1 /* $Id: movie.c,v 1.27 2003-06-16 06:57:34 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.27 2003-06-16 06:57:34 btb Exp $";
23 #define DEBUG_LEVEL CON_NORMAL
26 #include <sys/types.h>
52 extern int MenuHiresAvailable;
53 extern char CDROM_dir[];
63 short first_frame,last_frame;
67 #define MAX_SUBTITLES 500
68 #define MAX_ACTIVE_SUBTITLES 3
69 subtitle Subtitles[MAX_SUBTITLES];
74 char name[FILENAME_LEN];
79 #define MAX_MOVIES_PER_LIB 50 //determines size of malloc
82 char name[100]; //[FILENAME_LEN];
89 char movielib_files[][FILENAME_LEN] = {"intro-l.mvl","other-l.mvl","robots-l.mvl","oem-l.mvl"};
91 char movielib_files[][FILENAME_LEN] = {"intro-l.mvl","other-l.mvl","robots-l.mvl"};
94 #define N_BUILTIN_MOVIE_LIBS (sizeof(movielib_files)/sizeof(*movielib_files))
95 #define N_MOVIE_LIBS (N_BUILTIN_MOVIE_LIBS+1)
96 #define EXTRA_ROBOT_LIB N_BUILTIN_MOVIE_LIBS
97 movielib *movie_libs[N_MOVIE_LIBS];
100 //do we have the robot movies available
101 int robot_movies = 0; //0 means none, 1 means lowres, 2 means hires
103 int MovieHires = 1; //default is highres
105 int RoboFile = 0, RoboFilePos = 0;
107 // Function Prototypes
108 int RunMovie(char *filename, int highres_flag, int allow_abort,int dx,int dy);
110 int open_movie_file(char *filename,int must_have);
111 int reset_movie_file(int handle);
113 void change_filename_ext( char *dest, char *src, char *ext );
114 void decode_text_line(char *p);
115 void draw_subtitles(int frame_num);
118 // ----------------------------------------------------------------------
119 void* MPlayAlloc(unsigned size)
121 return d_malloc(size);
124 void MPlayFree(void *p)
130 //-----------------------------------------------------------------------
132 unsigned int FileRead(void *handle, void *buf, unsigned int count)
135 numread = read((int)handle, buf, count);
136 return (numread == count);
140 //-----------------------------------------------------------------------
143 //filename will actually get modified to be either low-res or high-res
144 //returns status. see values in movie.h
145 int PlayMovie(const char *filename, int must_have)
147 char name[FILENAME_LEN],*p;
151 if (FindArg("-nomovies"))
152 return MOVIE_NOT_PLAYED;
155 strcpy(name,filename);
157 if ((p=strchr(name,'.')) == NULL) //add extension, if missing
160 //check for escape already pressed & abort if so
161 while ((c=key_inkey()) != 0)
163 return MOVIE_ABORTED;
165 // Stop all digital sounds currently playing.
174 if (!FindArg("-nosound"))
179 ret = RunMovie(name,MovieHires,must_have,-1,-1);
181 if (!FindArg("-nosound"))
184 Screen_mode = -1; //force screen reset
190 void MovieShowFrame(ubyte *buf, uint bufw, uint bufh, uint sx, uint sy,
191 uint w, uint h, uint dstx, uint dsty)
193 grs_bitmap source_bm;
195 //mprintf((0,"MovieShowFrame %d,%d %d,%d %d,%d %d,%d\n",bufw,bufh,sx,sy,w,h,dstx,dsty));
197 Assert(bufw == w && bufh == h);
199 source_bm.bm_x = source_bm.bm_y = 0;
200 source_bm.bm_w = source_bm.bm_rowsize = bufw;
201 source_bm.bm_h = bufh;
202 source_bm.bm_type = BM_LINEAR;
203 source_bm.bm_flags = 0;
204 source_bm.bm_data = buf;
206 gr_bm_ubitblt(bufw,bufh,dstx,dsty,sx,sy,&source_bm,&grd_curcanv->cv_bitmap);
209 //our routine to set the pallete, called from the movie code
210 void MovieSetPalette(unsigned char *p, unsigned start, unsigned count)
215 //mprintf((0,"SetPalette p=%x, start=%d, count=%d\n",p,start,count));
217 //Color 0 should be black, and we get color 255
218 Assert(start>=1 && start+count-1<=254);
220 //Set color 0 to be black
221 gr_palette[0] = gr_palette[1] = gr_palette[2] = 0;
223 //Set color 255 to be our subtitle color
224 gr_palette[765] = gr_palette[766] = gr_palette[767] = 50;
226 //movie libs palette into our array
227 memcpy(gr_palette+start*3,p+start*3,count*3);
229 //finally set the palette in the hardware
230 //gr_palette_load(gr_palette);
232 //MVE_SetPalette(p, start, count);
238 short x, y, w, h; // The location of the menu.
239 grs_bitmap * bmp; // The background under the menu.
242 bkg movie_bg = {0,0,0,0,NULL};
245 #define BOX_BORDER (MenuHires?40:20)
248 void show_pause_message(char *msg)
253 gr_set_current_canvas(NULL);
254 gr_set_curfont( SMALL_FONT );
256 gr_get_string_size(msg,&w,&h,&aw);
258 x = (grd_curscreen->sc_w-w)/2;
259 y = (grd_curscreen->sc_h-h)/2;
263 gr_free_bitmap(movie_bg.bmp);
267 // Save the background of the display
268 movie_bg.x=x; movie_bg.y=y; movie_bg.w=w; movie_bg.h=h;
270 movie_bg.bmp = gr_create_bitmap( w+BOX_BORDER, h+BOX_BORDER );
272 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 );
276 gr_rect(x-BOX_BORDER/2,y-BOX_BORDER/2,x+w+BOX_BORDER/2-1,y+h+BOX_BORDER/2-1);
278 gr_set_fontcolor( 255, -1 );
280 gr_ustring( 0x8000, y, msg );
285 void clear_pause_message()
290 gr_bitmap(movie_bg.x-BOX_BORDER/2, movie_bg.y-BOX_BORDER/2, movie_bg.bmp);
292 gr_free_bitmap(movie_bg.bmp);
299 //returns status. see movie.h
300 int RunMovie(char *filename, int hires_flag, int must_have,int dx,int dy)
303 int result=1,aborted=0;
313 // Open Movie file. If it doesn't exist, no movie, just return.
315 filehndl = open_movie_file(filename,must_have);
317 if (filehndl == -1) {
319 Warning("movie: RunMovie: Cannot open movie <%s>\n",filename);
320 return MOVIE_NOT_PLAYED;
323 MVE_memCallbacks(MPlayAlloc, MPlayFree);
324 MVE_ioCallbacks(FileRead);
327 gr_set_mode(SM(640,480));
329 gr_set_mode(SM(320,200));
332 set_screen_mode(SCREEN_MENU);
333 gr_copy_palette(pal_save, gr_palette, 768);
334 memset(gr_palette, 0, 768);
335 gr_palette_load(gr_palette);
338 #if !defined(POLY_ACC)
339 MVE_sfCallbacks(MovieShowFrame);
340 MVE_palCallbacks(MovieSetPalette);
343 if (MVE_rmPrepMovie((void *)filehndl, dx, dy, track)) {
345 return MOVIE_NOT_PLAYED;
350 FontHires = FontHiresAvailable && hires_flag;
352 while((result = MVE_rmStepMovie()) == 0) {
354 draw_subtitles(frame_num);
356 gr_palette_load(gr_palette); // moved this here because of flashing
362 // If ESCAPE pressed, then quit movie.
363 if (key == KEY_ESC) {
364 result = aborted = 1;
368 // If PAUSE pressed, then pause movie
369 if (key == KEY_PAUSE) {
371 show_pause_message(TXT_PAUSE);
372 while (!key_inkey()) ;
373 clear_pause_message();
376 #ifdef GR_SUPPORTS_FULLSCREEN_TOGGLE
377 if ((key == KEY_CTRLED+KEY_SHIFTED+KEY_PADENTER) ||
378 (key == KEY_ALTED+KEY_CTRLED+KEY_PADENTER) ||
379 (key == KEY_ALTED+KEY_SHIFTED+KEY_PADENTER))
380 gr_toggle_fullscreen();
386 Assert(aborted || result == MVE_ERR_EOF); ///movie should be over
390 close(filehndl); // Close Movie File
392 // Restore old graphic state
394 Screen_mode=-1; //force reset of screen mode
396 gr_copy_palette(gr_palette, pal_save, 768);
397 gr_palette_load(pal_save);
400 return (aborted?MOVIE_ABORTED:MOVIE_PLAYED_FULL);
404 int InitMovieBriefing()
408 gr_set_mode(SM(640,480));
410 gr_set_mode(SM(320,200));
412 gr_init_sub_canvas( &VR_screen_pages[0], &grd_curscreen->sc_canvas, 0, 0, grd_curscreen->sc_w, grd_curscreen->sc_h );
413 gr_init_sub_canvas( &VR_screen_pages[1], &grd_curscreen->sc_canvas, 0, 0, grd_curscreen->sc_w, grd_curscreen->sc_h );
420 //returns 1 if frame updated ok
425 err = MVE_rmStepMovie();
427 gr_palette_load(gr_palette);
429 if (err == MVE_ERR_EOF) //end of movie, so reset
431 reset_movie_file(RoboFile);
432 if (MVE_rmPrepMovie((void *)RoboFile, MenuHires?280:140, MenuHires?200:80, 0)) {
446 void DeInitRobotMovie(void)
449 close(RoboFile); // Close Movie File
453 int InitRobotMovie(char *filename)
455 if (FindArg("-nomovies"))
458 con_printf(DEBUG_LEVEL, "RoboFile=%s\n", filename);
460 MVE_sndInit(-1); //tell movies to play no sound for robots
462 RoboFile = open_movie_file(filename, 1);
464 if (RoboFile == -1) {
465 Warning("movie: InitRobotMovie: Cannot open movie file <%s>",filename);
466 return MOVIE_NOT_PLAYED;
469 Vid_State = VID_PLAY;
471 if (MVE_rmPrepMovie((void *)RoboFile, MenuHires?280:140, MenuHires?200:80, 0)) {
476 RoboFilePos=lseek (RoboFile,0L,SEEK_CUR);
478 con_printf(DEBUG_LEVEL, "RoboFilePos=%d!\n", RoboFilePos);
485 * Subtitle system code
488 ubyte *subtitle_raw_data;
491 //search for next field following whitespace
492 ubyte *next_field(ubyte *p)
494 while (*p && !isspace(*p))
500 while (*p && isspace(*p))
510 int init_subtitles(char *filename)
519 if (! FindArg("-subtitles"))
522 ifile = cfopen(filename,"rb"); //try text version
524 if (!ifile) { //no text version, try binary version
525 char filename2[FILENAME_LEN];
526 change_filename_ext(filename2,filename,".TXB");
527 ifile = cfopen(filename2,"rb");
533 size = cfilelength(ifile);
535 MALLOC (subtitle_raw_data, ubyte, size+1);
537 read_count = cfread(subtitle_raw_data, 1, size, ifile);
541 subtitle_raw_data[size] = 0;
543 if (read_count != size) {
544 d_free(subtitle_raw_data);
548 p = subtitle_raw_data;
550 while (p && p < subtitle_raw_data+size) {
553 endp = strchr(p,'\n');
555 if (endp[-1] == '\r')
556 endp[-1] = 0; //handle 0d0a pair
557 *endp = 0; //string termintor
564 Subtitles[Num_subtitles].first_frame = atoi(p);
565 p = next_field(p); if (!p) continue;
566 Subtitles[Num_subtitles].last_frame = atoi(p);
567 p = next_field(p); if (!p) continue;
568 Subtitles[Num_subtitles].msg = p;
570 Assert(Num_subtitles==0 || Subtitles[Num_subtitles].first_frame >= Subtitles[Num_subtitles-1].first_frame);
571 Assert(Subtitles[Num_subtitles].last_frame >= Subtitles[Num_subtitles].first_frame);
584 void close_subtitles()
586 if (subtitle_raw_data)
587 d_free(subtitle_raw_data);
588 subtitle_raw_data = NULL;
593 //draw the subtitles for this frame
594 void draw_subtitles(int frame_num)
596 static int active_subtitles[MAX_ACTIVE_SUBTITLES];
597 static int num_active_subtitles,next_subtitle,line_spacing;
601 if (frame_num == 0) {
602 num_active_subtitles = 0;
604 gr_set_curfont( GAME_FONT );
605 line_spacing = grd_curcanv->cv_font->ft_h + (grd_curcanv->cv_font->ft_h >> 2);
606 gr_set_fontcolor(255,-1);
609 //get rid of any subtitles that have expired
610 for (t=0;t<num_active_subtitles;)
611 if (frame_num > Subtitles[active_subtitles[t]].last_frame) {
613 for (t2=t;t2<num_active_subtitles-1;t2++)
614 active_subtitles[t2] = active_subtitles[t2+1];
615 num_active_subtitles--;
621 //get any subtitles new for this frame
622 while (next_subtitle < Num_subtitles && frame_num >= Subtitles[next_subtitle].first_frame) {
623 if (num_active_subtitles >= MAX_ACTIVE_SUBTITLES)
624 Error("Too many active subtitles!");
625 active_subtitles[num_active_subtitles++] = next_subtitle;
629 //find y coordinate for first line of subtitles
630 y = grd_curcanv->cv_bitmap.bm_h-((line_spacing+1)*MAX_ACTIVE_SUBTITLES+2);
632 //erase old subtitles if necessary
635 gr_rect(0,y,grd_curcanv->cv_bitmap.bm_w-1,grd_curcanv->cv_bitmap.bm_h-1);
638 //now draw the current subtitles
639 for (t=0;t<num_active_subtitles;t++)
640 if (active_subtitles[t] != -1) {
641 gr_string(0x8000,y,Subtitles[active_subtitles[t]].msg);
647 movielib *init_new_movie_lib(char *filename, CFILE *fp)
653 //read movie file header
655 nfiles = cfile_read_int(fp); //get number of files
657 //table = d_malloc(sizeof(*table) + sizeof(ml_entry)*nfiles);
658 MALLOC(table, movielib, 1);
659 MALLOC(table->movies, ml_entry, nfiles);
661 strcpy(table->name,filename);
662 table->n_movies = nfiles;
664 offset = 4+4+nfiles*(13+4); //id + nfiles + nfiles * (filename + size)
666 for (i=0;i<nfiles;i++) {
669 n = cfread(table->movies[i].name, 13, 1, fp);
671 break; //end of file (probably)
673 len = cfile_read_int(fp);
675 table->movies[i].len = len;
676 table->movies[i].offset = offset;
678 offset += table->movies[i].len;
691 movielib *init_old_movie_lib(char *filename, CFILE *fp)
695 movielib *table,*table2;
700 table = d_malloc(sizeof(*table) + sizeof(ml_entry)*MAX_MOVIES_PER_LIB);
705 i = cfread(table->movies[nfiles].name, 13, 1, fp);
707 break; //end of file (probably)
709 i = cfread(&len, 4, 1, fp);
711 Error("error reading movie library <%s>",filename);
713 table->movies[nfiles].len = INTEL_INT(len);
714 table->movies[nfiles].offset = cftell(fp);
716 cfseek(fp, INTEL_INT(len), SEEK_CUR); //skip data
721 //allocate correct-sized table
722 size = sizeof(*table) + sizeof(ml_entry)*nfiles;
723 table2 = d_malloc(size);
724 memcpy(table2,table,size);
728 strcpy(table->name,filename);
730 table->n_movies = nfiles;
741 //find the specified movie library, and read in list of movies in it
742 movielib *init_movie_lib(char *filename)
744 //note: this based on cfile_init_hogfile()
749 fp = cfopen(filename, "rb");
754 cfread(id, 4, 1, fp);
755 if ( !strncmp( id, "DMVL", 4 ) )
756 return init_new_movie_lib(filename,fp);
757 else if ( !strncmp( id, "DHF", 3 ) ) {
758 cfseek(fp,-1,SEEK_CUR); //old file had 3 char id
759 return init_old_movie_lib(filename,fp);
768 void close_movie(int i)
771 d_free(movie_libs[i]->movies);
772 d_free(movie_libs[i]);
781 for (i=0;i<N_MOVIE_LIBS;i++)
786 //ask user to put the D2 CD in.
787 //returns -1 if ESC pressed, 0 if OK chosen
788 //CD may not have been inserted
792 ubyte save_pal[256*3];
793 grs_canvas *save_canv,*tcanv;
794 int ret,was_faded=gr_palette_faded_out;
798 save_canv = grd_curcanv;
799 tcanv = gr_create_canvas(grd_curcanv->cv_w,grd_curcanv->cv_h);
801 gr_set_current_canvas(tcanv);
802 gr_ubitmap(0,0,&save_canv->cv_bitmap);
803 gr_set_current_canvas(save_canv);
805 gr_clear_canvas(BM_XRGB(0,0,0));
807 memcpy(save_pal,gr_palette,sizeof(save_pal));
809 memcpy(gr_palette,last_palette_for_color_fonts,sizeof(gr_palette));
813 ret = nm_messagebox( "CD ERROR", 1, "Ok", "Please insert your Descent II CD");
818 ret2 = nm_messagebox( "CD ERROR", 2, "Try Again", "Leave Game", "You must insert your\nDescent II CD to Continue");
820 if (ret2 == -1 || ret2 == 0)
824 force_rb_register = 1; //disc has changed; force register new CD
828 memcpy(gr_palette,save_pal,sizeof(save_pal));
830 gr_ubitmap(0,0,&tcanv->cv_bitmap);
833 gr_palette_load(gr_palette);
835 gr_free_canvas(tcanv);
839 con_printf(DEBUG_LEVEL, "STUB: movie: request_cd\n");
845 void init_movie(char *filename,int libnum,int is_robots,int required)
851 if (FindArg("-nomovies")) {
852 movie_libs[libnum] = NULL;
857 //for robots, load highres versions if highres menus set
859 high_res = MenuHiresAvailable;
861 high_res = MovieHires;
864 strchr(filename,'.')[-1] = 'h';
868 if ((movie_libs[libnum] = init_movie_lib(filename)) == NULL) {
871 strcpy(name2,CDROM_dir);
872 strcat(name2,filename);
873 movie_libs[libnum] = init_movie_lib(name2);
875 if (movie_libs[libnum] != NULL)
876 movie_libs[libnum]->flags |= MLF_ON_CD;
879 Warning("Cannot open movie file <%s>\n",filename);
882 if (!try) { // first try
883 if (strchr(filename, '.')[-1] == 'h') { // try again with lowres
884 strchr(filename, '.')[-1] = 'l';
886 Warning("Trying to open movie file <%s> instead\n", filename);
889 } else if (strchr(filename, '.')[-1] == 'l') { // try again with highres
890 strchr(filename, '.')[-1] = 'h';
892 Warning("Trying to open movie file <%s> instead\n", filename);
900 if (is_robots && movie_libs[libnum]!=NULL)
901 robot_movies = high_res?2:1;
905 //find and initialize the movie libraries
911 for (i=0;i<N_BUILTIN_MOVIE_LIBS;i++) {
913 if (!strnicmp(movielib_files[i],"robot",5))
918 init_movie(movielib_files[i],i,is_robots,1);
921 movie_libs[EXTRA_ROBOT_LIB] = NULL;
923 atexit(close_movies);
927 void init_extra_robot_movie(char *filename)
929 close_movie(EXTRA_ROBOT_LIB);
930 init_movie(filename,EXTRA_ROBOT_LIB,1,0);
934 int movie_handle,movie_start;
936 //looks through a movie library for a movie file
937 //returns filehandle, with fileposition at movie, or -1 if can't find
938 int search_movie_lib(movielib *lib,char *filename,int must_have)
946 for (i=0;i<lib->n_movies;i++)
947 if (!stricmp(filename,lib->movies[i].name)) { //found the movie in a library
950 from_cd = (lib->flags & MLF_ON_CD);
953 songs_stop_redbook(); //ready to read from CD
955 do { //keep trying until we get the file handle
958 movie_handle = filehandle = open(lib->name, O_RDONLY | O_BINARY);
960 movie_handle = filehandle = open(lib->name, O_RDONLY);
963 if (must_have && from_cd && filehandle == -1) { //didn't get file!
965 if (request_cd() == -1) //ESC from requester
966 break; //bail from here. will get error later
969 } while (must_have && from_cd && filehandle == -1);
971 if (filehandle != -1)
972 lseek(filehandle,(movie_start=lib->movies[i].offset),SEEK_SET);
981 //returns file handle
982 int open_movie_file(char *filename,int must_have)
986 for (i=0;i<N_MOVIE_LIBS;i++) {
987 if ((filehandle = search_movie_lib(movie_libs[i],filename,must_have)) != -1)
991 return -1; //couldn't find it
994 //sets the file position to the start of this already-open file
995 int reset_movie_file(int handle)
997 Assert(handle == movie_handle);
999 lseek(handle,movie_start,SEEK_SET);
1001 return 0; //everything is cool