1 /* -*- mode: C; tab-width: 4 -*-
2 * xscreensaver, Copyright (c) 1992, 1993, 1994, 1996, 1997, 1998
3 * Jamie Zawinski <jwz@jwz.org>
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
15 * by Jonas Munsin (jmunsin@iki.fi) and Jamie Zawinski <jwz@jwz.org>
17 * -check the allocations in init_round_lense again, maybe make it possible again
18 * to use swamp without pre-allocating/calculating (although that
19 * makes it slower) - -swamp is memory hungry
20 * -more distortion matrices (fortunately, I'm out of ideas :)
21 * Stuff that would be cool but probably too much of a resource hog:
22 * -some kind of interpolation to avoid jaggies
23 * -large speed values leaves the image distorted
24 * program idea borrowed from a screensaver on a non-*NIX OS,
26 * 28 Sep 1999 Jonas Munsin (jmunsin@iki.fi)
27 * Added about 10x faster algortim for 8, 16 and 32 bpp (modifies pixels
28 * directly avoiding costly XPutPixle(XGetPixel()) calls, inspired by
29 * xwhirl made by horvai@clipper.ens.fr (Peter Horvai) and the XFree86
31 * This piece of code is really horrible, but it works, and at the moment
32 * I don't have time or inspiration to fix something that works (knock
34 * 08 Oct 1999 Jonas Munsin (jmunsin@iki.fi)
35 * Corrected several bugs causing references beyond allocated memory.
39 #include "screenhack.h"
40 #include <X11/Xutil.h>
43 #ifdef HAVE_XSHM_EXTENSION
45 static Bool use_shm = False;
46 static XShmSegmentInfo shm_info;
47 #endif /* HAVE_XSHM_EXTENSION */
55 static struct coo xy_coo[10];
57 static int delay, radius, speed, number, blackhole, vortex, magnify, reflect, slow;
58 static XWindowAttributes xgwa;
60 static Window g_window;
61 static Display *g_dpy;
62 static unsigned long black_pixel;
64 static XImage *orig_map, *buffer_map;
65 static unsigned long *buffer_map_cache;
68 static int ****from_array;
69 static int *fast_from = NULL;
70 static void (*effect) (int) = NULL;
71 static void move_lense(int);
72 static void swamp_thing(int);
73 static void new_rnd_coo(int);
74 static void init_round_lense(void);
75 static void (*draw) (int) = NULL;
76 static void reflect_draw(int);
77 static void plain_draw(int);
79 static void (*draw_routine)(XImage *, XImage *, int, int, int *) = NULL;
80 static void fast_draw_8(XImage *, XImage *, int, int, int *);
81 static void fast_draw_16(XImage *, XImage *, int, int, int *);
82 static void fast_draw_32(XImage *, XImage *, int, int, int *);
83 static void generic_draw(XImage *, XImage *, int, int, int *);
84 static int bpp_size = 0;
87 static void init_distort(Display *dpy, Window window)
96 delay = get_integer_resource("delay", "Integer");
97 radius = get_integer_resource("radius", "Integer");
98 speed = get_integer_resource("speed", "Integer");
99 number = get_integer_resource("number", "Integer");
101 #ifdef HAVE_XSHM_EXTENSION
102 use_shm = get_boolean_resource("useSHM", "Boolean");
103 #endif /* HAVE_XSHM_EXTENSION */
105 blackhole = get_boolean_resource("blackhole", "Boolean");
106 vortex = get_boolean_resource("vortex", "Boolean");
107 magnify = get_boolean_resource("magnify", "Boolean");
108 reflect = get_boolean_resource("reflect", "Boolean");
109 slow = get_boolean_resource("slow", "Boolean");
111 if (get_boolean_resource("swamp", "Boolean"))
112 effect = &swamp_thing;
113 if (get_boolean_resource("bounce", "Boolean"))
114 effect = &move_lense;
116 XGetWindowAttributes (dpy, window, &xgwa);
118 if (effect == NULL && radius == 0 && speed == 0 && number == 0
119 && !blackhole && !vortex && !magnify && !reflect) {
120 /* if no cmdline options are given, randomly choose one of:
121 * -radius 50 -number 4 -speed 1 -bounce
122 * -radius 50 -number 4 -speed 1 -blackhole
123 * -radius 50 -number 4 -speed 1 -vortex
124 * -radius 50 -number 4 -speed 1 -vortex -magnify
125 * -radius 50 -number 4 -speed 1 -vortex -magnify -blackhole
126 * -radius 100 -number 1 -speed 2 -bounce
127 * -radius 100 -number 1 -speed 2 -blackhole
128 * -radius 100 -number 1 -speed 2 -vortex
129 * -radius 100 -number 1 -speed 2 -vortex -magnify
130 * -radius 100 -number 1 -speed 2 -vortex -magnify -blackhole
131 * -radius 80 -number 1 -speed 2 -reflect
132 * -radius 50 -number 3 -speed 2 -reflect
134 * -radius 50 -number 4 -speed 2 -swamp
135 * -radius 50 -number 4 -speed 2 -swamp -blackhole
136 * -radius 50 -number 4 -speed 2 -swamp -vortex
137 * -radius 50 -number 4 -speed 2 -swamp -vortex -magnify
138 * -radius 50 -number 4 -speed 2 -swamp -vortex -magnify -blackhole
141 i = (random() % 12 /* 17 */);
147 radius=50;number=4;speed=1;
148 effect=&move_lense;break;
150 radius=50;number=4;speed=1;blackhole=1;
151 effect=&move_lense;break;
153 radius=50;number=4;speed=1;vortex=1;
154 effect=&move_lense;break;
156 radius=50;number=4;speed=1;vortex=1;magnify=1;
157 effect=&move_lense;break;
159 radius=50;number=4;speed=1;vortex=1;magnify=1;blackhole=1;
160 effect=&move_lense;break;
162 radius=100;number=1;speed=2;
163 effect=&move_lense;break;
165 radius=100;number=1;speed=2;blackhole=1;
166 effect=&move_lense;break;
168 radius=100;number=1;speed=2;vortex=1;
169 effect=&move_lense;break;
171 radius=100;number=1;speed=2;vortex=1;magnify=1;
172 effect=&move_lense;break;
174 radius=100;number=1;speed=2;vortex=1;magnify=1;blackhole=1;
175 effect=&move_lense;break;
178 radius=80;number=1;speed=2;reflect=1;
179 draw = &reflect_draw;effect = &move_lense;break;
181 radius=50;number=4;speed=2;reflect=1;
182 draw = &reflect_draw;effect = &move_lense;break;
184 #if 0 /* jwz: not these */
186 radius=50;number=4;speed=2;
187 effect=&swamp_thing;break;
189 radius=50;number=4;speed=2;blackhole=1;
190 effect=&swamp_thing;break;
192 radius=50;number=4;speed=2;vortex=1;
193 effect=&swamp_thing;break;
195 radius=50;number=4;speed=2;vortex=1;magnify=1;
196 effect=&swamp_thing;break;
198 radius=50;number=4;speed=2;vortex=1;magnify=1;blackhole=1;
199 effect=&swamp_thing;break;
206 /* but if the window is small, reduce default radius */
207 if (xgwa.width < radius * 8)
208 radius = xgwa.width/8;
222 effect = &move_lense;
224 draw = &reflect_draw;
225 effect = &move_lense;
230 black_pixel = BlackPixelOfScreen( xgwa.screen );
232 gcv.function = GXcopy;
233 gcv.subwindow_mode = IncludeInferiors;
234 gcflags = GCForeground |GCFunction;
235 if (use_subwindow_mode_p(xgwa.screen, window)) /* see grabscreen.c */
236 gcflags |= GCSubwindowMode;
237 gc = XCreateGC (dpy, window, gcflags, &gcv);
239 grab_screen_image (xgwa.screen, window);
242 orig_map = XGetImage(dpy, window, 0, 0, xgwa.width, xgwa.height,
244 buffer_map_cache = malloc(sizeof(unsigned long)*(2*radius+speed+2)*(2*radius+speed+2));
246 if (buffer_map_cache == NULL) {
251 # ifdef HAVE_XSHM_EXTENSION
255 buffer_map = create_xshm_image(dpy, xgwa.visual, orig_map->depth,
256 ZPixmap, 0, &shm_info,
257 2*radius + speed + 2,
258 2*radius + speed + 2);
262 # endif /* HAVE_XSHM_EXTENSION */
266 buffer_map = XCreateImage(dpy, xgwa.visual,
267 orig_map->depth, ZPixmap, 0, 0,
268 2*radius + speed + 2, 2*radius + speed + 2,
270 buffer_map->data = (char *)
271 calloc(buffer_map->height, buffer_map->bytes_per_line);
274 if ((buffer_map->byte_order == orig_map->byte_order)
275 && (buffer_map->depth == orig_map->depth)
276 && (buffer_map->format == ZPixmap)
277 && (orig_map->format == ZPixmap)
279 switch (orig_map->bits_per_pixel) {
281 draw_routine = &fast_draw_32;
282 bpp_size = sizeof(CARD32);
285 draw_routine = &fast_draw_16;
286 bpp_size = sizeof(CARD16);
289 draw_routine = &fast_draw_8;
290 bpp_size = sizeof(CARD8);
293 draw_routine = &generic_draw;
297 draw_routine = &generic_draw;
301 for (i = 0; i < number; i++) {
304 xy_coo[i].r = (i*radius)/(number-1); /* "randomize" initial */
307 xy_coo[i].r_change = speed + (i%2)*2*(-speed); /* values a bit */
308 xy_coo[i].xmove = speed + (i%2)*2*(-speed);
309 xy_coo[i].ymove = speed + (i%2)*2*(-speed);
314 /* example: initializes a "see-trough" matrix */
315 /* static void make_null_lense(void)
318 for (i = 0; i < 2*radius+speed+2; i++) {
319 for (j = 0 ; j < 2*radius+speed+2 ; j++) {
326 static void convert(void) {
329 fast_from = calloc(1, sizeof(int)*((buffer_map->bytes_per_line/bpp_size)*(2*radius+speed+2) + 2*radius+speed+2));
330 if (fast_from == NULL) {
335 for (i = 0; i < 2*radius+speed+2; i++) {
336 for (j = 0; j < 2*radius+speed+2; j++) {
337 *(p + i + j*buffer_map->bytes_per_line/bpp_size)
338 = from[i][j][0] + xgwa.width*from[i][j][1];
339 if (*(p + i + j*buffer_map->bytes_per_line/bpp_size) < 0
340 || *(p + i + j*buffer_map->bytes_per_line/bpp_size) >= orig_map->height*orig_map->width) {
341 *(p + i + j*buffer_map->bytes_per_line/bpp_size) = 0;
347 /* makes a lense with the Radius=loop and centred in
348 * the point (radius, radius)
350 static void make_round_lense(int radius, int loop)
354 for (i = 0; i < 2*radius+speed+2; i++) {
355 for(j = 0; j < ((0 == bpp_size) ? (2*radius+speed+2) : (buffer_map->bytes_per_line/bpp_size)); j++) {
357 r = sqrt ((i-radius)*(i-radius)+(j-radius)*(j-radius));
365 if (vortex) { /* vortex-twist effect */
367 /* this one-line formula for getting a nice rotation angle is borrowed
368 * (with permission) from the whirl plugin for gimp,
369 * Copyright (C) 1996 Federico Mena Quintero
371 /* 5 is just a constant used because it looks good :) */
372 angle = 5*(1-d)*(1-d);
374 /* Avoid atan2: DOMAIN error message */
375 if ((radius-j) == 0.0 && (radius-i) == 0.0) {
376 from[i][j][0] = radius + cos(angle)*r;
377 from[i][j][1] = radius + sin(angle)*r;
379 from[i][j][0] = radius +
380 cos(angle - atan2(radius-j, -(radius-i)))*r;
381 from[i][j][1] = radius +
382 sin(angle - atan2(radius-j, -(radius-i)))*r;
386 if (blackhole && r != 0) /* blackhole effect */
388 from[i][j][0] = radius + (from[i][j][0]-radius)*r;
389 from[i][j][1] = radius + (from[i][j][1]-radius)*r;
391 } else { /* default is to magnify */
394 /* raising r to different power here gives different amounts of
395 * distortion, a negative value sucks everything into a black hole
398 if (blackhole && r != 0) /* blackhole effect */
400 /* bubble effect (and blackhole) */
401 from[i][j][0] = radius + (i-radius)*r;
402 from[i][j][1] = radius + (j-radius)*r;
404 } else { /* not inside loop */
411 /* this is really just a quick hack to keep both the compability mode with all depths and still
412 * allow the custom optimized draw routines with the minimum amount of work */
419 # define EXIT_FAILURE -1
422 static void allocate_lense(void)
425 int s = ((0 != bpp_size) ? (buffer_map->bytes_per_line/bpp_size) : (2*radius+speed+2));
426 /* maybe this should be redone so that from[][][] is in one block;
427 * then pointers could be used instead of arrays in some places (and
428 * maybe give a speedup - maybe also consume less memory)
430 from = (int ***)malloc(s*sizeof(int **));
435 for (i = 0; i < s; i++) {
436 from[i] = (int **)malloc((2*radius+speed+2) * sizeof(int *));
437 if (from[i] == NULL) {
441 for (j = 0; j < s; j++) {
442 from[i][j] = (int *)malloc(2 * sizeof(int));
443 if (from[i][j] == NULL) {
451 /* from_array in an array containing precalculated from matrices,
452 * this is a double faced mem vs speed trade, it's faster, but eats
453 * _a lot_ of mem for large radius (is there a bug here? I can't see it)
455 static void init_round_lense(void)
459 if (effect == &swamp_thing) {
460 from_array = (int ****)malloc((radius+1)*sizeof(int ***));
461 for (k=0; k <= radius; k++) {
463 make_round_lense(radius, k);
464 from_array[k] = from;
466 } else { /* just allocate one from[][][] */
468 make_round_lense(radius,radius);
472 /* If fast_draw_8, fast_draw_16 or fast_draw_32 are to be used, the following properties
473 * of the src and dest XImages must hold (otherwise the generic, slooow, method provided
474 * by X is to be used):
475 * src->byte_order == dest->byte_order
476 * src->format == ZPixmap && dest->format == ZPixmap
477 * src->depth == dest->depth == the depth the function in question asumes
478 * x and y is the coordinates in src from where to cut out the image from,
479 * distort_matrix is a precalculated array of how to distort the matrix
482 static void fast_draw_8(XImage *src, XImage *dest, int x, int y, int *distort_matrix) {
483 CARD8 *u = (CARD8 *)dest->data;
484 CARD8 *t = (CARD8 *)src->data + x + y*src->bytes_per_line/sizeof(CARD8);
486 while (u < (CARD8 *)(dest->data + sizeof(CARD8)*dest->height
487 *dest->bytes_per_line/sizeof(CARD8))) {
488 *u++ = t[*distort_matrix++];
492 static void fast_draw_16(XImage *src, XImage *dest, int x, int y, int *distort_matrix) {
493 CARD16 *u = (CARD16 *)dest->data;
494 CARD16 *t = (CARD16 *)src->data + x + y*src->bytes_per_line/sizeof(CARD16);
496 while (u < (CARD16 *)(dest->data + sizeof(CARD16)*dest->height
497 *dest->bytes_per_line/sizeof(CARD16))) {
498 *u++ = t[*distort_matrix++];
502 static void fast_draw_32(XImage *src, XImage *dest, int x, int y, int *distort_matrix) {
503 CARD32 *u = (CARD32 *)dest->data;
504 CARD32 *t = (CARD32 *)src->data + x + y*src->bytes_per_line/sizeof(CARD32);
506 while (u < (CARD32 *)(dest->data + sizeof(CARD32)*dest->height
507 *dest->bytes_per_line/sizeof(CARD32))) {
508 *u++ = t[*distort_matrix++];
512 static void generic_draw(XImage *src, XImage *dest, int x, int y, int *distort_matrix) {
514 for (i = 0; i < dest->width; i++)
515 for (j = 0; j < dest->height; j++)
516 if (from[i][j][0] + x >= 0 &&
517 from[i][j][0] + x < src->width &&
518 from[i][j][1] + y >= 0 &&
519 from[i][j][1] + y < src->height)
520 XPutPixel(dest, i, j,
526 /* generate an XImage of from[][][] and draw it on the screen */
527 static void plain_draw(int k)
529 if (xy_coo[k].x+2*radius+speed+2 > orig_map->width ||
530 xy_coo[k].y+2*radius+speed+2 > orig_map->height)
533 draw_routine(orig_map, buffer_map, xy_coo[k].x, xy_coo[k].y, fast_from);
535 # ifdef HAVE_XSHM_EXTENSION
537 XShmPutImage(g_dpy, g_window, gc, buffer_map, 0, 0, xy_coo[k].x, xy_coo[k].y,
538 2*radius+speed+2, 2*radius+speed+2, False);
543 XPutImage(g_dpy, g_window, gc, buffer_map, 0, 0, xy_coo[k].x, xy_coo[k].y,
544 2*radius+speed+2, 2*radius+speed+2);
549 /* generate an XImage from the reflect algoritm submitted by
550 * Randy Zack <randy@acucorp.com>
551 * draw really got too big and ugly so I split it up
552 * it should be possible to use the from[][] to speed it up
553 * (once I figure out the algorithm used :)
555 static void reflect_draw(int k)
559 int ly, lysq, lx, ny, dist, rsq = radius * radius;
562 if (xy_coo[k].ymove > 0)
564 if (xy_coo[k].xmove > 0)
567 for(i = 0 ; i < 2*radius+speed+2; i++) {
570 ny = xy_coo[k].y + i;
571 for(j = 0 ; j < 2*radius+speed+2 ; j++) {
573 dist = lx * lx + lysq;
575 ly < -radius || ly > radius ||
576 lx < -radius || lx > radius)
577 XPutPixel( buffer_map, j, i,
578 XGetPixel( orig_map, xy_coo[k].x + j, ny ));
580 XPutPixel( buffer_map, j, i, black_pixel );
582 int x = xy_coo[k].x + cx + (lx * rsq / dist);
583 int y = xy_coo[k].y + cy + (ly * rsq / dist);
584 if (x < 0 || x >= xgwa.width ||
585 y < 0 || y >= xgwa.height)
586 XPutPixel( buffer_map, j, i, black_pixel );
588 XPutPixel( buffer_map, j, i,
589 XGetPixel( orig_map, x, y ));
594 XPutImage(g_dpy, g_window, gc, buffer_map, 0, 0, xy_coo[k].x, xy_coo[k].y,
595 2*radius+speed+2, 2*radius+speed+2);
598 /* create a new, random coordinate, that won't interfer with any other
599 * coordinates, as the drawing routines would be significantly slowed
600 * down if they were to handle serveral layers of distortions
602 static void new_rnd_coo(int k)
606 xy_coo[k].x = (random() % (xgwa.width-2*radius));
607 xy_coo[k].y = (random() % (xgwa.height-2*radius));
609 for (i = 0; i < number; i++) {
611 if ((abs(xy_coo[k].x - xy_coo[i].x) <= 2*radius+speed+2)
612 && (abs(xy_coo[k].y - xy_coo[i].y) <= 2*radius+speed+2)) {
613 xy_coo[k].x = (random() % (xgwa.width-2*radius));
614 xy_coo[k].y = (random() % (xgwa.height-2*radius));
621 /* move lens and handle bounces with walls and other lenses */
622 static void move_lense(int k)
626 if (xy_coo[k].x + 2*radius + speed + 2 >= xgwa.width)
627 xy_coo[k].xmove = -abs(xy_coo[k].xmove);
628 if (xy_coo[k].x <= speed)
629 xy_coo[k].xmove = abs(xy_coo[k].xmove);
630 if (xy_coo[k].y + 2*radius + speed + 2 >= xgwa.height)
631 xy_coo[k].ymove = -abs(xy_coo[k].ymove);
632 if (xy_coo[k].y <= speed)
633 xy_coo[k].ymove = abs(xy_coo[k].ymove);
635 xy_coo[k].x = xy_coo[k].x + xy_coo[k].xmove;
636 xy_coo[k].y = xy_coo[k].y + xy_coo[k].ymove;
638 /* bounce against othe lenses */
639 for (i = 0; i < number; i++) {
642 /* This commented test is for rectangular lenses (not currently used) and
643 * the one used is for circular ones
644 && (abs(xy_coo[k].x - xy_coo[i].x) <= 2*radius)
645 && (abs(xy_coo[k].y - xy_coo[i].y) <= 2*radius)) { */
647 && ((xy_coo[k].x - xy_coo[i].x)*(xy_coo[k].x - xy_coo[i].x)
648 + (xy_coo[k].y - xy_coo[i].y)*(xy_coo[k].y - xy_coo[i].y)
649 <= 2*radius*2*radius)) {
654 xy_coo[k].xmove = xy_coo[i].xmove;
655 xy_coo[k].ymove = xy_coo[i].ymove;
663 /* make xy_coo[k] grow/shrink */
664 static void swamp_thing(int k)
666 if (xy_coo[k].r >= radius)
667 xy_coo[k].r_change = -abs(xy_coo[k].r_change);
669 if (xy_coo[k].r <= 0) {
670 from = from_array[0];
672 xy_coo[k].r_change = abs(xy_coo[k].r_change);
674 xy_coo[k].r=xy_coo[k].r_change;
678 xy_coo[k].r = xy_coo[k].r + xy_coo[k].r_change;
680 if (xy_coo[k].r >= radius)
681 xy_coo[k].r = radius;
682 if (xy_coo[k].r <= 0)
685 from = from_array[xy_coo[k].r];
691 char *progclass = "Distort";
693 char *defaults [] = {
694 "*dontClearRoot: True",
695 #ifdef __sgi /* really, HAVE_READ_DISPLAY_EXTENSION */
709 #ifdef HAVE_XSHM_EXTENSION
710 "*useSHM: False", /* xshm turns out not to help. */
711 #endif /* HAVE_XSHM_EXTENSION */
715 XrmOptionDescRec options [] = {
716 { "-delay", ".delay", XrmoptionSepArg, 0 },
717 { "-radius", ".radius", XrmoptionSepArg, 0 },
718 { "-speed", ".speed", XrmoptionSepArg, 0 },
719 { "-number", ".number", XrmoptionSepArg, 0 },
720 { "-swamp", ".swamp", XrmoptionNoArg, "True" },
721 { "-bounce", ".bounce", XrmoptionNoArg, "True" },
722 { "-reflect", ".reflect", XrmoptionNoArg, "True" },
723 { "-vortex", ".vortex", XrmoptionNoArg, "True" },
724 { "-magnify", ".magnify", XrmoptionNoArg, "True" },
725 { "-blackhole", ".blackhole", XrmoptionNoArg, "True" },
726 { "-slow", ".slow", XrmoptionNoArg, "True" },
727 #ifdef HAVE_XSHM_EXTENSION
728 { "-shm", ".useSHM", XrmoptionNoArg, "True" },
729 { "-no-shm", ".useSHM", XrmoptionNoArg, "False" },
730 #endif /* HAVE_XSHM_EXTENSION */
735 void screenhack(Display *dpy, Window window)
739 init_distort (dpy, window);
741 for (k = 0; k < number; k++) {
747 screenhack_handle_events (dpy);
748 if (delay) usleep(delay);