1 /* -*- Mode: C; tab-width: 4 -*- */
2 /* extrusion --- extrusion module for xscreensaver */
4 * Permission to use, copy, modify, and distribute this software and its
5 * documentation for any purpose and without fee is hereby granted,
6 * provided that the above copyright notice appear in all copies and that
7 * both that copyright notice and this permission notice appear in
8 * supporting documentation.
10 * This file is provided AS IS with no warranties of any kind. The author
11 * shall have no liability with respect to the infringement of copyrights,
12 * trade secrets or any patents by this file or any part thereof. In no
13 * event will the author be liable for any lost revenue or profits or
14 * other special, indirect and consequential damages.
17 * Tue Oct 19 22:24:47 PDT 1999 Initial creation by David Konerding
21 * This screensaver requires the GLE ("OpenGL Tubing and Extrusion Library")
22 * which can be obtained from http://www.linas.org/gle/index.html
26 * due to a Bug/feature in VMS X11/Intrinsic.h has to be placed before xlock.
27 * otherwise caddr_t is not defined correctly
30 #include <X11/Intrinsic.h>
37 # define PROGCLASS "Screensaver"
38 # define HACK_INIT init_screensaver
39 # define HACK_DRAW draw_screensaver
40 # define screensaver_opts xlockmore_opts
41 #define DEFAULTS "*light: True \n" \
43 "*texture: False \n" \
44 "*image: BUILTIN \n" \
48 # include "xlockmore.h" /* from the xscreensaver distribution */
49 #else /* !STANDALONE */
50 # include "xlock.h" /* from the xlockmore distribution */
51 #endif /* !STANDALONE */
53 #ifdef USE_GL /* whole file */
57 # ifndef PIXEL_ALREADY_TYPEDEFED
58 # define PIXEL_ALREADY_TYPEDEFED /* Sigh, Xmu/Drawing.h needs this... */
64 # include <X11/Xmu/Drawing.h>
66 # include <Xmu/Drawing.h>
84 #define countof(x) (sizeof((x))/sizeof((*x)))
87 #define checkImageWidth 64
88 #define checkImageHeight 64
91 extern void InitStuff_helix2(void);
92 extern void DrawStuff_helix2(void);
93 extern void InitStuff_helix3(void);
94 extern void DrawStuff_helix3(void);
95 extern void InitStuff_helix4(void);
96 extern void DrawStuff_helix4(void);
97 extern void InitStuff_joinoffset(void);
98 extern void DrawStuff_joinoffset(void);
99 extern void InitStuff_screw(void);
100 extern void DrawStuff_screw(void);
101 extern void InitStuff_taper(void);
102 extern void DrawStuff_taper(void);
103 extern void InitStuff_twistoid(void);
104 extern void DrawStuff_twistoid(void);
111 #define DEF_LIGHT "True"
112 #define DEF_WIRE "False"
113 #define DEF_TEXTURE "False"
114 #define DEF_TEXTURE_QUALITY "False"
115 #define DEF_MIPMAP "False"
116 #define DEF_NAME "RANDOM"
117 #define DEF_IMAGE "BUILTIN"
121 static int do_texture;
122 static int do_texture_quality;
123 static int do_mipmap;
124 static char *which_name;
125 static char *which_image;
127 static XrmOptionDescRec opts[] = {
128 {"-light", ".extrusion.light", XrmoptionNoArg, (caddr_t) "true" },
129 {"+light", ".extrusion.light", XrmoptionNoArg, (caddr_t) "false" },
130 {"-wire", ".extrusion.wire", XrmoptionNoArg, (caddr_t) "true" },
131 {"+wire", ".extrusion.wire", XrmoptionNoArg, (caddr_t) "false" },
132 {"-texture", ".extrusion.texture", XrmoptionNoArg, (caddr_t) "true" },
133 {"+texture", ".extrusion.texture", XrmoptionNoArg, (caddr_t) "false" },
134 {"-texture", ".extrusion.texture", XrmoptionNoArg, (caddr_t) "true" },
135 {"+texture_quality", ".extrusion.texture", XrmoptionNoArg, (caddr_t) "false" },
136 {"-texture_quality", ".extrusion.texture", XrmoptionNoArg, (caddr_t) "true" },
137 {"+mipmap", ".extrusion.mipmap", XrmoptionNoArg, (caddr_t) "false" },
138 {"-mipmap", ".extrusion.mipmap", XrmoptionNoArg, (caddr_t) "true" },
139 {"-name", ".extrusion.name", XrmoptionSepArg, (caddr_t) NULL },
140 {"-image", ".extrusion.image", XrmoptionSepArg, (caddr_t) NULL },
144 static argtype vars[] = {
145 {(caddr_t *) &do_light, "light", "Light", DEF_LIGHT, t_Bool},
146 {(caddr_t *) &do_wire, "wire", "Wire", DEF_WIRE, t_Bool},
147 {(caddr_t *) &do_texture, "texture", "Texture", DEF_TEXTURE, t_Bool},
148 {(caddr_t *) &do_texture_quality, "texture_quality", "Texture_Quality", DEF_TEXTURE_QUALITY, t_Bool},
149 {(caddr_t *) &do_mipmap, "mipmap", "Mipmap", DEF_MIPMAP, t_Bool},
150 {(caddr_t *) &which_name, "name", "Name", DEF_NAME, t_String},
151 {(caddr_t *) &which_image, "image", "Image", DEF_IMAGE, t_String},
155 static OptionStruct desc[] =
157 {"-name num", "example 'name' to draw (helix2, helix3, helix4, joinoffset, screw, taper, twistoid)"},
158 {"-/+ light", "whether to do enable lighting (slower)"},
159 {"-/+ wire", "whether to do use wireframe instead of filled (faster)"},
160 {"-/+ texture", "whether to apply a texture (slower)"},
161 {"-image <filename>", "texture image to load (PPM or PPM4)"},
162 {"-/+ texture_quality", "whether to use texture smoothing (slower)"},
163 {"-/+ mipmap", "whether to use texture mipmap (slower)"},
166 ModeSpecOpt screensaver_opts = {countof(opts), opts, countof(vars), vars, desc};
169 ModStruct screensaver_description =
170 {"screensaver", "init_screensaver", "draw_screensaver", "release_screensaver",
171 "draw_screensaver", "init_screensaver", NULL, &screensaver_opts,
172 1000, 1, 2, 1, 4, 1.0, "",
173 "OpenGL screensaver", 0, NULL};
177 /* structure for holding the screensaver data */
179 int screen_width, screen_height;
180 GLXContext *glx_context;
184 static screensaverstruct *Screensaver = NULL;
189 /* convenient access to the screen width */
190 static int global_width=640, global_height=480;
193 static GLfloat lightOnePosition[] = {40.0, 40, 100.0, 0.0};
194 static GLfloat lightOneColor[] = {0.99, 0.99, 0.99, 1.0};
196 static GLfloat lightTwoPosition[] = {-40.0, 40, 100.0, 0.0};
197 static GLfloat lightTwoColor[] = {0.99, 0.99, 0.99, 1.0};
199 float rot_x=0, rot_y=0, rot_z=0;
200 static float dx=0, dy=0, dz=0;
201 static float ddx=0, ddy=0, ddz=0;
202 static float d_max = 0;
203 static int screensaver_number;
205 static float max_lastx=300, max_lasty=400;
206 static float min_lastx=-400, min_lasty=-400;
207 static float d_lastx=0, d_lasty=0;
208 static float dd_lastx=0, dd_lasty=0;
209 static float max_dlastx=0, max_dlasty=0;
210 float lastx=0, lasty=0;
213 static GLubyte * errString;
216 void (*InitStuff)(void);
217 void (*DrawStuff)(void);
221 /* currently joinoffset and twistoid look funny-
222 like we're looking at them from the back or something
225 struct functions funcs_ptr[] = {
226 {InitStuff_helix2, DrawStuff_helix2, "helix2"},
227 {InitStuff_helix3, DrawStuff_helix3, "helix3"},
228 {InitStuff_helix4, DrawStuff_helix4, "helix4"},
229 {InitStuff_joinoffset, DrawStuff_joinoffset, "joinoffset"},
230 {InitStuff_screw, DrawStuff_screw, "screw"},
231 {InitStuff_taper, DrawStuff_taper, "taper"},
232 {InitStuff_twistoid, DrawStuff_twistoid, "twistoid"},
235 static int num_screensavers = countof(funcs_ptr);
238 /* BEGINNING OF FUNCTIONS */
241 /* check for errors, bail if any. useful for debugging */
242 int checkError(int line, char *file)
244 if((errCode = glGetError()) != GL_NO_ERROR) {
245 errString = (GLubyte *)gluErrorString(errCode);
246 fprintf(stderr, "%s: OpenGL error: %s detected at line %d in file %s\n",
247 progname, errString, line, file);
254 /* generate a checkered image for texturing */
255 GLubyte *Generate_Image(int *width, int *height, int *format)
261 *width = checkImageWidth;
262 *height = checkImageHeight;
263 result = (GLubyte *)malloc(4 * *width * *height);
266 for (i = 0; i < checkImageWidth; i++) {
267 for (j = 0; j < checkImageHeight; j++) {
268 c = (((((i&0x8)==0))^(((j&0x8))==0)))*255;
269 result[counter++] = (GLubyte) c;
270 result[counter++] = (GLubyte) c;
271 result[counter++] = (GLubyte) c;
272 result[counter++] = (GLubyte) 255;
279 /* Load a modified version of PPM format with an extra byte for alpha */
280 GLubyte *LoadPPM4(const char *filename, int *width, int *height, int *format)
288 fp = fopen(filename, "rb");
291 fprintf(stderr, "%s: unable to open file '%s'\n", progname, filename);
292 return Generate_Image(width, height, format);
295 if (!fgets(buff, sizeof(buff), fp))
297 perror("Unable to read header filename\n");
298 return Generate_Image(width, height, format);
301 if (buff[0] != '6' || buff[1] != 'P')
303 fprintf(stderr, "%s: Invalid image format (must be `6P')\n", progname);
304 return Generate_Image(width, height, format);
309 fgets(buff, sizeof(buff), fp);
311 while (buff[0] == '#');
313 if (sscanf(buff, "%d %d", &sizeX, &sizeY) != 2)
315 fprintf(stderr, "%s: error loading image `%s'\n", progname, filename);
316 return Generate_Image(width, height, format);
319 if (fscanf(fp, "%d", &maxval) != 1)
321 fprintf(stderr, "%s: error loading image `%s'\n", progname, filename);
322 return Generate_Image(width, height, format);
325 while (fgetc(fp) != '\n')
328 data = (GLubyte *)malloc(4 * sizeX * sizeY);
331 fprintf(stderr, "%s: unable to allocate memory\n", progname);
335 if (fread(data, 4 * sizeX, sizeY, fp) != sizeY)
337 fprintf(stderr, "%s: error loading image `%s'\n", progname, filename);
338 return Generate_Image(width, height, format);
349 /* Load a plain PPM image */
350 GLubyte *LoadPPM(const char *filename, int *width, int *height, int *format)
358 fp = fopen(filename, "rb");
361 fprintf(stderr, "%s: unable to open file '%s'\n", progname, filename);
362 return Generate_Image(width, height, format);
365 if (!fgets(buff, sizeof(buff), fp))
368 return Generate_Image(width, height, format);
371 if (buff[0] != 'P' || buff[1] != '6')
373 fprintf(stderr, "%s: invalid image format (must be `P6')\n", progname);
374 return Generate_Image(width, height, format);
379 fgets(buff, sizeof(buff), fp);
381 while (buff[0] == '#');
383 if (sscanf(buff, "%d %d", &sizeX, &sizeY) != 2)
385 fprintf(stderr, "%s: error loading image `%s'\n", progname, filename);
386 return Generate_Image(width, height, format);
389 if (fscanf(fp, "%d", &maxval) != 1)
391 fprintf(stderr, "%s: error loading image `%s'\n", progname, filename);
392 return Generate_Image(width, height, format);
395 while (fgetc(fp) != '\n')
398 data = (GLubyte *)malloc(3 * sizeX * sizeY);
401 fprintf(stderr, "%s: unable to allocate memory\n", progname);
405 if (fread(data, 3 * sizeX, sizeY, fp) != sizeY)
407 fprintf(stderr, "%s: error loading image `%s'\n", progname, filename);
408 return Generate_Image(width, height, format);
419 /* create a texture to be applied to the surface
420 this function loads a file using a loader depending on
421 that extension of the file. there is very little error
425 void Create_Texture(char *filename, int do_mipmap, int do_texture_quality)
431 if ( !strncmp(filename, "BUILTIN", 7))
432 image = Generate_Image(&width, &height, &format);
433 else if ( !strncmp((filename+strlen(filename)-3), "ppm", 3))
434 image = LoadPPM(filename, &width, &height, &format);
435 else if ( !strncmp((filename+strlen(filename)-4), "ppm4", 4))
436 image = LoadPPM4(filename, &width, &height, &format);
438 fprintf(stderr, "%s: unknown file format extension: '%s'\n",
443 /* GL_MODULATE or GL_DECAL depending on what you want */
444 glTexEnvf(GL_TEXTURE_ENV, GL_TEXTURE_ENV_MODE, GL_MODULATE);
445 glTexParameterf(GL_TEXTURE_2D, GL_TEXTURE_WRAP_S, GL_REPEAT);
446 glTexParameterf(GL_TEXTURE_2D, GL_TEXTURE_WRAP_T, GL_REPEAT);
447 glPixelStorei(GL_UNPACK_ALIGNMENT, 1);
449 /* default is to do it quick and dirty */
450 /* if you have mipmaps turned on, but not texture quality, nothing will happen! */
451 if (do_texture_quality) {
452 /* with texture_quality, the min and mag filters look *much* nice but are *much* slower */
453 glTexParameterf(GL_TEXTURE_2D, GL_TEXTURE_MAG_FILTER, GL_LINEAR);
454 glTexParameterf(GL_TEXTURE_2D, GL_TEXTURE_MIN_FILTER, GL_LINEAR_MIPMAP_LINEAR);
456 glTexParameterf(GL_TEXTURE_2D, GL_TEXTURE_MAG_FILTER, GL_NEAREST);
457 glTexParameterf(GL_TEXTURE_2D, GL_TEXTURE_MIN_FILTER, GL_NEAREST);
461 gluBuild2DMipmaps(GL_TEXTURE_2D, format, width, height,
462 format, GL_UNSIGNED_BYTE, image);
466 glTexImage2D(GL_TEXTURE_2D, 0, format, width, height, 0,
467 format, GL_UNSIGNED_BYTE, image);
468 check_gl_error("texture");
474 /* mostly lifted from lament.c */
476 rotate (float *pos, float *v, float *dv, float max_v)
491 if (ppos < 0) abort();
492 if (ppos > 360) abort();
493 *pos = (*pos > 0 ? ppos : -ppos);
499 if (*v > max_v || *v < -max_v)
503 /* If it stops, start it going in the other direction. */
510 /* keep going in the same direction */
525 /* Alter direction of rotational acceleration randomly. */
526 if (! (random() % 120))
529 /* Change acceleration very occasionally. */
530 if (! (random() % 200))
534 else if (random() & 1)
543 bounce (float *pos, float *v, float *dv, float max_v)
548 *pos = 1.0, *v = -*v, *dv = -*dv;
550 *pos = 0, *v = -*v, *dv = -*dv;
552 if (*pos < 0.0) abort();
553 if (*pos > 1.0) abort();
559 if (*v > max_v || *v < -max_v)
564 /* Alter direction of rotational acceleration randomly. */
565 if (! (random() % 120))
568 /* Change acceleration very occasionally. */
569 if (! (random() % 200))
573 else if (random() & 1)
584 rot_x = (float) (random() % (360 * 2)) - 360; /* -360 - 360 */
585 rot_y = (float) (random() % (360 * 2)) - 360;
586 rot_z = (float) (random() % (360 * 2)) - 360;
588 /* bell curve from 0-1.5 degrees, avg 0.75 */
589 dx = (frand(1) + frand(1) + frand(1)) / 2.0;
590 dy = (frand(1) + frand(1) + frand(1)) / 2.0;
591 dz = (frand(1) + frand(1) + frand(1)) / 2.0;
599 lastx = (random() % (int) (max_lastx - min_lastx)) + min_lastx;
600 lasty = (random() % (int) (max_lasty - min_lasty)) + min_lasty;
601 d_lastx = (frand(1) + frand(1) + frand(1));
602 d_lasty = (frand(1) + frand(1) + frand(1));
603 max_dlastx = d_lastx * 2;
604 max_dlasty = d_lasty * 2;
610 /* draw the screensaver once */
611 void draw_screensaver(ModeInfo * mi)
613 screensaverstruct *gp = &Screensaver[MI_SCREEN(mi)];
614 Display *display = MI_DISPLAY(mi);
615 Window window = MI_WINDOW(mi);
618 int rootx, rooty, winx, winy;
622 if (!gp->glx_context)
625 glXMakeCurrent(display, window, *(gp->glx_context));
627 funcs_ptr[screensaver_number].DrawStuff();
629 rotate(&rot_x, &dx, &ddx, d_max);
630 rotate(&rot_y, &dy, &ddy, d_max);
631 rotate(&rot_z, &dz, &ddz, d_max);
633 /* swallow any ButtonPress events */
634 while (XCheckMaskEvent (MI_DISPLAY(mi), ButtonPressMask, &event))
636 /* check the pointer position and button state. */
637 XQueryPointer (MI_DISPLAY(mi), MI_WINDOW(mi),
638 &root, &child, &rootx, &rooty, &winx, &winy, &mask);
640 /* track the mouse only if a button is down. */
641 if (mask & (Button1Mask|Button2Mask|Button3Mask|Button4Mask|Button5Mask))
648 float scale = (max_lastx - min_lastx);
657 bounce(&lastx, &d_lastx, &dd_lastx, max_dlastx);
658 bounce(&lasty, &d_lasty, &dd_lasty, max_dlasty);
669 glXSwapBuffers(display, window);
673 /* set up lighting conditions */
674 void SetupLight(void)
676 glLightfv (GL_LIGHT0, GL_POSITION, lightOnePosition);
677 glLightfv (GL_LIGHT0, GL_DIFFUSE, lightOneColor);
678 glLightfv (GL_LIGHT1, GL_POSITION, lightTwoPosition);
679 glLightfv (GL_LIGHT1, GL_DIFFUSE, lightTwoColor);
681 glEnable (GL_LIGHT0);
682 glEnable (GL_LIGHT1);
683 glEnable (GL_LIGHTING);
685 glColorMaterial (GL_FRONT, GL_DIFFUSE);
686 glColorMaterial (GL_BACK, GL_DIFFUSE);
687 glEnable (GL_COLOR_MATERIAL);
690 /* reset the projection matrix */
691 void resetProjection(void) {
692 glMatrixMode(GL_PROJECTION);
694 glFrustum (-9, 9, -9, 9, 50, 150.0);
695 glMatrixMode(GL_MODELVIEW);
699 /* Standard reshape function */
701 reshape(int width, int height)
704 global_height=height;
705 glViewport( 0, 0, global_width, global_height );
710 /* decide which screensaver example to run */
711 void chooseScreensaverExample(void) {
713 /* call the extrusion init routine */
715 if (!strncmp(which_name, "RANDOM", strlen(which_name))) {
716 screensaver_number = random() % num_screensavers;
719 screensaver_number=-1;
720 for (i=0; i < num_screensavers; i++) {
721 if (!strncmp(which_name, funcs_ptr[i].name, strlen(which_name))) {
722 screensaver_number = i;
727 if (screensaver_number < 0 || screensaver_number >= num_screensavers) {
728 fprintf(stderr, "%s: invalid screensaver example number!\n", progname);
729 fprintf(stderr, "%s: known screensavers:\n", progname);
730 for (i=0; i < num_screensavers; i++)
731 fprintf(stderr,"\t%s\n", funcs_ptr[i].name);
735 funcs_ptr[screensaver_number].InitStuff();
738 /* main OpenGL initialization routine */
739 void initializeGL(GLsizei width, GLsizei height)
744 reshape(width, height);
745 glViewport( 0, 0, width, height );
747 glEnable(GL_DEPTH_TEST);
748 glClearColor(0,0,0,0);
749 /* glCullFace(GL_BACK); */
750 /* glEnable(GL_CULL_FACE); */
751 glShadeModel(GL_SMOOTH);
756 glPolygonMode(GL_FRONT,GL_LINE);
757 glPolygonMode(GL_BACK,GL_LINE);
760 Create_Texture(which_image, do_mipmap, do_texture_quality);
761 glEnable(GL_TEXTURE_2D);
763 /* configure the pipeline */
765 style |= TUBE_CONTOUR_CLOSED;
766 style |= TUBE_NORM_FACET;
767 style |= TUBE_JN_ANGLE;
768 gleSetJoinStyle (style);
771 mode = GLE_TEXTURE_ENABLE | GLE_TEXTURE_VERTEX_MODEL_FLAT;
772 glMatrixMode (GL_TEXTURE); glLoadIdentity ();
773 glScalef (0.25, 0.1, 1); glMatrixMode (GL_MODELVIEW);
774 gleTextureMode (mode);
780 /* xscreensaver initialization routine */
781 void init_screensaver(ModeInfo * mi)
783 int screen = MI_SCREEN(mi);
784 screensaverstruct *gp;
786 if (Screensaver == NULL) {
787 if ((Screensaver = (screensaverstruct *) calloc(MI_NUM_SCREENS(mi), sizeof (screensaverstruct))) == NULL)
790 gp = &Screensaver[screen];
792 gp->window = MI_WINDOW(mi);
793 if ((gp->glx_context = init_GL(mi)) != NULL) {
794 reshape(MI_WIDTH(mi), MI_HEIGHT(mi));
795 initializeGL(MI_WIDTH(mi), MI_HEIGHT(mi));
796 chooseScreensaverExample();
803 /* all sorts of nice cleanup code should go here! */
804 void release_screensaver(ModeInfo * mi)
807 if (Screensaver != NULL) {
808 for (screen = 0; screen < MI_NUM_SCREENS(mi); screen++) {
809 /* screensaverstruct *gp = &Screensaver[screen];*/
811 (void) free((void *) Screensaver);