1 // Copyright (C) 2021 Harry Godden (hgn) - All Rights Reserved
3 #define MA_NO_GENERATION
6 #include "dr_soft/miniaudio.h"
8 #define STB_VORBIS_MAX_CHANNELS 2
9 #include "stb/stb_vorbis.h"
11 #define SFX_MAX_SYSTEMS 32
12 //#define SFX_FLAG_ONESHOT 0x1
13 #define SFX_FLAG_STEREO 0x2
14 #define SFX_FLAG_REPEAT 0x4
15 #define SFX_FLAG_PERSISTENT 0x8
16 #define FADEOUT_LENGTH 4410
17 #define FADEOUT_DIVISOR (1.f/(float)FADEOUT_LENGTH)
19 typedef struct sfx_vol_control sfx_vol_control
;
20 typedef struct sfx_system sfx_system
;
22 struct sfx_vol_control
30 sfx_system
*persisitent_source
;
33 // Source buffer start
34 float *source
, *replacement
;
36 u32 clip_start
, clip_end
, buffer_length
;
39 sfx_vol_control
*vol_src
;
47 u32 fadeout
, fadeout_current
;
53 // Set of up to 8 sound effects packed into one
54 typedef struct sfx_set sfx_set
;
60 u32 segments
[32]; //from->to,from->to ...
66 ma_device g_aud_device
;
67 ma_device_config g_aud_dconfig
;
69 // Thread 1 - audio engine ( spawned from miniaudio.h )
70 // ======================================================
71 sfx_system sfx_sys
[SFX_MAX_SYSTEMS
];
74 // Thread 0 - Critical transfer section
75 // ======================================================
76 MUTEX_TYPE sfx_mux_t01
; // Resources share: 0 & 1
78 sfx_system
*sfx_q
[SFX_MAX_SYSTEMS
]; // Stuff changed
79 int sfx_q_len
= 0; // How much
82 // ======================================================
84 // g_vol_master is never directly acessed by users
85 float g_master_volume
= 1.f
;
87 // Decompress entire vorbis stream into buffer
88 static float *sfx_vorbis_stream( const unsigned char *data
, int len
, int channels
, u32
*samples
)
91 stb_vorbis
*pv
= stb_vorbis_open_memory( data
, len
, &err
, NULL
);
95 vg_error( "stb_vorbis_open_memory() failed with error code: %i\n", err
);
99 u32 length_samples
= stb_vorbis_stream_length_in_samples( pv
);
100 float *buffer
= (float *)malloc( length_samples
* channels
* sizeof( float ));
104 stb_vorbis_close( pv
);
105 vg_error( "out of memory while allocating sound resource\n" );
109 int read_samples
= stb_vorbis_get_samples_float_interleaved( pv
, channels
, buffer
, length_samples
* channels
);
110 if( read_samples
!= length_samples
)
112 vg_warn( "| warning: sample count mismatch. Expected %u got %i\n", length_samples
, read_samples
);
113 length_samples
= read_samples
;
116 stb_vorbis_close( pv
);
117 *samples
= length_samples
;
121 static float *sfx_vorbis( const char *strFileName
, int channels
, u32
*samples
)
124 void *filedata
= vg_asset_read_s( strFileName
, &len
);
128 float *wav
= sfx_vorbis_stream( filedata
, len
, channels
, samples
);
134 vg_error( "OGG load failed\n" );
139 typedef struct sfx_bgload sfx_bgload_t
;
150 void(*OnComplete
)(sfx_bgload_t
*inf
);
153 // Thread worker for background load job
154 void *sfx_vorbis_a_t( void *_inf
)
156 sfx_bgload_t
*info
= _inf
;
159 info
->buffer
= sfx_vorbis( info
->path
, info
->channels
, &info
->samples
);
160 info
->OnComplete( info
);
165 // Asynchronous resource load
166 int sfx_vorbis_a( const char *path
, int channels
, void(*OnComplete
)(sfx_bgload_t
*inf
), void *user
)
168 vg_info( "background job started for: %s\n", path
);
170 sfx_bgload_t
*params
= malloc( sizeof( sfx_bgload_t
) );
171 params
->path
= malloc( strlen( path
) + 1 );
172 strcpy( params
->path
, path
);
173 params
->OnComplete
= OnComplete
;
175 params
->channels
= channels
;
177 return vg_thread_run( sfx_vorbis_a_t
, params
);
180 // Asynchronous load-to-system callback
181 struct sfx_vorbis_a_to_inf
187 #define SFX_A_FLAG_AUTOSTART 0x1
188 #define SFX_A_FLAG_AUTOFREE 0x2
191 static int sfx_save( sfx_system *sys );
193 // Asynchronous load-to-system callback
194 void sfx_vorbis_a_to_c( sfx_bgload_t *loadinf )
196 struct sfx_vorbis_a_to_inf *inf = loadinf->user;
198 // Mark buffer for deallocation if autofree is set
199 if( inf->flags & SFX_A_FLAG_AUTOFREE )
200 inf->sys->replacement = loadinf->buffer;
202 inf->sys->source = loadinf->buffer;
204 inf->sys->end = loadinf->samples;
206 if( inf->flags & SFX_A_FLAG_AUTOSTART )
207 sfx_save( inf->sys );
209 free( loadinf->path );
214 // Asynchronous vorbis load into audio system
215 void sfx_vorbis_a_to( sfx_system *sys, const char *strFileName, int channels, u32 flags )
217 struct sfx_vorbis_a_to_inf *inf = malloc( sizeof( struct sfx_vorbis_a_to_inf ) );
223 if( !sfx_vorbis_a( strFileName, channels, sfx_vorbis_a_to_c, inf ) )
228 // ======================================================
230 static int sfx_begin_edit( sfx_system
*sys
)
232 MUTEX_LOCK( sfx_mux_t01
);
234 if( sfx_q_len
>= SFX_MAX_SYSTEMS
&& !sys
->in_queue
)
236 MUTEX_UNLOCK( sfx_mux_t01
);
237 vg_warn( "Warning: No free space in sound queue\n" );
244 static void sfx_end_edit( sfx_system
*sys
)
246 MUTEX_UNLOCK( sfx_mux_t01
);
249 // Mark change to be uploaded to queue system
250 static int sfx_push( sfx_system
*sys
)
254 // Mark change in queue
255 sfx_q
[ sfx_q_len
++ ] = sys
;
259 MUTEX_UNLOCK( sfx_mux_t01
);
264 // Edit a volume float, has to be function wrapped because of mutex
265 static void sfx_vol_fset( sfx_vol_control
*src
, float to
)
267 MUTEX_LOCK( sfx_mux_t01
);
271 MUTEX_UNLOCK( sfx_mux_t01
);
274 // thread-safe get volume value
275 static float sfx_vol_fget( sfx_vol_control
*src
)
279 MUTEX_LOCK( sfx_mux_t01
);
283 MUTEX_UNLOCK( sfx_mux_t01
);
288 // thread-safe set master volume
289 static void sfx_set_master( float to
)
291 MUTEX_LOCK( sfx_mux_t01
);
293 g_master_volume
= to
;
295 MUTEX_UNLOCK( sfx_mux_t01
);
298 // thread-safe get master volume
299 static float sfx_get_master(void)
303 MUTEX_LOCK( sfx_mux_t01
);
305 val
= g_master_volume
;
307 MUTEX_UNLOCK( sfx_mux_t01
);
312 void audio_mixer_callback( ma_device
*pDevice
, void *pOutBuf
, const void *pInput
, ma_uint32 frameCount
);
315 static void vg_audio_init(void)
317 g_aud_dconfig
= ma_device_config_init( ma_device_type_playback
);
318 g_aud_dconfig
.playback
.format
= ma_format_f32
;
319 g_aud_dconfig
.playback
.channels
= 2;
320 g_aud_dconfig
.sampleRate
= 44100;
321 g_aud_dconfig
.dataCallback
= audio_mixer_callback
;
323 g_aud_dconfig
.pUserData
= NULL
;
325 vg_info( "Starting audio engine\n" );
327 if( ma_device_init( NULL
, &g_aud_dconfig
, &g_aud_device
) != MA_SUCCESS
)
329 vg_exiterr( "ma_device failed to initialize" );
333 if( ma_device_start( &g_aud_device
) != MA_SUCCESS
)
335 ma_device_uninit( &g_aud_device
);
336 vg_exiterr( "ma_device failed to start" );
341 // Shutdown audio device
342 static void vg_audio_free(void)
344 ma_device_uninit( &g_aud_device
);
348 // ======================================================
350 // Create and return slot for a sound
351 static sfx_system
*sfx_alloc(void)
353 if( sfx_sys_len
>= SFX_MAX_SYSTEMS
)
356 // A conditional is done against this in localization step,
357 // Needs to be initialized.
358 sfx_sys
[ sfx_sys_len
].source
= NULL
;
360 return sfx_sys
+ (sfx_sys_len
++);
363 // Fetch samples into pcf
364 static void audio_mixer_getsamples( float *pcf
, float *source
, u32 cur
, u32 ch
)
368 pcf
[0] = source
[ cur
*2+0 ];
369 pcf
[1] = source
[ cur
*2+1 ];
373 pcf
[0] = source
[ cur
];
374 pcf
[1] = source
[ cur
];
378 // miniaudio.h interface
379 void audio_mixer_callback( ma_device
*pDevice
, void *pOutBuf
, const void *pInput
, ma_uint32 frameCount
)
381 // Process incoming sound queue
382 MUTEX_LOCK( sfx_mux_t01
);
384 while( sfx_q_len
--> 0 )
386 sfx_system
*src
= sfx_q
[sfx_q_len
];
395 // Links need to exist on persistent sounds
396 clone
->persisitent_source
= src
->flags
& SFX_FLAG_PERSISTENT
? src
: NULL
;
402 for( int i
= 0; i
< sfx_sys_len
; i
++ )
404 sfx_system
*sys
= sfx_sys
+ i
;
406 // Apply persistent volume if linked
407 if( sys
->flags
& SFX_FLAG_PERSISTENT
)
409 sys
->vol
= sys
->persisitent_source
->vol
* g_master_volume
;
411 // Persistent triggers
412 // -------------------
414 // Fadeout effect ( + remove )
415 if( sys
->persisitent_source
->fadeout
)
417 sys
->fadeout_current
= sys
->persisitent_source
->fadeout_current
;
418 sys
->fadeout
= sys
->persisitent_source
->fadeout
;
420 sys
->persisitent_source
= NULL
;
421 sys
->flags
&= ~SFX_FLAG_PERSISTENT
;
425 // Apply volume slider if it has one linked
427 sys
->cvol
= sys
->vol
* sys
->vol_src
->val
;
429 sys
->cvol
= sys
->vol
;
432 MUTEX_UNLOCK( sfx_mux_t01
);
435 float *pOut32F
= (float *)pOutBuf
;
436 for( int i
= 0; i
< frameCount
* 2; i
++ ){
440 for( int i
= 0; i
< sfx_sys_len
; i
++ )
442 sfx_system
*sys
= sfx_sys
+ i
;
444 u32 cursor
= sys
->cur
, buffer_pos
= 0;
445 float pcf
[2] = { 0.f
, 0.0f
};
447 u32 frames_write
= frameCount
;
448 float fadeout_divisor
= 1.0f
/ (float)sys
->fadeout
;
450 while( frames_write
)
452 u32 samples_this_run
= VG_MIN( frames_write
, sys
->end
- cursor
);
456 // Force this system to be removed now
457 if( sys
->fadeout_current
== 0 )
459 sys
->flags
&= 0x00000000;
464 samples_this_run
= VG_MIN( samples_this_run
, sys
->fadeout_current
);
467 for( u32 j
= 0; j
< samples_this_run
; j
++ )
469 audio_mixer_getsamples( pcf
, sys
->source
, cursor
, sys
->ch
);
471 float vol
= sys
->vol
;
475 vol
*= (float)sys
->fadeout_current
* fadeout_divisor
;
476 sys
->fadeout_current
--;
479 if( buffer_pos
>= frameCount
)
484 pOut32F
[ buffer_pos
*2+0 ] += pcf
[0] * vol
;
485 pOut32F
[ buffer_pos
*2+1 ] += pcf
[1] * vol
;
491 frames_write
-= samples_this_run
;
493 if( sys
->flags
& SFX_FLAG_REPEAT
)
507 // Redistribute sound systems
508 MUTEX_LOCK( sfx_mux_t01
);
511 while( idx
!= sfx_sys_len
)
513 sfx_system
*src
= sfx_sys
+ idx
;
515 // Keep only if cursor is before end or repeating
516 if( src
->cur
< src
->end
|| (src
->flags
& SFX_FLAG_REPEAT
) )
518 sfx_sys
[ wr
++ ] = sfx_sys
[ idx
];
525 MUTEX_UNLOCK( sfx_mux_t01
);
530 // Load strings into sfx_set's memory
531 // String layout: "sounda.ogg\0soundb.ogg\0soundc.ogg\0\0"
532 static void sfx_set_strings( sfx_set
*dest
, char *strSources
, u32 flags
, int bAsync
)
534 dest
->ch
= (flags
& SFX_FLAG_STEREO
)? 2: 1;
537 dest
->numsegments
= 0;
538 char *source
= strSources
;
542 while( (len
= strlen( source
)) )
545 float *sound
= sfx_vorbis( source
, dest
->ch
, &samples
);
550 dest
->numsegments
= 0;
556 float *nbuf
= realloc( dest
->main
, total
* dest
->ch
* sizeof(float) );
561 memcpy( dest
->main
+ (total
-samples
)*dest
->ch
, sound
, samples
*dest
->ch
*sizeof(float) );
564 dest
->segments
[ dest
->numsegments
*2+0 ] = total
-samples
;
565 dest
->segments
[ dest
->numsegments
*2+1 ] = total
;
569 vg_error( "realloc() failed\n" );
575 dest
->numsegments
++;
579 static void sfx_set_init( sfx_set
*dest
, char *sources
)
582 sfx_set_strings( dest
, dest
->sources
, dest
->flags
, 0 );
584 sfx_set_strings( dest
, sources
, dest
->flags
, 0 );
587 static void sfx_set_play( sfx_set
*source
, sfx_system
*sys
, int id
)
589 if( sfx_begin_edit( sys
) )
592 sys
->fadeout_current
= 0;
593 sys
->source
= source
->main
;
594 sys
->cur
= source
->segments
[ id
*2 + 0 ];
595 sys
->end
= source
->segments
[ id
*2 + 1 ];
596 sys
->ch
= source
->ch
;
599 sys
->clip_start
= sys
->cur
;
600 sys
->clip_end
= sys
->end
;
601 sys
->buffer_length
= source
->segments
[ (source
->numsegments
-1)*2 + 1 ];
607 // Pick a random sound from the buffer and play it into system
608 static void sfx_set_playrnd( sfx_set
*source
, sfx_system
*sys
, int min_id
, int max_id
)
610 if( !source
->numsegments
)
613 if( max_id
> source
->numsegments
)
615 vg_error( "Max ID out of range for playrnd\n" );
619 int pick
= (rand() % (max_id
-min_id
)) + min_id
;
621 sfx_set_play( source
, sys
, pick
);
624 static void sfx_system_fadeout( sfx_system
*sys
, u32 length_samples
)
626 if( sfx_begin_edit( sys
) )
628 sys
->fadeout_current
= length_samples
;
629 sys
->fadeout
= length_samples
;
635 // Free set resources
636 static void sfx_set_free( sfx_set
*set
)