2 * $Logfile: /Freespace2/code/Cutscene/Cutscenes.cpp $
7 * Code for the cutscenes viewer screen
10 * Revision 1.2 2002/05/07 03:16:43 theoddone33
11 * The Great Newline Fix
13 * Revision 1.1.1.1 2002/05/03 03:28:08 root
17 * 15 6/16/00 3:15p Jefff
18 * sim of the year dvd version changes, a few german soty localization
21 * 14 10/13/99 10:20a Jefff
22 * fixed bug where intro cutscene showed 2x after getting bad ending
24 * 13 10/06/99 10:30a Jefff
27 * 12 9/30/99 6:01p Jefff
30 * 11 9/07/99 1:10p Mikek
31 * Make movie check not hang in ~RELEASE_REAL build.
33 * 10 9/06/99 6:38p Dave
34 * Improved CD detection code.
36 * 9 9/06/99 1:16a Dave
37 * Make sure the user sees the intro movie.
39 * 8 9/03/99 1:31a Dave
40 * CD checking by act. Added support to play 2 cutscenes in a row
41 * seamlessly. Fixed super low level cfile bug related to files in the
42 * root directory of a CD. Added cheat code to set campaign mission # in
45 * 7 7/19/99 2:13p Dave
46 * Added some new strings for Heiko.
48 * 6 6/01/99 3:52p Dave
49 * View footage screen. Fixed xstrings to not display the & symbol. Popup,
50 * dead popup, pxo find player popup, pxo private room popup.
52 * 5 1/30/99 5:08p Dave
53 * More new hi-res stuff.Support for nice D3D textures.
55 * 4 10/23/98 3:51p Dave
56 * Full support for tstrings.tbl and foreign languages. All that remains
57 * is to make it active in Fred.
59 * 3 10/13/98 9:28a Dave
60 * Started neatening up freespace.h. Many variables renamed and
61 * reorganized. Added AlphaColors.[h,cpp]
63 * 2 10/07/98 10:52a Dave
66 * 1 10/07/98 10:48a Dave
68 * 18 6/09/98 10:31a Hoffoss
69 * Created index numbers for all xstr() references. Any new xstr() stuff
70 * added from here on out should be added to the end if the list. The
71 * current list count can be found in FreeSpace.cpp (search for
74 * 17 6/01/98 11:43a John
75 * JAS & MK: Classified all strings for localization.
77 * 16 5/24/98 9:01p Lawrance
78 * Add commit sounds when accept is pressed
80 * 15 5/21/98 8:05p Allender
81 * fix possible bug with number of cutscenes shown in the list
83 * 14 5/21/98 12:35a Lawrance
84 * Tweak how CD is checked for
86 * 13 5/20/98 1:34p Hoffoss
87 * Added cutscene description rendering.
89 * 12 5/19/98 12:19p Mike
92 * 11 5/12/98 4:17p Hoffoss
93 * Make ctrl-arrows (up/down) switch between tech room screens.
95 * 10 5/11/98 8:04p Hoffoss
98 * 9 5/10/98 10:05p Allender
99 * only show cutscenes which have been seen before. Made Fred able to
100 * write missions anywhere, defaulting to player misison folder, not data
101 * mission folder. Fix FreeSpace code to properly read missions from
104 * 8 5/08/98 5:30p Lawrance
105 * add CD checks for movie playing
107 * 7 5/08/98 4:07p Allender
108 * more cutscene stuff
110 * 6 5/07/98 2:33p Hoffoss
111 * Removed help and options buttons.
113 * 5 4/30/98 4:53p John
114 * Restructured and cleaned up cfile code. Added capability to read off
115 * of CD-ROM drive and out of multiple pack files.
117 * 4 4/23/98 8:27p Allender
118 * basic support for cutscene playback. Into movie code in place. Tech
119 * room can view cutscenes stored in CDROM_dir variable
121 * 3 4/21/98 7:07p Hoffoss
122 * Fixed problem where when switching screens flashes old tab hilight once
123 * before switching to new state.
125 * 2 4/17/98 6:33p Hoffoss
126 * Made changes to the tech room group of screens. Cutscenes screen is
132 #include "cutscenes.h"
136 #include "gamesequence.h"
137 #include "freespace.h"
140 // #include "movie.h"
142 #include "mainhallmenu.h"
143 #include "alphacolors.h"
144 #include "localize.h"
146 char *Cutscene_bitmap_name[GR_NUM_RESOLUTIONS] = {
150 char *Cutscene_mask_name[GR_NUM_RESOLUTIONS] = {
156 int Cutscenes_viewable;
157 int Description_index;
158 cutscene_info Cutscenes[MAX_CUTSCENES];
160 extern int All_movies_enabled; // If set, all movies may be viewed. Keyed off cheat code.
162 // initialization stuff for cutscenes
165 char buf[MULTITEXT_LENGTH];
168 if ((rval = setjmp(parse_abort)) != 0) {
169 Error(LOCATION, "Error parsing 'rank.tbl'\r\nError code = %i.\r\n", rval);
175 read_file_text("cutscenes.tbl");
178 // parse in all the rank names
180 skip_to_string("#Cutscenes");
181 ignore_white_space();
182 while ( required_string_either("#End", "$Filename:") ) {
183 Assert ( Num_cutscenes < MAX_CUTSCENES );
184 required_string("$Filename:");
185 stuff_string( Cutscenes[Num_cutscenes].filename, F_PATHNAME, NULL );
186 required_string("$Name:");
187 stuff_string( Cutscenes[Num_cutscenes].name, F_NAME, NULL );
188 required_string("$Description:");
189 stuff_string(buf, F_MULTITEXT, NULL);
190 drop_white_space(buf);
191 compact_multitext_string(buf);
192 Cutscenes[Num_cutscenes].description = strdup(buf);
193 required_string("$cd:");
194 stuff_int( &Cutscenes[Num_cutscenes].cd );
199 required_string("#End");
201 Cutscenes_viewable = INTRO_CUTSCENE_FLAG;
203 // close localization
207 // function to return 0 based index of which CD a particular movie is on
208 // returns -1 on failure.
209 int cutscenes_get_cd_num( char *filename )
211 #if defined(OEM_BUILD)
212 return 0; // only 1 cd for OEM
216 for (i = 0; i < Num_cutscenes; i++ ) {
217 if ( !stricmp(Cutscenes[i].filename, filename) ) {
218 return (Cutscenes[i].cd - 1);
223 #endif // defined(OEM_BUILD)
226 // marks a cutscene as viewable
227 void cutscene_mark_viewable(char *filename)
231 for (i = 0; i < Num_cutscenes; i++ ) {
232 if ( !stricmp(Cutscenes[i].filename, filename) ) {
233 Cutscenes_viewable |= (1<<i);
239 #define NUM_BUTTONS 8
241 #define TECH_DATABASE_BUTTON 0
242 #define SIMULATOR_BUTTON 1
243 #define CUTSCENES_BUTTON 2
244 #define CREDITS_BUTTON 3
246 #define SCROLL_UP_BUTTON 4
247 #define SCROLL_DOWN_BUTTON 5
248 #define PLAY_BUTTON 6
249 #define EXIT_BUTTON 7
251 static int Num_files;
252 static int Cutscene_list[MAX_CUTSCENES];
253 static int Stats_scroll_offset;
254 static int Selected_line = 0; // line that is currently selected for binding
255 static int Scroll_offset;
256 static int Background_bitmap;
257 static UI_BUTTON List_region;
258 static UI_WINDOW Ui_window;
260 ui_button_info Buttons[GR_NUM_RESOLUTIONS][NUM_BUTTONS] = {
262 ui_button_info("TDB_00", 7, 5, 37, 7, 0), // tech database 1
263 ui_button_info("TDB_01", 7, 19, 37, 23, 1), // tech database 2
264 ui_button_info("TDB_02", 7, 34, 37, 38, 2), // tech database 3
265 ui_button_info("TDB_03", 7, 49, 37, 54, 3), // tech database 4
267 ui_button_info("VFB_04", 6, 318, -1, -1, 4), // scroll up
268 ui_button_info("VFB_05", 36, 318, -1, -1, 5), // scroll down
269 ui_button_info("VFB_06", 578, 319, 587, 366, 6), // play
270 ui_button_info("VFB_07", 574, 431, 587, 413, 7), // exit
273 ui_button_info("2_TDB_00", 12, 7, 59, 12, 0), // tech database 1
274 ui_button_info("2_TDB_01", 12, 31, 59, 37, 1), // tech database 2
275 ui_button_info("2_TDB_02", 12, 56, 59, 62, 2), // tech database 3
276 ui_button_info("2_TDB_03", 12, 81, 59, 88, 3), // tech database 4
278 ui_button_info("2_VFB_04", 9, 509, -1, -1, 4), // scroll up
279 ui_button_info("2_VFB_05", 58, 509, -1, -1, 5), // scroll down
280 ui_button_info("2_VFB_06", 925, 511, 940, 586, 6), // play
281 ui_button_info("2_VFB_07", 918, 689, 940, 661, 7), // exit
286 #define NUM_CUTSCENE_TEXT 6
287 UI_XSTR Cutscene_text[GR_NUM_RESOLUTIONS][NUM_CUTSCENE_TEXT] = {
289 {"Technical Database", 1055, 37, 7, UI_XSTR_COLOR_GREEN, -1, &Buttons[0][TECH_DATABASE_BUTTON].button },
290 {"Mission Simulator", 1056, 37, 23, UI_XSTR_COLOR_GREEN, -1, &Buttons[0][SIMULATOR_BUTTON].button },
291 {"Cutscenes", 1057, 37, 38, UI_XSTR_COLOR_GREEN, -1, &Buttons[0][CUTSCENES_BUTTON].button },
292 {"Credits", 1058, 37, 54, UI_XSTR_COLOR_GREEN, -1, &Buttons[0][CREDITS_BUTTON].button },
294 {"Play", 1335, 587, 366, UI_XSTR_COLOR_GREEN, -1, &Buttons[0][PLAY_BUTTON].button },
295 {"Exit", 1419, 587, 413, UI_XSTR_COLOR_PINK, -1, &Buttons[0][EXIT_BUTTON].button },
298 {"Technical Database", 1055, 59, 12, UI_XSTR_COLOR_GREEN, -1, &Buttons[1][TECH_DATABASE_BUTTON].button },
299 {"Mission Simulator", 1056, 59, 37, UI_XSTR_COLOR_GREEN, -1, &Buttons[1][SIMULATOR_BUTTON].button },
300 {"Cutscenes", 1057, 59, 62, UI_XSTR_COLOR_GREEN, -1, &Buttons[1][CUTSCENES_BUTTON].button },
301 {"Credits", 1058, 59, 88, UI_XSTR_COLOR_GREEN, -1, &Buttons[1][CREDITS_BUTTON].button },
303 {"Play", 1335, 940, 586, UI_XSTR_COLOR_GREEN, -1, &Buttons[1][PLAY_BUTTON].button },
304 {"Exit", 1419, 940, 661, UI_XSTR_COLOR_PINK, -1, &Buttons[1][EXIT_BUTTON].button },
308 int Cutscene_list_coords[GR_NUM_RESOLUTIONS][4] = {
317 int Cutscene_desc_coords[GR_NUM_RESOLUTIONS][4] = {
326 #define MAX_TEXT_LINES 20
327 int Cutscene_max_text_lines[GR_NUM_RESOLUTIONS] = {
331 #define MAX_TEXT_LINE_LEN 256
333 static int Text_size;
334 static int Text_offset = 0;
335 static int Text_line_size[MAX_TEXT_LINES];
336 static char *Text_lines[MAX_TEXT_LINES];
339 int cutscenes_validate_cd(char *mve_name, int prompt_for_cd)
344 char volume_name[128];
347 int num_attempts = 0;
353 cd_mve_is_on = cutscenes_get_cd_num(mve_name);
354 if ((cd_mve_is_on != 0) && (cd_mve_is_on != 1) && (cd_mve_is_on != 2)) {
359 #if defined(OEM_BUILD)
360 sprintf(volume_name, NOX("FS2_OEM"));
362 sprintf(volume_name, NOX("FREESPACE2_%c"), '1' + cd_mve_is_on);
366 cd_drive_num = find_freespace_cd(volume_name);
367 path_set_ok = set_cdrom_path(cd_drive_num);
375 if ( !prompt_for_cd ) {
380 // no CD found, so prompt user
384 #if defined(DVD_MESSAGE_HACK)
385 sprintf(popup_msg, XSTR( "Movie not found\n\nInsert FreeSpace DVD to continue", 203));
387 sprintf(popup_msg, XSTR( "Movie not found\n\nInsert FreeSpace CD #%d to continue", 203), cd_mve_is_on+1);
390 popup_rval = popup(PF_BODY_BIG, 2, POPUP_CANCEL, POPUP_OK, popup_msg);
391 if ( popup_rval != 1 ) {
396 if ( num_attempts++ > 5 ) {
410 void cutscenes_screen_play()
412 char name[MAX_FILENAME_LEN], *full_name;
415 Assert( (Selected_line >= 0) && (Selected_line < Num_files) );
416 which_cutscene = Cutscene_list[Selected_line];
418 strcpy(name, Cutscenes[which_cutscene].filename );
419 full_name = cf_add_ext(name, NOX(".mve"));
423 int rval = movie_play(full_name);
427 sprintf(str, XSTR( "Unable to play movie %s.", 204), Cutscenes[which_cutscene].name );
428 popup(0, 1, POPUP_OK, str );
433 void cutscenes_screen_scroll_line_up()
437 gamesnd_play_iface(SND_SCROLL);
440 gamesnd_play_iface(SND_GENERAL_FAIL);
442 if (Selected_line < Scroll_offset)
443 Scroll_offset = Selected_line;
446 void cutscenes_screen_scroll_line_down()
450 if (Selected_line < Num_files - 1) {
452 gamesnd_play_iface(SND_SCROLL);
455 gamesnd_play_iface(SND_GENERAL_FAIL);
457 h = Cutscene_list_coords[gr_screen.res][3] / gr_get_font_height();
458 if (Selected_line >= Scroll_offset + h){
463 void cutscenes_screen_scroll_screen_up()
469 Assert(Selected_line > Scroll_offset);
470 h = Cutscene_list_coords[gr_screen.res][3] / gr_get_font_height();
471 while (Selected_line >= Scroll_offset + h){
475 gamesnd_play_iface(SND_SCROLL);
478 gamesnd_play_iface(SND_GENERAL_FAIL);
482 void cutscenes_screen_scroll_screen_down()
486 h = Cutscene_list_coords[gr_screen.res][3] / gr_get_font_height();
487 if (Scroll_offset + h < Num_files) {
489 if (Selected_line < Scroll_offset){
490 Selected_line = Scroll_offset;
493 gamesnd_play_iface(SND_SCROLL);
495 gamesnd_play_iface(SND_GENERAL_FAIL);
499 int cutscenes_screen_button_pressed(int n)
502 case TECH_DATABASE_BUTTON:
503 gamesnd_play_iface(SND_SWITCH_SCREENS);
504 gameseq_post_event(GS_EVENT_TECH_MENU);
507 case SIMULATOR_BUTTON:
508 gamesnd_play_iface(SND_SWITCH_SCREENS);
509 gameseq_post_event(GS_EVENT_SIMULATOR_ROOM);
513 gamesnd_play_iface(SND_SWITCH_SCREENS);
514 gameseq_post_event(GS_EVENT_CREDITS);
517 case SCROLL_UP_BUTTON:
518 cutscenes_screen_scroll_screen_up();
521 case SCROLL_DOWN_BUTTON:
522 cutscenes_screen_scroll_screen_down();
526 cutscenes_screen_play();
530 gamesnd_play_iface(SND_COMMIT_PRESSED);
531 gameseq_post_event(GS_EVENT_MAIN_MENU);
539 void cutscenes_screen_init()
544 Ui_window.create(0, 0, gr_screen.max_w, gr_screen.max_h, 0);
545 Ui_window.set_mask_bmap(Cutscene_mask_name[gr_screen.res]);
547 for (i=0; i<NUM_BUTTONS; i++) {
548 b = &Buttons[gr_screen.res][i];
550 b->button.create(&Ui_window, "", b->x, b->y, 60, 30, (i < 2), 1);
551 // set up callback for when a mouse first goes over a button
552 b->button.set_highlight_action(common_play_highlight_sound);
553 b->button.set_bmaps(b->filename);
554 b->button.link_hotspot(b->hotspot);
558 for(i=0; i<NUM_CUTSCENE_TEXT; i++){
559 Ui_window.add_XSTR(&Cutscene_text[gr_screen.res][i]);
562 Buttons[gr_screen.res][EXIT_BUTTON].button.set_hotkey(KEY_CTRLED | KEY_ENTER);
563 Buttons[gr_screen.res][SCROLL_UP_BUTTON].button.set_hotkey(KEY_PAGEUP);
564 Buttons[gr_screen.res][SCROLL_DOWN_BUTTON].button.set_hotkey(KEY_PAGEDOWN);
566 List_region.create(&Ui_window, "", Cutscene_list_coords[gr_screen.res][0], Cutscene_list_coords[gr_screen.res][1], Cutscene_list_coords[gr_screen.res][2], Cutscene_list_coords[gr_screen.res][3], 0, 1);
569 // set up hotkeys for buttons so we draw the correct animation frame when a key is pressed
570 Buttons[gr_screen.res][SCROLL_UP_BUTTON].button.set_hotkey(KEY_PAGEUP);
571 Buttons[gr_screen.res][SCROLL_DOWN_BUTTON].button.set_hotkey(KEY_PAGEDOWN);
573 Background_bitmap = bm_load(Cutscene_bitmap_name[gr_screen.res]);
574 Scroll_offset = Selected_line = 0;
575 Description_index = -1;
577 // when doing a debug version, just put all of the movie files here.
579 //Cutscenes_viewable = 0xffffffff; // makes all cutscenes viewble.
582 if (All_movies_enabled)
583 Cutscenes_viewable = 0xffffffff; // Cheat code enables all movies.
586 for ( i = 0; i < Num_cutscenes; i++ ) {
587 if ( Cutscenes_viewable & (1<<i) ) {
588 Cutscene_list[Num_files] = i;
594 void cutscenes_screen_close()
596 if (Background_bitmap)
597 bm_unload(Background_bitmap);
602 void cutscenes_screen_do_frame()
605 int font_height = gr_get_font_height();
606 int select_tease_line = -1;
608 k = Ui_window.process();
610 case KEY_DOWN: // select next line
611 cutscenes_screen_scroll_line_down();
614 case KEY_UP: // select previous line
615 cutscenes_screen_scroll_line_up();
619 case KEY_CTRLED | KEY_DOWN:
620 cutscenes_screen_button_pressed(CREDITS_BUTTON);
623 case KEY_SHIFTED | KEY_TAB:
624 case KEY_CTRLED | KEY_UP:
625 cutscenes_screen_button_pressed(SIMULATOR_BUTTON);
629 cutscenes_screen_play();
632 case KEY_ESC: // cancel
633 gameseq_post_event(GS_EVENT_MAIN_MENU);
637 case KEY_F1: // show help overlay
640 case KEY_F2: // goto options screen
641 gameseq_post_event(GS_EVENT_OPTIONS_MENU);
645 for (i=0; i<NUM_BUTTONS; i++){
646 if (Buttons[gr_screen.res][i].button.pressed()){
647 if (cutscenes_screen_button_pressed(i)){
653 if (List_region.button_down()) {
654 List_region.get_mouse_pos(NULL, &y);
655 z = Scroll_offset + y / font_height;
656 if ((z >= 0) && (z < Num_files))
657 select_tease_line = z;
660 if (List_region.pressed()) {
661 List_region.get_mouse_pos(NULL, &y);
662 z = Scroll_offset + y / font_height;
663 if ((z >= 0) && (z < Num_files))
667 GR_MAYBE_CLEAR_RES(Background_bitmap);
668 if (Background_bitmap >= 0) {
669 gr_set_bitmap(Background_bitmap);
675 for (i=TECH_DATABASE_BUTTON; i<=CREDITS_BUTTON; i++){
676 if (Buttons[gr_screen.res][i].button.button_down()){
681 if (i > CREDITS_BUTTON){
682 Buttons[gr_screen.res][CUTSCENES_BUTTON].button.draw_forced(2);
687 while (y + font_height <= Cutscene_list_coords[gr_screen.res][3]) {
692 if (z == Selected_line){
693 gr_set_color_fast(&Color_text_selected);
694 } else if (z == select_tease_line) {
695 gr_set_color_fast(&Color_text_subselected);
697 gr_set_color_fast(&Color_text_normal);
700 gr_printf(Cutscene_list_coords[gr_screen.res][0], Cutscene_list_coords[gr_screen.res][1] + y, Cutscenes[Cutscene_list[z]].name);
706 if (Description_index != Selected_line) {
709 Description_index = Selected_line;
711 src = Cutscenes[Cutscene_list[Description_index]].description;
713 Text_size = split_str(src, Cutscene_desc_coords[gr_screen.res][2], Text_line_size, Text_lines, Cutscene_max_text_lines[gr_screen.res]);
714 Assert(Text_size >= 0 && Text_size < Cutscene_max_text_lines[gr_screen.res]);
718 if (Description_index >= 0) {
720 char line[MAX_TEXT_LINE_LEN + 1];
722 gr_set_color_fast(&Color_text_normal);
726 while (y + font_height <= Cutscene_desc_coords[gr_screen.res][3]) {
730 len = Text_line_size[z];
731 if (len > MAX_TEXT_LINE_LEN)
732 len = MAX_TEXT_LINE_LEN;
734 strncpy(line, Text_lines[z], len);
736 gr_string(Cutscene_desc_coords[gr_screen.res][0], Cutscene_desc_coords[gr_screen.res][1] + y, line);