1 /* $Id: movie.c,v 1.25 2003-03-21 23:13:25 btb Exp $ */
3 THE COMPUTER CODE CONTAINED HEREIN IS THE SOLE PROPERTY OF PARALLAX
4 SOFTWARE CORPORATION ("PARALLAX"). PARALLAX, IN DISTRIBUTING THE CODE TO
5 END-USERS, AND SUBJECT TO ALL OF THE TERMS AND CONDITIONS HEREIN, GRANTS A
6 ROYALTY-FREE, PERPETUAL LICENSE TO SUCH END-USERS FOR USE BY SUCH END-USERS
7 IN USING, DISPLAYING, AND CREATING DERIVATIVE WORKS THEREOF, SO LONG AS
8 SUCH USE, DISPLAY OR CREATION IS FOR NON-COMMERCIAL, ROYALTY OR REVENUE
9 FREE PURPOSES. IN NO EVENT SHALL THE END-USER USE THE COMPUTER CODE
10 CONTAINED HEREIN FOR REVENUE-BEARING PURPOSES. THE END-USER UNDERSTANDS
11 AND AGREES TO THE TERMS HEREIN AND ACCEPTS THE SAME BY USE OF THIS FILE.
12 COPYRIGHT 1993-1999 PARALLAX SOFTWARE CORPORATION. ALL RIGHTS RESERVED.
20 static char rcsid[] = "$Id: movie.c,v 1.25 2003-03-21 23:13:25 btb Exp $";
23 #define DEBUG_LEVEL CON_NORMAL
26 #include <sys/types.h>
53 extern int MenuHiresAvailable;
54 extern char CDROM_dir[];
64 short first_frame,last_frame;
68 #define MAX_SUBTITLES 500
69 #define MAX_ACTIVE_SUBTITLES 3
70 subtitle Subtitles[MAX_SUBTITLES];
76 char name[FILENAME_LEN];
81 #define MAX_MOVIES_PER_LIB 50 //determines size of malloc
84 char name[100]; //[FILENAME_LEN];
91 char movielib_files[][FILENAME_LEN] = {"intro-l.mvl","other-l.mvl","robots-l.mvl","oem-l.mvl"};
93 char movielib_files[][FILENAME_LEN] = {"intro-l.mvl","other-l.mvl","robots-l.mvl"};
96 #define N_BUILTIN_MOVIE_LIBS (sizeof(movielib_files)/sizeof(*movielib_files))
97 #define N_MOVIE_LIBS (N_BUILTIN_MOVIE_LIBS+1)
98 #define EXTRA_ROBOT_LIB N_BUILTIN_MOVIE_LIBS
99 movielib *movie_libs[N_MOVIE_LIBS];
102 //do we have the robot movies available
103 int robot_movies = 0; //0 means none, 1 means lowres, 2 means hires
105 int MovieHires = 1; //default is highres
107 int RoboFile = 0, RoboFilePos = 0;
109 // Function Prototypes
110 int RunMovie(char *filename, int highres_flag, int allow_abort,int dx,int dy);
112 int open_movie_file(char *filename,int must_have);
113 int reset_movie_file(int handle);
115 void change_filename_ext( char *dest, char *src, char *ext );
116 void decode_text_line(char *p);
117 void draw_subtitles(int frame_num);
120 //-----------------------------------------------------------------------
123 //filename will actually get modified to be either low-res or high-res
124 //returns status. see values in movie.h
125 int PlayMovie(const char *filename, int must_have)
127 char name[FILENAME_LEN],*p;
131 if (FindArg("-nomovies"))
132 return MOVIE_NOT_PLAYED;
135 strcpy(name,filename);
137 if ((p=strchr(name,'.')) == NULL) //add extension, if missing
140 //check for escape already pressed & abort if so
141 while ((c=key_inkey()) != 0)
143 return MOVIE_ABORTED;
145 // Stop all digital sounds currently playing.
154 if (!FindArg("-nosound"))
159 ret = RunMovie(name,MovieHires,must_have,-1,-1);
161 if (!FindArg("-nosound"))
164 Screen_mode = -1; //force screen reset
172 short x, y, w, h; // The location of the menu.
173 grs_bitmap * bmp; // The background under the menu.
176 bkg movie_bg = {0,0,0,0,NULL};
179 #define BOX_BORDER (MenuHires?40:20)
182 void show_pause_message(char *msg)
187 gr_set_current_canvas(NULL);
188 gr_set_curfont( SMALL_FONT );
190 gr_get_string_size(msg,&w,&h,&aw);
192 x = (grd_curscreen->sc_w-w)/2;
193 y = (grd_curscreen->sc_h-h)/2;
197 gr_free_bitmap(movie_bg.bmp);
201 // Save the background of the display
202 movie_bg.x=x; movie_bg.y=y; movie_bg.w=w; movie_bg.h=h;
204 movie_bg.bmp = gr_create_bitmap( w+BOX_BORDER, h+BOX_BORDER );
206 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 );
210 gr_rect(x-BOX_BORDER/2,y-BOX_BORDER/2,x+w+BOX_BORDER/2-1,y+h+BOX_BORDER/2-1);
212 gr_set_fontcolor( 255, -1 );
214 gr_ustring( 0x8000, y, msg );
219 void clear_pause_message()
224 gr_bitmap(movie_bg.x-BOX_BORDER/2, movie_bg.y-BOX_BORDER/2, movie_bg.bmp);
226 gr_free_bitmap(movie_bg.bmp);
233 //returns status. see movie.h
234 int RunMovie(char *filename, int hires_flag, int must_have,int dx,int dy)
237 int result=1,aborted=0;
247 // Open Movie file. If it doesn't exist, no movie, just return.
249 filehndl = open_movie_file(filename,must_have);
251 if (filehndl == -1) {
253 Warning("movie: RunMovie: Cannot open movie <%s>\n",filename);
254 return MOVIE_NOT_PLAYED;
258 gr_set_mode(SM(640,480));
260 gr_set_mode(SM(320,200));
263 set_screen_mode(SCREEN_MENU);
264 gr_copy_palette(pal_save, gr_palette, 768);
265 memset(gr_palette, 0, 768);
266 gr_palette_load(gr_palette);
269 if (MVE_rmPrepMovie(filehndl, dx, dy, track)) {
271 return MOVIE_NOT_PLAYED;
276 FontHires = FontHiresAvailable && hires_flag;
278 while((result = MVE_rmStepMovie()) == 0) {
280 draw_subtitles(frame_num);
286 // If ESCAPE pressed, then quit movie.
287 if (key == KEY_ESC) {
288 result = aborted = 1;
292 // If PAUSE pressed, then pause movie
293 if (key == KEY_PAUSE) {
295 show_pause_message(TXT_PAUSE);
296 while (!key_inkey()) ;
297 clear_pause_message();
300 #ifdef GR_SUPPORTS_FULLSCREEN_TOGGLE
301 if ((key == KEY_CTRLED+KEY_SHIFTED+KEY_PADENTER) ||
302 (key == KEY_ALTED+KEY_CTRLED+KEY_PADENTER) ||
303 (key == KEY_ALTED+KEY_SHIFTED+KEY_PADENTER))
304 gr_toggle_fullscreen();
310 Assert(aborted || result == MVE_ERR_EOF); ///movie should be over
314 close(filehndl); // Close Movie File
316 // Restore old graphic state
318 Screen_mode=-1; //force reset of screen mode
320 gr_copy_palette(gr_palette, pal_save, 768);
321 gr_palette_load(pal_save);
324 return (aborted?MOVIE_ABORTED:MOVIE_PLAYED_FULL);
328 int InitMovieBriefing()
332 gr_set_mode(SM(640,480));
334 gr_set_mode(SM(320,200));
336 gr_init_sub_canvas( &VR_screen_pages[0], &grd_curscreen->sc_canvas, 0, 0, grd_curscreen->sc_w, grd_curscreen->sc_h );
337 gr_init_sub_canvas( &VR_screen_pages[1], &grd_curscreen->sc_canvas, 0, 0, grd_curscreen->sc_w, grd_curscreen->sc_h );
344 //returns 1 if frame updated ok
349 err = MVE_rmStepMovie();
351 if (err == MVE_ERR_EOF) //end of movie, so reset
353 reset_movie_file(RoboFile);
354 if (MVE_rmPrepMovie(RoboFile, MenuHires?280:140, MenuHires?200:80, 0)) {
368 void DeInitRobotMovie(void)
371 close(RoboFile); // Close Movie File
375 int InitRobotMovie(char *filename)
377 if (FindArg("-nomovies"))
380 con_printf(DEBUG_LEVEL, "RoboFile=%s\n", filename);
382 MVE_sndInit(-1); //tell movies to play no sound for robots
384 RoboFile = open_movie_file(filename, 1);
386 if (RoboFile == -1) {
387 Warning("movie: InitRobotMovie: Cannot open movie file <%s>",filename);
388 return MOVIE_NOT_PLAYED;
391 Vid_State = VID_PLAY;
393 if (MVE_rmPrepMovie(RoboFile, MenuHires?280:140, MenuHires?200:80, 0)) {
398 RoboFilePos=lseek (RoboFile,0L,SEEK_CUR);
400 con_printf(DEBUG_LEVEL, "RoboFilePos=%d!\n", RoboFilePos);
407 * Subtitle system code
410 ubyte *subtitle_raw_data;
413 //search for next field following whitespace
414 ubyte *next_field(ubyte *p)
416 while (*p && !isspace(*p))
422 while (*p && isspace(*p))
432 int init_subtitles(char *filename)
441 if (! FindArg("-subtitles"))
444 ifile = cfopen(filename,"rb"); //try text version
446 if (!ifile) { //no text version, try binary version
447 char filename2[FILENAME_LEN];
448 change_filename_ext(filename2,filename,".TXB");
449 ifile = cfopen(filename2,"rb");
455 size = cfilelength(ifile);
457 MALLOC (subtitle_raw_data, ubyte, size+1);
459 read_count = cfread(subtitle_raw_data, 1, size, ifile);
463 subtitle_raw_data[size] = 0;
465 if (read_count != size) {
466 d_free(subtitle_raw_data);
470 p = subtitle_raw_data;
472 while (p && p < subtitle_raw_data+size) {
475 endp = strchr(p,'\n');
477 if (endp[-1] == '\r')
478 endp[-1] = 0; //handle 0d0a pair
479 *endp = 0; //string termintor
486 Subtitles[Num_subtitles].first_frame = atoi(p);
487 p = next_field(p); if (!p) continue;
488 Subtitles[Num_subtitles].last_frame = atoi(p);
489 p = next_field(p); if (!p) continue;
490 Subtitles[Num_subtitles].msg = p;
492 Assert(Num_subtitles==0 || Subtitles[Num_subtitles].first_frame >= Subtitles[Num_subtitles-1].first_frame);
493 Assert(Subtitles[Num_subtitles].last_frame >= Subtitles[Num_subtitles].first_frame);
506 void close_subtitles()
508 if (subtitle_raw_data)
509 d_free(subtitle_raw_data);
510 subtitle_raw_data = NULL;
515 //draw the subtitles for this frame
516 void draw_subtitles(int frame_num)
518 static int active_subtitles[MAX_ACTIVE_SUBTITLES];
519 static int num_active_subtitles,next_subtitle,line_spacing;
523 if (frame_num == 0) {
524 num_active_subtitles = 0;
526 gr_set_curfont( GAME_FONT );
527 line_spacing = grd_curcanv->cv_font->ft_h + (grd_curcanv->cv_font->ft_h >> 2);
528 gr_set_fontcolor(255,-1);
531 //get rid of any subtitles that have expired
532 for (t=0;t<num_active_subtitles;)
533 if (frame_num > Subtitles[active_subtitles[t]].last_frame) {
535 for (t2=t;t2<num_active_subtitles-1;t2++)
536 active_subtitles[t2] = active_subtitles[t2+1];
537 num_active_subtitles--;
543 //get any subtitles new for this frame
544 while (next_subtitle < Num_subtitles && frame_num >= Subtitles[next_subtitle].first_frame) {
545 if (num_active_subtitles >= MAX_ACTIVE_SUBTITLES)
546 Error("Too many active subtitles!");
547 active_subtitles[num_active_subtitles++] = next_subtitle;
551 //find y coordinate for first line of subtitles
552 y = grd_curcanv->cv_bitmap.bm_h-((line_spacing+1)*MAX_ACTIVE_SUBTITLES+2);
554 //erase old subtitles if necessary
557 gr_rect(0,y,grd_curcanv->cv_bitmap.bm_w-1,grd_curcanv->cv_bitmap.bm_h-1);
560 //now draw the current subtitles
561 for (t=0;t<num_active_subtitles;t++)
562 if (active_subtitles[t] != -1) {
563 gr_string(0x8000,y,Subtitles[active_subtitles[t]].msg);
569 movielib *init_new_movie_lib(char *filename,FILE *fp)
575 //read movie file header
577 nfiles = file_read_int(fp); //get number of files
579 //table = d_malloc(sizeof(*table) + sizeof(ml_entry)*nfiles);
580 MALLOC(table, movielib, 1);
581 MALLOC(table->movies, ml_entry, nfiles);
583 strcpy(table->name,filename);
584 table->n_movies = nfiles;
586 offset = 4+4+nfiles*(13+4); //id + nfiles + nfiles * (filename + size)
588 for (i=0;i<nfiles;i++) {
591 n = fread( table->movies[i].name, 13, 1, fp );
593 break; //end of file (probably)
595 len = file_read_int(fp);
597 table->movies[i].len = len;
598 table->movies[i].offset = offset;
600 offset += table->movies[i].len;
613 movielib *init_old_movie_lib(char *filename,FILE *fp)
617 movielib *table,*table2;
622 table = d_malloc(sizeof(*table) + sizeof(ml_entry)*MAX_MOVIES_PER_LIB);
627 i = fread( table->movies[nfiles].name, 13, 1, fp );
629 break; //end of file (probably)
631 i = fread( &len, 4, 1, fp );
633 Error("error reading movie library <%s>",filename);
635 table->movies[nfiles].len = INTEL_INT(len);
636 table->movies[nfiles].offset = ftell( fp );
638 fseek( fp, INTEL_INT(len), SEEK_CUR ); //skip data
643 //allocate correct-sized table
644 size = sizeof(*table) + sizeof(ml_entry)*nfiles;
645 table2 = d_malloc(size);
646 memcpy(table2,table,size);
650 strcpy(table->name,filename);
652 table->n_movies = nfiles;
663 //find the specified movie library, and read in list of movies in it
664 movielib *init_movie_lib(char *filename)
666 //note: this based on cfile_init_hogfile()
671 fp = fopen( filename, "rb" );
673 if ((fp == NULL) && (AltHogdir_initialized)) {
675 strcpy(temp, AltHogDir);
677 strcat(temp, filename);
678 fp = fopen(temp, "rb");
684 fread( id, 4, 1, fp );
685 if ( !strncmp( id, "DMVL", 4 ) )
686 return init_new_movie_lib(filename,fp);
687 else if ( !strncmp( id, "DHF", 3 ) ) {
688 fseek(fp,-1,SEEK_CUR); //old file had 3 char id
689 return init_old_movie_lib(filename,fp);
698 void close_movie(int i)
701 d_free(movie_libs[i]->movies);
702 d_free(movie_libs[i]);
711 for (i=0;i<N_MOVIE_LIBS;i++)
716 //ask user to put the D2 CD in.
717 //returns -1 if ESC pressed, 0 if OK chosen
718 //CD may not have been inserted
722 ubyte save_pal[256*3];
723 grs_canvas *save_canv,*tcanv;
724 int ret,was_faded=gr_palette_faded_out;
728 save_canv = grd_curcanv;
729 tcanv = gr_create_canvas(grd_curcanv->cv_w,grd_curcanv->cv_h);
731 gr_set_current_canvas(tcanv);
732 gr_ubitmap(0,0,&save_canv->cv_bitmap);
733 gr_set_current_canvas(save_canv);
735 gr_clear_canvas(BM_XRGB(0,0,0));
737 memcpy(save_pal,gr_palette,sizeof(save_pal));
739 memcpy(gr_palette,last_palette_for_color_fonts,sizeof(gr_palette));
743 ret = nm_messagebox( "CD ERROR", 1, "Ok", "Please insert your Descent II CD");
748 ret2 = nm_messagebox( "CD ERROR", 2, "Try Again", "Leave Game", "You must insert your\nDescent II CD to Continue");
750 if (ret2 == -1 || ret2 == 0)
754 force_rb_register = 1; //disc has changed; force register new CD
758 memcpy(gr_palette,save_pal,sizeof(save_pal));
760 gr_ubitmap(0,0,&tcanv->cv_bitmap);
763 gr_palette_load(gr_palette);
765 gr_free_canvas(tcanv);
769 con_printf(DEBUG_LEVEL, "STUB: movie: request_cd\n");
775 void init_movie(char *filename,int libnum,int is_robots,int required)
781 if (FindArg("-nomovies")) {
782 movie_libs[libnum] = NULL;
787 //for robots, load highres versions if highres menus set
789 high_res = MenuHiresAvailable;
791 high_res = MovieHires;
794 strchr(filename,'.')[-1] = 'h';
798 if ((movie_libs[libnum] = init_movie_lib(filename)) == NULL) {
801 strcpy(name2,CDROM_dir);
802 strcat(name2,filename);
803 movie_libs[libnum] = init_movie_lib(name2);
805 if (movie_libs[libnum] != NULL)
806 movie_libs[libnum]->flags |= MLF_ON_CD;
809 Warning("Cannot open movie file <%s>\n",filename);
812 if (!try) { // first try
813 if (strchr(filename, '.')[-1] == 'h') { // try again with lowres
814 strchr(filename, '.')[-1] = 'l';
816 Warning("Trying to open movie file <%s> instead\n", filename);
819 } else if (strchr(filename, '.')[-1] == 'l') { // try again with highres
820 strchr(filename, '.')[-1] = 'h';
822 Warning("Trying to open movie file <%s> instead\n", filename);
830 if (is_robots && movie_libs[libnum]!=NULL)
831 robot_movies = high_res?2:1;
835 //find and initialize the movie libraries
841 for (i=0;i<N_BUILTIN_MOVIE_LIBS;i++) {
843 if (!strnicmp(movielib_files[i],"robot",5))
848 init_movie(movielib_files[i],i,is_robots,1);
851 movie_libs[EXTRA_ROBOT_LIB] = NULL;
853 atexit(close_movies);
857 void init_extra_robot_movie(char *filename)
859 close_movie(EXTRA_ROBOT_LIB);
860 init_movie(filename,EXTRA_ROBOT_LIB,1,0);
864 int movie_handle,movie_start;
866 //looks through a movie library for a movie file
867 //returns filehandle, with fileposition at movie, or -1 if can't find
868 int search_movie_lib(movielib *lib,char *filename,int must_have)
876 for (i=0;i<lib->n_movies;i++)
877 if (!stricmp(filename,lib->movies[i].name)) { //found the movie in a library
880 from_cd = (lib->flags & MLF_ON_CD);
883 songs_stop_redbook(); //ready to read from CD
885 do { //keep trying until we get the file handle
888 movie_handle = filehandle = open(lib->name, O_RDONLY | O_BINARY);
890 movie_handle = filehandle = open(lib->name, O_RDONLY);
893 if ((filehandle == -1) && (AltHogdir_initialized)) {
895 strcpy(temp, AltHogDir);
897 strcat(temp, lib->name);
899 movie_handle = filehandle = open(temp, O_RDONLY | O_BINARY);
901 movie_handle = filehandle = open(temp, O_RDONLY);
905 if (must_have && from_cd && filehandle == -1) { //didn't get file!
907 if (request_cd() == -1) //ESC from requester
908 break; //bail from here. will get error later
911 } while (must_have && from_cd && filehandle == -1);
913 if (filehandle != -1)
914 lseek(filehandle,(movie_start=lib->movies[i].offset),SEEK_SET);
923 //returns file handle
924 int open_movie_file(char *filename,int must_have)
928 for (i=0;i<N_MOVIE_LIBS;i++) {
929 if ((filehandle = search_movie_lib(movie_libs[i],filename,must_have)) != -1)
933 return -1; //couldn't find it
936 //sets the file position to the start of this already-open file
937 int reset_movie_file(int handle)
939 Assert(handle == movie_handle);
941 lseek(handle,movie_start,SEEK_SET);
943 return 0; //everything is cool