rnd-20060128-1-src
[rocksndiamonds.git] / src / libgame / system.c
1 /***********************************************************
2 * Artsoft Retro-Game Library                               *
3 *----------------------------------------------------------*
4 * (c) 1994-2002 Artsoft Entertainment                      *
5 *               Holger Schemel                             *
6 *               Detmolder Strasse 189                      *
7 *               33604 Bielefeld                            *
8 *               Germany                                    *
9 *               e-mail: info@artsoft.org                   *
10 *----------------------------------------------------------*
11 * system.c                                                 *
12 ***********************************************************/
13
14 #include <string.h>
15 #include <signal.h>
16
17 #include "platform.h"
18
19 #if defined(PLATFORM_MSDOS)
20 #include <fcntl.h>
21 #endif
22
23 #include "system.h"
24 #include "image.h"
25 #include "sound.h"
26 #include "setup.h"
27 #include "joystick.h"
28 #include "misc.h"
29
30
31 /* ========================================================================= */
32 /* exported variables                                                        */
33 /* ========================================================================= */
34
35 struct ProgramInfo      program;
36 struct OptionInfo       options;
37 struct VideoSystemInfo  video;
38 struct AudioSystemInfo  audio;
39 struct GfxInfo          gfx;
40 struct ArtworkInfo      artwork;
41 struct JoystickInfo     joystick;
42 struct SetupInfo        setup;
43
44 LevelDirTree           *leveldir_first = NULL;
45 LevelDirTree           *leveldir_current = NULL;
46 int                     level_nr;
47
48 Display                *display = NULL;
49 Visual                 *visual = NULL;
50 int                     screen = 0;
51 Colormap                cmap = None;
52
53 DrawWindow             *window = NULL;
54 DrawBuffer             *backbuffer = NULL;
55 DrawBuffer             *drawto = NULL;
56
57 int                     button_status = MB_NOT_PRESSED;
58 boolean                 motion_status = FALSE;
59
60 int                     redraw_mask = REDRAW_NONE;
61 int                     redraw_tiles = 0;
62
63 int                     FrameCounter = 0;
64
65
66 /* ========================================================================= */
67 /* init/close functions                                                      */
68 /* ========================================================================= */
69
70 void InitProgramInfo(char *argv0,
71                      char *userdata_directory, char *program_title,
72                      char *window_title, char *icon_title,
73                      char *x11_icon_filename, char *x11_iconmask_filename,
74                      char *msdos_cursor_filename,
75                      char *cookie_prefix, char *filename_prefix,
76                      int program_version)
77 {
78   program.command_basepath = getBasePath(argv0);
79   program.command_basename = getBaseName(argv0);
80
81   program.userdata_directory = userdata_directory;
82   program.program_title = program_title;
83   program.window_title = window_title;
84   program.icon_title = icon_title;
85   program.x11_icon_filename = x11_icon_filename;
86   program.x11_iconmask_filename = x11_iconmask_filename;
87   program.msdos_cursor_filename = msdos_cursor_filename;
88
89   program.cookie_prefix = cookie_prefix;
90   program.filename_prefix = filename_prefix;
91
92   program.version_major = VERSION_MAJOR(program_version);
93   program.version_minor = VERSION_MINOR(program_version);
94   program.version_patch = VERSION_PATCH(program_version);
95 }
96
97 void InitExitFunction(void (*exit_function)(int))
98 {
99   program.exit_function = exit_function;
100
101   /* set signal handlers to custom exit function */
102   signal(SIGINT, exit_function);
103   signal(SIGTERM, exit_function);
104
105 #if defined(TARGET_SDL)
106   /* set exit function to automatically cleanup SDL stuff after exit() */
107   atexit(SDL_Quit);
108 #endif
109 }
110
111 void InitPlatformDependentStuff(void)
112 {
113 #if defined(PLATFORM_MSDOS)
114   _fmode = O_BINARY;
115   initErrorFile();
116 #endif
117
118 #if defined(TARGET_SDL)
119   if (SDL_Init(SDL_INIT_EVENTTHREAD | SDL_INIT_NOPARACHUTE) < 0)
120     Error(ERR_EXIT, "SDL_Init() failed: %s", SDL_GetError());
121
122   SDLNet_Init();
123 #endif
124 }
125
126 void ClosePlatformDependentStuff(void)
127 {
128 #if defined(PLATFORM_MSDOS)
129   dumpErrorFile();
130 #endif
131 }
132
133 void InitGfxFieldInfo(int sx, int sy, int sxsize, int sysize,
134                       int real_sx, int real_sy,
135                       int full_sxsize, int full_sysize,
136                       Bitmap *field_save_buffer)
137 {
138   gfx.sx = sx;
139   gfx.sy = sy;
140   gfx.sxsize = sxsize;
141   gfx.sysize = sysize;
142   gfx.real_sx = real_sx;
143   gfx.real_sy = real_sy;
144   gfx.full_sxsize = full_sxsize;
145   gfx.full_sysize = full_sysize;
146
147   gfx.field_save_buffer = field_save_buffer;
148
149   gfx.background_bitmap = NULL;
150   gfx.background_bitmap_mask = REDRAW_NONE;
151
152   SetDrawDeactivationMask(REDRAW_NONE);         /* do not deactivate drawing */
153   SetDrawBackgroundMask(REDRAW_NONE);           /* deactivate masked drawing */
154 }
155
156 void InitGfxDoor1Info(int dx, int dy, int dxsize, int dysize)
157 {
158   gfx.dx = dx;
159   gfx.dy = dy;
160   gfx.dxsize = dxsize;
161   gfx.dysize = dysize;
162 }
163
164 void InitGfxDoor2Info(int vx, int vy, int vxsize, int vysize)
165 {
166   gfx.vx = vx;
167   gfx.vy = vy;
168   gfx.vxsize = vxsize;
169   gfx.vysize = vysize;
170 }
171
172 void InitGfxScrollbufferInfo(int scrollbuffer_width, int scrollbuffer_height)
173 {
174   /* currently only used by MSDOS code to alloc VRAM buffer, if available */
175   gfx.scrollbuffer_width = scrollbuffer_width;
176   gfx.scrollbuffer_height = scrollbuffer_height;
177 }
178
179 void SetDrawDeactivationMask(int draw_deactivation_mask)
180 {
181   gfx.draw_deactivation_mask = draw_deactivation_mask;
182 }
183
184 void SetDrawBackgroundMask(int draw_background_mask)
185 {
186   gfx.draw_background_mask = draw_background_mask;
187 }
188
189 static void DrawBitmapFromTile(Bitmap *bitmap, Bitmap *tile,
190                                int dest_x, int dest_y, int width, int height)
191 {
192   int bitmap_xsize = width;
193   int bitmap_ysize = height;
194   int tile_xsize = tile->width;
195   int tile_ysize = tile->height;
196   int tile_xsteps = (bitmap_xsize + tile_xsize - 1) / tile_xsize;
197   int tile_ysteps = (bitmap_ysize + tile_ysize - 1) / tile_ysize;
198   int x, y;
199
200   for (y = 0; y < tile_ysteps; y++)
201   {
202     for (x = 0; x < tile_xsteps; x++)
203     {
204       int draw_x = dest_x + x * tile_xsize;
205       int draw_y = dest_y + y * tile_ysize;
206       int draw_xsize = MIN(tile_xsize, bitmap_xsize - x * tile_xsize);
207       int draw_ysize = MIN(tile_ysize, bitmap_ysize - y * tile_ysize);
208
209       BlitBitmap(tile, bitmap, 0, 0, draw_xsize, draw_ysize, draw_x, draw_y);
210     }
211   }
212 }
213
214 void SetBackgroundBitmap(Bitmap *background_bitmap_tile, int mask)
215 {
216   if (background_bitmap_tile != NULL)
217     gfx.background_bitmap_mask |= mask;
218   else
219     gfx.background_bitmap_mask &= ~mask;
220
221   if (gfx.background_bitmap == NULL)
222     gfx.background_bitmap = CreateBitmap(video.width, video.height,
223                                          DEFAULT_DEPTH);
224
225   if (background_bitmap_tile == NULL)   /* empty background requested */
226     return;
227
228   if (mask == REDRAW_FIELD)
229     DrawBitmapFromTile(gfx.background_bitmap, background_bitmap_tile,
230                        gfx.real_sx, gfx.real_sy,
231                        gfx.full_sxsize, gfx.full_sysize);
232   else if (mask == REDRAW_DOOR_1)
233   {
234     DrawBitmapFromTile(gfx.background_bitmap, background_bitmap_tile,
235                        gfx.dx, gfx.dy,
236                        gfx.dxsize, gfx.dysize);
237   }
238 }
239
240 void SetMainBackgroundBitmap(Bitmap *background_bitmap_tile)
241 {
242   SetBackgroundBitmap(background_bitmap_tile, REDRAW_FIELD);
243 }
244
245 void SetDoorBackgroundBitmap(Bitmap *background_bitmap_tile)
246 {
247   SetBackgroundBitmap(background_bitmap_tile, REDRAW_DOOR_1);
248 }
249
250
251 /* ========================================================================= */
252 /* video functions                                                           */
253 /* ========================================================================= */
254
255 inline static int GetRealDepth(int depth)
256 {
257   return (depth == DEFAULT_DEPTH ? video.default_depth : depth);
258 }
259
260 inline static void sysFillRectangle(Bitmap *bitmap, int x, int y,
261                                int width, int height, Pixel color)
262 {
263 #if defined(TARGET_SDL)
264   SDLFillRectangle(bitmap, x, y, width, height, color);
265 #else
266   X11FillRectangle(bitmap, x, y, width, height, color);
267 #endif
268 }
269
270 inline static void sysCopyArea(Bitmap *src_bitmap, Bitmap *dst_bitmap,
271                                int src_x, int src_y, int width, int height,
272                                int dst_x, int dst_y, int mask_mode)
273 {
274 #if defined(TARGET_SDL)
275   SDLCopyArea(src_bitmap, dst_bitmap, src_x, src_y, width, height,
276               dst_x, dst_y, mask_mode);
277 #else
278   X11CopyArea(src_bitmap, dst_bitmap, src_x, src_y, width, height,
279               dst_x, dst_y, mask_mode);
280 #endif
281 }
282
283 inline void InitVideoDisplay(void)
284 {
285 #if defined(TARGET_SDL)
286   SDLInitVideoDisplay();
287 #else
288   X11InitVideoDisplay();
289 #endif
290 }
291
292 inline void CloseVideoDisplay(void)
293 {
294   KeyboardAutoRepeatOn();
295
296 #if defined(TARGET_SDL)
297   SDL_QuitSubSystem(SDL_INIT_VIDEO);
298 #else
299   if (display)
300     XCloseDisplay(display);
301 #endif
302 }
303
304 inline void InitVideoBuffer(DrawBuffer **backbuffer, DrawWindow **window,
305                             int width, int height, int depth,
306                             boolean fullscreen)
307 {
308   video.width = width;
309   video.height = height;
310   video.depth = GetRealDepth(depth);
311   video.fullscreen_available = FULLSCREEN_STATUS;
312   video.fullscreen_enabled = FALSE;
313
314 #if defined(TARGET_SDL)
315   SDLInitVideoBuffer(backbuffer, window, fullscreen);
316 #else
317   X11InitVideoBuffer(backbuffer, window);
318 #endif
319 }
320
321 inline Bitmap *CreateBitmapStruct(void)
322 {
323 #if defined(TARGET_SDL)
324   return checked_calloc(sizeof(struct SDLSurfaceInfo));
325 #else
326   return checked_calloc(sizeof(struct X11DrawableInfo));
327 #endif
328 }
329
330 inline Bitmap *CreateBitmap(int width, int height, int depth)
331 {
332   Bitmap *new_bitmap = CreateBitmapStruct();
333   int real_depth = GetRealDepth(depth);
334
335 #if defined(TARGET_SDL)
336   SDLCreateBitmapContent(new_bitmap, width, height, real_depth);
337 #else
338   X11CreateBitmapContent(new_bitmap, width, height, real_depth);
339 #endif
340
341   new_bitmap->width = width;
342   new_bitmap->height = height;
343
344   return new_bitmap;
345 }
346
347 inline static void FreeBitmapPointers(Bitmap *bitmap)
348 {
349   if (bitmap == NULL)
350     return;
351
352 #if defined(TARGET_SDL)
353   SDLFreeBitmapPointers(bitmap);
354 #else
355   X11FreeBitmapPointers(bitmap);
356 #endif
357
358   checked_free(bitmap->source_filename);
359   bitmap->source_filename = NULL;
360 }
361
362 inline static void TransferBitmapPointers(Bitmap *src_bitmap,
363                                           Bitmap *dst_bitmap)
364 {
365   if (src_bitmap == NULL || dst_bitmap == NULL)
366     return;
367
368   FreeBitmapPointers(dst_bitmap);
369
370   *dst_bitmap = *src_bitmap;
371 }
372
373 inline void FreeBitmap(Bitmap *bitmap)
374 {
375   if (bitmap == NULL)
376     return;
377
378   FreeBitmapPointers(bitmap);
379
380   free(bitmap);
381 }
382
383 inline void CloseWindow(DrawWindow *window)
384 {
385 #if defined(TARGET_X11)
386   if (window->drawable)
387   {
388     XUnmapWindow(display, window->drawable);
389     XDestroyWindow(display, window->drawable);
390   }
391   if (window->gc)
392     XFreeGC(display, window->gc);
393 #endif
394 }
395
396 static inline boolean CheckDrawingArea(int x, int y, int width, int height,
397                                        int draw_mask)
398 {
399   if (draw_mask == REDRAW_NONE)
400     return FALSE;
401
402   if (draw_mask & REDRAW_ALL)
403     return TRUE;
404
405   if ((draw_mask & REDRAW_FIELD) && x < gfx.real_sx + gfx.full_sxsize)
406     return TRUE;
407
408   if ((draw_mask & REDRAW_DOOR_1) && x >= gfx.dx && y < gfx.dy + gfx.dysize)
409     return TRUE;
410
411   if ((draw_mask & REDRAW_DOOR_2) && x >= gfx.dx && y >= gfx.vy)
412     return TRUE;
413
414   return FALSE;
415 }
416
417 inline boolean DrawingDeactivated(int x, int y, int width, int height)
418 {
419   return CheckDrawingArea(x, y, width, height, gfx.draw_deactivation_mask);
420 }
421
422 inline boolean DrawingOnBackground(int x, int y)
423 {
424   return (CheckDrawingArea(x, y, 1, 1, gfx.background_bitmap_mask) &&
425           CheckDrawingArea(x, y, 1, 1, gfx.draw_background_mask));
426 }
427
428 inline void BlitBitmap(Bitmap *src_bitmap, Bitmap *dst_bitmap,
429                        int src_x, int src_y, int width, int height,
430                        int dst_x, int dst_y)
431 {
432   if (DrawingDeactivated(dst_x, dst_y, width, height))
433     return;
434
435   sysCopyArea(src_bitmap, dst_bitmap, src_x, src_y, width, height,
436               dst_x, dst_y, BLIT_OPAQUE);
437 }
438
439 inline void FillRectangle(Bitmap *bitmap, int x, int y, int width, int height,
440                           Pixel color)
441 {
442   if (DrawingDeactivated(x, y, width, height))
443     return;
444
445   sysFillRectangle(bitmap, x, y, width, height, color);
446 }
447
448 inline void ClearRectangle(Bitmap *bitmap, int x, int y, int width, int height)
449 {
450   FillRectangle(bitmap, x, y, width, height, BLACK_PIXEL);
451 }
452
453 inline void ClearRectangleOnBackground(Bitmap *bitmap, int x, int y,
454                                        int width, int height)
455 {
456   if (DrawingOnBackground(x, y))
457     BlitBitmap(gfx.background_bitmap, bitmap, x, y, width, height, x, y);
458   else
459     ClearRectangle(bitmap, x, y, width, height);
460 }
461
462 inline void SetClipMask(Bitmap *bitmap, GC clip_gc, Pixmap clip_pixmap)
463 {
464 #if defined(TARGET_X11)
465   if (clip_gc)
466   {
467     bitmap->clip_gc = clip_gc;
468     XSetClipMask(display, bitmap->clip_gc, clip_pixmap);
469   }
470 #endif
471 }
472
473 inline void SetClipOrigin(Bitmap *bitmap, GC clip_gc, int clip_x, int clip_y)
474 {
475 #if defined(TARGET_X11)
476   if (clip_gc)
477   {
478     bitmap->clip_gc = clip_gc;
479     XSetClipOrigin(display, bitmap->clip_gc, clip_x, clip_y);
480   }
481 #endif
482 }
483
484 inline void BlitBitmapMasked(Bitmap *src_bitmap, Bitmap *dst_bitmap,
485                              int src_x, int src_y,
486                              int width, int height,
487                              int dst_x, int dst_y)
488 {
489   if (DrawingDeactivated(dst_x, dst_y, width, height))
490     return;
491
492   sysCopyArea(src_bitmap, dst_bitmap, src_x, src_y, width, height,
493               dst_x, dst_y, BLIT_MASKED);
494 }
495
496 inline void BlitBitmapOnBackground(Bitmap *src_bitmap, Bitmap *dst_bitmap,
497                                    int src_x, int src_y,
498                                    int width, int height,
499                                    int dst_x, int dst_y)
500 {
501   if (DrawingOnBackground(dst_x, dst_y))
502   {
503     /* draw background */
504     BlitBitmap(gfx.background_bitmap, dst_bitmap, dst_x, dst_y, width, height,
505                dst_x, dst_y);
506
507     /* draw foreground */
508     SetClipOrigin(src_bitmap, src_bitmap->stored_clip_gc,
509                   dst_x - src_x, dst_y - src_y);
510     BlitBitmapMasked(src_bitmap, dst_bitmap, src_x, src_y, width, height,
511                      dst_x, dst_y);
512   }
513   else
514     BlitBitmap(src_bitmap, dst_bitmap, src_x, src_y, width, height,
515                dst_x, dst_y);
516 }
517
518 inline void DrawSimpleBlackLine(Bitmap *bitmap, int from_x, int from_y,
519                                 int to_x, int to_y)
520 {
521 #if defined(TARGET_SDL)
522   SDLDrawSimpleLine(bitmap, from_x, from_y, to_x, to_y, BLACK_PIXEL);
523 #else
524   X11DrawSimpleLine(bitmap, from_x, from_y, to_x, to_y, BLACK_PIXEL);
525 #endif
526 }
527
528 inline void DrawSimpleWhiteLine(Bitmap *bitmap, int from_x, int from_y,
529                                 int to_x, int to_y)
530 {
531 #if defined(TARGET_SDL)
532   SDLDrawSimpleLine(bitmap, from_x, from_y, to_x, to_y, WHITE_PIXEL);
533 #else
534   X11DrawSimpleLine(bitmap, from_x, from_y, to_x, to_y, WHITE_PIXEL);
535 #endif
536 }
537
538 #if !defined(TARGET_X11_NATIVE)
539 inline void DrawLine(Bitmap *bitmap, int from_x, int from_y,
540                      int to_x, int to_y, Pixel pixel, int line_width)
541 {
542   int x, y;
543
544   for (x = 0; x < line_width; x++)
545   {
546     for (y = 0; y < line_width; y++)
547     {
548       int dx = x - line_width / 2;
549       int dy = y - line_width / 2;
550
551       if ((x == 0 && y == 0) ||
552           (x == 0 && y == line_width - 1) ||
553           (x == line_width - 1 && y == 0) ||
554           (x == line_width - 1 && y == line_width - 1))
555         continue;
556
557 #if defined(TARGET_SDL)
558       SDLDrawLine(bitmap,
559                   from_x + dx, from_y + dy, to_x + dx, to_y + dy, pixel);
560 #elif defined(TARGET_ALLEGRO)
561       AllegroDrawLine(bitmap->drawable, from_x + dx, from_y + dy,
562                       to_x + dx, to_y + dy, pixel);
563 #endif
564     }
565   }
566 }
567 #endif
568
569 inline void DrawLines(Bitmap *bitmap, struct XY *points, int num_points,
570                       Pixel pixel)
571 {
572 #if !defined(TARGET_X11_NATIVE)
573   int line_width = 4;
574   int i;
575
576   for (i = 0; i < num_points - 1; i++)
577     DrawLine(bitmap, points[i].x, points[i].y,
578              points[i + 1].x, points[i + 1].y, pixel, line_width);
579
580   /*
581   SDLDrawLines(bitmap->surface, points, num_points, pixel);
582   */
583 #else
584   XSetForeground(display, bitmap->line_gc[1], pixel);
585   XDrawLines(display, bitmap->drawable, bitmap->line_gc[1],
586              (XPoint *)points, num_points, CoordModeOrigin);
587 #endif
588 }
589
590 inline Pixel GetPixel(Bitmap *bitmap, int x, int y)
591 {
592   if (x < 0 || x >= bitmap->width ||
593       y < 0 || y >= bitmap->height)
594     return BLACK_PIXEL;
595
596 #if defined(TARGET_SDL)
597   return SDLGetPixel(bitmap, x, y);
598 #elif defined(TARGET_ALLEGRO)
599   return AllegroGetPixel(bitmap->drawable, x, y);
600 #else
601   return X11GetPixel(bitmap, x, y);
602 #endif
603 }
604
605 inline Pixel GetPixelFromRGB(Bitmap *bitmap, unsigned int color_r,
606                              unsigned int color_g, unsigned int color_b)
607 {
608 #if defined(TARGET_SDL)
609   return SDL_MapRGB(bitmap->surface->format, color_r, color_g, color_b);
610 #elif defined(TARGET_ALLEGRO)
611   return AllegroAllocColorCell(color_r << 8, color_g << 8, color_b << 8);
612 #else
613   return X11GetPixelFromRGB(color_r, color_g, color_b);
614 #endif
615 }
616
617 inline Pixel GetPixelFromRGBcompact(Bitmap *bitmap, unsigned int color)
618 {
619   unsigned int color_r = (color >> 16) & 0xff;
620   unsigned int color_g = (color >>  8) & 0xff;
621   unsigned int color_b = (color >>  0) & 0xff;
622
623   return GetPixelFromRGB(bitmap, color_r, color_g, color_b);
624 }
625
626 /* execute all pending screen drawing operations */
627 inline void FlushDisplay(void)
628 {
629 #ifndef TARGET_SDL
630   XFlush(display);
631 #endif
632 }
633
634 /* execute and wait for all pending screen drawing operations */
635 inline void SyncDisplay(void)
636 {
637 #ifndef TARGET_SDL
638   XSync(display, FALSE);
639 #endif
640 }
641
642 inline void KeyboardAutoRepeatOn(void)
643 {
644 #if defined(TARGET_SDL)
645   SDL_EnableKeyRepeat(SDL_DEFAULT_REPEAT_DELAY / 2,
646                       SDL_DEFAULT_REPEAT_INTERVAL / 2);
647   SDL_EnableUNICODE(1);
648 #else
649   if (display)
650     XAutoRepeatOn(display);
651 #endif
652 }
653
654 inline void KeyboardAutoRepeatOff(void)
655 {
656 #if defined(TARGET_SDL)
657   SDL_EnableKeyRepeat(0, SDL_DEFAULT_REPEAT_INTERVAL);
658   SDL_EnableUNICODE(0);
659 #else
660   if (display)
661     XAutoRepeatOff(display);
662 #endif
663 }
664
665 inline boolean PointerInWindow(DrawWindow *window)
666 {
667 #if defined(TARGET_SDL)
668   return TRUE;
669 #else
670   Window root, child;
671   int root_x, root_y;
672   unsigned int mask;
673   int win_x, win_y;
674
675   /* if XQueryPointer() returns False, the pointer
676      is not on the same screen as the specified window */
677   return XQueryPointer(display, window->drawable, &root, &child,
678                        &root_x, &root_y, &win_x, &win_y, &mask);
679 #endif
680 }
681
682 inline boolean SetVideoMode(boolean fullscreen)
683 {
684 #if defined(TARGET_SDL)
685   return SDLSetVideoMode(&backbuffer, fullscreen);
686 #else
687   boolean success = TRUE;
688
689   if (fullscreen && video.fullscreen_available)
690   {
691     Error(ERR_WARN, "fullscreen not available in X11 version");
692
693     /* display error message only once */
694     video.fullscreen_available = FALSE;
695
696     success = FALSE;
697   }
698
699   return success;
700 #endif
701 }
702
703 inline boolean ChangeVideoModeIfNeeded(boolean fullscreen)
704 {
705 #if defined(TARGET_SDL)
706   if ((fullscreen && !video.fullscreen_enabled && video.fullscreen_available)||
707       (!fullscreen && video.fullscreen_enabled))
708     fullscreen = SetVideoMode(fullscreen);
709 #endif
710
711   return fullscreen;
712 }
713
714 Bitmap *LoadImage(char *filename)
715 {
716   Bitmap *new_bitmap;
717
718 #if defined(TARGET_SDL)
719   new_bitmap = SDLLoadImage(filename);
720 #else
721   new_bitmap = X11LoadImage(filename);
722 #endif
723
724   if (new_bitmap)
725     new_bitmap->source_filename = getStringCopy(filename);
726
727   return new_bitmap;
728 }
729
730 Bitmap *LoadCustomImage(char *basename)
731 {
732   char *filename = getCustomImageFilename(basename);
733   Bitmap *new_bitmap;
734
735   if (filename == NULL)
736     Error(ERR_EXIT, "LoadCustomImage(): cannot find file '%s'", basename);
737
738   if ((new_bitmap = LoadImage(filename)) == NULL)
739     Error(ERR_EXIT, "LoadImage() failed: %s", GetError());
740
741   return new_bitmap;
742 }
743
744 void ReloadCustomImage(Bitmap *bitmap, char *basename)
745 {
746   char *filename = getCustomImageFilename(basename);
747   Bitmap *new_bitmap;
748
749   if (filename == NULL)         /* (should never happen) */
750   {
751     Error(ERR_WARN, "ReloadCustomImage(): cannot find file '%s'", basename);
752     return;
753   }
754
755   if (strcmp(filename, bitmap->source_filename) == 0)
756   {
757     /* The old and new image are the same (have the same filename and path).
758        This usually means that this image does not exist in this graphic set
759        and a fallback to the existing image is done. */
760
761     return;
762   }
763
764   if ((new_bitmap = LoadImage(filename)) == NULL)
765   {
766     Error(ERR_WARN, "LoadImage() failed: %s", GetError());
767     return;
768   }
769
770   if (bitmap->width != new_bitmap->width ||
771       bitmap->height != new_bitmap->height)
772   {
773     Error(ERR_WARN, "ReloadCustomImage: new image '%s' has wrong dimensions",
774           filename);
775     FreeBitmap(new_bitmap);
776     return;
777   }
778
779   TransferBitmapPointers(new_bitmap, bitmap);
780   free(new_bitmap);
781 }
782
783 Bitmap *ZoomBitmap(Bitmap *src_bitmap, int zoom_width, int zoom_height)
784 {
785   Bitmap *dst_bitmap = CreateBitmap(zoom_width, zoom_height, DEFAULT_DEPTH);
786
787 #if defined(TARGET_SDL)
788   SDLZoomBitmap(src_bitmap, dst_bitmap);
789 #else
790   X11ZoomBitmap(src_bitmap, dst_bitmap);
791 #endif
792
793   return dst_bitmap;
794 }
795
796 void CreateBitmapWithSmallBitmaps(Bitmap *old_bitmap, int zoom_factor)
797 {
798   Bitmap swap_bitmap;
799   Bitmap *new_bitmap, *tmp_bitmap_1, *tmp_bitmap_2, *tmp_bitmap_8;
800   int width_1, height_1, width_2, height_2, width_8, height_8;
801   int new_width, new_height;
802
803   width_1  = old_bitmap->width  * zoom_factor;
804   height_1 = old_bitmap->height * zoom_factor;
805   width_2  = width_1  / 2;
806   height_2 = height_1 / 2;
807   width_8  = width_1  / 8;
808   height_8 = height_1 / 8;
809
810   /* get image with normal size (this might require scaling up) */
811   if (zoom_factor != 1)
812     tmp_bitmap_1 = ZoomBitmap(old_bitmap, width_1, height_1);
813   else
814     tmp_bitmap_1 = old_bitmap;
815
816   /* get image with 1/2 of normal size (for use in the level editor) */
817   if (zoom_factor != 2)
818     tmp_bitmap_2 = ZoomBitmap(tmp_bitmap_1, width_1 / 2, height_1 / 2);
819   else
820     tmp_bitmap_2 = old_bitmap;
821
822   /* get image with 1/8 of normal size (for use on the preview screen) */
823   if (zoom_factor != 8)
824     tmp_bitmap_8 = ZoomBitmap(tmp_bitmap_1, width_1 / 8, height_1 / 8);
825   else
826     tmp_bitmap_8 = old_bitmap;
827
828   /* if image was scaled up, create new clipmask for normal size image */
829   if (zoom_factor != 1)
830   {
831 #if defined(TARGET_X11)
832     if (old_bitmap->clip_mask)
833       XFreePixmap(display, old_bitmap->clip_mask);
834
835     old_bitmap->clip_mask =
836       Pixmap_to_Mask(tmp_bitmap_1->drawable, width_1, height_1);
837
838     XSetClipMask(display, old_bitmap->stored_clip_gc, old_bitmap->clip_mask);
839 #else
840     SDL_Surface *tmp_surface_1 = tmp_bitmap_1->surface;
841
842     if (old_bitmap->surface_masked)
843       SDL_FreeSurface(old_bitmap->surface_masked);
844
845     SDL_SetColorKey(tmp_surface_1, SDL_SRCCOLORKEY,
846                     SDL_MapRGB(tmp_surface_1->format, 0x00, 0x00, 0x00));
847     if ((old_bitmap->surface_masked = SDL_DisplayFormat(tmp_surface_1)) ==NULL)
848       Error(ERR_EXIT, "SDL_DisplayFormat() failed");
849     SDL_SetColorKey(tmp_surface_1, 0, 0);       /* reset transparent pixel */
850 #endif
851   }
852
853   new_width  = width_1;
854   new_height = height_1 + (height_1 + 1) / 2;     /* prevent odd height */
855
856   new_bitmap = CreateBitmap(new_width, new_height, DEFAULT_DEPTH);
857
858   BlitBitmap(tmp_bitmap_1, new_bitmap, 0, 0, width_1, height_1, 0, 0);
859   BlitBitmap(tmp_bitmap_2, new_bitmap, 0, 0, width_1 / 2, height_1 / 2,
860              0, height_1);
861   BlitBitmap(tmp_bitmap_8, new_bitmap, 0, 0, width_1 / 8, height_1 / 8,
862              3 * width_1 / 4, height_1);
863
864   if (zoom_factor != 1)
865     FreeBitmap(tmp_bitmap_1);
866
867   if (zoom_factor != 2)
868     FreeBitmap(tmp_bitmap_2);
869
870   if (zoom_factor != 8)
871     FreeBitmap(tmp_bitmap_8);
872
873   /* replace image with extended image (containing normal, 1/2 and 1/8 size) */
874 #if defined(TARGET_SDL)
875   swap_bitmap.surface = old_bitmap->surface;
876   old_bitmap->surface = new_bitmap->surface;
877   new_bitmap->surface = swap_bitmap.surface;
878 #else
879   swap_bitmap.drawable = old_bitmap->drawable;
880   old_bitmap->drawable = new_bitmap->drawable;
881   new_bitmap->drawable = swap_bitmap.drawable;
882 #endif
883
884   old_bitmap->width  = new_bitmap->width;
885   old_bitmap->height = new_bitmap->height;
886
887   FreeBitmap(new_bitmap);
888 }
889
890
891 /* ------------------------------------------------------------------------- */
892 /* mouse pointer functions                                                   */
893 /* ------------------------------------------------------------------------- */
894
895 #if !defined(PLATFORM_MSDOS)
896 /* XPM */
897 static const char *cursor_image_playfield[] =
898 {
899   /* width height num_colors chars_per_pixel */
900   "    16    16        3            1",
901
902   /* colors */
903   "X c #000000",
904   ". c #ffffff",
905   "  c None",
906
907 #if 1
908   /* some people complained about a "white dot" on the screen and thought it
909      was a graphical error... OK, let's just remove the whole pointer :-) */
910
911   /* pixels */
912   "                ",
913   "                ",
914   "                ",
915   "                ",
916   "                ",
917   "                ",
918   "                ",
919   "                ",
920   "                ",
921   "                ",
922   "                ",
923   "                ",
924   "                ",
925   "                ",
926   "                ",
927   "                ",
928
929   /* hot spot */
930   "0,0"
931
932 #else
933
934   /* pixels */
935   " X              ",
936   "X.X             ",
937   " X              ",
938   "                ",
939   "                ",
940   "                ",
941   "                ",
942   "                ",
943   "                ",
944   "                ",
945   "                ",
946   "                ",
947   "                ",
948   "                ",
949   "                ",
950   "                ",
951
952   /* hot spot */
953   "1,1"
954 #endif
955 };
956
957 #if defined(TARGET_SDL)
958 static const int cursor_bit_order = BIT_ORDER_MSB;
959 #elif defined(TARGET_X11_NATIVE)
960 static const int cursor_bit_order = BIT_ORDER_LSB;
961 #endif
962
963 static struct MouseCursorInfo *get_cursor_from_image(const char **image)
964 {
965   struct MouseCursorInfo *cursor;
966   boolean bit_order_msb = (cursor_bit_order == BIT_ORDER_MSB);
967   int header_lines = 4;
968   int x, y, i;
969
970   cursor = checked_calloc(sizeof(struct MouseCursorInfo));
971
972   sscanf(image[0], " %d %d ", &cursor->width, &cursor->height);
973
974   i = -1;
975   for (y = 0; y < cursor->width; y++)
976   {
977     for (x = 0; x < cursor->height; x++)
978     {
979       int bit_nr = x % 8;
980       int bit_mask = 0x01 << (bit_order_msb ? 7 - bit_nr : bit_nr );
981
982       if (bit_nr == 0)
983       {
984         i++;
985         cursor->data[i] = cursor->mask[i] = 0;
986       }
987
988       switch (image[header_lines + y][x])
989       {
990         case 'X':
991           cursor->data[i] |= bit_mask;
992           cursor->mask[i] |= bit_mask;
993           break;
994
995         case '.':
996           cursor->mask[i] |= bit_mask;
997           break;
998
999         case ' ':
1000           break;
1001       }
1002     }
1003   }
1004
1005   sscanf(image[header_lines + y], "%d,%d", &cursor->hot_x, &cursor->hot_y);
1006
1007   return cursor;
1008 }
1009 #endif  /* !PLATFORM_MSDOS */
1010
1011 void SetMouseCursor(int mode)
1012 {
1013 #if !defined(PLATFORM_MSDOS)
1014   static struct MouseCursorInfo *cursor_playfield = NULL;
1015
1016   if (cursor_playfield == NULL)
1017     cursor_playfield = get_cursor_from_image(cursor_image_playfield);
1018
1019 #if defined(TARGET_SDL)
1020   SDLSetMouseCursor(mode == CURSOR_PLAYFIELD ? cursor_playfield : NULL);
1021 #elif defined(TARGET_X11_NATIVE)
1022   X11SetMouseCursor(mode == CURSOR_PLAYFIELD ? cursor_playfield : NULL);
1023 #endif
1024 #endif
1025 }
1026
1027
1028 /* ========================================================================= */
1029 /* audio functions                                                           */
1030 /* ========================================================================= */
1031
1032 inline void OpenAudio(void)
1033 {
1034   /* always start with reliable default values */
1035   audio.sound_available = FALSE;
1036   audio.music_available = FALSE;
1037   audio.loops_available = FALSE;
1038
1039   audio.sound_enabled = FALSE;
1040   audio.sound_deactivated = FALSE;
1041
1042   audio.mixer_pipe[0] = audio.mixer_pipe[1] = 0;
1043   audio.mixer_pid = 0;
1044   audio.device_name = NULL;
1045   audio.device_fd = -1;
1046
1047   audio.num_channels = 0;
1048   audio.music_channel = 0;
1049   audio.first_sound_channel = 0;
1050
1051 #if defined(TARGET_SDL)
1052   SDLOpenAudio();
1053 #elif defined(PLATFORM_UNIX)
1054   UnixOpenAudio();
1055 #elif defined(PLATFORM_MSDOS)
1056   MSDOSOpenAudio();
1057 #endif
1058 }
1059
1060 inline void CloseAudio(void)
1061 {
1062 #if defined(TARGET_SDL)
1063   SDLCloseAudio();
1064 #elif defined(PLATFORM_UNIX)
1065   UnixCloseAudio();
1066 #elif defined(PLATFORM_MSDOS)
1067   MSDOSCloseAudio();
1068 #endif
1069
1070   audio.sound_enabled = FALSE;
1071 }
1072
1073 inline void SetAudioMode(boolean enabled)
1074 {
1075   if (!audio.sound_available)
1076     return;
1077
1078   audio.sound_enabled = enabled;
1079 }
1080
1081
1082 /* ========================================================================= */
1083 /* event functions                                                           */
1084 /* ========================================================================= */
1085
1086 inline void InitEventFilter(EventFilter filter_function)
1087 {
1088 #if defined(TARGET_SDL)
1089   /* set event filter to filter out certain events */
1090   SDL_SetEventFilter(filter_function);
1091 #endif
1092 }
1093
1094 inline boolean PendingEvent(void)
1095 {
1096 #if defined(TARGET_SDL)
1097   return (SDL_PollEvent(NULL) ? TRUE : FALSE);
1098 #else
1099   return (XPending(display) ? TRUE : FALSE);
1100 #endif
1101 }
1102
1103 inline void NextEvent(Event *event)
1104 {
1105 #if defined(TARGET_SDL)
1106   SDLNextEvent(event);
1107 #else
1108   XNextEvent(display, event);
1109 #endif
1110 }
1111
1112 inline void PeekEvent(Event *event)
1113 {
1114 #if defined(TARGET_SDL)
1115   SDL_PeepEvents(event, 1, SDL_PEEKEVENT, SDL_ALLEVENTS);
1116 #else
1117   XPeekEvent(display, event);
1118 #endif
1119 }
1120
1121 inline Key GetEventKey(KeyEvent *event, boolean with_modifiers)
1122 {
1123 #if defined(TARGET_SDL)
1124
1125 #if 0
1126   printf("unicode == '%d', sym == '%d', mod == '0x%04x'\n",
1127          (int)event->keysym.unicode,
1128          (int)event->keysym.sym,
1129          (int)SDL_GetModState());
1130 #endif
1131
1132   if (with_modifiers &&
1133       event->keysym.unicode > 0x0000 &&
1134       event->keysym.unicode < 0x2000)
1135     return event->keysym.unicode;
1136   else
1137     return event->keysym.sym;
1138
1139 #else
1140
1141 #if 0
1142   printf("with modifiers == '0x%04x', without modifiers == '0x%04x'\n",
1143          (int)XLookupKeysym(event, event->state),
1144          (int)XLookupKeysym(event, 0));
1145 #endif
1146
1147   if (with_modifiers)
1148     return XLookupKeysym(event, event->state);
1149   else
1150     return XLookupKeysym(event, 0);
1151 #endif
1152 }
1153
1154 inline KeyMod HandleKeyModState(Key key, int key_status)
1155 {
1156   static KeyMod current_modifiers = KMOD_None;
1157
1158 #if !defined(TARGET_SDL)
1159   if (key != KSYM_UNDEFINED)    /* new key => check for modifier key change */
1160   {
1161     KeyMod new_modifier = KMOD_None;
1162
1163     switch(key)
1164     {
1165       case KSYM_Shift_L:
1166         new_modifier = KMOD_Shift_L;
1167         break;
1168       case KSYM_Shift_R:
1169         new_modifier = KMOD_Shift_R;
1170         break;
1171       case KSYM_Control_L:
1172         new_modifier = KMOD_Control_L;
1173         break;
1174       case KSYM_Control_R:
1175         new_modifier = KMOD_Control_R;
1176         break;
1177       case KSYM_Meta_L:
1178         new_modifier = KMOD_Meta_L;
1179         break;
1180       case KSYM_Meta_R:
1181         new_modifier = KMOD_Meta_R;
1182         break;
1183       case KSYM_Alt_L:
1184         new_modifier = KMOD_Alt_L;
1185         break;
1186       case KSYM_Alt_R:
1187         new_modifier = KMOD_Alt_R;
1188         break;
1189       default:
1190         break;
1191     }
1192
1193     if (key_status == KEY_PRESSED)
1194       current_modifiers |= new_modifier;
1195     else
1196       current_modifiers &= ~new_modifier;
1197   }
1198 #endif
1199
1200   return current_modifiers;
1201 }
1202
1203 inline KeyMod GetKeyModState()
1204 {
1205 #if defined(TARGET_SDL)
1206   return (KeyMod)SDL_GetModState();
1207 #else
1208   return HandleKeyModState(KSYM_UNDEFINED, 0);
1209 #endif
1210 }
1211
1212 inline boolean CheckCloseWindowEvent(ClientMessageEvent *event)
1213 {
1214   if (event->type != EVENT_CLIENTMESSAGE)
1215     return FALSE;
1216
1217 #if defined(TARGET_SDL)
1218   return TRUE;          /* the only possible message here is SDL_QUIT */
1219 #elif defined(PLATFORM_UNIX)
1220   if ((event->window == window->drawable) &&
1221       (event->data.l[0] == XInternAtom(display, "WM_DELETE_WINDOW", FALSE)))
1222     return TRUE;
1223 #endif
1224
1225   return FALSE;
1226 }
1227
1228
1229 /* ========================================================================= */
1230 /* joystick functions                                                        */
1231 /* ========================================================================= */
1232
1233 inline void InitJoysticks()
1234 {
1235   int i;
1236
1237 #if defined(NO_JOYSTICK)
1238   return;       /* joysticks generally deactivated by compile-time directive */
1239 #endif
1240
1241   /* always start with reliable default values */
1242   joystick.status = JOYSTICK_NOT_AVAILABLE;
1243   for (i = 0; i < MAX_PLAYERS; i++)
1244     joystick.fd[i] = -1;                /* joystick device closed */
1245
1246 #if defined(TARGET_SDL)
1247   SDLInitJoysticks();
1248 #elif defined(PLATFORM_UNIX)
1249   UnixInitJoysticks();
1250 #elif defined(PLATFORM_MSDOS)
1251   MSDOSInitJoysticks();
1252 #endif
1253
1254 #if 0
1255   for (i = 0; i < MAX_PLAYERS; i++)
1256     printf("::: Joystick for player %d: %d\n", i, joystick.fd[i]);
1257 #endif
1258 }
1259
1260 inline boolean ReadJoystick(int nr, int *x, int *y, boolean *b1, boolean *b2)
1261 {
1262 #if defined(TARGET_SDL)
1263   return SDLReadJoystick(nr, x, y, b1, b2);
1264 #elif defined(PLATFORM_UNIX)
1265   return UnixReadJoystick(nr, x, y, b1, b2);
1266 #elif defined(PLATFORM_MSDOS)
1267   return MSDOSReadJoystick(nr, x, y, b1, b2);
1268 #endif
1269 }