SDL_mixer.h
author Sam Lantinga <slouken@libsdl.org>
Sun, 15 Nov 2009 09:41:26 +0000
changeset 480 30976a327fd3
parent 477 c44842cb1d90
child 481 286c27f54ea1
permissions -rw-r--r--
warning: function declaration isn't a prototype
slouken@34
     1
/*
slouken@137
     2
    SDL_mixer:  An audio mixer library based on the SDL library
slouken@386
     3
    Copyright (C) 1997-2009 Sam Lantinga
slouken@34
     4
slouken@34
     5
    This library is free software; you can redistribute it and/or
slouken@34
     6
    modify it under the terms of the GNU Library General Public
slouken@34
     7
    License as published by the Free Software Foundation; either
slouken@34
     8
    version 2 of the License, or (at your option) any later version.
slouken@34
     9
slouken@34
    10
    This library is distributed in the hope that it will be useful,
slouken@34
    11
    but WITHOUT ANY WARRANTY; without even the implied warranty of
slouken@34
    12
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
slouken@34
    13
    Library General Public License for more details.
slouken@34
    14
slouken@34
    15
    You should have received a copy of the GNU Library General Public
slouken@34
    16
    License along with this library; if not, write to the Free
slouken@34
    17
    Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
slouken@34
    18
slouken@34
    19
    Sam Lantinga
slouken@137
    20
    slouken@libsdl.org
slouken@34
    21
*/
slouken@34
    22
slouken@140
    23
/* $Id$ */
slouken@137
    24
slouken@229
    25
#ifndef _SDL_MIXER_H
slouken@229
    26
#define _SDL_MIXER_H
slouken@34
    27
slouken@34
    28
#include "SDL_types.h"
slouken@34
    29
#include "SDL_rwops.h"
slouken@34
    30
#include "SDL_audio.h"
icculus@343
    31
#include "SDL_endian.h"
slouken@113
    32
#include "SDL_version.h"
slouken@40
    33
#include "begin_code.h"
slouken@34
    34
slouken@34
    35
/* Set up for C function definitions, even when using C++ */
slouken@34
    36
#ifdef __cplusplus
slouken@34
    37
extern "C" {
slouken@34
    38
#endif
slouken@34
    39
slouken@113
    40
/* Printable format: "%d.%d.%d", MAJOR, MINOR, PATCHLEVEL
slouken@113
    41
*/
slouken@227
    42
#define SDL_MIXER_MAJOR_VERSION	1
slouken@227
    43
#define SDL_MIXER_MINOR_VERSION	2
slouken@477
    44
#define SDL_MIXER_PATCHLEVEL    11
slouken@113
    45
slouken@113
    46
/* This macro can be used to fill a version structure with the compile-time
slouken@113
    47
 * version of the SDL_mixer library.
slouken@113
    48
 */
slouken@227
    49
#define SDL_MIXER_VERSION(X)						\
slouken@113
    50
{									\
slouken@227
    51
	(X)->major = SDL_MIXER_MAJOR_VERSION;				\
slouken@227
    52
	(X)->minor = SDL_MIXER_MINOR_VERSION;				\
slouken@227
    53
	(X)->patch = SDL_MIXER_PATCHLEVEL;				\
slouken@113
    54
}
slouken@113
    55
slouken@227
    56
/* Backwards compatibility */
slouken@227
    57
#define MIX_MAJOR_VERSION	SDL_MIXER_MAJOR_VERSION
slouken@227
    58
#define MIX_MINOR_VERSION	SDL_MIXER_MINOR_VERSION
slouken@227
    59
#define MIX_PATCHLEVEL		SDL_MIXER_PATCHLEVEL
slouken@227
    60
#define MIX_VERSION(X)		SDL_MIXER_VERSION(X)
slouken@227
    61
slouken@113
    62
/* This function gets the version of the dynamically linked SDL_mixer library.
slouken@113
    63
   it should NOT be used to fill a version structure, instead you should
slouken@227
    64
   use the SDL_MIXER_VERSION() macro.
slouken@113
    65
 */
slouken@165
    66
extern DECLSPEC const SDL_version * SDLCALL Mix_Linked_Version(void);
slouken@113
    67
slouken@470
    68
typedef enum
slouken@470
    69
{
slouken@470
    70
    MIX_INIT_FLAC = 0x00000001,
slouken@470
    71
    MIX_INIT_MOD  = 0x00000002,
slouken@470
    72
    MIX_INIT_MP3  = 0x00000004,
slouken@470
    73
    MIX_INIT_OGG  = 0x00000008
slouken@470
    74
} MIX_InitFlags;
slouken@470
    75
slouken@470
    76
/* Loads dynamic libraries and prepares them for use.  Flags should be
slouken@470
    77
   one or more flags from MIX_InitFlags OR'd together.
slouken@470
    78
   It returns the flags successfully initialized, or 0 on failure.
slouken@470
    79
 */
slouken@470
    80
extern DECLSPEC int SDLCALL Mix_Init(int flags);
slouken@470
    81
slouken@470
    82
/* Unloads libraries loaded with Mix_Init */
slouken@480
    83
extern DECLSPEC void SDLCALL Mix_Quit(void);
slouken@470
    84
slouken@113
    85
slouken@34
    86
/* The default mixer has 8 simultaneous mixing channels */
slouken@34
    87
#ifndef MIX_CHANNELS
slouken@34
    88
#define MIX_CHANNELS	8
slouken@34
    89
#endif
slouken@34
    90
slouken@34
    91
/* Good default values for a PC soundcard */
slouken@34
    92
#define MIX_DEFAULT_FREQUENCY	22050
slouken@70
    93
#if SDL_BYTEORDER == SDL_LIL_ENDIAN
slouken@70
    94
#define MIX_DEFAULT_FORMAT	AUDIO_S16LSB
slouken@70
    95
#else
slouken@70
    96
#define MIX_DEFAULT_FORMAT	AUDIO_S16MSB
slouken@70
    97
#endif
slouken@34
    98
#define MIX_DEFAULT_CHANNELS	2
slouken@34
    99
#define MIX_MAX_VOLUME		128	/* Volume of a chunk */
slouken@34
   100
slouken@34
   101
/* The internal format for an audio chunk */
icculus@267
   102
typedef struct Mix_Chunk {
slouken@34
   103
	int allocated;
slouken@34
   104
	Uint8 *abuf;
slouken@34
   105
	Uint32 alen;
slouken@34
   106
	Uint8 volume;		/* Per-sample volume, 0-128 */
slouken@34
   107
} Mix_Chunk;
slouken@34
   108
slouken@34
   109
/* The different fading types supported */
slouken@34
   110
typedef enum {
slouken@34
   111
	MIX_NO_FADING,
slouken@34
   112
	MIX_FADING_OUT,
slouken@34
   113
	MIX_FADING_IN
slouken@34
   114
} Mix_Fading;
slouken@34
   115
slouken@177
   116
typedef enum {
slouken@177
   117
	MUS_NONE,
slouken@177
   118
	MUS_CMD,
slouken@177
   119
	MUS_WAV,
slouken@177
   120
	MUS_MOD,
slouken@177
   121
	MUS_MID,
slouken@177
   122
	MUS_OGG,
icculus@384
   123
	MUS_MP3,
icculus@384
   124
	MUS_MP3_MAD,
slouken@408
   125
	MUS_FLAC
slouken@177
   126
} Mix_MusicType;
slouken@177
   127
slouken@34
   128
/* The internal format for a music chunk interpreted via mikmod */
slouken@34
   129
typedef struct _Mix_Music Mix_Music;
slouken@34
   130
slouken@34
   131
/* Open the mixer with a certain audio format */
slouken@165
   132
extern DECLSPEC int SDLCALL Mix_OpenAudio(int frequency, Uint16 format, int channels,
slouken@34
   133
							int chunksize);
slouken@34
   134
slouken@34
   135
/* Dynamically change the number of channels managed by the mixer.
slouken@34
   136
   If decreasing the number of channels, the upper channels are
slouken@34
   137
   stopped.
slouken@34
   138
   This function returns the new number of allocated channels.
slouken@34
   139
 */
slouken@165
   140
extern DECLSPEC int SDLCALL Mix_AllocateChannels(int numchans);
slouken@34
   141
slouken@34
   142
/* Find out what the actual audio device parameters are.
slouken@34
   143
   This function returns 1 if the audio has been opened, 0 otherwise.
slouken@34
   144
 */
slouken@165
   145
extern DECLSPEC int SDLCALL Mix_QuerySpec(int *frequency,Uint16 *format,int *channels);
slouken@34
   146
slouken@34
   147
/* Load a wave file or a music (.mod .s3m .it .xm) file */
slouken@165
   148
extern DECLSPEC Mix_Chunk * SDLCALL Mix_LoadWAV_RW(SDL_RWops *src, int freesrc);
slouken@34
   149
#define Mix_LoadWAV(file)	Mix_LoadWAV_RW(SDL_RWFromFile(file, "rb"), 1)
slouken@165
   150
extern DECLSPEC Mix_Music * SDLCALL Mix_LoadMUS(const char *file);
slouken@34
   151
slouken@254
   152
/* Load a music file from an SDL_RWop object (Ogg and MikMod specific currently)
slouken@59
   153
   Matt Campbell (matt@campbellhome.dhs.org) April 2000 */
slouken@226
   154
extern DECLSPEC Mix_Music * SDLCALL Mix_LoadMUS_RW(SDL_RWops *rw);
slouken@59
   155
slouken@34
   156
/* Load a wave file of the mixer format from a memory buffer */
slouken@165
   157
extern DECLSPEC Mix_Chunk * SDLCALL Mix_QuickLoad_WAV(Uint8 *mem);
slouken@34
   158
slouken@174
   159
/* Load raw audio data of the mixer format from a memory buffer */
slouken@174
   160
extern DECLSPEC Mix_Chunk * SDLCALL Mix_QuickLoad_RAW(Uint8 *mem, Uint32 len);
slouken@174
   161
slouken@34
   162
/* Free an audio chunk previously loaded */
slouken@165
   163
extern DECLSPEC void SDLCALL Mix_FreeChunk(Mix_Chunk *chunk);
slouken@165
   164
extern DECLSPEC void SDLCALL Mix_FreeMusic(Mix_Music *music);
slouken@34
   165
icculus@390
   166
/* Get a list of chunk/music decoders that this build of SDL_mixer provides.
icculus@390
   167
   This list can change between builds AND runs of the program, if external
icculus@390
   168
   libraries that add functionality become available.
icculus@390
   169
   You must successfully call Mix_OpenAudio() before calling these functions.
icculus@390
   170
   This API is only available in SDL_mixer 1.2.9 and later.
icculus@390
   171
icculus@390
   172
   // usage...
icculus@390
   173
   int i;
icculus@390
   174
   const int total = Mix_GetNumChunkDecoders();
icculus@390
   175
   for (i = 0; i < total; i++)
icculus@390
   176
       printf("Supported chunk decoder: [%s]\n", Mix_GetChunkDecoder(i));
icculus@390
   177
icculus@390
   178
   Appearing in this list doesn't promise your specific audio file will
icculus@390
   179
   decode...but it's handy to know if you have, say, a functioning Timidity
icculus@390
   180
   install.
icculus@390
   181
icculus@390
   182
   These return values are static, read-only data; do not modify or free it.
icculus@390
   183
   The pointers remain valid until you call Mix_CloseAudio().
icculus@390
   184
*/
icculus@390
   185
extern DECLSPEC int SDLCALL Mix_GetNumChunkDecoders(void);
icculus@390
   186
extern DECLSPEC const char * SDLCALL Mix_GetChunkDecoder(int index);
icculus@390
   187
extern DECLSPEC int SDLCALL Mix_GetNumMusicDecoders(void);
icculus@390
   188
extern DECLSPEC const char * SDLCALL Mix_GetMusicDecoder(int index);
icculus@390
   189
slouken@177
   190
/* Find out the music format of a mixer music, or the currently playing
slouken@177
   191
   music, if 'music' is NULL.
slouken@177
   192
*/
slouken@180
   193
extern DECLSPEC Mix_MusicType SDLCALL Mix_GetMusicType(const Mix_Music *music);
slouken@177
   194
slouken@34
   195
/* Set a function that is called after all mixing is performed.
slouken@34
   196
   This can be used to provide real-time visual display of the audio stream
slouken@34
   197
   or add a custom mixer filter for the stream data.
slouken@34
   198
*/
slouken@165
   199
extern DECLSPEC void SDLCALL Mix_SetPostMix(void (*mix_func)
slouken@34
   200
                             (void *udata, Uint8 *stream, int len), void *arg);
slouken@34
   201
slouken@34
   202
/* Add your own music player or additional mixer function.
slouken@34
   203
   If 'mix_func' is NULL, the default music player is re-enabled.
slouken@34
   204
 */
slouken@165
   205
extern DECLSPEC void SDLCALL Mix_HookMusic(void (*mix_func)
slouken@34
   206
                          (void *udata, Uint8 *stream, int len), void *arg);
slouken@34
   207
slouken@173
   208
/* Add your own callback when the music has finished playing.
slouken@173
   209
   This callback is only called if the music finishes naturally.
slouken@173
   210
 */
slouken@165
   211
extern DECLSPEC void SDLCALL Mix_HookMusicFinished(void (*music_finished)(void));
slouken@34
   212
slouken@34
   213
/* Get a pointer to the user data for the current music hook */
slouken@165
   214
extern DECLSPEC void * SDLCALL Mix_GetMusicHookData(void);
slouken@34
   215
slouken@164
   216
/*
slouken@164
   217
 * Add your own callback when a channel has finished playing. NULL
slouken@164
   218
 *  to disable callback. The callback may be called from the mixer's audio 
slouken@164
   219
 *  callback or it could be called as a result of Mix_HaltChannel(), etc.
slouken@164
   220
 *  do not call SDL_LockAudio() from this callback; you will either be 
slouken@164
   221
 *  inside the audio callback, or SDL_mixer will explicitly lock the audio
slouken@164
   222
 *  before calling your callback.
slouken@92
   223
 */
slouken@165
   224
extern DECLSPEC void SDLCALL Mix_ChannelFinished(void (*channel_finished)(int channel));
slouken@92
   225
slouken@113
   226
icculus@339
   227
/* Special Effects API by ryan c. gordon. (icculus@icculus.org) */
slouken@113
   228
slouken@113
   229
#define MIX_CHANNEL_POST  -2
slouken@113
   230
slouken@113
   231
/* This is the format of a special effect callback:
slouken@113
   232
 *
slouken@113
   233
 *   myeffect(int chan, void *stream, int len, void *udata);
slouken@113
   234
 *
slouken@113
   235
 * (chan) is the channel number that your effect is affecting. (stream) is
slouken@113
   236
 *  the buffer of data to work upon. (len) is the size of (stream), and
slouken@113
   237
 *  (udata) is a user-defined bit of data, which you pass as the last arg of
slouken@113
   238
 *  Mix_RegisterEffect(), and is passed back unmolested to your callback.
slouken@113
   239
 *  Your effect changes the contents of (stream) based on whatever parameters
slouken@113
   240
 *  are significant, or just leaves it be, if you prefer. You can do whatever
slouken@113
   241
 *  you like to the buffer, though, and it will continue in its changed state
slouken@113
   242
 *  down the mixing pipeline, through any other effect functions, then finally
slouken@113
   243
 *  to be mixed with the rest of the channels and music for the final output
slouken@113
   244
 *  stream.
slouken@164
   245
 *
slouken@164
   246
 * DO NOT EVER call SDL_LockAudio() from your callback function!
slouken@113
   247
 */
slouken@113
   248
typedef void (*Mix_EffectFunc_t)(int chan, void *stream, int len, void *udata);
slouken@113
   249
slouken@113
   250
/*
slouken@113
   251
 * This is a callback that signifies that a channel has finished all its
slouken@113
   252
 *  loops and has completed playback. This gets called if the buffer
slouken@113
   253
 *  plays out normally, or if you call Mix_HaltChannel(), implicitly stop
slouken@113
   254
 *  a channel via Mix_AllocateChannels(), or unregister a callback while
slouken@113
   255
 *  it's still playing.
slouken@164
   256
 *
slouken@164
   257
 * DO NOT EVER call SDL_LockAudio() from your callback function!
slouken@113
   258
 */
slouken@113
   259
typedef void (*Mix_EffectDone_t)(int chan, void *udata);
slouken@113
   260
slouken@113
   261
slouken@113
   262
/* Register a special effect function. At mixing time, the channel data is
slouken@113
   263
 *  copied into a buffer and passed through each registered effect function.
slouken@113
   264
 *  After it passes through all the functions, it is mixed into the final
slouken@113
   265
 *  output stream. The copy to buffer is performed once, then each effect
slouken@113
   266
 *  function performs on the output of the previous effect. Understand that
slouken@113
   267
 *  this extra copy to a buffer is not performed if there are no effects
slouken@113
   268
 *  registered for a given chunk, which saves CPU cycles, and any given
slouken@113
   269
 *  effect will be extra cycles, too, so it is crucial that your code run
slouken@113
   270
 *  fast. Also note that the data that your function is given is in the
slouken@113
   271
 *  format of the sound device, and not the format you gave to Mix_OpenAudio(),
slouken@113
   272
 *  although they may in reality be the same. This is an unfortunate but
slouken@113
   273
 *  necessary speed concern. Use Mix_QuerySpec() to determine if you can
slouken@113
   274
 *  handle the data before you register your effect, and take appropriate
slouken@113
   275
 *  actions.
slouken@113
   276
 * You may also specify a callback (Mix_EffectDone_t) that is called when
slouken@113
   277
 *  the channel finishes playing. This gives you a more fine-grained control
slouken@113
   278
 *  than Mix_ChannelFinished(), in case you need to free effect-specific
slouken@113
   279
 *  resources, etc. If you don't need this, you can specify NULL.
slouken@113
   280
 * You may set the callbacks before or after calling Mix_PlayChannel().
slouken@113
   281
 * Things like Mix_SetPanning() are just internal special effect functions,
slouken@113
   282
 *  so if you are using that, you've already incurred the overhead of a copy
slouken@113
   283
 *  to a separate buffer, and that these effects will be in the queue with
slouken@113
   284
 *  any functions you've registered. The list of registered effects for a
slouken@113
   285
 *  channel is reset when a chunk finishes playing, so you need to explicitly
slouken@113
   286
 *  set them with each call to Mix_PlayChannel*().
slouken@113
   287
 * You may also register a special effect function that is to be run after
slouken@113
   288
 *  final mixing occurs. The rules for these callbacks are identical to those
slouken@113
   289
 *  in Mix_RegisterEffect, but they are run after all the channels and the
slouken@113
   290
 *  music have been mixed into a single stream, whereas channel-specific
slouken@113
   291
 *  effects run on a given channel before any other mixing occurs. These
slouken@113
   292
 *  global effect callbacks are call "posteffects". Posteffects only have
slouken@113
   293
 *  their Mix_EffectDone_t function called when they are unregistered (since
slouken@113
   294
 *  the main output stream is never "done" in the same sense as a channel).
slouken@113
   295
 *  You must unregister them manually when you've had enough. Your callback
slouken@113
   296
 *  will be told that the channel being mixed is (MIX_CHANNEL_POST) if the
slouken@113
   297
 *  processing is considered a posteffect.
slouken@113
   298
 *
slouken@113
   299
 * After all these effects have finished processing, the callback registered
slouken@113
   300
 *  through Mix_SetPostMix() runs, and then the stream goes to the audio
slouken@113
   301
 *  device. 
slouken@113
   302
 *
slouken@164
   303
 * DO NOT EVER call SDL_LockAudio() from your callback function!
slouken@164
   304
 *
slouken@113
   305
 * returns zero if error (no such channel), nonzero if added.
slouken@113
   306
 *  Error messages can be retrieved from Mix_GetError().
slouken@113
   307
 */
slouken@165
   308
extern DECLSPEC int SDLCALL Mix_RegisterEffect(int chan, Mix_EffectFunc_t f,
slouken@164
   309
					Mix_EffectDone_t d, void *arg);
slouken@113
   310
slouken@113
   311
slouken@113
   312
/* You may not need to call this explicitly, unless you need to stop an
slouken@113
   313
 *  effect from processing in the middle of a chunk's playback.
slouken@113
   314
 * Posteffects are never implicitly unregistered as they are for channels,
slouken@113
   315
 *  but they may be explicitly unregistered through this function by
slouken@113
   316
 *  specifying MIX_CHANNEL_POST for a channel.
slouken@113
   317
 * returns zero if error (no such channel or effect), nonzero if removed.
slouken@113
   318
 *  Error messages can be retrieved from Mix_GetError().
slouken@113
   319
 */
slouken@165
   320
extern DECLSPEC int SDLCALL Mix_UnregisterEffect(int channel, Mix_EffectFunc_t f);
slouken@113
   321
slouken@113
   322
slouken@113
   323
/* You may not need to call this explicitly, unless you need to stop all
slouken@113
   324
 *  effects from processing in the middle of a chunk's playback. Note that
slouken@113
   325
 *  this will also shut off some internal effect processing, since
slouken@113
   326
 *  Mix_SetPanning() and others may use this API under the hood. This is
slouken@113
   327
 *  called internally when a channel completes playback.
slouken@113
   328
 * Posteffects are never implicitly unregistered as they are for channels,
slouken@113
   329
 *  but they may be explicitly unregistered through this function by
slouken@113
   330
 *  specifying MIX_CHANNEL_POST for a channel.
slouken@113
   331
 * returns zero if error (no such channel), nonzero if all effects removed.
slouken@113
   332
 *  Error messages can be retrieved from Mix_GetError().
slouken@113
   333
 */
slouken@165
   334
extern DECLSPEC int SDLCALL Mix_UnregisterAllEffects(int channel);
slouken@113
   335
slouken@113
   336
slouken@113
   337
#define MIX_EFFECTSMAXSPEED  "MIX_EFFECTSMAXSPEED"
slouken@113
   338
slouken@113
   339
/*
slouken@113
   340
 * These are the internally-defined mixing effects. They use the same API that
slouken@113
   341
 *  effects defined in the application use, but are provided here as a
slouken@113
   342
 *  convenience. Some effects can reduce their quality or use more memory in
slouken@113
   343
 *  the name of speed; to enable this, make sure the environment variable
slouken@113
   344
 *  MIX_EFFECTSMAXSPEED (see above) is defined before you call
slouken@113
   345
 *  Mix_OpenAudio().
slouken@113
   346
 */
slouken@113
   347
slouken@113
   348
slouken@113
   349
/* Set the panning of a channel. The left and right channels are specified
slouken@113
   350
 *  as integers between 0 and 255, quietest to loudest, respectively.
slouken@113
   351
 *
slouken@113
   352
 * Technically, this is just individual volume control for a sample with
slouken@113
   353
 *  two (stereo) channels, so it can be used for more than just panning.
slouken@113
   354
 *  If you want real panning, call it like this:
slouken@113
   355
 *
slouken@113
   356
 *   Mix_SetPanning(channel, left, 255 - left);
slouken@113
   357
 *
slouken@113
   358
 * ...which isn't so hard.
slouken@113
   359
 *
slouken@113
   360
 * Setting (channel) to MIX_CHANNEL_POST registers this as a posteffect, and
slouken@113
   361
 *  the panning will be done to the final mixed stream before passing it on
slouken@113
   362
 *  to the audio device.
slouken@113
   363
 *
slouken@113
   364
 * This uses the Mix_RegisterEffect() API internally, and returns without
slouken@113
   365
 *  registering the effect function if the audio device is not configured
slouken@113
   366
 *  for stereo output. Setting both (left) and (right) to 255 causes this
slouken@113
   367
 *  effect to be unregistered, since that is the data's normal state.
slouken@113
   368
 *
slouken@113
   369
 * returns zero if error (no such channel or Mix_RegisterEffect() fails),
slouken@113
   370
 *  nonzero if panning effect enabled. Note that an audio device in mono
slouken@113
   371
 *  mode is a no-op, but this call will return successful in that case.
slouken@113
   372
 *  Error messages can be retrieved from Mix_GetError().
slouken@113
   373
 */
slouken@165
   374
extern DECLSPEC int SDLCALL Mix_SetPanning(int channel, Uint8 left, Uint8 right);
slouken@113
   375
slouken@113
   376
slouken@113
   377
/* Set the position of a channel. (angle) is an integer from 0 to 360, that
slouken@113
   378
 *  specifies the location of the sound in relation to the listener. (angle)
slouken@113
   379
 *  will be reduced as neccesary (540 becomes 180 degrees, -100 becomes 260).
slouken@113
   380
 *  Angle 0 is due north, and rotates clockwise as the value increases.
slouken@113
   381
 *  For efficiency, the precision of this effect may be limited (angles 1
slouken@113
   382
 *  through 7 might all produce the same effect, 8 through 15 are equal, etc).
slouken@113
   383
 *  (distance) is an integer between 0 and 255 that specifies the space
slouken@113
   384
 *  between the sound and the listener. The larger the number, the further
slouken@113
   385
 *  away the sound is. Using 255 does not guarantee that the channel will be
slouken@113
   386
 *  culled from the mixing process or be completely silent. For efficiency,
slouken@113
   387
 *  the precision of this effect may be limited (distance 0 through 5 might
slouken@113
   388
 *  all produce the same effect, 6 through 10 are equal, etc). Setting (angle)
slouken@113
   389
 *  and (distance) to 0 unregisters this effect, since the data would be
slouken@113
   390
 *  unchanged.
slouken@113
   391
 *
slouken@113
   392
 * If you need more precise positional audio, consider using OpenAL for
slouken@113
   393
 *  spatialized effects instead of SDL_mixer. This is only meant to be a
slouken@113
   394
 *  basic effect for simple "3D" games.
slouken@113
   395
 *
slouken@113
   396
 * If the audio device is configured for mono output, then you won't get
slouken@113
   397
 *  any effectiveness from the angle; however, distance attenuation on the
slouken@113
   398
 *  channel will still occur. While this effect will function with stereo
slouken@113
   399
 *  voices, it makes more sense to use voices with only one channel of sound,
slouken@113
   400
 *  so when they are mixed through this effect, the positioning will sound
slouken@113
   401
 *  correct. You can convert them to mono through SDL before giving them to
slouken@113
   402
 *  the mixer in the first place if you like.
slouken@113
   403
 *
slouken@113
   404
 * Setting (channel) to MIX_CHANNEL_POST registers this as a posteffect, and
slouken@113
   405
 *  the positioning will be done to the final mixed stream before passing it
slouken@113
   406
 *  on to the audio device.
slouken@113
   407
 *
slouken@113
   408
 * This is a convenience wrapper over Mix_SetDistance() and Mix_SetPanning().
slouken@113
   409
 *
slouken@113
   410
 * returns zero if error (no such channel or Mix_RegisterEffect() fails),
slouken@113
   411
 *  nonzero if position effect is enabled.
slouken@113
   412
 *  Error messages can be retrieved from Mix_GetError().
slouken@113
   413
 */
slouken@165
   414
extern DECLSPEC int SDLCALL Mix_SetPosition(int channel, Sint16 angle, Uint8 distance);
slouken@113
   415
slouken@113
   416
slouken@113
   417
/* Set the "distance" of a channel. (distance) is an integer from 0 to 255
slouken@113
   418
 *  that specifies the location of the sound in relation to the listener.
slouken@113
   419
 *  Distance 0 is overlapping the listener, and 255 is as far away as possible
slouken@113
   420
 *  A distance of 255 does not guarantee silence; in such a case, you might
slouken@113
   421
 *  want to try changing the chunk's volume, or just cull the sample from the
slouken@113
   422
 *  mixing process with Mix_HaltChannel().
slouken@113
   423
 * For efficiency, the precision of this effect may be limited (distances 1
slouken@113
   424
 *  through 7 might all produce the same effect, 8 through 15 are equal, etc).
slouken@113
   425
 *  (distance) is an integer between 0 and 255 that specifies the space
slouken@113
   426
 *  between the sound and the listener. The larger the number, the further
slouken@113
   427
 *  away the sound is.
slouken@113
   428
 * Setting (distance) to 0 unregisters this effect, since the data would be
slouken@113
   429
 *  unchanged.
slouken@113
   430
 * If you need more precise positional audio, consider using OpenAL for
slouken@113
   431
 *  spatialized effects instead of SDL_mixer. This is only meant to be a
slouken@113
   432
 *  basic effect for simple "3D" games.
slouken@113
   433
 *
slouken@113
   434
 * Setting (channel) to MIX_CHANNEL_POST registers this as a posteffect, and
slouken@113
   435
 *  the distance attenuation will be done to the final mixed stream before
slouken@113
   436
 *  passing it on to the audio device.
slouken@113
   437
 *
slouken@113
   438
 * This uses the Mix_RegisterEffect() API internally.
slouken@113
   439
 *
slouken@113
   440
 * returns zero if error (no such channel or Mix_RegisterEffect() fails),
slouken@113
   441
 *  nonzero if position effect is enabled.
slouken@113
   442
 *  Error messages can be retrieved from Mix_GetError().
slouken@113
   443
 */
slouken@165
   444
extern DECLSPEC int SDLCALL Mix_SetDistance(int channel, Uint8 distance);
slouken@113
   445
slouken@113
   446
slouken@113
   447
/*
slouken@113
   448
 * !!! FIXME : Haven't implemented, since the effect goes past the
slouken@113
   449
 *              end of the sound buffer. Will have to think about this.
slouken@113
   450
 *               --ryan.
slouken@113
   451
 */
slouken@113
   452
#if 0
slouken@113
   453
/* Causes an echo effect to be mixed into a sound. (echo) is the amount
slouken@113
   454
 *  of echo to mix. 0 is no echo, 255 is infinite (and probably not
slouken@113
   455
 *  what you want).
slouken@113
   456
 *
slouken@113
   457
 * Setting (channel) to MIX_CHANNEL_POST registers this as a posteffect, and
slouken@113
   458
 *  the reverbing will be done to the final mixed stream before passing it on
slouken@113
   459
 *  to the audio device.
slouken@113
   460
 *
slouken@113
   461
 * This uses the Mix_RegisterEffect() API internally. If you specify an echo
slouken@113
   462
 *  of zero, the effect is unregistered, as the data is already in that state.
slouken@113
   463
 *
slouken@113
   464
 * returns zero if error (no such channel or Mix_RegisterEffect() fails),
slouken@113
   465
 *  nonzero if reversing effect is enabled.
slouken@113
   466
 *  Error messages can be retrieved from Mix_GetError().
slouken@113
   467
 */
slouken@165
   468
extern no_parse_DECLSPEC int SDLCALL Mix_SetReverb(int channel, Uint8 echo);
slouken@113
   469
#endif
slouken@113
   470
slouken@113
   471
/* Causes a channel to reverse its stereo. This is handy if the user has his
slouken@113
   472
 *  speakers hooked up backwards, or you would like to have a minor bit of
slouken@113
   473
 *  psychedelia in your sound code.  :)  Calling this function with (flip)
slouken@113
   474
 *  set to non-zero reverses the chunks's usual channels. If (flip) is zero,
slouken@113
   475
 *  the effect is unregistered.
slouken@113
   476
 *
slouken@113
   477
 * This uses the Mix_RegisterEffect() API internally, and thus is probably
slouken@113
   478
 *  more CPU intensive than having the user just plug in his speakers
slouken@113
   479
 *  correctly. Mix_SetReverseStereo() returns without registering the effect
slouken@113
   480
 *  function if the audio device is not configured for stereo output.
slouken@113
   481
 *
slouken@113
   482
 * If you specify MIX_CHANNEL_POST for (channel), then this the effect is used
slouken@113
   483
 *  on the final mixed stream before sending it on to the audio device (a
slouken@113
   484
 *  posteffect).
slouken@113
   485
 *
slouken@113
   486
 * returns zero if error (no such channel or Mix_RegisterEffect() fails),
slouken@113
   487
 *  nonzero if reversing effect is enabled. Note that an audio device in mono
slouken@113
   488
 *  mode is a no-op, but this call will return successful in that case.
slouken@113
   489
 *  Error messages can be retrieved from Mix_GetError().
slouken@113
   490
 */
slouken@165
   491
extern DECLSPEC int SDLCALL Mix_SetReverseStereo(int channel, int flip);
slouken@113
   492
slouken@113
   493
/* end of effects API. --ryan. */
slouken@113
   494
slouken@113
   495
slouken@34
   496
/* Reserve the first channels (0 -> n-1) for the application, i.e. don't allocate
slouken@34
   497
   them dynamically to the next sample if requested with a -1 value below.
slouken@34
   498
   Returns the number of reserved channels.
slouken@34
   499
 */
slouken@165
   500
extern DECLSPEC int SDLCALL Mix_ReserveChannels(int num);
slouken@34
   501
slouken@34
   502
/* Channel grouping functions */
slouken@34
   503
slouken@34
   504
/* Attach a tag to a channel. A tag can be assigned to several mixer
slouken@34
   505
   channels, to form groups of channels.
slouken@34
   506
   If 'tag' is -1, the tag is removed (actually -1 is the tag used to
slouken@34
   507
   represent the group of all the channels).
slouken@34
   508
   Returns true if everything was OK.
slouken@34
   509
 */
slouken@165
   510
extern DECLSPEC int SDLCALL Mix_GroupChannel(int which, int tag);
slouken@34
   511
/* Assign several consecutive channels to a group */
slouken@165
   512
extern DECLSPEC int SDLCALL Mix_GroupChannels(int from, int to, int tag);
slouken@136
   513
/* Finds the first available channel in a group of channels,
slouken@136
   514
   returning -1 if none are available.
slouken@136
   515
 */
slouken@165
   516
extern DECLSPEC int SDLCALL Mix_GroupAvailable(int tag);
slouken@34
   517
/* Returns the number of channels in a group. This is also a subtle
slouken@34
   518
   way to get the total number of channels when 'tag' is -1
slouken@34
   519
 */
slouken@165
   520
extern DECLSPEC int SDLCALL Mix_GroupCount(int tag);
slouken@34
   521
/* Finds the "oldest" sample playing in a group of channels */
slouken@165
   522
extern DECLSPEC int SDLCALL Mix_GroupOldest(int tag);
slouken@34
   523
/* Finds the "most recent" (i.e. last) sample playing in a group of channels */
slouken@165
   524
extern DECLSPEC int SDLCALL Mix_GroupNewer(int tag);
slouken@34
   525
slouken@34
   526
/* Play an audio chunk on a specific channel.
slouken@34
   527
   If the specified channel is -1, play on the first free channel.
slouken@34
   528
   If 'loops' is greater than zero, loop the sound that many times.
slouken@34
   529
   If 'loops' is -1, loop inifinitely (~65000 times).
slouken@34
   530
   Returns which channel was used to play the sound.
slouken@34
   531
*/
slouken@34
   532
#define Mix_PlayChannel(channel,chunk,loops) Mix_PlayChannelTimed(channel,chunk,loops,-1)
slouken@34
   533
/* The same as above, but the sound is played at most 'ticks' milliseconds */
slouken@165
   534
extern DECLSPEC int SDLCALL Mix_PlayChannelTimed(int channel, Mix_Chunk *chunk, int loops, int ticks);
slouken@165
   535
extern DECLSPEC int SDLCALL Mix_PlayMusic(Mix_Music *music, int loops);
slouken@34
   536
slouken@34
   537
/* Fade in music or a channel over "ms" milliseconds, same semantics as the "Play" functions */
slouken@165
   538
extern DECLSPEC int SDLCALL Mix_FadeInMusic(Mix_Music *music, int loops, int ms);
slouken@165
   539
extern DECLSPEC int SDLCALL Mix_FadeInMusicPos(Mix_Music *music, int loops, int ms, double position);
slouken@34
   540
#define Mix_FadeInChannel(channel,chunk,loops,ms) Mix_FadeInChannelTimed(channel,chunk,loops,ms,-1)
slouken@165
   541
extern DECLSPEC int SDLCALL Mix_FadeInChannelTimed(int channel, Mix_Chunk *chunk, int loops, int ms, int ticks);
slouken@34
   542
slouken@34
   543
/* Set the volume in the range of 0-128 of a specific channel or chunk.
slouken@34
   544
   If the specified channel is -1, set volume for all channels.
slouken@34
   545
   Returns the original volume.
slouken@34
   546
   If the specified volume is -1, just return the current volume.
slouken@34
   547
*/
slouken@165
   548
extern DECLSPEC int SDLCALL Mix_Volume(int channel, int volume);
slouken@165
   549
extern DECLSPEC int SDLCALL Mix_VolumeChunk(Mix_Chunk *chunk, int volume);
slouken@165
   550
extern DECLSPEC int SDLCALL Mix_VolumeMusic(int volume);
slouken@34
   551
slouken@34
   552
/* Halt playing of a particular channel */
slouken@165
   553
extern DECLSPEC int SDLCALL Mix_HaltChannel(int channel);
slouken@165
   554
extern DECLSPEC int SDLCALL Mix_HaltGroup(int tag);
slouken@165
   555
extern DECLSPEC int SDLCALL Mix_HaltMusic(void);
slouken@34
   556
slouken@34
   557
/* Change the expiration delay for a particular channel.
slouken@34
   558
   The sample will stop playing after the 'ticks' milliseconds have elapsed,
slouken@34
   559
   or remove the expiration if 'ticks' is -1
slouken@34
   560
*/
slouken@165
   561
extern DECLSPEC int SDLCALL Mix_ExpireChannel(int channel, int ticks);
slouken@34
   562
slouken@34
   563
/* Halt a channel, fading it out progressively till it's silent
slouken@34
   564
   The ms parameter indicates the number of milliseconds the fading
slouken@34
   565
   will take.
slouken@34
   566
 */
slouken@165
   567
extern DECLSPEC int SDLCALL Mix_FadeOutChannel(int which, int ms);
slouken@165
   568
extern DECLSPEC int SDLCALL Mix_FadeOutGroup(int tag, int ms);
slouken@165
   569
extern DECLSPEC int SDLCALL Mix_FadeOutMusic(int ms);
slouken@34
   570
slouken@34
   571
/* Query the fading status of a channel */
slouken@165
   572
extern DECLSPEC Mix_Fading SDLCALL Mix_FadingMusic(void);
slouken@165
   573
extern DECLSPEC Mix_Fading SDLCALL Mix_FadingChannel(int which);
slouken@34
   574
slouken@34
   575
/* Pause/Resume a particular channel */
slouken@165
   576
extern DECLSPEC void SDLCALL Mix_Pause(int channel);
slouken@165
   577
extern DECLSPEC void SDLCALL Mix_Resume(int channel);
slouken@167
   578
extern DECLSPEC int SDLCALL Mix_Paused(int channel);
slouken@34
   579
slouken@34
   580
/* Pause/Resume the music stream */
slouken@165
   581
extern DECLSPEC void SDLCALL Mix_PauseMusic(void);
slouken@165
   582
extern DECLSPEC void SDLCALL Mix_ResumeMusic(void);
slouken@165
   583
extern DECLSPEC void SDLCALL Mix_RewindMusic(void);
slouken@167
   584
extern DECLSPEC int SDLCALL Mix_PausedMusic(void);
slouken@34
   585
slouken@154
   586
/* Set the current position in the music stream.
slouken@154
   587
   This returns 0 if successful, or -1 if it failed or isn't implemented.
slouken@155
   588
   This function is only implemented for MOD music formats (set pattern
slouken@155
   589
   order number) and for OGG music (set position in seconds), at the
slouken@155
   590
   moment.
slouken@154
   591
*/
slouken@165
   592
extern DECLSPEC int SDLCALL Mix_SetMusicPosition(double position);
slouken@154
   593
slouken@34
   594
/* Check the status of a specific channel.
slouken@34
   595
   If the specified channel is -1, check all channels.
slouken@34
   596
*/
slouken@165
   597
extern DECLSPEC int SDLCALL Mix_Playing(int channel);
slouken@165
   598
extern DECLSPEC int SDLCALL Mix_PlayingMusic(void);
slouken@34
   599
slouken@34
   600
/* Stop music and set external music playback command */
slouken@165
   601
extern DECLSPEC int SDLCALL Mix_SetMusicCMD(const char *command);
slouken@34
   602
slouken@154
   603
/* Synchro value is set by MikMod from modules while playing */
slouken@165
   604
extern DECLSPEC int SDLCALL Mix_SetSynchroValue(int value);
slouken@165
   605
extern DECLSPEC int SDLCALL Mix_GetSynchroValue(void);
slouken@154
   606
slouken@92
   607
/* Get the Mix_Chunk currently associated with a mixer channel
slouken@92
   608
    Returns NULL if it's an invalid channel, or there's no chunk associated.
slouken@92
   609
*/
slouken@165
   610
extern DECLSPEC Mix_Chunk * SDLCALL Mix_GetChunk(int channel);
slouken@92
   611
slouken@34
   612
/* Close the mixer, halting all playing audio */
slouken@165
   613
extern DECLSPEC void SDLCALL Mix_CloseAudio(void);
slouken@34
   614
slouken@34
   615
/* We'll use SDL for reporting errors */
slouken@34
   616
#define Mix_SetError	SDL_SetError
slouken@34
   617
#define Mix_GetError	SDL_GetError
slouken@34
   618
slouken@34
   619
/* Ends C function definitions when using C++ */
slouken@34
   620
#ifdef __cplusplus
slouken@78
   621
}
slouken@34
   622
#endif
slouken@40
   623
#include "close_code.h"
slouken@34
   624
slouken@229
   625
#endif /* _SDL_MIXER_H */