2 * Copyright (C) Volition, Inc. 1999. All rights reserved.
4 * All source code herein is the property of Volition, Inc. You may not sell
5 * or otherwise commercially exploit the source or things you created based on
10 * $Logfile: /Freespace2/code/Cutscene/Cutscenes.cpp $
15 * Code for the cutscenes viewer screen
18 * Revision 1.9 2004/09/20 01:31:44 theoddone33
21 * Revision 1.8 2003/06/11 18:30:32 taylor
24 * Revision 1.7 2003/05/25 02:30:42 taylor
27 * Revision 1.6 2002/07/24 00:20:41 relnev
30 * Revision 1.5 2002/06/09 04:41:15 relnev
31 * added copyright header
33 * Revision 1.4 2002/06/02 04:26:34 relnev
36 * Revision 1.3 2002/05/26 22:06:17 relnev
37 * makefile: disable stand_gui for now.
39 * rest: staticize some globals
41 * Revision 1.2 2002/05/07 03:16:43 theoddone33
42 * The Great Newline Fix
44 * Revision 1.1.1.1 2002/05/03 03:28:08 root
48 * 15 6/16/00 3:15p Jefff
49 * sim of the year dvd version changes, a few german soty localization
52 * 14 10/13/99 10:20a Jefff
53 * fixed bug where intro cutscene showed 2x after getting bad ending
55 * 13 10/06/99 10:30a Jefff
58 * 12 9/30/99 6:01p Jefff
61 * 11 9/07/99 1:10p Mikek
62 * Make movie check not hang in ~RELEASE_REAL build.
64 * 10 9/06/99 6:38p Dave
65 * Improved CD detection code.
67 * 9 9/06/99 1:16a Dave
68 * Make sure the user sees the intro movie.
70 * 8 9/03/99 1:31a Dave
71 * CD checking by act. Added support to play 2 cutscenes in a row
72 * seamlessly. Fixed super low level cfile bug related to files in the
73 * root directory of a CD. Added cheat code to set campaign mission # in
76 * 7 7/19/99 2:13p Dave
77 * Added some new strings for Heiko.
79 * 6 6/01/99 3:52p Dave
80 * View footage screen. Fixed xstrings to not display the & symbol. Popup,
81 * dead popup, pxo find player popup, pxo private room popup.
83 * 5 1/30/99 5:08p Dave
84 * More new hi-res stuff.Support for nice D3D textures.
86 * 4 10/23/98 3:51p Dave
87 * Full support for tstrings.tbl and foreign languages. All that remains
88 * is to make it active in Fred.
90 * 3 10/13/98 9:28a Dave
91 * Started neatening up freespace.h. Many variables renamed and
92 * reorganized. Added AlphaColors.[h,cpp]
94 * 2 10/07/98 10:52a Dave
97 * 1 10/07/98 10:48a Dave
99 * 18 6/09/98 10:31a Hoffoss
100 * Created index numbers for all xstr() references. Any new xstr() stuff
101 * added from here on out should be added to the end if the list. The
102 * current list count can be found in FreeSpace.cpp (search for
105 * 17 6/01/98 11:43a John
106 * JAS & MK: Classified all strings for localization.
108 * 16 5/24/98 9:01p Lawrance
109 * Add commit sounds when accept is pressed
111 * 15 5/21/98 8:05p Allender
112 * fix possible bug with number of cutscenes shown in the list
114 * 14 5/21/98 12:35a Lawrance
115 * Tweak how CD is checked for
117 * 13 5/20/98 1:34p Hoffoss
118 * Added cutscene description rendering.
120 * 12 5/19/98 12:19p Mike
123 * 11 5/12/98 4:17p Hoffoss
124 * Make ctrl-arrows (up/down) switch between tech room screens.
126 * 10 5/11/98 8:04p Hoffoss
129 * 9 5/10/98 10:05p Allender
130 * only show cutscenes which have been seen before. Made Fred able to
131 * write missions anywhere, defaulting to player misison folder, not data
132 * mission folder. Fix FreeSpace code to properly read missions from
135 * 8 5/08/98 5:30p Lawrance
136 * add CD checks for movie playing
138 * 7 5/08/98 4:07p Allender
139 * more cutscene stuff
141 * 6 5/07/98 2:33p Hoffoss
142 * Removed help and options buttons.
144 * 5 4/30/98 4:53p John
145 * Restructured and cleaned up cfile code. Added capability to read off
146 * of CD-ROM drive and out of multiple pack files.
148 * 4 4/23/98 8:27p Allender
149 * basic support for cutscene playback. Into movie code in place. Tech
150 * room can view cutscenes stored in CDROM_dir variable
152 * 3 4/21/98 7:07p Hoffoss
153 * Fixed problem where when switching screens flashes old tab hilight once
154 * before switching to new state.
156 * 2 4/17/98 6:33p Hoffoss
157 * Made changes to the tech room group of screens. Cutscenes screen is
163 #include "cutscenes.h"
167 #include "gamesequence.h"
168 #include "freespace.h"
173 #include "mainhallmenu.h"
174 #include "alphacolors.h"
175 #include "localize.h"
177 char *Cutscene_bitmap_name[GR_NUM_RESOLUTIONS] = {
181 char *Cutscene_mask_name[GR_NUM_RESOLUTIONS] = {
187 int Cutscenes_viewable;
188 int Description_index;
189 cutscene_info Cutscenes[MAX_CUTSCENES];
191 extern int All_movies_enabled; // If set, all movies may be viewed. Keyed off cheat code.
193 // initialization stuff for cutscenes
196 #ifndef FS1_DEMO // no cuscenes in FS1 demo
197 char buf[MULTITEXT_LENGTH];
200 if ((rval = setjmp(parse_abort)) != 0) {
201 Error(LOCATION, "Error parsing 'rank.tbl'\r\nError code = %i.\r\n", rval);
207 read_file_text("cutscenes.tbl");
210 // parse in all the rank names
212 skip_to_string("#Cutscenes");
213 ignore_white_space();
214 while ( required_string_either("#End", "$Filename:") ) {
215 Assert ( Num_cutscenes < MAX_CUTSCENES );
216 required_string("$Filename:");
217 stuff_string( Cutscenes[Num_cutscenes].filename, F_PATHNAME, NULL );
218 required_string("$Name:");
219 stuff_string( Cutscenes[Num_cutscenes].name, F_NAME, NULL );
220 required_string("$Description:");
221 stuff_string(buf, F_MULTITEXT, NULL);
222 drop_white_space(buf);
223 compact_multitext_string(buf);
224 Cutscenes[Num_cutscenes].description = strdup(buf);
225 required_string("$cd:");
226 stuff_int( &Cutscenes[Num_cutscenes].cd );
231 required_string("#End");
233 Cutscenes_viewable = INTRO_CUTSCENE_FLAG;
235 // close localization
240 // free up memory from table parsing
241 void cutscene_tbl_close()
245 for (i=0; i<MAX_CUTSCENES; i++) {
246 if (Cutscenes[i].description) {
247 free(Cutscenes[i].description);
248 Cutscenes[i].description = NULL;
253 // function to return 0 based index of which CD a particular movie is on
254 // returns -1 on failure.
255 int cutscenes_get_cd_num( char *filename )
257 #if defined(OEM_BUILD)
258 return 0; // only 1 cd for OEM
262 for (i = 0; i < Num_cutscenes; i++ ) {
263 if ( !stricmp(Cutscenes[i].filename, filename) ) {
264 return (Cutscenes[i].cd - 1);
269 #endif // defined(OEM_BUILD)
272 // marks a cutscene as viewable
273 void cutscene_mark_viewable(char *filename)
277 for (i = 0; i < Num_cutscenes; i++ ) {
278 if ( !stricmp(Cutscenes[i].filename, filename) ) {
279 Cutscenes_viewable |= (1<<i);
285 #define NUM_BUTTONS 8
287 #define TECH_DATABASE_BUTTON 0
288 #define SIMULATOR_BUTTON 1
289 #define CUTSCENES_BUTTON 2
290 #define CREDITS_BUTTON 3
292 #define SCROLL_UP_BUTTON 4
293 #define SCROLL_DOWN_BUTTON 5
294 #define PLAY_BUTTON 6
295 #define EXIT_BUTTON 7
297 static int Num_files;
298 static int Cutscene_list[MAX_CUTSCENES];
299 static int Selected_line = 0; // line that is currently selected for binding
300 static int Scroll_offset;
301 static int Background_bitmap;
302 static UI_BUTTON List_region;
303 static UI_WINDOW Ui_window;
305 static ui_button_info Buttons[GR_NUM_RESOLUTIONS][NUM_BUTTONS] = {
308 ui_button_info("TDB_00", 0, 0, -1, -1, 0), // technical database tab
309 ui_button_info("TDB_01", 0, 19, -1, -1, 1), // mission simulator tab
310 ui_button_info("TDB_02", 0, 35, -1, -1, 2), // cutscenes tab
311 ui_button_info("TDB_03", 0, 56, -1, -1, 3), // credits tab
313 ui_button_info("VFB_04", 570, 304, -1, -1, 4), // scroll up
314 ui_button_info("VFB_05", 600, 304, -1, -1, 5), // scroll down
315 ui_button_info("VFB_06", 573, 347, -1, -1, 6), // play
316 ui_button_info("VFB_07", 566, 411, -1, -1, 7), // exit
318 ui_button_info("TDB_00", 7, 5, 37, 7, 0), // tech database 1
319 ui_button_info("TDB_01", 7, 19, 37, 23, 1), // tech database 2
320 ui_button_info("TDB_02", 7, 34, 37, 38, 2), // tech database 3
321 ui_button_info("TDB_03", 7, 49, 37, 54, 3), // tech database 4
323 ui_button_info("VFB_04", 6, 318, -1, -1, 4), // scroll up
324 ui_button_info("VFB_05", 36, 318, -1, -1, 5), // scroll down
325 ui_button_info("VFB_06", 578, 319, 587, 366, 6), // play
326 ui_button_info("VFB_07", 574, 431, 587, 413, 7), // exit
330 ui_button_info("2_TDB_00", 12, 7, 59, 12, 0), // tech database 1
331 ui_button_info("2_TDB_01", 12, 31, 59, 37, 1), // tech database 2
332 ui_button_info("2_TDB_02", 12, 56, 59, 62, 2), // tech database 3
333 ui_button_info("2_TDB_03", 12, 81, 59, 88, 3), // tech database 4
335 ui_button_info("2_VFB_04", 9, 509, -1, -1, 4), // scroll up
336 ui_button_info("2_VFB_05", 58, 509, -1, -1, 5), // scroll down
337 ui_button_info("2_VFB_06", 925, 511, 940, 586, 6), // play
338 ui_button_info("2_VFB_07", 918, 689, 940, 661, 7), // exit
344 #define NUM_CUTSCENE_TEXT 0
346 #define NUM_CUTSCENE_TEXT 6
348 UI_XSTR Cutscene_text[GR_NUM_RESOLUTIONS][NUM_CUTSCENE_TEXT] = {
350 // nothing needed for FS1
352 {"Technical Database", 1055, 37, 7, UI_XSTR_COLOR_GREEN, -1, &Buttons[0][TECH_DATABASE_BUTTON].button },
353 {"Mission Simulator", 1056, 37, 23, UI_XSTR_COLOR_GREEN, -1, &Buttons[0][SIMULATOR_BUTTON].button },
354 {"Cutscenes", 1057, 37, 38, UI_XSTR_COLOR_GREEN, -1, &Buttons[0][CUTSCENES_BUTTON].button },
355 {"Credits", 1058, 37, 54, UI_XSTR_COLOR_GREEN, -1, &Buttons[0][CREDITS_BUTTON].button },
357 {"Play", 1335, 587, 366, UI_XSTR_COLOR_GREEN, -1, &Buttons[0][PLAY_BUTTON].button },
358 {"Exit", 1419, 587, 413, UI_XSTR_COLOR_PINK, -1, &Buttons[0][EXIT_BUTTON].button },
362 // nothing needed for FS1
364 {"Technical Database", 1055, 59, 12, UI_XSTR_COLOR_GREEN, -1, &Buttons[1][TECH_DATABASE_BUTTON].button },
365 {"Mission Simulator", 1056, 59, 37, UI_XSTR_COLOR_GREEN, -1, &Buttons[1][SIMULATOR_BUTTON].button },
366 {"Cutscenes", 1057, 59, 62, UI_XSTR_COLOR_GREEN, -1, &Buttons[1][CUTSCENES_BUTTON].button },
367 {"Credits", 1058, 59, 88, UI_XSTR_COLOR_GREEN, -1, &Buttons[1][CREDITS_BUTTON].button },
369 {"Play", 1335, 940, 586, UI_XSTR_COLOR_GREEN, -1, &Buttons[1][PLAY_BUTTON].button },
370 {"Exit", 1419, 940, 661, UI_XSTR_COLOR_PINK, -1, &Buttons[1][EXIT_BUTTON].button },
375 int Cutscene_list_coords[GR_NUM_RESOLUTIONS][4] = {
388 int Cutscene_desc_coords[GR_NUM_RESOLUTIONS][4] = {
401 #define MAX_TEXT_LINES 20
402 int Cutscene_max_text_lines[GR_NUM_RESOLUTIONS] = {
406 #define MAX_TEXT_LINE_LEN 256
408 static int Text_size;
409 static int Text_offset = 0;
410 static int Text_line_size[MAX_TEXT_LINES];
411 static char *Text_lines[MAX_TEXT_LINES];
414 int cutscenes_validate_cd(char *mve_name, int prompt_for_cd)
419 char volume_name[128];
422 int num_attempts = 0;
428 cd_mve_is_on = cutscenes_get_cd_num(mve_name);
429 if ((cd_mve_is_on != 0) && (cd_mve_is_on != 1) && (cd_mve_is_on != 2)) {
434 #if defined(OEM_BUILD)
435 sprintf(volume_name, NOX("FS2_OEM"));
437 sprintf(volume_name, NOX("FREESPACE2_%c"), '1' + cd_mve_is_on);
441 cd_drive_num = find_freespace_cd(volume_name);
442 path_set_ok = set_cdrom_path(cd_drive_num);
450 if ( !prompt_for_cd ) {
455 // no CD found, so prompt user
459 #if defined(DVD_MESSAGE_HACK)
460 sprintf(popup_msg, XSTR( "Movie not found\n\nInsert FreeSpace DVD to continue", 203));
462 sprintf(popup_msg, XSTR( "Movie not found\n\nInsert FreeSpace CD #%d to continue", 203), cd_mve_is_on+1);
465 popup_rval = popup(PF_BODY_BIG, 2, POPUP_CANCEL, POPUP_OK, popup_msg);
466 if ( popup_rval != 1 ) {
471 if ( num_attempts++ > 5 ) {
485 void cutscenes_screen_play()
487 char name[MAX_FILENAME_LEN], *full_name;
490 Assert( (Selected_line >= 0) && (Selected_line < Num_files) );
491 which_cutscene = Cutscene_list[Selected_line];
493 strcpy(name, Cutscenes[which_cutscene].filename );
494 full_name = cf_add_ext(name, NOX(".mve"));
496 int rval = movie_play(full_name);
500 sprintf(str, XSTR( "Unable to play movie %s.", 204), Cutscenes[which_cutscene].name );
501 popup(0, 1, POPUP_OK, str );
505 void cutscenes_screen_scroll_line_up()
509 gamesnd_play_iface(SND_SCROLL);
512 gamesnd_play_iface(SND_GENERAL_FAIL);
514 if (Selected_line < Scroll_offset)
515 Scroll_offset = Selected_line;
518 void cutscenes_screen_scroll_line_down()
522 if (Selected_line < Num_files - 1) {
524 gamesnd_play_iface(SND_SCROLL);
527 gamesnd_play_iface(SND_GENERAL_FAIL);
529 h = Cutscene_list_coords[gr_screen.res][3] / gr_get_font_height();
530 if (Selected_line >= Scroll_offset + h){
535 void cutscenes_screen_scroll_screen_up()
541 Assert(Selected_line > Scroll_offset);
542 h = Cutscene_list_coords[gr_screen.res][3] / gr_get_font_height();
543 while (Selected_line >= Scroll_offset + h){
547 gamesnd_play_iface(SND_SCROLL);
550 gamesnd_play_iface(SND_GENERAL_FAIL);
554 void cutscenes_screen_scroll_screen_down()
558 h = Cutscene_list_coords[gr_screen.res][3] / gr_get_font_height();
559 if (Scroll_offset + h < Num_files) {
561 if (Selected_line < Scroll_offset){
562 Selected_line = Scroll_offset;
565 gamesnd_play_iface(SND_SCROLL);
567 gamesnd_play_iface(SND_GENERAL_FAIL);
571 int cutscenes_screen_button_pressed(int n)
574 case TECH_DATABASE_BUTTON:
575 gamesnd_play_iface(SND_SWITCH_SCREENS);
576 gameseq_post_event(GS_EVENT_TECH_MENU);
579 case SIMULATOR_BUTTON:
580 gamesnd_play_iface(SND_SWITCH_SCREENS);
581 gameseq_post_event(GS_EVENT_SIMULATOR_ROOM);
585 gamesnd_play_iface(SND_SWITCH_SCREENS);
586 gameseq_post_event(GS_EVENT_CREDITS);
589 case SCROLL_UP_BUTTON:
590 cutscenes_screen_scroll_screen_up();
593 case SCROLL_DOWN_BUTTON:
594 cutscenes_screen_scroll_screen_down();
598 cutscenes_screen_play();
602 gamesnd_play_iface(SND_COMMIT_PRESSED);
603 gameseq_post_event(GS_EVENT_MAIN_MENU);
611 void cutscenes_screen_init()
616 Ui_window.create(0, 0, gr_screen.max_w, gr_screen.max_h, 0);
617 Ui_window.set_mask_bmap(Cutscene_mask_name[gr_screen.res]);
619 for (i=0; i<NUM_BUTTONS; i++) {
620 b = &Buttons[gr_screen.res][i];
622 b->button.create(&Ui_window, "", b->x, b->y, 60, 30, (i < 2), 1);
623 // set up callback for when a mouse first goes over a button
624 b->button.set_highlight_action(common_play_highlight_sound);
625 b->button.set_bmaps(b->filename);
626 b->button.link_hotspot(b->hotspot);
630 for(i=0; i<NUM_CUTSCENE_TEXT; i++){
631 Ui_window.add_XSTR(&Cutscene_text[gr_screen.res][i]);
634 Buttons[gr_screen.res][EXIT_BUTTON].button.set_hotkey(KEY_CTRLED | KEY_ENTER);
635 Buttons[gr_screen.res][SCROLL_UP_BUTTON].button.set_hotkey(KEY_PAGEUP);
636 Buttons[gr_screen.res][SCROLL_DOWN_BUTTON].button.set_hotkey(KEY_PAGEDOWN);
638 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);
641 // set up hotkeys for buttons so we draw the correct animation frame when a key is pressed
642 Buttons[gr_screen.res][SCROLL_UP_BUTTON].button.set_hotkey(KEY_PAGEUP);
643 Buttons[gr_screen.res][SCROLL_DOWN_BUTTON].button.set_hotkey(KEY_PAGEDOWN);
645 Background_bitmap = bm_load(Cutscene_bitmap_name[gr_screen.res]);
646 Scroll_offset = Selected_line = 0;
647 Description_index = -1;
649 // when doing a debug version, just put all of the movie files here.
651 //Cutscenes_viewable = 0xffffffff; // makes all cutscenes viewble.
654 if (All_movies_enabled)
655 Cutscenes_viewable = 0xffffffff; // Cheat code enables all movies.
658 for ( i = 0; i < Num_cutscenes; i++ ) {
659 if ( Cutscenes_viewable & (1<<i) ) {
660 Cutscene_list[Num_files] = i;
666 void cutscenes_screen_close()
668 if (Background_bitmap)
669 bm_unload(Background_bitmap);
674 void cutscenes_screen_do_frame()
677 int font_height = gr_get_font_height();
678 int select_tease_line = -1;
680 k = Ui_window.process();
682 case KEY_DOWN: // select next line
683 cutscenes_screen_scroll_line_down();
686 case KEY_UP: // select previous line
687 cutscenes_screen_scroll_line_up();
691 case KEY_CTRLED | KEY_DOWN:
692 cutscenes_screen_button_pressed(CREDITS_BUTTON);
695 case KEY_SHIFTED | KEY_TAB:
696 case KEY_CTRLED | KEY_UP:
697 cutscenes_screen_button_pressed(SIMULATOR_BUTTON);
701 cutscenes_screen_play();
704 case KEY_ESC: // cancel
705 gameseq_post_event(GS_EVENT_MAIN_MENU);
709 case KEY_F1: // show help overlay
712 case KEY_F2: // goto options screen
713 gameseq_post_event(GS_EVENT_OPTIONS_MENU);
717 for (i=0; i<NUM_BUTTONS; i++){
718 if (Buttons[gr_screen.res][i].button.pressed()){
719 if (cutscenes_screen_button_pressed(i)){
725 if (List_region.button_down()) {
726 List_region.get_mouse_pos(NULL, &y);
727 z = Scroll_offset + y / font_height;
728 if ((z >= 0) && (z < Num_files))
729 select_tease_line = z;
732 if (List_region.pressed()) {
733 List_region.get_mouse_pos(NULL, &y);
734 z = Scroll_offset + y / font_height;
735 if ((z >= 0) && (z < Num_files))
739 GR_MAYBE_CLEAR_RES(Background_bitmap);
740 if (Background_bitmap >= 0) {
741 gr_set_bitmap(Background_bitmap, GR_ALPHABLEND_NONE, GR_BITBLT_MODE_NORMAL, 1.0f, -1, -1);
747 for (i=TECH_DATABASE_BUTTON; i<=CREDITS_BUTTON; i++){
748 if (Buttons[gr_screen.res][i].button.button_down()){
753 if (i > CREDITS_BUTTON){
754 Buttons[gr_screen.res][CUTSCENES_BUTTON].button.draw_forced(2);
759 while (y + font_height <= Cutscene_list_coords[gr_screen.res][3]) {
764 if (z == Selected_line){
765 gr_set_color_fast(&Color_text_selected);
766 } else if (z == select_tease_line) {
767 gr_set_color_fast(&Color_text_subselected);
769 gr_set_color_fast(&Color_text_normal);
772 gr_printf(Cutscene_list_coords[gr_screen.res][0], Cutscene_list_coords[gr_screen.res][1] + y, Cutscenes[Cutscene_list[z]].name);
778 if (Description_index != Selected_line) {
781 Description_index = Selected_line;
783 src = Cutscenes[Cutscene_list[Description_index]].description;
785 Text_size = split_str(src, Cutscene_desc_coords[gr_screen.res][2], Text_line_size, Text_lines, Cutscene_max_text_lines[gr_screen.res]);
786 Assert(Text_size >= 0 && Text_size < Cutscene_max_text_lines[gr_screen.res]);
790 if (Description_index >= 0) {
792 char line[MAX_TEXT_LINE_LEN + 1];
794 gr_set_color_fast(&Color_text_normal);
798 while (y + font_height <= Cutscene_desc_coords[gr_screen.res][3]) {
802 len = Text_line_size[z];
803 if (len > MAX_TEXT_LINE_LEN)
804 len = MAX_TEXT_LINE_LEN;
806 strncpy(line, Text_lines[z], len);
808 gr_string(Cutscene_desc_coords[gr_screen.res][0], Cutscene_desc_coords[gr_screen.res][1] + y, line);