Alc/backends/portaudio.c

   1 /**
   2  * OpenAL cross platform audio library
   3  * Copyright (C) 1999-2007 by authors.
   4  * This library is free software; you can redistribute it and/or
   5  *  modify it under the terms of the GNU Library General Public
   6  *  License as published by the Free Software Foundation; either
   7  *  version 2 of the License, or (at your option) any later version.
   8  *
   9  * This library is distributed in the hope that it will be useful,
  10  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  12  *  Library General Public License for more details.
  13  *
  14  * You should have received a copy of the GNU Library General Public
  15  *  License along with this library; if not, write to the
  16  *  Free Software Foundation, Inc.,
  17  *  51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
  18  * Or go to http://www.gnu.org/copyleft/lgpl.html
  19  */
  20
  21 #include "config.h"
  22
  23 #include <stdio.h>
  24 #include <stdlib.h>
  25 #include <string.h>
  26
  27 #include "alMain.h"
  28 #include "alu.h"
  29 #include "compat.h"
  30
  31 #include <portaudio.h>
  32
  33
  34 static const ALCchar pa_device[] = "PortAudio Default";
  35
  36
  37 #ifdef HAVE_DYNLOAD
  38 static void *pa_handle;
  39 #define MAKE_FUNC(x) static __typeof(x) * p##x
  40 MAKE_FUNC(Pa_Initialize);
  41 MAKE_FUNC(Pa_Terminate);
  42 MAKE_FUNC(Pa_GetErrorText);
  43 MAKE_FUNC(Pa_StartStream);
  44 MAKE_FUNC(Pa_StopStream);
  45 MAKE_FUNC(Pa_OpenStream);
  46 MAKE_FUNC(Pa_CloseStream);
  47 MAKE_FUNC(Pa_GetDefaultOutputDevice);
  48 MAKE_FUNC(Pa_GetDefaultInputDevice);
  49 MAKE_FUNC(Pa_GetStreamInfo);
  50 #undef MAKE_FUNC
  51
  52 #define Pa_Initialize                  pPa_Initialize
  53 #define Pa_Terminate                   pPa_Terminate
  54 #define Pa_GetErrorText                pPa_GetErrorText
  55 #define Pa_StartStream                 pPa_StartStream
  56 #define Pa_StopStream                  pPa_StopStream
  57 #define Pa_OpenStream                  pPa_OpenStream
  58 #define Pa_CloseStream                 pPa_CloseStream
  59 #define Pa_GetDefaultOutputDevice      pPa_GetDefaultOutputDevice
  60 #define Pa_GetDefaultInputDevice       pPa_GetDefaultInputDevice
  61 #define Pa_GetStreamInfo               pPa_GetStreamInfo
  62 #endif
  63
  64 static ALCboolean pa_load(void)
  65 {
  66     PaError err;
  67
  68 #ifdef HAVE_DYNLOAD
  69     if(!pa_handle)
  70     {
  71 #ifdef _WIN32
  72 # define PALIB "portaudio.dll"
  73 #elif defined(__APPLE__) && defined(__MACH__)
  74 # define PALIB "libportaudio.2.dylib"
  75 #elif defined(__OpenBSD__)
  76 # define PALIB "libportaudio.so"
  77 #else
  78 # define PALIB "libportaudio.so.2"
  79 #endif
  80
  81         pa_handle = LoadLib(PALIB);
  82         if(!pa_handle)
  83             return ALC_FALSE;
  84
  85 #define LOAD_FUNC(f) do {                                                     \
  86     p##f = GetSymbol(pa_handle, #f);                                          \
  87     if(p##f == NULL)                                                          \
  88     {                                                                         \
  89         CloseLib(pa_handle);                                                  \
  90         pa_handle = NULL;                                                     \
  91         return ALC_FALSE;                                                     \
  92     }                                                                         \
  93 } while(0)
  94         LOAD_FUNC(Pa_Initialize);
  95         LOAD_FUNC(Pa_Terminate);
  96         LOAD_FUNC(Pa_GetErrorText);
  97         LOAD_FUNC(Pa_StartStream);
  98         LOAD_FUNC(Pa_StopStream);
  99         LOAD_FUNC(Pa_OpenStream);
 100         LOAD_FUNC(Pa_CloseStream);
 101         LOAD_FUNC(Pa_GetDefaultOutputDevice);
 102         LOAD_FUNC(Pa_GetDefaultInputDevice);
 103         LOAD_FUNC(Pa_GetStreamInfo);
 104 #undef LOAD_FUNC
 105
 106         if((err=Pa_Initialize()) != paNoError)
 107         {
 108             ERR("Pa_Initialize() returned an error: %s\n", Pa_GetErrorText(err));
 109             CloseLib(pa_handle);
 110             pa_handle = NULL;
 111             return ALC_FALSE;
 112         }
 113     }
 114 #else
 115     if((err=Pa_Initialize()) != paNoError)
 116     {
 117         ERR("Pa_Initialize() returned an error: %s\n", Pa_GetErrorText(err));
 118         return ALC_FALSE;
 119     }
 120 #endif
 121     return ALC_TRUE;
 122 }
 123
 124
 125 typedef struct {
 126     PaStream *stream;
 127     PaStreamParameters params;
 128     ALuint update_size;
 129
 130     RingBuffer *ring;
 131 } pa_data;
 132
 133
 134 static int pa_callback(const void *UNUSED(inputBuffer), void *outputBuffer,
 135                        unsigned long framesPerBuffer, const PaStreamCallbackTimeInfo *UNUSED(timeInfo),
 136                        const PaStreamCallbackFlags UNUSED(statusFlags), void *userData)
 137 {
 138     ALCdevice *device = (ALCdevice*)userData;
 139
 140     aluMixData(device, outputBuffer, framesPerBuffer);
 141     return 0;
 142 }
 143
 144 static int pa_capture_cb(const void *inputBuffer, void *UNUSED(outputBuffer),
 145                          unsigned long framesPerBuffer, const PaStreamCallbackTimeInfo *UNUSED(timeInfo),
 146                          const PaStreamCallbackFlags UNUSED(statusFlags), void *userData)
 147 {
 148     ALCdevice *device = (ALCdevice*)userData;
 149     pa_data *data = (pa_data*)device->ExtraData;
 150
 151     WriteRingBuffer(data->ring, inputBuffer, framesPerBuffer);
 152     return 0;
 153 }
 154
 155
 156 static ALCenum pa_open_playback(ALCdevice *device, const ALCchar *deviceName)
 157 {
 158     pa_data *data;
 159     PaError err;
 160
 161     if(!deviceName)
 162         deviceName = pa_device;
 163     else if(strcmp(deviceName, pa_device) != 0)
 164         return ALC_INVALID_VALUE;
 165
 166     data = (pa_data*)calloc(1, sizeof(pa_data));
 167     data->update_size = device->UpdateSize;
 168
 169     data->params.device = -1;
 170     if(!ConfigValueInt("port", "device", &data->params.device) ||
 171        data->params.device < 0)
 172         data->params.device = Pa_GetDefaultOutputDevice();
 173     data->params.suggestedLatency = (device->UpdateSize*device->NumUpdates) /
 174                                     (float)device->Frequency;
 175     data->params.hostApiSpecificStreamInfo = NULL;
 176
 177     data->params.channelCount = ((device->FmtChans == DevFmtMono) ? 1 : 2);
 178
 179     switch(device->FmtType)
 180     {
 181         case DevFmtByte:
 182             data->params.sampleFormat = paInt8;
 183             break;
 184         case DevFmtUByte:
 185             data->params.sampleFormat = paUInt8;
 186             break;
 187         case DevFmtUShort:
 188             /* fall-through */
 189         case DevFmtShort:
 190             data->params.sampleFormat = paInt16;
 191             break;
 192         case DevFmtUInt:
 193             /* fall-through */
 194         case DevFmtInt:
 195             data->params.sampleFormat = paInt32;
 196             break;
 197         case DevFmtFloat:
 198             data->params.sampleFormat = paFloat32;
 199             break;
 200     }
 201
 202 retry_open:
 203     err = Pa_OpenStream(&data->stream, NULL, &data->params, device->Frequency,
 204                         device->UpdateSize, paNoFlag, pa_callback, device);
 205     if(err != paNoError)
 206     {
 207         if(data->params.sampleFormat == paFloat32)
 208         {
 209             data->params.sampleFormat = paInt16;
 210             goto retry_open;
 211         }
 212         ERR("Pa_OpenStream() returned an error: %s\n", Pa_GetErrorText(err));
 213         free(data);
 214         return ALC_INVALID_VALUE;
 215     }
 216
 217     device->ExtraData = data;
 218     al_string_copy_cstr(&device->DeviceName, deviceName);
 219
 220     return ALC_NO_ERROR;
 221 }
 222
 223 static void pa_close_playback(ALCdevice *device)
 224 {
 225     pa_data *data = (pa_data*)device->ExtraData;
 226     PaError err;
 227
 228     err = Pa_CloseStream(data->stream);
 229     if(err != paNoError)
 230         ERR("Error closing stream: %s\n", Pa_GetErrorText(err));
 231
 232     free(data);
 233     device->ExtraData = NULL;
 234 }
 235
 236 static ALCboolean pa_reset_playback(ALCdevice *device)
 237 {
 238     pa_data *data = (pa_data*)device->ExtraData;
 239     const PaStreamInfo *streamInfo;
 240
 241     streamInfo = Pa_GetStreamInfo(data->stream);
 242     device->Frequency = streamInfo->sampleRate;
 243     device->UpdateSize = data->update_size;
 244
 245     if(data->params.sampleFormat == paInt8)
 246         device->FmtType = DevFmtByte;
 247     else if(data->params.sampleFormat == paUInt8)
 248         device->FmtType = DevFmtUByte;
 249     else if(data->params.sampleFormat == paInt16)
 250         device->FmtType = DevFmtShort;
 251     else if(data->params.sampleFormat == paInt32)
 252         device->FmtType = DevFmtInt;
 253     else if(data->params.sampleFormat == paFloat32)
 254         device->FmtType = DevFmtFloat;
 255     else
 256     {
 257         ERR("Unexpected sample format: 0x%lx\n", data->params.sampleFormat);
 258         return ALC_FALSE;
 259     }
 260
 261     if(data->params.channelCount == 2)
 262         device->FmtChans = DevFmtStereo;
 263     else if(data->params.channelCount == 1)
 264         device->FmtChans = DevFmtMono;
 265     else
 266     {
 267         ERR("Unexpected channel count: %u\n", data->params.channelCount);
 268         return ALC_FALSE;
 269     }
 270     SetDefaultChannelOrder(device);
 271
 272     return ALC_TRUE;
 273 }
 274
 275 static ALCboolean pa_start_playback(ALCdevice *device)
 276 {
 277     pa_data *data = (pa_data*)device->ExtraData;
 278     PaError err;
 279
 280     err = Pa_StartStream(data->stream);
 281     if(err != paNoError)
 282     {
 283         ERR("Pa_StartStream() returned an error: %s\n", Pa_GetErrorText(err));
 284         return ALC_FALSE;
 285     }
 286
 287     return ALC_TRUE;
 288 }
 289
 290 static void pa_stop_playback(ALCdevice *device)
 291 {
 292     pa_data *data = (pa_data*)device->ExtraData;
 293     PaError err;
 294
 295     err = Pa_StopStream(data->stream);
 296     if(err != paNoError)
 297         ERR("Error stopping stream: %s\n", Pa_GetErrorText(err));
 298 }
 299
 300
 301 static ALCenum pa_open_capture(ALCdevice *device, const ALCchar *deviceName)
 302 {
 303     ALuint frame_size;
 304     pa_data *data;
 305     PaError err;
 306
 307     if(!deviceName)
 308         deviceName = pa_device;
 309     else if(strcmp(deviceName, pa_device) != 0)
 310         return ALC_INVALID_VALUE;
 311
 312     data = (pa_data*)calloc(1, sizeof(pa_data));
 313     if(data == NULL)
 314         return ALC_OUT_OF_MEMORY;
 315
 316     frame_size = FrameSizeFromDevFmt(device->FmtChans, device->FmtType);
 317     data->ring = CreateRingBuffer(frame_size, device->UpdateSize*device->NumUpdates);
 318     if(data->ring == NULL)
 319         goto error;
 320
 321     data->params.device = -1;
 322     if(!ConfigValueInt("port", "capture", &data->params.device) ||
 323        data->params.device < 0)
 324         data->params.device = Pa_GetDefaultInputDevice();
 325     data->params.suggestedLatency = 0.0f;
 326     data->params.hostApiSpecificStreamInfo = NULL;
 327
 328     switch(device->FmtType)
 329     {
 330         case DevFmtByte:
 331             data->params.sampleFormat = paInt8;
 332             break;
 333         case DevFmtUByte:
 334             data->params.sampleFormat = paUInt8;
 335             break;
 336         case DevFmtShort:
 337             data->params.sampleFormat = paInt16;
 338             break;
 339         case DevFmtInt:
 340             data->params.sampleFormat = paInt32;
 341             break;
 342         case DevFmtFloat:
 343             data->params.sampleFormat = paFloat32;
 344             break;
 345         case DevFmtUInt:
 346         case DevFmtUShort:
 347             ERR("%s samples not supported\n", DevFmtTypeString(device->FmtType));
 348             goto error;
 349     }
 350     data->params.channelCount = ChannelsFromDevFmt(device->FmtChans);
 351
 352     err = Pa_OpenStream(&data->stream, &data->params, NULL, device->Frequency,
 353                         paFramesPerBufferUnspecified, paNoFlag, pa_capture_cb, device);
 354     if(err != paNoError)
 355     {
 356         ERR("Pa_OpenStream() returned an error: %s\n", Pa_GetErrorText(err));
 357         goto error;
 358     }
 359
 360     al_string_copy_cstr(&device->DeviceName, deviceName);
 361
 362     device->ExtraData = data;
 363     return ALC_NO_ERROR;
 364
 365 error:
 366     DestroyRingBuffer(data->ring);
 367     free(data);
 368     return ALC_INVALID_VALUE;
 369 }
 370
 371 static void pa_close_capture(ALCdevice *device)
 372 {
 373     pa_data *data = (pa_data*)device->ExtraData;
 374     PaError err;
 375
 376     err = Pa_CloseStream(data->stream);
 377     if(err != paNoError)
 378         ERR("Error closing stream: %s\n", Pa_GetErrorText(err));
 379
 380     DestroyRingBuffer(data->ring);
 381     data->ring = NULL;
 382
 383     free(data);
 384     device->ExtraData = NULL;
 385 }
 386
 387 static void pa_start_capture(ALCdevice *device)
 388 {
 389     pa_data *data = device->ExtraData;
 390     PaError err;
 391
 392     err = Pa_StartStream(data->stream);
 393     if(err != paNoError)
 394         ERR("Error starting stream: %s\n", Pa_GetErrorText(err));
 395 }
 396
 397 static void pa_stop_capture(ALCdevice *device)
 398 {
 399     pa_data *data = (pa_data*)device->ExtraData;
 400     PaError err;
 401
 402     err = Pa_StopStream(data->stream);
 403     if(err != paNoError)
 404         ERR("Error stopping stream: %s\n", Pa_GetErrorText(err));
 405 }
 406
 407 static ALCenum pa_capture_samples(ALCdevice *device, ALCvoid *buffer, ALCuint samples)
 408 {
 409     pa_data *data = device->ExtraData;
 410     ReadRingBuffer(data->ring, buffer, samples);
 411     return ALC_NO_ERROR;
 412 }
 413
 414 static ALCuint pa_available_samples(ALCdevice *device)
 415 {
 416     pa_data *data = device->ExtraData;
 417     return RingBufferSize(data->ring);
 418 }
 419
 420
 421 static const BackendFuncs pa_funcs = {
 422     pa_open_playback,
 423     pa_close_playback,
 424     pa_reset_playback,
 425     pa_start_playback,
 426     pa_stop_playback,
 427     pa_open_capture,
 428     pa_close_capture,
 429     pa_start_capture,
 430     pa_stop_capture,
 431     pa_capture_samples,
 432     pa_available_samples
 433 };
 434
 435 ALCboolean alc_pa_init(BackendFuncs *func_list)
 436 {
 437     if(!pa_load())
 438         return ALC_FALSE;
 439     *func_list = pa_funcs;
 440     return ALC_TRUE;
 441 }
 442
 443 void alc_pa_deinit(void)
 444 {
 445 #ifdef HAVE_DYNLOAD
 446     if(pa_handle)
 447     {
 448         Pa_Terminate();
 449         CloseLib(pa_handle);
 450         pa_handle = NULL;
 451     }
 452 #else
 453     Pa_Terminate();
 454 #endif
 455 }
 456
 457 void alc_pa_probe(enum DevProbe type)
 458 {
 459     switch(type)
 460     {
 461         case ALL_DEVICE_PROBE:
 462             AppendAllDevicesList(pa_device);
 463             break;
 464         case CAPTURE_DEVICE_PROBE:
 465             AppendCaptureDeviceList(pa_device);
 466             break;
 467     }
 468 }