almixer_isolated: ALmixer.h annotate

annotate ALmixer.h @ 3:a929285e1db0

Added CMake build system. There are problems with the SDL_sound module due to changes in CMake. Right now they just seem to be warnings, but I am unable to suppress them. Added license. Added README.

author	Eric Wing <ewing . public \|-at-\| gmail . com>
date	Wed, 27 Oct 2010 20:43:14 -0700
parents	SDL_ALmixer.h@279d0427ef26
children	8cb13d89451a

rev	line source
0 01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	1 /*
2 279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	2 ALmixer: A library to make playing pre-loaded sounds and streams easier
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	3 with high performance and potential access to OpenAL effects.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	4 Copyright 2002, 2010 Eric Wing <ewing . public @ playcontrol.net>
0 01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	5
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	6 This library is free software; you can redistribute it and/or
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	7 modify it under the terms of the GNU Library General Public
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	8 License as published by the Free Software Foundation; either
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	9 version 2 of the License, or (at your option) any later version.
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	10
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	11 This library is distributed in the hope that it will be useful,
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	12 but WITHOUT ANY WARRANTY; without even the implied warranty of
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	14 Library General Public License for more details.
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	15
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	16 You should have received a copy of the GNU Library General Public
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	17 License along with this library; if not, write to the Free
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	18 Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	19
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	20 */
2 279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	21
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	22
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	23 /**
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	24 * @mainpage
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	25 * ALmixer (which I sometimes call "SDL-OpenAL-Mixer" or "SDL_ALmixer") is a cross-platform audio library built
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	26 * on top of OpenAL to make playing and managing sounds easier.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	27 * ALmixer provides a simple API inspired by SDL_mixer to make playing sounds easy
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	28 * with having to worry about directly dealing with OpenAL sources, buffers,
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	29 * and buffer queuing directly.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	30 * ALmixer currently utilizes SDL_sound behind the scenes to decode
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	31 * various audio formats such as WAV, MP3, AAC, MP4, OGG, etc.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	32 *
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	33 * This library is targeted towards two major groups:
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	34 * - People who just want an easy, high performance, way to play audio (don't care if its OpenAL or not)
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	35 * - People who want to an easy way to play audio in OpenAL but still want access to OpenAL directly.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	36 *
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	37 * ALmixer exposes OpenAL sources in the API so you can freely use ALmixer
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	38 * in larger OpenAL applications that need to apply OpenAL 3D effects and features
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	39 * to playing sounds.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	40 *
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	41 * The API is heavily influenced and inspired by SDL_mixer, though there is one major
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	42 * conceptual design difference. ALmixer doesn't divide sound and music playback into two
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	43 * separate play APIs. Instead, there is one unified play API and you specify via the
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	44 * load API whether you want the audio resource loaded as a stream or completely preloaded.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	45 * This allows you to have any arbitrary number of streaming sources playing simultaneously
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	46 * (such as music and speech) unlike SDL_mixer where you are limited to only one "music"
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	47 * channel.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	48 *
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	49 * A less major conceptual design difference is every "Channel" API has a corresponding "Source" API.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	50 * Every "channel" (in the SDL_mixer definition context) maps to a corresponding OpenAL source id. You can use
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	51 * this source ID directly with OpenAL API commands to utilize OpenAL effects such as position, Doppler, etc.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	52 * Convenience APIs are provided to let you convert channel numbers to source ids and vice-versa.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	53 *
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	54 * Another change which is a pet-peev of mine with SDL_mixer is the lack of a user_data parameter in callbacks.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	55 * ALmixer callbacks allow you to pass user_data (aka context) pointers through the callback functions.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	56 *
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	57 * @note There are some #defines you can set to change the behavior at compile time. Most you shouldn't touch.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	58 * The one worth noting is ENABLE_ALMIXER_THREADS. If enabled, ALmixer_Update() is automatically called on a
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	59 * background thread so you no longer have to explicitly call it. (The function turns into a no-op so your existing
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	60 * code won't break.) Having Update run in a separate thread has some advantages, particularly for streaming
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	61 * audio as all the OpenAL buffer queuing happens in this function. It is less likely the background thread will
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	62 * be blocked for long periods and thus less likely your buffer queues will be starved. However, this means you
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	63 * need to be extra careful about what you do in callback functions as they are invoked from the background thread.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	64 * I still consider this feature a experimental (though I am starting to use it more myself) and there
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	65 * may still be bugs.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	66 *
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	67 * @author Eric Wing
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	68 */
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	69
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	70 /**
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	71 * @file
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	72 * ALmixer (which I sometimes call "SDL-OpenAL-Mixer" or "SDL_ALmixer") is a cross-platform audio library built
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	73 * on top of OpenAL to make playing and managing sounds easier.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	74 * ALmixer provides a simple API inspired by SDL_mixer to make playing sounds easy
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	75 * with having to worry about directly dealing with OpenAL sources, buffers,
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	76 * and buffer queuing directly.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	77 * ALmixer currently utilizes SDL_sound behind the scenes to decode
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	78 * various audio formats such as WAV, MP3, AAC, MP4, OGG, etc.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	79 *
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	80 * This library is targeted towards two major groups:
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	81 * - People who just want an easy, high performance, way to play audio (don't care if its OpenAL or not)
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	82 * - People who want to an easy way to play audio in OpenAL but still want access to OpenAL directly.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	83 *
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	84 * ALmixer exposes OpenAL sources in the API so you can freely use ALmixer
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	85 * in larger OpenAL applications that need to apply OpenAL 3D effects and features
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	86 * to playing sounds.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	87 *
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	88 * The API is heavily influenced and inspired by SDL_mixer, though there is one major
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	89 * conceptual design difference. ALmixer doesn't divide sound and music playback into two
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	90 * separate play APIs. Instead, there is one unified play API and you specify via the
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	91 * load API whether you want the audio resource loaded as a stream or completely preloaded.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	92 * This allows you to have any arbitrary number of streaming sources playing simultaneously
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	93 * (such as music and speech) unlike SDL_mixer where you are limited to only one "music"
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	94 * channel.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	95 *
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	96 * A less major conceptual design difference is every "Channel" API has a corresponding "Source" API.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	97 * Every "channel" (in the SDL_mixer definition context) maps to a corresponding OpenAL source id. You can use
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	98 * this source ID directly with OpenAL API commands to utilize OpenAL effects such as position, Doppler, etc.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	99 * Convenience APIs are provided to let you convert channel numbers to source ids and vice-versa.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	100 *
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	101 * Another change which is a pet-peev of mine with SDL_mixer is the lack of a user_data parameter in callbacks.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	102 * ALmixer callbacks allow you to pass user_data (aka context) pointers through the callback functions.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	103 *
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	104 * @note There are some #defines you can set to change the behavior at compile time. Most you shouldn't touch.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	105 * The one worth noting is ENABLE_ALMIXER_THREADS. If enabled, ALmixer_Update() is automatically called on a
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	106 * background thread so you no longer have to explicitly call it. (The function turns into a no-op so your existing
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	107 * code won't break.) Having Update run in a separate thread has some advantages, particularly for streaming
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	108 * audio as all the OpenAL buffer queuing happens in this function. It is less likely the background thread will
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	109 * be blocked for long periods and thus less likely your buffer queues will be starved. However, this means you
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	110 * need to be extra careful about what you do in callback functions as they are invoked from the background thread.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	111 * I still consider this feature a experimental (though I am starting to use it more myself) and there
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	112 * may still be bugs.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	113 *
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	114 * @author Eric Wing
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	115 */
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	116
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	117
0 01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	118 #ifndef _SDL_ALMIXER_H_
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	119 #define _SDL_ALMIXER_H_
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	120
2 279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	121
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	122 #ifndef DOXYGEN_SHOULD_IGNORE_THIS
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	123 /** @cond DOXYGEN_SHOULD_IGNORE_THIS */
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	124
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	125 /* Note: For Doxygen to produce clean output, you should set the
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	126 * PREDEFINED option to remove ALMIXER_DECLSPEC, ALMIXER_CALL, and
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	127 * the DOXYGEN_SHOULD_IGNORE_THIS blocks.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	128 * PREDEFINED = DOXYGEN_SHOULD_IGNORE_THIS=1 ALMIXER_DECLSPEC= ALMIXER_CALL=
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	129 */
0 01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	130
2 279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	131 #ifdef ALMIXER_COMPILE_WITHOUT_SDL
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	132 #if defined(_WIN32)
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	133 #if defined(ALMIXER_BUILD_LIBRARY)
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	134 #define ALMIXER_DECLSPEC __declspec(dllexport)
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	135 #else
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	136 #define ALMIXER_DECLSPEC __declspec(dllimport)
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	137 #endif
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	138 #else
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	139 #if defined(ALMIXER_BUILD_LIBRARY)
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	140 #if defined (__GNUC__) && __GNUC__ >= 4
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	141 #define ALMIXER_DECLSPEC __attribute__((visibility("default")))
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	142 #else
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	143 #define ALMIXER_DECLSPEC
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	144 #endif
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	145 #else
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	146 #define ALMIXER_DECLSPEC
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	147 #endif
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	148 #endif
0 01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	149
2 279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	150 #if defined(_WIN32)
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	151 #define ALMIXER_CALL __cdecl
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	152 #else
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	153 #define ALMIXER_CALL
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	154 #endif
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	155 #else
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	156 #include "SDL_types.h" /* will include begin_code.h which is what I really want */
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	157 #define ALMIXER_DECLSPEC DECLSPEC
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	158 #define ALMIXER_CALL SDLCALL
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	159 #endif
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	160
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	161 /** @endcond DOXYGEN_SHOULD_IGNORE_THIS */
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	162 #endif /* DOXYGEN_SHOULD_IGNORE_THIS */
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	163
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	164
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	165
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	166 /* Needed for OpenAL types since altypes.h was removed in 1.1 */
1 a8a8fe374984 Subversion era Eric Wing <ewing . public \|-at-\| gmail . com> parents: 0 diff changeset	167 #include "al.h"
0 01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	168
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	169 /* Set up for C function definitions, even when using C++ */
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	170 #ifdef __cplusplus
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	171 extern "C" {
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	172 #endif
2 279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	173
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	174 #ifdef ALMIXER_COMPILE_WITHOUT_SDL
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	175 /**
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	176 * Struct that contains the version information of this library.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	177 * This represents the library's version as three levels: major revision
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	178 * (increments with massive changes, additions, and enhancements),
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	179 * minor revision (increments with backwards-compatible changes to the
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	180 * major revision), and patchlevel (increments with fixes to the minor
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	181 * revision).
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	182 * @see ALMIXER_VERSION, ALmixer_GetLinkedVersion
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	183 */
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	184 typedef struct ALmixer_version
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	185 {
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	186 ALubyte major;
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	187 ALubyte minor;
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	188 ALubyte patch;
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	189 } ALmixer_version;
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	190 #else
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	191 #include "SDL_version.h"
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	192 #define ALmixer_version SDL_version
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	193 #endif
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	194
0 01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	195 /* Printable format: "%d.%d.%d", MAJOR, MINOR, PATCHLEVEL
2 279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	196 */
0 01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	197 #define ALMIXER_MAJOR_VERSION 0
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	198 #define ALMIXER_MINOR_VERSION 1
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	199 #define ALMIXER_PATCHLEVEL 0
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	200
2 279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	201
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	202 /**
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	203 * @defgroup CoreOperation Initialization, Tear-down, and Core Operational Commands
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	204 * @{
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	205 * Functions for setting up and using ALmixer.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	206 */
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	207
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	208
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	209 /**
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	210 * This macro fills in a version structure with the version of the
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	211 * library you compiled against. This is determined by what header the
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	212 * compiler uses. Note that if you dynamically linked the library, you might
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	213 * have a slightly newer or older version at runtime. That version can be
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	214 * determined with ALmixer_GetLinkedVersion(), which, unlike
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	215 * ALMIXER_GET_COMPILED_VERSION, is not a macro.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	216 *
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	217 * @note When compiled with SDL, this macro can be used to fill a version structure
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	218 * compatible with SDL_version.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	219 *
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	220 * @param X A pointer to a ALmixer_version struct to initialize.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	221 *
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	222 * @see ALmixer_version, ALmixer_GetLinkedVersion
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	223 */
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	224 #define ALMIXER_GET_COMPILED_VERSION(X) \
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	225 { \
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	226 (X)->major = ALMIXER_MAJOR_VERSION; \
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	227 (X)->minor = ALMIXER_MINOR_VERSION; \
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	228 (X)->patch = ALMIXER_PATCHLEVEL; \
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	229 }
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	230
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	231 /**
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	232 * Gets the library version of the dynamically linked ALmixer you are using.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	233 * This gets the version of ALmixer that is linked against your program.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	234 * If you are using a shared library (DLL) version of ALmixer, then it is
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	235 * possible that it will be different than the version you compiled against.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	236 *
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	237 * This is a real function; the macro ALMIXER_GET_COMPILED_VERSION
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	238 * tells you what version of tErrorLib you compiled against:
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	239 *
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	240 * @code
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	241 * ALmixer_version compiled;
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	242 * ALmixer_version linked;
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	243 *
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	244 * ALMIXER_GET_COMPILED_VERSION(&compiled);
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	245 * ALmixer_GetLinkedVersion(&linked);
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	246 * printf("We compiled against tError version %d.%d.%d ...\n",
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	247 * compiled.major, compiled.minor, compiled.patch);
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	248 * printf("But we linked against tError version %d.%d.%d.\n",
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	249 * linked.major, linked.minor, linked.patch);
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	250 * @endcode
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	251 *
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	252 * @see ALmixer_version, ALMIXER_GET_COMPILED_VERSION
0 01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	253 */
2 279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	254 extern ALMIXER_DECLSPEC const ALmixer_version* ALMIXER_CALL ALmixer_GetLinkedVersion(void);
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	255
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	256 #ifdef ALMIXER_COMPILE_WITHOUT_SDL
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	257 /**
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	258 * Gets the last error string that was set by the system and clears the error.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	259 *
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	260 * @note When compiled with SDL, this directly uses SDL_GetError.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	261 *
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	262 * @return Returns a string containing the last error or "" when no error is set.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	263 */
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	264 extern ALMIXER_DECLSPEC const char* ALMIXER_CALL ALmixer_GetError(void);
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	265 /**
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	266 * Sets an error string that can be retrieved by ALmixer_GetError.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	267 *
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	268 * @note When compiled with SDL, this directly uses SDL_SetError.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	269 *
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	270 * param The error string to set.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	271 */
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	272 extern ALMIXER_DECLSPEC void ALMIXER_CALL ALmixer_SetError(const char *fmt, ...);
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	273 #else
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	274 #include "SDL_error.h"
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	275 /**
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	276 * Gets the last error string that was set by the system and clears the error.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	277 *
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	278 * @note When compiled with SDL, this directly uses SDL_GetError.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	279 *
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	280 * @return Returns a string containing the last error or "" when no error is set.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	281 */
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	282 #define ALmixer_GetError SDL_GetError
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	283 /**
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	284 * Sets an error string that can be retrieved by ALmixer_GetError.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	285 *
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	286 * @note When compiled with SDL, this directly uses SDL_SetError.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	287 *
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	288 * param The error string to set.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	289 */
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	290 #define ALmixer_SetError SDL_SetError
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	291 #endif
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	292
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	293
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	294 #ifdef ALMIXER_COMPILE_WITHOUT_SDL
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	295 #include "ALmixer_rwops.h"
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	296 #else
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	297 #include "SDL_rwops.h"
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	298 /**
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	299 * A struct that mimicks the SDL_RWops structure.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	300 *
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	301 * @note When compiled with SDL, this directly uses SDL_RWops.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	302 */
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	303 #define ALmixer_RWops SDL_RWops
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	304 #endif
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	305
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	306
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	307 #define ALMIXER_DEFAULT_FREQUENCY 0
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	308 #define ALMIXER_DEFAULT_REFRESH 0
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	309 #define ALMIXER_DEFAULT_NUM_CHANNELS 16
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	310 #define ALMIXER_DEFAULT_NUM_SOURCES ALMIXER_DEFAULT_NUM_CHANNELS
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	311
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	312 /**
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	313 * This is the recommended Init function. This will initialize the context, SDL_sound,
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	314 * and the mixer system. You should call this in the setup of your code, after SDL_Init.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	315 * If you attempt to bypass this function, you do so at your own risk.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	316 *
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	317 * @note ALmixer expects the SDL audio subsystem to be disabled. In some cases, an enabled
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	318 * SDL audio subsystem will interfere and cause problems in your app. This Init method explicitly
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	319 * disables the SDL subsystem if SDL is compiled in.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	320 *
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	321 * @note The maximum number of sources is OpenAL implementation dependent.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	322 * Currently 16 is lowest common denominator for all OpenAL implementations in current use.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	323 * 32 is currently the second lowest common denominator.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	324 * If you try to allocate more sources than are actually available, this function may return false depending
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	325 * if the OpenAL implementation returns an error or not. It is possible for OpenAL to silently fail
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	326 * so be very careful about picking too many sources.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	327 *
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	328 * @param playback_frequency The sample rate you want OpenAL to play at, e.g. 44100
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	329 * Note that OpenAL is not required to actually respect this value.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	330 * Pass in 0 or ALMIXER_DEFAULT_FREQUENCY to specify you want to use your implementation's default value.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	331 * @param num_sources The number of OpenAL sources (also can be thought of as
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	332 * SDL_mixer channels) you wish to allocate.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	333 * Pass in 0 or ALMIXER_DEFAULT_NUM_SOURCES to use ALmixer's default value.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	334 * @param refresh_rate The refresh rate you want OpenAL to operate at.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	335 * Note that OpenAL is not required to respect this value.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	336 * Pass in 0 or ALMIXER_DEFAULT_REFRESH to use OpenAL default behaviors.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	337 * @return Returns AL_FALSE on a failure or AL_TRUE if successfully initialized.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	338 */
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	339 extern ALMIXER_DECLSPEC ALboolean ALMIXER_CALL ALmixer_Init(ALuint playback_frequency, ALint num_sources, ALuint refresh_rate);
0 01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	340
2 279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	341 /**
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	342 * InitContext will only initialize the OpenAL context (and not the mixer part).
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	343 * Note that SDL_Sound is also initialized here because load order matters
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	344 * because SDL audio will conflict with OpenAL when using SMPEG. This is only
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	345 * provided as a backdoor and is not recommended.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	346 *
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	347 * @note This is a backdoor in case you need to initialize the AL context and
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	348 * the mixer system separately. I strongly recommend avoiding these two functions
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	349 * and use the normal Init() function.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	350 */
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	351 extern ALMIXER_DECLSPEC ALboolean ALMIXER_CALL ALmixer_InitContext(ALuint playback_frequency, ALuint refresh_rate);
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	352
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	353 /**
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	354 * InitMixer will only initialize the Mixer system. This is provided in the case
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	355 * that you need control over the loading of the context. You may load the context
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	356 * yourself, and then call this function. This is not recommended practice, but is
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	357 * provided as a backdoor in case you have good reason to
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	358 * do this. Be warned that if ALmixer_InitMixer() fails,
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	359 * it will not clean up the AL context. Also be warned that Quit() still does try to
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	360 * clean up everything.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	361 *
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	362 * @note This is a backdoor in case you need to initialize the AL context and
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	363 * the mixer system separately. I strongly recommend avoiding these two functions
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	364 * and use the normal Init() function.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	365 */
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	366 extern ALMIXER_DECLSPEC ALboolean ALMIXER_CALL ALmixer_InitMixer(ALint num_sources);
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	367
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	368 /**
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	369 * This shuts down ALmixer. Please remember to free your ALmixer_Data* instances
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	370 * before calling this method.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	371 */
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	372 extern ALMIXER_DECLSPEC void ALMIXER_CALL ALmixer_Quit(void);
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	373 /**
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	374 * Returns whether ALmixer has been initializatized (via Init) or not.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	375 * @return Returns true for initialized and false for not initialized.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	376 */
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	377 extern ALMIXER_DECLSPEC ALboolean ALMIXER_CALL ALmixer_IsInitialized(void);
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	378
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	379 /**
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	380 * Returns the frequency that OpenAL is set to.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	381 * @note This function is not guaranteed to give correct information and is OpenAL implementation dependent.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	382 * @return Returns the frequency, e.g. 44100.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	383 */
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	384 extern ALMIXER_DECLSPEC ALuint ALMIXER_CALL ALmixer_GetFrequency(void);
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	385
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	386 /**
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	387 * Let's you change the maximum number of channels/sources available.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	388 * This function is not heavily tested. It is probably better to simply initialize
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	389 * ALmixer with the number of sources you want when you initialize it instead of
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	390 * dynamically changing it later.
0 01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	391 */
2 279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	392 extern ALMIXER_DECLSPEC ALint ALMIXER_CALL ALmixer_AllocateChannels(ALint num_chans);
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	393
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	394 /**
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	395 * Allows you to reserve a certain number of channels so they won't be automatically
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	396 * allocated to play on.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	397 * This function will effectively block off a certain number of channels so they won't
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	398 * be automatically assigned to be played on when you call various play functions
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	399 * (applies to both play-channel and play-source functions since they are the same under the hood).
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	400 * The lowest number channels will always be blocked off first.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	401 * For example, if there are 16 channels available, and you pass 2 into this function,
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	402 * channels 0 and 1 will be reserved so they won't be played on automatically when you specify
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	403 * you want to play a sound on any available channel/source. You can
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	404 * still play on channels 0 and 1 if you explicitly designate you want to play on their channel
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	405 * number or source id.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	406 * Setting back to 0 will clear all the reserved channels so all will be available again for
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	407 * auto-assignment.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	408 * As an example, this feature can be useful if you always want your music to be on channel 0 and
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	409 * speech on channel 1 and you don't want sound effects to ever occupy those channels. This allows
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	410 * you to build in certain assumptions about your code, perhaps for deciding which data you want
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	411 * to analyze in a data callback.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	412 * Specifying the number of reserve channels to the maximum number of channels will effectively
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	413 * disable auto-assignment.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	414 * @param number_of_reserve_channels The number of channels/sources to reserve.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	415 * Or pass -1 to find out how many channels are currently reserved.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	416 * @return Returns the number of currently reserved channels.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	417 */
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	418 extern ALMIXER_DECLSPEC ALint ALMIXER_CALL ALmixer_ReserveChannels(ALint number_of_reserve_channels);
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	419
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	420
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	421 /**
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	422 * The update function that allows ALmixer to update its internal state.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	423 * If not compiled with/using threads, this function must be periodically called
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	424 * to poll ALmixer to force streamed music and other events to
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	425 * take place.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	426 * The typical place to put this function is in your main-loop.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	427 * If threads are enabled, then this function just
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	428 * returns 0 and is effectively a no-op. With threads, it is not necessary to call this function
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	429 * because updates are handled internally on another thread. However, because threads are still considered
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	430 * experimental, it is recommended you call this function in a proper place in your code in case
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	431 * future versions of this library need to abandon threads.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	432 * @return Returns 0 if using threads. If not using threads, for debugging purposes, it returns
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	433 * the number of buffers queued during the loop, or a negative value indicating the numer of errors encountered.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	434 * This is subject to change and should not be relied on.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	435 */
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	436 extern ALMIXER_DECLSPEC ALint ALMIXER_CALL ALmixer_Update(void);
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	437
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	438 /**
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	439 * @}
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	440 */
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	441
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	442 /**
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	443 * @defgroup LoadAPI Load Audio Functions
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	444 * @{
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	445 * Functions for loading and unloading audio data.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	446 */
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	447
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	448
0 01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	449
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	450 /*
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	451 #define ALmixer_AudioInfo Sound_AudioInfo
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	452 */
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	453
2 279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	454 /*
0 01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	455 #define ALMIXER_DEFAULT_BUFFERSIZE 32768
2 279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	456 #define ALMIXER_DEFAULT_BUFFERSIZE 4096
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	457 */
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	458 #define ALMIXER_DEFAULT_BUFFERSIZE 16384
0 01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	459
2 279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	460 /* You probably never need to use these macros directly. */
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	461 #ifndef ALMIXER_DISABLE_PREDECODED_PRECOMPUTE_BUFFER_SIZE_OPTIMIZATION
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	462 #define ALMIXER_DEFAULT_PREDECODED_BUFFERSIZE ALMIXER_DEFAULT_BUFFERSIZE * 4
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	463 #else
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	464 /* I'm picking a smaller buffer because ALmixer will try to create a new larger buffer
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	465 * based on the length of the audio. So creating a large block up-front might just be a waste.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	466 * However, if my attempts fail for some reason, this buffer size becomes a fallback.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	467 * Having too small of a buffer might cause performance bottlenecks.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	468 */
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	469 #define ALMIXER_DEFAULT_PREDECODED_BUFFERSIZE 1024
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	470 #endif
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	471
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	472 /**
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	473 * Specifies the maximum number of queue buffers to use for a sound stream.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	474 * Default Queue Buffers must be at least 2.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	475 */
0 01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	476 #define ALMIXER_DEFAULT_QUEUE_BUFFERS 5
2 279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	477 /**
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	478 * Specifies the number of queue buffers initially filled when first loading a stream.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	479 * Default startup buffers should be at least 1. */
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	480 #define ALMIXER_DEFAULT_STARTUP_BUFFERS 2
0 01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	481
1 a8a8fe374984 Subversion era Eric Wing <ewing . public \|-at-\| gmail . com> parents: 0 diff changeset	482 /*
0 01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	483 #define ALMIXER_DECODE_STREAM 0
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	484 #define ALMIXER_DECODE_ALL 1
1 a8a8fe374984 Subversion era Eric Wing <ewing . public \|-at-\| gmail . com> parents: 0 diff changeset	485 */
0 01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	486
1 a8a8fe374984 Subversion era Eric Wing <ewing . public \|-at-\| gmail . com> parents: 0 diff changeset	487 /* This is a trick I picked up from Lua. Doing the typedef separately
a8a8fe374984 Subversion era Eric Wing <ewing . public \|-at-\| gmail . com> parents: 0 diff changeset	488 * (and I guess before the definition) instead of a single
a8a8fe374984 Subversion era Eric Wing <ewing . public \|-at-\| gmail . com> parents: 0 diff changeset	489 * entry: typedef struct {...} YourName; seems to allow me
a8a8fe374984 Subversion era Eric Wing <ewing . public \|-at-\| gmail . com> parents: 0 diff changeset	490 * to use forward declarations. Doing it the other way (like SDL)
a8a8fe374984 Subversion era Eric Wing <ewing . public \|-at-\| gmail . com> parents: 0 diff changeset	491 * seems to prevent me from using forward declarions as I get conflicting
a8a8fe374984 Subversion era Eric Wing <ewing . public \|-at-\| gmail . com> parents: 0 diff changeset	492 * definition errors. I don't really understand why though.
a8a8fe374984 Subversion era Eric Wing <ewing . public \|-at-\| gmail . com> parents: 0 diff changeset	493 */
a8a8fe374984 Subversion era Eric Wing <ewing . public \|-at-\| gmail . com> parents: 0 diff changeset	494 typedef struct ALmixer_Data ALmixer_Data;
a8a8fe374984 Subversion era Eric Wing <ewing . public \|-at-\| gmail . com> parents: 0 diff changeset	495 typedef struct ALmixer_AudioInfo ALmixer_AudioInfo;
0 01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	496
1 a8a8fe374984 Subversion era Eric Wing <ewing . public \|-at-\| gmail . com> parents: 0 diff changeset	497 /**
2 279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	498 * Roughly the equvialent to the Sound_AudioInfo struct in SDL_sound.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	499 * Types have been changed to use AL types because I know those are available.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	500 * This is different than SDL which uses fixed types so there might be subtle
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	501 * things you need to pay attention to..
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	502 * @note Originally, I just used the Sound_AudioInfo directly, but
1 a8a8fe374984 Subversion era Eric Wing <ewing . public \|-at-\| gmail . com> parents: 0 diff changeset	503 * I've been trying to reduce the header dependencies for this file.
a8a8fe374984 Subversion era Eric Wing <ewing . public \|-at-\| gmail . com> parents: 0 diff changeset	504 * But more to the point, I've been interested in dealing with the
a8a8fe374984 Subversion era Eric Wing <ewing . public \|-at-\| gmail . com> parents: 0 diff changeset	505 * WinMain override problem Josh faced when trying to use SDL components
a8a8fe374984 Subversion era Eric Wing <ewing . public \|-at-\| gmail . com> parents: 0 diff changeset	506 * in an MFC app which didn't like losing control of WinMain.
a8a8fe374984 Subversion era Eric Wing <ewing . public \|-at-\| gmail . com> parents: 0 diff changeset	507 * My theory is that if I can purge the header of any thing that
a8a8fe374984 Subversion era Eric Wing <ewing . public \|-at-\| gmail . com> parents: 0 diff changeset	508 * #include's SDL_main.h, then this might work.
a8a8fe374984 Subversion era Eric Wing <ewing . public \|-at-\| gmail . com> parents: 0 diff changeset	509 * So I am now introducing my own AudioInfo struct.
a8a8fe374984 Subversion era Eric Wing <ewing . public \|-at-\| gmail . com> parents: 0 diff changeset	510 */
a8a8fe374984 Subversion era Eric Wing <ewing . public \|-at-\| gmail . com> parents: 0 diff changeset	511 struct ALmixer_AudioInfo
a8a8fe374984 Subversion era Eric Wing <ewing . public \|-at-\| gmail . com> parents: 0 diff changeset	512 {
2 279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	513 ALushort format; /*< Equivalent of SDL_AudioSpec.format. /
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	514 ALubyte channels; /*< Number of sound channels. 1 == mono, 2 == stereo. /
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	515 ALuint rate; /*< Sample rate; frequency of sample points per second. /
1 a8a8fe374984 Subversion era Eric Wing <ewing . public \|-at-\| gmail . com> parents: 0 diff changeset	516 };
0 01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	517
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	518
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	519
2 279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	520 /**
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	521 * This is a general loader function to load an audio resource from an RWops.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	522 * Generally, you should use the LoadStream and LoadAll specializations of this function instead which call this.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	523 * @param rw_ops The rwops pointing to the audio resource you want to load.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	524 * @param file_ext The file extension of your audio type which is used as a hint by the backend to decide which
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	525 * decoder to use.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	526 * @param buffer_size The size of a buffer to allocate for read chunks. This number should be in quantized with
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	527 * the valid frame sizes of your audio data. If the data is streamed, the data will be read in buffer_size chunks.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	528 * If the file is to be predecoded, optimizations may occur and this value might be ignored.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	529 * @param decode_mode_is_predecoded Specifies whether you want to completely preload the data or stream the data in chunks.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	530 * @param max_queue_buffers For streamed data, specifies the maximum number of buffers that can be queued at any given time.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	531 * @param num_startup_buffers For streamed data, specifies the number of buffers to fill before playback starts.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	532 * @param access_data A boolean that specifies if you want the data contained in the currently playing buffer to be handed
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	533 * to you in a callback function. Note that for predecoded data, you get back the entire buffer in one callback when the
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	534 * audio first starts playing. With streamed data, you get the data in buffer_size chunks. Callbacks are not guarnanteed
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	535 * to be perfectly in-sync as this is a best-effort implementaiton. There are memory and performance considerations for
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	536 * using this feature, so if you don't need data callbacks, you should pass false to this function.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	537 * @return Returns an ALmixer_Data* of the loaded sample or NULL if failed.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	538 */
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	539 extern ALMIXER_DECLSPEC ALmixer_Data* ALMIXER_CALL ALmixer_LoadSample_RW(ALmixer_RWops* rw_ops, const char* file_ext, ALuint buffer_size, ALboolean decode_mode_is_predecoded, ALuint max_queue_buffers, ALuint num_startup_buffers, ALboolean access_data);
0 01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	540
2 279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	541 #ifdef DOXYGEN_ONLY
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	542 /**
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	543 * This is the loader function to load an audio resource from an RWops as a stream.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	544 * @param rw_ops The rwops pointing to the audio resource you want to load.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	545 * @param file_ext The file extension of your audio type which is used as a hint by the backend to decide which
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	546 * decoder to use.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	547 * @param buffer_size The size of a buffer to allocate for read chunks. This number should be in quantized with
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	548 * the valid frame sizes of your audio data. If the data is streamed, the data will be read in buffer_size chunks.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	549 * @param max_queue_buffers For streamed data, specifies the maximum number of buffers that can be queued at any given time.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	550 * @param num_startup_buffers For streamed data, specifies the number of buffers to fill before playback starts.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	551 * @param access_data A boolean that specifies if you want the data contained in the currently playing buffer to be handed
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	552 * to you in a callback function. Note that for predecoded data, you get back the entire buffer in one callback when the
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	553 * audio first starts playing. With streamed data, you get the data in buffer_size chunks. Callbacks are not guarnanteed
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	554 * to be perfectly in-sync as this is a best-effort implementaiton. There are memory and performance considerations for
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	555 * using this feature, so if you don't need data callbacks, you should pass false to this function.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	556 * @return Returns an ALmixer_Data* of the loaded sample or NULL if failed.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	557 */
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	558 ALmixer_Data* ALmixer_LoadStream_RW(ALmixer_RWops* rw_ops, const char* file_ext, ALuint buffer_size, ALuint max_queue_buffers, ALuint num_startup_buffers, ALboolean access_data);
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	559 #else
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	560 #define ALmixer_LoadStream_RW(rw_ops, file_ext, buffer_size, max_queue_buffers, num_startup_buffers, access_data) ALmixer_LoadSample_RW(rw_ops,file_ext, buffer_size, AL_FALSE, max_queue_buffers, num_startup_buffers, access_data)
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	561 #endif
0 01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	562
2 279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	563 #ifdef DOXYGEN_ONLY
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	564 /**
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	565 * This is the loader function to completely preload an audio resource from an RWops into RAM.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	566 * @param rw_ops The rwops pointing to the audio resource you want to load.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	567 * @param file_ext The file extension of your audio type which is used as a hint by the backend to decide which
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	568 * decoder to use.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	569 * @param access_data A boolean that specifies if you want the data contained in the currently playing buffer to be handed
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	570 * to you in a callback function. Note that for predecoded data, you get back the entire buffer in one callback when the
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	571 * audio first starts playing. With streamed data, you get the data in buffer_size chunks. Callbacks are not guarnanteed
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	572 * to be perfectly in-sync as this is a best-effort implementaiton. There are memory and performance considerations for
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	573 * using this feature, so if you don't need data callbacks, you should pass false to this function.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	574 * @return Returns an ALmixer_Data* of the loaded sample or NULL if failed.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	575 */
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	576 ALmixer_Data* ALmixer_LoadAll_RW(ALmixer_RWops* rw_ops, const char* file_ext, ALboolean access_data);
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	577 #else
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	578 #define ALmixer_LoadAll_RW(rw_ops, file_ext, access_data) ALmixer_LoadSample_RW(rw_ops, fileext, ALMIXER_DEFAULT_PREDECODED_BUFFERSIZE, AL_TRUE, 0, 0, access_data)
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	579 #endif
0 01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	580
2 279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	581 /**
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	582 * This is a general loader function to load an audio resource from a file.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	583 * Generally, you should use the LoadStream and LoadAll specializations of this function instead which call this.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	584 * @param file_name The file of the audio resource you want to load.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	585 * @param buffer_size The size of a buffer to allocate for read chunks. This number should be in quantized with
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	586 * the valid frame sizes of your audio data. If the data is streamed, the data will be read in buffer_size chunks.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	587 * If the file is to be predecoded, optimizations may occur and this value might be ignored.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	588 * @param decode_mode_is_predecoded Specifies whether you want to completely preload the data or stream the data in chunks.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	589 * @param max_queue_buffers For streamed data, specifies the maximum number of buffers that can be queued at any given time.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	590 * @param num_startup_buffers For streamed data, specifies the number of buffers to fill before playback starts.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	591 * @param access_data A boolean that specifies if you want the data contained in the currently playing buffer to be handed
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	592 * to you in a callback function. Note that for predecoded data, you get back the entire buffer in one callback when the
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	593 * audio first starts playing. With streamed data, you get the data in buffer_size chunks. Callbacks are not guarnanteed
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	594 * to be perfectly in-sync as this is a best-effort implementaiton. There are memory and performance considerations for
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	595 * using this feature, so if you don't need data callbacks, you should pass false to this function.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	596 * @return Returns an ALmixer_Data* of the loaded sample or NULL if failed.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	597 */
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	598 extern ALMIXER_DECLSPEC ALmixer_Data * ALMIXER_CALL ALmixer_LoadSample(const char* file_name, ALuint buffer_size, ALboolean decode_mode_is_predecoded, ALuint max_queue_buffers, ALuint num_startup_buffers, ALboolean access_data);
0 01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	599
2 279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	600 #ifdef DOXYGEN_ONLY
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	601 /**
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	602 * This is the loader function to load an audio resource from a file.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	603 * @param file_name The file to the audio resource you want to load.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	604 * @param buffer_size The size of a buffer to allocate for read chunks. This number should be in quantized with
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	605 * the valid frame sizes of your audio data. If the data is streamed, the data will be read in buffer_size chunks.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	606 * @param max_queue_buffers For streamed data, specifies the maximum number of buffers that can be queued at any given time.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	607 * @param num_startup_buffers For streamed data, specifies the number of buffers to fill before playback starts.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	608 * @param access_data A boolean that specifies if you want the data contained in the currently playing buffer to be handed
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	609 * to you in a callback function. Note that for predecoded data, you get back the entire buffer in one callback when the
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	610 * audio first starts playing. With streamed data, you get the data in buffer_size chunks. Callbacks are not guarnanteed
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	611 * to be perfectly in-sync as this is a best-effort implementaiton. There are memory and performance considerations for
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	612 * using this feature, so if you don't need data callbacks, you should pass false to this function.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	613 * @return Returns an ALmixer_Data* of the loaded sample or NULL if failed.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	614 */
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	615 ALmixer_Data* ALmixer_LoadStream(const char* file_name, ALuint buffer_size, ALuint max_queue_buffers, ALuint num_startup_buffers, ALboolean access_data);
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	616 #else
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	617 #define ALmixer_LoadStream(file_name, buffer_size, max_queue_buffers, num_startup_buffers,access_data) ALmixer_LoadSample(file_name, buffer_size, AL_FALSE, max_queue_buffers, num_startup_buffers, access_data)
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	618 #endif
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	619
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	620 #ifdef DOXYGEN_ONLY
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	621 /**
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	622 * This is the loader function to completely preload an audio resource from a file into RAM.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	623 * @param file_name The file to the audio resource you want to load.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	624 * @param access_data A boolean that specifies if you want the data contained in the currently playing buffer to be handed
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	625 * to you in a callback function. Note that for predecoded data, you get back the entire buffer in one callback when the
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	626 * audio first starts playing. With streamed data, you get the data in buffer_size chunks. Callbacks are not guarnanteed
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	627 * to be perfectly in-sync as this is a best-effort implementaiton. There are memory and performance considerations for
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	628 * using this feature, so if you don't need data callbacks, you should pass false to this function.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	629 * @return Returns an ALmixer_Data* of the loaded sample or NULL if failed.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	630 */
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	631 ALmixer_Data* ALmixer_LoadAll(const char* file_name, ALboolean access_data);
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	632 #else
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	633 #define ALmixer_LoadAll(file_name, access_data) ALmixer_LoadSample(file_name, ALMIXER_DEFAULT_PREDECODED_BUFFERSIZE, AL_TRUE, 0, 0, access_data)
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	634 #endif
0 01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	635
2 279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	636 /**
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	637 * This is a back door general loader function for RAW samples or if you need to specify the ALmixer_AudioInfo field.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	638 * Use at your own risk.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	639 * Generally, you should use the LoadStream and LoadAll specializations of this function instead which call this.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	640 * @param rw_ops The rwops pointing to the audio resource you want to load.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	641 * @param file_ext The file extension of your audio type which is used as a hint by the backend to decide which
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	642 * decoder to use. Pass "raw" for raw formats.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	643 * @param desired_format The format you want audio decoded to. NULL will pick a default for you.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	644 * @param buffer_size The size of a buffer to allocate for read chunks. This number should be in quantized with
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	645 * the valid frame sizes of your audio data. If the data is streamed, the data will be read in buffer_size chunks.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	646 * If the file is to be predecoded, optimizations may occur and this value might be ignored.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	647 * @param decode_mode_is_predecoded Specifies whether you want to completely preload the data or stream the data in chunks.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	648 * @param max_queue_buffers For streamed data, specifies the maximum number of buffers that can be queued at any given time.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	649 * @param num_startup_buffers For streamed data, specifies the number of buffers to fill before playback starts.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	650 * @param access_data A boolean that specifies if you want the data contained in the currently playing buffer to be handed
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	651 * to you in a callback function. Note that for predecoded data, you get back the entire buffer in one callback when the
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	652 * audio first starts playing. With streamed data, you get the data in buffer_size chunks. Callbacks are not guarnanteed
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	653 * to be perfectly in-sync as this is a best-effort implementaiton. There are memory and performance considerations for
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	654 * using this feature, so if you don't need data callbacks, you should pass false to this function.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	655 * @return Returns an ALmixer_Data* of the loaded sample or NULL if failed.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	656 */
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	657 extern ALMIXER_DECLSPEC ALmixer_Data * ALMIXER_CALL ALmixer_LoadSample_RAW_RW(ALmixer_RWops* rw_ops, const char* file_ext, ALmixer_AudioInfo* desired_format, ALuint buffer_size, ALboolean decode_mode_is_predecoded, ALuint max_queue_buffers, ALuint num_startup_buffers, ALboolean access_data);
0 01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	658
2 279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	659 #ifdef DOXYGEN_ONLY
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	660 /**
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	661 * This is a back door stream loader function for RAW samples or if you need to specify the ALmixer_AudioInfo field.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	662 * Use at your own risk.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	663 * @param rw_ops The rwops pointing to the audio resource you want to load.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	664 * @param file_ext The file extension of your audio type which is used as a hint by the backend to decide which
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	665 * decoder to use. Pass "raw" for raw formats.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	666 * @param desired_format The format you want audio decoded to. NULL will pick a default for you.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	667 * @param buffer_size The size of a buffer to allocate for read chunks. This number should be in quantized with
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	668 * the valid frame sizes of your audio data. If the data is streamed, the data will be read in buffer_size chunks.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	669 * If the file is to be predecoded, optimizations may occur and this value might be ignored.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	670 * @param max_queue_buffers For streamed data, specifies the maximum number of buffers that can be queued at any given time.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	671 * @param num_startup_buffers For streamed data, specifies the number of buffers to fill before playback starts.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	672 * @param access_data A boolean that specifies if you want the data contained in the currently playing buffer to be handed
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	673 * to you in a callback function. Note that for predecoded data, you get back the entire buffer in one callback when the
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	674 * audio first starts playing. With streamed data, you get the data in buffer_size chunks. Callbacks are not guarnanteed
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	675 * to be perfectly in-sync as this is a best-effort implementaiton. There are memory and performance considerations for
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	676 * using this feature, so if you don't need data callbacks, you should pass false to this function.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	677 * @return Returns an ALmixer_Data* of the loaded sample or NULL if failed.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	678 */
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	679 ALmixer_Data* ALmixer_LoadStream_RAW_RW(ALmixer_RWops* rw_ops, const char* file_ext, ALmixer_AudioInfo* desired_format, ALuint buffer_size, ALuint max_queue_buffers, ALuint num_startup_buffers, ALboolean access_data);
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	680 #else
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	681 #define ALmixer_LoadStream_RAW_RW(rw_ops, file_ext, desired_format, buffer_size, max_queue_buffers, num_startup_buffers, access_data) ALmixer_LoadSample_RAW_RW(rw_ops, file_ext, desired_format, buffer_size, AL_FALSE, max_queue_buffers, num_startup_buffers, access_data)
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	682 #endif
0 01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	683
2 279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	684 #ifdef DOXYGEN_ONLY
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	685 /**
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	686 * This is a back door loader function for complete preloading RAW samples into RAM or if you need to specify the ALmixer_AudioInfo field.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	687 * Use at your own risk.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	688 * @param rw_ops The rwops pointing to the audio resource you want to load.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	689 * @param file_ext The file extension of your audio type which is used as a hint by the backend to decide which
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	690 * decoder to use. Pass "raw" for raw formats.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	691 * @param desired_format The format you want audio decoded to. NULL will pick a default for you.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	692 * @param access_data A boolean that specifies if you want the data contained in the currently playing buffer to be handed
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	693 * to you in a callback function. Note that for predecoded data, you get back the entire buffer in one callback when the
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	694 * audio first starts playing. With streamed data, you get the data in buffer_size chunks. Callbacks are not guarnanteed
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	695 * to be perfectly in-sync as this is a best-effort implementaiton. There are memory and performance considerations for
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	696 * using this feature, so if you don't need data callbacks, you should pass false to this function.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	697 * @return Returns an ALmixer_Data* of the loaded sample or NULL if failed.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	698 */
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	699 ALmixer_Data* ALmixer_LoadAll_RAW_RW(ALmixer_RWops* rw_ops, const char* file_ext, ALmixer_AudioInfo* desired_format, ALboolean access_data);
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	700 #else
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	701 #define ALmixer_LoadAll_RAW_RW(rw_ops, file_ext, desired_format, access_data) ALmixer_LoadSample_RAW_RW(rw_ops, file_ext, desired_format, ALMIXER_DEFAULT_PREDECODED_BUFFERSIZE, AL_TRUE, 0, 0, access_data)
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	702 #endif
0 01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	703
2 279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	704 /**
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	705 * This is a back door general loader function for RAW samples or if you need to specify the ALmixer_AudioInfo field.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	706 * Use at your own risk.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	707 * Generally, you should use the LoadStream and LoadAll specializations of this function instead which call this.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	708 * @param file_name The file to the audio resource you want to load. Extension should be "raw" for raw formats.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	709 * @param desired_format The format you want audio decoded to. NULL will pick a default for you.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	710 * @param buffer_size The size of a buffer to allocate for read chunks. This number should be in quantized with
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	711 * the valid frame sizes of your audio data. If the data is streamed, the data will be read in buffer_size chunks.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	712 * If the file is to be predecoded, optimizations may occur and this value might be ignored.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	713 * @param decode_mode_is_predecoded Specifies whether you want to completely preload the data or stream the data in chunks.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	714 * @param max_queue_buffers For streamed data, specifies the maximum number of buffers that can be queued at any given time.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	715 * @param num_startup_buffers For streamed data, specifies the number of buffers to fill before playback starts.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	716 * @param access_data A boolean that specifies if you want the data contained in the currently playing buffer to be handed
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	717 * to you in a callback function. Note that for predecoded data, you get back the entire buffer in one callback when the
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	718 * audio first starts playing. With streamed data, you get the data in buffer_size chunks. Callbacks are not guarnanteed
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	719 * to be perfectly in-sync as this is a best-effort implementaiton. There are memory and performance considerations for
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	720 * using this feature, so if you don't need data callbacks, you should pass false to this function.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	721 * @return Returns an ALmixer_Data* of the loaded sample or NULL if failed.
0 01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	722 */
2 279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	723 extern ALMIXER_DECLSPEC ALmixer_Data * ALMIXER_CALL ALmixer_LoadSample_RAW(const char* file_name, ALmixer_AudioInfo* desired_format, ALuint buffer_size, ALboolean decode_mode_is_predecoded, ALuint max_queue_buffers, ALuint num_startup_buffers, ALboolean access_data);
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	724
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	725 #ifdef DOXYGEN_ONLY
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	726 /**
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	727 * This is a back door stream loader function for RAW samples or if you need to specify the ALmixer_AudioInfo field.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	728 * Use at your own risk.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	729 * @param file_name The file to the audio resource you want to load.Extension should be "raw" for raw formats.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	730 * @param desired_format The format you want audio decoded to. NULL will pick a default for you.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	731 * @param buffer_size The size of a buffer to allocate for read chunks. This number should be in quantized with
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	732 * the valid frame sizes of your audio data. If the data is streamed, the data will be read in buffer_size chunks.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	733 * If the file is to be predecoded, optimizations may occur and this value might be ignored.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	734 * @param max_queue_buffers For streamed data, specifies the maximum number of buffers that can be queued at any given time.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	735 * @param num_startup_buffers For streamed data, specifies the number of buffers to fill before playback starts.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	736 * @param access_data A boolean that specifies if you want the data contained in the currently playing buffer to be handed
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	737 * to you in a callback function. Note that for predecoded data, you get back the entire buffer in one callback when the
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	738 * audio first starts playing. With streamed data, you get the data in buffer_size chunks. Callbacks are not guarnanteed
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	739 * to be perfectly in-sync as this is a best-effort implementaiton. There are memory and performance considerations for
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	740 * using this feature, so if you don't need data callbacks, you should pass false to this function.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	741 * @return Returns an ALmixer_Data* of the loaded sample or NULL if failed.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	742 */
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	743 ALmixer_Data* ALmixer_LoadStream_RAW(const char* file_name, ALmixer_AudioInfo* desired_format, ALuint buffer_size, ALuint max_queue_buffers, ALuint num_startup_buffers, ALboolean access_data);
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	744 #else
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	745 #define ALmixer_LoadStream_RAW(file_name, desired_format, buffer_size, max_queue_buffers, num_startup_buffers, access_data) ALmixer_LoadSample_RAW(file_name, desired_format, buffer_size, AL_FALSE, max_queue_buffers, num_startup_buffers, access_data)
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	746 #endif
0 01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	747
2 279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	748 #ifdef DOXYGEN_ONLY
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	749 /**
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	750 * This is a back door loader function for complete preloading RAW samples into RAM or if you need to specify the ALmixer_AudioInfo field.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	751 * Use at your own risk.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	752 * @param file_name The file to the audio resource you want to load. Extension should be "raw" for raw formats.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	753 * @param desired_format The format you want audio decoded to. NULL will pick a default for you.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	754 * @param access_data A boolean that specifies if you want the data contained in the currently playing buffer to be handed
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	755 * to you in a callback function. Note that for predecoded data, you get back the entire buffer in one callback when the
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	756 * audio first starts playing. With streamed data, you get the data in buffer_size chunks. Callbacks are not guarnanteed
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	757 * to be perfectly in-sync as this is a best-effort implementaiton. There are memory and performance considerations for
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	758 * using this feature, so if you don't need data callbacks, you should pass false to this function.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	759 * @return Returns an ALmixer_Data* of the loaded sample or NULL if failed.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	760 */
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	761 ALmixer_Data* ALmixer_LoadAll_RAW(const char* file_name, ALmixer_AudioInfo* desired_format, ALboolean access_data);
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	762 #else
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	763 #define ALmixer_LoadAll_RAW(file_name, desired_format, access_data) ALmixer_LoadSample_RAW(file_name, desired_format, ALMIXER_DEFAULT_PREDECODED_BUFFERSIZE, AL_TRUE, 0, 0, access_data)
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	764 #endif
0 01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	765
2 279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	766 /**
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	767 * Frees an ALmixer_Data.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	768 * Releases the memory associated with a ALmixer_Data. Use this when you are done playing the audio sample
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	769 * and wish to release the memory.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	770 * @warning Do not try releasing data that is currently in use (e.g. playing, paused).
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	771 * @warning Make sure to free your data before calling ALmixer_Quit. Do not free data aftter ALmixer_Quit().
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	772 * @param almixer_data The ALmixer_Data* you want to free.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	773 */
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	774 extern ALMIXER_DECLSPEC void ALMIXER_CALL ALmixer_FreeData(ALmixer_Data* almixer_data);
0 01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	775
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	776
2 279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	777 /**
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	778 * Returns true if the almixer_data was completely loaded into memory or false if it was loaded
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	779 * as a stream.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	780 * @param almixer_data The audio resource you want to know about.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	781 * @return AL_TRUE is predecoded, or AL_FALSE if streamed.
0 01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	782 */
2 279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	783 extern ALMIXER_DECLSPEC ALboolean ALMIXER_CALL ALmixer_IsPredecoded(ALmixer_Data* almixer_data);
0 01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	784
2 279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	785 /**
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	786 * @}
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	787 */
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	788
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	789 /**
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	790 * @defgroup CallbackAPI Callbacks
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	791 * @{
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	792 * Functions for callbacks
0 01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	793 */
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	794
2 279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	795 /**
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	796 * Allows you to set a callback for when a sound has finished playing on a channel/source.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	797 * @param playback_finished_callback The function you want to be invoked when a sound finishes.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	798 * The callback function will pass you back the channel number which just finished playing,
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	799 * the OpenAL source id associated with the channel, the ALmixer_Data* that was played,
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	800 * a boolean telling you whether a sound finished playing because it ended normally or because
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	801 * something interrupted the playback (such as the user calling ALmixer_Halt*), and the
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	802 * user_data supplied as the second parameter to this function.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	803 * @param which_chan The ALmixer channel that the data is currently playing on.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	804 * @param al_source The OpenAL source that the data is currently playing on.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	805 * @param almixer_data The ALmixer_Data that was played.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	806 * @param finished_naturally AL_TRUE if the sound finished playing because it ended normally
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	807 * or AL_FALSE because something interrupted playback (such as the user calling ALmixer_Halt*).
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	808 * @param user_data This will be passed back to you in the callback.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	809 *
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	810 * @warning You should not call other ALmixer functions in this callback.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	811 * Particularly in the case of when compiled with threads, recursive locking
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	812 * will occur which will lead to deadlocks. Also be aware that particularly in the
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	813 * threaded case, the callbacks may (and currently do) occur on a background thread.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	814 * One typical thread safe strategy is to set flags or schedule events to occur on the
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	815 * main thread.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	816 * One possible exception to the no-calling ALmixer functions rule is ALmixer_Free. ALmixer_Free
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	817 * currently does not lock so it might okay to call this to free your data. However, this is not
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	818 * tested and not the expected pattern to be used.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	819 */
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	820 extern ALMIXER_DECLSPEC void ALMIXER_CALL ALmixer_SetPlaybackFinishedCallback(void (playback_finished_callback)(ALint which_channel, ALuint al_source, ALmixer_Data almixer_data, ALboolean finished_naturally, void* user_data), void* user_data);
1 a8a8fe374984 Subversion era Eric Wing <ewing . public \|-at-\| gmail . com> parents: 0 diff changeset	821
a8a8fe374984 Subversion era Eric Wing <ewing . public \|-at-\| gmail . com> parents: 0 diff changeset	822 /**
2 279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	823 * Allows you to set a callback for getting audio data.
1 a8a8fe374984 Subversion era Eric Wing <ewing . public \|-at-\| gmail . com> parents: 0 diff changeset	824 * This is a callback function pointer that when set, will trigger a function
a8a8fe374984 Subversion era Eric Wing <ewing . public \|-at-\| gmail . com> parents: 0 diff changeset	825 * anytime there is new data loaded for a sample. The appropriate load
a8a8fe374984 Subversion era Eric Wing <ewing . public \|-at-\| gmail . com> parents: 0 diff changeset	826 * parameter must be set in order for a sample to appear here.
a8a8fe374984 Subversion era Eric Wing <ewing . public \|-at-\| gmail . com> parents: 0 diff changeset	827 * Keep in mind the the current backend implementation must do an end run
a8a8fe374984 Subversion era Eric Wing <ewing . public \|-at-\| gmail . com> parents: 0 diff changeset	828 * around OpenAL because OpenAL lacks support for this kind of thing.
a8a8fe374984 Subversion era Eric Wing <ewing . public \|-at-\| gmail . com> parents: 0 diff changeset	829 * As such, buffers are copied at decode time, and there is no attempt to do
a8a8fe374984 Subversion era Eric Wing <ewing . public \|-at-\| gmail . com> parents: 0 diff changeset	830 * fine grained timing syncronization. You will be provided the entire buffer
a8a8fe374984 Subversion era Eric Wing <ewing . public \|-at-\| gmail . com> parents: 0 diff changeset	831 * that is decoded regardless of length. So if you predecoded the entire
a8a8fe374984 Subversion era Eric Wing <ewing . public \|-at-\| gmail . com> parents: 0 diff changeset	832 * audio file, the entire data buffer will be provided in a single callback.
a8a8fe374984 Subversion era Eric Wing <ewing . public \|-at-\| gmail . com> parents: 0 diff changeset	833 * If you stream the data, you will be getting chunk sizes that are the same as
a8a8fe374984 Subversion era Eric Wing <ewing . public \|-at-\| gmail . com> parents: 0 diff changeset	834 * what you specified the decode size to be. Unfortunely, this means if you
a8a8fe374984 Subversion era Eric Wing <ewing . public \|-at-\| gmail . com> parents: 0 diff changeset	835 * pick smaller buffers, you get finer detail at the expense/risk of buffer
a8a8fe374984 Subversion era Eric Wing <ewing . public \|-at-\| gmail . com> parents: 0 diff changeset	836 * underruns. If you decode more data, you have to deal with the syncronization
a8a8fe374984 Subversion era Eric Wing <ewing . public \|-at-\| gmail . com> parents: 0 diff changeset	837 * issues if you want to display the data during playback in something like an
a8a8fe374984 Subversion era Eric Wing <ewing . public \|-at-\| gmail . com> parents: 0 diff changeset	838 * oscilloscope.
2 279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	839 *
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	840 * @warning You should not call other ALmixer functions in this callback.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	841 * Particularly in the case of when compiled with threads, recursive locking
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	842 * will occur which will lead to deadlocks. Also be aware that particularly in the
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	843 * threaded case, the callbacks may (and currently do) occur on a background thread.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	844 * One typical thread safe strategy is to set flags or schedule events to occur on the
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	845 * main thread.
1 a8a8fe374984 Subversion era Eric Wing <ewing . public \|-at-\| gmail . com> parents: 0 diff changeset	846 *
2 279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	847 * @param playback_data_callback The function you want called back.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	848 * @param which_channel The ALmixer channel that the data is currently playing on.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	849 * @param al_source The OpenAL source that the data is currently playing on.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	850 * @param pcm_data This is a pointer to the data buffer containing ALmixer's
1 a8a8fe374984 Subversion era Eric Wing <ewing . public \|-at-\| gmail . com> parents: 0 diff changeset	851 * version of the decoded data. Consider this data as read-only. In the
a8a8fe374984 Subversion era Eric Wing <ewing . public \|-at-\| gmail . com> parents: 0 diff changeset	852 * non-threaded backend, this data will persist until potentially the next call
a8a8fe374984 Subversion era Eric Wing <ewing . public \|-at-\| gmail . com> parents: 0 diff changeset	853 * to Update(). Currently, data buffers are preallocated and not destroyed
a8a8fe374984 Subversion era Eric Wing <ewing . public \|-at-\| gmail . com> parents: 0 diff changeset	854 * until FreeData() is called (though this behavior is subject to change),
a8a8fe374984 Subversion era Eric Wing <ewing . public \|-at-\| gmail . com> parents: 0 diff changeset	855 * but the contents will change when the buffer needs to be reused for a
a8a8fe374984 Subversion era Eric Wing <ewing . public \|-at-\| gmail . com> parents: 0 diff changeset	856 * future callback. The buffer reuse is tied to the amount of buffers that
a8a8fe374984 Subversion era Eric Wing <ewing . public \|-at-\| gmail . com> parents: 0 diff changeset	857 * may be queued.
a8a8fe374984 Subversion era Eric Wing <ewing . public \|-at-\| gmail . com> parents: 0 diff changeset	858 * But assuming I don't change this, this may allow for some optimization
a8a8fe374984 Subversion era Eric Wing <ewing . public \|-at-\| gmail . com> parents: 0 diff changeset	859 * so you can try referencing data from these buffers without worrying
a8a8fe374984 Subversion era Eric Wing <ewing . public \|-at-\| gmail . com> parents: 0 diff changeset	860 * about crashing. (You still need to be aware that the data could be
a8a8fe374984 Subversion era Eric Wing <ewing . public \|-at-\| gmail . com> parents: 0 diff changeset	861 * modified behind the scenes on an Update().)
2 279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	862 * The data type listed is an signed 8-bit format, but the real data may
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	863 * not actually be this. ALbyte was chosen as a convenience. If you have
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	864 * a 16 bit format, you will want to cast the data and divide the num_bytes by 2.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	865 * Typically, data is either Sint16. This seems to be a
1 a8a8fe374984 Subversion era Eric Wing <ewing . public \|-at-\| gmail . com> parents: 0 diff changeset	866 * convention audio people seem to follow though I'm not sure what the
a8a8fe374984 Subversion era Eric Wing <ewing . public \|-at-\| gmail . com> parents: 0 diff changeset	867 * underlying reasons (if any) are for this. I suspect that there may be
2 279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	868 * some nice alignment/conversion property if you need to cast between ALbyte
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	869 * and ALubyte.
1 a8a8fe374984 Subversion era Eric Wing <ewing . public \|-at-\| gmail . com> parents: 0 diff changeset	870 *
a8a8fe374984 Subversion era Eric Wing <ewing . public \|-at-\| gmail . com> parents: 0 diff changeset	871 * @param num_bytes This is the total length of the data buffer. It presumes
2 279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	872 * that this length is measured for ALbyte. So if you have Sint16 data, you
1 a8a8fe374984 Subversion era Eric Wing <ewing . public \|-at-\| gmail . com> parents: 0 diff changeset	873 * should divide num_bytes by two if you access the data as Sint16.
a8a8fe374984 Subversion era Eric Wing <ewing . public \|-at-\| gmail . com> parents: 0 diff changeset	874 *
a8a8fe374984 Subversion era Eric Wing <ewing . public \|-at-\| gmail . com> parents: 0 diff changeset	875 * @param frequency The frequency the data was decoded at.
a8a8fe374984 Subversion era Eric Wing <ewing . public \|-at-\| gmail . com> parents: 0 diff changeset	876 *
2 279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	877 * @param num_channels_in_sample 1 for mono, 2 for stereo. Not to be confused with the ALmixer which_channel.
1 a8a8fe374984 Subversion era Eric Wing <ewing . public \|-at-\| gmail . com> parents: 0 diff changeset	878 *
a8a8fe374984 Subversion era Eric Wing <ewing . public \|-at-\| gmail . com> parents: 0 diff changeset	879 * @param bit_depth Bits per sample. This is expected to be 8 or 16. This
a8a8fe374984 Subversion era Eric Wing <ewing . public \|-at-\| gmail . com> parents: 0 diff changeset	880 * number will tell you if you if you need to treat the data buffer as
a8a8fe374984 Subversion era Eric Wing <ewing . public \|-at-\| gmail . com> parents: 0 diff changeset	881 * 16 bit or not.
a8a8fe374984 Subversion era Eric Wing <ewing . public \|-at-\| gmail . com> parents: 0 diff changeset	882 *
a8a8fe374984 Subversion era Eric Wing <ewing . public \|-at-\| gmail . com> parents: 0 diff changeset	883 * @param is_unsigned 1 if the data is unsigned, 0 if signed. Using this
a8a8fe374984 Subversion era Eric Wing <ewing . public \|-at-\| gmail . com> parents: 0 diff changeset	884 * combined with bit_depth will tell you if you need to treat the data
2 279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	885 * as ALubyte, ALbyte, ALuint, or ALint.
1 a8a8fe374984 Subversion era Eric Wing <ewing . public \|-at-\| gmail . com> parents: 0 diff changeset	886 *
a8a8fe374984 Subversion era Eric Wing <ewing . public \|-at-\| gmail . com> parents: 0 diff changeset	887 * @param decode_mode_is_predecoded This is here to tell you if the data was totally
a8a8fe374984 Subversion era Eric Wing <ewing . public \|-at-\| gmail . com> parents: 0 diff changeset	888 * predecoded or loaded as a stream. If predecoded, you will only get
a8a8fe374984 Subversion era Eric Wing <ewing . public \|-at-\| gmail . com> parents: 0 diff changeset	889 * one data callback per playback instance. (This might also be true for
a8a8fe374984 Subversion era Eric Wing <ewing . public \|-at-\| gmail . com> parents: 0 diff changeset	890 * looping the same sample...I don't remember how it was implemented.
a8a8fe374984 Subversion era Eric Wing <ewing . public \|-at-\| gmail . com> parents: 0 diff changeset	891 * Maybe this should be fixed.)
a8a8fe374984 Subversion era Eric Wing <ewing . public \|-at-\| gmail . com> parents: 0 diff changeset	892 * 0 (ALMIXER_DECODE_STREAM) for streamed.
a8a8fe374984 Subversion era Eric Wing <ewing . public \|-at-\| gmail . com> parents: 0 diff changeset	893 * 1 (ALMIXER_DECODE_ALL) for predecoded.
a8a8fe374984 Subversion era Eric Wing <ewing . public \|-at-\| gmail . com> parents: 0 diff changeset	894 *
a8a8fe374984 Subversion era Eric Wing <ewing . public \|-at-\| gmail . com> parents: 0 diff changeset	895 * @param length_in_msec This returns the total length (time) of the data
a8a8fe374984 Subversion era Eric Wing <ewing . public \|-at-\| gmail . com> parents: 0 diff changeset	896 * buffer in milliseconds. This could be computed yourself, but is provided
a8a8fe374984 Subversion era Eric Wing <ewing . public \|-at-\| gmail . com> parents: 0 diff changeset	897 * as a convenince.
a8a8fe374984 Subversion era Eric Wing <ewing . public \|-at-\| gmail . com> parents: 0 diff changeset	898 *
2 279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	899 * @param user_data The user data you pass in will be passed back to you in the callback.
1 a8a8fe374984 Subversion era Eric Wing <ewing . public \|-at-\| gmail . com> parents: 0 diff changeset	900 */
2 279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	901 extern ALMIXER_DECLSPEC void ALMIXER_CALL ALmixer_SetPlaybackDataCallback(void (playback_data_callback)(ALint which_channel, ALuint al_source, ALbyte pcm_data, ALuint num_bytes, ALuint frequency, ALubyte num_channels_in_sample, ALubyte bit_depth, ALboolean is_unsigned, ALboolean decode_mode_is_predecoded, ALuint length_in_msec, void* user_data), void* user_data);
0 01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	902
2 279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	903 /**
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	904 * @}
0 01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	905 */
2 279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	906
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	907 /**
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	908 * @defgroup PlayAPI Functions useful for playback.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	909 * @{
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	910 * These are core functions that are useful for controlling playback.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	911 * Also see the Volume functions for additional playback functions and Query functions for additional information.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	912 */
0 01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	913
2 279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	914 /**
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	915 * Returns the total time in milliseconds of the audio resource.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	916 * Returns the total time in milliseconds of the audio resource.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	917 * If the total length cannot be determined, -1 will be returned.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	918 * @param almixer_data The audio sample you want to know the total time of.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	919 * @return The total time in milliseconds or -1 if some kind of failure.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	920 */
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	921 extern ALMIXER_DECLSPEC ALint ALMIXER_CALL ALmixer_GetTotalTime(ALmixer_Data* almixer_data);
0 01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	922
2 279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	923 /**
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	924 * This function will look up the OpenAL source id for the corresponding channel number.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	925 * @param which_channel The channel which you want to find the corresponding OpenAL source id for.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	926 * If -1 was specified, an available source for playback will be returned.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	927 * @return The OpenAL source id corresponding to the channel. 0 if you specified an illegal channel value.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	928 * Or 0 if you specified -1 and no sources were currently available.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	929 * @note ALmixer assumes your OpenAL implementation does not use 0 as a valid source ID. While the OpenAL spec
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	930 * does not disallow 0 for valid source ids, as of now, there are no known OpenAL implementations in use that
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	931 * use 0 as a valid source id (partly due to problems this has caused developers in the past).
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	932 */
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	933 extern ALMIXER_DECLSPEC ALuint ALMIXER_CALL ALmixer_GetSource(ALint which_channel);
0 01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	934
2 279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	935 /**
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	936 * This function will look up the channel for the corresponding source.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	937 * @param al_source The source id you want to find the corresponding channel number for.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	938 * If -1 is supplied, it will try to return the first channel not in use.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	939 * Returns -1 on error, or the channel.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	940 */
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	941 extern ALMIXER_DECLSPEC ALint ALMIXER_CALL ALmixer_GetChannel(ALuint al_source);
0 01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	942
2 279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	943 /**
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	944 * Will look for a channel available for playback.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	945 * Given a start channel number, the search will increase to the highest channel until it finds one available.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	946 * @param start_channel The channel number you want to start looking at.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	947 * @return A channel available or -1 if none could be found.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	948 */
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	949 extern ALMIXER_DECLSPEC ALint ALMIXER_CALL ALmixer_FindFreeChannel(ALint start_channel);
1 a8a8fe374984 Subversion era Eric Wing <ewing . public \|-at-\| gmail . com> parents: 0 diff changeset	950
0 01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	951
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	952
2 279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	953 /**
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	954 * Play a sound on a channel with a time limit.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	955 * Plays a sound on a channel and will auto-stop after a specified number of milliseconds.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	956 * @param which_channel Allows you to specify the specific channel you want to play on.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	957 * Channels range from 0 to the (Number of allocated channels - 1). If you specify -1,
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	958 * an available channel will be chosen automatically for you.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	959 * @note While paused, the auto-stop clock will also be paused. This makes it easy to always stop
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	960 * a sample by a predesignated length without worrying about whether the user paused playback which would
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	961 * throw off your calculations.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	962 * @param almixer_data The audio resource you want to play.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	963 * @param number_of_loops The number of times to loop (repeat) playing the data.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	964 * 0 means the data will play exactly once without repeat. -1 means infinitely loop.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	965 * @param number_of_milliseconds The number of milliseconds that should be played until the sample is auto-stopped.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	966 * -1 means don't auto-stop playing and let the sample finish playing normally (or if looping is set to infinite,
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	967 * the sample will never stop playing).
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	968 * @return Returns the channel that was selected for playback or -1 if no channels were available.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	969 */
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	970 extern ALMIXER_DECLSPEC ALint ALMIXER_CALL ALmixer_PlayChannelTimed(ALint which_channel, ALmixer_Data* almixer_data, ALint number_of_loops, ALint number_of_milliseconds);
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	971
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	972 #ifdef DOXYGEN_ONLY
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	973 /**
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	974 * The same as ALmixer_PlayChannelTimed, but the sound is played without time limits.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	975 * @see ALmixer_PlayChannelTimed.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	976 */
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	977 ALint ALmixer_PlayChannelTimed(ALint which_channel, ALmixer_Data* almixer_data, ALint number_of_loops);
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	978 #else
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	979 #define ALmixer_PlayChannel(channel,data,loops) ALmixer_PlayChannelTimed(channel,data,loops,-1)
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	980 #endif
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	981
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	982
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	983 /**
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	984 * Play a sound on an OpenAL source with a time limit.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	985 * Plays a sound on an OpenAL source and will auto-stop after a specified number of milliseconds.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	986 * @param al_source Allows you to specify the OpenAL source you want to play on.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	987 * If you specify 0, an available source will be chosen automatically for you.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	988 * @note Source values are not necessarily continguous and their values are implementation dependent.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	989 * Always use ALmixer functions to determine source values.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	990 * @note While paused, the auto-stop clock will also be paused. This makes it easy to always stop
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	991 * a sample by a predesignated length without worrying about whether the user paused playback which would
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	992 * throw off your calculations.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	993 * @param almixer_data The audio resource you want to play.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	994 * @param number_of_loops The number of times to loop (repeat) playing the data.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	995 * 0 means the data will play exactly once without repeat. -1 means infinitely loop.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	996 * @param number_of_milliseconds The number of milliseconds that should be played until the sample is auto-stopped.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	997 * -1 means don't auto-stop playing and let the sample finish playing normally (or if looping is set to infinite,
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	998 * the sample will never stop playing).
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	999 * @return Returns the OpenAL source that was selected for playback or 0 if no sources were available.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1000 */
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1001 extern ALMIXER_DECLSPEC ALuint ALMIXER_CALL ALmixer_PlaySourceTimed(ALuint al_source, ALmixer_Data* almixer_data, ALint number_of_loops, ALint number_of_milliseconds);
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1002
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1003 #ifdef DOXYGEN_ONLY
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1004 /**
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1005 * The same as ALmixer_PlaySourceTimed, but the sound is played without time limits.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1006 * @see ALmixer_PlaySourceTimed.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1007 */
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1008 ALint ALmixer_PlayChannelTimed(ALuint al_source, ALmixer_Data* almixer_data, ALint number_of_loops);
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1009 #else
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1010 #define ALmixer_PlaySource(al_source, almixer_data, number_of_loops) ALmixer_PlaySourceTimed(al_source, almixer_data, number_of_loops, -1)
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1011 #endif
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1012
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1013 /**
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1014 * Stops playback on a channel.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1015 * Stops playback on a channel and clears the channel so it can be played on again.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1016 * @note Callbacks will still be invoked, but the finished_naturally flag will be set to AL_FALSE.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1017 * @param which_channel The channel to halt or -1 to halt all channels.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1018 * @return The actual number of channels halted on success or -1 on error.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1019 */
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1020 extern ALMIXER_DECLSPEC ALint ALMIXER_CALL ALmixer_HaltChannel(ALint which_channel);
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1021
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1022 /**
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1023 * Stops playback on a channel.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1024 * Stops playback on a channel and clears the channel so it can be played on again.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1025 * @note Callbacks will still be invoked, but the finished_naturally flag will be set to AL_FALSE.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1026 * @param al_source The source to halt or 0 to halt all sources.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1027 * @return The actual number of sources halted on success or -1 on error.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1028 */
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1029 extern ALMIXER_DECLSPEC ALint ALMIXER_CALL ALmixer_HaltSource(ALuint al_source);
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1030
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1031 /**
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1032 * Rewinds the sound to the beginning for a given data.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1033 * Rewinds the actual data, but the effect
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1034 * may not be noticed until the currently buffered data is played.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1035 * @param almixer_data The data to rewind.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1036 * @returns 0 on success or -1 on error.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1037 */
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1038 extern ALMIXER_DECLSPEC ALint ALMIXER_CALL ALmixer_RewindData(ALmixer_Data* almixer_data);
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1039
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1040 /**
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1041 * Rewinds the sound to the beginning that is playing on a specific channel.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1042 * If decoded all, rewind will instantly rewind it. Data is not
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1043 * affected, so it will start at the "Seek"'ed positiond.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1044 * Streamed data will rewind the actual data, but the effect
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1045 * may not be noticed until the currently buffered data is played.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1046 * @param which_channel The channel to rewind or -1 to rewind all channels.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1047 * @returns 0 on success or -1 on error.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1048 */
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1049 extern ALMIXER_DECLSPEC ALint ALMIXER_CALL ALmixer_RewindChannel(ALint which_channel);
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1050 /**
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1051 * Rewinds the sound to the beginning that is playing on a specific source.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1052 * If decoded all, rewind will instantly rewind it. Data is not
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1053 * affected, so it will start at the "Seek"'ed positiond.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1054 * Streamed data will rewind the actual data, but the effect
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1055 * may not be noticed until the currently buffered data is played.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1056 * @param al_source The source to rewind or 0 to rewind all sources.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1057 * @returns 1 on success or 0 on error.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1058 */
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1059 extern ALMIXER_DECLSPEC ALint ALMIXER_CALL ALmixer_RewindSource(ALuint al_source);
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1060
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1061 /**
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1062 * Seek the sound for a given data.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1063 * Seeks the actual data to the given millisecond. It
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1064 * may not be noticed until the currently buffered data is played.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1065 * @param almixer_data
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1066 * @param msec_pos The time position to seek to in the audio in milliseconds.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1067 * @returns 0 on success or -1 on error.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1068 */
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1069 extern ALMIXER_DECLSPEC ALint ALMIXER_CALL ALmixer_SeekData(ALmixer_Data* almixer_data, ALuint msec_pos);
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1070
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1071 /**
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1072 * Pauses playback on a channel.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1073 * Pauses playback on a channel. Should have no effect on channels that aren't playing.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1074 * @param which_channel The channel to pause or -1 to pause all channels.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1075 * @return The actual number of channels paused on success or -1 on error.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1076 */
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1077 extern ALMIXER_DECLSPEC ALint ALMIXER_CALL ALmixer_PauseChannel(ALint which_channel);
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1078 /**
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1079 * Pauses playback on a source.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1080 * Pauses playback on a source. Should have no effect on source that aren't playing.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1081 * @param al_source The source to pause or -1 to pause all source.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1082 * @return The actual number of source paused on success or -1 on error.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1083 */
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1084 extern ALMIXER_DECLSPEC ALint ALMIXER_CALL ALmixer_PauseSource(ALuint al_source);
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1085
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1086 /**
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1087 * Resumes playback on a channel that is paused.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1088 * Resumes playback on a channel that is paused. Should have no effect on channels that aren't paused.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1089 * @param which_channel The channel to resume or -1 to resume all channels.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1090 * @return The actual number of channels resumed on success or -1 on error.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1091 */
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1092 extern ALMIXER_DECLSPEC ALint ALMIXER_CALL ALmixer_ResumeChannel(ALint which_channel);
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1093
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1094 /**
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1095 * Resumes playback on a source that is paused.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1096 * Resumes playback on a source that is paused. Should have no effect on sources that aren't paused.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1097 * @param al_source The source to resume or -1 to resume all sources.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1098 * @return The actual number of sources resumed on success or -1 on error.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1099 */
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1100 extern ALMIXER_DECLSPEC ALint ALMIXER_CALL ALmixer_ResumeSource(ALuint al_source);
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1101
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1102
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1103 /**
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1104 * Will cause a currently playing channel to stop playing in the specified number of milliseconds.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1105 * Will cause a currently playing channel to stop playing in the specified number of milliseconds.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1106 * This will override the value that was set when PlayChannelTimed or PlaySourceTimed was called
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1107 * or override any previous calls to ExpireChannel or ExpireSource.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1108 * @param which_channel The channel to expire or -1 to apply to all channels.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1109 * @param number_of_milliseconds How many milliseconds from now until the expire triggers.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1110 * @return The actual number of channels this action is applied to on success or -1 on error.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1111 */
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1112 extern ALMIXER_DECLSPEC ALint ALMIXER_CALL ALmixer_ExpireChannel(ALint which_channel, ALint number_of_milliseconds);
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1113 /**
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1114 * Will cause a currently playing source to stop playing in the specified number of milliseconds.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1115 * Will cause a currently playing source to stop playing in the specified number of milliseconds.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1116 * This will override the value that was set when PlayChannelTimed or PlaySourceTimed was called
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1117 * or override any previous calls to ExpireChannel or ExpireSource.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1118 * @param al_source The source to expire or 0 to apply to all sources.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1119 * @param number_of_milliseconds How many milliseconds from now until the expire triggers.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1120 * @return The actual number of sources this action is applied to on success or -1 on error.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1121 */
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1122 extern ALMIXER_DECLSPEC ALint ALMIXER_CALL ALmixer_ExpireSource(ALuint al_source, ALint number_of_milliseconds);
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1123
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1124 /**
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1125 * @}
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1126 */
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1127
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1128 /**
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1129 * @defgroup VolumeAPI Volume and Fading
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1130 * @{
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1131 * Fade and volume functions directly call OpenAL functions related to AL_GAIN.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1132 * These functions are provided mostly for those who just want to play audio but are not planning
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1133 * to use OpenAL features directly.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1134 * If you are using OpenAL directly (e.g. for 3D effects), you may want to be careful about using these as
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1135 * they may fight/override values you directly set yourself.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1136 */
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1137
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1138 /**
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1139 * Similar to ALmixer_PlayChannelTimed except that sound volume fades in from the minimum volume to the current AL_GAIN over the specified amount of time.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1140 * @see ALmixer_PlayChannelTimed.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1141 */
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1142 extern ALMIXER_DECLSPEC ALint ALMIXER_CALL ALmixer_FadeInChannelTimed(ALint which_channel, ALmixer_Data* almixer_data, ALint number_of_loops, ALuint fade_ticks, ALint expire_ticks);
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1143
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1144 #ifdef DOXYGEN_ONLY
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1145 /**
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1146 * The same as ALmixer_FadeInChannelTimed, but the sound is played without time limits.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1147 * @see ALmixer_FadeInChannelTimed, ALmixer_PlayChannel.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1148 */
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1149 ALint ALmixer_FadeInChannel(ALint which_channel, ALmixer_Data* almixer_data, ALint number_of_loops, ALuint fade_ticks);
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1150 #else
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1151 #define ALmixer_FadeInChannel(which_channel, almixer_data, number_of_loops, fade_ticks) ALmixer_FadeInChannelTimed(which_channel, almixer_data, number_of_loops, fade_ticks, -1)
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1152 #endif
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1153
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1154 /**
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1155 * Similar to ALmixer_PlaySourceTimed except that sound volume fades in from the minimum volume to the max volume over the specified amount of time.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1156 * @see ALmixer_PlaySourceTimed.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1157 */
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1158 extern ALMIXER_DECLSPEC ALuint ALMIXER_CALL ALmixer_FadeInSourceTimed(ALuint al_source, ALmixer_Data* almixer_data, ALint number_of_loops, ALuint fade_ticks, ALint expire_ticks);
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1159
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1160 #ifdef DOXYGEN_ONLY
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1161 /**
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1162 * The same as ALmixer_FadeInSourceTimed, but the sound is played without time limits.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1163 * @see ALmixer_FadeInSourceTimed, ALmixer_PlaySource.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1164 */
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1165 extern ALuint ALmixer_FadeInSource(ALuint al_source, ALmixer_Data* almixer_data, ALint number_of_loops, ALuint fade_ticks);
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1166 #else
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1167 #define ALmixer_FadeInSource(al_source, almixer_data, number_of_loops, fade_ticks) ALmixer_FadeInSourceTimed(al_source, almixer_data, number_of_loops, fade_ticks, -1)
0 01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	1168 #endif
2 279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1169
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1170 /**
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1171 * Fade out a current playing channel.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1172 * Will fade out a currently playing channel over the specified period of time starting from now.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1173 * The volume will be changed from the current AL_GAIN level to the AL_MIN_GAIN.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1174 * The volume fade will interpolate over the specified period of time.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1175 * The playback will halt at the end of the time period.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1176 * @param which_channel The channel to fade or -1 to fade all playing channels.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1177 * @param fade_ticks In milliseconds, the amount of time the fade out should take to complete.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1178 * @return Returns -1 on error or the number of channels faded.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1179 */
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1180 extern ALMIXER_DECLSPEC ALint ALMIXER_CALL ALmixer_FadeOutChannel(ALint which_channel, ALuint fade_ticks);
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1181
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1182 /**
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1183 * Fade out a current playing source.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1184 * Will fade out a currently playing source over the specified period of time starting from now.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1185 * The volume will be changed from the current AL_GAIN level to the AL_MIN_GAIN.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1186 * The volume fade will interpolate over the specified period of time.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1187 * The playback will halt at the end of the time period.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1188 * @param al_source The source to fade or -1 to fade all playing sources.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1189 * @param fade_ticks In milliseconds, the amount of time the fade out should take to complete.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1190 * @return Returns -1 on error or the number of sources faded.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1191 */
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1192 extern ALMIXER_DECLSPEC ALint ALMIXER_CALL ALmixer_FadeOutSource(ALuint al_source, ALuint fade_ticks);
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1193
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1194 /**
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1195 * Gradually changes the volume from the current AL_GAIN to the specified volume.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1196 * Gradually changes the volume from the current AL_GAIN to the specified volume over the specified period of time.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1197 * This is some times referred to as volume ducking.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1198 * Note that this function works for setting the volume higher as well as lower.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1199 * @param which_channel The channel to fade or -1 to fade all playing channels.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1200 * @param fade_ticks In milliseconds, the amount of time the volume change should take to complete.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1201 * @param volume The volume to change to. Valid values are 0.0 to 1.0.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1202 * @return Returns -1 on error or the number of channels faded.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1203 */
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1204 extern ALMIXER_DECLSPEC ALint ALMIXER_CALL ALmixer_FadeChannel(ALint which_channel, ALuint fade_ticks, ALfloat volume);
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1205
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1206 /**
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1207 * Gradually changes the volume from the current AL_GAIN to the specified volume.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1208 * Gradually changes the volume from the current AL_GAIN to the specified volume over the specified period of time.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1209 * This is some times referred to as volume ducking.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1210 * Note that this function works for setting the volume higher as well as lower.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1211 * @param al_source The source to fade or -1 to fade all playing sources.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1212 * @param fade_ticks In milliseconds, the amount of time the volume change should take to complete.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1213 * @param volume The volume to change to. Valid values are 0.0 to 1.0.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1214 * @return Returns -1 on error or the number of sources faded.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1215 */
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1216 extern ALMIXER_DECLSPEC ALint ALMIXER_CALL ALmixer_FadeSource(ALuint al_source, ALuint fade_ticks, ALfloat volume);
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1217
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1218 /**
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1219 * Sets the volume via the AL_GAIN source property.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1220 * Sets the volume for a given channel via the AL_GAIN source property.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1221 * @param which_channel The channel to set the volume to or -1 to set on all channels.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1222 * @param volume The new volume to use. Valid values are 0.0 to 1.0.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1223 * @return AL_TRUE on success or AL_FALSE on error.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1224 */
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1225 extern ALMIXER_DECLSPEC ALboolean ALMIXER_CALL ALmixer_SetVolumeChannel(ALint which_channel, ALfloat volume);
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1226
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1227 /**
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1228 * Sets the volume via the AL_GAIN source property.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1229 * Sets the volume for a given source via the AL_GAIN source property.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1230 * @param al_source The source to set the volume to or 0 to set on all sources.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1231 * @param volume The new volume to use. Valid values are 0.0 to 1.0.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1232 * @return AL_TRUE on success or AL_FALSE on error.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1233 */
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1234 extern ALMIXER_DECLSPEC ALboolean ALMIXER_CALL ALmixer_SetVolumeSource(ALuint al_source, ALfloat volume);
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1235
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1236 /**
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1237 * Gets the volume via the AL_GAIN source property.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1238 * Gets the volume for a given channel via the AL_GAIN source property.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1239 * @param which_channel The channel to get the volume from.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1240 * -1 will return the average volume set across all channels.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1241 * @return Returns the volume for the specified channel, or the average set volume for all channels, or -1.0 on error.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1242 */
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1243 extern ALMIXER_DECLSPEC ALfloat ALMIXER_CALL ALmixer_GetVolumeChannel(ALint which_channel);
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1244
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1245 /**
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1246 * Gets the volume via the AL_GAIN source property.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1247 * Gets the volume for a given source via the AL_GAIN source property.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1248 * @param al_source The source to get the volume from.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1249 * -1 will return the average volume set across all source.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1250 * @return Returns the volume for the specified source, or the average set volume for all sources, or -1.0 on error.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1251 */
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1252 extern ALMIXER_DECLSPEC ALfloat ALMIXER_CALL ALmixer_GetVolumeSource(ALuint al_source);
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1253
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1254 /**
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1255 * Sets the maximum volume via the AL_MAX_GAIN source property.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1256 * Sets the maximum volume for a given channel via the AL_MAX_GAIN source property.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1257 * Max volumes will be clamped to this value.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1258 * @param which_channel The channel to set the volume to or -1 to set on all channels.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1259 * @param volume The new volume to use. Valid values are 0.0 to 1.0.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1260 * @return AL_TRUE on success or AL_FALSE on error.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1261 */
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1262 extern ALMIXER_DECLSPEC ALboolean ALMIXER_CALL ALmixer_SetMaxVolumeChannel(ALint which_channel, ALfloat volume);
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1263
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1264 /**
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1265 * Sets the maximum volume via the AL_MAX_GAIN source property.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1266 * Sets the maximum volume for a given source via the AL_MAX_GAIN source property.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1267 * @param al_source The source to set the volume to or 0 to set on all sources.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1268 * @param volume The new volume to use. Valid values are 0.0 to 1.0.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1269 * @return AL_TRUE on success or AL_FALSE on error.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1270 */
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1271 extern ALMIXER_DECLSPEC ALboolean ALMIXER_CALL ALmixer_SetMaxVolumeSource(ALuint al_source, ALfloat volume);
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1272
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1273 /**
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1274 * Gets the max volume via the AL_MAX_GAIN source property.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1275 * Gets the max volume for a given channel via the AL_MAX_GAIN source property.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1276 * @param which_channel The channel to get the volume from.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1277 * -1 will return the average volume set across all channels.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1278 * @return Returns the volume for the specified channel, or the average set volume for all channels, or -1.0 on error.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1279 */
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1280 extern ALMIXER_DECLSPEC ALfloat ALMIXER_CALL ALmixer_GetMaxVolumeChannel(ALint which_channel);
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1281
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1282 /**
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1283 * Gets the maximum volume via the AL_MAX_GAIN source property.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1284 * Gets the maximum volume for a given source via the AL_MAX_GAIN source property.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1285 * @param al_source The source to set the volume to or 0 to set on all sources.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1286 * 0 will return the average volume set across all channels.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1287 * @return Returns the volume for the specified channel, or the average set volume for all channels, or -1.0 on error.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1288 */
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1289 extern ALMIXER_DECLSPEC ALfloat ALMIXER_CALL ALmixer_GetMaxVolumeSource(ALuint al_source);
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1290
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1291 /**
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1292 * Sets the minimum volume via the AL_MIN_GAIN source property.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1293 * Sets the minimum volume for a given channel via the AL_MIN_GAIN source property.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1294 * Min volumes will be clamped to this value.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1295 * @param which_channel The channel to set the volume to or -1 to set on all channels.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1296 * @param volume The new volume to use. Valid values are 0.0 to 1.0.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1297 * @return AL_TRUE on success or AL_FALSE on error.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1298 */
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1299 extern ALMIXER_DECLSPEC ALboolean ALMIXER_CALL ALmixer_SetMinVolumeChannel(ALint which_channel, ALfloat volume);
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1300
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1301 /**
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1302 * Sets the minimum volume via the AL_MIN_GAIN source property.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1303 * Sets the minimum volume for a given source via the AL_MIN_GAIN source property.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1304 * @param al_source The source to set the volume to or 0 to set on all sources.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1305 * @param volume The new volume to use. Valid values are 0.0 to 1.0.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1306 * @return AL_TRUE on success or AL_FALSE on error.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1307 */
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1308 extern ALMIXER_DECLSPEC ALboolean ALMIXER_CALL ALmixer_SetMinVolumeSource(ALuint al_source, ALfloat volume);
0 01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	1309
2 279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1310 /**
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1311 * Gets the min volume via the AL_MIN_GAIN source property.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1312 * Gets the min volume for a given channel via the AL_MIN_GAIN source property.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1313 * @param which_channel The channel to get the volume from.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1314 * -1 will return the average volume set across all channels.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1315 * @return Returns the volume for the specified channel, or the average set volume for all channels, or -1.0 on error.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1316 */
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1317 extern ALMIXER_DECLSPEC ALfloat ALMIXER_CALL ALmixer_GetMinVolumeChannel(ALint which_channel);
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1318
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1319 /**
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1320 * Gets the min volume via the AL_MIN_GAIN source property.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1321 * Gets the min volume for a given source via the AL_MIN_GAIN source property.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1322 * @param al_source The source to set the volume to or 0 to set on all sources.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1323 * 0 will return the average volume set across all channels.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1324 * @return Returns the volume for the specified channel, or the average set volume for all channels, or -1.0 on error.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1325 */
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1326 extern ALMIXER_DECLSPEC ALfloat ALMIXER_CALL ALmixer_GetMinVolumeSource(ALuint al_source);
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1327
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1328 /**
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1329 * Sets the OpenAL listener AL_GAIN which can be thought of as the "master volume".
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1330 * Sets the OpenAL listener AL_GAIN which can be thought of as the "master volume".
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1331 * @param new_volume The new volume level to be set. Range is 0.0 to 1.0 where 1.0 is the max volume.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1332 * @return AL_TRUE on success or AL_FALSE on an error.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1333 */
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1334 extern ALMIXER_DECLSPEC ALboolean ALMIXER_CALL ALmixer_SetMasterVolume(ALfloat new_volume);
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1335
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1336 /**
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1337 * Gets the OpenAL listener AL_GAIN which can be thought of as the "master volume".
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1338 * Gets the OpenAL listener AL_GAIN which can be thought of as the "master volume".
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1339 * @return The current volume level on the listener. -1.0 will be returned on an error.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1340 */
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1341 extern ALMIXER_DECLSPEC ALfloat ALMIXER_CALL ALmixer_GetMasterVolume(void);
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1342
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1343 /**
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1344 * @}
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1345 */
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1346
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1347 /**
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1348 * @defgroup QueryAPI Query APIs
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1349 * @{
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1350 * Functions to query ALmixer.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1351 */
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1352
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1353
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1354 /**
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1355 * Returns true if the specified channel is currently playing or paused,
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1356 * or if -1 is passed the number of channels that are currently playing or paused.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1357 * @param which_channel The channel you want to know about or -1 to get the count of
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1358 * currently playing/paused channels.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1359 * @return For a specific channel, 1 if the channel is playing or paused, 0 if not.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1360 * Or returns the count of currently playing/paused channels.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1361 * Or -1 on an error.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1362 */
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1363 extern ALMIXER_DECLSPEC ALint ALMIXER_CALL ALmixer_IsActiveChannel(ALint which_channel);
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1364
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1365 /**
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1366 * Returns true if the specified source is currently playing or paused,
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1367 * or if -1 is passed the number of sources that are currently playing or paused.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1368 * @param al_source The channel you want to know about or -1 to get the count of
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1369 * currently playing/paused sources.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1370 * @return For a specific sources, 1 if the channel is playing or paused, 0 if not.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1371 * Or returns the count of currently playing/paused sources.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1372 * Or -1 on an error.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1373 */
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1374 extern ALMIXER_DECLSPEC ALint ALMIXER_CALL ALmixer_IsActiveSource(ALuint al_source);
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1375
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1376 /**
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1377 * Returns true if the specified channel is currently playing.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1378 * or if -1 is passed the number of channels that are currently playing.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1379 * @param which_channel The channel you want to know about or -1 to get the count of
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1380 * currently playing channels.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1381 * @return For a specific channel, 1 if the channel is playing, 0 if not.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1382 * Or returns the count of currently playing channels.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1383 * Or -1 on an error.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1384 */
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1385 extern ALMIXER_DECLSPEC ALint ALMIXER_CALL ALmixer_IsPlayingChannel(ALint which_channel);
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1386
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1387 /**
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1388 * Returns true if the specified sources is currently playing.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1389 * or if -1 is passed the number of sources that are currently playing.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1390 * @param al_source The sources you want to know about or -1 to get the count of
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1391 * currently playing sources.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1392 * @return For a specific source, 1 if the source is playing, 0 if not.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1393 * Or returns the count of currently playing sources.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1394 * Or -1 on an error.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1395 */
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1396 extern ALMIXER_DECLSPEC ALint ALMIXER_CALL ALmixer_IsPlayingSource(ALuint al_source);
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1397
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1398 /**
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1399 * Returns true if the specified channel is currently paused.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1400 * or if -1 is passed the number of channels that are currently paused.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1401 * @param which_channel The channel you want to know about or -1 to get the count of
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1402 * currently paused channels.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1403 * @return For a specific channel, 1 if the channel is paused, 0 if not.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1404 * Or returns the count of currently paused channels.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1405 * Or -1 on an error.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1406 */
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1407 extern ALMIXER_DECLSPEC ALint ALMIXER_CALL ALmixer_IsPausedChannel(ALint which_channel);
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1408
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1409 /**
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1410 * Returns true if the specified sources is currently paused.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1411 * or if -1 is passed the number of sources that are currently paused.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1412 * @param al_source The source you want to know about or -1 to get the count of
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1413 * currently paused sources.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1414 * @return For a specific source, 1 if the source is paused, 0 if not.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1415 * Or returns the count of currently paused sources.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1416 * Or -1 on an error.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1417 */
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1418 extern ALMIXER_DECLSPEC ALint ALMIXER_CALL ALmixer_IsPausedSource(ALuint al_source);
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1419
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1420 /**
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1421 * Returns the number of channels that are currently available for playback (not playing, not paused).
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1422 * @return The number of channels that are currently free.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1423 */
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1424 extern ALMIXER_DECLSPEC ALuint ALMIXER_CALL ALmixer_CountAllFreeChannels(void);
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1425
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1426 /**
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1427 * Returns the number of channels that are currently available for playback (not playing, not paused),
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1428 * excluding the channels that have been reserved.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1429 * @return The number of channels that are currently in free, excluding the channels that have been reserved.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1430 * @see ALmixer_ReserveChannels
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1431 */
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1432 extern ALMIXER_DECLSPEC ALuint ALMIXER_CALL ALmixer_CountUnreservedFreeChannels(void);
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1433
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1434 /**
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1435 * Returns the number of channels that are currently in use (playing/paused),
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1436 * excluding the channels that have been reserved.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1437 * @return The number of channels that are currently in use.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1438 * @see ALmixer_ReserveChannels
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1439 */
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1440 extern ALMIXER_DECLSPEC ALuint ALMIXER_CALL ALmixer_CountAllUsedChannels(void);
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1441
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1442 /**
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1443 * Returns the number of channels that are currently in use (playing/paused),
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1444 * excluding the channels that have been reserved.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1445 * @return The number of channels that are currently in use excluding the channels that have been reserved.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1446 * @see ALmixer_ReserveChannels
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1447 */
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1448 extern ALMIXER_DECLSPEC ALuint ALMIXER_CALL ALmixer_CountUnreservedUsedChannels(void);
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1449
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1450
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1451 #ifdef DOXYGEN_ONLY
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1452 /**
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1453 * Returns the number of allocated channels.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1454 * This is just a convenience alias to ALmixer_AllocateChannels(-1).
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1455 * @see ALmixer_AllocateChannels
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1456 */
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1457 ALint ALmixer_CountTotalChannels(void);
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1458 #else
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1459 #define ALmixer_CountTotalChannels() ALmixer_AllocateChannels(-1)
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1460 #endif
0 01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	1461
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	1462
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	1463
2 279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1464
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1465 #ifdef DOXYGEN_ONLY
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1466 /**
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1467 * Returns the number of allocated channels.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1468 * This is just a convenience alias to ALmixer_ReserveChannels(-1).
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1469 * @see ALmixer_ReserveChannels
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1470 */
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1471 ALint ALmixer_CountReservedChannels(void);
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1472 #else
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1473 #define ALmixer_CountReservedChannels() ALmixer_ReserveChannels(-1)
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1474 #endif
0 01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	1475
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	1476
2 279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1477 /**
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1478 * @}
0 01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	1479 */
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	1480
2 279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1481 /**
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1482 * @defgroup DebugAPI Debug APIs
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1483 * @{
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1484 * Functions for debugging purposes. These may be removed in future versions.
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1485 */
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1486
0 01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	1487
2 279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1488 /* For testing */
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1489 #if 0
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1490 extern ALMIXER_DECLSPEC void ALMIXER_CALL ALmixer_OutputAttributes(void);
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1491 #endif
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1492 /** This function may be removed in the future. For debugging. Prints to stderr. Lists the decoders available. */
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1493 extern ALMIXER_DECLSPEC void ALMIXER_CALL ALmixer_OutputDecoders(void);
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1494 /** This function may be removed in the future. For debugging. Prints to stderr. */
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1495 extern ALMIXER_DECLSPEC void ALMIXER_CALL ALmixer_OutputOpenALInfo(void);
0 01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	1496
2 279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1497 /** This function may be removed in the future. Returns true if compiled with threads, false if not. */
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1498 extern ALMIXER_DECLSPEC ALboolean ALMIXER_CALL ALmixer_CompiledWithThreadBackend(void);
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1499
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1500 /**
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1501 * @}
279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1502 */
0 01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	1503
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	1504
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	1505
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	1506
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	1507 /* Ends C function definitions when using C++ */
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	1508 #ifdef __cplusplus
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	1509 }
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	1510 #endif
2 279d0427ef26 Overhaul prep for first public release. Eric Wing <ewing . public \|-at-\| gmail . com> parents: 1 diff changeset	1511
0 01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	1512
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	1513 #endif /* _SDL_ALMIXER_H_ */
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	1514
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	1515 /* end of SDL_ALmixer.h ... */
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	1516
01e39f9f58d5 Bitkeeper era. Eric Wing <ewing . public \|-at-\| gmail . com> parents: diff changeset	1517

Mercurial > almixer_isolated

annotate ALmixer.h @ 3:a929285e1db0