| /* |
| Simple DirectMedia Layer |
| Copyright (C) 1997-2024 Sam Lantinga <slouken@libsdl.org> |
| |
| This software is provided 'as-is', without any express or implied |
| warranty. In no event will the authors be held liable for any damages |
| arising from the use of this software. |
| |
| Permission is granted to anyone to use this software for any purpose, |
| including commercial applications, and to alter it and redistribute it |
| freely, subject to the following restrictions: |
| |
| 1. The origin of this software must not be misrepresented; you must not |
| claim that you wrote the original software. If you use this software |
| in a product, an acknowledgment in the product documentation would be |
| appreciated but is not required. |
| 2. Altered source versions must be plainly marked as such, and must not be |
| misrepresented as being the original software. |
| 3. This notice may not be removed or altered from any source distribution. |
| */ |
| #include "SDL_internal.h" |
| |
| #ifndef SDL_audioqueue_h_ |
| #define SDL_audioqueue_h_ |
| |
| // Internal functions used by SDL_AudioStream for queueing audio. |
| |
| typedef void(SDLCALL *SDL_ReleaseAudioBufferCallback)(void *userdata, const void *buffer, int buflen); |
| |
| typedef struct SDL_AudioQueue SDL_AudioQueue; |
| typedef struct SDL_AudioTrack SDL_AudioTrack; |
| |
| // Create a new audio queue |
| SDL_AudioQueue *SDL_CreateAudioQueue(size_t chunk_size); |
| |
| // Destroy an audio queue |
| void SDL_DestroyAudioQueue(SDL_AudioQueue *queue); |
| |
| // Completely clear the queue |
| void SDL_ClearAudioQueue(SDL_AudioQueue *queue); |
| |
| // Mark the last track as flushed |
| void SDL_FlushAudioQueue(SDL_AudioQueue *queue); |
| |
| // Pop the current head track |
| // REQUIRES: The head track must exist, and must have been flushed |
| void SDL_PopAudioQueueHead(SDL_AudioQueue *queue); |
| |
| // Write data to the end of queue |
| // REQUIRES: If the spec has changed, the last track must have been flushed |
| int SDL_WriteToAudioQueue(SDL_AudioQueue *queue, const SDL_AudioSpec *spec, const Uint8 *data, size_t len); |
| |
| // Create a track where the input data is owned by the caller |
| SDL_AudioTrack *SDL_CreateAudioTrack(SDL_AudioQueue *queue, |
| const SDL_AudioSpec *spec, Uint8 *data, size_t len, size_t capacity, |
| SDL_ReleaseAudioBufferCallback callback, void *userdata); |
| |
| // Add a track to the end of the queue |
| // REQUIRES: `track != NULL` |
| void SDL_AddTrackToAudioQueue(SDL_AudioQueue *queue, SDL_AudioTrack *track); |
| |
| // Iterate over the tracks in the queue |
| void *SDL_BeginAudioQueueIter(SDL_AudioQueue *queue); |
| |
| // Query and update the track iterator |
| // REQUIRES: `*inout_iter != NULL` (a valid iterator) |
| size_t SDL_NextAudioQueueIter(SDL_AudioQueue *queue, void **inout_iter, SDL_AudioSpec *out_spec, SDL_bool *out_flushed); |
| |
| const Uint8 *SDL_ReadFromAudioQueue(SDL_AudioQueue *queue, |
| Uint8 *dst, SDL_AudioFormat dst_format, int dst_channels, |
| int past_frames, int present_frames, int future_frames, |
| Uint8 *scratch); |
| |
| // Get the total number of bytes currently queued |
| size_t SDL_GetAudioQueueQueued(SDL_AudioQueue *queue); |
| |
| int SDL_ResetAudioQueueHistory(SDL_AudioQueue *queue, int num_frames); |
| |
| #endif // SDL_audioqueue_h_ |