1 /* $Id: movie.c,v 1.36 2004-08-06 20:36:02 schaffner 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.
26 static char rcsid[] = "$Id: movie.c,v 1.36 2004-08-06 20:36:02 schaffner Exp $";
29 #define DEBUG_LEVEL CON_NORMAL
34 # include <sys/types.h>
35 # include <sys/stat.h>
64 extern int MenuHiresAvailable;
65 extern char CDROM_dir[];
75 short first_frame,last_frame;
79 #define MAX_SUBTITLES 500
80 #define MAX_ACTIVE_SUBTITLES 3
81 subtitle Subtitles[MAX_SUBTITLES];
86 char name[FILENAME_LEN];
91 #define MAX_MOVIES_PER_LIB 50 //determines size of malloc
94 char name[100]; //[FILENAME_LEN];
101 char movielib_files[][FILENAME_LEN] = {"intro-l.mvl","other-l.mvl","robots-l.mvl","oem-l.mvl"};
103 char movielib_files[][FILENAME_LEN] = {"intro-l.mvl","other-l.mvl","robots-l.mvl"};
106 #define N_BUILTIN_MOVIE_LIBS (sizeof(movielib_files)/sizeof(*movielib_files))
107 #define N_MOVIE_LIBS (N_BUILTIN_MOVIE_LIBS+1)
108 #define EXTRA_ROBOT_LIB N_BUILTIN_MOVIE_LIBS
109 movielib *movie_libs[N_MOVIE_LIBS];
112 //do we have the robot movies available
113 int robot_movies = 0; //0 means none, 1 means lowres, 2 means hires
115 int MovieHires = 1; //default is highres
117 CFILE *RoboFile = NULL;
120 // Function Prototypes
121 int RunMovie(char *filename, int highres_flag, int allow_abort,int dx,int dy);
123 CFILE *open_movie_file(char *filename, int must_have);
124 int reset_movie_file(CFILE *handle);
126 void change_filename_ext( char *dest, char *src, char *ext );
127 void decode_text_line(char *p);
128 void draw_subtitles(int frame_num);
131 // ----------------------------------------------------------------------
132 void* MPlayAlloc(unsigned size)
134 return d_malloc(size);
137 void MPlayFree(void *p)
143 //-----------------------------------------------------------------------
145 unsigned int FileRead(void *handle, void *buf, unsigned int count)
148 numread = cfread(buf, 1, count, (CFILE *)handle);
149 return (numread == count);
153 //-----------------------------------------------------------------------
156 //filename will actually get modified to be either low-res or high-res
157 //returns status. see values in movie.h
158 int PlayMovie(const char *filename, int must_have)
160 char name[FILENAME_LEN],*p;
164 if (FindArg("-nomovies"))
165 return MOVIE_NOT_PLAYED;
168 strcpy(name,filename);
170 if ((p=strchr(name,'.')) == NULL) //add extension, if missing
173 //check for escape already pressed & abort if so
174 while ((c=key_inkey()) != 0)
176 return MOVIE_ABORTED;
178 // Stop all digital sounds currently playing.
187 if (!FindArg("-nosound"))
192 ret = RunMovie(name,MovieHires,must_have,-1,-1);
194 if (!FindArg("-nosound"))
197 Screen_mode = -1; //force screen reset
203 void MovieShowFrame(ubyte *buf, uint bufw, uint bufh, uint sx, uint sy,
204 uint w, uint h, uint dstx, uint dsty)
206 grs_bitmap source_bm;
208 //mprintf((0,"MovieShowFrame %d,%d %d,%d %d,%d %d,%d\n",bufw,bufh,sx,sy,w,h,dstx,dsty));
210 Assert(bufw == w && bufh == h);
212 source_bm.bm_x = source_bm.bm_y = 0;
213 source_bm.bm_w = source_bm.bm_rowsize = bufw;
214 source_bm.bm_h = bufh;
215 source_bm.bm_type = BM_LINEAR;
216 source_bm.bm_flags = 0;
217 source_bm.bm_data = buf;
219 gr_bm_ubitblt(bufw,bufh,dstx,dsty,sx,sy,&source_bm,&grd_curcanv->cv_bitmap);
222 //our routine to set the pallete, called from the movie code
223 void MovieSetPalette(unsigned char *p, unsigned start, unsigned count)
228 //mprintf((0,"SetPalette p=%x, start=%d, count=%d\n",p,start,count));
230 //Color 0 should be black, and we get color 255
231 Assert(start>=1 && start+count-1<=254);
233 //Set color 0 to be black
234 gr_palette[0] = gr_palette[1] = gr_palette[2] = 0;
236 //Set color 255 to be our subtitle color
237 gr_palette[765] = gr_palette[766] = gr_palette[767] = 50;
239 //movie libs palette into our array
240 memcpy(gr_palette+start*3,p+start*3,count*3);
242 //finally set the palette in the hardware
243 //gr_palette_load(gr_palette);
245 //MVE_SetPalette(p, start, count);
251 short x, y, w, h; // The location of the menu.
252 grs_bitmap * bmp; // The background under the menu.
255 bkg movie_bg = {0,0,0,0,NULL};
258 #define BOX_BORDER (MenuHires?40:20)
261 void show_pause_message(char *msg)
266 gr_set_current_canvas(NULL);
267 gr_set_curfont( SMALL_FONT );
269 gr_get_string_size(msg,&w,&h,&aw);
271 x = (grd_curscreen->sc_w-w)/2;
272 y = (grd_curscreen->sc_h-h)/2;
276 gr_free_bitmap(movie_bg.bmp);
280 // Save the background of the display
281 movie_bg.x=x; movie_bg.y=y; movie_bg.w=w; movie_bg.h=h;
283 movie_bg.bmp = gr_create_bitmap( w+BOX_BORDER, h+BOX_BORDER );
285 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 );
289 gr_rect(x-BOX_BORDER/2,y-BOX_BORDER/2,x+w+BOX_BORDER/2-1,y+h+BOX_BORDER/2-1);
291 gr_set_fontcolor( 255, -1 );
293 gr_ustring( 0x8000, y, msg );
298 void clear_pause_message()
303 gr_bitmap(movie_bg.x-BOX_BORDER/2, movie_bg.y-BOX_BORDER/2, movie_bg.bmp);
305 gr_free_bitmap(movie_bg.bmp);
312 //returns status. see movie.h
313 int RunMovie(char *filename, int hires_flag, int must_have,int dx,int dy)
316 int result=1,aborted=0;
326 // Open Movie file. If it doesn't exist, no movie, just return.
328 filehndl = open_movie_file(filename,must_have);
330 if (filehndl == NULL)
333 con_printf(CON_NORMAL, "movie: RunMovie: Cannot open movie <%s>\n",filename);
334 return MOVIE_NOT_PLAYED;
337 MVE_memCallbacks(MPlayAlloc, MPlayFree);
338 MVE_ioCallbacks(FileRead);
341 gr_set_mode(SM(640,480));
343 gr_set_mode(SM(320,200));
346 set_screen_mode(SCREEN_MENU);
347 gr_copy_palette(pal_save, gr_palette, 768);
348 memset(gr_palette, 0, 768);
349 gr_palette_load(gr_palette);
352 #if !defined(POLY_ACC)
353 MVE_sfCallbacks(MovieShowFrame);
354 MVE_palCallbacks(MovieSetPalette);
357 if (MVE_rmPrepMovie((void *)filehndl, dx, dy, track)) {
359 return MOVIE_NOT_PLAYED;
364 FontHires = FontHiresAvailable && hires_flag;
366 while((result = MVE_rmStepMovie()) == 0) {
368 draw_subtitles(frame_num);
370 gr_palette_load(gr_palette); // moved this here because of flashing
376 // If ESCAPE pressed, then quit movie.
377 if (key == KEY_ESC) {
378 result = aborted = 1;
382 // If PAUSE pressed, then pause movie
383 if (key == KEY_PAUSE) {
385 show_pause_message(TXT_PAUSE);
386 while (!key_inkey()) ;
387 clear_pause_message();
390 #ifdef GR_SUPPORTS_FULLSCREEN_TOGGLE
391 if ((key == KEY_ALTED+KEY_ENTER) ||
392 (key == KEY_ALTED+KEY_PADENTER))
393 gr_toggle_fullscreen();
399 Assert(aborted || result == MVE_ERR_EOF); ///movie should be over
403 cfclose(filehndl); // Close Movie File
405 // Restore old graphic state
407 Screen_mode=-1; //force reset of screen mode
409 gr_copy_palette(gr_palette, pal_save, 768);
410 gr_palette_load(pal_save);
413 return (aborted?MOVIE_ABORTED:MOVIE_PLAYED_FULL);
417 int InitMovieBriefing()
421 gr_set_mode(SM(640,480));
423 gr_set_mode(SM(320,200));
425 gr_init_sub_canvas( &VR_screen_pages[0], &grd_curscreen->sc_canvas, 0, 0, grd_curscreen->sc_w, grd_curscreen->sc_h );
426 gr_init_sub_canvas( &VR_screen_pages[1], &grd_curscreen->sc_canvas, 0, 0, grd_curscreen->sc_w, grd_curscreen->sc_h );
433 //returns 1 if frame updated ok
438 err = MVE_rmStepMovie();
440 gr_palette_load(gr_palette);
442 if (err == MVE_ERR_EOF) //end of movie, so reset
444 reset_movie_file(RoboFile);
445 if (MVE_rmPrepMovie((void *)RoboFile, MenuHires?280:140, MenuHires?200:80, 0)) {
459 void DeInitRobotMovie(void)
462 cfclose(RoboFile); // Close Movie File
466 int InitRobotMovie(char *filename)
468 if (FindArg("-nomovies"))
471 con_printf(DEBUG_LEVEL, "RoboFile=%s\n", filename);
473 MVE_sndInit(-1); //tell movies to play no sound for robots
475 RoboFile = open_movie_file(filename, 1);
477 if (RoboFile == NULL)
479 Warning("movie: InitRobotMovie: Cannot open movie file <%s>",filename);
480 return MOVIE_NOT_PLAYED;
483 Vid_State = VID_PLAY;
485 if (MVE_rmPrepMovie((void *)RoboFile, MenuHires?280:140, MenuHires?200:80, 0)) {
490 RoboFilePos = cfseek(RoboFile, 0L, SEEK_CUR);
492 con_printf(DEBUG_LEVEL, "RoboFilePos=%d!\n", RoboFilePos);
499 * Subtitle system code
502 char *subtitle_raw_data;
505 //search for next field following whitespace
506 char *next_field (char *p)
508 while (*p && !isspace(*p))
514 while (*p && isspace(*p))
524 int init_subtitles(char *filename)
533 if (! FindArg("-subtitles"))
536 ifile = cfopen(filename,"rb"); //try text version
538 if (!ifile) { //no text version, try binary version
539 char filename2[FILENAME_LEN];
540 change_filename_ext(filename2,filename,".TXB");
541 ifile = cfopen(filename2,"rb");
547 size = cfilelength(ifile);
549 MALLOC (subtitle_raw_data, char, size+1);
551 read_count = cfread(subtitle_raw_data, 1, size, ifile);
555 subtitle_raw_data[size] = 0;
557 if (read_count != size) {
558 d_free(subtitle_raw_data);
562 p = subtitle_raw_data;
564 while (p && p < subtitle_raw_data+size) {
567 endp = strchr(p,'\n');
569 if (endp[-1] == '\r')
570 endp[-1] = 0; //handle 0d0a pair
571 *endp = 0; //string termintor
578 Subtitles[Num_subtitles].first_frame = atoi(p);
579 p = next_field(p); if (!p) continue;
580 Subtitles[Num_subtitles].last_frame = atoi(p);
581 p = next_field(p); if (!p) continue;
582 Subtitles[Num_subtitles].msg = p;
584 Assert(Num_subtitles==0 || Subtitles[Num_subtitles].first_frame >= Subtitles[Num_subtitles-1].first_frame);
585 Assert(Subtitles[Num_subtitles].last_frame >= Subtitles[Num_subtitles].first_frame);
598 void close_subtitles()
600 if (subtitle_raw_data)
601 d_free(subtitle_raw_data);
602 subtitle_raw_data = NULL;
607 //draw the subtitles for this frame
608 void draw_subtitles(int frame_num)
610 static int active_subtitles[MAX_ACTIVE_SUBTITLES];
611 static int num_active_subtitles,next_subtitle,line_spacing;
615 if (frame_num == 0) {
616 num_active_subtitles = 0;
618 gr_set_curfont( GAME_FONT );
619 line_spacing = grd_curcanv->cv_font->ft_h + (grd_curcanv->cv_font->ft_h >> 2);
620 gr_set_fontcolor(255,-1);
623 //get rid of any subtitles that have expired
624 for (t=0;t<num_active_subtitles;)
625 if (frame_num > Subtitles[active_subtitles[t]].last_frame) {
627 for (t2=t;t2<num_active_subtitles-1;t2++)
628 active_subtitles[t2] = active_subtitles[t2+1];
629 num_active_subtitles--;
635 //get any subtitles new for this frame
636 while (next_subtitle < Num_subtitles && frame_num >= Subtitles[next_subtitle].first_frame) {
637 if (num_active_subtitles >= MAX_ACTIVE_SUBTITLES)
638 Error("Too many active subtitles!");
639 active_subtitles[num_active_subtitles++] = next_subtitle;
643 //find y coordinate for first line of subtitles
644 y = grd_curcanv->cv_bitmap.bm_h-((line_spacing+1)*MAX_ACTIVE_SUBTITLES+2);
646 //erase old subtitles if necessary
649 gr_rect(0,y,grd_curcanv->cv_bitmap.bm_w-1,grd_curcanv->cv_bitmap.bm_h-1);
652 //now draw the current subtitles
653 for (t=0;t<num_active_subtitles;t++)
654 if (active_subtitles[t] != -1) {
655 gr_string(0x8000,y,Subtitles[active_subtitles[t]].msg);
661 movielib *init_new_movie_lib(char *filename, CFILE *fp)
667 //read movie file header
669 nfiles = cfile_read_int(fp); //get number of files
671 //table = d_malloc(sizeof(*table) + sizeof(ml_entry)*nfiles);
672 MALLOC(table, movielib, 1);
673 MALLOC(table->movies, ml_entry, nfiles);
675 strcpy(table->name,filename);
676 table->n_movies = nfiles;
678 offset = 4+4+nfiles*(13+4); //id + nfiles + nfiles * (filename + size)
680 for (i=0;i<nfiles;i++) {
683 n = cfread(table->movies[i].name, 13, 1, fp);
685 break; //end of file (probably)
687 len = cfile_read_int(fp);
689 table->movies[i].len = len;
690 table->movies[i].offset = offset;
692 offset += table->movies[i].len;
705 movielib *init_old_movie_lib(char *filename, CFILE *fp)
709 movielib *table,*table2;
714 table = d_malloc(sizeof(*table) + sizeof(ml_entry)*MAX_MOVIES_PER_LIB);
719 i = cfread(table->movies[nfiles].name, 13, 1, fp);
721 break; //end of file (probably)
723 i = cfread(&len, 4, 1, fp);
725 Error("error reading movie library <%s>",filename);
727 table->movies[nfiles].len = INTEL_INT(len);
728 table->movies[nfiles].offset = cftell(fp);
730 cfseek(fp, INTEL_INT(len), SEEK_CUR); //skip data
735 //allocate correct-sized table
736 size = sizeof(*table) + sizeof(ml_entry)*nfiles;
737 table2 = d_malloc(size);
738 memcpy(table2,table,size);
742 strcpy(table->name,filename);
744 table->n_movies = nfiles;
755 //find the specified movie library, and read in list of movies in it
756 movielib *init_movie_lib(char *filename)
758 //note: this based on cfile_init_hogfile()
763 fp = cfopen(filename, "rb");
768 cfread(id, 4, 1, fp);
769 if ( !strncmp( id, "DMVL", 4 ) )
770 return init_new_movie_lib(filename,fp);
771 else if ( !strncmp( id, "DHF", 3 ) ) {
772 cfseek(fp,-1,SEEK_CUR); //old file had 3 char id
773 return init_old_movie_lib(filename,fp);
782 void close_movie(int i)
785 d_free(movie_libs[i]->movies);
786 d_free(movie_libs[i]);
795 for (i=0;i<N_MOVIE_LIBS;i++)
800 //ask user to put the D2 CD in.
801 //returns -1 if ESC pressed, 0 if OK chosen
802 //CD may not have been inserted
806 ubyte save_pal[256*3];
807 grs_canvas *save_canv,*tcanv;
808 int ret,was_faded=gr_palette_faded_out;
812 save_canv = grd_curcanv;
813 tcanv = gr_create_canvas(grd_curcanv->cv_w,grd_curcanv->cv_h);
815 gr_set_current_canvas(tcanv);
816 gr_ubitmap(0,0,&save_canv->cv_bitmap);
817 gr_set_current_canvas(save_canv);
819 gr_clear_canvas(BM_XRGB(0,0,0));
821 memcpy(save_pal,gr_palette,sizeof(save_pal));
823 memcpy(gr_palette,last_palette_for_color_fonts,sizeof(gr_palette));
827 ret = nm_messagebox( "CD ERROR", 1, "Ok", "Please insert your Descent II CD");
832 ret2 = nm_messagebox( "CD ERROR", 2, "Try Again", "Leave Game", "You must insert your\nDescent II CD to Continue");
834 if (ret2 == -1 || ret2 == 0)
838 force_rb_register = 1; //disc has changed; force register new CD
842 memcpy(gr_palette,save_pal,sizeof(save_pal));
844 gr_ubitmap(0,0,&tcanv->cv_bitmap);
847 gr_palette_load(gr_palette);
849 gr_free_canvas(tcanv);
853 con_printf(DEBUG_LEVEL, "STUB: movie: request_cd\n");
859 void init_movie(char *filename, int libnum, int is_robots, int required)
862 char *res = strchr(filename, '.') - 1; // 'h' == high resolution, 'l' == low
865 if (FindArg("-nomovies")) {
866 movie_libs[libnum] = NULL;
871 //for robots, load highres versions if highres menus set
873 high_res = MenuHiresAvailable;
875 high_res = MovieHires;
880 for (try = 0; (movie_libs[libnum] = init_movie_lib(filename)) == NULL; try++) {
883 strcpy(name2,CDROM_dir);
884 strcat(name2,filename);
885 movie_libs[libnum] = init_movie_lib(name2);
887 if (movie_libs[libnum] != NULL) {
888 movie_libs[libnum]->flags |= MLF_ON_CD;
889 break; // we found our movie on the CD
891 if (try == 0) { // first try
892 if (*res == 'h') { // try low res instead
895 } else if (*res == 'l') { // try high
900 Warning("Cannot open movie file <%s>",filename);
906 Warning("Cannot open any movie file <%s>", filename);
913 if (is_robots && movie_libs[libnum]!=NULL)
914 robot_movies = high_res?2:1;
918 //find and initialize the movie libraries
924 for (i=0;i<N_BUILTIN_MOVIE_LIBS;i++) {
926 if (!strnicmp(movielib_files[i],"robot",5))
931 init_movie(movielib_files[i],i,is_robots,1);
934 movie_libs[EXTRA_ROBOT_LIB] = NULL;
936 atexit(close_movies);
940 void init_extra_robot_movie(char *filename)
942 close_movie(EXTRA_ROBOT_LIB);
943 init_movie(filename,EXTRA_ROBOT_LIB,1,0);
950 //looks through a movie library for a movie file
951 //returns filehandle, with fileposition at movie, or -1 if can't find
952 CFILE *search_movie_lib(movielib *lib, char *filename, int must_have)
960 for (i=0;i<lib->n_movies;i++)
961 if (!stricmp(filename,lib->movies[i].name)) { //found the movie in a library
964 from_cd = (lib->flags & MLF_ON_CD);
967 songs_stop_redbook(); //ready to read from CD
969 do { //keep trying until we get the file handle
971 movie_handle = filehandle = cfopen(lib->name, "rb");
973 if (must_have && from_cd && filehandle == NULL)
976 if (request_cd() == -1) //ESC from requester
977 break; //bail from here. will get error later
980 } while (must_have && from_cd && filehandle == NULL);
983 cfseek(filehandle, (movie_start = lib->movies[i].offset), SEEK_SET);
992 //returns file handle
993 CFILE *open_movie_file(char *filename, int must_have)
998 for (i=0;i<N_MOVIE_LIBS;i++) {
999 if ((filehandle = search_movie_lib(movie_libs[i], filename, must_have)) != NULL)
1003 return NULL; //couldn't find it
1006 //sets the file position to the start of this already-open file
1007 int reset_movie_file(CFILE *handle)
1009 Assert(handle == movie_handle);
1011 cfseek(handle, movie_start, SEEK_SET);
1013 return 0; //everything is cool