s_main.h File Reference

Specifies sound API? More...

#include "../../shared/mathlib.h"

Go to the source code of this file.

Macros
#define	SND_VOLUME_DEFAULT   1.0f
#define	SND_VOLUME_WEAPONS   1.0f

Enumerations
enum	stdsound_t { 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. More...
void	S_PlayStdSample (const stdsound_t sId, const vec3_t origin, float atten, float volume)
	plays one of the precached samples More...
void	S_StartLocalSample (const char *s, float volume)
	Plays a sample without spatialization. More...
int	S_LoadSampleIdx (const char *soundFile)
	Loads and registers a sound file for later use. More...
bool	S_LoadAndPlaySample (const char *s, const vec3_t origin, float atten, float volume)
	does what the name implies in just one function to avoid exposing s_sample_t More...
void	S_SetSampleRepeatRate (int sampleRepeatRate)
	Controls the repeat rate for the same sample. More...
void	S_LoadSamples (void)
	Wrapper for S_PrecacheSamples to avoid exposing it via s_sample.h. More...

Detailed Description

Specifies sound API?

Definition in file s_main.h.

Macro Definition Documentation

#define SND_VOLUME_DEFAULT   1.0f

Definition at line 42 of file s_main.h.

Referenced by CL_ActorDoThrow(), CL_ActorPlaySound(), CL_DoEndRound(), CL_Explode(), CL_SoundEvent(), CL_SpawnParseEntitystring(), GAME_AddChatMessage(), Irc_AppendToBuffer(), Irc_Client_CmdPrivmsg(), LE_AddAmbientSound(), S_Play_f(), SEQ_ExecuteSound(), and UI_PlaySound().

#define SND_VOLUME_WEAPONS   1.0f

Definition at line 43 of file s_main.h.

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

Enumeration Type Documentation

enum stdsound_t

These sounds are precached in S_LoadSamples.

Enumerator
SOUND_WATER_IN
SOUND_WATER_OUT
SOUND_WATER_MOVE
MAX_SOUNDIDS

Definition at line 34 of file s_main.h.

Function Documentation

void S_Frame

(

void

)

See also

CL_Frame

Definition at line 70 of file s_main.cpp.

References le_s::attenuation, camera_s::axis, AXIS_FORWARD, AXIS_RIGHT, AXIS_UP, clientBattleScape_s::cam, camera_s::camorg, 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, s_env_s::right, S_GetSample(), S_LoopSample(), S_MumbleUpdate(), S_Restart_f(), S_SpatializeChannel(), s_channel_s::sample, le_s::sampleIdx, le_s::type, VectorCopy, 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 172 of file s_main.cpp.

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

Referenced by CL_Init(), and S_Restart_f().

bool S_LoadAndPlaySample	(	const char *	s,
		const vec3_t	origin,
		float	attenuation,
		float	volume
	)

does what the name implies in just one function to avoid exposing s_sample_t

Parameters

s	name of the sample
origin	where to play it
attenuation	how to reduce volume by distance
volume	well, the volume

Definition at line 314 of file s_main.cpp.

References Q_strnull(), S_LoadSample(), and S_PlaySample().

Referenced by CL_ActorDoShoot(), CL_ActorDoThrow(), CL_ActorPlaySound(), CL_ActorShootHidden(), CL_Explode(), CL_InvReload(), CL_SoundEvent(), LE_AddProjectile(), LE_PlayFootStepSound(), LE_PlaySoundFileAndParticleForSurface(), and LET_Projectile().

int S_LoadSampleIdx

(

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

Returns

The index of the loaded sample or 0

See also

S_LoadSound

Definition at line 105 of file s_sample.cpp.

References s_sample_s::chunk, cl_soundSysPool, Com_HashKey(), Com_StripExtension(), hash, s_sample_s::hashNext, s_sample_s::index, s_env_s::initialized, MAX_QPATH, Mem_PoolAllocType, Mem_PoolStrDup, s_sample_s::name, name, s_env, S_FindByName(), S_LoadSampleChunk(), SAMPLE_HASH_SIZE, and sampleIndexLast.

Referenced by LE_AddAmbientSound(), and S_LoadSample().

void S_LoadSamples

(

void

)

Wrapper for S_PrecacheSamples to avoid exposing it via s_sample.h.

Definition at line 359 of file s_main.cpp.

References S_PrecacheSamples().

Referenced by CL_InitAfter(), and S_Restart_f().

void S_PlayStdSample	(	const stdsound_t	sId,
		const vec3_t	origin,
		float	attenuation,
		float	volume
	)

plays one of the precached samples

Parameters

sId	ID of the sample
origin	where to play it
attenuation	how to reduce volume by distance
volume	well, the volume

Definition at line 333 of file s_main.cpp.

References S_PlaySample().

Referenced by LE_PlaySoundFileForContents().

void S_SetSampleRepeatRate

(

int

sampleRepeatRate

)

Controls the repeat rate for the same sample.

Parameters

[in]

sampleRepeatRate

milliseconds that must have passed to play the same sample again

Definition at line 352 of file s_main.cpp.

References s_env_s::sampleRepeatRate.

Referenced by GAME_GetImportData().

void S_Shutdown

(

void

)

See also

S_Init

S_Restart_f

Definition at line 275 of file s_main.cpp.

References Cmd_RemoveCommand(), s_env_s::initialized, M_Shutdown(), Mem_DeletePool, S_FreeSamples(), and S_Stop().

Referenced by CL_Shutdown(), and S_Restart_f().

void S_StartLocalSample	(	const char *	name,
		float	relVolume
	)

Plays a sample without spatialization.

Parameters

[in]	name	The sample name
[in]	relVolume	Max mixer volume factor (0.0 - 1.0)

See also

S_PlaySample

S_LoadSample

Definition at line 184 of file s_mix.cpp.

References Com_Printf(), s_env_s::initialized, s_env, S_LoadSample(), S_PlaySample(), and SOUND_ATTN_NORM.

Referenced by CL_DoEndRound(), GAME_AddChatMessage(), GAME_GetImportData(), Irc_AppendToBuffer(), Irc_Client_CmdPrivmsg(), S_Play_f(), SEQ_ExecuteSound(), and UI_PlaySound().

void S_Stop

(

void

)

Stop all channels.

Definition at line 58 of file s_main.cpp.

References s_env_s::channels, s_env_s::initialized, OBJZERO, and S_MumbleUnlink().

Referenced by CL_Disconnect(), and S_Shutdown().