From http://www.jwz.org/xscreensaver/xscreensaver-5.39.tar.gz
[xscreensaver] / hacks / glx / atlantis.c
1 /* atlantis --- Shows moving 3D sea animals */
2
3 #if 0
4 static const char sccsid[] = "@(#)atlantis.c    5.08 2003/04/09 xlockmore";
5 #endif
6
7 /* Copyright (c) E. Lassauge, 1998. */
8
9 /*
10  * Permission to use, copy, modify, and distribute this software and its
11  * documentation for any purpose and without fee is hereby granted,
12  * provided that the above copyright notice appear in all copies and that
13  * both that copyright notice and this permission notice appear in
14  * supporting documentation.
15  *
16  * This file is provided AS IS with no warranties of any kind.  The author
17  * shall have no liability with respect to the infringement of copyrights,
18  * trade secrets or any patents by this file or any part thereof.  In no
19  * event will the author be liable for any lost revenue or profits or
20  * other special, indirect and consequential damages.
21  *
22  * The original code for this mode was written by Mark J. Kilgard
23  * as a demo for openGL programming.
24  * 
25  * Porting it to xlock  was possible by comparing the original Mesa's morph3d 
26  * demo with it's ported version to xlock, so thanks for Marcelo F. Vianna 
27  * (look at morph3d.c) for his indirect help.
28  *
29  * Thanks goes also to Brian Paul for making it possible and inexpensive
30  * to use OpenGL at home.
31  *
32  * My e-mail address is lassauge@users.sourceforge.net
33  *
34  * Eric Lassauge  (May-13-1998)
35  *
36  * REVISION HISTORY:
37  * 
38  * Jamie Zawinski, 2-Apr-01:  - The fishies were inside out!  The back faces
39  *                              were being drawn, not the front faces.
40  *                            - Added a texture to simulate light from the
41  *                              surface, like in the SGI version.
42  *
43  * David A. Bagley - 98/06/17 : Add whalespeed option. Global options to
44  *                              initialize local variables are now:
45  *                              XLock.atlantis.cycles: 100      ! SharkSpeed
46  *                              XLock.atlantis.batchcount: 4    ! SharkNum
47  *                              XLock.atlantis.whalespeed: 250  ! WhaleSpeed
48  *                              XLock.atlantis.size: 6000       ! SharkSize
49  *                              Add random direction for whales/dolphins
50  * 
51  * E.Lassauge - 98/06/16: Use the following global options to initialize
52  *                        local variables :
53  *                              XLock.atlantis.delay: 100       ! SharkSpeed
54  *                              XLock.atlantis.batchcount: 4    ! SharkNum
55  *                              XLock.atlantis.cycles: 250      ! WhaleSpeed
56  *                              XLock.atlantis.size: 6000       ! SharkSize
57  *                        Add support for -/+ wireframe (t'was so easy to do!)
58  *
59  * TODO : 
60  *        - better handling of sizes and speeds
61  *        - test standalone and module modes
62  *        - purify it (!)
63  */
64
65 /* Copyright (c) Mark J. Kilgard, 1994. */
66
67 /**
68  * (c) Copyright 1993, 1994, Silicon Graphics, Inc.
69  * ALL RIGHTS RESERVED
70  * Permission to use, copy, modify, and distribute this software for
71  * any purpose and without fee is hereby granted, provided that the above
72  * copyright notice appear in all copies and that both the copyright notice
73  * and this permission notice appear in supporting documentation, and that
74  * the name of Silicon Graphics, Inc. not be used in advertising
75  * or publicity pertaining to distribution of the software without specific,
76  * written prior permission.
77  *
78  * THE MATERIAL EMBODIED ON THIS SOFTWARE IS PROVIDED TO YOU "AS-IS"
79  * AND WITHOUT WARRANTY OF ANY KIND, EXPRESS, IMPLIED OR OTHERWISE,
80  * INCLUDING WITHOUT LIMITATION, ANY WARRANTY OF MERCHANTABILITY OR
81  * FITNESS FOR A PARTICULAR PURPOSE.  IN NO EVENT SHALL SILICON
82  * GRAPHICS, INC.  BE LIABLE TO YOU OR ANYONE ELSE FOR ANY DIRECT,
83  * SPECIAL, INCIDENTAL, INDIRECT OR CONSEQUENTIAL DAMAGES OF ANY
84  * KIND, OR ANY DAMAGES WHATSOEVER, INCLUDING WITHOUT LIMITATION,
85  * LOSS OF PROFIT, LOSS OF USE, SAVINGS OR REVENUE, OR THE CLAIMS OF
86  * THIRD PARTIES, WHETHER OR NOT SILICON GRAPHICS, INC.  HAS BEEN
87  * ADVISED OF THE POSSIBILITY OF SUCH LOSS, HOWEVER CAUSED AND ON
88  * ANY THEORY OF LIABILITY, ARISING OUT OF OR IN CONNECTION WITH THE
89  * POSSESSION, USE OR PERFORMANCE OF THIS SOFTWARE.
90  *
91  * US Government Users Restricted Rights
92  * Use, duplication, or disclosure by the Government is subject to
93  * restrictions set forth in FAR 52.227.19(c)(2) or subparagraph
94  * (c)(1)(ii) of the Rights in Technical Data and Computer Software
95  * clause at DFARS 252.227-7013 and/or in similar or successor
96  * clauses in the FAR or the DOD or NASA FAR Supplement.
97  * Unpublished-- rights reserved under the copyright laws of the
98  * United States.  Contractor/manufacturer is Silicon Graphics,
99  * Inc., 2011 N.  Shoreline Blvd., Mountain View, CA 94039-7311.
100  *
101  * OpenGL(TM) is a trademark of Silicon Graphics, Inc.
102  */
103
104 #define DEF_TEXTURE "True"
105 #define DEF_GRADIENT "True"
106 #define DEF_WHALESPEED  "250"
107
108 #ifdef STANDALONE
109 # define DEFAULTS       "*delay:       25000 \n" \
110                          "*count:          4 \n" \
111                          "*showFPS:    False \n" \
112                          "*cycles:       100 \n" \
113                          "*size:        6000 \n" \
114                          "*wireframe:  False \n"
115 # define release_atlantis 0
116 # define atlantis_handle_event xlockmore_no_events
117 # include "xlockmore.h"         /* from the xscreensaver distribution */
118 #else  /* !STANDALONE */
119 # include "xlock.h"             /* from the xlockmore distribution */
120 # include "vis.h"
121 #endif /* !STANDALONE */
122
123 #ifdef USE_GL
124
125 #include "atlantis.h"
126
127
128 static int  whalespeed;
129 static int do_texture;
130 static int do_gradient;
131 static XrmOptionDescRec opts[] =
132 {
133      {"-whalespeed", ".atlantis.whalespeed", XrmoptionSepArg, 0},
134      {"-texture",    ".atlantis.texture",    XrmoptionNoArg, "true"},
135      {"+texture",    ".atlantis.texture",    XrmoptionNoArg, "false"},
136      {"-gradient",   ".atlantis.gradient",   XrmoptionNoArg, "true"},
137      {"+gradient",   ".atlantis.gradient",   XrmoptionNoArg, "false"},
138 };
139
140 static argtype vars[] =
141 {
142  {&whalespeed, "whalespeed", "WhaleSpeed", DEF_WHALESPEED, t_Int},
143  {&do_texture,  "texture",    "Texture",    DEF_TEXTURE,   t_Bool},
144  {&do_gradient, "gradient",   "Gradient",   DEF_GRADIENT,  t_Bool},
145 };
146
147 static OptionStruct desc[] =
148 {
149         {"-whalespeed num", "speed of whales and the dolphin"},
150         {"-texture",        "whether to introduce water-like distortion"},
151         {"-gradient",       "whether to introduce gradient-filled background"},
152 };
153
154 ENTRYPOINT ModeSpecOpt atlantis_opts =
155 {sizeof opts / sizeof opts[0], opts, sizeof vars / sizeof vars[0], vars, desc};
156
157 #ifdef USE_MODULES
158 ModStruct   atlantis_description =
159 {"atlantis", "init_atlantis", "draw_atlantis", NULL,
160  "refresh_atlantis", "change_atlantis", "free_atlantis", &atlantis_opts,
161  1000, NUM_SHARKS, SHARKSPEED, SHARKSIZE, 64, 1.0, "",
162  "Shows moving sharks/whales/dolphin", 0, NULL};
163
164 #endif
165
166 static atlantisstruct *atlantis = NULL;
167
168 #include "ximage-loader.h"
169
170 #include "images/gen/sea-texture_png.h"
171
172
173 static void
174 parse_image_data(ModeInfo *mi)
175 {
176   atlantisstruct *ap = &atlantis[MI_SCREEN(mi)];
177   ap->texture = image_data_to_ximage (mi->dpy, mi->xgwa.visual,
178                                       sea_texture_png,
179                                       sizeof(sea_texture_png));
180 }
181
182 static void
183 InitFishs(atlantisstruct * ap)
184 {
185         int         i;
186
187         for (i = 0; i < ap->num_sharks; i++) {
188                 ap->sharks[i].x = 70000.0 + NRAND(ap->sharksize);
189                 ap->sharks[i].y = NRAND(ap->sharksize);
190                 ap->sharks[i].z = NRAND(ap->sharksize);
191                 ap->sharks[i].psi = NRAND(360) - 180.0;
192                 ap->sharks[i].v = 1.0;
193         }
194
195         /* Random whale direction */
196         ap->whaledir = LRAND() & 1;
197
198         ap->dolph.x = 30000.0;
199         ap->dolph.y = 0.0;
200         ap->dolph.z = (float) (ap->sharksize);
201         ap->dolph.psi = (ap->whaledir) ? 90.0 : -90.0;
202         ap->dolph.theta = 0.0;
203         ap->dolph.v = 6.0;
204
205         ap->momWhale.x = 70000.0;
206         ap->momWhale.y = 0.0;
207         ap->momWhale.z = 0.0;
208         ap->momWhale.psi = (ap->whaledir) ? 90.0 : -90.0;
209         ap->momWhale.theta = 0.0;
210         ap->momWhale.v = 3.0;
211
212         ap->babyWhale.x = 60000.0;
213         ap->babyWhale.y = -2000.0;
214         ap->babyWhale.z = -2000.0;
215         ap->babyWhale.psi = (ap->whaledir) ? 90.0 : -90.0;
216         ap->babyWhale.theta = 0.0;
217         ap->babyWhale.v = 3.0;
218 }
219
220 static void
221 Init(ModeInfo *mi)
222 {
223         atlantisstruct *ap = &atlantis[MI_SCREEN(mi)];
224
225         static const float ambient[]        = {0.1, 0.1, 0.1, 1.0};
226         static const float diffuse[]        = {1.0, 1.0, 1.0, 1.0};
227         static const float position[]       = {0.0, 1.0, 0.0, 0.0};
228         static const float mat_shininess[]  = {90.0};
229         static const float mat_specular[]   = {0.8, 0.8, 0.8, 1.0};
230         static const float mat_diffuse[]    = {0.46, 0.66, 0.795, 1.0};
231         static const float mat_ambient[]    = {0.0, 0.1, 0.2, 1.0};
232         static const float lmodel_ambient[] = {0.4, 0.4, 0.4, 1.0};
233         static const float lmodel_localviewer[] = {0.0};
234
235         float        fblue = 0.0, fgreen;
236
237         glFrontFace(GL_CCW);
238
239         if (ap->wire)
240           {
241             glDisable(GL_DEPTH_TEST);
242             glDisable(GL_CULL_FACE);
243             glDisable(GL_LIGHTING);
244             glDisable(GL_NORMALIZE);
245           }
246         else
247           {
248             glDepthFunc(GL_LEQUAL);
249             glEnable(GL_DEPTH_TEST);
250             glEnable(GL_CULL_FACE);
251             glEnable(GL_NORMALIZE);
252             glShadeModel(GL_SMOOTH);
253
254             glLightfv(GL_LIGHT0, GL_AMBIENT, ambient);
255             glLightfv(GL_LIGHT0, GL_DIFFUSE, diffuse);
256             glLightfv(GL_LIGHT0, GL_POSITION, position);
257             glLightModelfv(GL_LIGHT_MODEL_AMBIENT, lmodel_ambient);
258             glLightModelfv(GL_LIGHT_MODEL_LOCAL_VIEWER, lmodel_localviewer);
259             glEnable(GL_LIGHTING);
260             glEnable(GL_LIGHT0);
261
262             glMaterialfv(GL_FRONT_AND_BACK, GL_SHININESS, mat_shininess);
263             glMaterialfv(GL_FRONT_AND_BACK, GL_SPECULAR, mat_specular);
264             glMaterialfv(GL_FRONT_AND_BACK, GL_DIFFUSE, mat_diffuse);
265             glMaterialfv(GL_FRONT_AND_BACK, GL_AMBIENT, mat_ambient);
266           }
267
268         if (ap->wire || !do_texture)
269           {
270             glDisable(GL_TEXTURE_2D);
271           }
272         else
273           {
274             GLfloat scale = 0.0005;
275
276             if (!ap->texture)
277               parse_image_data (mi);
278
279             clear_gl_error();
280             glTexImage2D(GL_TEXTURE_2D, 0, GL_RGBA,
281                          ap->texture->width, ap->texture->height, 0,
282                          GL_RGBA, GL_UNSIGNED_BYTE,
283                          ap->texture->data);
284             check_gl_error("texture");
285
286             glTexParameteri(GL_TEXTURE_2D, GL_TEXTURE_WRAP_S, GL_REPEAT);
287             glTexParameteri(GL_TEXTURE_2D, GL_TEXTURE_WRAP_T, GL_REPEAT);
288             glTexParameteri(GL_TEXTURE_2D, GL_TEXTURE_MAG_FILTER, GL_LINEAR);
289             glTexParameteri(GL_TEXTURE_2D, GL_TEXTURE_MIN_FILTER, GL_LINEAR);
290
291             glTexEnvf(GL_TEXTURE_ENV, GL_TEXTURE_ENV_MODE, GL_MODULATE);
292
293 # ifndef HAVE_JWZGLES
294             {
295               GLfloat s_plane[] = { 1, 0, 0, 0 };
296               GLfloat t_plane[] = { 0, 0, 1, 0 };
297               glTexGeni (GL_S, GL_TEXTURE_GEN_MODE, GL_EYE_LINEAR);
298               glTexGeni (GL_T, GL_TEXTURE_GEN_MODE, GL_EYE_LINEAR);
299               glTexGenfv(GL_S, GL_EYE_PLANE, s_plane);
300               glTexGenfv(GL_T, GL_EYE_PLANE, t_plane);
301               glEnable(GL_TEXTURE_GEN_S);
302               glEnable(GL_TEXTURE_GEN_T);
303             }
304 # endif
305             glEnable(GL_TEXTURE_2D);
306
307             glMatrixMode(GL_TEXTURE);
308             glLoadIdentity();
309             glScalef(scale, scale, 1);
310             glMatrixMode(GL_MODELVIEW);
311           }
312
313         InitFishs(ap);
314
315         /* Add a little randomness */
316         fblue = ((float) (NRAND(30)) / 100.0) + 0.70;
317         fgreen = fblue * 0.56;
318         glClearColor(0.0, fgreen, fblue, 1.0);
319 }
320
321 ENTRYPOINT void
322 reshape_atlantis(ModeInfo * mi, int width, int height)
323 {
324   double h = (GLfloat) height / (GLfloat) width;  
325   atlantisstruct *ap = &atlantis[MI_SCREEN(mi)];
326   int y = 0;
327
328   if (width > height * 5) {   /* tiny window: show middle */
329     height = width * 9/16;
330     y = -height/2;
331     h = height / (GLfloat) width;
332   }
333
334   glViewport(0, y, ap->WinW = (GLint) width, ap->WinH = (GLint) height);
335
336   glMatrixMode(GL_PROJECTION);
337   glLoadIdentity();
338   gluPerspective(400.0, 1/h, 1.0, 2000000.0);
339   glMatrixMode(GL_MODELVIEW);
340 }
341
342
343 /* Fill the background with a gradient -- thanks to 
344    Phil Carrig <pod@internode.on.net> for figuring out
345    how to do this more efficiently!
346  */
347 static void
348 clear_tank (atlantisstruct * ap)
349 {
350   glClear(GL_COLOR_BUFFER_BIT | GL_DEPTH_BUFFER_BIT);
351
352   if (do_gradient && !ap->wire)
353     {
354       GLfloat top[4] = { 0.00, 0.40, 0.70, };
355       GLfloat bot[4] = { 0.00, 0.05, 0.18, };
356
357       glMatrixMode(GL_PROJECTION);
358       glPushMatrix();
359       {
360         glLoadIdentity();
361         glMatrixMode(GL_MODELVIEW);
362         glPushMatrix();
363         {
364           glLoadIdentity();
365           /* glRotatef(current_device_rotation(), 0, 0, 1); */
366
367 # ifndef HAVE_JWZGLES
368           glShadeModel (GL_SMOOTH);
369 # endif
370           glDisable (GL_LIGHTING);
371           glBegin (GL_QUADS);
372           glColor3fv (bot);
373           glVertex3f (-1, -1, 1); glVertex3f ( 1, -1, 1);
374           glColor3fv (top);
375           glVertex3f ( 1,  1, 1); glVertex3f (-1,  1, 1);
376           glEnd();
377           glEnable (GL_LIGHTING);
378
379           /* Need to reset this because jwzgles conflates color and material */
380           glColor3f (0.0, 0.1, 0.2);
381         }
382         glPopMatrix();
383       }
384       glMatrixMode(GL_PROJECTION);
385       glPopMatrix();
386
387       glMatrixMode(GL_MODELVIEW);
388     }
389 }
390
391
392 static void
393 Animate(atlantisstruct * ap)
394 {
395         int         i;
396
397         for (i = 0; i < ap->num_sharks; i++) {
398                 SharkPilot(&(ap->sharks[i]), ap->sharkspeed);
399                 SharkMiss(ap, i);
400         }
401         WhalePilot(&(ap->dolph), ap->whalespeed, ap->whaledir);
402         ap->dolph.phi++;
403         WhalePilot(&(ap->momWhale), ap->whalespeed, ap->whaledir);
404         ap->momWhale.phi++;
405         WhalePilot(&(ap->babyWhale), ap->whalespeed, ap->whaledir);
406         ap->babyWhale.phi++;
407 }
408
409 static void
410 AllDisplay(atlantisstruct * ap)
411 {
412         int         i;
413
414         clear_tank(ap);
415
416         for (i = 0; i < ap->num_sharks; i++) {
417                 glPushMatrix();
418                 FishTransform(&(ap->sharks[i]));
419                 DrawShark(&(ap->sharks[i]), ap->wire);
420                 glPopMatrix();
421         }
422
423         glPushMatrix();
424         FishTransform(&(ap->dolph));
425         DrawDolphin(&(ap->dolph), ap->wire);
426         glPopMatrix();
427
428         glPushMatrix();
429         FishTransform(&(ap->momWhale));
430         DrawWhale(&(ap->momWhale), ap->wire);
431         glPopMatrix();
432
433         glPushMatrix();
434         FishTransform(&(ap->babyWhale));
435         glScalef(0.45, 0.45, 0.3);
436         DrawWhale(&(ap->babyWhale), ap->wire);
437         glPopMatrix();
438 }
439
440 /*
441  *-----------------------------------------------------------------------------
442  *-----------------------------------------------------------------------------
443  *    Xlock hooks.
444  *-----------------------------------------------------------------------------
445  *-----------------------------------------------------------------------------
446  */
447
448 /*
449  *-----------------------------------------------------------------------------
450  *    Initialize atlantis.  Called each time the window changes.
451  *-----------------------------------------------------------------------------
452  */
453
454 ENTRYPOINT void
455 init_atlantis(ModeInfo * mi)
456 {
457         int         screen = MI_SCREEN(mi);
458         atlantisstruct *ap;
459         Display    *display = MI_DISPLAY(mi);
460         Window      window = MI_WINDOW(mi);
461
462         MI_INIT(mi, atlantis);
463         ap = &atlantis[screen];
464         ap->num_sharks = MI_COUNT(mi);
465         if (ap->sharks == NULL) {
466                 if ((ap->sharks = (fishRec *) calloc(ap->num_sharks,
467                                                 sizeof (fishRec))) == NULL) {
468                         /* free everything up to now */
469                         (void) free((void *) atlantis);
470                         atlantis = NULL;
471                         return;
472                 }
473         }
474         ap->sharkspeed = MI_CYCLES(mi);         /* has influence on the "width"
475                                                    of the movement */
476         ap->sharksize = MI_SIZE(mi);    /* has influence on the "distance"
477                                            of the sharks */
478         ap->whalespeed = whalespeed;
479         ap->wire = MI_IS_WIREFRAME(mi);
480
481         if (MI_IS_DEBUG(mi)) {
482                 (void) fprintf(stderr,
483                                "%s:\n\tnum_sharks=%d\n\tsharkspeed=%.1f\n\tsharksize=%d\n\twhalespeed=%.1f\n\twireframe=%s\n",
484                                MI_NAME(mi),
485                                ap->num_sharks,
486                                ap->sharkspeed,
487                                ap->sharksize,
488                                ap->whalespeed,
489                                ap->wire ? "yes" : "no"
490                         );
491         }
492         if ((ap->glx_context = init_GL(mi)) != NULL) {
493
494                 reshape_atlantis(mi, MI_WIDTH(mi), MI_HEIGHT(mi));
495                 glDrawBuffer(GL_BACK);
496                 Init(mi);
497                 AllDisplay(ap);
498                 glXSwapBuffers(display, window);
499
500         } else {
501                 MI_CLEARWINDOW(mi);
502         }
503 }
504
505 /*
506  *-----------------------------------------------------------------------------
507  *    Called by the mainline code periodically to update the display.
508  *-----------------------------------------------------------------------------
509  */
510 ENTRYPOINT void
511 draw_atlantis(ModeInfo * mi)
512 {
513         atlantisstruct *ap = &atlantis[MI_SCREEN(mi)];
514
515         Display    *display = MI_DISPLAY(mi);
516         Window      window = MI_WINDOW(mi);
517
518         MI_IS_DRAWN(mi) = True;
519
520         if (!ap->glx_context)
521                 return;
522
523         glXMakeCurrent(display, window, *(ap->glx_context));
524
525         glClear(GL_COLOR_BUFFER_BIT | GL_DEPTH_BUFFER_BIT);
526
527         glPushMatrix();
528         glRotatef(current_device_rotation(), 0, 0, 1);
529         AllDisplay(ap);
530         Animate(ap);
531         glPopMatrix();
532
533         if (mi->fps_p) do_fps (mi);
534         glXSwapBuffers(display, window);
535 }
536
537
538 /*
539  *-----------------------------------------------------------------------------
540  *    The display is being taken away from us.  Free up malloc'ed 
541  *      memory and X resources that we've alloc'ed.
542  *-----------------------------------------------------------------------------
543  */
544
545 ENTRYPOINT void
546 free_atlantis(ModeInfo * mi)
547 {
548 #if 0
549         atlantisstruct *ap = &atlantis[screen];
550
551         if (ap->sharks)
552                 (void) free((void *) ap->sharks);
553 #endif
554 }
555
556 #ifndef STANDALONE
557 ENTRYPOINT void
558 refresh_atlantis(ModeInfo * mi)
559 {
560 }
561
562 ENTRYPOINT void
563 change_atlantis(ModeInfo * mi)
564 {
565         atlantisstruct *ap = &atlantis[MI_SCREEN(mi)];
566
567         if (!ap->glx_context)
568                 return;
569
570         glXMakeCurrent(MI_DISPLAY(mi), MI_WINDOW(mi), *(ap->glx_context));
571         Init(mi);
572 }
573 #endif /* !STANDALONE */
574
575 XSCREENSAVER_MODULE ("Atlantis", atlantis)
576
577 #endif /* USE_GL */