1 /* photopile, Copyright (c) 2008-2015 Jens Kilian <jjk@acm.org>
2 * Based on carousel, Copyright (c) 2005-2008 Jamie Zawinski <jwz@jwz.org>
3 * Loads a sequence of images and shuffles them into a pile.
5 * Permission to use, copy, modify, distribute, and sell this software and its
6 * documentation for any purpose is hereby granted without fee, provided that
7 * the above copyright notice appear in all copies and that both that
8 * copyright notice and this permission notice appear in supporting
9 * documentation. No representations are made about the suitability of this
10 * software for any purpose. It is provided "as is" without express or
14 #define DEF_FONT "-*-helvetica-bold-r-normal-*-*-480-*-*-*-*-*-*"
15 #define DEFAULTS "*count: 7 \n" \
17 "*wireframe: False \n" \
18 "*showFPS: False \n" \
19 "*fpsSolid: True \n" \
21 "*font: " DEF_FONT "\n" \
22 "*desktopGrabber: xscreensaver-getimage -no-desktop %s\n" \
23 "*grabDesktopImages: False \n" \
24 "*chooseRandomImages: True \n" \
25 "*suppressRotationAnimation: True\n" \
27 # define refresh_photopile 0
28 # define release_photopile 0
29 # define photopile_handle_event 0
32 #define countof(x) (sizeof((x))/sizeof((*x)))
35 # include <X11/Intrinsic.h> /* for XrmDatabase in -debug mode */
39 #include "xlockmore.h"
40 #include "grab-ximage.h"
42 #include "dropshadow.h"
46 # define DEF_SCALE "0.4"
47 # define DEF_MAX_TILT "50"
48 # define DEF_SPEED "1.0"
49 # define DEF_DURATION "5"
50 # define DEF_MIPMAP "True"
51 # define DEF_TITLES "False"
52 # define DEF_POLAROID "True"
53 # define DEF_CLIP "True"
54 # define DEF_SHADOWS "True"
55 # define DEF_DEBUG "False"
57 #define BELLRAND(n) ((frand((n)) + frand((n)) + frand((n))) / 3)
60 GLfloat x, y; /* position on screen */
61 GLfloat angle; /* rotation angle */
66 Bool loaded_p; /* true if image can be drawn */
68 char *title; /* the filename of this image */
69 int w, h; /* size in pixels of the image */
70 int tw, th; /* size in pixels of the texture */
71 XRectangle geom; /* where in the image the bits are */
73 position pos[4]; /* control points for calculating position */
75 GLuint texid; /* GL texture ID */
80 typedef enum { EARLY, SHUFFLE, NORMAL, LOADING } fade_mode;
81 static int fade_ticks = 60;
85 GLXContext *glx_context;
87 image *frames; /* pointer to array of images */
88 int nframe; /* image being (resp. next to be) loaded */
91 texture_font_data *texfont;
92 int loading_sw, loading_sh;
94 time_t last_time, now;
101 static photopile_state *sss = NULL;
104 /* Command-line arguments
106 static GLfloat scale; /* Scale factor for loading images. */
107 static GLfloat max_tilt; /* Maximum angle from vertical. */
108 static GLfloat speed; /* Animation speed scale factor. */
109 static int duration; /* Reload images after this long. */
110 static Bool mipmap_p; /* Use mipmaps instead of single textures. */
111 static Bool titles_p; /* Display image titles. */
112 static Bool polaroid_p; /* Use instant-film look for images. */
113 static Bool clip_p; /* Clip images instead of scaling for -polaroid. */
114 static Bool shadows_p; /* Draw drop shadows. */
115 static Bool debug_p; /* Be loud and do weird things. */
118 static XrmOptionDescRec opts[] = {
119 {"-scale", ".scale", XrmoptionSepArg, 0 },
120 {"-maxTilt", ".maxTilt", XrmoptionSepArg, 0 },
121 {"-speed", ".speed", XrmoptionSepArg, 0 },
122 {"-duration", ".duration", XrmoptionSepArg, 0 },
123 {"-mipmaps", ".mipmap", XrmoptionNoArg, "True" },
124 {"-no-mipmaps", ".mipmap", XrmoptionNoArg, "False" },
125 {"-titles", ".titles", XrmoptionNoArg, "True" },
126 {"-no-titles", ".titles", XrmoptionNoArg, "False" },
127 {"-polaroid", ".polaroid", XrmoptionNoArg, "True" },
128 {"-no-polaroid", ".polaroid", XrmoptionNoArg, "False" },
129 {"-clip", ".clip", XrmoptionNoArg, "True" },
130 {"-no-clip", ".clip", XrmoptionNoArg, "False" },
131 {"-shadows", ".shadows", XrmoptionNoArg, "True" },
132 {"-no-shadows", ".shadows", XrmoptionNoArg, "False" },
133 {"-debug", ".debug", XrmoptionNoArg, "True" },
134 {"-font", ".font", XrmoptionSepArg, 0 },
137 static argtype vars[] = {
138 { &scale, "scale", "Scale", DEF_SCALE, t_Float},
139 { &max_tilt, "maxTilt", "MaxTilt", DEF_MAX_TILT, t_Float},
140 { &speed, "speed", "Speed", DEF_SPEED, t_Float},
141 { &duration, "duration", "Duration", DEF_DURATION, t_Int},
142 { &mipmap_p, "mipmap", "Mipmap", DEF_MIPMAP, t_Bool},
143 { &titles_p, "titles", "Titles", DEF_TITLES, t_Bool},
144 { &polaroid_p, "polaroid", "Polaroid", DEF_POLAROID, t_Bool},
145 { &clip_p, "clip", "Clip", DEF_CLIP, t_Bool},
146 { &shadows_p, "shadows", "Shadows", DEF_SHADOWS, t_Bool},
147 { &debug_p, "debug", "Debug", DEF_DEBUG, t_Bool},
150 ENTRYPOINT ModeSpecOpt photopile_opts = {countof(opts), opts, countof(vars), vars, NULL};
153 /* Functions to interpolate between image positions.
156 add_pos(position p, position q)
165 scale_pos(GLfloat t, position p)
174 linear_combination(GLfloat t, position p, position q)
176 return add_pos(scale_pos(1.0 - t, p), scale_pos(t, q));
180 interpolate(GLfloat t, position p[4])
182 /* de Casteljau's algorithm, 4 control points */
183 position p10 = linear_combination(t, p[0], p[1]);
184 position p11 = linear_combination(t, p[1], p[2]);
185 position p12 = linear_combination(t, p[2], p[3]);
187 position p20 = linear_combination(t, p10, p11);
188 position p21 = linear_combination(t, p11, p12);
190 return linear_combination(t, p20, p21);
194 offset_pos(position p, GLfloat th, GLfloat r)
198 p.angle = (frand(2.0) - 1.0) * max_tilt;
202 /* Calculate new positions for all images.
205 set_new_positions(photopile_state *ss)
207 ModeInfo *mi = ss->mi;
210 for (i = 0; i < MI_COUNT(mi)+1; ++i)
212 image *frame = ss->frames + i;
213 GLfloat w = frame->w;
214 GLfloat h = frame->h;
215 GLfloat d = sqrt(w*w + h*h);
216 GLfloat leave = frand(M_PI * 2.0);
217 GLfloat enter = frand(M_PI * 2.0);
220 frame->pos[0] = frame->pos[3];
223 frame->pos[3].x = BELLRAND(MI_WIDTH(mi));
224 frame->pos[3].y = BELLRAND(MI_HEIGHT(mi));
225 frame->pos[3].angle = (frand(2.0) - 1.0) * max_tilt;
227 /* Try to keep the images mostly inside the screen bounds */
228 frame->pos[3].x = MAX(0.5*w, MIN(MI_WIDTH(mi)-0.5*w, frame->pos[3].x));
229 frame->pos[3].y = MAX(0.5*h, MIN(MI_HEIGHT(mi)-0.5*h, frame->pos[3].y));
231 /* intermediate points */
232 frame->pos[1] = offset_pos(frame->pos[0], leave, d * (0.5 + frand(1.0)));
233 frame->pos[2] = offset_pos(frame->pos[3], enter, d * (0.5 + frand(1.0)));
237 /* Callback that tells us that the texture has been loaded.
240 image_loaded_cb (const char *filename, XRectangle *geom,
241 int image_width, int image_height,
242 int texture_width, int texture_height,
245 photopile_state *ss = (photopile_state *) closure;
246 ModeInfo *mi = ss->mi;
247 int wire = MI_IS_WIREFRAME(mi);
248 image *frame = ss->frames + ss->nframe;
254 frame->w = (int)(MI_WIDTH(mi) * scale) - 1;
255 frame->h = (int)(MI_HEIGHT(mi) * scale) - 1;
259 frame->w = (int)(MI_HEIGHT(mi) * scale) - 1;
260 frame->h = (int)(MI_WIDTH(mi) * scale) - 1;
262 if (frame->w <= 10) frame->w = 10;
263 if (frame->h <= 10) frame->h = 10;
264 frame->geom.width = frame->w;
265 frame->geom.height = frame->h;
269 if (image_width == 0 || image_height == 0)
272 glTexParameteri (GL_TEXTURE_2D, GL_TEXTURE_MAG_FILTER, GL_LINEAR);
273 glTexParameteri (GL_TEXTURE_2D, GL_TEXTURE_MIN_FILTER,
274 mipmap_p ? GL_LINEAR_MIPMAP_LINEAR : GL_LINEAR);
276 glTexParameteri (GL_TEXTURE_2D, GL_TEXTURE_WRAP_S, GL_REPEAT);
277 glTexParameteri (GL_TEXTURE_2D, GL_TEXTURE_WRAP_T, GL_REPEAT);
279 frame->w = image_width;
280 frame->h = image_height;
281 frame->tw = texture_width;
282 frame->th = texture_height;
287 frame->title = (filename ? strdup (filename) : 0);
289 /* xscreensaver-getimage returns paths relative to the image directory
290 now, so leave the sub-directory part in. Unless it's an absolute path.
292 if (frame->title && frame->title[0] == '/')
294 /* strip filename to part after last /. */
295 char *s = strrchr (frame->title, '/');
296 if (s) strcpy (frame->title, s+1);
300 fprintf (stderr, "%s: loaded %4d x %-4d %4d x %-4d \"%s\"\n",
304 frame->tw, frame->th,
305 (frame->title ? frame->title : "(null)"));
308 frame->loaded_p = True;
315 load_image (ModeInfo *mi)
317 photopile_state *ss = &sss[MI_SCREEN(mi)];
318 int wire = MI_IS_WIREFRAME(mi);
319 image *frame = ss->frames + ss->nframe;
321 if (debug_p && !wire && frame->w != 0)
322 fprintf (stderr, "%s: dropped %4d x %-4d %4d x %-4d \"%s\"\n",
326 frame->tw, frame->th,
327 (frame->title ? frame->title : "(null)"));
329 frame->loaded_p = False;
332 image_loaded_cb (0, 0, 0, 0, 0, 0, ss);
335 int w = MI_WIDTH(mi);
336 int h = MI_HEIGHT(mi);
337 int size = (int)((w > h ? w : h) * scale);
338 if (size <= 10) size = 10;
339 load_texture_async (mi->xgwa.screen, mi->window, *ss->glx_context,
341 mipmap_p, frame->texid,
342 image_loaded_cb, ss);
348 loading_msg (ModeInfo *mi)
350 photopile_state *ss = &sss[MI_SCREEN(mi)];
351 int wire = MI_IS_WIREFRAME(mi);
352 const char text[] = "Loading...";
356 if (ss->loading_sw == 0) /* only do this once */
359 texture_string_metrics (ss->texfont, text, &e, 0, 0);
360 ss->loading_sw = e.width;
361 ss->loading_sh = e.ascent + e.descent;
364 glClear(GL_COLOR_BUFFER_BIT | GL_DEPTH_BUFFER_BIT);
366 glMatrixMode(GL_PROJECTION);
370 glMatrixMode(GL_MODELVIEW);
373 glOrtho(0, MI_WIDTH(mi), 0, MI_HEIGHT(mi), -1, 1);
375 glTranslatef ((MI_WIDTH(mi) - ss->loading_sw) / 2,
376 (MI_HEIGHT(mi) - ss->loading_sh) / 2,
379 glEnable (GL_TEXTURE_2D);
380 glDisable (GL_DEPTH_TEST);
381 print_texture_string (ss->texfont, text);
382 glEnable (GL_DEPTH_TEST);
385 glMatrixMode(GL_PROJECTION);
388 glMatrixMode(GL_MODELVIEW);
391 glXSwapBuffers (MI_DISPLAY (mi), MI_WINDOW(mi));
396 loading_initial_image (ModeInfo *mi)
398 photopile_state *ss = &sss[MI_SCREEN(mi)];
400 if (ss->frames[ss->nframe].loaded_p)
402 /* The initial image has been fully loaded, start fading it in. */
405 for (i = 0; i < ss->nframe; ++i)
407 ss->frames[i].pos[3].x = MI_WIDTH(mi) * 0.5;
408 ss->frames[i].pos[3].y = MI_HEIGHT(mi) * 0.5;
409 ss->frames[i].pos[3].angle = 0.0;
411 set_new_positions(ss);
414 ss->mode_tick = fade_ticks / speed;
421 return (ss->mode == EARLY);
426 reshape_photopile (ModeInfo *mi, int width, int height)
428 glViewport (0, 0, (GLint) width, (GLint) height);
430 glMatrixMode(GL_PROJECTION);
433 glMatrixMode(GL_MODELVIEW);
435 glOrtho(0, MI_WIDTH(mi), 0, MI_HEIGHT(mi), -1, 1);
437 # ifdef HAVE_MOBILE /* Keep it the same relative size when rotated. */
439 GLfloat h = MI_HEIGHT(mi) / (GLfloat) MI_WIDTH(mi);
440 int o = (int) current_device_rotation();
441 if (o != 0 && o != 180 && o != -180)
442 glScalef (1/h, h, 1);
446 glClear(GL_COLOR_BUFFER_BIT);
450 /* Kludge to add "-v" to invocation of "xscreensaver-getimage" in -debug mode
453 hack_resources (Display *dpy)
456 char *res = "desktopGrabber";
457 char *val = get_string_resource (dpy, res, "DesktopGrabber");
461 XrmDatabase db = XtDatabase (dpy);
462 sprintf (buf1, "%.100s.%.100s", progname, res);
463 sprintf (buf2, "%.200s -v", val);
465 value.size = strlen(buf2);
466 XrmPutResource (&db, buf1, "String", &value);
467 # endif /* !HAVE_JWXYZ */
472 init_photopile (ModeInfo *mi)
474 int screen = MI_SCREEN(mi);
476 int wire = MI_IS_WIREFRAME(mi);
479 if ((sss = (photopile_state *)
480 calloc (MI_NUM_SCREENS(mi), sizeof(photopile_state))) == NULL)
486 if ((ss->glx_context = init_GL(mi)) != NULL) {
487 reshape_photopile (mi, MI_WIDTH(mi), MI_HEIGHT(mi));
488 clear_gl_error(); /* WTF? sometimes "invalid op" from glViewport! */
493 ss->shadow = init_drop_shadow();
494 ss->texfont = load_texture_font (MI_DISPLAY(mi), "font");
497 hack_resources (MI_DISPLAY (mi));
499 ss->frames = (image *)calloc (MI_COUNT(mi) + 1, sizeof(image));
504 for (i = 0; i < MI_COUNT(mi) + 1; ++i)
506 glGenTextures (1, &(ss->frames[i].texid));
507 if (ss->frames[i].texid <= 0) abort();
512 load_image(mi); /* start loading the first image */
517 draw_image (ModeInfo *mi, int i, GLfloat t, GLfloat s, GLfloat z)
519 int wire = MI_IS_WIREFRAME(mi);
520 photopile_state *ss = &sss[MI_SCREEN(mi)];
521 image *frame = ss->frames + i;
523 position pos = interpolate(t, frame->pos);
524 GLfloat w = frame->geom.width * 0.5;
525 GLfloat h = frame->geom.height * 0.5;
526 GLfloat z1 = z - 0.25 / (MI_COUNT(mi) + 1);
527 GLfloat z2 = z - 0.5 / (MI_COUNT(mi) + 1);
534 GLfloat minSize = MIN(w, h);
535 GLfloat maxSize = MAX(w, h);
537 /* Clip or scale image to fit in the frame.
545 GLfloat scale = minSize / maxSize;
550 w1 = minSize * 1.16; /* enlarge frame border */
553 s /= 1.5; /* compensate for border size */
558 /* Position and scale this image.
560 glTranslatef (pos.x, pos.y, 0);
561 glRotatef (pos.angle, 0, 0, 1);
564 /* Draw the drop shadow. */
565 if (shadows_p && !wire)
568 draw_drop_shadow(ss->shadow, -w1, -h1, z2, 2.0 * w1, h1 + h2, 20.0);
569 glDisable (GL_BLEND);
572 glDisable (GL_LIGHTING);
573 glEnable (GL_DEPTH_TEST);
574 glDisable (GL_CULL_FACE);
576 /* Draw the retro instant-film frame.
582 glShadeModel (GL_SMOOTH);
583 glEnable (GL_LINE_SMOOTH);
584 glHint (GL_LINE_SMOOTH_HINT, GL_NICEST);
588 glVertex3f (-w1, -h1, z2);
589 glVertex3f ( w1, -h1, z2);
590 glVertex3f ( w1, h2, z2);
591 glVertex3f (-w1, h2, z2);
596 glColor3f (0.5, 0.5, 0.5);
597 glBegin (GL_LINE_LOOP);
598 glVertex3f (-w1, -h1, z);
599 glVertex3f ( w1, -h1, z);
600 glVertex3f ( w1, h2, z);
601 glVertex3f (-w1, h2, z);
605 /* Draw the image quad.
609 GLfloat texw = w / frame->tw;
610 GLfloat texh = h / frame->th;
611 GLfloat texx = (frame->geom.x + 0.5 * frame->geom.width) / frame->tw;
612 GLfloat texy = (frame->geom.y + 0.5 * frame->geom.height) / frame->th;
614 glBindTexture (GL_TEXTURE_2D, frame->texid);
615 glEnable (GL_TEXTURE_2D);
618 glTexCoord2f (texx - texw, texy + texh); glVertex3f (-w, -h, z1);
619 glTexCoord2f (texx + texw, texy + texh); glVertex3f ( w, -h, z1);
620 glTexCoord2f (texx + texw, texy - texh); glVertex3f ( w, h, z1);
621 glTexCoord2f (texx - texw, texy - texh); glVertex3f (-w, h, z1);
623 glDisable (GL_TEXTURE_2D);
626 /* Draw a box around it.
630 glShadeModel (GL_SMOOTH);
631 glEnable (GL_LINE_SMOOTH);
632 glHint (GL_LINE_SMOOTH_HINT, GL_NICEST);
635 glColor3f (0.5, 0.5, 0.5);
636 glBegin (GL_LINE_LOOP);
637 glVertex3f (-w, -h, z);
638 glVertex3f ( w, -h, z);
639 glVertex3f ( w, h, z);
640 glVertex3f (-w, h, z);
643 /* Draw a title under the image.
647 int sw, sh, ascent, descent;
649 const char *title = frame->title ? frame->title : "(untitled)";
652 /* #### Highly approximate, but doing real clipping is harder... */
654 if (strlen(title) > max)
655 title += strlen(title) - max;
657 texture_string_metrics (ss->texfont, title, &e, &ascent, &descent);
659 sh = ascent + descent;
661 /* Scale the text to match the pixel size of the photo */
664 /* Move to below photo */
665 glTranslatef (0, -h - sh * (polaroid_p ? 2.2 : 0.5), 0);
666 glTranslatef (-sw*scale/2, sh*scale/2, z);
667 glScalef (scale, scale, 1);
669 if (wire || !polaroid_p)
680 glEnable (GL_TEXTURE_2D);
682 print_texture_string (ss->texfont, title);
686 glBegin (GL_LINE_LOOP);
687 glVertex3f (0, 0, 0);
688 glVertex3f (sw, 0, 0);
689 glVertex3f (sw, sh, 0);
690 glVertex3f (0, sh, 0);
700 draw_photopile (ModeInfo *mi)
702 photopile_state *ss = &sss[MI_SCREEN(mi)];
705 if (!ss->glx_context)
708 glXMakeCurrent(MI_DISPLAY(mi), MI_WINDOW(mi), *(ss->glx_context));
710 if (ss->mode == EARLY)
711 if (loading_initial_image (mi))
714 /* Only check the wall clock every 10 frames */
715 if (ss->now == 0 || ss->draw_tick++ > 10)
717 ss->now = time((time_t *) 0);
718 if (ss->last_time == 0) ss->last_time = ss->now;
722 glClear(GL_COLOR_BUFFER_BIT | GL_DEPTH_BUFFER_BIT);
727 glTranslatef (MI_WIDTH(mi)/2, MI_HEIGHT(mi)/2, 0);
728 glRotatef(current_device_rotation(), 0, 0, 1);
729 glTranslatef (-MI_WIDTH(mi)/2, -MI_HEIGHT(mi)/2, 0);
731 /* Handle state transitions. */
735 if (--ss->mode_tick <= 0)
737 ss->nframe = (ss->nframe+1) % (MI_COUNT(mi)+1);
740 ss->last_time = time((time_t *) 0);
744 if (ss->now - ss->last_time > duration)
751 if (ss->frames[ss->nframe].loaded_p)
753 set_new_positions(ss);
755 ss->mode_tick = fade_ticks / speed;
762 t = 1.0 - ss->mode_tick / (fade_ticks / speed);
763 t = 0.5 * (1.0 - cos(M_PI * t));
765 /* Draw the images. */
766 for (i = 0; i < MI_COUNT(mi) + (ss->mode == SHUFFLE); ++i)
768 int j = (ss->nframe + i + 1) % (MI_COUNT(mi) + 1);
770 if (ss->frames[j].loaded_p)
773 GLfloat z = (GLfloat)i / (MI_COUNT(mi) + 1);
778 if (i == MI_COUNT(mi))
795 draw_image(mi, j, t, s, z);
801 if (mi->fps_p) do_fps (mi);
803 glXSwapBuffers (MI_DISPLAY (mi), MI_WINDOW(mi));
806 XSCREENSAVER_MODULE ("Photopile", photopile)