SDL_sound_CoreAudio: SDL_sound.h comparison

comparison SDL_sound.h @ 353:2740fad98dfe

Tweaked and enhanced for Doxygen support.

author	Ryan C. Gordon <icculus@icculus.org>
date	Fri, 07 Jun 2002 13:23:59 +0000
parents	c345a40a8a99
children	b3ac77d08e79

comparison

equal deleted inserted replaced

-:f0eb99670fa8
+:2740fad98dfe
+/** \file SDL_sound.h */
 /*
 * SDL_sound -- An abstract sound format decoding API.
 * Copyright (C) 2001  Ryan C. Gordon.
 *
 * This library is free software; you can redistribute it and/or
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 */
 /**
-* @overview
+* \mainpage SDL_sound
+*
+* The latest version of SDL_sound can be found at:
+*     http://icculus.org/SDL_sound/
 *
 * The basic gist of SDL_sound is that you use an SDL_RWops to get sound data
 *  into this library, and SDL_sound will take that data, in one of several
 *  popular formats, and decode it into raw waveform data in the format of
 *  your choice. This gives you a nice abstraction for getting sound into your
 *
 *   (...and more to come...)
 *
 * Please see the file COPYING in the source's root directory.
 *
-*  This file written by Ryan C. Gordon. (icculus@clutteredmind.org)
+* \author Ryan C. Gordon (icculus@clutteredmind.org)
+* \author many others, please see CREDITS in the source's root directory.
 */
 #ifndef _INCLUDE_SDL_SOUND_H_
 #define _INCLUDE_SDL_SOUND_H_
 #ifdef __cplusplus
 extern "C" {
 #endif
+/* !!! FIXME: Use SDLCALL instead. */
+#ifndef DOXYGEN_SHOULD_IGNORE_THIS
 #ifdef SDL_SOUND_DLL_EXPORTS
 #  undef DECLSPEC
 #  define DECLSPEC __declspec(dllexport)
 #endif
 #define SOUND_VER_MAJOR 0
 #define SOUND_VER_MINOR 1
 #define SOUND_VER_PATCH 5
+#endif
-/**
-* These are flags that are used in a Sound_Sample to show various states.
+/**
-*
+* \enum Sound_SampleFlags
-*   To use: "if (sample->flags & SOUND_SAMPLEFLAG_ERROR) { dosomething(); }"
+* \brief Flags that are used in a Sound_Sample to show various states.
 *
-*  @param SOUND_SAMPLEFLAG_NONE     null flag.
+* To use:
-*  @param SOUND_SAMPLEFLAG_CANSEEK  sample can seek to arbitrary points.
+* \code
-*  @param SOUND_SAMPLEFLAG_EOF      end of input stream.
+* if (sample->flags & SOUND_SAMPLEFLAG_ERROR) { dosomething(); }
-*  @param SOUND_SAMPLEFLAG_ERROR    unrecoverable error.
+* \endcode
-*  @param SOUND_SAMPLEFLAG_EAGAIN   function would block, or temp error.
+*/
-*/
+typedef enum
-typedef enum __SOUND_SAMPLEFLAGS__
 {
-SOUND_SAMPLEFLAG_NONE      = 0,
+SOUND_SAMPLEFLAG_NONE    = 0,       /**< No special attributes. */
 /* these are set at sample creation time... */
-SOUND_SAMPLEFLAG_CANSEEK  = 1,
+SOUND_SAMPLEFLAG_CANSEEK = 1,       /**< sample can seek to arbitrary points. */
 /* these are set during decoding... */
-SOUND_SAMPLEFLAG_EOF       = 1 << 29,
+SOUND_SAMPLEFLAG_EOF     = 1 << 29, /**< end of input stream. */
-SOUND_SAMPLEFLAG_ERROR     = 1 << 30,
+SOUND_SAMPLEFLAG_ERROR   = 1 << 30, /**< unrecoverable error. */
-SOUND_SAMPLEFLAG_EAGAIN    = 1 << 31
+SOUND_SAMPLEFLAG_EAGAIN  = 1 << 31  /**< function would block, or temp error. */
 } Sound_SampleFlags;
 /**
+* \struct Sound_AudioInfo
+* \brief Information about an existing sample's format.
+*
 * These are the basics of a decoded sample's data structure: data format
 *  (see AUDIO_U8 and friends in SDL_audio.h), number of channels, and sample
 *  rate. If you need more explanation than that, you should stop developing
 *  sound code right now.
-*
+*/
-*   @param format Equivalent of SDL_AudioSpec.format.
+typedef struct
-*   @param channels Number of sound channels. 1 == mono, 2 == stereo.
-*   @param rate Sample rate; frequency of sample points per second (44100,
-*                22050, 8000, etc.)
-*/
-typedef struct __SOUND_AUDIOINFO__
 {
-Uint16 format;
+Uint16 format;  /**< Equivalent of SDL_AudioSpec.format. */
-Uint8 channels;
+Uint8 channels; /**< Number of sound channels. 1 == mono, 2 == stereo. */
-Uint32 rate;
+Uint32 rate;    /**< Sample rate; frequency of sample points per second. */
 } Sound_AudioInfo;
 /**
+* \struct Sound_DecoderInfo
+* \brief Information about available soudn decoders.
+*
 * Each decoder sets up one of these structs, which can be retrieved via
 *  the Sound_AvailableDecoders() function. EVERY FIELD IN THIS IS READ-ONLY.
 *
-*   @param extensions File extensions, list ends with NULL. Read it like this:
+* The extensions field is a NULL-terminated list of ASCIZ strings. You
-*           const char **ext;
+*  should read it like this:
-*           for (ext = info->extensions; *ext != NULL; ext++)
+*
-*                printf("   File extension \"%s\"\n", *ext);
+* \code
-*   @param description Human readable description of decoder.
+* const char **ext;
-*   @param author "Name Of Author <email@emailhost.dom>"
+* for (ext = info->extensions; *ext != NULL; ext++) {
-*   @param url URL specific to this decoder.
+*     printf("   File extension \"%s\"\n", *ext);
-*/
+* }
-typedef struct __SOUND_DECODERINFO__
+* \endcode
+*
+*/
+typedef struct
 {
-const char **extensions;
+const char **extensions; /**< File extensions, list ends with NULL. */
-const char *description;
+const char *description; /**< Human readable description of decoder. */
-const char *author;
+const char *author;      /**< "Name Of Author \<email@emailhost.dom\>" */
-const char *url;
+const char *url;         /**< URL specific to this decoder. */
 } Sound_DecoderInfo;
 /**
+* \struct Sound_Sample
+* \brief Represents sound data in the process of being decoded.
+*
 * The Sound_Sample structure is the heart of SDL_sound. This holds
 *  information about a source of sound data as it is being decoded.
 *  EVERY FIELD IN THIS IS READ-ONLY. Please use the API functions to
 *  change them.
-*
+*/
-*  @param opaque Internal use only. Don't touch.
+typedef struct
-*  @param decoder Decoder used for this sample.
-*  @param desired Desired audio format for conversion.
-*  @param actual Actual audio format of sample.
-*  @param buffer Decoded sound data lands in here.
-*  @param buffer_size Current size of (buffer), in bytes (Uint8).
-*  @param flags Flags relating to this sample.
-*/
-typedef struct __SOUND_SAMPLE__
 {
-void *opaque;
+void *opaque;  /**< Internal use only. Don't touch. */
-const Sound_DecoderInfo *decoder;
+const Sound_DecoderInfo *decoder;  /**< Decoder used for this sample. */
-Sound_AudioInfo desired;
+Sound_AudioInfo desired;  /**< Desired audio format for conversion. */
-Sound_AudioInfo actual;
+Sound_AudioInfo actual;  /**< Actual audio format of sample. */
-void *buffer;
+void *buffer;  /**< Decoded sound data lands in here. */
-Uint32 buffer_size;
+Uint32 buffer_size;  /**< Current size of (buffer), in bytes (Uint8). */
-Sound_SampleFlags flags;
+Sound_SampleFlags flags;  /**< Flags relating to this sample. */
 } Sound_Sample;
 /**
-* Just what it says: a major.minor.patch style version number...
+* \struct Sound_Version
-*
+* \brief Information the version of SDL_sound in use.
-*   @param major The major version number.
+*
-*   @param minor The minor version number.
+* Represents the library's version as three levels: major revision
-*   @param patch The patchlevel version number.
+*  (increments with massive changes, additions, and enhancements),
-*/
+*  minor revision (increments with backwards-compatible changes to the
-typedef struct __SOUND_VERSION__
+*  major revision), and patchlevel (increments with fixes to the minor
+*  revision).
+*
+* \sa SOUND_VERSION
+* \sa Sound_GetLinkedVersion
+*/
+typedef struct
 {
-int major;
+int major; /**< major revision */
-int minor;
+int minor; /**< minor revision */
-int patch;
+int patch; /**< patchlevel */
 } Sound_Version;
 /* functions and macros... */
-#define SOUND_VERSION(x) { \
+/**
-(x)->major = SOUND_VER_MAJOR; \
+* \def SOUND_VERSION(x)
-(x)->minor = SOUND_VER_MINOR; \
+* \brief Macro to determine SDL_sound version program was compiled against.
-(x)->patch = SOUND_VER_PATCH; \
+*
-}
+* This macro fills in a Sound_Version structure with the version of the
+*  library you compiled against. This is determined by what header the
-/**
+*  compiler uses. Note that if you dynamically linked the library, you might
-* Get the version of SDL_sound that is linked against your program. If you
+*  have a slightly newer or older version at runtime. That version can be
-*  are using a shared library (DLL) version of SDL_sound, then it is possible
+*  determined with Sound_GetLinkedVersion(), which, unlike SOUND_VERSION,
-*  that it will be different than the version you compiled against.
+*  is not a macro.
+*
+* \param x A pointer to a Sound_Version struct to initialize.
+*
+* \sa Sound_Version
+* \sa Sound_GetLinkedVersion
+*/
+#define SOUND_VERSION(x) \
+{ \
+(x)->major = SOUND_VER_MAJOR; \
+(x)->minor = SOUND_VER_MINOR; \
+(x)->patch = SOUND_VER_PATCH; \
+}
+/**
+* \fn void Sound_GetLinkedVersion(Sound_Version *ver)
+* \brief Get the version of SDL_sound that is linked against your program.
+*
+* If you are using a shared library (DLL) version of SDL_sound, then it is
+*  possible that it will be different than the version you compiled against.
 *
 * This is a real function; the macro SOUND_VERSION tells you what version
 *  of SDL_sound you compiled against:
 *
+* \code
 * Sound_Version compiled;
 * Sound_Version linked;
 *
 * SOUND_VERSION(&compiled);
 * Sound_GetLinkedVersion(&linked);
 * printf("We compiled against SDL_sound version %d.%d.%d ...\n",
 *           compiled.major, compiled.minor, compiled.patch);
 * printf("But we linked against SDL_sound version %d.%d.%d.\n",
 *           linked.major, linked.minor, linked.patch);
+* \endcode
 *
 * This function may be called safely at any time, even before Sound_Init().
 *
-* @param ver Sound_Version structure to fill with shared library's version.
+* \param ver Sound_Version structure to fill with shared library's version.
 */
-extern DECLSPEC void Sound_GetLinkedVersion(Sound_Version *ver);
+DECLSPEC void Sound_GetLinkedVersion(Sound_Version *ver);
 /**
-* Initialize SDL_sound. This must be called before any other SDL_sound
+* \fn Sound_Init(void)
-*  function (except perhaps Sound_GetLinkedVersion()). You should call
+* \brief Initialize SDL_sound.
-*  SDL_Init() before calling this. Sound_Init() will attempt to call
+*
-*  SDL_Init(SDL_INIT_AUDIO), just in case. This is a safe behaviour, but it
+* This must be called before any other SDL_sound function (except perhaps
-*  may not configure SDL to your liking by itself.
+*  Sound_GetLinkedVersion()). You should call SDL_Init() before calling this.
-*
+*  Sound_Init() will attempt to call SDL_Init(SDL_INIT_AUDIO), just in case.
-*  @returns nonzero on success, zero on error. Specifics of the
+*  This is a safe behaviour, but it may not configure SDL to your liking by
+*  itself.
+*
+*  \return nonzero on success, zero on error. Specifics of the
 *           error can be gleaned from Sound_GetError().
 */
-extern DECLSPEC int Sound_Init(void);
+DECLSPEC int Sound_Init(void);
 /**
-* Shutdown SDL_sound. This closes any SDL_RWops that were being used as
+* \fn Sound_Quit(void)
-*  sound sources, and frees any resources in use by SDL_sound.
+* \brief Shutdown SDL_sound.
+*
+* This closes any SDL_RWops that were being used as sound sources, and frees
+*  any resources in use by SDL_sound.
 *
 * All Sound_Sample pointers you had prior to this call are INVALIDATED.
 *
 * Once successfully deinitialized, Sound_Init() can be called again to
 *  restart the subsystem. All default API states are restored at this
 *  point.
 *
 * You should call this BEFORE SDL_Quit(). This will NOT call SDL_Quit()
 *  for you!
 *
-*  @returns nonzero on success, zero on error. Specifics of the error
+*  \return nonzero on success, zero on error. Specifics of the error
 *           can be gleaned from Sound_GetError(). If failure, state of
 *           SDL_sound is undefined, and probably badly screwed up.
 */
-extern DECLSPEC int Sound_Quit(void);
+DECLSPEC int Sound_Quit(void);
 /**
-* Get a list of sound formats supported by this implementation of SDL_sound.
+* \fn const Sound_DecoderInfo **Sound_AvailableDecoders(void)
-*  This is for informational purposes only. Note that the extension listed is
+* \brief Get a list of sound formats supported by this version of SDL_sound.
+*
+* This is for informational purposes only. Note that the extension listed is
 *  merely convention: if we list "MP3", you can open an MPEG-1 Layer 3 audio
 *  file with an extension of "XYZ", if you like. The file extensions are
 *  informational, and only required as a hint to choosing the correct
 *  decoder, since the sound data may not be coming from a file at all, thanks
 *  to the abstraction that an SDL_RWops provides.
 *
 * The returned value is an array of pointers to Sound_DecoderInfo structures,
 *  with a NULL entry to signify the end of the list:
 *
+* \code
 * Sound_DecoderInfo **i;
 *
 * for (i = Sound_AvailableDecoders(); *i != NULL; i++)
 * {
 *     printf("Supported sound format: [%s], which is [%s].\n",
 *              i->extension, i->description);
 *     // ...and other fields...
 * }
+* \endcode
 *
 * The return values are pointers to static internal memory, and should
 *  be considered READ ONLY, and never freed.
 *
-*  @returns READ ONLY Null-terminated array of READ ONLY structures.
+*  \return READ ONLY Null-terminated array of READ ONLY structures.
 */
-extern DECLSPEC const Sound_DecoderInfo **Sound_AvailableDecoders(void);
+DECLSPEC const Sound_DecoderInfo **Sound_AvailableDecoders(void);
 /**
-* Get the last SDL_sound error message as a null-terminated string.
+* \fn const char *Sound_GetError(void)
-*  This will be NULL if there's been no error since the last call to this
+* \brief Get the last SDL_sound error message as a null-terminated string.
-*  function. The pointer returned by this call points to an internal buffer.
+*
-*  Each thread has a unique error state associated with it, but each time
+* This will be NULL if there's been no error since the last call to this
-*  a new error message is set, it will overwrite the previous one associated
+*  function. The pointer returned by this call points to an internal buffer,
-*  with that thread. It is safe to call this function at anytime, even
+*  and should not be deallocated. Each thread has a unique error state
-*  before Sound_Init().
+*  associated with it, but each time a new error message is set, it will
-*
+*  overwrite the previous one associated with that thread. It is safe to call
-*  @returns READ ONLY string of last error message.
+*  this function at anytime, even before Sound_Init().
-*/
+*
-extern DECLSPEC const char *Sound_GetError(void);
+*  \return READ ONLY string of last error message.
+*/
+DECLSPEC const char *Sound_GetError(void);
-/**
-* Clear the current error message, so the next call to Sound_GetError() will
-*  return NULL.
+/**
-*/
+* \fn void Sound_ClearError(void)
-extern DECLSPEC void Sound_ClearError(void);
+* \brief Clear the current error message.
+*
+* The next call to Sound_GetError() after Sound_ClearError() will return NULL.
-/**
+*/
-* Start decoding a new sound sample. The data is read via an SDL_RWops
+DECLSPEC void Sound_ClearError(void);
-*  structure (see SDL_rwops.h in the SDL include directory), so it may be
-*  coming from memory, disk, network stream, etc. The (ext) parameter is
-*  merely a hint to determining the correct decoder; if you specify, for
+/**
-*  example, "mp3" for an extension, and one of the decoders lists that
+* \fn Sound_Sample *Sound_NewSample(SDL_RWops *rw, const char *ext, Sound_AudioInfo *desired, Uint32 bufferSize)
-*  as a handled extension, then that decoder is given first shot at trying
+* \brief Start decoding a new sound sample.
-*  to claim the data for decoding. If none of the extensions match (or the
+*
-*  extension is NULL), then every decoder examines the data to determine if
+* The data is read via an SDL_RWops structure (see SDL_rwops.h in the SDL
-*  it can handle it, until one accepts it. In such a case your SDL_RWops will
+*  include directory), so it may be coming from memory, disk, network stream,
-*  need to be capable of rewinding to the start of the stream.
+*  etc. The (ext) parameter is merely a hint to determining the correct
+*  decoder; if you specify, for example, "mp3" for an extension, and one of
+*  the decoders lists that as a handled extension, then that decoder is given
+*  first shot at trying to claim the data for decoding. If none of the
+*  extensions match (or the extension is NULL), then every decoder examines
+*  the data to determine if it can handle it, until one accepts it. In such a
+*  case your SDL_RWops will need to be capable of rewinding to the start of
+*  the stream.
+*
 * If no decoders can handle the data, a NULL value is returned, and a human
 *  readable error message can be fetched from Sound_GetError().
+*
 * Optionally, a desired audio format can be specified. If the incoming data
 *  is in a different format, SDL_sound will convert it to the desired format
 *  on the fly. Note that this can be an expensive operation, so it may be
 *  wise to convert data before you need to play it back, if possible, or
 *  make sure your data is initially in the format that you need it in.
 *  If you don't want to convert the data, you can specify NULL for a desired
 *  format. The incoming format of the data, preconversion, can be found
 *  in the Sound_Sample structure.
+*
 * Note that the raw sound data "decoder" needs you to specify both the
 *  extension "RAW" and a "desired" format, or it will refuse to handle
 *  the data. This is to prevent it from catching all formats unsupported
 *  by the other decoders.
+*
 * Finally, specify an initial buffer size; this is the number of bytes that
 *  will be allocated to store each read from the sound buffer. The more you
 *  can safely allocate, the more decoding can be done in one block, but the
 *  more resources you have to use up, and the longer each decoding call will
 *  take. Note that different data formats require more or less space to
 *  store. This buffer can be resized via Sound_SetBufferSize() ...
+*
 * The buffer size specified must be a multiple of the size of a single
 *  sample point. So, if you want 16-bit, stereo samples, then your sample
 *  point size is (2 channels * 16 bits), or 32 bits per sample, which is four
 *  bytes. In such a case, you could specify 128 or 132 bytes for a buffer,
 *  but not 129, 130, or 131 (although in reality, you'll want to specify a
 *  MUCH larger buffer).
+*
 * When you are done with this Sound_Sample pointer, you can dispose of it
 *  via Sound_FreeSample().
+*
 * You do not have to keep a reference to (rw) around. If this function
 *  suceeds, it stores (rw) internally (and disposes of it during the call
 *  to Sound_FreeSample()). If this function fails, it will dispose of the
 *  SDL_RWops for you.
 *
-*    @param rw SDL_RWops with sound data.
+*    \param rw SDL_RWops with sound data.
-*    @param ext File extension normally associated with a data format.
+*    \param ext File extension normally associated with a data format.
 *               Can usually be NULL.
-*    @param desired Format to convert sound data into. Can usually be NULL,
+*    \param desired Format to convert sound data into. Can usually be NULL,
 *                   if you don't need conversion.
-*   @returns Sound_Sample pointer, which is used as a handle to several other
+*    \param bufferSize Size, in bytes, to allocate for the decoding buffer.
+*   \return Sound_Sample pointer, which is used as a handle to several other
 *            SDL_sound APIs. NULL on error. If error, use
 *            Sound_GetError() to see what went wrong.
 */
-extern DECLSPEC Sound_Sample *Sound_NewSample(SDL_RWops *rw, const char *ext,
+DECLSPEC Sound_Sample *Sound_NewSample(SDL_RWops *rw, const char *ext,
 Sound_AudioInfo *desired,
 Uint32 bufferSize);
 /**
+* \fn Sound_Sample *Sound_NewSampleFromFile(const char *filename, Sound_AudioInfo *desired, Uint32 bufferSize)
+* \brief Start decoding a new sound sample from a file on disk.
+*
 * This is identical to Sound_NewSample(), but it creates an SDL_RWops for you
 *  from the file located in (filename). Note that (filename) is specified in
 *  platform-dependent notation. ("C:\\music\\mysong.mp3" on windows, and
 *  "/home/icculus/music/mysong.mp3" or whatever on Unix, etc.)
 * Sound_NewSample()'s "ext" parameter is gleaned from the contents of
 *  (filename).
 *
-*    @param filename file containing sound data.
+*    \param filename file containing sound data.
-*    @param desired Format to convert sound data into. Can usually be NULL,
+*    \param desired Format to convert sound data into. Can usually be NULL,
 *                   if you don't need conversion.
-*    @param bufferSize size, in bytes, of initial read buffer.
+*    \param bufferSize size, in bytes, of initial read buffer.
-*   @returns Sound_Sample pointer, which is used as a handle to several other
+*   \return Sound_Sample pointer, which is used as a handle to several other
 *            SDL_sound APIs. NULL on error. If error, use
 *            Sound_GetError() to see what went wrong.
 */
-extern DECLSPEC Sound_Sample *Sound_NewSampleFromFile(const char *filename,
+DECLSPEC Sound_Sample *Sound_NewSampleFromFile(const char *filename,
 Sound_AudioInfo *desired,
 Uint32 bufferSize);
 /**
-* Dispose of a Sound_Sample pointer that was returned from Sound_NewSample().
+* \fn void Sound_FreeSample(Sound_Sample *sample)
-*  This will also close/dispose of the SDL_RWops that was used at creation
+* \brief Dispose of a Dispose of a Sound_Sample.
+*
+* This will also close/dispose of the SDL_RWops that was used at creation
 *  time, so there's no need to keep a reference to that around.
 * The Sound_Sample pointer is invalid after this call, and will almost
 *  certainly result in a crash if you attempt to keep using it.
 *
-*    @param sample The Sound_Sample to delete.
+*    \param sample The Sound_Sample to delete.
 */
-extern DECLSPEC void Sound_FreeSample(Sound_Sample *sample);
+DECLSPEC void Sound_FreeSample(Sound_Sample *sample);
 /**
-* Change the current buffer size for a sample. If the buffer size could
+* \fn int Sound_SetBufferSize(Sound_Sample *sample, Uint32 new_size)
-*  be changed, then the sample->buffer and sample->buffer_size fields will
+* \brief Change the current buffer size for a sample.
-*  reflect that. If they could not be changed, then your original sample
+*
-*  state is preserved. If the buffer is shrinking, the data at the end of
+* If the buffer size could be changed, then the sample->buffer and
-*  buffer is truncated. If the buffer is growing, the contents of the new
+*  sample->buffer_size fields will reflect that. If they could not be
-*  space at the end is undefined until you decode more into it or initialize
+*  changed, then your original sample state is preserved. If the buffer is
-*  it yourself.
+*  shrinking, the data at the end of buffer is truncated. If the buffer is
+*  growing, the contents of the new space at the end is undefined until you
+*  decode more into it or initialize it yourself.
 *
 * The buffer size specified must be a multiple of the size of a single
 *  sample point. So, if you want 16-bit, stereo samples, then your sample
 *  point size is (2 channels * 16 bits), or 32 bits per sample, which is four
 *  bytes. In such a case, you could specify 128 or 132 bytes for a buffer,
 *  but not 129, 130, or 131 (although in reality, you'll want to specify a
 *  MUCH larger buffer).
 *
-*    @param sample The Sound_Sample whose buffer to modify.
+*    \param sample The Sound_Sample whose buffer to modify.
-*    @param new_size The desired size, in bytes, of the new buffer.
+*    \param new_size The desired size, in bytes, of the new buffer.
-*  @returns non-zero if buffer size changed, zero on failure.
+*   \return non-zero if buffer size changed, zero on failure.
 */
-extern DECLSPEC int Sound_SetBufferSize(Sound_Sample *sample, Uint32 new_size);
+DECLSPEC int Sound_SetBufferSize(Sound_Sample *sample, Uint32 new_size);
 /**
-* Decode more of the sound data in a Sound_Sample. It will decode at most
+* \fn Uint32 Sound_Decode(Sound_Sample *sample)
-*  sample->buffer_size bytes into sample->buffer in the desired format, and
+* \brief Decode more of the sound data in a Sound_Sample.
-*  return the number of decoded bytes.
+*
+* It will decode at most sample->buffer_size bytes into sample->buffer in the
+*  desired format, and return the number of decoded bytes.
 * If sample->buffer_size bytes could not be decoded, then please refer to
 *  sample->flags to determine if this was an End-of-stream or error condition.
 *
-*    @param sample Do more decoding to this Sound_Sample.
+*    \param sample Do more decoding to this Sound_Sample.
-*  @returns number of bytes decoded into sample->buffer. If it is less than
+*   \return number of bytes decoded into sample->buffer. If it is less than
 *           sample->buffer_size, then you should check sample->flags to see
 *           what the current state of the sample is (EOF, error, read again).
 */
-extern DECLSPEC Uint32 Sound_Decode(Sound_Sample *sample);
+DECLSPEC Uint32 Sound_Decode(Sound_Sample *sample);
 /**
-* Decode the remainder of the sound data in a Sound_Sample. This will
+* \fn Uint32 Sound_DecodeAll(Sound_Sample *sample)
-*  dynamically allocate memory for the ENTIRE remaining sample.
+* \brief Decode the remainder of the sound data in a Sound_Sample.
+*
+* This will dynamically allocate memory for the ENTIRE remaining sample.
 *  sample->buffer_size and sample->buffer will be updated to reflect the
 *  new buffer. Please refer to sample->flags to determine if the decoding
 *  finished due to an End-of-stream or error condition.
 *
 * Be aware that sound data can take a large amount of memory, and that
 *  sample->buffer_size bytes plus the complete decoded sample at most. The
 *  larger your buffer size, the less overhead this function needs, but beware
 *  the possibility of paging to disk. Best to make this user-configurable if
 *  the sample isn't specific and small.
 *
-*    @param sample Do all decoding for this Sound_Sample.
+*    \param sample Do all decoding for this Sound_Sample.
-*   @returns number of bytes decoded into sample->buffer. You should check
+*   \return number of bytes decoded into sample->buffer. You should check
 *           sample->flags to see what the current state of the sample is
 *           (EOF, error, read again).
 */
-extern DECLSPEC Uint32 Sound_DecodeAll(Sound_Sample *sample);
+DECLSPEC Uint32 Sound_DecodeAll(Sound_Sample *sample);
 /**
-* Restart a sample at the start of its waveform data, as if newly
+* \fn int Sound_Rewind(Sound_Sample *sample)
-*  created with Sound_NewSample(). If successful, the next call to
+* \brief Rewind a sample to the start.
-*  Sound_Decode[All]() will give audio data from the earliest point
+*
-*  in the stream.
+* Restart a sample at the start of its waveform data, as if newly
-*
+*  created with Sound_NewSample(). If successful, the next call to
-* Beware that this function will fail if the SDL_RWops that feeds the
+*  Sound_Decode[All]() will give audio data from the earliest point
-*  decoder can not be rewound via it's seek method, but this can
+*  in the stream.
-*  theoretically be avoided by wrapping it in some sort of buffering
+*
-*  SDL_RWops.
+* Beware that this function will fail if the SDL_RWops that feeds the
-*
+*  decoder can not be rewound via it's seek method, but this can
-* This function should ONLY fail if the RWops is not seekable, or
+*  theoretically be avoided by wrapping it in some sort of buffering
-*  SDL_sound is not initialized. Both can be controlled by the application,
+*  SDL_RWops.
-*  and thus, it is up to the developer's paranoia to dictate whether this
+*
-*  function's return value need be checked at all.
+* This function should ONLY fail if the RWops is not seekable, or
-*
+*  SDL_sound is not initialized. Both can be controlled by the application,
-* If this function fails, the state of the sample is undefined, but it
+*  and thus, it is up to the developer's paranoia to dictate whether this
-*  is still safe to call Sound_FreeSample() to dispose of it.
+*  function's return value need be checked at all.
 *
-* On success, ERROR, EOF, and EAGAIN are cleared from sample->flags. The
+* If this function fails, the state of the sample is undefined, but it
-*  ERROR flag is set on error.
+*  is still safe to call Sound_FreeSample() to dispose of it.
 *
-*    @param sample The Sound_Sample to rewind.
+* On success, ERROR, EOF, and EAGAIN are cleared from sample->flags. The
-*   @return nonzero on success, zero on error. Specifics of the
+*  ERROR flag is set on error.
-*           error can be gleaned from Sound_GetError().
+*
-*/
+*    \param sample The Sound_Sample to rewind.
-extern DECLSPEC int Sound_Rewind(Sound_Sample *sample);
+*   \return nonzero on success, zero on error. Specifics of the
+*           error can be gleaned from Sound_GetError().
+*/
-/**
+DECLSPEC int Sound_Rewind(Sound_Sample *sample);
-* Reposition a sample's stream. If successful, the next call to
-*  Sound_Decode[All]() will give audio data from the offset you
-*  specified.
+/**
-*
+* \fn int Sound_Seek(Sound_Sample *sample, Uint32 ms)
-* The offset is specified in milliseconds from the start of the
+* \brief Seek to a different point in a sample.
-*  sample.
+*
-*
+* Reposition a sample's stream. If successful, the next call to
-* Beware that this function can fail for several reasons. If the
+*  Sound_Decode[All]() will give audio data from the offset you
-*  SDL_RWops that feeds the decoder can not seek, this call will almost
+*  specified.
-*  certainly fail, but this can theoretically be avoided by wrapping it
+*
-*  in some sort of buffering SDL_RWops. Some decoders can never seek,
+* The offset is specified in milliseconds from the start of the
-*  others can only seek with certain files. The decoders will set a flag
+*  sample.
-*  in the sample at creation time to help you determine this.
+*
-*
+* Beware that this function can fail for several reasons. If the
-* You should check sample->flags & SOUND_SAMPLEFLAG_CANSEEK
+*  SDL_RWops that feeds the decoder can not seek, this call will almost
-*  before attempting. Sound_Seek() reports failure immediately if this
+*  certainly fail, but this can theoretically be avoided by wrapping it
-*  flag isn't set. This function can still fail for other reasons if the
+*  in some sort of buffering SDL_RWops. Some decoders can never seek,
-*  flag is set.
+*  others can only seek with certain files. The decoders will set a flag
-*
+*  in the sample at creation time to help you determine this.
-* This function can be emulated in the application with Sound_Rewind()
+*
-*  and predecoding a specific amount of the sample, but this can be
+* You should check sample->flags & SOUND_SAMPLEFLAG_CANSEEK
-*  extremely inefficient. Sound_Seek() accelerates the seek on a
+*  before attempting. Sound_Seek() reports failure immediately if this
-*  with decoder-specific code.
+*  flag isn't set. This function can still fail for other reasons if the
-*
+*  flag is set.
-* If this function fails, the sample should continue to function as if
+*
-*  this call was never made. If there was an unrecoverable error,
+* This function can be emulated in the application with Sound_Rewind()
-*  sample->flags & SOUND_SAMPLEFLAG_ERROR will be set, which you regular
+*  and predecoding a specific amount of the sample, but this can be
-*  decoding loop can pick up.
+*  extremely inefficient. Sound_Seek() accelerates the seek on a
-*
+*  with decoder-specific code.
-* On success, ERROR, EOF, and EAGAIN are cleared from sample->flags.
+*
-*
+* If this function fails, the sample should continue to function as if
-*    @param sample The Sound_Sample to seek.
+*  this call was never made. If there was an unrecoverable error,
-*    @param ms The new position, in milliseconds from start of sample.
+*  sample->flags & SOUND_SAMPLEFLAG_ERROR will be set, which you regular
-*   @return nonzero on success, zero on error. Specifics of the
+*  decoding loop can pick up.
-*           error can be gleaned from Sound_GetError().
+*
-*/
+* On success, ERROR, EOF, and EAGAIN are cleared from sample->flags.
-extern DECLSPEC int Sound_Seek(Sound_Sample *sample, Uint32 ms);
+*
+*    \param sample The Sound_Sample to seek.
+*    \param ms The new position, in milliseconds from start of sample.
+*   \return nonzero on success, zero on error. Specifics of the
+*           error can be gleaned from Sound_GetError().
+*/
+DECLSPEC int Sound_Seek(Sound_Sample *sample, Uint32 ms);
 #ifdef __cplusplus
 }
 #endif

Mercurial > SDL_sound_CoreAudio

comparison SDL_sound.h @ 353:2740fad98dfe