Skip to content

refactor(loadscreen): Refactor the single player load screen to use TheDisplay for intro video playback #2273

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Mauller wants to merge 2 commits into
base: main
Choose a base branch
from
Open

refactor(loadscreen): Refactor the single player load screen to use TheDisplay for intro video playback #2273

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
df5756a
refactor(display): Add the ability to use internal buffers in TheDisp…
Mauller Feb 8, 2026
53ae2e5
refactor(loadscreen): Use TheDisplay for video playback of single pla…
Mauller Feb 8, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 4 additions & 2 deletions GeneralsMD/Code/GameEngine/Include/GameClient/Display.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -143,13 +143,15 @@ class Display : public SubsystemInterface

/// draw a video buffer fit within the screen coordinates
virtual void drawScaledVideoBuffer( VideoBuffer *buffer, VideoStreamInterface *stream ) = 0;
virtual void drawVideoBuffer( VideoBuffer *buffer, Int startX, Int startY,
Int endX, Int endY ) = 0;
virtual void drawScaledVideoBuffer() = 0;
virtual void drawVideoBuffer( VideoBuffer *buffer, Int startX, Int startY, Int endX, Int endY ) = 0;
virtual void drawVideoBuffer(Int startX, Int startY, Int endX, Int endY) = 0;

/// FullScreen video playback
virtual void playLogoMovie( AsciiString movieName, Int minMovieLength, Int minCopyrightLength );
virtual void playMovie( AsciiString movieName );
virtual void stopMovie( void );
virtual Real getMovieProgress(); ///< returns the playback progress in the range 0.0 to 1.0
virtual Bool isMoviePlaying(void);

/// Register debug display callback
Expand Down
3 changes: 0 additions & 3 deletions GeneralsMD/Code/GameEngine/Include/GameClient/LoadScreen.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -110,9 +110,6 @@ class SinglePlayerLoadScreen : public LoadScreen

UnicodeString m_unicodeObjectiveLines[MAX_OBJECTIVE_LINES];

VideoBuffer *m_videoBuffer;
VideoStreamInterface *m_videoStream;

void moveWindows( Int frame );

AudioEventRTS m_ambientLoop;
Expand Down
9 changes: 9 additions & 0 deletions GeneralsMD/Code/GameEngine/Source/GameClient/Display.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -360,6 +360,15 @@ void Display::reset()
v->reset();
}

//============================================================================
// Display::getMovieProgress
//============================================================================

Real Display::getMovieProgress()
{
return m_videoStream ? (Real)m_videoStream->frameIndex() / (Real)m_videoStream->frameCount() : 0.0f;
}

//============================================================================
// Display::isMoviePlaying
//============================================================================
Expand Down
100 changes: 27 additions & 73 deletions GeneralsMD/Code/GameEngine/Source/GameClient/GUI/LoadScreen.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -182,8 +182,6 @@ SinglePlayerLoadScreen::SinglePlayerLoadScreen( void )
m_currentObjectiveWidthOffset = 0;
m_progressBar = nullptr;
m_percent = nullptr;
m_videoStream = nullptr;
m_videoBuffer = nullptr;
m_objectiveWin = nullptr;
for(Int i = 0; i < MAX_OBJECTIVE_LINES; ++i)
m_objectiveLines[i] = nullptr;
Expand All @@ -198,15 +196,6 @@ SinglePlayerLoadScreen::~SinglePlayerLoadScreen( void )
for(Int i = 0; i < MAX_OBJECTIVE_LINES; ++i)
m_objectiveLines[i] = nullptr;

delete m_videoBuffer;
m_videoBuffer = nullptr;

if ( m_videoStream )
{
m_videoStream->close();
m_videoStream = nullptr;
}

TheAudio->removeAudioEvent( m_ambientLoopHandle );
m_ambientLoopHandle = 0;

Expand Down Expand Up @@ -476,32 +465,6 @@ void SinglePlayerLoadScreen::init( GameInfo *game )

*/
m_ambientLoop.setEventName("LoadScreenAmbient");
// create the new stream
m_videoStream = TheVideoPlayer->open( TheCampaignManager->getCurrentMission()->m_movieLabel );
if ( m_videoStream == nullptr )
{
m_percent->winHide(TRUE);
return;
}

// Create the new buffer
m_videoBuffer = TheDisplay->createVideoBuffer();
if ( m_videoBuffer == nullptr ||
!m_videoBuffer->allocate( m_videoStream->width(),
m_videoStream->height())
)
{
delete m_videoBuffer;
m_videoBuffer = nullptr;

if ( m_videoStream )
{
m_videoStream->close();
m_videoStream = nullptr;
}

return;
}

// format the progress bar: USA to blue, GLA to green, China to red
// and set the background image
Expand Down Expand Up @@ -530,9 +493,16 @@ void SinglePlayerLoadScreen::init( GameInfo *game )
// TheSuperHackers @bugfix Originally this movie render loop stopped rendering when the game window was inactive.
// This either skipped the movie or caused decompression artifacts. Now the video just keeps playing until it done.

Int progressUpdateCount = m_videoStream->frameCount() / FRAME_FUDGE_ADD;
Int shiftedPercent = -FRAME_FUDGE_ADD + 1;
while (m_videoStream->frameIndex() < m_videoStream->frameCount() - 1 )
// Hide the background window while the movie is playing
backgroundWin->winEnable(false);

// Show video progress bar
m_progressBar->winEnable(true);

// TheSuperHackers @info We now make use of movie playback within the display object
TheDisplay->playMovie(TheCampaignManager->getCurrentMission()->m_movieLabel);

while(TheDisplay->isMoviePlaying())
{
// TheSuperHackers @feature User can now skip video by pressing ESC
if (TheKeyboard)
Expand All @@ -548,51 +518,31 @@ void SinglePlayerLoadScreen::init( GameInfo *game )

TheGameEngine->serviceWindowsOS();

if(!m_videoStream->isFrameReady())
{
Sleep(1);
continue;
}

m_videoStream->frameDecompress();
m_videoStream->frameRender(m_videoBuffer);

// PULLED FROM THE MISSION DISK
// moveWindows( m_videoStream->frameIndex());

m_videoStream->frameNext();

if(m_videoBuffer)
m_loadScreen->winGetInstanceData()->setVideoBuffer(m_videoBuffer);
if(m_videoStream->frameIndex() % progressUpdateCount == 0)
{
shiftedPercent++;
if(shiftedPercent >0)
shiftedPercent = 0;
Int percent = (shiftedPercent + FRAME_FUDGE_ADD)/1.3;
UnicodeString per;
per.format(L"%d%%",percent);
TheMouse->setCursorTooltip(UnicodeString::TheEmptyString);
GadgetProgressBarSetProgress(m_progressBar, percent);
GadgetStaticTextSetText(m_percent, per);

}
TheWindowManager->update();
// Update the video progress in the progress bar
Int percent = TheDisplay->getMovieProgress() * 100.0f;
UnicodeString per;
per.format(L"%d%%",percent);
TheMouse->setCursorTooltip(UnicodeString::TheEmptyString);
GadgetProgressBarSetProgress(m_progressBar, percent);
GadgetStaticTextSetText(m_percent, per);

// redraw all views, update the GUI
TheWindowManager->update();
TheDisplay->update();
TheDisplay->draw();
}

// let the background image show through
m_videoStream->close();
m_videoStream = nullptr;
m_loadScreen->winGetInstanceData()->setVideoBuffer( nullptr );
TheDisplay->stopMovie();
backgroundWin->winEnable(true);
TheDisplay->draw();
}
else
{
// if we're min spec'ed don't play a movie

backgroundWin->winEnable(true);

Int delay = mission->m_voiceLength * 1000;
Int begin = timeGetTime();
Int currTime = begin;
Expand All @@ -613,6 +563,10 @@ void SinglePlayerLoadScreen::init( GameInfo *game )
TheDisplay->draw();

}

GadgetProgressBarSetProgress(m_progressBar, 0);
GadgetStaticTextSetText(m_percent, UnicodeString::TheEmptyString);

setFPMode();
m_percent->winHide(TRUE);
m_ambientLoopHandle = TheAudio->addAudioEvent(&m_ambientLoop);
Expand Down
5 changes: 3 additions & 2 deletions GeneralsMD/Code/GameEngineDevice/Include/W3DDevice/GameClient/W3DDisplay.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -115,8 +115,9 @@ class W3DDisplay : public Display

/// draw a video buffer fit within the screen coordinates
virtual void drawScaledVideoBuffer( VideoBuffer *buffer, VideoStreamInterface *stream );
virtual void drawVideoBuffer( VideoBuffer *buffer, Int startX, Int startY,
Int endX, Int endY );
virtual void drawScaledVideoBuffer();
virtual void drawVideoBuffer( VideoBuffer *buffer, Int startX, Int startY, Int endX, Int endY );
virtual void drawVideoBuffer( Int startX, Int startY, Int endX, Int endY );

virtual VideoBuffer* createVideoBuffer( void ) ; ///< Create a video buffer that can be used for this display

Expand Down
10 changes: 10 additions & 0 deletions GeneralsMD/Code/GameEngineDevice/Source/W3DDevice/GameClient/GUI/W3DGameWindow.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -388,6 +388,16 @@ void W3DGameWinDefaultDraw( GameWindow *window, WinInstanceData *instData )
TheDisplay->drawVideoBuffer( instData->m_videoBuffer, pos.x, pos.y, pos.x + size.x, pos.y + size.y );
}

// if the display has a movie playing then we need to draw the displays video buffer
if (TheDisplay->isMoviePlaying())
Copy link
Author

@Mauller Mauller Feb 8, 2026 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is added in addition to the original drawing functionality as some screens still use the original method, such as the challenge load screen.

The challenge load screen does something more complex with it's video handling and needs looking at seperate from this change.

{
ICoord2D pos, size;
window->winGetScreenPosition(&pos.x, &pos.y);
window->winGetSize(&size.x, &size.y);

TheDisplay->drawVideoBuffer(pos.x, pos.y, pos.x + size.x, pos.y + size.y);
}

}

// W3DGameWindow::winDrawBorder ===============================================
Expand Down
10 changes: 10 additions & 0 deletions GeneralsMD/Code/GameEngineDevice/Source/W3DDevice/GameClient/W3DDisplay.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2844,6 +2844,11 @@ void W3DDisplay::drawScaledVideoBuffer( VideoBuffer *buffer, VideoStreamInterfac
drawVideoBuffer( buffer, startX, startY, endX, endY );
}

void W3DDisplay::drawScaledVideoBuffer()
{
drawScaledVideoBuffer(m_videoBuffer, m_videoStream);
}
Comment on lines +2847 to +2850
Copy link

@greptile-apps greptile-apps bot Feb 15, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Missing null check before dereferencing m_videoBuffer and m_videoStream. The original method at line 2813 doesn't check either, but since this is being called from W3DGameWindow.cpp:398 which already checks isMoviePlaying(), it should be safe. However, defensive programming suggests adding a check here as well.

Suggested change
void W3DDisplay::drawScaledVideoBuffer()
{
drawScaledVideoBuffer(m_videoBuffer, m_videoStream);
}
void W3DDisplay::drawScaledVideoBuffer()
{
if (m_videoBuffer && m_videoStream)
drawScaledVideoBuffer(m_videoBuffer, m_videoStream);
}

Note: If this suggestion doesn't match your team's coding style, reply to this and let me know. I'll remember it for next time!

Prompt To Fix With AI 
This is a comment left during a code review.
Path: GeneralsMD/Code/GameEngineDevice/Source/W3DDevice/GameClient/W3DDisplay.cpp
Line: 2847:2850

Comment:
Missing null check before dereferencing `m_videoBuffer` and `m_videoStream`. The original method at line 2813 doesn't check either, but since this is being called from `W3DGameWindow.cpp:398` which already checks `isMoviePlaying()`, it should be safe. However, defensive programming suggests adding a check here as well.

```suggestion
void W3DDisplay::drawScaledVideoBuffer()
{
	if (m_videoBuffer && m_videoStream)
		drawScaledVideoBuffer(m_videoBuffer, m_videoStream);
}
```

<sub>Note: If this suggestion doesn't match your team's coding style, reply to this and let me know. I'll remember it for next time!</sub>

How can I resolve this? If you propose a fix, please make it concise.


//============================================================================
// W3DDisplay::drawVideoBuffer
//============================================================================
Expand All @@ -2861,6 +2866,11 @@ void W3DDisplay::drawVideoBuffer( VideoBuffer *buffer, Int startX, Int startY, I

}

void W3DDisplay::drawVideoBuffer( Int startX, Int startY, Int endX, Int endY )
{
drawVideoBuffer(m_videoBuffer, startX, startY, endX, endY);
}
Comment on lines +2869 to +2872
Copy link

@greptile-apps greptile-apps bot Feb 15, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Missing null check for m_videoBuffer before dereferencing. While isMoviePlaying() checks both pointers, adding a guard here provides an extra safety layer.

Suggested change
void W3DDisplay::drawVideoBuffer( Int startX, Int startY, Int endX, Int endY )
{
drawVideoBuffer(m_videoBuffer, startX, startY, endX, endY);
}
void W3DDisplay::drawVideoBuffer( Int startX, Int startY, Int endX, Int endY )
{
if (m_videoBuffer)
drawVideoBuffer(m_videoBuffer, startX, startY, endX, endY);
}

Note: If this suggestion doesn't match your team's coding style, reply to this and let me know. I'll remember it for next time!

Prompt To Fix With AI 
This is a comment left during a code review.
Path: GeneralsMD/Code/GameEngineDevice/Source/W3DDevice/GameClient/W3DDisplay.cpp
Line: 2869:2872

Comment:
Missing null check for `m_videoBuffer` before dereferencing. While `isMoviePlaying()` checks both pointers, adding a guard here provides an extra safety layer.

```suggestion
void W3DDisplay::drawVideoBuffer( Int startX, Int startY, Int endX, Int endY )
{
	if (m_videoBuffer)
		drawVideoBuffer(m_videoBuffer, startX, startY, endX, endY);
}
```

<sub>Note: If this suggestion doesn't match your team's coding style, reply to this and let me know. I'll remember it for next time!</sub>

How can I resolve this? If you propose a fix, please make it concise.


// W3DDisplay::setClipRegion ============================================
/** Set the clipping region for images.
@todo: Make this work for all primitives, not just drawImage. */
Expand Down
8 changes: 5 additions & 3 deletions GeneralsMD/Code/Tools/GUIEdit/Include/GUIEditDisplay.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -98,9 +98,11 @@ class GUIEditDisplay : public Display
virtual VideoBuffer* createVideoBuffer( void ) { return nullptr; }

/// draw a video buffer fit within the screen coordinates
virtual void drawScaledVideoBuffer( VideoBuffer *buffer, VideoStreamInterface *stream ) { }
virtual void drawVideoBuffer( VideoBuffer *buffer, Int startX, Int startY,
Int endX, Int endY ) { }
virtual void drawScaledVideoBuffer(VideoBuffer* buffer, VideoStreamInterface* stream) { }
virtual void drawScaledVideoBuffer() { }
virtual void drawVideoBuffer(VideoBuffer* buffer, Int startX, Int startY, Int endX, Int endY) { }
virtual void drawVideoBuffer(Int startX, Int startY, Int endX, Int endY) { }

virtual void takeScreenShot(void){ }
virtual void toggleMovieCapture(void) {}

Expand Down
Loading