]> icculus.org git repositories - btb/d2x.git/blob - main/movie.c
small hack to fix briefing palette switching, remove old broken hacks
[btb/d2x.git] / main / movie.c
1 /*
2 THE COMPUTER CODE CONTAINED HEREIN IS THE SOLE PROPERTY OF PARALLAX
3 SOFTWARE CORPORATION ("PARALLAX").  PARALLAX, IN DISTRIBUTING THE CODE TO
4 END-USERS, AND SUBJECT TO ALL OF THE TERMS AND CONDITIONS HEREIN, GRANTS A
5 ROYALTY-FREE, PERPETUAL LICENSE TO SUCH END-USERS FOR USE BY SUCH END-USERS
6 IN USING, DISPLAYING,  AND CREATING DERIVATIVE WORKS THEREOF, SO LONG AS
7 SUCH USE, DISPLAY OR CREATION IS FOR NON-COMMERCIAL, ROYALTY OR REVENUE
8 FREE PURPOSES.  IN NO EVENT SHALL THE END-USER USE THE COMPUTER CODE
9 CONTAINED HEREIN FOR REVENUE-BEARING PURPOSES.  THE END-USER UNDERSTANDS
10 AND AGREES TO THE TERMS HEREIN AND ACCEPTS THE SAME BY USE OF THIS FILE.
11 COPYRIGHT 1993-1999 PARALLAX SOFTWARE CORPORATION.  ALL RIGHTS RESERVED.
12 */
13
14 /*
15  *
16  * Movie Playing Stuff
17  *
18  */
19
20 #ifdef HAVE_CONFIG_H
21 #include <conf.h>
22 #endif
23
24 #include <string.h>
25 #ifndef macintosh
26 # ifndef _WIN32_WCE
27 #  include <sys/types.h>
28 #  include <sys/stat.h>
29 #  include <fcntl.h>
30 # endif
31 # ifndef _MSC_VER
32 #  include <unistd.h>
33 # endif
34 #endif // ! macintosh
35 #include <ctype.h>
36
37 #include "movie.h"
38 #include "console.h"
39 #include "args.h"
40 #include "key.h"
41 #include "digi.h"
42 #include "songs.h"
43 #include "inferno.h"
44 #include "palette.h"
45 #include "strutil.h"
46 #include "error.h"
47 #include "u_mem.h"
48 #include "byteswap.h"
49 #include "gr.h"
50 #include "gamefont.h"
51 #include "cfile.h"
52 #include "menu.h"
53 #include "libmve.h"
54 #include "text.h"
55 #include "screens.h"
56 #include "physfsrwops.h"
57
58 extern int MenuHiresAvailable;
59 extern char CDROM_dir[];
60
61
62 // Subtitle data
63 typedef struct {
64         short first_frame,last_frame;
65         char *msg;
66 } subtitle;
67
68 #define MAX_SUBTITLES 500
69 #define MAX_ACTIVE_SUBTITLES 3
70 subtitle Subtitles[MAX_SUBTITLES];
71 int Num_subtitles;
72
73 // Movielib data
74
75 #ifdef D2_OEM
76 char movielib_files[5][FILENAME_LEN] = {"intro","other","robots","oem"};
77 #else
78 char movielib_files[4][FILENAME_LEN] = {"intro","other","robots"};
79 #endif
80
81 #define N_MOVIE_LIBS (sizeof(movielib_files) / sizeof(*movielib_files))
82 #define N_BUILTIN_MOVIE_LIBS (N_MOVIE_LIBS - 1)
83 #define EXTRA_ROBOT_LIB N_BUILTIN_MOVIE_LIBS
84
85 int MovieHires = 1;   //default is highres
86
87 SDL_RWops *RoboFile;
88
89 // Function Prototypes
90 int RunMovie(char *filename, int highres_flag, int allow_abort,int dx,int dy);
91
92 void decode_text_line(char *p);
93 void draw_subtitles(int frame_num);
94
95
96 // ----------------------------------------------------------------------
97 void* MPlayAlloc(unsigned size)
98 {
99     return d_malloc(size);
100 }
101
102 void MPlayFree(void *p)
103 {
104     d_free(p);
105 }
106
107
108 //-----------------------------------------------------------------------
109
110 unsigned int FileRead(void *handle, void *buf, unsigned int count)
111 {
112     unsigned numread;
113     numread = SDL_RWread((SDL_RWops *)handle, buf, 1, count);
114     return (numread == count);
115 }
116
117
118 //-----------------------------------------------------------------------
119
120
121 //filename will actually get modified to be either low-res or high-res
122 //returns status.  see values in movie.h
123 int PlayMovie(const char *filename, int must_have)
124 {
125         char name[FILENAME_LEN],*p;
126         int c, ret;
127
128         if (FindArg("-nomovies"))
129                 return MOVIE_NOT_PLAYED;
130
131         strcpy(name,filename);
132
133         if ((p=strchr(name,'.')) == NULL)               //add extension, if missing
134                 strcat(name,".mve");
135
136         //check for escape already pressed & abort if so
137         while ((c=key_inkey()) != 0)
138                 if (c == KEY_ESC)
139                         return MOVIE_ABORTED;
140
141         // Stop all digital sounds currently playing.
142         digi_stop_all();
143
144         // Stop all songs
145         songs_stop_all();
146
147         digi_close();
148
149         // Start sound
150         if (!FindArg("-nosound"))
151                 MVE_sndInit(1);
152         else
153                 MVE_sndInit(-1);
154
155         ret = RunMovie(name,MovieHires,must_have,-1,-1);
156
157         if (!FindArg("-nosound"))
158                 digi_init();
159
160         Screen_mode = -1;               //force screen reset
161
162         return ret;
163 }
164
165
166 void MovieShowFrame(ubyte *buf, uint bufw, uint bufh, uint sx, uint sy,
167                                         uint w, uint h, uint dstx, uint dsty)
168 {
169         grs_bitmap source_bm;
170
171         //mprintf((0,"MovieShowFrame %d,%d  %d,%d  %d,%d  %d,%d\n",bufw,bufh,sx,sy,w,h,dstx,dsty));
172
173         Assert(bufw == w && bufh == h);
174
175         source_bm.bm_x = source_bm.bm_y = 0;
176         source_bm.bm_w = source_bm.bm_rowsize = bufw;
177         source_bm.bm_h = bufh;
178         source_bm.bm_type = BM_LINEAR;
179         source_bm.bm_flags = 0;
180         source_bm.bm_data = buf;
181
182         gr_bm_ubitblt(bufw,bufh,dstx,dsty,sx,sy,&source_bm,&grd_curcanv->cv_bitmap);
183 }
184
185 //our routine to set the pallete, called from the movie code
186 void MovieSetPalette(unsigned char *p, unsigned start, unsigned count)
187 {
188         if (count == 0)
189                 return;
190
191         //mprintf((0,"SetPalette p=%x, start=%d, count=%d\n",p,start,count));
192
193         //Color 0 should be black, and we get color 255
194         Assert(start>=1 && start+count-1<=254);
195
196         //Set color 0 to be black
197         gr_palette[0] = gr_palette[1] = gr_palette[2] = 0;
198
199         //Set color 255 to be our subtitle color
200         gr_palette[765] = gr_palette[766] = gr_palette[767] = 50;
201
202         //movie libs palette into our array
203         memcpy(gr_palette+start*3,p+start*3,count*3);
204
205         //finally set the palette in the hardware
206         gr_palette_load(gr_palette);
207
208         //MVE_SetPalette(p, start, count);
209 }
210
211
212 #if 0
213 typedef struct bkg {
214         short x, y, w, h;           // The location of the menu.
215         grs_bitmap * bmp;               // The background under the menu.
216 } bkg;
217
218 bkg movie_bg = {0,0,0,0,NULL};
219 #endif
220
221 #define BOX_BORDER (MenuHires?40:20)
222
223
224 void show_pause_message(char *msg)
225 {
226         int w,h,aw;
227         int x,y;
228
229         gr_set_current_canvas(NULL);
230         gr_set_curfont( SMALL_FONT );
231
232         gr_get_string_size(msg,&w,&h,&aw);
233
234         x = (grd_curscreen->sc_w-w)/2;
235         y = (grd_curscreen->sc_h-h)/2;
236
237 #if 0
238         if (movie_bg.bmp) {
239                 gr_free_bitmap(movie_bg.bmp);
240                 movie_bg.bmp = NULL;
241         }
242
243         // Save the background of the display
244         movie_bg.x=x; movie_bg.y=y; movie_bg.w=w; movie_bg.h=h;
245
246         movie_bg.bmp = gr_create_bitmap( w+BOX_BORDER, h+BOX_BORDER );
247
248         gr_bm_ubitblt(w+BOX_BORDER, h+BOX_BORDER, 0, 0, x-BOX_BORDER/2, y-BOX_BORDER/2, &(grd_curcanv->cv_bitmap), movie_bg.bmp );
249 #endif
250
251         gr_setcolor(0);
252         gr_rect(x-BOX_BORDER/2,y-BOX_BORDER/2,x+w+BOX_BORDER/2-1,y+h+BOX_BORDER/2-1);
253
254         gr_set_fontcolor( 255, -1 );
255
256         gr_ustring( 0x8000, y, msg );
257
258         gr_update();
259 }
260
261 void clear_pause_message()
262 {
263 #if 0
264         if (movie_bg.bmp) {
265
266                 gr_bitmap(movie_bg.x-BOX_BORDER/2, movie_bg.y-BOX_BORDER/2, movie_bg.bmp);
267
268                 gr_free_bitmap(movie_bg.bmp);
269                 movie_bg.bmp = NULL;
270         }
271 #endif
272 }
273
274
275 //returns status.  see movie.h
276 int RunMovie(char *filename, int hires_flag, int must_have,int dx,int dy)
277 {
278         SDL_RWops *filehndl;
279         int result=1,aborted=0;
280         int track = 0;
281         int frame_num;
282         int key;
283
284         result=1;
285
286         // Open Movie file.  If it doesn't exist, no movie, just return.
287
288         filehndl = PHYSFSRWOPS_openRead(filename);
289
290         if (!filehndl)
291         {
292                 if (must_have)
293                         con_printf(CON_URGENT, "Can't open movie <%s>: %s\n", filename, PHYSFS_getLastError());
294                 return MOVIE_NOT_PLAYED;
295         }
296
297         MVE_memCallbacks(MPlayAlloc, MPlayFree);
298         MVE_ioCallbacks(FileRead);
299         MVE_sfCallbacks(MovieShowFrame);
300         MVE_palCallbacks(MovieSetPalette);
301
302         if (hires_flag) {
303                 gr_set_mode(SM(640,480));
304         } else {
305                 gr_set_mode(SM(320,200));
306         }
307 #ifdef OGL
308         set_screen_mode(SCREEN_MENU);
309 #endif
310
311         if (MVE_rmPrepMovie((void *)filehndl, dx, dy, track)) {
312                 Int3();
313                 return MOVIE_NOT_PLAYED;
314         }
315
316         frame_num = 0;
317
318         FontHires = FontHiresAvailable && hires_flag;
319
320         while((result = MVE_rmStepMovie()) == 0) {
321
322                 draw_subtitles(frame_num);
323
324                 gr_update();
325
326                 key = key_inkey();
327
328                 // If ESCAPE pressed, then quit movie.
329                 if (key == KEY_ESC) {
330                         result = aborted = 1;
331                         break;
332                 }
333
334                 // If PAUSE pressed, then pause movie
335                 if (key == KEY_PAUSE) {
336                         MVE_rmHoldMovie();
337                         show_pause_message(TXT_PAUSE);
338                         while (!key_inkey()) ;
339                         clear_pause_message();
340                 }
341
342 #ifdef GR_SUPPORTS_FULLSCREEN_TOGGLE
343                 if ((key == KEY_ALTED+KEY_ENTER) ||
344                     (key == KEY_ALTED+KEY_PADENTER))
345                         gr_toggle_fullscreen();
346 #endif
347
348                 frame_num++;
349         }
350
351         Assert(aborted || result == MVE_ERR_EOF);        ///movie should be over
352
353     MVE_rmEndMovie();
354
355         SDL_FreeRW(filehndl);                           // Close Movie File
356
357         // Restore old graphic state
358
359         Screen_mode=-1;  //force reset of screen mode
360
361         return (aborted?MOVIE_ABORTED:MOVIE_PLAYED_FULL);
362 }
363
364
365 int InitMovieBriefing()
366 {
367 #if 0
368         if (MenuHires)
369                 gr_set_mode(SM(640,480));
370         else
371                 gr_set_mode(SM(320,200));
372
373         gr_init_sub_canvas( &VR_screen_pages[0], &grd_curscreen->sc_canvas, 0, 0, grd_curscreen->sc_w, grd_curscreen->sc_h );
374         gr_init_sub_canvas( &VR_screen_pages[1], &grd_curscreen->sc_canvas, 0, 0, grd_curscreen->sc_w, grd_curscreen->sc_h );
375 #endif
376
377         return 1;
378 }
379
380
381 //returns 1 if frame updated ok
382 int RotateRobot()
383 {
384         int err;
385
386         err = MVE_rmStepMovie();
387
388         if (err == MVE_ERR_EOF)     //end of movie, so reset
389         {
390                 SDL_RWseek(RoboFile, 0, SEEK_SET);
391                 if (MVE_rmPrepMovie(RoboFile, MenuHires?280:140, MenuHires?200:80, 0))
392                 {
393                         Int3();
394                         return 0;
395                 }
396         }
397         else if (err) {
398                 Int3();
399                 return 0;
400         }
401
402         return 1;
403 }
404
405
406 void DeInitRobotMovie(void)
407 {
408         MVE_rmEndMovie();
409         SDL_FreeRW(RoboFile);                           // Close Movie File
410 }
411
412
413 int InitRobotMovie(char *filename)
414 {
415         if (FindArg("-nomovies"))
416                 return 0;
417
418         con_printf(CON_DEBUG, "RoboFile=%s\n", filename);
419
420         MVE_sndInit(-1);        //tell movies to play no sound for robots
421
422         RoboFile = PHYSFSRWOPS_openRead(filename);
423
424         if (!RoboFile)
425         {
426                 con_printf(CON_URGENT, "Can't open movie <%s>: %s\n", filename, PHYSFS_getLastError());
427                 return MOVIE_NOT_PLAYED;
428         }
429
430         if (MVE_rmPrepMovie((void *)RoboFile, MenuHires?280:140, MenuHires?200:80, 0)) {
431                 Int3();
432                 return 0;
433         }
434
435         return 1;
436 }
437
438
439 /*
440  *              Subtitle system code
441  */
442
443 char *subtitle_raw_data;
444
445
446 //search for next field following whitespace 
447 char *next_field (char *p)
448 {
449         while (*p && !isspace(*p))
450                 p++;
451
452         if (!*p)
453                 return NULL;
454
455         while (*p && isspace(*p))
456                 p++;
457
458         if (!*p)
459                 return NULL;
460
461         return p;
462 }
463
464
465 int init_subtitles(char *filename)
466 {
467         CFILE *ifile;
468         int size,read_count;
469         char *p;
470         int have_binary = 0;
471
472         Num_subtitles = 0;
473
474         if (! FindArg("-subtitles"))
475                 return 0;
476
477         ifile = cfopen(filename,"rb");          //try text version
478
479         if (!ifile) {                                                           //no text version, try binary version
480                 char filename2[FILENAME_LEN];
481                 change_filename_extension(filename2, filename, ".TXB");
482                 ifile = cfopen(filename2,"rb");
483                 if (!ifile)
484                         return 0;
485                 have_binary = 1;
486         }
487
488         size = cfilelength(ifile);
489
490         MALLOC (subtitle_raw_data, char, size+1);
491
492         read_count = cfread(subtitle_raw_data, 1, size, ifile);
493
494         cfclose(ifile);
495
496         subtitle_raw_data[size] = 0;
497
498         if (read_count != size) {
499                 d_free(subtitle_raw_data);
500                 return 0;
501         }
502
503         p = subtitle_raw_data;
504
505         while (p && p < subtitle_raw_data+size) {
506                 char *endp;
507
508                 endp = strchr(p,'\n'); 
509                 if (endp) {
510                         if (endp[-1] == '\r')
511                                 endp[-1] = 0;           //handle 0d0a pair
512                         *endp = 0;                      //string termintor
513                 }
514
515                 if (have_binary)
516                         decode_text_line(p);
517
518                 if (*p != ';') {
519                         Subtitles[Num_subtitles].first_frame = atoi(p);
520                         p = next_field(p); if (!p) continue;
521                         Subtitles[Num_subtitles].last_frame = atoi(p);
522                         p = next_field(p); if (!p) continue;
523                         Subtitles[Num_subtitles].msg = p;
524
525                         Assert(Num_subtitles==0 || Subtitles[Num_subtitles].first_frame >= Subtitles[Num_subtitles-1].first_frame);
526                         Assert(Subtitles[Num_subtitles].last_frame >= Subtitles[Num_subtitles].first_frame);
527
528                         Num_subtitles++;
529                 }
530
531                 p = endp+1;
532
533         }
534
535         return 1;
536 }
537
538
539 void close_subtitles()
540 {
541         if (subtitle_raw_data)
542                 d_free(subtitle_raw_data);
543         subtitle_raw_data = NULL;
544         Num_subtitles = 0;
545 }
546
547
548 //draw the subtitles for this frame
549 void draw_subtitles(int frame_num)
550 {
551         static int active_subtitles[MAX_ACTIVE_SUBTITLES];
552         static int num_active_subtitles,next_subtitle,line_spacing;
553         int t,y;
554         int must_erase=0;
555
556         if (frame_num == 0) {
557                 num_active_subtitles = 0;
558                 next_subtitle = 0;
559                 gr_set_curfont( GAME_FONT );
560                 line_spacing = grd_curcanv->cv_font->ft_h + (grd_curcanv->cv_font->ft_h >> 2);
561                 gr_set_fontcolor(255,-1);
562         }
563
564         //get rid of any subtitles that have expired
565         for (t=0;t<num_active_subtitles;)
566                 if (frame_num > Subtitles[active_subtitles[t]].last_frame) {
567                         int t2;
568                         for (t2=t;t2<num_active_subtitles-1;t2++)
569                                 active_subtitles[t2] = active_subtitles[t2+1];
570                         num_active_subtitles--;
571                         must_erase = 1;
572                 }
573                 else
574                         t++;
575
576         //get any subtitles new for this frame 
577         while (next_subtitle < Num_subtitles && frame_num >= Subtitles[next_subtitle].first_frame) {
578                 if (num_active_subtitles >= MAX_ACTIVE_SUBTITLES)
579                         Error("Too many active subtitles!");
580                 active_subtitles[num_active_subtitles++] = next_subtitle;
581                 next_subtitle++;
582         }
583
584         //find y coordinate for first line of subtitles
585         y = grd_curcanv->cv_bitmap.bm_h-((line_spacing+1)*MAX_ACTIVE_SUBTITLES+2);
586
587         //erase old subtitles if necessary
588         if (must_erase) {
589                 gr_setcolor(0);
590                 gr_rect(0,y,grd_curcanv->cv_bitmap.bm_w-1,grd_curcanv->cv_bitmap.bm_h-1);
591         }
592
593         //now draw the current subtitles
594         for (t=0;t<num_active_subtitles;t++)
595                 if (active_subtitles[t] != -1) {
596                         gr_string(0x8000,y,Subtitles[active_subtitles[t]].msg);
597                         y += line_spacing+1;
598                 }
599 }
600
601
602 void close_movie(char *movielib, int is_robots)
603 {
604         int high_res;
605         char filename[FILENAME_LEN];
606
607         if (is_robots)
608                 high_res = MenuHiresAvailable;
609         else
610                 high_res = MovieHires;
611
612         sprintf(filename, "%s-%s.mvl", movielib, high_res?"h":"l");
613
614         if (!cfile_close(filename))
615         {
616                 con_printf(CON_URGENT, "Can't close movielib <%s>: %s\n", filename, PHYSFS_getLastError());
617                 sprintf(filename, "%s-%s.mvl", movielib, high_res?"l":"h");
618
619                 if (!cfile_close(filename))
620                         con_printf(CON_URGENT, "Can't close movielib <%s>: %s\n", filename, PHYSFS_getLastError());
621         }
622 }
623
624 void close_movies()
625 {
626         int i, is_robots;
627
628         for (i = 0 ; i < N_BUILTIN_MOVIE_LIBS ; i++)
629         {
630                 if (!strnicmp(movielib_files[i], "robot", 5))
631                         is_robots = 1;
632                 else
633                         is_robots = 0;
634
635                 close_movie(movielib_files[i], is_robots);
636         }
637 }
638
639
640 //ask user to put the D2 CD in.
641 //returns -1 if ESC pressed, 0 if OK chosen
642 //CD may not have been inserted
643 int request_cd(void)
644 {
645 #if 0
646         ubyte save_pal[256*3];
647         grs_canvas *save_canv,*tcanv;
648         int ret,was_faded=gr_palette_faded_out;
649
650         gr_palette_clear();
651
652         save_canv = grd_curcanv;
653         tcanv = gr_create_canvas(grd_curcanv->cv_w,grd_curcanv->cv_h);
654
655         gr_set_current_canvas(tcanv);
656         gr_ubitmap(0,0,&save_canv->cv_bitmap);
657         gr_set_current_canvas(save_canv);
658
659         gr_clear_canvas(BM_XRGB(0,0,0));
660
661         memcpy(save_pal,gr_palette,sizeof(save_pal));
662
663         memcpy(gr_palette,last_palette_for_color_fonts,sizeof(gr_palette));
664
665  try_again:;
666
667         ret = nm_messagebox( "CD ERROR", 1, "Ok", "Please insert your Descent II CD");
668
669         if (ret == -1) {
670                 int ret2;
671
672                 ret2 = nm_messagebox( "CD ERROR", 2, "Try Again", "Leave Game", "You must insert your\nDescent II CD to Continue");
673
674                 if (ret2 == -1 || ret2 == 0)
675                         goto try_again;
676         }
677
678         force_rb_register = 1;  //disc has changed; force register new CD
679
680         gr_palette_clear();
681
682         memcpy(gr_palette,save_pal,sizeof(save_pal));
683
684         gr_ubitmap(0,0,&tcanv->cv_bitmap);
685
686         if (!was_faded)
687                 gr_palette_load(gr_palette);
688
689         gr_free_canvas(tcanv);
690
691         return ret;
692 #else
693         con_printf(CON_DEBUG, "STUB: movie: request_cd\n");
694         return 0;
695 #endif
696 }
697
698
699 void init_movie(char *movielib, int is_robots, int required)
700 {
701         int high_res;
702         char filename[FILENAME_LEN];
703
704         //for robots, load highres versions if highres menus set
705         if (is_robots)
706                 high_res = MenuHiresAvailable;
707         else
708                 high_res = MovieHires;
709
710         sprintf(filename, "%s-%s.mvl", movielib, high_res?"h":"l");
711
712         if (!cfile_init(filename))
713         {
714                 if (required)
715                         con_printf(CON_URGENT, "Can't open movielib <%s>: %s\n", filename, PHYSFS_getLastError());
716
717                 sprintf(filename, "%s-%s.mvl", movielib, high_res?"l":"h");
718
719                 if (!cfile_init(filename))
720                         if (required)
721                                 con_printf(CON_URGENT, "Can't open movielib <%s>: %s\n", filename, PHYSFS_getLastError());
722         }
723 }
724
725
726 //find and initialize the movie libraries
727 void init_movies()
728 {
729         int i;
730         int is_robots;
731
732         if (FindArg("-nomovies"))
733                 return;
734
735         for (i=0;i<N_BUILTIN_MOVIE_LIBS;i++) {
736
737                 if (!strnicmp(movielib_files[i],"robot",5))
738                         is_robots = 1;
739                 else
740                         is_robots = 0;
741
742                 init_movie(movielib_files[i], is_robots, 1);
743         }
744
745         atexit(close_movies);
746 }
747
748
749 void close_extra_robot_movie(void)
750 {
751         if (strlen(movielib_files[EXTRA_ROBOT_LIB]))
752                 if (!cfile_close(movielib_files[EXTRA_ROBOT_LIB]))
753                         con_printf(CON_URGENT, "Can't close robot movielib: %s\n", PHYSFS_getLastError());
754 }
755
756 void init_extra_robot_movie(char *movielib)
757 {
758         if (FindArg("-nomovies"))
759                 return;
760
761         close_extra_robot_movie();
762         init_movie(movielib, 1, 0);
763         strcpy(movielib_files[EXTRA_ROBOT_LIB], movielib);
764         atexit(close_extra_robot_movie);
765 }