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 HACK_RESHAPE reshape_screensaver
41 # define screensaver_opts xlockmore_opts
42 #define DEFAULTS "*delay: 10000 \n" \
43 "*showFPS: False \n" \
46 "*texture: False \n" \
47 "*image: BUILTIN \n" \
51 # include "xlockmore.h" /* from the xscreensaver distribution */
52 #else /* !STANDALONE */
53 # include "xlock.h" /* from the xlockmore distribution */
54 #endif /* !STANDALONE */
56 #ifdef USE_GL /* whole file */
60 # include <X11/Xmu/Drawing.h>
62 # include <Xmu/Drawing.h>
80 #define countof(x) (sizeof((x))/sizeof((*x)))
83 #define checkImageWidth 64
84 #define checkImageHeight 64
87 extern void InitStuff_helix2(void);
88 extern void DrawStuff_helix2(void);
89 extern void InitStuff_helix3(void);
90 extern void DrawStuff_helix3(void);
91 extern void InitStuff_helix4(void);
92 extern void DrawStuff_helix4(void);
93 extern void InitStuff_joinoffset(void);
94 extern void DrawStuff_joinoffset(void);
95 extern void InitStuff_screw(void);
96 extern void DrawStuff_screw(void);
97 extern void InitStuff_taper(void);
98 extern void DrawStuff_taper(void);
99 extern void InitStuff_twistoid(void);
100 extern void DrawStuff_twistoid(void);
107 #define DEF_LIGHT "True"
108 #define DEF_WIRE "False"
109 #define DEF_TEXTURE "False"
110 #define DEF_TEXTURE_QUALITY "False"
111 #define DEF_MIPMAP "False"
112 #define DEF_NAME "RANDOM"
113 #define DEF_IMAGE "BUILTIN"
117 static int do_texture;
118 static int do_texture_quality;
119 static int do_mipmap;
120 static char *which_name;
121 static char *which_image;
123 static XrmOptionDescRec opts[] = {
124 {"-light", ".extrusion.light", XrmoptionNoArg, (caddr_t) "true" },
125 {"+light", ".extrusion.light", XrmoptionNoArg, (caddr_t) "false" },
126 {"-wire", ".extrusion.wire", XrmoptionNoArg, (caddr_t) "true" },
127 {"+wire", ".extrusion.wire", XrmoptionNoArg, (caddr_t) "false" },
128 {"-texture", ".extrusion.texture", XrmoptionNoArg, (caddr_t) "true" },
129 {"+texture", ".extrusion.texture", XrmoptionNoArg, (caddr_t) "false" },
130 {"-texture", ".extrusion.texture", XrmoptionNoArg, (caddr_t) "true" },
131 {"+texture_quality", ".extrusion.texture", XrmoptionNoArg, (caddr_t) "false" },
132 {"-texture_quality", ".extrusion.texture", XrmoptionNoArg, (caddr_t) "true" },
133 {"+mipmap", ".extrusion.mipmap", XrmoptionNoArg, (caddr_t) "false" },
134 {"-mipmap", ".extrusion.mipmap", XrmoptionNoArg, (caddr_t) "true" },
135 {"-name", ".extrusion.name", XrmoptionSepArg, (caddr_t) NULL },
136 {"-image", ".extrusion.image", XrmoptionSepArg, (caddr_t) NULL },
140 static argtype vars[] = {
141 {(caddr_t *) &do_light, "light", "Light", DEF_LIGHT, t_Bool},
142 {(caddr_t *) &do_wire, "wire", "Wire", DEF_WIRE, t_Bool},
143 {(caddr_t *) &do_texture, "texture", "Texture", DEF_TEXTURE, t_Bool},
144 {(caddr_t *) &do_texture_quality, "texture_quality", "Texture_Quality", DEF_TEXTURE_QUALITY, t_Bool},
145 {(caddr_t *) &do_mipmap, "mipmap", "Mipmap", DEF_MIPMAP, t_Bool},
146 {(caddr_t *) &which_name, "name", "Name", DEF_NAME, t_String},
147 {(caddr_t *) &which_image, "image", "Image", DEF_IMAGE, t_String},
151 static OptionStruct desc[] =
153 {"-name num", "example 'name' to draw (helix2, helix3, helix4, joinoffset, screw, taper, twistoid)"},
154 {"-/+ light", "whether to do enable lighting (slower)"},
155 {"-/+ wire", "whether to do use wireframe instead of filled (faster)"},
156 {"-/+ texture", "whether to apply a texture (slower)"},
157 {"-image <filename>", "texture image to load (PPM or PPM4)"},
158 {"-/+ texture_quality", "whether to use texture smoothing (slower)"},
159 {"-/+ mipmap", "whether to use texture mipmap (slower)"},
162 ModeSpecOpt screensaver_opts = {countof(opts), opts, countof(vars), vars, desc};
165 ModStruct screensaver_description =
166 {"screensaver", "init_screensaver", "draw_screensaver", "release_screensaver",
167 "draw_screensaver", "init_screensaver", NULL, &screensaver_opts,
168 1000, 1, 2, 1, 4, 1.0, "",
169 "OpenGL screensaver", 0, NULL};
173 /* structure for holding the screensaver data */
175 int screen_width, screen_height;
176 GLXContext *glx_context;
180 static screensaverstruct *Screensaver = NULL;
185 /* convenient access to the screen width */
186 static int global_width=640, global_height=480;
189 static GLfloat lightOnePosition[] = {40.0, 40, 100.0, 0.0};
190 static GLfloat lightOneColor[] = {0.99, 0.99, 0.99, 1.0};
192 static GLfloat lightTwoPosition[] = {-40.0, 40, 100.0, 0.0};
193 static GLfloat lightTwoColor[] = {0.99, 0.99, 0.99, 1.0};
195 float rot_x=0, rot_y=0, rot_z=0;
196 static float dx=0, dy=0, dz=0;
197 static float ddx=0, ddy=0, ddz=0;
198 static float d_max = 0;
199 static int screensaver_number;
201 static float max_lastx=300, max_lasty=400;
202 static float min_lastx=-400, min_lasty=-400;
203 static float d_lastx=0, d_lasty=0;
204 static float dd_lastx=0, dd_lasty=0;
205 static float max_dlastx=0, max_dlasty=0;
206 float lastx=0, lasty=0;
209 static GLubyte * errString;
212 void (*InitStuff)(void);
213 void (*DrawStuff)(void);
217 /* currently joinoffset and twistoid look funny-
218 like we're looking at them from the back or something
221 struct functions funcs_ptr[] = {
222 {InitStuff_helix2, DrawStuff_helix2, "helix2"},
223 {InitStuff_helix3, DrawStuff_helix3, "helix3"},
224 {InitStuff_helix4, DrawStuff_helix4, "helix4"},
225 {InitStuff_joinoffset, DrawStuff_joinoffset, "joinoffset"},
226 {InitStuff_screw, DrawStuff_screw, "screw"},
227 {InitStuff_taper, DrawStuff_taper, "taper"},
228 {InitStuff_twistoid, DrawStuff_twistoid, "twistoid"},
231 static int num_screensavers = countof(funcs_ptr);
234 /* BEGINNING OF FUNCTIONS */
237 /* check for errors, bail if any. useful for debugging */
238 int checkError(int line, char *file)
240 if((errCode = glGetError()) != GL_NO_ERROR) {
241 errString = (GLubyte *)gluErrorString(errCode);
242 fprintf(stderr, "%s: OpenGL error: %s detected at line %d in file %s\n",
243 progname, errString, line, file);
250 /* generate a checkered image for texturing */
251 GLubyte *Generate_Image(int *width, int *height, int *format)
257 *width = checkImageWidth;
258 *height = checkImageHeight;
259 result = (GLubyte *)malloc(4 * *width * *height);
262 for (i = 0; i < checkImageWidth; i++) {
263 for (j = 0; j < checkImageHeight; j++) {
264 c = (((((i&0x8)==0))^(((j&0x8))==0)))*255;
265 result[counter++] = (GLubyte) c;
266 result[counter++] = (GLubyte) c;
267 result[counter++] = (GLubyte) c;
268 result[counter++] = (GLubyte) 255;
275 /* Load a modified version of PPM format with an extra byte for alpha */
276 GLubyte *LoadPPM4(const char *filename, int *width, int *height, int *format)
284 fp = fopen(filename, "rb");
287 fprintf(stderr, "%s: unable to open file '%s'\n", progname, filename);
288 return Generate_Image(width, height, format);
291 if (!fgets(buff, sizeof(buff), fp))
293 perror("Unable to read header filename\n");
294 return Generate_Image(width, height, format);
297 if (buff[0] != '6' || buff[1] != 'P')
299 fprintf(stderr, "%s: Invalid image format (must be `6P')\n", progname);
300 return Generate_Image(width, height, format);
305 fgets(buff, sizeof(buff), fp);
307 while (buff[0] == '#');
309 if (sscanf(buff, "%d %d", &sizeX, &sizeY) != 2)
311 fprintf(stderr, "%s: error loading image `%s'\n", progname, filename);
312 return Generate_Image(width, height, format);
315 if (fscanf(fp, "%d", &maxval) != 1)
317 fprintf(stderr, "%s: error loading image `%s'\n", progname, filename);
318 return Generate_Image(width, height, format);
321 while (fgetc(fp) != '\n')
324 data = (GLubyte *)malloc(4 * sizeX * sizeY);
327 fprintf(stderr, "%s: unable to allocate memory\n", progname);
331 if (fread(data, 4 * sizeX, sizeY, fp) != sizeY)
333 fprintf(stderr, "%s: error loading image `%s'\n", progname, filename);
334 return Generate_Image(width, height, format);
345 /* Load a plain PPM image */
346 GLubyte *LoadPPM(const char *filename, int *width, int *height, int *format)
354 fp = fopen(filename, "rb");
357 fprintf(stderr, "%s: unable to open file '%s'\n", progname, filename);
358 return Generate_Image(width, height, format);
361 if (!fgets(buff, sizeof(buff), fp))
364 return Generate_Image(width, height, format);
367 if (buff[0] != 'P' || buff[1] != '6')
369 fprintf(stderr, "%s: invalid image format (must be `P6')\n", progname);
370 return Generate_Image(width, height, format);
375 fgets(buff, sizeof(buff), fp);
377 while (buff[0] == '#');
379 if (sscanf(buff, "%d %d", &sizeX, &sizeY) != 2)
381 fprintf(stderr, "%s: error loading image `%s'\n", progname, filename);
382 return Generate_Image(width, height, format);
385 if (fscanf(fp, "%d", &maxval) != 1)
387 fprintf(stderr, "%s: error loading image `%s'\n", progname, filename);
388 return Generate_Image(width, height, format);
391 while (fgetc(fp) != '\n')
394 data = (GLubyte *)malloc(3 * sizeX * sizeY);
397 fprintf(stderr, "%s: unable to allocate memory\n", progname);
401 if (fread(data, 3 * sizeX, sizeY, fp) != sizeY)
403 fprintf(stderr, "%s: error loading image `%s'\n", progname, filename);
404 return Generate_Image(width, height, format);
415 /* create a texture to be applied to the surface
416 this function loads a file using a loader depending on
417 that extension of the file. there is very little error
421 void Create_Texture(char *filename, int do_mipmap, int do_texture_quality)
427 if ( !strncmp(filename, "BUILTIN", 7))
428 image = Generate_Image(&width, &height, &format);
429 else if ( !strncmp((filename+strlen(filename)-3), "ppm", 3))
430 image = LoadPPM(filename, &width, &height, &format);
431 else if ( !strncmp((filename+strlen(filename)-4), "ppm4", 4))
432 image = LoadPPM4(filename, &width, &height, &format);
434 fprintf(stderr, "%s: unknown file format extension: '%s'\n",
439 /* GL_MODULATE or GL_DECAL depending on what you want */
440 glTexEnvf(GL_TEXTURE_ENV, GL_TEXTURE_ENV_MODE, GL_MODULATE);
441 glTexParameterf(GL_TEXTURE_2D, GL_TEXTURE_WRAP_S, GL_REPEAT);
442 glTexParameterf(GL_TEXTURE_2D, GL_TEXTURE_WRAP_T, GL_REPEAT);
443 glPixelStorei(GL_UNPACK_ALIGNMENT, 1);
445 /* default is to do it quick and dirty */
446 /* if you have mipmaps turned on, but not texture quality, nothing will happen! */
447 if (do_texture_quality) {
448 /* with texture_quality, the min and mag filters look *much* nice but are *much* slower */
449 glTexParameterf(GL_TEXTURE_2D, GL_TEXTURE_MAG_FILTER, GL_LINEAR);
450 glTexParameterf(GL_TEXTURE_2D, GL_TEXTURE_MIN_FILTER, GL_LINEAR_MIPMAP_LINEAR);
452 glTexParameterf(GL_TEXTURE_2D, GL_TEXTURE_MAG_FILTER, GL_NEAREST);
453 glTexParameterf(GL_TEXTURE_2D, GL_TEXTURE_MIN_FILTER, GL_NEAREST);
457 gluBuild2DMipmaps(GL_TEXTURE_2D, format, width, height,
458 format, GL_UNSIGNED_BYTE, image);
462 glTexImage2D(GL_TEXTURE_2D, 0, format, width, height, 0,
463 format, GL_UNSIGNED_BYTE, image);
464 check_gl_error("texture");
470 /* mostly lifted from lament.c */
472 rotate (float *pos, float *v, float *dv, float max_v)
487 if (ppos < 0) abort();
488 if (ppos > 360) abort();
489 *pos = (*pos > 0 ? ppos : -ppos);
495 if (*v > max_v || *v < -max_v)
499 /* If it stops, start it going in the other direction. */
506 /* keep going in the same direction */
521 /* Alter direction of rotational acceleration randomly. */
522 if (! (random() % 120))
525 /* Change acceleration very occasionally. */
526 if (! (random() % 200))
530 else if (random() & 1)
539 bounce (float *pos, float *v, float *dv, float max_v)
544 *pos = 1.0, *v = -*v, *dv = -*dv;
546 *pos = 0, *v = -*v, *dv = -*dv;
548 if (*pos < 0.0) abort();
549 if (*pos > 1.0) abort();
555 if (*v > max_v || *v < -max_v)
560 /* Alter direction of rotational acceleration randomly. */
561 if (! (random() % 120))
564 /* Change acceleration very occasionally. */
565 if (! (random() % 200))
569 else if (random() & 1)
580 rot_x = (float) (random() % (360 * 2)) - 360; /* -360 - 360 */
581 rot_y = (float) (random() % (360 * 2)) - 360;
582 rot_z = (float) (random() % (360 * 2)) - 360;
584 /* bell curve from 0-1.5 degrees, avg 0.75 */
585 dx = (frand(1) + frand(1) + frand(1)) / 2.0;
586 dy = (frand(1) + frand(1) + frand(1)) / 2.0;
587 dz = (frand(1) + frand(1) + frand(1)) / 2.0;
595 lastx = (random() % (int) (max_lastx - min_lastx)) + min_lastx;
596 lasty = (random() % (int) (max_lasty - min_lasty)) + min_lasty;
597 d_lastx = (frand(1) + frand(1) + frand(1));
598 d_lasty = (frand(1) + frand(1) + frand(1));
599 max_dlastx = d_lastx * 2;
600 max_dlasty = d_lasty * 2;
606 /* draw the screensaver once */
607 void draw_screensaver(ModeInfo * mi)
609 screensaverstruct *gp = &Screensaver[MI_SCREEN(mi)];
610 Display *display = MI_DISPLAY(mi);
611 Window window = MI_WINDOW(mi);
614 int rootx, rooty, winx, winy;
618 if (!gp->glx_context)
621 glXMakeCurrent(display, window, *(gp->glx_context));
623 funcs_ptr[screensaver_number].DrawStuff();
625 rotate(&rot_x, &dx, &ddx, d_max);
626 rotate(&rot_y, &dy, &ddy, d_max);
627 rotate(&rot_z, &dz, &ddz, d_max);
629 /* swallow any ButtonPress events */
630 while (XCheckMaskEvent (MI_DISPLAY(mi), ButtonPressMask, &event))
632 /* check the pointer position and button state. */
633 XQueryPointer (MI_DISPLAY(mi), MI_WINDOW(mi),
634 &root, &child, &rootx, &rooty, &winx, &winy, &mask);
636 /* track the mouse only if a button is down. */
637 if (mask & (Button1Mask|Button2Mask|Button3Mask|Button4Mask|Button5Mask))
644 float scale = (max_lastx - min_lastx);
653 bounce(&lastx, &d_lastx, &dd_lastx, max_dlastx);
654 bounce(&lasty, &d_lasty, &dd_lasty, max_dlasty);
665 if (mi->fps_p) do_fps (mi);
666 glXSwapBuffers(display, window);
670 /* set up lighting conditions */
671 void SetupLight(void)
673 glLightfv (GL_LIGHT0, GL_POSITION, lightOnePosition);
674 glLightfv (GL_LIGHT0, GL_DIFFUSE, lightOneColor);
675 glLightfv (GL_LIGHT1, GL_POSITION, lightTwoPosition);
676 glLightfv (GL_LIGHT1, GL_DIFFUSE, lightTwoColor);
678 glEnable (GL_LIGHT0);
679 glEnable (GL_LIGHT1);
680 glEnable (GL_LIGHTING);
682 glColorMaterial (GL_FRONT, GL_DIFFUSE);
683 glColorMaterial (GL_BACK, GL_DIFFUSE);
684 glEnable (GL_COLOR_MATERIAL);
687 /* reset the projection matrix */
688 void resetProjection(void) {
689 glMatrixMode(GL_PROJECTION);
691 glFrustum (-9, 9, -9, 9, 50, 150.0);
692 glMatrixMode(GL_MODELVIEW);
696 /* Standard reshape function */
698 reshape_screensaver(ModeInfo *mi, int width, int height)
701 global_height=height;
702 glViewport( 0, 0, global_width, global_height );
707 /* decide which screensaver example to run */
708 void chooseScreensaverExample(void) {
710 /* call the extrusion init routine */
712 if (!strncmp(which_name, "RANDOM", strlen(which_name))) {
713 screensaver_number = random() % num_screensavers;
716 screensaver_number=-1;
717 for (i=0; i < num_screensavers; i++) {
718 if (!strncmp(which_name, funcs_ptr[i].name, strlen(which_name))) {
719 screensaver_number = i;
724 if (screensaver_number < 0 || screensaver_number >= num_screensavers) {
725 fprintf(stderr, "%s: invalid screensaver example number!\n", progname);
726 fprintf(stderr, "%s: known screensavers:\n", progname);
727 for (i=0; i < num_screensavers; i++)
728 fprintf(stderr,"\t%s\n", funcs_ptr[i].name);
732 funcs_ptr[screensaver_number].InitStuff();
735 /* main OpenGL initialization routine */
737 initializeGL(ModeInfo *mi, GLsizei width, GLsizei height)
742 reshape_screensaver(mi, width, height);
743 glViewport( 0, 0, width, height );
745 glEnable(GL_DEPTH_TEST);
746 glClearColor(0,0,0,0);
747 /* glCullFace(GL_BACK); */
748 /* glEnable(GL_CULL_FACE); */
749 glShadeModel(GL_SMOOTH);
754 glPolygonMode(GL_FRONT,GL_LINE);
755 glPolygonMode(GL_BACK,GL_LINE);
758 Create_Texture(which_image, do_mipmap, do_texture_quality);
759 glEnable(GL_TEXTURE_2D);
761 /* configure the pipeline */
763 style |= TUBE_CONTOUR_CLOSED;
764 style |= TUBE_NORM_FACET;
765 style |= TUBE_JN_ANGLE;
766 gleSetJoinStyle (style);
769 mode = GLE_TEXTURE_ENABLE | GLE_TEXTURE_VERTEX_MODEL_FLAT;
770 glMatrixMode (GL_TEXTURE); glLoadIdentity ();
771 glScalef (0.25, 0.1, 1); glMatrixMode (GL_MODELVIEW);
772 gleTextureMode (mode);
778 /* xscreensaver initialization routine */
779 void init_screensaver(ModeInfo * mi)
781 int screen = MI_SCREEN(mi);
782 screensaverstruct *gp;
784 if (Screensaver == NULL) {
785 if ((Screensaver = (screensaverstruct *) calloc(MI_NUM_SCREENS(mi), sizeof (screensaverstruct))) == NULL)
788 gp = &Screensaver[screen];
790 gp->window = MI_WINDOW(mi);
791 if ((gp->glx_context = init_GL(mi)) != NULL) {
792 reshape_screensaver(mi, MI_WIDTH(mi), MI_HEIGHT(mi));
793 initializeGL(mi, MI_WIDTH(mi), MI_HEIGHT(mi));
794 chooseScreensaverExample();
801 /* all sorts of nice cleanup code should go here! */
802 void release_screensaver(ModeInfo * mi)
805 if (Screensaver != NULL) {
806 for (screen = 0; screen < MI_NUM_SCREENS(mi); screen++) {
807 /* screensaverstruct *gp = &Screensaver[screen];*/
809 (void) free((void *) Screensaver);