102 Dalmatians: Puppies to the Rescue
Decompilation Source Reference | GitLab repository
Loading...
Searching...
No Matches
music.c
Go to the documentation of this file.
1/* Recovered game implementation; original addresses identify provenance. */
10#include "pcdogs/level/types.h"
15#include "pcdogs/types/common.h"
16#include <math.h>
17#include <stdarg.h>
18#include <string.h>
19
20// Original pcdogs.exe: 0x4067e0
21// Selects or updates an eased music transition through fade-out, hold, and fade-in phases using Q12 durations at 30 Hz. Negative mode advances the existing transition after its update gate; callers must provide valid theme indices within the five-slot array and usable timing values when selecting a new track.
22void Audio_TriggerMusicTransition(int32_t track_index, int32_t transition_mode, struct Level_TransitionTimingData const *transition_timing, int32_t volume_percent)
23{
24 if (transition_mode >= 0)
25 {
27 }
28 else
29 {
31 {
33 return;
34 }
36 }
37
38 const struct Audio_MusicStreamRecord *track =
39 (const struct Audio_MusicStreamRecord *)pkg_resource_current_level_data->themes[track_index];
40 if (!Audio_CheckStreamStatus(track))
41 {
42 uint32_t frame = g_frameCounter;
43 uint32_t fade_out_end = Audio_MusicFadeFrameCount;
44 bool changed_track = track_index != Audio_TriggerMusicTransition_CurrentTrackIndex;
45
46 if (changed_track)
47 {
49 g_musicTransitionVolume = (int32_t)((uint32_t)volume_percent << AUDIO_Q12_SHIFT) / AUDIO_PERCENT_SCALE;
50 fade_out_end = frame +
52 Audio_MusicFadeFrameCount = fade_out_end;
53 g_musicFadeStartFrame = fade_out_end +
58 }
59
60 if (changed_track || frame <= fade_out_end)
61 {
62 uint32_t remaining_q12 = (fade_out_end - frame) << AUDIO_Q12_SHIFT;
63 int32_t gain = remaining_q12
64 ? Math_EaseInOutQuadraticQ12(remaining_q12 / (fade_out_end - (uint32_t)g_musicTransitionPending))
65 : 0;
66 Audio_SetMusicFadeTarget((int32_t)(((int64_t)gain * g_musicTransitionVolume) >> AUDIO_Q12_SHIFT), 0);
67
68 if ((uint32_t)g_frameCounter < (uint32_t)Audio_MusicFadeFrameCount)
69 return;
70
74 }
75 }
76
77 uint32_t frame = g_frameCounter;
78 uint32_t fade_in_start = g_musicFadeStartFrame;
79 uint32_t fade_in_end = g_musicTransitionEndFrame;
80 if (frame < fade_in_start)
81 return;
82
83 if (frame <= fade_in_end)
84 {
85 int32_t gain = AUDIO_Q12_ONE;
86 if (frame == fade_in_end)
88 else
89 {
90 uint32_t elapsed_q12 = (frame - fade_in_start) << AUDIO_Q12_SHIFT;
91 gain = Math_EaseInOutQuadraticQ12(elapsed_q12 / (fade_in_end - fade_in_start));
92 }
93 Audio_SetMusicFadeTarget((int32_t)(((int64_t)gain * g_musicTransitionVolume) >> AUDIO_Q12_SHIFT), 0);
94 }
95
96 if ((uint32_t)g_frameCounter == (uint32_t)g_musicFadeStartFrame)
97 {
100 }
101}
102
103// Original pcdogs.exe: 0x438440
104// Opens the named music file under the package music directory when a digital driver and filename are present. The open-stream counter increments after the attempt even if opening fails.
105void Audio_OpenStream(struct Audio_MusicStreamRecord *stream_record)
106{
107 if (!Audio_InitializeSystem_DigitalDriver || !stream_record->filename[0])
108 {
109 stream_record->handle = NULL;
110 return;
111 }
112
113 char music_path[MAX_PATH];
114 String_FormatCRTString(music_path, "%sdata\\music\\%s", &g_pkgBasePath, stream_record->filename);
115 stream_record->handle = AIL_open_stream(Audio_InitializeSystem_DigitalDriver, music_path, false);
116 g_openStreamCount = (int32_t)((uint32_t)g_openStreamCount + 1U);
117}
118
119// Original pcdogs.exe: 0x4384b0
120// Returns whether the supplied stream record has a handle whose Miles status is playing.
121int32_t Audio_IsStreamPlaying(struct Audio_MusicStreamRecord const *stream_record)
122{
123 AIL_HSTREAM handle = stream_record->handle;
124
126}
127
128// Original pcdogs.exe: 0x4384d0
129// Converts Q12 volume to the Miles scale for the active stream, clamping the unsigned converted value to 128.
130void Audio_SetStreamVolume(int32_t volume_fp12)
131{
132 AIL_HSTREAM active_stream = g_musicStreamHandle;
133
134 if (!active_stream) // Verify stream is open before setting volume
135 return;
136
137 // Convert volume from 12-bit (4096 range) to 7-bit (128 range) by right-shifting 5 bits
138 uint32_t volume = volume_fp12 >> AUDIO_VOLUME_TO_MILES_SHIFT;
139
140 // Clamp volume to maximum of 128 (0x80)
141 if (volume >= (AUDIO_MILES_CONTROL_MAX + 1))
143
144 // Set stream volume via Miles API (0-127 range, with 128 as max)
145 AIL_set_stream_volume(active_stream, volume);
146}
147
148// Original pcdogs.exe: 0x438500
149// Optionally opens and selects a music record, then starts the active stream at the requested volume with indefinite looping.
150void Audio_PlayMusicStream(struct Audio_MusicStreamRecord *stream_record, int32_t volume_fp12)
151{
152 if (stream_record)
153 {
154 Audio_OpenStream(stream_record);
155 g_musicStreamHandle = stream_record->handle;
156 }
157
159 return;
160
161 Audio_SetStreamVolume(volume_fp12);
164}
165
166// Original pcdogs.exe: 0x438550
172
173// Original pcdogs.exe: 0x438570
179
180// Original pcdogs.exe: 0x438590
191
192// Original pcdogs.exe: 0x4385f0
193// Stores a truncated 16-bit target volume and a fade count of the requested frames plus one, returning the previous target. Negative targets scale the previous target in Q12.
194int32_t Audio_SetMusicFadeTarget(int32_t target_volume, int16_t frame_count)
195{
196 int32_t resolved_target_volume = target_volume;
197 int32_t previous_target_volume = (int32_t)g_musicFadeTargetVolume;
198
199 if (resolved_target_volume < 0)
200 {
201 int32_t factor = (int32_t)(0U - (uint32_t)resolved_target_volume);
202 resolved_target_volume = (int32_t)(((int64_t)factor * previous_target_volume) >> AUDIO_Q12_SHIFT);
203 }
204
205 g_musicFadeTargetVolume = (uint16_t)resolved_target_volume;
206 g_musicFadeFrameCount = frame_count + 1;
207
208 return previous_target_volume;
209}
210
211// Original pcdogs.exe: 0x438630
212// Saves the current target and requests a fade to zero unless the music is already paused or stopped.
214{
215 // Check bits 1 and 2 of sound system flags (paused=0x02, stopped=0x04). Only fade if not already paused or
216 // stopped.
218 return;
219
221 // Set bit 0 of sound system flags to indicate fade-out in progress
224}
225
226// Original pcdogs.exe: 0x438660
227// Restores the saved fade target and resumes the stream unless the pause flag is set, clearing the fading and stopped flags.
229{
230 // Check bit 1 (paused flag). Only proceed if not paused.
232 return;
233
234 // Clear bits 0 (fading) and 2 (stopped), keeping only other flags (mask 0xfa = 11111010)
236 // Resume music stream playback
238
239 /* tailcall */
240 return Audio_ResumeStream();
241}
242
243// Original pcdogs.exe: 0x438690
244// Sets the music pause flag and closes the active stream unless already paused.
246{
247 uint8_t sound_flags = g_soundSystemFlags;
248
249 if (AUDIO_MUSIC_PAUSED & sound_flags)
250 return;
251
253
254 /* tailcall */
255 return Audio_CloseMusicStream();
256}
257
258// Original pcdogs.exe: 0x4386b0
259// Selects a music stream record and clears the low four music-state flags without opening the stream.
265
266// Original pcdogs.exe: 0x4386d0
267// Resets current fade volume to zero, requests a full-volume fade, and selects the supplied music record.
274
275// Original pcdogs.exe: 0x438700
276// Returns whether a nonnull music record is currently playing.
277int32_t Audio_CheckStreamStatus(struct Audio_MusicStreamRecord const *stream_record)
278{
279 return (stream_record && Audio_IsStreamPlaying(stream_record));
280}
281
282// Original pcdogs.exe: 0x438720
283// Advances the signed 16-bit fade state, starts eligible selected streams, and pauses streams when a fade-out reaches zero. Applies the user music-volume scale before updating stream volume.
285{
286 int64_t scaled_volume_product;
287 int16_t fade_frames_remaining = g_musicFadeFrameCount;
288
289 if (fade_frames_remaining)
290 {
291 int16_t previous_fade_volume = g_musicTransitionState;
292
293 g_musicTransitionState = previous_fade_volume + (int16_t)((int64_t)((int32_t)g_musicFadeTargetVolume - (int32_t)previous_fade_volume) / (int32_t)fade_frames_remaining);
294 g_musicFadeFrameCount = fade_frames_remaining - 1;
295 }
296
297 uint8_t sound_flags;
298
300 {
302
303 if (!selected_stream)
304 return;
305
306 sound_flags = g_soundSystemFlags;
307
309 return;
310
311 if (!(sound_flags & AUDIO_MUSIC_STARTED))
312 {
314 Audio_PlayMusicStream(selected_stream, (int32_t)g_musicTransitionState);
315
316 sound_flags = g_soundSystemFlags;
317 }
318 }
319 else
320 sound_flags = g_soundSystemFlags;
321
322 if (!g_musicTransitionState && sound_flags & AUDIO_MUSIC_FADING)
323 {
326 }
327
328 /* 4387cf calls the setting getter once before the IMUL/SHRD pair. */
329 int32_t music_volume = Settings_GetMusicVolume();
330
331 scaled_volume_product = (int64_t)music_volume * (int32_t)g_musicTransitionState;
332 Audio_SetStreamVolume((int32_t)(scaled_volume_product >> AUDIO_Q12_SHIFT));
333}
334
335// Original pcdogs.exe: 0x438800
336// Forwards to the routine that pauses music state and closes the active stream.
338{
339 /* tailcall */
341}
#define AUDIO_MUSIC_STARTED
Definition constants.h:19
#define AUDIO_VOLUME_TO_MILES_SHIFT
Definition constants.h:31
#define AUDIO_TRANSITION_FRAMES_PER_SECOND
Definition constants.h:33
#define AUDIO_PERCENT_SCALE
Definition constants.h:35
@ AUDIO_PLAYBACK_PLAYING
Definition constants.h:63
#define AUDIO_MUSIC_PAUSE_FADE_FRAMES
Definition constants.h:34
#define AUDIO_Q12_ONE
Definition constants.h:24
#define AUDIO_MUSIC_PAUSED
Definition constants.h:17
#define AUDIO_MILES_CONTROL_MAX
Definition constants.h:29
#define AUDIO_MUSIC_FADING
Definition constants.h:16
@ AUDIO_STREAM_PAUSE
Definition constants.h:69
@ AUDIO_STREAM_RESUME
Definition constants.h:68
#define AUDIO_Q12_SHIFT
Definition constants.h:22
#define AUDIO_MUSIC_STOPPED
Definition constants.h:18
#define Audio_TriggerMusicTransition_CurrentTrackIndex
Definition globals.h:57
#define g_musicSelectedStreamRecord
Definition globals.h:33
#define Audio_InitializeSystem_DigitalDriver
Definition globals.h:24
#define g_soundSystemFlags
Definition globals.h:30
#define Audio_MusicFadeFrameCount
Definition globals.h:18
void * AIL_HSTREAM
Definition common.h:8
#define GAME_OVERLAY_SKIP_OBJECT_RENDER
Definition constants.h:36
#define GAME_TRANSITION_MUSIC_TRANSITION
Definition constants.h:8
#define Game_FrameTransitionFlags
Definition globals.h:47
#define Game_FrameOverlayFlags
Definition globals.h:44
int32_t AIL_start_stream(AIL_HSTREAM stream)
int32_t AIL_stream_status(AIL_HSTREAM stream)
int32_t AIL_set_stream_volume(AIL_HSTREAM stream, int32_t volume)
int32_t AIL_pause_stream(AIL_HSTREAM stream, int32_t pause)
int32_t AIL_close_stream(AIL_HSTREAM stream)
int32_t AIL_set_stream_loop_count(AIL_HSTREAM stream, int32_t loop_count)
AIL_HSTREAM AIL_open_stream(AIL_HDIGDRIVER driver, char const *filename, int32_t stream_memory)
int32_t Math_EaseInOutQuadraticQ12(int32_t input_q12)
Definition fixed_point.c:24
void Audio_SetStreamVolume(int32_t volume_fp12)
Definition music.c:130
int32_t Audio_IsStreamPlaying(struct Audio_MusicStreamRecord const *stream_record)
Definition music.c:121
void Audio_StartMusicWithFade(struct Audio_MusicStreamRecord *stream_record)
Definition music.c:268
void Audio_CloseMusicStream(void)
Definition music.c:181
void Audio_PauseStream(void)
Definition music.c:167
void Audio_FadeInMusic()
Definition music.c:228
int32_t Audio_CheckStreamStatus(struct Audio_MusicStreamRecord const *stream_record)
Definition music.c:277
void Audio_FadeOutMusic()
Definition music.c:213
int32_t Audio_SetMusicFadeTarget(int32_t target_volume, int16_t frame_count)
Definition music.c:194
void Audio_StopMusicAndPause()
Definition music.c:245
void Audio_OpenStream(struct Audio_MusicStreamRecord *stream_record)
Definition music.c:105
void Audio_PlayMusicStream(struct Audio_MusicStreamRecord *stream_record, int32_t volume_fp12)
Definition music.c:150
void Audio_StopMusicAndPauseThunk()
Definition music.c:337
void Audio_ProcessMusicFade()
Definition music.c:284
void Audio_ResumeStream(void)
Definition music.c:174
void Audio_TriggerMusicTransition(int32_t track_index, int32_t transition_mode, struct Level_TransitionTimingData const *transition_timing, int32_t volume_percent)
Definition music.c:22
void Audio_ResetMusicState(struct Audio_MusicStreamRecord *stream_record)
Definition music.c:260
#define g_pkgBasePath
Definition globals.h:102
#define pkg_resource_current_level_data
Definition globals.h:117
int32_t String_FormatCRTString(char *buffer, char const *format,...)
Definition formatting.c:18
uint16_t Settings_GetMusicVolume(void)
Definition preferences.c:27
AIL_HSTREAM handle
Definition types.h:11
char filename[0x0]
Definition types.h:12
#define g_musicTransitionTarget
Definition values.h:468
#define g_frameCounter
Definition values.h:501
#define g_musicTransitionState
Definition values.h:471
#define g_musicTransitionVolume
Definition values.h:150
#define g_musicFadeTargetVolume
Definition values.h:474
#define g_musicFadeStartFrame
Definition values.h:165
#define g_screenFadeCounter
Definition values.h:624
#define g_musicFadeFrameCount
Definition values.h:465
#define g_musicTransitionPending
Definition values.h:171
#define g_openStreamCount
Definition values.h:456
#define g_musicTransitionEndFrame
Definition values.h:168
#define g_musicStreamHandle
Definition values.h:459