git.hungrycats.org Git - xscreensaver/blob - hacks/spotlight.c

   1 /*
   2  * spotlight - an xscreensaver module
   3  * Copyright (c) 1999, 2001 Rick Schultz <rick.schultz@gmail.com>
   4  *
   5  * loosely based on the BackSpace module "StefView" by Darcy Brockbank
   6  */
   7
   8 /* modified from a module from the xscreensaver distribution */
   9
  10 /*
  11  * xscreensaver, Copyright (c) 1992-2006 Jamie Zawinski <jwz@jwz.org>
  12  *
  13  * Permission to use, copy, modify, distribute, and sell this software and its
  14  * documentation for any purpose is hereby granted without fee, provided that
  15  * the above copyright notice appear in all copies and that both that
  16  * copyright notice and this permission notice appear in supporting
  17  * documentation.  No representations are made about the suitability of this
  18  * software for any purpose.  It is provided "as is" without express or
  19  * implied warranty.
  20  */
  21
  22
  23 /* #define DEBUG */
  24 #include <math.h>
  25 #include "screenhack.h"
  26
  27 #define MINX 0.0
  28 #define MINY 0.0
  29 #define X_PERIOD 15000.0
  30 #define Y_PERIOD 12000.0
  31
  32 struct state {
  33   Display *dpy;
  34   Window window;
  35   Screen *screen;
  36
  37   int sizex, sizey; /* screen size */
  38   int delay;
  39   int duration;
  40   time_t start_time;
  41
  42   GC window_gc;
  43 #ifdef DEBUG
  44   GC white_gc;
  45 #endif
  46   GC buffer_gc;     /* draw in buffer, then flush to screen
  47                        to avoid flicker */
  48   int radius;       /* radius of spotlight in pixels */
  49
  50   Pixmap pm;        /* pixmap grabbed from screen */
  51   Pixmap buffer;    /* pixmap for the buffer */
  52
  53   int x, y, s;      /* x & y coords of buffer (upper left corner) */
  54   /* s is the width of the buffer */
  55
  56   int off;      /* random offset from currentTimeInMs(), so that
  57                    two concurrent copies of spotlight have different
  58                    behavior. */
  59
  60   int oldx, oldy, max_x_speed, max_y_speed;
  61   /* used to keep the new buffer position
  62      over the old spotlight image to make sure
  63      the old image is completely erased */
  64
  65   Bool first_p;
  66   async_load_state *img_loader;
  67 };
  68
  69
  70 /* The path the spotlight follows around the screen is sinusoidal.
  71    This function is fed to sin() to get the x & y coords */
  72 static long
  73 currentTimeInMs(struct state *st)
  74 {
  75   struct timeval curTime;
  76 #ifdef GETTIMEOFDAY_TWO_ARGS
  77   struct timezone tz = {0,0};
  78   gettimeofday(&curTime, &tz);
  79 #else
  80   gettimeofday(&curTime);
  81 #endif
  82   return curTime.tv_sec*1000 + curTime.tv_usec/1000.0;
  83 }
  84
  85
  86 static void *
  87 spotlight_init (Display *dpy, Window window)
  88 {
  89   struct state *st = (struct state *) calloc (1, sizeof(*st));
  90   XGCValues gcv;
  91   XWindowAttributes xgwa;
  92   long gcflags;
  93   Colormap cmap;
  94   unsigned long bg;
  95   GC clip_gc;
  96   Pixmap clip_pm;
  97
  98   st->dpy = dpy;
  99   st->window = window;
 100   st->first_p = True;
 101
 102   XGetWindowAttributes (st->dpy, st->window, &xgwa);
 103   st->screen = xgwa.screen;
 104   st->sizex = xgwa.width;
 105   st->sizey = xgwa.height;
 106   cmap = xgwa.colormap;
 107   bg = get_pixel_resource (st->dpy, cmap, "background", "Background");
 108
 109   /* read parameters, keep em sane */
 110   st->delay = get_integer_resource (st->dpy, "delay", "Integer");
 111   if (st->delay < 1) st->delay = 1;
 112   st->duration = get_integer_resource (st->dpy, "duration", "Seconds");
 113   if (st->duration < 1) st->duration = 1;
 114   st->radius = get_integer_resource (st->dpy, "radius", "Integer");
 115   if (st->radius < 0) st->radius = 125;
 116
 117   /* Don't let the spotlight be bigger than the window */
 118   while (st->radius > xgwa.width * 0.45)
 119     st->radius /= 2;
 120   while (st->radius > xgwa.height * 0.45)
 121     st->radius /= 2;
 122
 123   if (st->radius < 4)
 124     st->radius = 4;
 125
 126   /* do the dance */
 127   gcv.function = GXcopy;
 128   gcv.subwindow_mode = IncludeInferiors;
 129   gcflags = GCForeground | GCFunction;
 130   gcv.foreground = bg;
 131
 132 #ifdef NOPE
 133   if (use_subwindow_mode_p(xgwa.screen, st->window)) /* see grabscreen.c */
 134     gcflags |= GCSubwindowMode;
 135 #endif
 136   st->window_gc = XCreateGC(st->dpy, st->window, gcflags, &gcv);
 137
 138   st->pm = XCreatePixmap(st->dpy, st->window, st->sizex, st->sizey, xgwa.depth);
 139   XClearWindow(st->dpy, st->window);
 140
 141   /* create buffer to reduce flicker */
 142 #ifdef HAVE_COCOA       /* Don't second-guess Quartz's double-buffering */
 143   st->buffer = 0;
 144 #else
 145   st->buffer = XCreatePixmap(st->dpy, st->window, st->sizex, st->sizey, xgwa.depth);
 146 #endif
 147
 148   st->buffer_gc = XCreateGC(st->dpy, (st->buffer ? st->buffer : window), gcflags, &gcv);
 149   if (st->buffer)
 150     XFillRectangle(st->dpy, st->buffer, st->buffer_gc, 0, 0, st->sizex, st->sizey);
 151
 152   /* blank out screen */
 153   XFillRectangle(st->dpy, st->window, st->window_gc, 0, 0, st->sizex, st->sizey);
 154   XSetWindowBackground (st->dpy, st->window, bg);
 155
 156   /* create clip mask (so it's a circle, not a square) */
 157   clip_pm = XCreatePixmap(st->dpy, st->window, st->radius*4, st->radius*4, 1);
 158   st->img_loader = load_image_async_simple (0, xgwa.screen, st->window, st->pm,
 159                                             0, 0);
 160   st->start_time = time ((time_t) 0);
 161
 162   gcv.foreground = 0L;
 163   clip_gc = XCreateGC(st->dpy, clip_pm, gcflags, &gcv);
 164   XFillRectangle(st->dpy, clip_pm, clip_gc, 0, 0, st->radius*4, st->radius*4);
 165
 166   XSetForeground(st->dpy, clip_gc, 1L);
 167   XFillArc(st->dpy, clip_pm, clip_gc, st->radius , st->radius,
 168            st->radius*2, st->radius*2, 0, 360*64);
 169
 170   /* set buffer's clip mask to the one we just made */
 171   XSetClipMask(st->dpy, st->buffer_gc, clip_pm);
 172
 173   /* free everything */
 174   XFreeGC(st->dpy, clip_gc);
 175   XFreePixmap(st->dpy, clip_pm);
 176
 177   /* avoid remants */
 178   st->max_x_speed = st->max_y_speed = st->radius;
 179
 180   st->off = random();
 181
 182 #ifdef DEBUG
 183   /* create GC with white fg */
 184   gcv.foreground = fg;
 185   st->white_gc = XCreateGC(st->dpy, st->window, gcflags, &gcv);
 186 #endif
 187   return st;
 188 }
 189
 190
 191 /*
 192  * perform one iteration
 193  */
 194 static void
 195 onestep (struct state *st, Bool first_p)
 196 {
 197   long now;
 198
 199   if (st->img_loader)   /* still loading */
 200     {
 201       st->img_loader = load_image_async_simple (st->img_loader, 0, 0, 0, 0, 0);
 202       if (! st->img_loader) {  /* just finished */
 203         st->start_time = time ((time_t) 0);
 204       }
 205       return;
 206     }
 207
 208   if (!st->img_loader &&
 209       st->start_time + st->duration < time ((time_t) 0)) {
 210     st->img_loader = load_image_async_simple (0, st->screen, st->window,
 211                                               st->pm, 0, 0);
 212     return;
 213   }
 214
 215 #define nrnd(x) (random() % (x))
 216
 217   st->oldx = st->x;
 218   st->oldy = st->y;
 219
 220   st->s = st->radius *4 ;   /* s = width of buffer */
 221
 222   now = currentTimeInMs(st) + st->off;
 223
 224   /* find new x,y */
 225   st->x = ((1 + sin(((double)now) / X_PERIOD * 2. * M_PI))/2.0)
 226     * (st->sizex - st->s/2) -st->s/4  + MINX;
 227   st->y = ((1 + sin(((double)now) / Y_PERIOD * 2. * M_PI))/2.0)
 228     * (st->sizey - st->s/2) -st->s/4  + MINY;
 229
 230   if (!st->first_p)
 231     {
 232       /* limit change in x and y to buffer width */
 233       if ( st->x < (st->oldx - st->max_x_speed) ) st->x = st->oldx - st->max_x_speed;
 234       if ( st->x > (st->oldx + st->max_x_speed) ) st->x = st->oldx + st->max_x_speed;
 235       if ( st->y < (st->oldy - st->max_y_speed) ) st->y = st->oldy - st->max_y_speed;
 236       if ( st->y > (st->oldy + st->max_y_speed) ) st->y = st->oldy + st->max_y_speed;
 237     }
 238
 239   if (! st->buffer)
 240     {
 241       XClearWindow (st->dpy, st->window);
 242       XSetClipOrigin(st->dpy, st->buffer_gc, st->x,st->y);
 243       XCopyArea(st->dpy, st->pm, st->window, st->buffer_gc, st->x, st->y, st->s, st->s, st->x, st->y);
 244     }
 245   else
 246     {
 247       /* clear buffer */
 248       XFillRectangle(st->dpy, st->buffer, st->buffer_gc, st->x, st->y, st->s, st->s);
 249
 250       /* copy area of screen image (pm) to buffer
 251          Clip to a circle */
 252       XSetClipOrigin(st->dpy, st->buffer_gc, st->x,st->y);
 253       XCopyArea(st->dpy, st->pm, st->buffer, st->buffer_gc, st->x, st->y, st->s, st->s, st->x, st->y);
 254
 255       /* copy buffer to screen (window) */
 256       XCopyArea(st->dpy, st->buffer, st->window, st->window_gc, st->x , st->y, st->s, st->s, st->x, st->y);
 257     }
 258
 259 #ifdef DEBUG
 260   /* draw a box around the buffer */
 261   XDrawRectangle(st->dpy, st->window, st->white_gc, st->x , st->y, st->s, st->s);
 262 #endif
 263
 264 }
 265
 266
 267 static unsigned long
 268 spotlight_draw (Display *dpy, Window window, void *closure)
 269 {
 270   struct state *st = (struct state *) closure;
 271   onestep(st, st->first_p);
 272   st->first_p = False;
 273   return st->delay;
 274 }
 275
 276 static void
 277 spotlight_reshape (Display *dpy, Window window, void *closure,
 278                  unsigned int w, unsigned int h)
 279 {
 280 }
 281
 282 static Bool
 283 spotlight_event (Display *dpy, Window window, void *closure, XEvent *event)
 284 {
 285   return False;
 286 }
 287
 288 static void
 289 spotlight_free (Display *dpy, Window window, void *closure)
 290 {
 291   struct state *st = (struct state *) closure;
 292   XFreeGC (dpy, st->window_gc);
 293   XFreeGC (dpy, st->buffer_gc);
 294   if (st->pm) XFreePixmap (dpy, st->pm);
 295   if (st->buffer) XFreePixmap (dpy, st->buffer);
 296   free (st);
 297 }
 298
 299
 300 \f
 301
 302 static const char *spotlight_defaults [] = {
 303   ".background:                 black",
 304   ".foreground:                 white",
 305   "*dontClearRoot:              True",
 306   "*fpsSolid:                   true",
 307
 308 #ifdef __sgi    /* really, HAVE_READ_DISPLAY_EXTENSION */
 309   "*visualID:                   Best",
 310 #endif
 311
 312   "*delay:                      10000",
 313   "*duration:                   120",
 314   "*radius:                     125",
 315   0
 316 };
 317
 318 static XrmOptionDescRec spotlight_options [] = {
 319   { "-delay",           ".delay",               XrmoptionSepArg, 0 },
 320   { "-duration",        ".duration",            XrmoptionSepArg, 0 },
 321   { "-radius",          ".radius",              XrmoptionSepArg, 0 },
 322   { 0, 0, 0, 0 }
 323 };
 324
 325 XSCREENSAVER_MODULE ("Spotlight", spotlight)