/Users/hercules/trunk/SDL/include/SDL_audio.h File Reference

#include "SDL_stdinc.h"
#include "SDL_error.h"
#include "SDL_endian.h"
#include "SDL_mutex.h"
#include "SDL_thread.h"
#include "SDL_rwops.h"
#include "begin_code.h"
#include "close_code.h"

Go to the source code of this file.

Data Structures

struct SDL_AudioSpec

struct SDL_AudioCVT

Defines

#define SDL_AUDIO_MASK_BITSIZE   (0xFF)

#define SDL_AUDIO_MASK_DATATYPE   (1<<8)

#define SDL_AUDIO_MASK_ENDIAN   (1<<12)

#define SDL_AUDIO_MASK_SIGNED   (1<<15)

#define SDL_AUDIO_BITSIZE(x)   (x & SDL_AUDIO_MASK_BITSIZE)

#define SDL_AUDIO_ISFLOAT(x)   (x & SDL_AUDIO_MASK_DATATYPE)

#define SDL_AUDIO_ISBIGENDIAN(x)   (x & SDL_AUDIO_MASK_ENDIAN)

#define SDL_AUDIO_ISSIGNED(x)   (x & SDL_AUDIO_MASK_SIGNED)

#define SDL_AUDIO_ISINT(x)   (!SDL_AUDIO_ISFLOAT(x))

#define SDL_AUDIO_ISLITTLEENDIAN(x)   (!SDL_AUDIO_ISBIGENDIAN(x))

#define SDL_AUDIO_ISUNSIGNED(x)   (!SDL_AUDIO_ISSIGNED(x))

#define AUDIO_U8   0x0008

#define AUDIO_S8   0x8008

#define AUDIO_U16LSB   0x0010

#define AUDIO_S16LSB   0x8010

#define AUDIO_U16MSB   0x1010

#define AUDIO_S16MSB   0x9010

#define AUDIO_U16   AUDIO_U16LSB

#define AUDIO_S16   AUDIO_S16LSB

#define AUDIO_S32LSB   0x8020

#define AUDIO_S32MSB   0x9020

#define AUDIO_S32   AUDIO_S32LSB

#define AUDIO_F32LSB   0x8120

#define AUDIO_F32MSB   0x9120

#define AUDIO_F32   AUDIO_F32LSB

#define AUDIO_U16SYS   AUDIO_U16LSB

#define AUDIO_S16SYS   AUDIO_S16LSB

#define AUDIO_S32SYS   AUDIO_S32LSB

#define AUDIO_F32SYS   AUDIO_F32LSB

#define SDL_AUDIO_ALLOW_FREQUENCY_CHANGE   0x00000001

#define SDL_AUDIO_ALLOW_FORMAT_CHANGE   0x00000002

#define SDL_AUDIO_ALLOW_CHANNELS_CHANGE   0x00000004

#define SDL_AUDIO_ALLOW_ANY_CHANGE   (SDL_AUDIO_ALLOW_FREQUENCY_CHANGE|SDL_AUDIO_ALLOW_FORMAT_CHANGE|SDL_AUDIO_ALLOW_CHANNELS_CHANGE)

#define SDL_LoadWAV(file, spec, audio_buf, audio_len)   SDL_LoadWAV_RW(SDL_RWFromFile(file, "rb"),1, spec,audio_buf,audio_len)

#define SDL_MIX_MAXVOLUME   128

Typedefs

typedef Uint16 SDL_AudioFormat

typedef SDL_AudioFormat format

typedef Uint32 SDL_AudioDeviceID

Enumerations

enum SDL_audiostatus { SDL_AUDIO_STOPPED = 0, SDL_AUDIO_PLAYING, SDL_AUDIO_PAUSED }

Functions

typedef void (SDLCALL *SDL_AudioFilter)(struct SDL_AudioCVT *cvt

DECLSPEC int SDLCALL SDL_GetNumAudioDrivers (void)

DECLSPEC const char *SDLCALL SDL_GetAudioDriver (int index)

DECLSPEC int SDLCALL SDL_AudioInit (const char *driver_name)

DECLSPEC void SDLCALL SDL_AudioQuit (void)

DECLSPEC const char *SDLCALL SDL_GetCurrentAudioDriver (void)

DECLSPEC int SDLCALL SDL_OpenAudio (SDL_AudioSpec *desired, SDL_AudioSpec *obtained)

DECLSPEC int SDLCALL SDL_GetNumAudioDevices (int iscapture)

DECLSPEC const char *SDLCALL SDL_GetAudioDeviceName (int index, int iscapture)

DECLSPEC SDL_AudioDeviceID SDLCALL SDL_OpenAudioDevice (const char *device, int iscapture, const SDL_AudioSpec *desired, SDL_AudioSpec *obtained, int allowed_changes)

DECLSPEC SDL_audiostatus SDLCALL SDL_GetAudioStatus (void)

DECLSPEC SDL_audiostatus SDLCALL SDL_GetAudioDeviceStatus (SDL_AudioDeviceID dev)

DECLSPEC void SDLCALL SDL_PauseAudio (int pause_on)

DECLSPEC void SDLCALL SDL_PauseAudioDevice (SDL_AudioDeviceID dev, int pause_on)

DECLSPEC SDL_AudioSpec *SDLCALL SDL_LoadWAV_RW (SDL_RWops *src, int freesrc, SDL_AudioSpec *spec, Uint8 **audio_buf, Uint32 *audio_len)

DECLSPEC void SDLCALL SDL_FreeWAV (Uint8 *audio_buf)

DECLSPEC int SDLCALL SDL_BuildAudioCVT (SDL_AudioCVT *cvt, SDL_AudioFormat src_format, Uint8 src_channels, int src_rate, SDL_AudioFormat dst_format, Uint8 dst_channels, int dst_rate)

DECLSPEC int SDLCALL SDL_ConvertAudio (SDL_AudioCVT *cvt)

DECLSPEC void SDLCALL SDL_MixAudio (Uint8 *dst, const Uint8 *src, Uint32 len, int volume)

DECLSPEC void SDLCALL SDL_MixAudioFormat (Uint8 *dst, const Uint8 *src, SDL_AudioFormat format, Uint32 len, int volume)

DECLSPEC void SDLCALL SDL_LockAudio (void)

DECLSPEC void SDLCALL SDL_LockAudioDevice (SDL_AudioDeviceID dev)

DECLSPEC void SDLCALL SDL_UnlockAudio (void)

DECLSPEC void SDLCALL SDL_UnlockAudioDevice (SDL_AudioDeviceID dev)

DECLSPEC void SDLCALL SDL_CloseAudio (void)

DECLSPEC void SDLCALL SDL_CloseAudioDevice (SDL_AudioDeviceID dev)

DECLSPEC int SDLCALL SDL_AudioDeviceConnected (SDL_AudioDeviceID dev)

Detailed Description

Access to the raw audio mixing buffer for the SDL library


Data Structures
struct	SDL_AudioSpec
struct	SDL_AudioCVT
Defines
#define	SDL_AUDIO_MASK_BITSIZE (0xFF)
#define	SDL_AUDIO_MASK_DATATYPE (1<<8)
#define	SDL_AUDIO_MASK_ENDIAN (1<<12)
#define	SDL_AUDIO_MASK_SIGNED (1<<15)
#define	SDL_AUDIO_BITSIZE(x) (x & SDL_AUDIO_MASK_BITSIZE)
#define	SDL_AUDIO_ISFLOAT(x) (x & SDL_AUDIO_MASK_DATATYPE)
#define	SDL_AUDIO_ISBIGENDIAN(x) (x & SDL_AUDIO_MASK_ENDIAN)
#define	SDL_AUDIO_ISSIGNED(x) (x & SDL_AUDIO_MASK_SIGNED)
#define	SDL_AUDIO_ISINT(x) (!SDL_AUDIO_ISFLOAT(x))
#define	SDL_AUDIO_ISLITTLEENDIAN(x) (!SDL_AUDIO_ISBIGENDIAN(x))
#define	SDL_AUDIO_ISUNSIGNED(x) (!SDL_AUDIO_ISSIGNED(x))
#define	AUDIO_U8 0x0008
#define	AUDIO_S8 0x8008
#define	AUDIO_U16LSB 0x0010
#define	AUDIO_S16LSB 0x8010
#define	AUDIO_U16MSB 0x1010
#define	AUDIO_S16MSB 0x9010
#define	AUDIO_U16 AUDIO_U16LSB
#define	AUDIO_S16 AUDIO_S16LSB
#define	AUDIO_S32LSB 0x8020
#define	AUDIO_S32MSB 0x9020
#define	AUDIO_S32 AUDIO_S32LSB
#define	AUDIO_F32LSB 0x8120
#define	AUDIO_F32MSB 0x9120
#define	AUDIO_F32 AUDIO_F32LSB
#define	AUDIO_U16SYS AUDIO_U16LSB
#define	AUDIO_S16SYS AUDIO_S16LSB
#define	AUDIO_S32SYS AUDIO_S32LSB
#define	AUDIO_F32SYS AUDIO_F32LSB
#define	SDL_AUDIO_ALLOW_FREQUENCY_CHANGE 0x00000001
#define	SDL_AUDIO_ALLOW_FORMAT_CHANGE 0x00000002
#define	SDL_AUDIO_ALLOW_CHANNELS_CHANGE 0x00000004
#define	SDL_AUDIO_ALLOW_ANY_CHANGE (SDL_AUDIO_ALLOW_FREQUENCY_CHANGE\|SDL_AUDIO_ALLOW_FORMAT_CHANGE\|SDL_AUDIO_ALLOW_CHANNELS_CHANGE)
#define	SDL_LoadWAV(file, spec, audio_buf, audio_len) SDL_LoadWAV_RW(SDL_RWFromFile(file, "rb"),1, spec,audio_buf,audio_len)
#define	SDL_MIX_MAXVOLUME 128
Typedefs
typedef Uint16	SDL_AudioFormat
typedef SDL_AudioFormat	format
typedef Uint32	SDL_AudioDeviceID
Enumerations
enum	SDL_audiostatus { SDL_AUDIO_STOPPED = 0, SDL_AUDIO_PLAYING, SDL_AUDIO_PAUSED }
Functions
typedef	void (SDLCALL SDL_AudioFilter)(struct SDL_AudioCVT cvt
DECLSPEC int SDLCALL	SDL_GetNumAudioDrivers (void)
DECLSPEC const char *SDLCALL	SDL_GetAudioDriver (int index)
DECLSPEC int SDLCALL	SDL_AudioInit (const char *driver_name)
DECLSPEC void SDLCALL	SDL_AudioQuit (void)
DECLSPEC const char *SDLCALL	SDL_GetCurrentAudioDriver (void)
DECLSPEC int SDLCALL	SDL_OpenAudio (SDL_AudioSpec desired, SDL_AudioSpec obtained)
DECLSPEC int SDLCALL	SDL_GetNumAudioDevices (int iscapture)
DECLSPEC const char *SDLCALL	SDL_GetAudioDeviceName (int index, int iscapture)
DECLSPEC SDL_AudioDeviceID SDLCALL	SDL_OpenAudioDevice (const char device, int iscapture, const SDL_AudioSpec desired, SDL_AudioSpec *obtained, int allowed_changes)
DECLSPEC SDL_audiostatus SDLCALL	SDL_GetAudioStatus (void)
DECLSPEC SDL_audiostatus SDLCALL	SDL_GetAudioDeviceStatus (SDL_AudioDeviceID dev)
DECLSPEC void SDLCALL	SDL_PauseAudio (int pause_on)
DECLSPEC void SDLCALL	SDL_PauseAudioDevice (SDL_AudioDeviceID dev, int pause_on)
DECLSPEC SDL_AudioSpec *SDLCALL	SDL_LoadWAV_RW (SDL_RWops src, int freesrc, SDL_AudioSpec spec, Uint8 *audio_buf, Uint32 audio_len)
DECLSPEC void SDLCALL	SDL_FreeWAV (Uint8 *audio_buf)
DECLSPEC int SDLCALL	SDL_BuildAudioCVT (SDL_AudioCVT *cvt, SDL_AudioFormat src_format, Uint8 src_channels, int src_rate, SDL_AudioFormat dst_format, Uint8 dst_channels, int dst_rate)
DECLSPEC int SDLCALL	SDL_ConvertAudio (SDL_AudioCVT *cvt)
DECLSPEC void SDLCALL	SDL_MixAudio (Uint8 dst, const Uint8 src, Uint32 len, int volume)
DECLSPEC void SDLCALL	SDL_MixAudioFormat (Uint8 dst, const Uint8 src, SDL_AudioFormat format, Uint32 len, int volume)
DECLSPEC void SDLCALL	SDL_LockAudio (void)
DECLSPEC void SDLCALL	SDL_LockAudioDevice (SDL_AudioDeviceID dev)
DECLSPEC void SDLCALL	SDL_UnlockAudio (void)
DECLSPEC void SDLCALL	SDL_UnlockAudioDevice (SDL_AudioDeviceID dev)
DECLSPEC void SDLCALL	SDL_CloseAudio (void)
DECLSPEC void SDLCALL	SDL_CloseAudioDevice (SDL_AudioDeviceID dev)
DECLSPEC int SDLCALL	SDL_AudioDeviceConnected (SDL_AudioDeviceID dev)