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