sound.h

/*
 * See Licensing and Copyright notice in naev.h
 */
#pragma once

#include "SDL_mutex.h"
#include "SDL_rwops.h"
#include "nopenal.h"
#include <vorbis/vorbisfile.h>
 
/*
 * Some OpenAL extension defines.
 */
#ifndef ALC_OUTPUT_LIMITER_SOFT
#define ALC_OUTPUT_LIMITER_SOFT 0x199A
#endif /* ALC_OUTPUT_LIMITER_SOFT */
 
extern int sound_disabled;
 
#define SOUND_REFERENCE_DISTANCE 500. 
#define SOUND_MAX_DISTANCE 25e3       
 
/*
 * Static configuration.
 */
#define SOUND_PILOT_RELATIVE                                                   \
   1 
 
/*
 * Environmental features.
 */
typedef enum SoundEnv_e {
   SOUND_ENV_NORMAL, 
   SOUND_ENV_NEBULA  
} SoundEnv_t;        
 
typedef struct alInfo_s {
   ALCint freq;           
   ALCint nmono;          
   ALCint nstereo;        
   ALint  output_limiter; 
   ALint  efx;            
   ALint  efx_major;      
   ALint  efx_minor;      
   ALint  efx_auxSends;   
   /* Effect types. */
   ALint efx_reverb; 
   ALint efx_echo;   
} alInfo_t;
extern alInfo_t al_info;
 
extern ALuint sound_efx_directSlot; 
 
/*
 * Vorbis stuff.
 */
extern ov_callbacks sound_al_ovcall;
extern ov_callbacks sound_al_ovcall_noclose;
 
/*
 * sound subsystem
 */
int    sound_init( void );
void   sound_exit( void );
int    sound_update( double dt );
void   sound_pause( void );
void   sound_resume( void );
int    sound_volume( const double vol );
double sound_getVolume( void );
double sound_getVolumeLog( void );
void   sound_stopAll( void );
void   sound_setSpeed( double s );
 
/*
 * source management
 */
int source_newRW( SDL_RWops *rw, const char *name, unsigned int flags );
int source_new( const char *filename, unsigned int flags );
 
/*
 * sound sample management
 */
int    sound_get( const char *name );
double sound_getLength( int sound );
 
/*
 * voice management
 */
int  sound_play( int sound );
int  sound_playPos( int sound, double px, double py, double vx, double vy );
void sound_stop( int voice );
int  sound_updatePos( int voice, double px, double py, double vx, double vy );
int  sound_updateListener( double dir, double px, double py, double vx,
                           double vy );
 
/*
 * Group functions.
 */
int  sound_reserve( int num );
int  sound_createGroup( int size );
int  sound_playGroup( int group, int sound, int once );
void sound_stopGroup( int group );
void sound_pauseGroup( int group );
void sound_resumeGroup( int group );
void sound_speedGroup( int group, int enable );
void sound_volumeGroup( int group, double volume );
void sound_pitchGroup( int group, double pitch );
 
/*
 * Environmental functions.
 */
void sound_setAbsorption( double value );
int  sound_env( SoundEnv_t env, double param );
 
/*
 * Vorbis filtering.
 */
#define RG_PREAMP_DB 0.0 
typedef struct rg_filter_param_s {
   float rg_scale_factor;
   float rg_max_scale;
} rg_filter_param_t;
void rg_filter( float **pcm, long channels, long samples, void *filter_param );
 
/* Lock for OpenAL operations. */
int sound_al_buffer( ALuint *buf, SDL_RWops *rw, const char *name );
extern SDL_mutex
   *sound_lock; 
#define soundLock() SDL_mutexP( sound_lock )
#define soundUnlock() SDL_mutexV( sound_lock )