1 /* $Id: movie.c,v 1.12 2002-09-01 02:49:06 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.12 2002-09-01 02:49:06 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];
75 char name[FILENAME_LEN];
80 #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];
101 int MVEPaletteCalls = 0;
103 //do we have the robot movies available
104 int robot_movies = 0; //0 means none, 1 means lowres, 2 means hires
106 int MovieHires = 0; //default for now is lores
111 grs_bitmap *Robo_bitmap;
114 // Function Prototypes
115 int RunMovie(char *filename, int highres_flag, int allow_abort,int dx,int dy);
117 int open_movie_file(char *filename,int must_have);
119 void change_filename_ext( char *dest, char *src, char *ext );
120 void decode_text_line(char *p);
121 void draw_subtitles(int frame_num);
124 //filename will actually get modified to be either low-res or high-res
125 //returns status. see values in movie.h
126 int PlayMovie(const char *filename, int must_have)
128 char name[FILENAME_LEN],*p;
131 int save_sample_rate;
135 if (FindArg("-nomovies"))
136 return MOVIE_NOT_PLAYED;
139 strcpy(name,filename);
141 if ((p=strchr(name,'.')) == NULL) //add extension, if missing
144 //check for escape already pressed & abort if so
145 while ((c=key_inkey()) != 0)
147 return MOVIE_ABORTED;
149 // Stop all digital sounds currently playing.
156 save_sample_rate = digi_sample_rate;
157 digi_sample_rate = SAMPLE_RATE_22K; //always 22K for movies
158 digi_reset(); digi_reset();
163 ret = RunMovie(name,MovieHires,must_have,-1,-1);
166 gr_palette_clear(); //clear out palette in case movie aborted
170 digi_sample_rate = save_sample_rate; //restore rate for game
171 digi_reset(); digi_reset();
176 Screen_mode = -1; //force screen reset
183 short x, y, w, h; // The location of the menu.
184 grs_bitmap * bmp; // The background under the menu.
187 bkg movie_bg = {0,0,0,0,NULL};
190 #define BOX_BORDER (MenuHires?40:20)
192 void show_pause_message(char *msg)
197 gr_set_current_canvas(NULL);
198 gr_set_curfont( SMALL_FONT );
200 gr_get_string_size(msg,&w,&h,&aw);
202 x = (grd_curscreen->sc_w-w)/2;
203 y = (grd_curscreen->sc_h-h)/2;
207 gr_free_bitmap(movie_bg.bmp);
211 // Save the background of the display
212 movie_bg.x=x; movie_bg.y=y; movie_bg.w=w; movie_bg.h=h;
214 movie_bg.bmp = gr_create_bitmap( w+BOX_BORDER, h+BOX_BORDER );
216 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 );
220 gr_rect(x-BOX_BORDER/2,y-BOX_BORDER/2,x+w+BOX_BORDER/2-1,y+h+BOX_BORDER/2-1);
222 gr_set_fontcolor( 255, -1 );
224 gr_ustring( 0x8000, y, msg );
229 void clear_pause_message()
234 gr_bitmap(movie_bg.x-BOX_BORDER/2, movie_bg.y-BOX_BORDER/2, movie_bg.bmp);
236 gr_free_bitmap(movie_bg.bmp);
242 //returns status. see movie.h
243 int RunMovie(char *filename, int hires_flag, int must_have,int dx,int dy)
246 int result=1,aborted=0;
249 grs_bitmap *mve_bitmap;
255 // Open Movie file. If it doesn't exist, no movie, just return.
257 filehndl = open_movie_file(filename,must_have);
259 if (filehndl == -1) {
262 Warning("movie: RunMovie: Cannot open movie <%s>\n",filename);
264 return MOVIE_NOT_PLAYED;
268 gr_set_mode(SM(640,480));
274 gr_set_mode(SM(320,200));
283 FontHires = FontHiresAvailable && hires_flag;
285 mve = mve_open(filehndl);
287 mve_bitmap = gr_create_bitmap(w, h); // w, h must match the mve exactly!
289 mveplay_initializeMovie(mve, mve_bitmap);
291 while((result = mveplay_stepMovie(mve))) {
293 gr_bitmap(x, y, mve_bitmap);
295 draw_subtitles(frame_num);
299 // If ESCAPE pressed, then quit movie.
300 if (key == KEY_ESC) {
306 // If PAUSE pressed, then pause movie
307 if (key == KEY_PAUSE) {
308 show_pause_message(TXT_PAUSE);
309 while (!key_inkey()) ;
310 mveplay_restartTimer(mve);
311 clear_pause_message();
317 Assert(aborted || !result); ///movie should be over
319 mveplay_shutdownMovie(mve);
321 gr_free_bitmap(mve_bitmap);
325 close(filehndl); // Close Movie File
327 // Restore old graphic state
329 Screen_mode=-1; //force reset of screen mode
331 return (aborted?MOVIE_ABORTED:MOVIE_PLAYED_FULL);
335 int InitMovieBriefing()
338 gr_set_mode(SM(640,480));
340 gr_set_mode(SM(320,200));
346 //returns 1 if frame updated ok
351 ret = mveplay_stepMovie(Robo_mve);
352 gr_bitmap(MenuHires?280:140, MenuHires?200:80, Robo_bitmap);
355 mveplay_shutdownMovie(Robo_mve);
357 lseek(RoboFile, Robo_filepos, SEEK_SET);
358 Robo_mve = mve_open(RoboFile);
359 mveplay_initializeMovie(Robo_mve, Robo_bitmap);
366 void DeInitRobotMovie(void)
368 mveplay_shutdownMovie(Robo_mve);
371 gr_free_bitmap(Robo_bitmap);
377 int InitRobotMovie(char *filename)
379 RoboFile = open_movie_file(filename, 1);
381 if (RoboFile == -1) {
382 Warning("movie: InitRobotMovie: Cannot open movie file <%s>",filename);
383 return MOVIE_NOT_PLAYED;
386 Robo_filepos = lseek(RoboFile, 0, SEEK_CUR);
388 Robo_mve = mve_open(RoboFile);
390 Robo_bitmap = gr_create_bitmap(MenuHires?320:160, MenuHires?200:88);
392 mveplay_initializeMovie(Robo_mve, Robo_bitmap);
399 * Subtitle system code
402 ubyte *subtitle_raw_data;
405 //search for next field following whitespace
406 ubyte *next_field(ubyte *p)
408 while (*p && !isspace(*p))
414 while (*p && isspace(*p))
424 int init_subtitles(char *filename)
433 if (! FindArg("-subtitles"))
436 ifile = cfopen(filename,"rb"); //try text version
438 if (!ifile) { //no text version, try binary version
439 char filename2[FILENAME_LEN];
440 change_filename_ext(filename2,filename,".TXB");
441 ifile = cfopen(filename2,"rb");
447 size = cfilelength(ifile);
449 MALLOC (subtitle_raw_data, ubyte, size+1);
451 read_count = cfread(subtitle_raw_data, 1, size, ifile);
455 subtitle_raw_data[size] = 0;
457 if (read_count != size) {
458 d_free(subtitle_raw_data);
462 p = subtitle_raw_data;
464 while (p && p < subtitle_raw_data+size) {
467 endp = strchr(p,'\n');
469 if (endp[-1] == '\r')
470 endp[-1] = 0; //handle 0d0a pair
471 *endp = 0; //string termintor
478 Subtitles[Num_subtitles].first_frame = atoi(p);
479 p = next_field(p); if (!p) continue;
480 Subtitles[Num_subtitles].last_frame = atoi(p);
481 p = next_field(p); if (!p) continue;
482 Subtitles[Num_subtitles].msg = p;
484 Assert(Num_subtitles==0 || Subtitles[Num_subtitles].first_frame >= Subtitles[Num_subtitles-1].first_frame);
485 Assert(Subtitles[Num_subtitles].last_frame >= Subtitles[Num_subtitles].first_frame);
498 void close_subtitles()
500 if (subtitle_raw_data)
501 d_free(subtitle_raw_data);
502 subtitle_raw_data = NULL;
507 //draw the subtitles for this frame
508 void draw_subtitles(int frame_num)
510 static int active_subtitles[MAX_ACTIVE_SUBTITLES];
511 static int num_active_subtitles,next_subtitle,line_spacing;
515 if (frame_num == 0) {
516 num_active_subtitles = 0;
518 gr_set_curfont( GAME_FONT );
519 line_spacing = grd_curcanv->cv_font->ft_h + (grd_curcanv->cv_font->ft_h >> 2);
520 gr_set_fontcolor(255,-1);
523 //get rid of any subtitles that have expired
524 for (t=0;t<num_active_subtitles;)
525 if (frame_num > Subtitles[active_subtitles[t]].last_frame) {
527 for (t2=t;t2<num_active_subtitles-1;t2++)
528 active_subtitles[t2] = active_subtitles[t2+1];
529 num_active_subtitles--;
535 //get any subtitles new for this frame
536 while (next_subtitle < Num_subtitles && frame_num >= Subtitles[next_subtitle].first_frame) {
537 if (num_active_subtitles >= MAX_ACTIVE_SUBTITLES)
538 Error("Too many active subtitles!");
539 active_subtitles[num_active_subtitles++] = next_subtitle;
543 //find y coordinate for first line of subtitles
544 y = grd_curcanv->cv_bitmap.bm_h-((line_spacing+1)*MAX_ACTIVE_SUBTITLES+2);
546 //erase old subtitles if necessary
549 gr_rect(0,y,grd_curcanv->cv_bitmap.bm_w-1,grd_curcanv->cv_bitmap.bm_h-1);
552 //now draw the current subtitles
553 for (t=0;t<num_active_subtitles;t++)
554 if (active_subtitles[t] != -1) {
555 gr_string(0x8000,y,Subtitles[active_subtitles[t]].msg);
565 con_printf(DEBUG_LEVEL, "STUB: movie: request_cd\n");
570 movielib *init_new_movie_lib(char *filename,FILE *fp)
576 //read movie file header
578 nfiles = file_read_int(fp); //get number of files
580 //table = d_malloc(sizeof(*table) + sizeof(ml_entry)*nfiles);
581 MALLOC(table, movielib, 1);
582 MALLOC(table->movies, ml_entry, nfiles);
584 strcpy(table->name,filename);
585 table->n_movies = nfiles;
587 offset = 4+4+nfiles*(13+4); //id + nfiles + nfiles * (filename + size)
589 for (i=0;i<nfiles;i++) {
592 n = fread( table->movies[i].name, 13, 1, fp );
594 break; //end of file (probably)
596 len = file_read_int(fp);
598 table->movies[i].len = len;
599 table->movies[i].offset = offset;
601 offset += table->movies[i].len;
614 movielib *init_old_movie_lib(char *filename,FILE *fp)
618 movielib *table,*table2;
623 table = d_malloc(sizeof(*table) + sizeof(ml_entry)*MAX_MOVIES_PER_LIB);
628 i = fread( table->movies[nfiles].name, 13, 1, fp );
630 break; //end of file (probably)
632 i = fread( &len, 4, 1, fp );
634 Error("error reading movie library <%s>",filename);
636 table->movies[nfiles].len = INTEL_INT(len);
637 table->movies[nfiles].offset = ftell( fp );
639 fseek( fp, INTEL_INT(len), SEEK_CUR ); //skip data
644 //allocate correct-sized table
645 size = sizeof(*table) + sizeof(ml_entry)*nfiles;
646 table2 = d_malloc(size);
647 memcpy(table2,table,size);
651 strcpy(table->name,filename);
653 table->n_movies = nfiles;
664 //find the specified movie library, and read in list of movies in it
665 movielib *init_movie_lib(char *filename)
667 //note: this based on cfile_init_hogfile()
672 fp = fopen( filename, "rb" );
674 if ((fp == NULL) && (AltHogdir_initialized)) {
676 strcpy(temp, AltHogDir);
678 strcat(temp, filename);
679 fp = fopen(temp, "rb");
685 fread( id, 4, 1, fp );
686 if ( !strncmp( id, "DMVL", 4 ) )
687 return init_new_movie_lib(filename,fp);
688 else if ( !strncmp( id, "DHF", 3 ) ) {
689 fseek(fp,-1,SEEK_CUR); //old file had 3 char id
690 return init_old_movie_lib(filename,fp);
699 void close_movie(int i)
702 d_free(movie_libs[i]->movies);
703 d_free(movie_libs[i]);
712 for (i=0;i<N_MOVIE_LIBS;i++)
717 void init_movie(char *filename,int libnum,int is_robots,int required)
723 if (FindArg("-nomovies")) {
724 movie_libs[libnum] = NULL;
729 //for robots, load highres versions if highres menus set
731 high_res = MenuHiresAvailable;
733 high_res = MovieHires;
736 strchr(filename,'.')[-1] = 'h';
740 if ((movie_libs[libnum] = init_movie_lib(filename)) == NULL) {
743 strcpy(name2,CDROM_dir);
744 strcat(name2,filename);
745 movie_libs[libnum] = init_movie_lib(name2);
747 if (movie_libs[libnum] != NULL)
748 movie_libs[libnum]->flags |= MLF_ON_CD;
751 Warning("Cannot open movie file <%s>\n",filename);
754 if (!try) { // first try
755 if (strchr(filename, '.')[-1] == 'h') { // try again with lowres
756 strchr(filename, '.')[-1] = 'l';
757 Warning("Trying to open movie file <%s> instead\n", filename);
760 } else if (strchr(filename, '.')[-1] == 'l') { // try again with highres
761 strchr(filename, '.')[-1] = 'h';
762 Warning("Trying to open movie file <%s> instead\n", filename);
770 if (is_robots && movie_libs[libnum]!=NULL)
771 robot_movies = high_res?2:1;
775 //find and initialize the movie libraries
781 for (i=0;i<N_BUILTIN_MOVIE_LIBS;i++) {
783 if (!strnicmp(movielib_files[i],"robot",5))
788 init_movie(movielib_files[i],i,is_robots,1);
791 movie_libs[EXTRA_ROBOT_LIB] = NULL;
793 atexit(close_movies);
797 void init_extra_robot_movie(char *filename)
799 close_movie(EXTRA_ROBOT_LIB);
800 init_movie(filename,EXTRA_ROBOT_LIB,1,0);
804 //looks through a movie library for a movie file
805 //returns filehandle, with fileposition at movie, or -1 if can't find
806 int search_movie_lib(movielib *lib,char *filename,int must_have)
814 for (i=0;i<lib->n_movies;i++)
815 if (!stricmp(filename,lib->movies[i].name)) { //found the movie in a library
818 from_cd = (lib->flags & MLF_ON_CD);
821 songs_stop_redbook(); //ready to read from CD
823 do { //keep trying until we get the file handle
825 /* movie_handle = */ filehandle = open(lib->name, O_RDONLY);
827 if ((filehandle == -1) && (AltHogdir_initialized)) {
829 strcpy(temp, AltHogDir);
831 strcat(temp, lib->name);
832 filehandle = open(temp, O_RDONLY);
835 if (must_have && from_cd && filehandle == -1) { //didn't get file!
837 if (request_cd() == -1) //ESC from requester
838 break; //bail from here. will get error later
841 } while (must_have && from_cd && filehandle == -1);
843 if (filehandle != -1)
844 lseek(filehandle,(/* movie_start = */ lib->movies[i].offset),SEEK_SET);
853 //returns file handle
854 int open_movie_file(char *filename,int must_have)
858 for (i=0;i<N_MOVIE_LIBS;i++) {
859 if ((filehandle = search_movie_lib(movie_libs[i],filename,must_have)) != -1)
863 return -1; //couldn't find it