include/SDL_audio.h
author Sam Lantinga <slouken@libsdl.org>
Wed, 01 Feb 2006 06:32:25 +0000
changeset 1312 c9b51268668f
parent 930 02759105b989
child 1330 450721ad5436
permissions -rw-r--r--
Updated copyright information and removed rcs id lines (problematic in branch merges)
I batch edited these files, so please let me know if I've accidentally removed anybody's
credit here.
     1 /*
     2     SDL - Simple DirectMedia Layer
     3     Copyright (C) 1997-2006 Sam Lantinga
     4 
     5     This library is free software; you can redistribute it and/or
     6     modify it under the terms of the GNU Lesser General Public
     7     License as published by the Free Software Foundation; either
     8     version 2.1 of the License, or (at your option) any later version.
     9 
    10     This library is distributed in the hope that it will be useful,
    11     but WITHOUT ANY WARRANTY; without even the implied warranty of
    12     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
    13     Lesser General Public License for more details.
    14 
    15     You should have received a copy of the GNU Lesser General Public
    16     License along with this library; if not, write to the Free Software
    17     Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
    18 
    19     Sam Lantinga
    20     slouken@libsdl.org
    21 */
    22 
    23 /* Access to the raw audio mixing buffer for the SDL library */
    24 
    25 #ifndef _SDL_audio_h
    26 #define _SDL_audio_h
    27 
    28 #include <stdio.h>
    29 
    30 #include "SDL_main.h"
    31 #include "SDL_types.h"
    32 #include "SDL_error.h"
    33 #include "SDL_rwops.h"
    34 #include "SDL_byteorder.h"
    35 
    36 #include "begin_code.h"
    37 /* Set up for C function definitions, even when using C++ */
    38 #ifdef __cplusplus
    39 extern "C" {
    40 #endif
    41 
    42 /* The calculated values in this structure are calculated by SDL_OpenAudio() */
    43 typedef struct SDL_AudioSpec {
    44 	int freq;		/* DSP frequency -- samples per second */
    45 	Uint16 format;		/* Audio data format */
    46 	Uint8  channels;	/* Number of channels: 1 mono, 2 stereo */
    47 	Uint8  silence;		/* Audio buffer silence value (calculated) */
    48 	Uint16 samples;		/* Audio buffer size in samples (power of 2) */
    49 	Uint16 padding;		/* Necessary for some compile environments */
    50 	Uint32 size;		/* Audio buffer size in bytes (calculated) */
    51 	/* This function is called when the audio device needs more data.
    52 	   'stream' is a pointer to the audio data buffer
    53 	   'len' is the length of that buffer in bytes.
    54 	   Once the callback returns, the buffer will no longer be valid.
    55 	   Stereo samples are stored in a LRLRLR ordering.
    56 	*/
    57 	void (SDLCALL *callback)(void *userdata, Uint8 *stream, int len);
    58 	void  *userdata;
    59 } SDL_AudioSpec;
    60 
    61 /* Audio format flags (defaults to LSB byte order) */
    62 #define AUDIO_U8	0x0008	/* Unsigned 8-bit samples */
    63 #define AUDIO_S8	0x8008	/* Signed 8-bit samples */
    64 #define AUDIO_U16LSB	0x0010	/* Unsigned 16-bit samples */
    65 #define AUDIO_S16LSB	0x8010	/* Signed 16-bit samples */
    66 #define AUDIO_U16MSB	0x1010	/* As above, but big-endian byte order */
    67 #define AUDIO_S16MSB	0x9010	/* As above, but big-endian byte order */
    68 #define AUDIO_U16	AUDIO_U16LSB
    69 #define AUDIO_S16	AUDIO_S16LSB
    70 
    71 /* Native audio byte ordering */
    72 #if SDL_BYTEORDER == SDL_LIL_ENDIAN
    73 #define AUDIO_U16SYS	AUDIO_U16LSB
    74 #define AUDIO_S16SYS	AUDIO_S16LSB
    75 #else
    76 #define AUDIO_U16SYS	AUDIO_U16MSB
    77 #define AUDIO_S16SYS	AUDIO_S16MSB
    78 #endif
    79 
    80 
    81 /* A structure to hold a set of audio conversion filters and buffers */
    82 typedef struct SDL_AudioCVT {
    83 	int needed;			/* Set to 1 if conversion possible */
    84 	Uint16 src_format;		/* Source audio format */
    85 	Uint16 dst_format;		/* Target audio format */
    86 	double rate_incr;		/* Rate conversion increment */
    87 	Uint8 *buf;			/* Buffer to hold entire audio data */
    88 	int    len;			/* Length of original audio buffer */
    89 	int    len_cvt;			/* Length of converted audio buffer */
    90 	int    len_mult;		/* buffer must be len*len_mult big */
    91 	double len_ratio; 	/* Given len, final size is len*len_ratio */
    92 	void (SDLCALL *filters[10])(struct SDL_AudioCVT *cvt, Uint16 format);
    93 	int filter_index;		/* Current audio conversion function */
    94 } SDL_AudioCVT;
    95 
    96 
    97 /* Function prototypes */
    98 
    99 /* These functions are used internally, and should not be used unless you
   100  * have a specific need to specify the audio driver you want to use.
   101  * You should normally use SDL_Init() or SDL_InitSubSystem().
   102  */
   103 extern DECLSPEC int SDLCALL SDL_AudioInit(const char *driver_name);
   104 extern DECLSPEC void SDLCALL SDL_AudioQuit(void);
   105 
   106 /* This function fills the given character buffer with the name of the
   107  * current audio driver, and returns a pointer to it if the audio driver has
   108  * been initialized.  It returns NULL if no driver has been initialized.
   109  */
   110 extern DECLSPEC char * SDLCALL SDL_AudioDriverName(char *namebuf, int maxlen);
   111 
   112 /*
   113  * This function opens the audio device with the desired parameters, and
   114  * returns 0 if successful, placing the actual hardware parameters in the
   115  * structure pointed to by 'obtained'.  If 'obtained' is NULL, the audio
   116  * data passed to the callback function will be guaranteed to be in the
   117  * requested format, and will be automatically converted to the hardware
   118  * audio format if necessary.  This function returns -1 if it failed 
   119  * to open the audio device, or couldn't set up the audio thread.
   120  *
   121  * When filling in the desired audio spec structure,
   122  *  'desired->freq' should be the desired audio frequency in samples-per-second.
   123  *  'desired->format' should be the desired audio format.
   124  *  'desired->samples' is the desired size of the audio buffer, in samples.
   125  *     This number should be a power of two, and may be adjusted by the audio
   126  *     driver to a value more suitable for the hardware.  Good values seem to
   127  *     range between 512 and 8096 inclusive, depending on the application and
   128  *     CPU speed.  Smaller values yield faster response time, but can lead
   129  *     to underflow if the application is doing heavy processing and cannot
   130  *     fill the audio buffer in time.  A stereo sample consists of both right
   131  *     and left channels in LR ordering.
   132  *     Note that the number of samples is directly related to time by the
   133  *     following formula:  ms = (samples*1000)/freq
   134  *  'desired->size' is the size in bytes of the audio buffer, and is
   135  *     calculated by SDL_OpenAudio().
   136  *  'desired->silence' is the value used to set the buffer to silence,
   137  *     and is calculated by SDL_OpenAudio().
   138  *  'desired->callback' should be set to a function that will be called
   139  *     when the audio device is ready for more data.  It is passed a pointer
   140  *     to the audio buffer, and the length in bytes of the audio buffer.
   141  *     This function usually runs in a separate thread, and so you should
   142  *     protect data structures that it accesses by calling SDL_LockAudio()
   143  *     and SDL_UnlockAudio() in your code.
   144  *  'desired->userdata' is passed as the first parameter to your callback
   145  *     function.
   146  *
   147  * The audio device starts out playing silence when it's opened, and should
   148  * be enabled for playing by calling SDL_PauseAudio(0) when you are ready
   149  * for your audio callback function to be called.  Since the audio driver
   150  * may modify the requested size of the audio buffer, you should allocate
   151  * any local mixing buffers after you open the audio device.
   152  */
   153 extern DECLSPEC int SDLCALL SDL_OpenAudio(SDL_AudioSpec *desired, SDL_AudioSpec *obtained);
   154 
   155 /*
   156  * Get the current audio state:
   157  */
   158 typedef enum {
   159 	SDL_AUDIO_STOPPED = 0,
   160 	SDL_AUDIO_PLAYING,
   161 	SDL_AUDIO_PAUSED
   162 } SDL_audiostatus;
   163 extern DECLSPEC SDL_audiostatus SDLCALL SDL_GetAudioStatus(void);
   164 
   165 /*
   166  * This function pauses and unpauses the audio callback processing.
   167  * It should be called with a parameter of 0 after opening the audio
   168  * device to start playing sound.  This is so you can safely initialize
   169  * data for your callback function after opening the audio device.
   170  * Silence will be written to the audio device during the pause.
   171  */
   172 extern DECLSPEC void SDLCALL SDL_PauseAudio(int pause_on);
   173 
   174 /*
   175  * This function loads a WAVE from the data source, automatically freeing
   176  * that source if 'freesrc' is non-zero.  For example, to load a WAVE file,
   177  * you could do:
   178  *	SDL_LoadWAV_RW(SDL_RWFromFile("sample.wav", "rb"), 1, ...);
   179  *
   180  * If this function succeeds, it returns the given SDL_AudioSpec,
   181  * filled with the audio data format of the wave data, and sets
   182  * 'audio_buf' to a malloc()'d buffer containing the audio data,
   183  * and sets 'audio_len' to the length of that audio buffer, in bytes.
   184  * You need to free the audio buffer with SDL_FreeWAV() when you are 
   185  * done with it.
   186  *
   187  * This function returns NULL and sets the SDL error message if the 
   188  * wave file cannot be opened, uses an unknown data format, or is 
   189  * corrupt.  Currently raw and MS-ADPCM WAVE files are supported.
   190  */
   191 extern DECLSPEC SDL_AudioSpec * SDLCALL SDL_LoadWAV_RW(SDL_RWops *src, int freesrc, SDL_AudioSpec *spec, Uint8 **audio_buf, Uint32 *audio_len);
   192 
   193 /* Compatibility convenience function -- loads a WAV from a file */
   194 #define SDL_LoadWAV(file, spec, audio_buf, audio_len) \
   195 	SDL_LoadWAV_RW(SDL_RWFromFile(file, "rb"),1, spec,audio_buf,audio_len)
   196 
   197 /*
   198  * This function frees data previously allocated with SDL_LoadWAV_RW()
   199  */
   200 extern DECLSPEC void SDLCALL SDL_FreeWAV(Uint8 *audio_buf);
   201 
   202 /*
   203  * This function takes a source format and rate and a destination format
   204  * and rate, and initializes the 'cvt' structure with information needed
   205  * by SDL_ConvertAudio() to convert a buffer of audio data from one format
   206  * to the other.
   207  * This function returns 0, or -1 if there was an error.
   208  */
   209 extern DECLSPEC int SDLCALL SDL_BuildAudioCVT(SDL_AudioCVT *cvt,
   210 		Uint16 src_format, Uint8 src_channels, int src_rate,
   211 		Uint16 dst_format, Uint8 dst_channels, int dst_rate);
   212 
   213 /* Once you have initialized the 'cvt' structure using SDL_BuildAudioCVT(),
   214  * created an audio buffer cvt->buf, and filled it with cvt->len bytes of
   215  * audio data in the source format, this function will convert it in-place
   216  * to the desired format.
   217  * The data conversion may expand the size of the audio data, so the buffer
   218  * cvt->buf should be allocated after the cvt structure is initialized by
   219  * SDL_BuildAudioCVT(), and should be cvt->len*cvt->len_mult bytes long.
   220  */
   221 extern DECLSPEC int SDLCALL SDL_ConvertAudio(SDL_AudioCVT *cvt);
   222 
   223 /*
   224  * This takes two audio buffers of the playing audio format and mixes
   225  * them, performing addition, volume adjustment, and overflow clipping.
   226  * The volume ranges from 0 - 128, and should be set to SDL_MIX_MAXVOLUME
   227  * for full audio volume.  Note this does not change hardware volume.
   228  * This is provided for convenience -- you can mix your own audio data.
   229  */
   230 #define SDL_MIX_MAXVOLUME 128
   231 extern DECLSPEC void SDLCALL SDL_MixAudio(Uint8 *dst, const Uint8 *src, Uint32 len, int volume);
   232 
   233 /*
   234  * The lock manipulated by these functions protects the callback function.
   235  * During a LockAudio/UnlockAudio pair, you can be guaranteed that the
   236  * callback function is not running.  Do not call these from the callback
   237  * function or you will cause deadlock.
   238  */
   239 extern DECLSPEC void SDLCALL SDL_LockAudio(void);
   240 extern DECLSPEC void SDLCALL SDL_UnlockAudio(void);
   241 
   242 /*
   243  * This function shuts down audio processing and closes the audio device.
   244  */
   245 extern DECLSPEC void SDLCALL SDL_CloseAudio(void);
   246 
   247 
   248 /* Ends C function definitions when using C++ */
   249 #ifdef __cplusplus
   250 }
   251 #endif
   252 #include "close_code.h"
   253 
   254 #endif /* _SDL_audio_h */