bugfix(audiomanager): Fix dummy audio manager implementation for failing audio length script conditions in headless mode

[Caball009]

• Closes Incomplete implementation of dummy audio manager can cause mismatches in headless mode #2295
• Follow up for [ZH] Implement Headless Mode #651

Our current implementation of dummy audio manager is incomplete, because it cannot return the actual length of audio files. Replays will mismatch if they contain scripts that rely on this.

TODO:

• Make sure the Github CI can access the audio files.
• Replicate in Generals.

[greptile-apps]

Greptile Summary

Fixed dummy audio manager for headless mode by changing inheritance from AudioManager to MilesAudioManager, enabling actual audio file length queries required by certain scripts. The new MilesAudioManagerDummy deliberately does not override openDevice(), closeDevice(), or getFileLengthMS() to leverage the parent's Miles Sound System integration for querying audio file metadata without playback.

Key Changes:

• Removed AudioManagerDummy from shared Core header
• Added MilesAudioManagerDummy in Miles-specific header inheriting from MilesAudioManager
• Refactored GeneralsMD audio manager factory to accept headless parameter
• Updated GeneralsMD initialization to use factory pattern

Critical Issue:

• Generals (vanilla) build is broken - Generals/Code/GameEngine/Source/Common/GameEngine.cpp:437 still references removed AudioManagerDummy class

Minor Issue:

• Commented-out code in MilesAudioManagerDummy could be removed since line 335 comment explains design intent

Confidence Score: 2/5

• Cannot merge - breaks Generals build due to removed AudioManagerDummy reference
• GeneralsMD changes are architecturally sound and the approach correctly enables audio file length queries in headless mode, but the shared Core header change breaks the Generals build which still references the removed class. PR's own TODO acknowledges this ("Replicate in Generals"), but the current state leaves one codebase broken.
• Pay attention to Core/GameEngine/Include/Common/GameAudio.h - removal breaks Generals build. Either revert this change temporarily, or include corresponding Generals updates in this PR.

Important Files Changed

Filename	Overview
Core/GameEngine/Include/Common/GameAudio.h	Removed AudioManagerDummy class from shared header, breaking Generals build which still references it
Core/GameEngineDevice/Include/MilesAudioDevice/MilesAudioManager.h	Added MilesAudioManagerDummy inheriting from MilesAudioManager to enable audio file length queries in headless mode; contains commented-out code for documentation
GeneralsMD/Code/GameEngineDevice/Include/Win32Device/Common/Win32GameEngine.h	Implemented createAudioManager(Bool headless) to return MilesAudioManagerDummy when headless, otherwise MilesAudioManager

Class Diagram

%%{init: {'theme': 'neutral'}}%%
classDiagram
    class AudioManager {
        <<interface>>
        +getFileLengthMS(string) Real
        +openDevice() void
        +closeDevice() void
        +getDevice() void*
    }
    
    class MilesAudioManager {
        -m_digitalHandle
        +openDevice() void
        +closeDevice() void
        +getDevice() void*
        +getFileLengthMS(string) Real
    }
    
    class MilesAudioManagerDummy {
        +stopAudio() void
        +pauseAudio() void
        +isMusicPlaying() bool
        Note: Inherits openDevice, closeDevice, getFileLengthMS from parent
    }
    
    class AudioManagerDummy_OLD {
        <<removed>>
        +getFileLengthMS() returns -1
    }
    
    AudioManager <|-- MilesAudioManager
    MilesAudioManager <|-- MilesAudioManagerDummy
    AudioManager <|.. AudioManagerDummy_OLD : "Before (removed)"
    
    note for MilesAudioManagerDummy "Uses parent's Miles device initialization\nto query actual audio file lengths"

Loading

_{Last reviewed commit: 487a865}

[greptile-apps]

_{5 files reviewed, 4 comments}

_{Edit Code Review Agent Settings | Greptile}

[greptile-apps]

Remove commented-out code. The existing comment at line 335 already explains why these methods aren't overridden.

Prompt To Fix With AI

This is a comment left during a code review.
Path: Core/GameEngineDevice/Include/MilesAudioDevice/MilesAudioManager.h
Line: 351-353

Comment:
Remove commented-out code. The existing comment at line 335 already explains why these methods aren't overridden.

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

_{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!}

[Caball009]

I think there's value in providing a complete implementation of AudioManager. The functions that are commented out show clearly, more so than the comment, which functions are not overridden for this dummy implementation.

[greptile-apps]

That's a fair point. Commented-out method signatures can serve as inline documentation showing what's intentionally not overridden, especially in a class that overrides most other virtual methods.

However, this approach has a trade-off: it creates ambiguity about whether the code is temporarily disabled or intentionally documented. A clearer alternative would be to add these method names to the existing comment at line 335, making it explicit which methods are intentionally not overridden without leaving commented code.

For example:

// Methods intentionally not overridden: openDevice(), closeDevice(), getDevice()

This gives you the same clarity without the "is this dead code?" question. But if you prefer the visual clarity of seeing the signatures, keeping them commented is also reasonable—just be aware that most linters and style guides flag commented-out code as a smell.

Your call on which approach better serves future maintainers.

[xezon]

Maybe do Bool dummy ? Because it may not just be headless that want's to use a dummy in the future, aka the Dummy class should not care in what context it is used.

[xezon]

"Useful for headless mode"

[xezon]

Perhaps mirror the implemention for createRadar?

It currently also does TheGlobalData->m_headless ? NEW RadarDummy : createRadar()

[xezon]

Perhaps clarify that this is CRC relevant