s_main.h File Reference

Specifies sound API? More...

#include <SDL_mixer.h>

Include dependency graph for s_main.h:

This graph shows which files directly or indirectly include this file:

Data Structures
struct	s_sample_s
struct	s_channel_s
struct	s_env_s
	the sound environment More...
Defines
#define	MAX_CHANNELS 64
#define	SND_VOLUME_DEFAULT 1.0f
#define	SND_VOLUME_WEAPONS 1.0f
Typedefs
typedef struct s_sample_s	s_sample_t
typedef struct s_channel_s	s_channel_t
typedef struct s_env_s	s_env_t
	the sound environment
Enumerations
enum	{ SOUND_WATER_IN, SOUND_WATER_OUT, SOUND_WATER_MOVE, MAX_SOUNDIDS }
	These sounds are precached in S_LoadSamples. More...
Functions
void	S_Init (void)
void	S_Shutdown (void)
void	S_Frame (void)
void	S_Stop (void)
	Stop all channels.
void	S_PlaySample (const vec3_t origin, s_sample_t *sample, float atten, float volume)
	Validates the parms and queues the sound up.
void	S_StartLocalSample (const char *s, float volume)
	Plays a sample without spatialization.
s_sample_t *	S_LoadSample (const char *s)
	Loads and registers a sound file for later use.
Variables
s_env_t	s_env

Detailed Description

Specifies sound API?

Definition in file s_main.h.

Define Documentation

#define MAX_CHANNELS 64

Definition at line 34 of file s_main.h.

Referenced by S_AllocChannel(), S_Frame(), S_Init(), and S_LoopSample().

#define SND_VOLUME_DEFAULT 1.0f

Definition at line 76 of file s_main.h.

Referenced by CL_ActorDoThrow(), CL_ActorPlaySound(), CL_DoEndRound(), CL_ParseServerMessage(), CL_ParseStartSoundPacket(), CL_SpawnParseEntitystring(), Irc_AppendToBuffer(), Irc_Client_CmdPrivmsg(), LE_AddAmbientSound(), MS_AddNewMessageSound(), S_Play_f(), SEQ_ExecuteSound(), and UI_PlaySound().

#define SND_VOLUME_WEAPONS 1.0f

Definition at line 77 of file s_main.h.

Referenced by CL_ActorDoShoot(), CL_ActorShootHidden(), CL_InvReload(), LE_AddProjectile(), and LET_Projectile().

Typedef Documentation

typedef struct s_channel_s s_channel_t

typedef struct s_env_s s_env_t

the sound environment

typedef struct s_sample_s s_sample_t

Enumeration Type Documentation

anonymous enum

These sounds are precached in S_LoadSamples.

Enumerator:

SOUND_WATER_IN
SOUND_WATER_OUT
SOUND_WATER_MOVE
MAX_SOUNDIDS

Definition at line 37 of file s_main.h.

Function Documentation

void S_Frame ( void )

See also:: CL_Frame

Definition at line 62 of file s_main.c.

References AngleVectors(), le_s::attenuation, s_env_s::channels, cl, CL_OnBattlescape(), s_channel_s::count, ET_SOUND, i, s_env_s::initialized, LE_GetNextInUse(), M_Frame(), MAX_CHANNELS, cvar_s::modified, le_s::origin, qfalse, s_env_s::right, S_LoopSample(), S_Restart_f(), S_SpatializeChannel(), le_s::sample, s_channel_s::sample, le_s::type, and le_s::volume.

Referenced by CL_Frame(), and CL_InitAfter().

void S_Init ( void )

See also:: S_Shutdown; S_Restart_f

Todo:: implement the volume change for already loaded sample chunks

Definition at line 185 of file s_main.c.

References Cmd_AddCommand(), Cmd_AddParamCompleteFunction(), Cmd_Dummy_f(), Com_Printf(), CVAR_ARCHIVE, Cvar_Get(), s_env_s::format, s_env_s::initialized, cvar_s::integer, M_Init(), MAX_CHANNELS, MAX_VAR, cvar_s::modified, s_env_s::numChannels, Q_strncpyz(), qfalse, qtrue, s_env_s::rate, S_CompleteSounds(), S_FreeChannel(), S_Play_f(), and S_Restart_f().

Referenced by CL_Init(), and S_Restart_f().

s_sample_t* S_LoadSample ( const char * soundFile )

Loads and registers a sound file for later use.

Parameters:

[in] soundFile The name of the soundfile, relative to the sounds dir

See also:: S_LoadSound

Definition at line 105 of file s_sample.c.

References s_sample_s::chunk, chunk(), cl_soundSysPool, Com_HashKey(), Com_StripExtension(), hash(), s_sample_s::hashNext, s_env_s::initialized, MAX_QPATH, Mem_PoolAlloc, Mem_PoolStrDup, s_sample_s::name, name, s_env, S_FindName(), S_LoadSampleChunk(), and SAMPLE_HASH_SIZE.

Referenced by CL_ActorDoShoot(), CL_ActorDoThrow(), CL_ActorPlaySound(), CL_InvReload(), CL_ParseStartSoundPacket(), LE_AddAmbientSound(), LE_AddProjectile(), LE_PlaySoundFileAndParticleForSurface(), LET_Projectile(), S_LoadSamples(), and S_StartLocalSample().

void S_PlaySample	(	const vec3_t	origin,
		s_sample_t *	sample,
		float	atten,
		float	relVolume
	)

Validates the parms and queues the sound up.

Parameters:

`[in]`	origin	if this is `NULL`, the sound will be dynamically sourced from the entity
`[in]`	sample	The soundfile to play
`[in]`	atten	Attenuation of sound to be played (for example, `fireAttenuation` or `impactAttenuation` from `fireDef_s`).
`[in]`	relVolume	Max mixer volume factor (0.0 - 1.0)