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 if (effect == NULL && radius == 0 && speed == 0 && number == 0
117 && !blackhole && !vortex && !magnify && !reflect) {
118 /* if no cmdline options are given, randomly choose one of:
119 * -radius 50 -number 4 -speed 1 -bounce
120 * -radius 50 -number 4 -speed 1 -blackhole
121 * -radius 50 -number 4 -speed 1 -vortex
122 * -radius 50 -number 4 -speed 1 -vortex -magnify
123 * -radius 50 -number 4 -speed 1 -vortex -magnify -blackhole
124 * -radius 100 -number 1 -speed 2 -bounce
125 * -radius 100 -number 1 -speed 2 -blackhole
126 * -radius 100 -number 1 -speed 2 -vortex
127 * -radius 100 -number 1 -speed 2 -vortex -magnify
128 * -radius 100 -number 1 -speed 2 -vortex -magnify -blackhole
129 * -radius 80 -number 1 -speed 2 -reflect
130 * -radius 50 -number 3 -speed 2 -reflect
132 * -radius 50 -number 4 -speed 2 -swamp
133 * -radius 50 -number 4 -speed 2 -swamp -blackhole
134 * -radius 50 -number 4 -speed 2 -swamp -vortex
135 * -radius 50 -number 4 -speed 2 -swamp -vortex -magnify
136 * -radius 50 -number 4 -speed 2 -swamp -vortex -magnify -blackhole
139 i = (random() % 12 /* 17 */);
145 radius=50;number=4;speed=1;
146 effect=&move_lense;break;
148 radius=50;number=4;speed=1;blackhole=1;
149 effect=&move_lense;break;
151 radius=50;number=4;speed=1;vortex=1;
152 effect=&move_lense;break;
154 radius=50;number=4;speed=1;vortex=1;magnify=1;
155 effect=&move_lense;break;
157 radius=50;number=4;speed=1;vortex=1;magnify=1;blackhole=1;
158 effect=&move_lense;break;
160 radius=100;number=1;speed=2;
161 effect=&move_lense;break;
163 radius=100;number=1;speed=2;blackhole=1;
164 effect=&move_lense;break;
166 radius=100;number=1;speed=2;vortex=1;
167 effect=&move_lense;break;
169 radius=100;number=1;speed=2;vortex=1;magnify=1;
170 effect=&move_lense;break;
172 radius=100;number=1;speed=2;vortex=1;magnify=1;blackhole=1;
173 effect=&move_lense;break;
176 radius=80;number=1;speed=2;reflect=1;
177 draw = &reflect_draw;effect = &move_lense;break;
179 radius=50;number=4;speed=2;reflect=1;
180 draw = &reflect_draw;effect = &move_lense;break;
182 #if 0 /* jwz: not these */
184 radius=50;number=4;speed=2;
185 effect=&swamp_thing;break;
187 radius=50;number=4;speed=2;blackhole=1;
188 effect=&swamp_thing;break;
190 radius=50;number=4;speed=2;vortex=1;
191 effect=&swamp_thing;break;
193 radius=50;number=4;speed=2;vortex=1;magnify=1;
194 effect=&swamp_thing;break;
196 radius=50;number=4;speed=2;vortex=1;magnify=1;blackhole=1;
197 effect=&swamp_thing;break;
217 effect = &move_lense;
219 draw = &reflect_draw;
220 effect = &move_lense;
225 XGetWindowAttributes (dpy, window, &xgwa);
226 black_pixel = BlackPixelOfScreen( xgwa.screen );
228 gcv.function = GXcopy;
229 gcv.subwindow_mode = IncludeInferiors;
230 gcflags = GCForeground |GCFunction;
231 if (use_subwindow_mode_p(xgwa.screen, window)) /* see grabscreen.c */
232 gcflags |= GCSubwindowMode;
233 gc = XCreateGC (dpy, window, gcflags, &gcv);
235 grab_screen_image (xgwa.screen, window);
238 orig_map = XGetImage(dpy, window, 0, 0, xgwa.width, xgwa.height,
240 buffer_map_cache = malloc(sizeof(unsigned long)*(2*radius+speed+2)*(2*radius+speed+2));
242 if (buffer_map_cache == NULL) {
247 # ifdef HAVE_XSHM_EXTENSION
251 buffer_map = create_xshm_image(dpy, xgwa.visual, orig_map->depth,
252 ZPixmap, 0, &shm_info,
253 2*radius + speed + 2,
254 2*radius + speed + 2);
258 # endif /* HAVE_XSHM_EXTENSION */
262 buffer_map = XCreateImage(dpy, xgwa.visual,
263 orig_map->depth, ZPixmap, 0, 0,
264 2*radius + speed + 2, 2*radius + speed + 2,
266 buffer_map->data = (char *)
267 calloc(buffer_map->height, buffer_map->bytes_per_line);
270 if ((buffer_map->byte_order == orig_map->byte_order)
271 && (buffer_map->depth == orig_map->depth)
272 && (buffer_map->format == ZPixmap)
273 && (orig_map->format == ZPixmap)
275 switch (orig_map->bits_per_pixel) {
277 draw_routine = &fast_draw_32;
278 bpp_size = sizeof(CARD32);
281 draw_routine = &fast_draw_16;
282 bpp_size = sizeof(CARD16);
285 draw_routine = &fast_draw_8;
286 bpp_size = sizeof(CARD8);
289 draw_routine = &generic_draw;
293 draw_routine = &generic_draw;
297 for (i = 0; i < number; i++) {
300 xy_coo[i].r = (i*radius)/(number-1); /* "randomize" initial */
303 xy_coo[i].r_change = speed + (i%2)*2*(-speed); /* values a bit */
304 xy_coo[i].xmove = speed + (i%2)*2*(-speed);
305 xy_coo[i].ymove = speed + (i%2)*2*(-speed);
310 /* example: initializes a "see-trough" matrix */
311 /* static void make_null_lense(void)
314 for (i = 0; i < 2*radius+speed+2; i++) {
315 for (j = 0 ; j < 2*radius+speed+2 ; j++) {
322 static void convert(void) {
325 fast_from = calloc(1, sizeof(int)*((buffer_map->bytes_per_line/bpp_size)*(2*radius+speed+2) + 2*radius+speed+2));
326 if (fast_from == NULL) {
331 for (i = 0; i < 2*radius+speed+2; i++) {
332 for (j = 0; j < 2*radius+speed+2; j++) {
333 *(p + i + j*buffer_map->bytes_per_line/bpp_size)
334 = from[i][j][0] + xgwa.width*from[i][j][1];
335 if (*(p + i + j*buffer_map->bytes_per_line/bpp_size) < 0
336 || *(p + i + j*buffer_map->bytes_per_line/bpp_size) >= orig_map->height*orig_map->width) {
337 *(p + i + j*buffer_map->bytes_per_line/bpp_size) = 0;
343 /* makes a lense with the Radius=loop and centred in
344 * the point (radius, radius)
346 static void make_round_lense(int radius, int loop)
350 for (i = 0; i < 2*radius+speed+2; i++) {
351 for(j = 0; j < ((0 == bpp_size) ? (2*radius+speed+2) : (buffer_map->bytes_per_line/bpp_size)); j++) {
353 r = sqrt ((i-radius)*(i-radius)+(j-radius)*(j-radius));
361 if (vortex) { /* vortex-twist effect */
363 /* this one-line formula for getting a nice rotation angle is borrowed
364 * (with permission) from the whirl plugin for gimp,
365 * Copyright (C) 1996 Federico Mena Quintero
367 /* 5 is just a constant used because it looks good :) */
368 angle = 5*(1-d)*(1-d);
370 /* Avoid atan2: DOMAIN error message */
371 if ((radius-j) == 0.0 && (radius-i) == 0.0) {
372 from[i][j][0] = radius + cos(angle)*r;
373 from[i][j][1] = radius + sin(angle)*r;
375 from[i][j][0] = radius +
376 cos(angle - atan2(radius-j, -(radius-i)))*r;
377 from[i][j][1] = radius +
378 sin(angle - atan2(radius-j, -(radius-i)))*r;
382 if (blackhole && r != 0) /* blackhole effect */
384 from[i][j][0] = radius + (from[i][j][0]-radius)*r;
385 from[i][j][1] = radius + (from[i][j][1]-radius)*r;
387 } else { /* default is to magnify */
390 /* raising r to different power here gives different amounts of
391 * distortion, a negative value sucks everything into a black hole
394 if (blackhole && r != 0) /* blackhole effect */
396 /* bubble effect (and blackhole) */
397 from[i][j][0] = radius + (i-radius)*r;
398 from[i][j][1] = radius + (j-radius)*r;
400 } else { /* not inside loop */
407 /* this is really just a quick hack to keep both the compability mode with all depths and still
408 * allow the custom optimized draw routines with the minimum amount of work */
415 # define EXIT_FAILURE -1
418 static void allocate_lense(void)
421 int s = ((0 != bpp_size) ? (buffer_map->bytes_per_line/bpp_size) : (2*radius+speed+2));
422 /* maybe this should be redone so that from[][][] is in one block;
423 * then pointers could be used instead of arrays in some places (and
424 * maybe give a speedup - maybe also consume less memory)
426 from = (int ***)malloc(s*sizeof(int **));
431 for (i = 0; i < s; i++) {
432 from[i] = (int **)malloc((2*radius+speed+2) * sizeof(int *));
433 if (from[i] == NULL) {
437 for (j = 0; j < s; j++) {
438 from[i][j] = (int *)malloc(2 * sizeof(int));
439 if (from[i][j] == NULL) {
447 /* from_array in an array containing precalculated from matrices,
448 * this is a double faced mem vs speed trade, it's faster, but eats
449 * _a lot_ of mem for large radius (is there a bug here? I can't see it)
451 static void init_round_lense(void)
455 if (effect == &swamp_thing) {
456 from_array = (int ****)malloc((radius+1)*sizeof(int ***));
457 for (k=0; k <= radius; k++) {
459 make_round_lense(radius, k);
460 from_array[k] = from;
462 } else { /* just allocate one from[][][] */
464 make_round_lense(radius,radius);
468 /* If fast_draw_8, fast_draw_16 or fast_draw_32 are to be used, the following properties
469 * of the src and dest XImages must hold (otherwise the generic, slooow, method provided
470 * by X is to be used):
471 * src->byte_order == dest->byte_order
472 * src->format == ZPixmap && dest->format == ZPixmap
473 * src->depth == dest->depth == the depth the function in question asumes
474 * x and y is the coordinates in src from where to cut out the image from,
475 * distort_matrix is a precalculated array of how to distort the matrix
478 static void fast_draw_8(XImage *src, XImage *dest, int x, int y, int *distort_matrix) {
479 CARD8 *u = (CARD8 *)dest->data;
480 CARD8 *t = (CARD8 *)src->data + x + y*src->bytes_per_line/sizeof(CARD8);
482 while (u < (CARD8 *)(dest->data + sizeof(CARD8)*dest->height
483 *dest->bytes_per_line/sizeof(CARD8))) {
484 *u++ = t[*distort_matrix++];
488 static void fast_draw_16(XImage *src, XImage *dest, int x, int y, int *distort_matrix) {
489 CARD16 *u = (CARD16 *)dest->data;
490 CARD16 *t = (CARD16 *)src->data + x + y*src->bytes_per_line/sizeof(CARD16);
492 while (u < (CARD16 *)(dest->data + sizeof(CARD16)*dest->height
493 *dest->bytes_per_line/sizeof(CARD16))) {
494 *u++ = t[*distort_matrix++];
498 static void fast_draw_32(XImage *src, XImage *dest, int x, int y, int *distort_matrix) {
499 CARD32 *u = (CARD32 *)dest->data;
500 CARD32 *t = (CARD32 *)src->data + x + y*src->bytes_per_line/sizeof(CARD32);
502 while (u < (CARD32 *)(dest->data + sizeof(CARD32)*dest->height
503 *dest->bytes_per_line/sizeof(CARD32))) {
504 *u++ = t[*distort_matrix++];
508 static void generic_draw(XImage *src, XImage *dest, int x, int y, int *distort_matrix) {
510 for (i = 0; i < dest->width; i++)
511 for (j = 0; j < dest->height; j++)
512 if (from[i][j][0] + x >= 0 &&
513 from[i][j][0] + x < src->width &&
514 from[i][j][1] + y >= 0 &&
515 from[i][j][1] + y < src->height)
516 XPutPixel(dest, i, j,
522 /* generate an XImage of from[][][] and draw it on the screen */
523 static void plain_draw(int k)
525 if (xy_coo[k].x+2*radius+speed+2 > orig_map->width ||
526 xy_coo[k].y+2*radius+speed+2 > orig_map->height)
529 draw_routine(orig_map, buffer_map, xy_coo[k].x, xy_coo[k].y, fast_from);
531 # ifdef HAVE_XSHM_EXTENSION
533 XShmPutImage(g_dpy, g_window, gc, buffer_map, 0, 0, xy_coo[k].x, xy_coo[k].y,
534 2*radius+speed+2, 2*radius+speed+2, False);
539 XPutImage(g_dpy, g_window, gc, buffer_map, 0, 0, xy_coo[k].x, xy_coo[k].y,
540 2*radius+speed+2, 2*radius+speed+2);
545 /* generate an XImage from the reflect algoritm submitted by
546 * Randy Zack <randy@acucorp.com>
547 * draw really got too big and ugly so I split it up
548 * it should be possible to use the from[][] to speed it up
549 * (once I figure out the algorithm used :)
551 static void reflect_draw(int k)
555 int ly, lysq, lx, ny, dist, rsq = radius * radius;
558 if (xy_coo[k].ymove > 0)
560 if (xy_coo[k].xmove > 0)
563 for(i = 0 ; i < 2*radius+speed+2; i++) {
566 ny = xy_coo[k].y + i;
567 for(j = 0 ; j < 2*radius+speed+2 ; j++) {
569 dist = lx * lx + lysq;
571 ly < -radius || ly > radius ||
572 lx < -radius || lx > radius)
573 XPutPixel( buffer_map, j, i,
574 XGetPixel( orig_map, xy_coo[k].x + j, ny ));
576 XPutPixel( buffer_map, j, i, black_pixel );
578 int x = xy_coo[k].x + cx + (lx * rsq / dist);
579 int y = xy_coo[k].y + cy + (ly * rsq / dist);
580 if (x < 0 || x >= xgwa.width ||
581 y < 0 || y >= xgwa.height)
582 XPutPixel( buffer_map, j, i, black_pixel );
584 XPutPixel( buffer_map, j, i,
585 XGetPixel( orig_map, x, y ));
590 XPutImage(g_dpy, g_window, gc, buffer_map, 0, 0, xy_coo[k].x, xy_coo[k].y,
591 2*radius+speed+2, 2*radius+speed+2);
594 /* create a new, random coordinate, that won't interfer with any other
595 * coordinates, as the drawing routines would be significantly slowed
596 * down if they were to handle serveral layers of distortions
598 static void new_rnd_coo(int k)
602 xy_coo[k].x = (random() % (xgwa.width-2*radius));
603 xy_coo[k].y = (random() % (xgwa.height-2*radius));
605 for (i = 0; i < number; i++) {
607 if ((abs(xy_coo[k].x - xy_coo[i].x) <= 2*radius+speed+2)
608 && (abs(xy_coo[k].y - xy_coo[i].y) <= 2*radius+speed+2)) {
609 xy_coo[k].x = (random() % (xgwa.width-2*radius));
610 xy_coo[k].y = (random() % (xgwa.height-2*radius));
617 /* move lens and handle bounces with walls and other lenses */
618 static void move_lense(int k)
622 if (xy_coo[k].x + 2*radius + speed + 2 >= xgwa.width)
623 xy_coo[k].xmove = -abs(xy_coo[k].xmove);
624 if (xy_coo[k].x <= speed)
625 xy_coo[k].xmove = abs(xy_coo[k].xmove);
626 if (xy_coo[k].y + 2*radius + speed + 2 >= xgwa.height)
627 xy_coo[k].ymove = -abs(xy_coo[k].ymove);
628 if (xy_coo[k].y <= speed)
629 xy_coo[k].ymove = abs(xy_coo[k].ymove);
631 xy_coo[k].x = xy_coo[k].x + xy_coo[k].xmove;
632 xy_coo[k].y = xy_coo[k].y + xy_coo[k].ymove;
634 /* bounce against othe lenses */
635 for (i = 0; i < number; i++) {
638 /* This commented test is for rectangular lenses (not currently used) and
639 * the one used is for circular ones
640 && (abs(xy_coo[k].x - xy_coo[i].x) <= 2*radius)
641 && (abs(xy_coo[k].y - xy_coo[i].y) <= 2*radius)) { */
643 && ((xy_coo[k].x - xy_coo[i].x)*(xy_coo[k].x - xy_coo[i].x)
644 + (xy_coo[k].y - xy_coo[i].y)*(xy_coo[k].y - xy_coo[i].y)
645 <= 2*radius*2*radius)) {
650 xy_coo[k].xmove = xy_coo[i].xmove;
651 xy_coo[k].ymove = xy_coo[i].ymove;
659 /* make xy_coo[k] grow/shrink */
660 static void swamp_thing(int k)
662 if (xy_coo[k].r >= radius)
663 xy_coo[k].r_change = -abs(xy_coo[k].r_change);
665 if (xy_coo[k].r <= 0) {
666 from = from_array[0];
668 xy_coo[k].r_change = abs(xy_coo[k].r_change);
670 xy_coo[k].r=xy_coo[k].r_change;
674 xy_coo[k].r = xy_coo[k].r + xy_coo[k].r_change;
676 if (xy_coo[k].r >= radius)
677 xy_coo[k].r = radius;
678 if (xy_coo[k].r <= 0)
681 from = from_array[xy_coo[k].r];
687 char *progclass = "Distort";
689 char *defaults [] = {
690 "*dontClearRoot: True",
691 #ifdef __sgi /* really, HAVE_READ_DISPLAY_EXTENSION */
705 #ifdef HAVE_XSHM_EXTENSION
706 "*useSHM: False", /* xshm turns out not to help. */
707 #endif /* HAVE_XSHM_EXTENSION */
711 XrmOptionDescRec options [] = {
712 { "-delay", ".delay", XrmoptionSepArg, 0 },
713 { "-radius", ".radius", XrmoptionSepArg, 0 },
714 { "-speed", ".speed", XrmoptionSepArg, 0 },
715 { "-number", ".number", XrmoptionSepArg, 0 },
716 { "-swamp", ".swamp", XrmoptionNoArg, "True" },
717 { "-bounce", ".bounce", XrmoptionNoArg, "True" },
718 { "-reflect", ".reflect", XrmoptionNoArg, "True" },
719 { "-vortex", ".vortex", XrmoptionNoArg, "True" },
720 { "-magnify", ".magnify", XrmoptionNoArg, "True" },
721 { "-blackhole", ".blackhole", XrmoptionNoArg, "True" },
722 { "-slow", ".slow", XrmoptionNoArg, "True" },
723 #ifdef HAVE_XSHM_EXTENSION
724 { "-shm", ".useSHM", XrmoptionNoArg, "True" },
725 { "-no-shm", ".useSHM", XrmoptionNoArg, "False" },
726 #endif /* HAVE_XSHM_EXTENSION */
731 void screenhack(Display *dpy, Window window)
735 init_distort (dpy, window);
737 for (k = 0; k < number; k++) {
743 screenhack_handle_events (dpy);
744 if (delay) usleep(delay);