/**
 * @file sound.h
 * @brief Specifies sound API?
 */

/*
All original materal Copyright (C) 2002-2007 UFO: Alien Invasion team.

15/06/06, Eddy Cullen (ScreamingWithNoSound):
	Reformatted to agreed style.
	Added doxygen file comment.
	Updated copyright notice.
	Added inclusion guard.

Original file from Quake 2 v3.21: quake2-2.31/client/sound.h
Copyright (C) 1997-2001 Id Software, Inc.

This program is free software; you can redistribute it and/or
modify it under the terms of the GNU General Public License
as published by the Free Software Foundation; either version 2
of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.

See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with this program; if not, write to the Free Software
Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.

*/

#ifndef CLIENT_SOUND_H
#define CLIENT_SOUND_H

struct sfx_s;

typedef struct snd_stream_s
{
	qFILE file;
	int length;
	int pos;
} snd_stream_t;

void S_Init(void);
void S_Shutdown(void);
void S_Activate(qboolean active);

/* if origin is NULL, the sound will be dynamically sourced from the entity */
void S_StartSound(vec3_t origin, int entnum, int entchannel, struct sfx_s *sfx, float fvol, float attenuation, float timeofs);
void S_StartLocalSound(const char *s);

void S_RawSamples(int samples, int rate, int width, int channels, byte * data, float volume);

void S_StopAllSounds(void);
void S_Update(vec3_t origin, vec3_t v_forward, vec3_t v_right, vec3_t v_up);

void S_BeginRegistration(void);
struct sfx_s *S_RegisterSound(const char *sample);
void S_EndRegistration(void);

/* the sound code makes callbacks to the client for entity position */
/* information, so entities can be dynamically re-spatialized */
void CL_GetEntitySoundOrigin(int ent, vec3_t org);

#endif /* CLIENT_SOUND_H */