src/audio/SDL_sysaudio.h
author Ryan C. Gordon
Tue, 06 Dec 2016 02:20:58 -0500
changeset 10680 fe759a74b018
parent 10638 d11daa346140
child 10681 34b25c97b17f
permissions -rw-r--r--
Added SDL_VARIABLE_LENGTH_ARRAY so this #ifdef is localized to one place.
slouken@0
     1
/*
slouken@5535
     2
  Simple DirectMedia Layer
slouken@9998
     3
  Copyright (C) 1997-2016 Sam Lantinga <slouken@libsdl.org>
slouken@0
     4
slouken@5535
     5
  This software is provided 'as-is', without any express or implied
slouken@5535
     6
  warranty.  In no event will the authors be held liable for any damages
slouken@5535
     7
  arising from the use of this software.
slouken@0
     8
slouken@5535
     9
  Permission is granted to anyone to use this software for any purpose,
slouken@5535
    10
  including commercial applications, and to alter it and redistribute it
slouken@5535
    11
  freely, subject to the following restrictions:
slouken@0
    12
slouken@5535
    13
  1. The origin of this software must not be misrepresented; you must not
slouken@5535
    14
     claim that you wrote the original software. If you use this software
slouken@5535
    15
     in a product, an acknowledgment in the product documentation would be
slouken@5535
    16
     appreciated but is not required.
slouken@5535
    17
  2. Altered source versions must be plainly marked as such, and must not be
slouken@5535
    18
     misrepresented as being the original software.
slouken@5535
    19
  3. This notice may not be removed or altered from any source distribution.
slouken@0
    20
*/
icculus@8093
    21
#include "../SDL_internal.h"
slouken@0
    22
slouken@10638
    23
#ifndef SDL_sysaudio_h_
slouken@10638
    24
#define SDL_sysaudio_h_
slouken@0
    25
slouken@0
    26
#include "SDL_mutex.h"
slouken@0
    27
#include "SDL_thread.h"
slouken@0
    28
icculus@10264
    29
/* !!! FIXME: These are wordy and unlocalized... */
icculus@10264
    30
#define DEFAULT_OUTPUT_DEVNAME "System audio output device"
icculus@10264
    31
#define DEFAULT_INPUT_DEVNAME "System audio capture device"
icculus@10264
    32
slouken@0
    33
/* The SDL audio driver */
slouken@0
    34
typedef struct SDL_AudioDevice SDL_AudioDevice;
slouken@7191
    35
#define _THIS   SDL_AudioDevice *_this
slouken@0
    36
icculus@9394
    37
/* Audio targets should call this as devices are added to the system (such as
icculus@9394
    38
   a USB headset being plugged in), and should also be called for
icculus@9394
    39
   for every device found during DetectDevices(). */
icculus@9394
    40
extern void SDL_AddAudioDevice(const int iscapture, const char *name, void *handle);
icculus@9393
    41
icculus@9394
    42
/* Audio targets should call this as devices are removed, so SDL can update
icculus@9394
    43
   its list of available devices. */
icculus@9399
    44
extern void SDL_RemoveAudioDevice(const int iscapture, void *handle);
icculus@9393
    45
icculus@9394
    46
/* Audio targets should call this if an opened audio device is lost while
icculus@9394
    47
   being used. This can happen due to i/o errors, or a device being unplugged,
icculus@9394
    48
   etc. If the device is totally gone, please also call SDL_RemoveAudioDevice()
icculus@9394
    49
   as appropriate so SDL's list of devices is accurate. */
icculus@9394
    50
extern void SDL_OpenedAudioDeviceDisconnected(SDL_AudioDevice *device);
icculus@9393
    51
icculus@5593
    52
icculus@9012
    53
/* This is the size of a packet when using SDL_QueueAudio(). We allocate
icculus@9012
    54
   these as necessary and pool them, under the assumption that we'll
icculus@9012
    55
   eventually end up with a handful that keep recycling, meeting whatever
icculus@9012
    56
   the app needs. We keep packing data tightly as more arrives to avoid
icculus@9012
    57
   wasting space, and if we get a giant block of data, we'll split them
icculus@9012
    58
   into multiple packets behind the scenes. My expectation is that most
icculus@9012
    59
   apps will have 2-3 of these in the pool. 8k should cover most needs, but
icculus@9012
    60
   if this is crippling for some embedded system, we can #ifdef this.
icculus@9012
    61
   The system preallocates enough packets for 2 callbacks' worth of data. */
icculus@9012
    62
#define SDL_AUDIOBUFFERQUEUE_PACKETLEN (8 * 1024)
icculus@9012
    63
icculus@9012
    64
/* Used by apps that queue audio instead of using the callback. */
icculus@9012
    65
typedef struct SDL_AudioBufferQueue
icculus@9012
    66
{
icculus@9012
    67
    Uint8 data[SDL_AUDIOBUFFERQUEUE_PACKETLEN];  /* packet data. */
icculus@9012
    68
    Uint32 datalen;  /* bytes currently in use in this packet. */
icculus@9012
    69
    Uint32 startpos;  /* bytes currently consumed in this packet. */
icculus@9012
    70
    struct SDL_AudioBufferQueue *next;  /* next item in linked list. */
icculus@9012
    71
} SDL_AudioBufferQueue;
icculus@9012
    72
icculus@2049
    73
typedef struct SDL_AudioDriverImpl
icculus@2049
    74
{
icculus@9394
    75
    void (*DetectDevices) (void);
icculus@9394
    76
    int (*OpenDevice) (_THIS, void *handle, const char *devname, int iscapture);
icculus@2049
    77
    void (*ThreadInit) (_THIS); /* Called by audio thread at start */
icculus@2049
    78
    void (*WaitDevice) (_THIS);
icculus@2049
    79
    void (*PlayDevice) (_THIS);
icculus@9031
    80
    int (*GetPendingBytes) (_THIS);
icculus@2049
    81
    Uint8 *(*GetDeviceBuf) (_THIS);
icculus@10239
    82
    int (*CaptureFromDevice) (_THIS, void *buffer, int buflen);
icculus@10239
    83
    void (*FlushCapture) (_THIS);
icculus@10473
    84
    void (*PrepareToClose) (_THIS);  /**< Called between run and draining wait for playback devices */
icculus@2049
    85
    void (*CloseDevice) (_THIS);
icculus@2049
    86
    void (*LockDevice) (_THIS);
icculus@2049
    87
    void (*UnlockDevice) (_THIS);
icculus@9394
    88
    void (*FreeDeviceHandle) (void *handle);  /**< SDL is done with handle from SDL_AddAudioDevice() */
icculus@2049
    89
    void (*Deinitialize) (void);
icculus@2049
    90
icculus@5590
    91
    /* !!! FIXME: add pause(), so we can optimize instead of mixing silence. */
icculus@5590
    92
icculus@2049
    93
    /* Some flags to push duplicate code into the core and reduce #ifdefs. */
icculus@9391
    94
    /* !!! FIXME: these should be SDL_bool */
icculus@5589
    95
    int ProvidesOwnCallbackThread;
icculus@10471
    96
    int SkipMixerLock;
icculus@5589
    97
    int HasCaptureSupport;
icculus@5589
    98
    int OnlyHasDefaultOutputDevice;
icculus@10258
    99
    int OnlyHasDefaultCaptureDevice;
icculus@9394
   100
    int AllowsArbitraryDeviceNames;
icculus@2049
   101
} SDL_AudioDriverImpl;
icculus@2049
   102
icculus@2049
   103
icculus@9394
   104
typedef struct SDL_AudioDeviceItem
icculus@9394
   105
{
icculus@9394
   106
    void *handle;
icculus@9394
   107
    struct SDL_AudioDeviceItem *next;
icculus@10680
   108
    char name[SDL_VARIABLE_LENGTH_ARRAY];
icculus@9394
   109
} SDL_AudioDeviceItem;
icculus@9394
   110
icculus@9394
   111
icculus@2049
   112
typedef struct SDL_AudioDriver
slouken@1895
   113
{
slouken@1895
   114
    /* * * */
slouken@1895
   115
    /* The name of this audio driver */
slouken@1895
   116
    const char *name;
slouken@0
   117
slouken@1895
   118
    /* * * */
slouken@1895
   119
    /* The description of this audio driver */
slouken@1895
   120
    const char *desc;
slouken@0
   121
icculus@2049
   122
    SDL_AudioDriverImpl impl;
icculus@5593
   123
icculus@9393
   124
    /* A mutex for device detection */
icculus@9394
   125
    SDL_mutex *detectionLock;
icculus@9394
   126
    SDL_bool captureDevicesRemoved;
icculus@9394
   127
    SDL_bool outputDevicesRemoved;
icculus@5593
   128
    int outputDeviceCount;
icculus@5593
   129
    int inputDeviceCount;
icculus@9394
   130
    SDL_AudioDeviceItem *outputDevices;
icculus@9394
   131
    SDL_AudioDeviceItem *inputDevices;
icculus@2049
   132
} SDL_AudioDriver;
icculus@2049
   133
slouken@0
   134
slouken@2716
   135
/* Streamer */
slouken@2716
   136
typedef struct
slouken@2716
   137
{
slouken@2716
   138
    Uint8 *buffer;
slouken@2716
   139
    int max_len;                /* the maximum length in bytes */
slouken@2716
   140
    int read_pos, write_pos;    /* the position of the write and read heads in bytes */
slouken@2716
   141
} SDL_AudioStreamer;
slouken@2716
   142
slouken@2716
   143
icculus@2049
   144
/* Define the SDL audio driver structure */
icculus@2049
   145
struct SDL_AudioDevice
icculus@2049
   146
{
slouken@1895
   147
    /* * * */
slouken@1895
   148
    /* Data common to all devices */
icculus@9393
   149
    SDL_AudioDeviceID id;
slouken@0
   150
slouken@1895
   151
    /* The current audio specification (shared with audio thread) */
slouken@1895
   152
    SDL_AudioSpec spec;
slouken@0
   153
slouken@1895
   154
    /* An audio conversion block for audio format emulation */
slouken@1895
   155
    SDL_AudioCVT convert;
slouken@0
   156
slouken@2716
   157
    /* The streamer, if sample rate conversion necessitates it */
slouken@2716
   158
    int use_streamer;
slouken@2716
   159
    SDL_AudioStreamer streamer;
slouken@2716
   160
slouken@1895
   161
    /* Current state flags */
icculus@10233
   162
    SDL_atomic_t shutdown; /* true if we are signaling the play thread to end. */
icculus@10238
   163
    SDL_atomic_t enabled;  /* true if device is functioning and connected. */
icculus@10238
   164
    SDL_atomic_t paused;
icculus@10235
   165
    SDL_bool iscapture;
slouken@0
   166
slouken@1895
   167
    /* Fake audio buffer for when the audio hardware is busy */
slouken@1895
   168
    Uint8 *fake_stream;
slouken@0
   169
icculus@9391
   170
    /* A mutex for locking the mixing buffers */
slouken@1895
   171
    SDL_mutex *mixer_lock;
slouken@0
   172
slouken@1895
   173
    /* A thread to feed the audio device */
slouken@1895
   174
    SDL_Thread *thread;
slouken@3578
   175
    SDL_threadID threadid;
slouken@0
   176
icculus@9012
   177
    /* Queued buffers (if app not using callback). */
icculus@9012
   178
    SDL_AudioBufferQueue *buffer_queue_head; /* device fed from here. */
icculus@9012
   179
    SDL_AudioBufferQueue *buffer_queue_tail; /* queue fills to here. */
icculus@9012
   180
    SDL_AudioBufferQueue *buffer_queue_pool; /* these are unused packets. */
icculus@9012
   181
    Uint32 queued_bytes;  /* number of bytes of audio data in the queue. */
icculus@9012
   182
slouken@1895
   183
    /* * * */
slouken@1895
   184
    /* Data private to this driver */
slouken@1895
   185
    struct SDL_PrivateAudioData *hidden;
slouken@10467
   186
slouken@10467
   187
    void *handle;
slouken@0
   188
};
slouken@0
   189
#undef _THIS
slouken@0
   190
slouken@1895
   191
typedef struct AudioBootStrap
slouken@1895
   192
{
slouken@1895
   193
    const char *name;
slouken@1895
   194
    const char *desc;
slouken@2060
   195
    int (*init) (SDL_AudioDriverImpl * impl);
icculus@5578
   196
    int demand_only;  /* 1==request explicitly, or it won't be available. */
slouken@0
   197
} AudioBootStrap;
slouken@0
   198
slouken@10609
   199
#if SDL_AUDIO_DRIVER_PULSEAUDIO
slouken@10609
   200
extern AudioBootStrap PULSEAUDIO_bootstrap;
slouken@10609
   201
#endif
slouken@10609
   202
#if SDL_AUDIO_DRIVER_ALSA
slouken@10609
   203
extern AudioBootStrap ALSA_bootstrap;
slouken@10609
   204
#endif
slouken@10609
   205
#if SDL_AUDIO_DRIVER_SNDIO
slouken@10609
   206
extern AudioBootStrap SNDIO_bootstrap;
slouken@10609
   207
#endif
slouken@10609
   208
#if SDL_AUDIO_DRIVER_BSD
slouken@10609
   209
extern AudioBootStrap BSD_AUDIO_bootstrap;
slouken@10609
   210
#endif
slouken@10609
   211
#if SDL_AUDIO_DRIVER_OSS
slouken@10609
   212
extern AudioBootStrap DSP_bootstrap;
slouken@10609
   213
#endif
slouken@10609
   214
#if SDL_AUDIO_DRIVER_QSA
slouken@10609
   215
extern AudioBootStrap QSAAUDIO_bootstrap;
slouken@10609
   216
#endif
slouken@10609
   217
#if SDL_AUDIO_DRIVER_SUNAUDIO
slouken@10609
   218
extern AudioBootStrap SUNAUDIO_bootstrap;
slouken@10609
   219
#endif
slouken@10609
   220
#if SDL_AUDIO_DRIVER_ARTS
slouken@10609
   221
extern AudioBootStrap ARTS_bootstrap;
slouken@10609
   222
#endif
slouken@10609
   223
#if SDL_AUDIO_DRIVER_ESD
slouken@10609
   224
extern AudioBootStrap ESD_bootstrap;
slouken@10609
   225
#endif
slouken@10609
   226
#if SDL_AUDIO_DRIVER_NACL
slouken@10609
   227
extern AudioBootStrap NACLAUDIO_bootstrap;
slouken@10609
   228
#endif
slouken@10609
   229
#if SDL_AUDIO_DRIVER_NAS
slouken@10609
   230
extern AudioBootStrap NAS_bootstrap;
slouken@10609
   231
#endif
slouken@10609
   232
#if SDL_AUDIO_DRIVER_XAUDIO2
slouken@10609
   233
extern AudioBootStrap XAUDIO2_bootstrap;
slouken@10609
   234
#endif
slouken@10609
   235
#if SDL_AUDIO_DRIVER_DSOUND
slouken@10609
   236
extern AudioBootStrap DSOUND_bootstrap;
slouken@10609
   237
#endif
slouken@10609
   238
#if SDL_AUDIO_DRIVER_WINMM
slouken@10609
   239
extern AudioBootStrap WINMM_bootstrap;
slouken@10609
   240
#endif
slouken@10609
   241
#if SDL_AUDIO_DRIVER_PAUDIO
slouken@10609
   242
extern AudioBootStrap PAUDIO_bootstrap;
slouken@10609
   243
#endif
slouken@10609
   244
#if SDL_AUDIO_DRIVER_HAIKU
slouken@10609
   245
extern AudioBootStrap HAIKUAUDIO_bootstrap;
slouken@10609
   246
#endif
slouken@10609
   247
#if SDL_AUDIO_DRIVER_COREAUDIO
slouken@10609
   248
extern AudioBootStrap COREAUDIO_bootstrap;
slouken@10609
   249
#endif
slouken@10609
   250
#if SDL_AUDIO_DRIVER_DISK
slouken@10609
   251
extern AudioBootStrap DISKAUDIO_bootstrap;
slouken@10609
   252
#endif
slouken@10609
   253
#if SDL_AUDIO_DRIVER_DUMMY
slouken@10609
   254
extern AudioBootStrap DUMMYAUDIO_bootstrap;
slouken@10609
   255
#endif
slouken@10609
   256
#if SDL_AUDIO_DRIVER_FUSIONSOUND
slouken@10609
   257
extern AudioBootStrap FUSIONSOUND_bootstrap;
slouken@10609
   258
#endif
slouken@10609
   259
#if SDL_AUDIO_DRIVER_ANDROID
slouken@10609
   260
extern AudioBootStrap ANDROIDAUDIO_bootstrap;
slouken@10609
   261
#endif
slouken@10609
   262
#if SDL_AUDIO_DRIVER_PSP
slouken@10609
   263
extern AudioBootStrap PSPAUDIO_bootstrap;
slouken@10609
   264
#endif
slouken@10609
   265
#if SDL_AUDIO_DRIVER_EMSCRIPTEN
slouken@10609
   266
extern AudioBootStrap EMSCRIPTENAUDIO_bootstrap;
slouken@10609
   267
#endif
slouken@10609
   268
slouken@10609
   269
slouken@10609
   270
slouken@10638
   271
#endif /* SDL_sysaudio_h_ */
slouken@0
   272
slouken@1895
   273
/* vi: set ts=4 sw=4 expandtab: */