Movies¶
The game plays its movies with RAD's Bink (BINKW32.DLL), their sound through Miles
(BinkSetSoundSystem with BinkOpenMiles). The movies are Bink files (.bik),
in the game's folder and in the discs' archives.
Playing a movie¶
Four functions play a movie in a loop of their own, in xtrabits.cpp:
| Function | Plays | From | Over | At |
|---|---|---|---|---|
play_bink_movie (0x004AB850) |
The intro | The game's folder | A screen cleared to black once | The movie's rate, at full volume (BinkSetVolume, 0x8000) |
play_bink_movie_no_clear (0x004AB6E0) |
The front end's transitions | The game's folder | What the screen last showed | 15 frames a second (BinkSetFrameRate(15, 1) and BINKFRAMERATE) |
play_bink_movie_resourced (0x004ABB80) |
The hangar's, a chapter's zoom, a new pilot's intro | The disc's archive | A screen cleared to black once | The movie's rate, at full volume |
play_bink_movie_no_clear_resourced (0x004AB9D0) |
A chapter's movie and news, the ways of a new pilot's induction, the way into the briefing room | The disc's archive | What the screen last showed | The movie's rate: it sets 15 frames a second without BINKFRAMERATE, which alone has Bink keep to it |
The two that read the disc's archive find the movie in it (hog_locate, 0x004C83F0), by its
whole name whatever its case, and have Bink open it where it lies in the archive's file
(BINKFILEHANDLE, 0x800000).
A pass of the loop (0x004AB7B2) runs the message pump, reads the keyboard and moves the pointer.
Escape, the pointer's right button down, the movie's end (0x005D6C90) or the game quitting
(0x005D60BC) ends it; otherwise, once BinkWait says the next frame is due, bink_frame
(0x004AC510) decodes it (BinkDoFrame), copies it into the middle of the screen
(BinkCopyToBuffer), and moves on to the next (BinkNextFrame), or marks the movie ended at its
last. The message pump pauses the movie while the window is away (BinkPause). A movie that cannot
be opened stops the game with a message (play_bink_movie: error loading %s.).
The video settings' Transitions ([Device], 1 unless set, read at 0x004A9081; Video) turns off the
movies over the screen; those on a cleared screen play whatever it says on a hardware renderer
(sr + 0x1AC). With it off, a chapter's end plays its zoom alone.
The Reliant's rooms, the news report and a new pilot's induction play their movies in loops of their own, from the disc's archive at 15 frames a second whatever the settings, each frame copied to the screen as it is due (The Reliant's rooms). The briefing plays the mission's movie on the briefing room's screen so, at the movie's rate and full volume (Briefing).
The discs' archives¶
cd_hog_open (0x0042FE00) opens a disc's archive, cd1.hog or cd2.hog, in place of the one
open (cd_hog, 0x005202D4): from the disc in the drive (cd_in_drive, 0x004AC6C0), asking for
the other disc where the drive holds the wrong one, or, in a full install, from the installation's
folder, where both lie (Platform). Where the archive
cannot be opened, the game stops with Can't open HOG resource file %s.
Disc 2 holds the Reliant's movies and chapters 1 and 2 with their news; disc 1 the Yamato's, chapters 3 to 5 and the story's end. Both hold the Yamato's hangar and landing, the zooms and the news' transition.
Around a mission¶
WinMain plays the hangar's movie before each mission it flies, and play_landing_movie after it.
The main menu's INSTANT ACTION flies its mission itself, without either, and neither plays where a
lobby launched the game (lobby_launch, 0x00595C64).
The hangar¶
After the briefing, WinMain starts the music fading out by 15 (music_fade_out), stops the
voices (sound_pause_all), and waits a second, in which the timer fades the music out (0x004AA3B2
on). Unverified: that the call it waits with is Sleep: the executable's protection hides its
imports. Then, before the mission's loading, hangar_movie_play (0x004ABD40) opens the
disc of the mission's carrier (The carrier), the Reliant's second or the Yamato's first, and
plays the next of three movies of the pilots readying in its hangar (play_bink_movie_resourced):
the Reliant's, r_h_ta.bik to r_h_tc.bik, or the Yamato's, y_h_ta.bik to y_h_tc.bik. It steps the count on
before each (0x005D6C8C), which WinMain sets to the first as it opens the front end
(0x004A9587), so the second plays first.
The landing¶
WinMain plays play_landing_movie (0x004ABDE0) as a mission ends, but not where the player's
ship was destroyed or the ejected pilot killed or captured, nor where the mission was left from
the pause menu (mission_ending 1, 3 and 4), nor after mission 25's first part, which leads into
its second (Rules by mission number).
It plays nothing after mission 25's second part or mission 27 where the game's variable 36 is
clear, nor where the player's ship was sent home (mission_ending 6 and 7). A mission that ends a
chapter of the story ends in the chapter's end, unless the script rated it a total failure
(mission_success -1); any other mission ends in the landing.
The landing (0x004AC195 on) plays its movie from the disc's archive at 15 frames a second
(BinkOpen with BINKFILEHANDLE and BINKFRAMERATE, 0x801000) at full volume, on a screen
cleared to black; then, unless Escape ended it, the thread's movie, a file of the game's folder
read whole (hog_file_read) and opened in memory (BINKFROMMEMORY, 0x4000000), at its own rate.
Neither movie has sound: the land bank's first sound, from resource.hog, plays over both at
127, once, from the middle (sound_play), and stops as they end (sound_pause_all). Escape ends
each movie; the pointer's right button does not, as the loop moves no pointer.
The movies and the bank follow the carrier and the mission's rating (0x004ABDEC on):
| The Reliant, up to mission 17 | The Yamato, from mission 18 | |
|---|---|---|
| Landing | r_h_land.bik |
yamland_generic.bik |
| Total failure, failure | rthread_d.bik, rlande.fat |
thread04.bik, ylande.fat |
| Partial failure | rthread_d.bik, rlandd.fat |
thread04.bik, ylandd.fat |
| Partial success | rthread_c.bik, rlandc.fat |
thread03.bik, ylandc.fat |
| Success | rthread_b.bik, rlandb.fat |
thread02.bik, ylandb.fat |
| Success with its bonus | rthread_a.bik, rlanda.fat |
thread01.bik, ylanda.fat |
Mission 7 always ends on the Yamato, and mission 8 where the game's variable 32 is clear, each with a failure's thread and bank whatever the rating.
Improvement: OpenReliant takes the landing's carrier, the visits to the Yamato and the missions without a landing once the Yamato is lost from the mission's settings, which start with the original's and which mods can change (Each mission of the campaign, Rules by mission number).
A chapter's end¶
The chapters' table (chapter_of_mission, 0x00509C00, a byte for each of missions 1 to 32) names
the chapter a mission ends: missions 7, 11, 19, 21 and 25 end chapters 1 to 5. A chapter's end
(0x004ABFEE on) opens the chapter's disc, the second before mission 18 and the first from it on,
and plays:
- The zoom,
thread_zoom.bikbefore mission 18 andrthread_zoom.bikfrom it on (play_bink_movie_resourced). - The chapter's movie,
new_chapter1.biktonew_chapter5.bik(chapter_movies,0x00509BE8), with the news' loop, the first sound ofnewsloop.fat, playing over and over at 80 from here to the last report (play_bink_movie_no_clear_resourcedfrom here on). - The news reports the campaign's flags call for, each after the news' transition,
acntran.bik(The campaign's flags).
| After mission | Report | Plays where |
|---|---|---|
| 7 | new_chapter1_thread1.bik |
rameses_alive (18) is other than 1 |
| 11 | new_chapter2_thread1.bik |
czar_alive (29) is other than 1 |
| 11 | new_chapter2_thread2.bik |
krasnaya_alive (17) is other than 1 |
| 11 | new_chapter2_thread3.bik |
nicolai_petrov_alive (6) is other than 1; it then sets chapter2_thread3_shown (34) |
Each attempt at a mission clears variable 34. The function has reports for mission 16 too,
new_chapter3_thread1.bik, new_chapter3_thread2.bik and new_chapter2_thread3.bik, which are
never reached, as mission 16 ends no chapter.
Improvement: OpenReliant takes the chapter a mission ends and the news reports after its movie from the mission's settings, which start with the original's values and which mods can change (Each mission of the campaign). A chapter plays up to 8 reports, where the original's play at most 3.
The co-op loadout plays the same rotating hangar movies before flight. At the end of a mission, the client uses the host's campaign flags and mission rating to choose the return scene, story thread and news reports. A rescued pilot sees the return films as well. The transport keeps running during playback, so a pilot who skips a film can still wait for the rest of the crew.
Co-op loads mission251.dte directly when the host finishes Mission 25's first part with a
result that allows it to continue. WinMain sets mission25_second_part at 0x004A9FA9,
skips briefing and launch at 0x004A9B12, and plays the return sequence after the second
part (0x004A9ED3). The host carries the eligible wing, its loadouts and the shared campaign
flags across the split. Replay starts again with the first part's starting state
(0x004A9AC6).
WinMain calls pickup_count at 0x004A9EFE. A third rescue plays the pilot's transfer
movie and marks that pilot as unable to advance. Replay restores the rescue count from the
start of the attempt. After the last mission, pilots who can advance see the end briefing,
the story films and credits before leaving the campaign (0x004AA027 to 0x004AA037).
How a mission ended¶
After the landing, or where there is none, WinMain plays how a mission of the campaign ended
from the archive of the disc open, the mission's carrier's, on a cleared screen
(play_bink_movie_resourced), then turns to the restart screen or the main menu
(After a mission). The movies are the mission's carrier's
(The carrier):
| Ending | The Reliant | The Yamato | Then |
|---|---|---|---|
| The player's ship destroyed, or the ejected pilot killed: the funeral | new_funeral.bik |
new_funeral2.bik |
The restart screen |
| The ejected pilot captured: the pilot in the enemy's hands | int.bik |
int.bik |
The restart screen |
| Sent home for destroying a friend: the pilot's execution | new_rel_exec.bik |
new_y_exec.bik |
The restart screen |
| Picked up by a nanny ship the third time: the pilot's transfer | new_reliant_transfer.bik |
new_a y trans.bik |
The main menu |
| A total failure: the pilot's transfer | new_reliant_transfer.bik where reliant_alive (32) is set, else new_a y trans.bik |
new_a y trans.bik |
The main menu |
After missions 25 and 27, where yamato_alive (36) is clear, a total failure plays the shuttle at Fort
Bear, fortbearshuttle_.bik, in the transfer's place (0x004AA5E0). Each movie lies on its
carrier's disc, and int.bik and new_a y trans.bik on both.
A mission that awards a medal (medal_of_mission, 0x005009BB) plays its ceremony from the disc
as the mission's end is recorded, where the script rated it a success with its bonus and no nanny
ship picked the pilot up (mission_end_record, 0x00475B57 on), before the ITAC:
| After mission | Medal | Ceremony |
|---|---|---|
| 6 | 1 | new_silver.bik |
| 11 | 2 | new_black eagle.bik |
| 16 | 3 | new_valour.bik |
| 21 | 4 | new_legion.bik |
| 23 | 5 | new_navy_cross.bik |
| 27 | 6 | new_medal_of_honour.bik |
Improvement: OpenReliant takes each mission's medal from the mission's settings, which start
with the original's values and which mods can change (Each mission of the campaign). Scripts can also choose each of these movies, or none, with the hooks mission_lost, career_over and medal_ceremony (Hooks). A movie a hook chooses plays from a mod or from either disc's archive: where the archive open doesn't hold it, the other disc's opens for it, and the first opens again after it (Movies.playChosen).
The story's end¶
As mission 28 is won, the campaign moves on to mission 29, the story's end. WinMain runs mission
29's briefing (The campaign's end), then the story's end
(ending_movies_play, 0x004AC620) from the first disc's archive, which alone holds its movies:
new_chapter6_thread1.bikon a cleared screen (play_bink_movie_resourced).- The news reports the campaign's flags call for, each after
acntran.bik, over the screen (play_bink_movie_no_clear_resourced):
| Report | Plays where |
|---|---|
new_chapter6_thread2.bik |
kulov_alive (8) is other than 1 |
new_chapter6_thread3.bik |
ivan_petrov_alive (7) is other than 1 |
new_chapter6_thread5.bik |
steiner_alive (13) is 1 |
new_chapter6_thread4.bik |
steiner_alive (13) is other than 1 |
acntran.bikandnew_chapter6.bik, over the screen.- The credits (
credits_play,0x004AC780).
Then WinMain puts the campaign back at mission 1 (0x004AA6FC) and goes back to the main menu.
The credits show eight pages over credits.spr's pictures, to music\new_sim07.wav played over
and over at level 127. Each page is a picture drawn through its own palette, and the developers' names,
strings of the game's, in the menus' small font: the headings orange (0xFF7E00), the names white,
each at its place or centred across the screen (credits_lines, 0x0050A180). A page fades in by
0.03 at a time, up to full, and stays until 750 game ticks have passed since it began; it then
fades out by 0.03 at a time over 150 ticks, the palette and the text alike (credits_brightness,
0x005D6B34), and gives way to the next. Escape ends the credits. Then the music fades out by 15
every five ticks (music_fade_out), and the credits end once it has stopped.
| Page | Picture | Palette |
|---|---|---|
| 1, 6 | 1 | 0 |
| 2, 7 | 3 | 2 |
| 3 | 5 | 4 |
| 4 | 7 | 6 |
| 5 | 9 | 8 |
| 8 | 11 | 10 |
Improvement: the game fades a page by a step each frame, so that the credits fade the faster the higher the frame rate. OpenReliant takes a step for each of the simulation's steps, 25 a second, as the game does at 25 frames a second.
In a mission¶
A mission's script asks for Foster's last stand, the Reliant's destruction, with
PlayFostersLastStand (0x00459740), which mission 18 runs. The targeting keys' next pass
(hud_target_keys, 0x0048C31B on) pauses the game, which stops its ticks and the script's
clock, pauses the music, the voices and the 3D voices, and stops the line the radio says, where it
says one. It plays foster.bik from the disc's archive open (play_bink_movie_resourced), and
outside its software renderer switches to 640 by 480 for the movie and back. Then the line, the 3D
voices, the voices and the music go on, and the game with them.
OpenReliant's driver plays it once the frame's controls have run (hud.MovieHold). With
--mission, which flies the mission without the hangar's movie, no disc's archive is open yet, so
the movie opens the disc of the mission's carrier.
In co-op the host holds the mission tick at the cue. Each client plays the same movie while the network keeps running. The host resumes when all connected pilots have finished or skipped it, with a two-minute wall-clock limit if a client stalls.
The movies played¶
- As the renderer first starts, before its loading screens,
renderer_loadplays the intro:new_nms.bik,new_dalogo_fs_uncmpr.bikandwarty_.bik, from the game's folder. - As
WinMainopens the front end,0x004AB6A0playssplash to mm.bik, the splash turning into the main menu. - The front end's screens play their transitions from its
interfacefolder as they lead from one to another: SINGLE PLAYERmain2sin.bik, MULTI PLAYERmain2mul.bikand GAME OPTIONSmain2opt.bikfrom the main menu; the pilot roster's MAIN MENU and Escapesin2main.bik, and LOAD GAMEsinfade.bik. - As START GAME starts a campaign,
WinMainplays a new pilot's intro,new_intro.bik, before mission 1's induction, and the ways from where the induction ended; the in-game options' MAIN MENU playsinterface\igo2mm.bikbefore the main menu (The Reliant's rooms). - Around each mission
WinMainflies, the hangar's movie, the landing or a chapter's end, and how the mission ended or a medal's ceremony (Around a mission). - In mission 18, Foster's last stand,
foster.bik, as its script asks (In a mission). - The ITAC plays its own in its loop, its sections' movies in and out, and on the Reliant the pilot's
eye read. VIDEO REPORTS plays a report's movie again from its disc's archive on a cleared screen,
such as
new_intro.bikorfoster.bik(The ITAC).
In OpenReliant¶
engine/bink.zig stands in for Bink, each function for the call it
names; engine/bink/picture.zig turns a decoded picture into
colours, by BT.601 in its limited range, or by what a mod's movie says: BT.709, or the full range.
It reads the container itself and hands the packets to a Codec: FFmpeg's decoders, in the
platform (Platform). It decodes a movie's sound whole as the movie
opens and plays it as a Miles stream, where Bink fills a Miles sample as it plays; the sound starts
with the first frame, and OpenAL Soft resamples it as it resamples every sound
(Sound).
game/xtrabits/movie.zig holds the game's players, one
Kind each and one for the landing's loop, bink_frame, and the hangar's movies;
game/xtrabits/landing.zig decides what
play_landing_movie plays. game/interface/disc.zig
opens the discs' archives as a full install does, from the game's folder, where openreliant
install copies both. The driver runs the loops (openreliant/movies.zig),
each frame drawn over an empty scene and put on the window, the window's messages read as the
message pump reads them.
The intro, the splash's movie and the transitions of the screens ported play as the game plays
them; a mission --mission names, or a screenshot, starts without the intro. A mission the front
end starts, all but INSTANT ACTION's, fades the music out over a second and plays the hangar's
movie before its loading screen, and as it ends the landing or a chapter's end, and how it ended
or a medal's ceremony; LEAVE MISSION leaves it without the landing. A movie that is missing, or
that cannot be decoded, is left out, and the game goes on, as it does without a disc's archive or
a bank.
Fixes:
- For a rating past the named ones, the game takes whatever its stack holds for the thread's movie and the bank. OpenReliant lands without them.
- Past the chapters' table, the game reads a mission's chapter from what follows the table. OpenReliant ends no chapter there.
- The pointer's right button ends a movie only once it has come up since the movie began. The game ends one while the button is down, so that the press that skipped what came before, still held, ends it at once.
Improvements, each left out under --original:
- The steps at the edges of the 8 by 8 blocks Bink codes a picture in are smoothed where they are small (up to 12 levels) and the levels either side are even (within 3): the blocks that show in a dark or flat area once a movie is drawn large, as in the front end's transitions. Where three levels either side are even, the step is spread over the four nearest it, as H.264's strong filter spreads one; otherwise the two at the edge are brought nearer. Steps past that are edges in the picture, and stay.
- Each pixel's colour is blended from the four nearest samples of the half-size colour planes, three quarters of the nearer and a quarter of the farther each way, where Bink gives a 2 by 2 block of pixels one colour, which shows as steps along a coloured edge.
- A movie is drawn as large as fits in the window, as the front end is, keeping its shape, so that
a 16:9 movie fills a wide window.
--originaldraws it at its size in the middle of the front end's screen, as the game draws it on a screen 640 by 480. - On the GPU, a movie is magnified with FSR 1's edge-adaptive upscale (EASU, from AMD's FidelityFX Super Resolution 1.0), which keeps its edges sharp without steps (Renderer).
Improvement: a mod can give a movie in WebM or Matroska, of VP9 video with Opus or Vorbis sound,
in place of a Bink movie (Movies, Matroska and WebM
files). For the movie name.bik, a mod's name.webm comes first, then
its name.mkv, then the Bink movie, a mod's or the game's. Its frames show at their own times,
unless the movie's kind sets a rate in place of its own, as the transitions' and the rooms' 15
frames a second do. It is drawn in the place and at the size of the Bink movie it replaces, which
OpenReliant reads from that movie's header, or at its own size where there is none. Like other
mods' files, it is used under --original too. The deblocking above passes it by, as VP9 filters
the edges of its own blocks. One that can't be played, such as one of AV1 video
(#1334), is left out with a message in
the log, and the Bink movie plays.
Not ported: the transitions of the multiplayer screens (#404).