ogg-winmm HookModule

ogg-winmm, repackaged as a HookModule to be loaded with samuelgr's Hookshot

I hate to tell you, but the AI bug bit me when DeepSeek was suddenly able to spit out some pretty complicated code 9/10 times without me getting compile errors. Still, I wanted my first GitHub foray into this to be respectful (later ones, not so much?? I tease.) The core code of AyuanX's fork is intact- I will be able to easily integrate their changes into later builds- only minimal changes were needed on my end. I should even be able to integrate other forks' improvements if recommended. I'm not a complete dumb dumb.

Just a warning: the Hookshot-specific glue-code is all vibes. You better review it. It was prompted to match style of ogg-winmm code historically. I refuse to take credit for anything other than the ideas and the orchestration. The real credit goes to those who slaved over making this the best it could be over the years. If you have issues with this fork- don't go complain to anyone else involved unless it can be confirmed to be upstream. I think the only issues that should be reported are related to the HookModule implementation (outside of Xidi, I think this is the first published HookModule, so it might be doing something wrong).

A breakdown of the actual changes:

• No more DLL replacement: Rather than hoping the game'll hook on its own, it's built for usage with samuelgr's mighty Hookshot
• Bare minimum changes to core source: A few necessary lines were changed in ogg-winmm.c due to changes in the execution- the settings file now has a hardcoded name, ogg-winmm.ini
• Hookshot integration: Adds glue C++ to register hooks and a Hookshot-specific stubs file to handle those bouncy trampolines for mci and waveOut calls
• Build system changes: Removed unnecessary files and updated for a dual-stage C/C++ build- uses UPX compression
• VC++ 2022 redistributable: The x86 redist is needed for operation

Building this fork:

• It uses NMAKE for now, my toolchain (being minimal and all) didn't have MSBuild, and I didn't want to work out how to get that going; also didn't feel like getting CMake for unserious projects such as this
• The below was only tested against my portablemsvc-installed VC++ 2022 toolchain (system registered) and my girlfriend's honest-to-goodness Visual Studio 2022 install (where the batchfile inherits the Developer Command Prompt environment instead)
• In both tests, it was run interactively with a double-click in Explorer
• It can also be run non-interactively (build.bat build / build.bat clean, etc.) if that's your kind of thing
• On a fresh clone, run fetch dependencies once before building - I didn't keep the ogg/vorbis sources in the repo, and they are hard dependencies!
• If the toolchain variables don't exist on system (normal for an official install) and build.bat can't find a Developer Command Prompt with vswhere, try running it in the Developer Command Prompt directly - it might just work then!

Original readme (some details may not be applicable!)

ogg-winmm is a wrapper of "winmm.dll", which is used by many games and programs to play CD-DA audio tracks.

ogg-winmm emulates the CD-DA audio tracks by reading them from ogg files instead of audio tracks on a CD-ROM.

ogg-winmm also provides separate volume control for CDDA/MIDI/WAVE, which has been missing in Windows Vista/7/8/10.

Usage:

1. Rip the audio tracks from the CD and encode them to ogg files, following naming convention:

Track02.ogg, Track03.ogg, Track04.ogg, ...

Note that the file names can not contain whitespace, and the track numbers must be contiguous without gap in the middle.

Also note the numbering usually starts from 02 since on mixed mode CDs the first track is a data track.

In rare cases some games may use a pure audio CD with no data tracks in which case you should start numbering them from "Track01.ogg".

2. Extract the dll file and the ini file to the game folder where the game's main executable file is located.

3. Create a subfolder called "Music" there and put the ogg files in it.

4. (Optional) Override the volume for CDDA/MIDI/WAVE in "winmm.ini" file if desired.

5. Run the game and enjoy the emulated CD audio.

Requirement:

• Minimum operating system: Windows XP or newer.

NOTE: It actually can also work on Win95/98 if you follow the extra procedure below:

1. Rename "winmm.dll" to "wincd.dll", and rename "winmm.ini" to "wincd.ini".
2. Use a hex editor to open the game's exe file, then replace all occurrences of string "winmm.dll" (case-insensitive) to "wincd.dll".

Building:

• Use MinGW 6.3.0-1 or later to build on Windows OS.
• Dependencies:
  • libogg (https://github.com/gcp/libogg.git)
  • libvorbis (https://github.com/xiph/vorbis.git)

Revisions:

v.2025.01.16

• Treat PLAY as RESUME when in PAUSE.

v.2025.01.09

• Link to "msvcrt40.dll" for backward compatibility to Win9x.

v.2024.11.12

• Compatibility fix for thread scheduling on Windows XP or later.

v.2024.10.24

• Add an option to customize the music folder name.

v.2024.08.08

• Small compiler optimizations.

v.2024.03.21

• Fix the truncation at the end of each song ranging from 1ms to 500ms.

v.2023.07.24

• Correctly report stereo CD separate channel volume control capability.

v.2023.06.01

• Fix MCI_PAUSE & MCI_RESUME when not playing.
• Fix MCI_STATUS_LENGTH when time format is set to TMSF.
• Fix MCI_STATUS_POSITION when time format is set to milliseconds or MSF.

v.2023.04.14

• Implement MCI_SEEK & MCI_GETDEVCAPS.
• Allow aux volume control on left/right channel separately.

v.2023.03.11

• Allow more than 1 data track before audio track.
• Fix total track number.

v.2023.02.28

• Improve time range precision from second to millisecond.
• Add compatibility support for Win95/98.

v.2023.02.26:

• Implement time range playing down to seconds instead of always track-wise playing.
• Implement pause and resume.

v.2023.01.18:

• Implement play/seek/length/position for mciSendString.

v.2022.06.26:

• Fix MIDI file open bypass.

v.2022.05.26:

• Remove unnecessary monitor thread.
• Thread calling convention fix.
• Position calculation and status fix.
• Various compatibility fix.

v.2022.02.28:

• Implement MCI_INFO
• Fix MCI_SYSINFO
• Bugfixes for MCISendString

v.2022.02.27:

• Treat MCI_PAUSE as MCI_STOP and MCI_RESUME as MCI_PLAY, since MCICDA does not support resume.

v.2021.11.15:

• Ignore case when opening device.

v.2021.11.11:

• Post notify message to the correct window.
• Fix a race condition that sometimes causes music to stutter.

v.2021.11.10:

• Completely rewrite player control logic.
• Use persistent thread to improve performance.
• Use persistent buffer to improve performance.
• Fix various crash/freeze scenarios related to thread.
• Fix various memory leak scenarios related to buffer.

v.2021.08.08:

• Fix MCI_STATUS_LENGTH and MCI_STATUS_POSITION.
• Optimize player thread control.

v.2021.07.26:

• Relay MCI commands if they are not targeting cdaudio device.
• Add more stub functions to support more games.
• Filter MIDI source by the full driver name (wdmaud.drv).

v.2021.07.11:

• Implement an alternative method to control MIDI volume, which should make scaling coefficients identical to CDDA/WAVE volume control.

v.2021.07.10:

• Implement separate volume control for CDDA/MIDI/WAVE. This is necessary because Windows does not provide any method to separate the volume control of CDDA/MIDI/WAVE ever since Vista.

v.2021.07.09:

• Fix the start tick of each track. Since MCICDA does not support pause, unnecessary time accumulation is removed.

v.2021.07.08:

• Implement realtime TMSF report for MCI_STATUS_POSITION. Many games use this realtime status to sync up video and audio frame by frame.