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.5 2002/06/09 04:41:15 relnev
19 * added copyright header
21 * Revision 1.4 2002/06/02 04:26:34 relnev
24 * Revision 1.3 2002/05/26 22:06:17 relnev
25 * makefile: disable stand_gui for now.
27 * rest: staticize some globals
29 * Revision 1.2 2002/05/07 03:16:43 theoddone33
30 * The Great Newline Fix
32 * Revision 1.1.1.1 2002/05/03 03:28:08 root
36 * 15 6/16/00 3:15p Jefff
37 * sim of the year dvd version changes, a few german soty localization
40 * 14 10/13/99 10:20a Jefff
41 * fixed bug where intro cutscene showed 2x after getting bad ending
43 * 13 10/06/99 10:30a Jefff
46 * 12 9/30/99 6:01p Jefff
49 * 11 9/07/99 1:10p Mikek
50 * Make movie check not hang in ~RELEASE_REAL build.
52 * 10 9/06/99 6:38p Dave
53 * Improved CD detection code.
55 * 9 9/06/99 1:16a Dave
56 * Make sure the user sees the intro movie.
58 * 8 9/03/99 1:31a Dave
59 * CD checking by act. Added support to play 2 cutscenes in a row
60 * seamlessly. Fixed super low level cfile bug related to files in the
61 * root directory of a CD. Added cheat code to set campaign mission # in
64 * 7 7/19/99 2:13p Dave
65 * Added some new strings for Heiko.
67 * 6 6/01/99 3:52p Dave
68 * View footage screen. Fixed xstrings to not display the & symbol. Popup,
69 * dead popup, pxo find player popup, pxo private room popup.
71 * 5 1/30/99 5:08p Dave
72 * More new hi-res stuff.Support for nice D3D textures.
74 * 4 10/23/98 3:51p Dave
75 * Full support for tstrings.tbl and foreign languages. All that remains
76 * is to make it active in Fred.
78 * 3 10/13/98 9:28a Dave
79 * Started neatening up freespace.h. Many variables renamed and
80 * reorganized. Added AlphaColors.[h,cpp]
82 * 2 10/07/98 10:52a Dave
85 * 1 10/07/98 10:48a Dave
87 * 18 6/09/98 10:31a Hoffoss
88 * Created index numbers for all xstr() references. Any new xstr() stuff
89 * added from here on out should be added to the end if the list. The
90 * current list count can be found in FreeSpace.cpp (search for
93 * 17 6/01/98 11:43a John
94 * JAS & MK: Classified all strings for localization.
96 * 16 5/24/98 9:01p Lawrance
97 * Add commit sounds when accept is pressed
99 * 15 5/21/98 8:05p Allender
100 * fix possible bug with number of cutscenes shown in the list
102 * 14 5/21/98 12:35a Lawrance
103 * Tweak how CD is checked for
105 * 13 5/20/98 1:34p Hoffoss
106 * Added cutscene description rendering.
108 * 12 5/19/98 12:19p Mike
111 * 11 5/12/98 4:17p Hoffoss
112 * Make ctrl-arrows (up/down) switch between tech room screens.
114 * 10 5/11/98 8:04p Hoffoss
117 * 9 5/10/98 10:05p Allender
118 * only show cutscenes which have been seen before. Made Fred able to
119 * write missions anywhere, defaulting to player misison folder, not data
120 * mission folder. Fix FreeSpace code to properly read missions from
123 * 8 5/08/98 5:30p Lawrance
124 * add CD checks for movie playing
126 * 7 5/08/98 4:07p Allender
127 * more cutscene stuff
129 * 6 5/07/98 2:33p Hoffoss
130 * Removed help and options buttons.
132 * 5 4/30/98 4:53p John
133 * Restructured and cleaned up cfile code. Added capability to read off
134 * of CD-ROM drive and out of multiple pack files.
136 * 4 4/23/98 8:27p Allender
137 * basic support for cutscene playback. Into movie code in place. Tech
138 * room can view cutscenes stored in CDROM_dir variable
140 * 3 4/21/98 7:07p Hoffoss
141 * Fixed problem where when switching screens flashes old tab hilight once
142 * before switching to new state.
144 * 2 4/17/98 6:33p Hoffoss
145 * Made changes to the tech room group of screens. Cutscenes screen is
151 #include "cutscenes.h"
155 #include "gamesequence.h"
156 #include "freespace.h"
159 // #include "movie.h"
161 #include "mainhallmenu.h"
162 #include "alphacolors.h"
163 #include "localize.h"
165 char *Cutscene_bitmap_name[GR_NUM_RESOLUTIONS] = {
169 char *Cutscene_mask_name[GR_NUM_RESOLUTIONS] = {
175 int Cutscenes_viewable;
176 int Description_index;
177 cutscene_info Cutscenes[MAX_CUTSCENES];
179 extern int All_movies_enabled; // If set, all movies may be viewed. Keyed off cheat code.
181 // initialization stuff for cutscenes
184 char buf[MULTITEXT_LENGTH];
187 if ((rval = setjmp(parse_abort)) != 0) {
188 Error(LOCATION, "Error parsing 'rank.tbl'\r\nError code = %i.\r\n", rval);
194 read_file_text("cutscenes.tbl");
197 // parse in all the rank names
199 skip_to_string("#Cutscenes");
200 ignore_white_space();
201 while ( required_string_either("#End", "$Filename:") ) {
202 Assert ( Num_cutscenes < MAX_CUTSCENES );
203 required_string("$Filename:");
204 stuff_string( Cutscenes[Num_cutscenes].filename, F_PATHNAME, NULL );
205 required_string("$Name:");
206 stuff_string( Cutscenes[Num_cutscenes].name, F_NAME, NULL );
207 required_string("$Description:");
208 stuff_string(buf, F_MULTITEXT, NULL);
209 drop_white_space(buf);
210 compact_multitext_string(buf);
211 Cutscenes[Num_cutscenes].description = strdup(buf);
212 required_string("$cd:");
213 stuff_int( &Cutscenes[Num_cutscenes].cd );
218 required_string("#End");
220 Cutscenes_viewable = INTRO_CUTSCENE_FLAG;
222 // close localization
226 // function to return 0 based index of which CD a particular movie is on
227 // returns -1 on failure.
228 int cutscenes_get_cd_num( char *filename )
230 #if defined(OEM_BUILD)
231 return 0; // only 1 cd for OEM
235 for (i = 0; i < Num_cutscenes; i++ ) {
236 if ( !stricmp(Cutscenes[i].filename, filename) ) {
237 return (Cutscenes[i].cd - 1);
242 #endif // defined(OEM_BUILD)
245 // marks a cutscene as viewable
246 void cutscene_mark_viewable(char *filename)
250 for (i = 0; i < Num_cutscenes; i++ ) {
251 if ( !stricmp(Cutscenes[i].filename, filename) ) {
252 Cutscenes_viewable |= (1<<i);
258 #define NUM_BUTTONS 8
260 #define TECH_DATABASE_BUTTON 0
261 #define SIMULATOR_BUTTON 1
262 #define CUTSCENES_BUTTON 2
263 #define CREDITS_BUTTON 3
265 #define SCROLL_UP_BUTTON 4
266 #define SCROLL_DOWN_BUTTON 5
267 #define PLAY_BUTTON 6
268 #define EXIT_BUTTON 7
270 static int Num_files;
271 static int Cutscene_list[MAX_CUTSCENES];
272 static int Selected_line = 0; // line that is currently selected for binding
273 static int Scroll_offset;
274 static int Background_bitmap;
275 static UI_BUTTON List_region;
276 static UI_WINDOW Ui_window;
278 static ui_button_info Buttons[GR_NUM_RESOLUTIONS][NUM_BUTTONS] = {
280 ui_button_info("TDB_00", 7, 5, 37, 7, 0), // tech database 1
281 ui_button_info("TDB_01", 7, 19, 37, 23, 1), // tech database 2
282 ui_button_info("TDB_02", 7, 34, 37, 38, 2), // tech database 3
283 ui_button_info("TDB_03", 7, 49, 37, 54, 3), // tech database 4
285 ui_button_info("VFB_04", 6, 318, -1, -1, 4), // scroll up
286 ui_button_info("VFB_05", 36, 318, -1, -1, 5), // scroll down
287 ui_button_info("VFB_06", 578, 319, 587, 366, 6), // play
288 ui_button_info("VFB_07", 574, 431, 587, 413, 7), // exit
291 ui_button_info("2_TDB_00", 12, 7, 59, 12, 0), // tech database 1
292 ui_button_info("2_TDB_01", 12, 31, 59, 37, 1), // tech database 2
293 ui_button_info("2_TDB_02", 12, 56, 59, 62, 2), // tech database 3
294 ui_button_info("2_TDB_03", 12, 81, 59, 88, 3), // tech database 4
296 ui_button_info("2_VFB_04", 9, 509, -1, -1, 4), // scroll up
297 ui_button_info("2_VFB_05", 58, 509, -1, -1, 5), // scroll down
298 ui_button_info("2_VFB_06", 925, 511, 940, 586, 6), // play
299 ui_button_info("2_VFB_07", 918, 689, 940, 661, 7), // exit
304 #define NUM_CUTSCENE_TEXT 6
305 UI_XSTR Cutscene_text[GR_NUM_RESOLUTIONS][NUM_CUTSCENE_TEXT] = {
307 {"Technical Database", 1055, 37, 7, UI_XSTR_COLOR_GREEN, -1, &Buttons[0][TECH_DATABASE_BUTTON].button },
308 {"Mission Simulator", 1056, 37, 23, UI_XSTR_COLOR_GREEN, -1, &Buttons[0][SIMULATOR_BUTTON].button },
309 {"Cutscenes", 1057, 37, 38, UI_XSTR_COLOR_GREEN, -1, &Buttons[0][CUTSCENES_BUTTON].button },
310 {"Credits", 1058, 37, 54, UI_XSTR_COLOR_GREEN, -1, &Buttons[0][CREDITS_BUTTON].button },
312 {"Play", 1335, 587, 366, UI_XSTR_COLOR_GREEN, -1, &Buttons[0][PLAY_BUTTON].button },
313 {"Exit", 1419, 587, 413, UI_XSTR_COLOR_PINK, -1, &Buttons[0][EXIT_BUTTON].button },
316 {"Technical Database", 1055, 59, 12, UI_XSTR_COLOR_GREEN, -1, &Buttons[1][TECH_DATABASE_BUTTON].button },
317 {"Mission Simulator", 1056, 59, 37, UI_XSTR_COLOR_GREEN, -1, &Buttons[1][SIMULATOR_BUTTON].button },
318 {"Cutscenes", 1057, 59, 62, UI_XSTR_COLOR_GREEN, -1, &Buttons[1][CUTSCENES_BUTTON].button },
319 {"Credits", 1058, 59, 88, UI_XSTR_COLOR_GREEN, -1, &Buttons[1][CREDITS_BUTTON].button },
321 {"Play", 1335, 940, 586, UI_XSTR_COLOR_GREEN, -1, &Buttons[1][PLAY_BUTTON].button },
322 {"Exit", 1419, 940, 661, UI_XSTR_COLOR_PINK, -1, &Buttons[1][EXIT_BUTTON].button },
326 int Cutscene_list_coords[GR_NUM_RESOLUTIONS][4] = {
335 int Cutscene_desc_coords[GR_NUM_RESOLUTIONS][4] = {
344 #define MAX_TEXT_LINES 20
345 int Cutscene_max_text_lines[GR_NUM_RESOLUTIONS] = {
349 #define MAX_TEXT_LINE_LEN 256
351 static int Text_size;
352 static int Text_offset = 0;
353 static int Text_line_size[MAX_TEXT_LINES];
354 static char *Text_lines[MAX_TEXT_LINES];
357 int cutscenes_validate_cd(char *mve_name, int prompt_for_cd)
362 char volume_name[128];
365 int num_attempts = 0;
371 cd_mve_is_on = cutscenes_get_cd_num(mve_name);
372 if ((cd_mve_is_on != 0) && (cd_mve_is_on != 1) && (cd_mve_is_on != 2)) {
377 #if defined(OEM_BUILD)
378 sprintf(volume_name, NOX("FS2_OEM"));
380 sprintf(volume_name, NOX("FREESPACE2_%c"), '1' + cd_mve_is_on);
384 cd_drive_num = find_freespace_cd(volume_name);
385 path_set_ok = set_cdrom_path(cd_drive_num);
393 if ( !prompt_for_cd ) {
398 // no CD found, so prompt user
402 #if defined(DVD_MESSAGE_HACK)
403 sprintf(popup_msg, XSTR( "Movie not found\n\nInsert FreeSpace DVD to continue", 203));
405 sprintf(popup_msg, XSTR( "Movie not found\n\nInsert FreeSpace CD #%d to continue", 203), cd_mve_is_on+1);
408 popup_rval = popup(PF_BODY_BIG, 2, POPUP_CANCEL, POPUP_OK, popup_msg);
409 if ( popup_rval != 1 ) {
414 if ( num_attempts++ > 5 ) {
428 void cutscenes_screen_play()
430 char name[MAX_FILENAME_LEN], *full_name;
433 Assert( (Selected_line >= 0) && (Selected_line < Num_files) );
434 which_cutscene = Cutscene_list[Selected_line];
436 strcpy(name, Cutscenes[which_cutscene].filename );
437 full_name = cf_add_ext(name, NOX(".mve"));
441 int rval = movie_play(full_name);
445 sprintf(str, XSTR( "Unable to play movie %s.", 204), Cutscenes[which_cutscene].name );
446 popup(0, 1, POPUP_OK, str );
451 void cutscenes_screen_scroll_line_up()
455 gamesnd_play_iface(SND_SCROLL);
458 gamesnd_play_iface(SND_GENERAL_FAIL);
460 if (Selected_line < Scroll_offset)
461 Scroll_offset = Selected_line;
464 void cutscenes_screen_scroll_line_down()
468 if (Selected_line < Num_files - 1) {
470 gamesnd_play_iface(SND_SCROLL);
473 gamesnd_play_iface(SND_GENERAL_FAIL);
475 h = Cutscene_list_coords[gr_screen.res][3] / gr_get_font_height();
476 if (Selected_line >= Scroll_offset + h){
481 void cutscenes_screen_scroll_screen_up()
487 Assert(Selected_line > Scroll_offset);
488 h = Cutscene_list_coords[gr_screen.res][3] / gr_get_font_height();
489 while (Selected_line >= Scroll_offset + h){
493 gamesnd_play_iface(SND_SCROLL);
496 gamesnd_play_iface(SND_GENERAL_FAIL);
500 void cutscenes_screen_scroll_screen_down()
504 h = Cutscene_list_coords[gr_screen.res][3] / gr_get_font_height();
505 if (Scroll_offset + h < Num_files) {
507 if (Selected_line < Scroll_offset){
508 Selected_line = Scroll_offset;
511 gamesnd_play_iface(SND_SCROLL);
513 gamesnd_play_iface(SND_GENERAL_FAIL);
517 int cutscenes_screen_button_pressed(int n)
520 case TECH_DATABASE_BUTTON:
521 gamesnd_play_iface(SND_SWITCH_SCREENS);
522 gameseq_post_event(GS_EVENT_TECH_MENU);
525 case SIMULATOR_BUTTON:
526 gamesnd_play_iface(SND_SWITCH_SCREENS);
527 gameseq_post_event(GS_EVENT_SIMULATOR_ROOM);
531 gamesnd_play_iface(SND_SWITCH_SCREENS);
532 gameseq_post_event(GS_EVENT_CREDITS);
535 case SCROLL_UP_BUTTON:
536 cutscenes_screen_scroll_screen_up();
539 case SCROLL_DOWN_BUTTON:
540 cutscenes_screen_scroll_screen_down();
544 cutscenes_screen_play();
548 gamesnd_play_iface(SND_COMMIT_PRESSED);
549 gameseq_post_event(GS_EVENT_MAIN_MENU);
557 void cutscenes_screen_init()
562 Ui_window.create(0, 0, gr_screen.max_w, gr_screen.max_h, 0);
563 Ui_window.set_mask_bmap(Cutscene_mask_name[gr_screen.res]);
565 for (i=0; i<NUM_BUTTONS; i++) {
566 b = &Buttons[gr_screen.res][i];
568 b->button.create(&Ui_window, "", b->x, b->y, 60, 30, (i < 2), 1);
569 // set up callback for when a mouse first goes over a button
570 b->button.set_highlight_action(common_play_highlight_sound);
571 b->button.set_bmaps(b->filename);
572 b->button.link_hotspot(b->hotspot);
576 for(i=0; i<NUM_CUTSCENE_TEXT; i++){
577 Ui_window.add_XSTR(&Cutscene_text[gr_screen.res][i]);
580 Buttons[gr_screen.res][EXIT_BUTTON].button.set_hotkey(KEY_CTRLED | KEY_ENTER);
581 Buttons[gr_screen.res][SCROLL_UP_BUTTON].button.set_hotkey(KEY_PAGEUP);
582 Buttons[gr_screen.res][SCROLL_DOWN_BUTTON].button.set_hotkey(KEY_PAGEDOWN);
584 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);
587 // set up hotkeys for buttons so we draw the correct animation frame when a key is pressed
588 Buttons[gr_screen.res][SCROLL_UP_BUTTON].button.set_hotkey(KEY_PAGEUP);
589 Buttons[gr_screen.res][SCROLL_DOWN_BUTTON].button.set_hotkey(KEY_PAGEDOWN);
591 Background_bitmap = bm_load(Cutscene_bitmap_name[gr_screen.res]);
592 Scroll_offset = Selected_line = 0;
593 Description_index = -1;
595 // when doing a debug version, just put all of the movie files here.
597 //Cutscenes_viewable = 0xffffffff; // makes all cutscenes viewble.
600 if (All_movies_enabled)
601 Cutscenes_viewable = 0xffffffff; // Cheat code enables all movies.
604 for ( i = 0; i < Num_cutscenes; i++ ) {
605 if ( Cutscenes_viewable & (1<<i) ) {
606 Cutscene_list[Num_files] = i;
612 void cutscenes_screen_close()
614 if (Background_bitmap)
615 bm_unload(Background_bitmap);
620 void cutscenes_screen_do_frame()
623 int font_height = gr_get_font_height();
624 int select_tease_line = -1;
626 k = Ui_window.process();
628 case KEY_DOWN: // select next line
629 cutscenes_screen_scroll_line_down();
632 case KEY_UP: // select previous line
633 cutscenes_screen_scroll_line_up();
637 case KEY_CTRLED | KEY_DOWN:
638 cutscenes_screen_button_pressed(CREDITS_BUTTON);
641 case KEY_SHIFTED | KEY_TAB:
642 case KEY_CTRLED | KEY_UP:
643 cutscenes_screen_button_pressed(SIMULATOR_BUTTON);
647 cutscenes_screen_play();
650 case KEY_ESC: // cancel
651 gameseq_post_event(GS_EVENT_MAIN_MENU);
655 case KEY_F1: // show help overlay
658 case KEY_F2: // goto options screen
659 gameseq_post_event(GS_EVENT_OPTIONS_MENU);
663 for (i=0; i<NUM_BUTTONS; i++){
664 if (Buttons[gr_screen.res][i].button.pressed()){
665 if (cutscenes_screen_button_pressed(i)){
671 if (List_region.button_down()) {
672 List_region.get_mouse_pos(NULL, &y);
673 z = Scroll_offset + y / font_height;
674 if ((z >= 0) && (z < Num_files))
675 select_tease_line = z;
678 if (List_region.pressed()) {
679 List_region.get_mouse_pos(NULL, &y);
680 z = Scroll_offset + y / font_height;
681 if ((z >= 0) && (z < Num_files))
685 GR_MAYBE_CLEAR_RES(Background_bitmap);
686 if (Background_bitmap >= 0) {
687 gr_set_bitmap(Background_bitmap);
693 for (i=TECH_DATABASE_BUTTON; i<=CREDITS_BUTTON; i++){
694 if (Buttons[gr_screen.res][i].button.button_down()){
699 if (i > CREDITS_BUTTON){
700 Buttons[gr_screen.res][CUTSCENES_BUTTON].button.draw_forced(2);
705 while (y + font_height <= Cutscene_list_coords[gr_screen.res][3]) {
710 if (z == Selected_line){
711 gr_set_color_fast(&Color_text_selected);
712 } else if (z == select_tease_line) {
713 gr_set_color_fast(&Color_text_subselected);
715 gr_set_color_fast(&Color_text_normal);
718 gr_printf(Cutscene_list_coords[gr_screen.res][0], Cutscene_list_coords[gr_screen.res][1] + y, Cutscenes[Cutscene_list[z]].name);
724 if (Description_index != Selected_line) {
727 Description_index = Selected_line;
729 src = Cutscenes[Cutscene_list[Description_index]].description;
731 Text_size = split_str(src, Cutscene_desc_coords[gr_screen.res][2], Text_line_size, Text_lines, Cutscene_max_text_lines[gr_screen.res]);
732 Assert(Text_size >= 0 && Text_size < Cutscene_max_text_lines[gr_screen.res]);
736 if (Description_index >= 0) {
738 char line[MAX_TEXT_LINE_LEN + 1];
740 gr_set_color_fast(&Color_text_normal);
744 while (y + font_height <= Cutscene_desc_coords[gr_screen.res][3]) {
748 len = Text_line_size[z];
749 if (len > MAX_TEXT_LINE_LEN)
750 len = MAX_TEXT_LINE_LEN;
752 strncpy(line, Text_lines[z], len);
754 gr_string(Cutscene_desc_coords[gr_screen.res][0], Cutscene_desc_coords[gr_screen.res][1] + y, line);