RtAudio.h

   1 /************************************************************************/
   2 /*! \class RtAudio
   3     \brief Realtime audio i/o C++ classes.
   4
   5     RtAudio provides a common API (Application Programming Interface)
   6     for realtime audio input/output across Linux (native ALSA, Jack,
   7     and OSS), Macintosh OS X (CoreAudio and Jack), and Windows
   8     (DirectSound and ASIO) operating systems.
   9
  10     RtAudio WWW site: http://www.music.mcgill.ca/~gary/rtaudio/
  11
  12     RtAudio: realtime audio i/o C++ classes
  13     Copyright (c) 2001-2012 Gary P. Scavone
  14
  15     Permission is hereby granted, free of charge, to any person
  16     obtaining a copy of this software and associated documentation files
  17     (the "Software"), to deal in the Software without restriction,
  18     including without limitation the rights to use, copy, modify, merge,
  19     publish, distribute, sublicense, and/or sell copies of the Software,
  20     and to permit persons to whom the Software is furnished to do so,
  21     subject to the following conditions:
  22
  23     The above copyright notice and this permission notice shall be
  24     included in all copies or substantial portions of the Software.
  25
  26     Any person wishing to distribute modifications to the Software is
  27     asked to send the modifications to the original developer so that
  28     they can be incorporated into the canonical version.  This is,
  29     however, not a binding provision of this license.
  30
  31     THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
  32     EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
  33     MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
  34     IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR
  35     ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF
  36     CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
  37     WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  38 */
  39 /************************************************************************/
  40
  41 /*!
  42   \file RtAudio.h
  43  */
  44
  45 // RtAudio: Version 4.0.11
  46
  47 #ifndef __RTAUDIO_H
  48 #define __RTAUDIO_H
  49
  50 #include <string>
  51 #include <vector>
  52 #include "RtError.h"
  53
  54 /*! \typedef typedef unsigned long RtAudioFormat;
  55     \brief RtAudio data format type.
  56
  57     Support for signed integers and floats.  Audio data fed to/from an
  58     RtAudio stream is assumed to ALWAYS be in host byte order.  The
  59     internal routines will automatically take care of any necessary
  60     byte-swapping between the host format and the soundcard.  Thus,
  61     endian-ness is not a concern in the following format definitions.
  62     Note that 24-bit data is expected to be encapsulated in a 32-bit
  63     format.
  64
  65     - \e RTAUDIO_SINT8:   8-bit signed integer.
  66     - \e RTAUDIO_SINT16:  16-bit signed integer.
  67     - \e RTAUDIO_SINT24:  Lower 3 bytes of 32-bit signed integer.
  68     - \e RTAUDIO_SINT32:  32-bit signed integer.
  69     - \e RTAUDIO_FLOAT32: Normalized between plus/minus 1.0.
  70     - \e RTAUDIO_FLOAT64: Normalized between plus/minus 1.0.
  71 */
  72 typedef unsigned long RtAudioFormat;
  73 static const RtAudioFormat RTAUDIO_SINT8 = 0x1;    // 8-bit signed integer.
  74 static const RtAudioFormat RTAUDIO_SINT16 = 0x2;   // 16-bit signed integer.
  75 static const RtAudioFormat RTAUDIO_SINT24 = 0x4;   // Lower 3 bytes of 32-bit signed integer.
  76 static const RtAudioFormat RTAUDIO_SINT32 = 0x8;   // 32-bit signed integer.
  77 static const RtAudioFormat RTAUDIO_FLOAT32 = 0x10; // Normalized between plus/minus 1.0.
  78 static const RtAudioFormat RTAUDIO_FLOAT64 = 0x20; // Normalized between plus/minus 1.0.
  79
  80 /*! \typedef typedef unsigned long RtAudioStreamFlags;
  81     \brief RtAudio stream option flags.
  82
  83     The following flags can be OR'ed together to allow a client to
  84     make changes to the default stream behavior:
  85
  86     - \e RTAUDIO_NONINTERLEAVED:   Use non-interleaved buffers (default = interleaved).
  87     - \e RTAUDIO_MINIMIZE_LATENCY: Attempt to set stream parameters for lowest possible latency.
  88     - \e RTAUDIO_HOG_DEVICE:       Attempt grab device for exclusive use.
  89     - \e RTAUDIO_ALSA_USE_DEFAULT: Use the "default" PCM device (ALSA only).
  90
  91     By default, RtAudio streams pass and receive audio data from the
  92     client in an interleaved format.  By passing the
  93     RTAUDIO_NONINTERLEAVED flag to the openStream() function, audio
  94     data will instead be presented in non-interleaved buffers.  In
  95     this case, each buffer argument in the RtAudioCallback function
  96     will point to a single array of data, with \c nFrames samples for
  97     each channel concatenated back-to-back.  For example, the first
  98     sample of data for the second channel would be located at index \c
  99     nFrames (assuming the \c buffer pointer was recast to the correct
 100     data type for the stream).
 101
 102     Certain audio APIs offer a number of parameters that influence the
 103     I/O latency of a stream.  By default, RtAudio will attempt to set
 104     these parameters internally for robust (glitch-free) performance
 105     (though some APIs, like Windows Direct Sound, make this difficult).
 106     By passing the RTAUDIO_MINIMIZE_LATENCY flag to the openStream()
 107     function, internal stream settings will be influenced in an attempt
 108     to minimize stream latency, though possibly at the expense of stream
 109     performance.
 110
 111     If the RTAUDIO_HOG_DEVICE flag is set, RtAudio will attempt to
 112     open the input and/or output stream device(s) for exclusive use.
 113     Note that this is not possible with all supported audio APIs.
 114
 115     If the RTAUDIO_SCHEDULE_REALTIME flag is set, RtAudio will attempt
 116     to select realtime scheduling (round-robin) for the callback thread.
 117
 118     If the RTAUDIO_ALSA_USE_DEFAULT flag is set, RtAudio will attempt to
 119     open the "default" PCM device when using the ALSA API. Note that this
 120     will override any specified input or output device id.
 121 */
 122 typedef unsigned int RtAudioStreamFlags;
 123 static const RtAudioStreamFlags RTAUDIO_NONINTERLEAVED = 0x1;    // Use non-interleaved buffers (default = interleaved).
 124 static const RtAudioStreamFlags RTAUDIO_MINIMIZE_LATENCY = 0x2;  // Attempt to set stream parameters for lowest possible latency.
 125 static const RtAudioStreamFlags RTAUDIO_HOG_DEVICE = 0x4;        // Attempt grab device and prevent use by others.
 126 static const RtAudioStreamFlags RTAUDIO_SCHEDULE_REALTIME = 0x8; // Try to select realtime scheduling for callback thread.
 127 static const RtAudioStreamFlags RTAUDIO_ALSA_USE_DEFAULT = 0x10; // Use the "default" PCM device (ALSA only).
 128
 129 /*! \typedef typedef unsigned long RtAudioStreamStatus;
 130     \brief RtAudio stream status (over- or underflow) flags.
 131
 132     Notification of a stream over- or underflow is indicated by a
 133     non-zero stream \c status argument in the RtAudioCallback function.
 134     The stream status can be one of the following two options,
 135     depending on whether the stream is open for output and/or input:
 136
 137     - \e RTAUDIO_INPUT_OVERFLOW:   Input data was discarded because of an overflow condition at the driver.
 138     - \e RTAUDIO_OUTPUT_UNDERFLOW: The output buffer ran low, likely producing a break in the output sound.
 139 */
 140 typedef unsigned int RtAudioStreamStatus;
 141 static const RtAudioStreamStatus RTAUDIO_INPUT_OVERFLOW = 0x1;    // Input data was discarded because of an overflow condition at the driver.
 142 static const RtAudioStreamStatus RTAUDIO_OUTPUT_UNDERFLOW = 0x2;  // The output buffer ran low, likely causing a gap in the output sound.
 143
 144 //! RtAudio callback function prototype.
 145 /*!
 146    All RtAudio clients must create a function of type RtAudioCallback
 147    to read and/or write data from/to the audio stream.  When the
 148    underlying audio system is ready for new input or output data, this
 149    function will be invoked.
 150
 151    \param outputBuffer For output (or duplex) streams, the client
 152           should write \c nFrames of audio sample frames into this
 153           buffer.  This argument should be recast to the datatype
 154           specified when the stream was opened.  For input-only
 155           streams, this argument will be NULL.
 156
 157    \param inputBuffer For input (or duplex) streams, this buffer will
 158           hold \c nFrames of input audio sample frames.  This
 159           argument should be recast to the datatype specified when the
 160           stream was opened.  For output-only streams, this argument
 161           will be NULL.
 162
 163    \param nFrames The number of sample frames of input or output
 164           data in the buffers.  The actual buffer size in bytes is
 165           dependent on the data type and number of channels in use.
 166
 167    \param streamTime The number of seconds that have elapsed since the
 168           stream was started.
 169
 170    \param status If non-zero, this argument indicates a data overflow
 171           or underflow condition for the stream.  The particular
 172           condition can be determined by comparison with the
 173           RtAudioStreamStatus flags.
 174
 175    \param userData A pointer to optional data provided by the client
 176           when opening the stream (default = NULL).
 177
 178    To continue normal stream operation, the RtAudioCallback function
 179    should return a value of zero.  To stop the stream and drain the
 180    output buffer, the function should return a value of one.  To abort
 181    the stream immediately, the client should return a value of two.
 182  */
 183 typedef int (*RtAudioCallback)( void *outputBuffer, void *inputBuffer,
 184                                 unsigned int nFrames,
 185                                 double streamTime,
 186                                 RtAudioStreamStatus status,
 187                                 void *userData );
 188
 189
 190 // **************************************************************** //
 191 //
 192 // RtAudio class declaration.
 193 //
 194 // RtAudio is a "controller" used to select an available audio i/o
 195 // interface.  It presents a common API for the user to call but all
 196 // functionality is implemented by the class RtApi and its
 197 // subclasses.  RtAudio creates an instance of an RtApi subclass
 198 // based on the user's API choice.  If no choice is made, RtAudio
 199 // attempts to make a "logical" API selection.
 200 //
 201 // **************************************************************** //
 202
 203 class RtApi;
 204
 205 class RtAudio
 206 {
 207  public:
 208
 209   //! Audio API specifier arguments.
 210   enum Api {
 211     UNSPECIFIED,    /*!< Search for a working compiled API. */
 212     LINUX_ALSA,     /*!< The Advanced Linux Sound Architecture API. */
 213     LINUX_PULSE,    /*!< The Linux PulseAudio API. */
 214     LINUX_OSS,      /*!< The Linux Open Sound System API. */
 215     UNIX_JACK,      /*!< The Jack Low-Latency Audio Server API. */
 216     MACOSX_CORE,    /*!< Macintosh OS-X Core Audio API. */
 217     WINDOWS_ASIO,   /*!< The Steinberg Audio Stream I/O API. */
 218     WINDOWS_DS,     /*!< The Microsoft Direct Sound API. */
 219     RTAUDIO_DUMMY   /*!< A compilable but non-functional API. */
 220   };
 221
 222   //! The public device information structure for returning queried values.
 223   struct DeviceInfo {
 224     bool probed;                  /*!< true if the device capabilities were successfully probed. */
 225     std::string name;             /*!< Character string device identifier. */
 226     unsigned int outputChannels;  /*!< Maximum output channels supported by device. */
 227     unsigned int inputChannels;   /*!< Maximum input channels supported by device. */
 228     unsigned int duplexChannels;  /*!< Maximum simultaneous input/output channels supported by device. */
 229     bool isDefaultOutput;         /*!< true if this is the default output device. */
 230     bool isDefaultInput;          /*!< true if this is the default input device. */
 231     std::vector<unsigned int> sampleRates; /*!< Supported sample rates (queried from list of standard rates). */
 232     RtAudioFormat nativeFormats;  /*!< Bit mask of supported data formats. */
 233
 234     // Default constructor.
 235     DeviceInfo()
 236       :probed(false), outputChannels(0), inputChannels(0), duplexChannels(0),
 237        isDefaultOutput(false), isDefaultInput(false), nativeFormats(0) {}
 238   };
 239
 240   //! The structure for specifying input or ouput stream parameters.
 241   struct StreamParameters {
 242     unsigned int deviceId;     /*!< Device index (0 to getDeviceCount() - 1). */
 243     unsigned int nChannels;    /*!< Number of channels. */
 244     unsigned int firstChannel; /*!< First channel index on device (default = 0). */
 245
 246     // Default constructor.
 247     StreamParameters()
 248       : deviceId(0), nChannels(0), firstChannel(0) {}
 249   };
 250
 251   //! The structure for specifying stream options.
 252   /*!
 253     The following flags can be OR'ed together to allow a client to
 254     make changes to the default stream behavior:
 255
 256     - \e RTAUDIO_NONINTERLEAVED:    Use non-interleaved buffers (default = interleaved).
 257     - \e RTAUDIO_MINIMIZE_LATENCY:  Attempt to set stream parameters for lowest possible latency.
 258     - \e RTAUDIO_HOG_DEVICE:        Attempt grab device for exclusive use.
 259     - \e RTAUDIO_SCHEDULE_REALTIME: Attempt to select realtime scheduling for callback thread.
 260     - \e RTAUDIO_ALSA_USE_DEFAULT:  Use the "default" PCM device (ALSA only).
 261
 262     By default, RtAudio streams pass and receive audio data from the
 263     client in an interleaved format.  By passing the
 264     RTAUDIO_NONINTERLEAVED flag to the openStream() function, audio
 265     data will instead be presented in non-interleaved buffers.  In
 266     this case, each buffer argument in the RtAudioCallback function
 267     will point to a single array of data, with \c nFrames samples for
 268     each channel concatenated back-to-back.  For example, the first
 269     sample of data for the second channel would be located at index \c
 270     nFrames (assuming the \c buffer pointer was recast to the correct
 271     data type for the stream).
 272
 273     Certain audio APIs offer a number of parameters that influence the
 274     I/O latency of a stream.  By default, RtAudio will attempt to set
 275     these parameters internally for robust (glitch-free) performance
 276     (though some APIs, like Windows Direct Sound, make this difficult).
 277     By passing the RTAUDIO_MINIMIZE_LATENCY flag to the openStream()
 278     function, internal stream settings will be influenced in an attempt
 279     to minimize stream latency, though possibly at the expense of stream
 280     performance.
 281
 282     If the RTAUDIO_HOG_DEVICE flag is set, RtAudio will attempt to
 283     open the input and/or output stream device(s) for exclusive use.
 284     Note that this is not possible with all supported audio APIs.
 285
 286     If the RTAUDIO_SCHEDULE_REALTIME flag is set, RtAudio will attempt
 287     to select realtime scheduling (round-robin) for the callback thread.
 288     The \c priority parameter will only be used if the RTAUDIO_SCHEDULE_REALTIME
 289     flag is set. It defines the thread's realtime priority.
 290
 291     If the RTAUDIO_ALSA_USE_DEFAULT flag is set, RtAudio will attempt to
 292     open the "default" PCM device when using the ALSA API. Note that this
 293     will override any specified input or output device id.
 294
 295     The \c numberOfBuffers parameter can be used to control stream
 296     latency in the Windows DirectSound, Linux OSS, and Linux Alsa APIs
 297     only.  A value of two is usually the smallest allowed.  Larger
 298     numbers can potentially result in more robust stream performance,
 299     though likely at the cost of stream latency.  The value set by the
 300     user is replaced during execution of the RtAudio::openStream()
 301     function by the value actually used by the system.
 302
 303     The \c streamName parameter can be used to set the client name
 304     when using the Jack API.  By default, the client name is set to
 305     RtApiJack.  However, if you wish to create multiple instances of
 306     RtAudio with Jack, each instance must have a unique client name.
 307   */
 308   struct StreamOptions {
 309     RtAudioStreamFlags flags;      /*!< A bit-mask of stream flags (RTAUDIO_NONINTERLEAVED, RTAUDIO_MINIMIZE_LATENCY, RTAUDIO_HOG_DEVICE, RTAUDIO_ALSA_USE_DEFAULT). */
 310     unsigned int numberOfBuffers;  /*!< Number of stream buffers. */
 311     std::string streamName;        /*!< A stream name (currently used only in Jack). */
 312     int priority;                  /*!< Scheduling priority of callback thread (only used with flag RTAUDIO_SCHEDULE_REALTIME). */
 313
 314     // Default constructor.
 315     StreamOptions()
 316     : flags(0), numberOfBuffers(0), priority(0) {}
 317   };
 318
 319   //! A static function to determine the available compiled audio APIs.
 320   /*!
 321     The values returned in the std::vector can be compared against
 322     the enumerated list values.  Note that there can be more than one
 323     API compiled for certain operating systems.
 324   */
 325   static void getCompiledApi( std::vector<RtAudio::Api> &apis ) throw();
 326
 327   //! The class constructor.
 328   /*!
 329     The constructor performs minor initialization tasks.  No exceptions
 330     can be thrown.
 331
 332     If no API argument is specified and multiple API support has been
 333     compiled, the default order of use is JACK, ALSA, OSS (Linux
 334     systems) and ASIO, DS (Windows systems).
 335   */
 336   RtAudio( RtAudio::Api api=UNSPECIFIED ) throw();
 337
 338   //! The destructor.
 339   /*!
 340     If a stream is running or open, it will be stopped and closed
 341     automatically.
 342   */
 343   ~RtAudio() throw();
 344
 345   //! Returns the audio API specifier for the current instance of RtAudio.
 346   RtAudio::Api getCurrentApi( void ) throw();
 347
 348   //! A public function that queries for the number of audio devices available.
 349   /*!
 350     This function performs a system query of available devices each time it
 351     is called, thus supporting devices connected \e after instantiation. If
 352     a system error occurs during processing, a warning will be issued.
 353   */
 354   unsigned int getDeviceCount( void ) throw();
 355
 356   //! Return an RtAudio::DeviceInfo structure for a specified device number.
 357   /*!
 358
 359     Any device integer between 0 and getDeviceCount() - 1 is valid.
 360     If an invalid argument is provided, an RtError (type = INVALID_USE)
 361     will be thrown.  If a device is busy or otherwise unavailable, the
 362     structure member "probed" will have a value of "false" and all
 363     other members are undefined.  If the specified device is the
 364     current default input or output device, the corresponding
 365     "isDefault" member will have a value of "true".
 366   */
 367   RtAudio::DeviceInfo getDeviceInfo( unsigned int device );
 368
 369   //! A function that returns the index of the default output device.
 370   /*!
 371     If the underlying audio API does not provide a "default
 372     device", or if no devices are available, the return value will be
 373     0.  Note that this is a valid device identifier and it is the
 374     client's responsibility to verify that a device is available
 375     before attempting to open a stream.
 376   */
 377   unsigned int getDefaultOutputDevice( void ) throw();
 378
 379   //! A function that returns the index of the default input device.
 380   /*!
 381     If the underlying audio API does not provide a "default
 382     device", or if no devices are available, the return value will be
 383     0.  Note that this is a valid device identifier and it is the
 384     client's responsibility to verify that a device is available
 385     before attempting to open a stream.
 386   */
 387   unsigned int getDefaultInputDevice( void ) throw();
 388
 389   //! A public function for opening a stream with the specified parameters.
 390   /*!
 391     An RtError (type = SYSTEM_ERROR) is thrown if a stream cannot be
 392     opened with the specified parameters or an error occurs during
 393     processing.  An RtError (type = INVALID_USE) is thrown if any
 394     invalid device ID or channel number parameters are specified.
 395
 396     \param outputParameters Specifies output stream parameters to use
 397            when opening a stream, including a device ID, number of channels,
 398            and starting channel number.  For input-only streams, this
 399            argument should be NULL.  The device ID is an index value between
 400            0 and getDeviceCount() - 1.
 401     \param inputParameters Specifies input stream parameters to use
 402            when opening a stream, including a device ID, number of channels,
 403            and starting channel number.  For output-only streams, this
 404            argument should be NULL.  The device ID is an index value between
 405            0 and getDeviceCount() - 1.
 406     \param format An RtAudioFormat specifying the desired sample data format.
 407     \param sampleRate The desired sample rate (sample frames per second).
 408     \param *bufferFrames A pointer to a value indicating the desired
 409            internal buffer size in sample frames.  The actual value
 410            used by the device is returned via the same pointer.  A
 411            value of zero can be specified, in which case the lowest
 412            allowable value is determined.
 413     \param callback A client-defined function that will be invoked
 414            when input data is available and/or output data is needed.
 415     \param userData An optional pointer to data that can be accessed
 416            from within the callback function.
 417     \param options An optional pointer to a structure containing various
 418            global stream options, including a list of OR'ed RtAudioStreamFlags
 419            and a suggested number of stream buffers that can be used to
 420            control stream latency.  More buffers typically result in more
 421            robust performance, though at a cost of greater latency.  If a
 422            value of zero is specified, a system-specific median value is
 423            chosen.  If the RTAUDIO_MINIMIZE_LATENCY flag bit is set, the
 424            lowest allowable value is used.  The actual value used is
 425            returned via the structure argument.  The parameter is API dependent.
 426   */
 427   void openStream( RtAudio::StreamParameters *outputParameters,
 428                    RtAudio::StreamParameters *inputParameters,
 429                    RtAudioFormat format, unsigned int sampleRate,
 430                    unsigned int *bufferFrames, RtAudioCallback callback,
 431                    void *userData = NULL, RtAudio::StreamOptions *options = NULL );
 432
 433   //! A function that closes a stream and frees any associated stream memory.
 434   /*!
 435     If a stream is not open, this function issues a warning and
 436     returns (no exception is thrown).
 437   */
 438   void closeStream( void ) throw();
 439
 440   //! A function that starts a stream.
 441   /*!
 442     An RtError (type = SYSTEM_ERROR) is thrown if an error occurs
 443     during processing.  An RtError (type = INVALID_USE) is thrown if a
 444     stream is not open.  A warning is issued if the stream is already
 445     running.
 446   */
 447   void startStream( void );
 448
 449   //! Stop a stream, allowing any samples remaining in the output queue to be played.
 450   /*!
 451     An RtError (type = SYSTEM_ERROR) is thrown if an error occurs
 452     during processing.  An RtError (type = INVALID_USE) is thrown if a
 453     stream is not open.  A warning is issued if the stream is already
 454     stopped.
 455   */
 456   void stopStream( void );
 457
 458   //! Stop a stream, discarding any samples remaining in the input/output queue.
 459   /*!
 460     An RtError (type = SYSTEM_ERROR) is thrown if an error occurs
 461     during processing.  An RtError (type = INVALID_USE) is thrown if a
 462     stream is not open.  A warning is issued if the stream is already
 463     stopped.
 464   */
 465   void abortStream( void );
 466
 467   //! Returns true if a stream is open and false if not.
 468   bool isStreamOpen( void ) const throw();
 469
 470   //! Returns true if the stream is running and false if it is stopped or not open.
 471   bool isStreamRunning( void ) const throw();
 472
 473   //! Returns the number of elapsed seconds since the stream was started.
 474   /*!
 475     If a stream is not open, an RtError (type = INVALID_USE) will be thrown.
 476   */
 477   double getStreamTime( void );
 478
 479   //! Returns the internal stream latency in sample frames.
 480   /*!
 481     The stream latency refers to delay in audio input and/or output
 482     caused by internal buffering by the audio system and/or hardware.
 483     For duplex streams, the returned value will represent the sum of
 484     the input and output latencies.  If a stream is not open, an
 485     RtError (type = INVALID_USE) will be thrown.  If the API does not
 486     report latency, the return value will be zero.
 487   */
 488   long getStreamLatency( void );
 489
 490  //! Returns actual sample rate in use by the stream.
 491  /*!
 492    On some systems, the sample rate used may be slightly different
 493    than that specified in the stream parameters.  If a stream is not
 494    open, an RtError (type = INVALID_USE) will be thrown.
 495  */
 496   unsigned int getStreamSampleRate( void );
 497
 498   //! Specify whether warning messages should be printed to stderr.
 499   void showWarnings( bool value = true ) throw();
 500
 501  protected:
 502
 503   void openRtApi( RtAudio::Api api );
 504   RtApi *rtapi_;
 505 };
 506
 507 // Operating system dependent thread functionality.
 508 #if defined(__WINDOWS_DS__) || defined(__WINDOWS_ASIO__)
 509   #include <windows.h>
 510   #include <process.h>
 511
 512   typedef unsigned long ThreadHandle;
 513   typedef CRITICAL_SECTION StreamMutex;
 514
 515 #elif defined(__LINUX_ALSA__) || defined(__LINUX_PULSE__) || defined(__UNIX_JACK__) || defined(__LINUX_OSS__) || defined(__MACOSX_CORE__)
 516   // Using pthread library for various flavors of unix.
 517   #include <pthread.h>
 518
 519   typedef pthread_t ThreadHandle;
 520   typedef pthread_mutex_t StreamMutex;
 521
 522 #else // Setup for "dummy" behavior
 523
 524   #define __RTAUDIO_DUMMY__
 525   typedef int ThreadHandle;
 526   typedef int StreamMutex;
 527
 528 #endif
 529
 530 // This global structure type is used to pass callback information
 531 // between the private RtAudio stream structure and global callback
 532 // handling functions.
 533 struct CallbackInfo {
 534   void *object;    // Used as a "this" pointer.
 535   ThreadHandle thread;
 536   void *callback;
 537   void *userData;
 538   void *apiInfo;   // void pointer for API specific callback information
 539   bool isRunning;
 540
 541   // Default constructor.
 542   CallbackInfo()
 543     :object(0), callback(0), userData(0), apiInfo(0), isRunning(false) {}
 544 };
 545
 546 // **************************************************************** //
 547 //
 548 // RtApi class declaration.
 549 //
 550 // Subclasses of RtApi contain all API- and OS-specific code necessary
 551 // to fully implement the RtAudio API.
 552 //
 553 // Note that RtApi is an abstract base class and cannot be
 554 // explicitly instantiated.  The class RtAudio will create an
 555 // instance of an RtApi subclass (RtApiOss, RtApiAlsa,
 556 // RtApiJack, RtApiCore, RtApiDs, or RtApiAsio).
 557 //
 558 // **************************************************************** //
 559
 560 #if defined( HAVE_GETTIMEOFDAY )
 561   #include <sys/time.h>
 562 #endif
 563
 564 #include <sstream>
 565
 566 class RtApi
 567 {
 568 public:
 569
 570   RtApi();
 571   virtual ~RtApi();
 572   virtual RtAudio::Api getCurrentApi( void ) = 0;
 573   virtual unsigned int getDeviceCount( void ) = 0;
 574   virtual RtAudio::DeviceInfo getDeviceInfo( unsigned int device ) = 0;
 575   virtual unsigned int getDefaultInputDevice( void );
 576   virtual unsigned int getDefaultOutputDevice( void );
 577   void openStream( RtAudio::StreamParameters *outputParameters,
 578                    RtAudio::StreamParameters *inputParameters,
 579                    RtAudioFormat format, unsigned int sampleRate,
 580                    unsigned int *bufferFrames, RtAudioCallback callback,
 581                    void *userData, RtAudio::StreamOptions *options );
 582   virtual void closeStream( void );
 583   virtual void startStream( void ) = 0;
 584   virtual void stopStream( void ) = 0;
 585   virtual void abortStream( void ) = 0;
 586   long getStreamLatency( void );
 587   unsigned int getStreamSampleRate( void );
 588   virtual double getStreamTime( void );
 589   bool isStreamOpen( void ) const { return stream_.state != STREAM_CLOSED; };
 590   bool isStreamRunning( void ) const { return stream_.state == STREAM_RUNNING; };
 591   void showWarnings( bool value ) { showWarnings_ = value; };
 592
 593
 594 protected:
 595
 596   static const unsigned int MAX_SAMPLE_RATES;
 597   static const unsigned int SAMPLE_RATES[];
 598
 599   enum { FAILURE, SUCCESS };
 600
 601   enum StreamState {
 602     STREAM_STOPPED,
 603     STREAM_STOPPING,
 604     STREAM_RUNNING,
 605     STREAM_CLOSED = -50
 606   };
 607
 608   enum StreamMode {
 609     OUTPUT,
 610     INPUT,
 611     DUPLEX,
 612     UNINITIALIZED = -75
 613   };
 614
 615   // A protected structure used for buffer conversion.
 616   struct ConvertInfo {
 617     int channels;
 618     int inJump, outJump;
 619     RtAudioFormat inFormat, outFormat;
 620     std::vector<int> inOffset;
 621     std::vector<int> outOffset;
 622   };
 623
 624   // A protected structure for audio streams.
 625   struct RtApiStream {
 626     unsigned int device[2];    // Playback and record, respectively.
 627     void *apiHandle;           // void pointer for API specific stream handle information
 628     StreamMode mode;           // OUTPUT, INPUT, or DUPLEX.
 629     StreamState state;         // STOPPED, RUNNING, or CLOSED
 630     char *userBuffer[2];       // Playback and record, respectively.
 631     char *deviceBuffer;
 632     bool doConvertBuffer[2];   // Playback and record, respectively.
 633     bool userInterleaved;
 634     bool deviceInterleaved[2]; // Playback and record, respectively.
 635     bool doByteSwap[2];        // Playback and record, respectively.
 636     unsigned int sampleRate;
 637     unsigned int bufferSize;
 638     unsigned int nBuffers;
 639     unsigned int nUserChannels[2];    // Playback and record, respectively.
 640     unsigned int nDeviceChannels[2];  // Playback and record channels, respectively.
 641     unsigned int channelOffset[2];    // Playback and record, respectively.
 642     unsigned long latency[2];         // Playback and record, respectively.
 643     RtAudioFormat userFormat;
 644     RtAudioFormat deviceFormat[2];    // Playback and record, respectively.
 645     StreamMutex mutex;
 646     CallbackInfo callbackInfo;
 647     ConvertInfo convertInfo[2];
 648     double streamTime;         // Number of elapsed seconds since the stream started.
 649
 650 #if defined(HAVE_GETTIMEOFDAY)
 651     struct timeval lastTickTimestamp;
 652 #endif
 653
 654     RtApiStream()
 655       :apiHandle(0), deviceBuffer(0) { device[0] = 11111; device[1] = 11111; }
 656   };
 657
 658   typedef signed short Int16;
 659   typedef signed int Int32;
 660   typedef float Float32;
 661   typedef double Float64;
 662
 663   std::ostringstream errorStream_;
 664   std::string errorText_;
 665   bool showWarnings_;
 666   RtApiStream stream_;
 667
 668   /*!
 669     Protected, api-specific method that attempts to open a device
 670     with the given parameters.  This function MUST be implemented by
 671     all subclasses.  If an error is encountered during the probe, a
 672     "warning" message is reported and FAILURE is returned. A
 673     successful probe is indicated by a return value of SUCCESS.
 674   */
 675   virtual bool probeDeviceOpen( unsigned int device, StreamMode mode, unsigned int channels,
 676                                 unsigned int firstChannel, unsigned int sampleRate,
 677                                 RtAudioFormat format, unsigned int *bufferSize,
 678                                 RtAudio::StreamOptions *options );
 679
 680   //! A protected function used to increment the stream time.
 681   void tickStreamTime( void );
 682
 683   //! Protected common method to clear an RtApiStream structure.
 684   void clearStreamInfo();
 685
 686   /*!
 687     Protected common method that throws an RtError (type =
 688     INVALID_USE) if a stream is not open.
 689   */
 690   void verifyStream( void );
 691
 692   //! Protected common error method to allow global control over error handling.
 693   void error( RtError::Type type );
 694
 695   /*!
 696     Protected method used to perform format, channel number, and/or interleaving
 697     conversions between the user and device buffers.
 698   */
 699   void convertBuffer( char *outBuffer, char *inBuffer, ConvertInfo &info );
 700
 701   //! Protected common method used to perform byte-swapping on buffers.
 702   void byteSwapBuffer( char *buffer, unsigned int samples, RtAudioFormat format );
 703
 704   //! Protected common method that returns the number of bytes for a given format.
 705   unsigned int formatBytes( RtAudioFormat format );
 706
 707   //! Protected common method that sets up the parameters for buffer conversion.
 708   void setConvertInfo( StreamMode mode, unsigned int firstChannel );
 709 };
 710
 711 // **************************************************************** //
 712 //
 713 // Inline RtAudio definitions.
 714 //
 715 // **************************************************************** //
 716
 717 inline RtAudio::Api RtAudio :: getCurrentApi( void ) throw() { return rtapi_->getCurrentApi(); }
 718 inline unsigned int RtAudio :: getDeviceCount( void ) throw() { return rtapi_->getDeviceCount(); }
 719 inline RtAudio::DeviceInfo RtAudio :: getDeviceInfo( unsigned int device ) { return rtapi_->getDeviceInfo( device ); }
 720 inline unsigned int RtAudio :: getDefaultInputDevice( void ) throw() { return rtapi_->getDefaultInputDevice(); }
 721 inline unsigned int RtAudio :: getDefaultOutputDevice( void ) throw() { return rtapi_->getDefaultOutputDevice(); }
 722 inline void RtAudio :: closeStream( void ) throw() { return rtapi_->closeStream(); }
 723 inline void RtAudio :: startStream( void ) { return rtapi_->startStream(); }
 724 inline void RtAudio :: stopStream( void )  { return rtapi_->stopStream(); }
 725 inline void RtAudio :: abortStream( void ) { return rtapi_->abortStream(); }
 726 inline bool RtAudio :: isStreamOpen( void ) const throw() { return rtapi_->isStreamOpen(); }
 727 inline bool RtAudio :: isStreamRunning( void ) const throw() { return rtapi_->isStreamRunning(); }
 728 inline long RtAudio :: getStreamLatency( void ) { return rtapi_->getStreamLatency(); }
 729 inline unsigned int RtAudio :: getStreamSampleRate( void ) { return rtapi_->getStreamSampleRate(); };
 730 inline double RtAudio :: getStreamTime( void ) { return rtapi_->getStreamTime(); }
 731 inline void RtAudio :: showWarnings( bool value ) throw() { rtapi_->showWarnings( value ); }
 732
 733 // RtApi Subclass prototypes.
 734
 735 #if defined(__MACOSX_CORE__)
 736
 737 #include <CoreAudio/AudioHardware.h>
 738
 739 class RtApiCore: public RtApi
 740 {
 741 public:
 742
 743   RtApiCore();
 744   ~RtApiCore();
 745   RtAudio::Api getCurrentApi( void ) { return RtAudio::MACOSX_CORE; };
 746   unsigned int getDeviceCount( void );
 747   RtAudio::DeviceInfo getDeviceInfo( unsigned int device );
 748   unsigned int getDefaultOutputDevice( void );
 749   unsigned int getDefaultInputDevice( void );
 750   void closeStream( void );
 751   void startStream( void );
 752   void stopStream( void );
 753   void abortStream( void );
 754   long getStreamLatency( void );
 755
 756   // This function is intended for internal use only.  It must be
 757   // public because it is called by the internal callback handler,
 758   // which is not a member of RtAudio.  External use of this function
 759   // will most likely produce highly undesireable results!
 760   bool callbackEvent( AudioDeviceID deviceId,
 761                       const AudioBufferList *inBufferList,
 762                       const AudioBufferList *outBufferList );
 763
 764   private:
 765
 766   bool probeDeviceOpen( unsigned int device, StreamMode mode, unsigned int channels,
 767                         unsigned int firstChannel, unsigned int sampleRate,
 768                         RtAudioFormat format, unsigned int *bufferSize,
 769                         RtAudio::StreamOptions *options );
 770   static const char* getErrorCode( OSStatus code );
 771 };
 772
 773 #endif
 774
 775 #if defined(__UNIX_JACK__)
 776
 777 class RtApiJack: public RtApi
 778 {
 779 public:
 780
 781   RtApiJack();
 782   ~RtApiJack();
 783   RtAudio::Api getCurrentApi( void ) { return RtAudio::UNIX_JACK; };
 784   unsigned int getDeviceCount( void );
 785   RtAudio::DeviceInfo getDeviceInfo( unsigned int device );
 786   void closeStream( void );
 787   void startStream( void );
 788   void stopStream( void );
 789   void abortStream( void );
 790   long getStreamLatency( void );
 791
 792   // This function is intended for internal use only.  It must be
 793   // public because it is called by the internal callback handler,
 794   // which is not a member of RtAudio.  External use of this function
 795   // will most likely produce highly undesireable results!
 796   bool callbackEvent( unsigned long nframes );
 797
 798   private:
 799
 800   bool probeDeviceOpen( unsigned int device, StreamMode mode, unsigned int channels,
 801                         unsigned int firstChannel, unsigned int sampleRate,
 802                         RtAudioFormat format, unsigned int *bufferSize,
 803                         RtAudio::StreamOptions *options );
 804 };
 805
 806 #endif
 807
 808 #if defined(__WINDOWS_ASIO__)
 809
 810 class RtApiAsio: public RtApi
 811 {
 812 public:
 813
 814   RtApiAsio();
 815   ~RtApiAsio();
 816   RtAudio::Api getCurrentApi( void ) { return RtAudio::WINDOWS_ASIO; };
 817   unsigned int getDeviceCount( void );
 818   RtAudio::DeviceInfo getDeviceInfo( unsigned int device );
 819   void closeStream( void );
 820   void startStream( void );
 821   void stopStream( void );
 822   void abortStream( void );
 823   long getStreamLatency( void );
 824
 825   // This function is intended for internal use only.  It must be
 826   // public because it is called by the internal callback handler,
 827   // which is not a member of RtAudio.  External use of this function
 828   // will most likely produce highly undesireable results!
 829   bool callbackEvent( long bufferIndex );
 830
 831   private:
 832
 833   std::vector<RtAudio::DeviceInfo> devices_;
 834   void saveDeviceInfo( void );
 835   bool coInitialized_;
 836   bool probeDeviceOpen( unsigned int device, StreamMode mode, unsigned int channels,
 837                         unsigned int firstChannel, unsigned int sampleRate,
 838                         RtAudioFormat format, unsigned int *bufferSize,
 839                         RtAudio::StreamOptions *options );
 840 };
 841
 842 #endif
 843
 844 #if defined(__WINDOWS_DS__)
 845
 846 class RtApiDs: public RtApi
 847 {
 848 public:
 849
 850   RtApiDs();
 851   ~RtApiDs();
 852   RtAudio::Api getCurrentApi( void ) { return RtAudio::WINDOWS_DS; };
 853   unsigned int getDeviceCount( void );
 854   unsigned int getDefaultOutputDevice( void );
 855   unsigned int getDefaultInputDevice( void );
 856   RtAudio::DeviceInfo getDeviceInfo( unsigned int device );
 857   void closeStream( void );
 858   void startStream( void );
 859   void stopStream( void );
 860   void abortStream( void );
 861   long getStreamLatency( void );
 862
 863   // This function is intended for internal use only.  It must be
 864   // public because it is called by the internal callback handler,
 865   // which is not a member of RtAudio.  External use of this function
 866   // will most likely produce highly undesireable results!
 867   void callbackEvent( void );
 868
 869   private:
 870
 871   bool coInitialized_;
 872   bool buffersRolling;
 873   long duplexPrerollBytes;
 874   bool probeDeviceOpen( unsigned int device, StreamMode mode, unsigned int channels,
 875                         unsigned int firstChannel, unsigned int sampleRate,
 876                         RtAudioFormat format, unsigned int *bufferSize,
 877                         RtAudio::StreamOptions *options );
 878 };
 879
 880 #endif
 881
 882 #if defined(__LINUX_ALSA__)
 883
 884 class RtApiAlsa: public RtApi
 885 {
 886 public:
 887
 888   RtApiAlsa();
 889   ~RtApiAlsa();
 890   RtAudio::Api getCurrentApi() { return RtAudio::LINUX_ALSA; };
 891   unsigned int getDeviceCount( void );
 892   RtAudio::DeviceInfo getDeviceInfo( unsigned int device );
 893   void closeStream( void );
 894   void startStream( void );
 895   void stopStream( void );
 896   void abortStream( void );
 897
 898   // This function is intended for internal use only.  It must be
 899   // public because it is called by the internal callback handler,
 900   // which is not a member of RtAudio.  External use of this function
 901   // will most likely produce highly undesireable results!
 902   void callbackEvent( void );
 903
 904   private:
 905
 906   std::vector<RtAudio::DeviceInfo> devices_;
 907   void saveDeviceInfo( void );
 908   bool probeDeviceOpen( unsigned int device, StreamMode mode, unsigned int channels,
 909                         unsigned int firstChannel, unsigned int sampleRate,
 910                         RtAudioFormat format, unsigned int *bufferSize,
 911                         RtAudio::StreamOptions *options );
 912 };
 913
 914 #endif
 915
 916 #if defined(__LINUX_PULSE__)
 917
 918 class RtApiPulse: public RtApi
 919 {
 920 public:
 921   ~RtApiPulse();
 922   RtAudio::Api getCurrentApi() { return RtAudio::LINUX_PULSE; };
 923   unsigned int getDeviceCount( void );
 924   RtAudio::DeviceInfo getDeviceInfo( unsigned int device );
 925   void closeStream( void );
 926   void startStream( void );
 927   void stopStream( void );
 928   void abortStream( void );
 929
 930   // This function is intended for internal use only.  It must be
 931   // public because it is called by the internal callback handler,
 932   // which is not a member of RtAudio.  External use of this function
 933   // will most likely produce highly undesireable results!
 934   void callbackEvent( void );
 935
 936   private:
 937
 938   std::vector<RtAudio::DeviceInfo> devices_;
 939   void saveDeviceInfo( void );
 940   bool probeDeviceOpen( unsigned int device, StreamMode mode, unsigned int channels,
 941                         unsigned int firstChannel, unsigned int sampleRate,
 942                         RtAudioFormat format, unsigned int *bufferSize,
 943                         RtAudio::StreamOptions *options );
 944 };
 945
 946 #endif
 947
 948 #if defined(__LINUX_OSS__)
 949
 950 class RtApiOss: public RtApi
 951 {
 952 public:
 953
 954   RtApiOss();
 955   ~RtApiOss();
 956   RtAudio::Api getCurrentApi() { return RtAudio::LINUX_OSS; };
 957   unsigned int getDeviceCount( void );
 958   RtAudio::DeviceInfo getDeviceInfo( unsigned int device );
 959   void closeStream( void );
 960   void startStream( void );
 961   void stopStream( void );
 962   void abortStream( void );
 963
 964   // This function is intended for internal use only.  It must be
 965   // public because it is called by the internal callback handler,
 966   // which is not a member of RtAudio.  External use of this function
 967   // will most likely produce highly undesireable results!
 968   void callbackEvent( void );
 969
 970   private:
 971
 972   bool probeDeviceOpen( unsigned int device, StreamMode mode, unsigned int channels,
 973                         unsigned int firstChannel, unsigned int sampleRate,
 974                         RtAudioFormat format, unsigned int *bufferSize,
 975                         RtAudio::StreamOptions *options );
 976 };
 977
 978 #endif
 979
 980 #if defined(__RTAUDIO_DUMMY__)
 981
 982 class RtApiDummy: public RtApi
 983 {
 984 public:
 985
 986   RtApiDummy() { errorText_ = "RtApiDummy: This class provides no functionality."; error( RtError::WARNING ); };
 987   RtAudio::Api getCurrentApi( void ) { return RtAudio::RTAUDIO_DUMMY; };
 988   unsigned int getDeviceCount( void ) { return 0; };
 989   RtAudio::DeviceInfo getDeviceInfo( unsigned int device ) { RtAudio::DeviceInfo info; return info; };
 990   void closeStream( void ) {};
 991   void startStream( void ) {};
 992   void stopStream( void ) {};
 993   void abortStream( void ) {};
 994
 995   private:
 996
 997   bool probeDeviceOpen( unsigned int device, StreamMode mode, unsigned int channels,
 998                         unsigned int firstChannel, unsigned int sampleRate,
 999                         RtAudioFormat format, unsigned int *bufferSize,
1000                         RtAudio::StreamOptions *options ) { return false; };
1001 };
1002
1003 #endif
1004
1005 #endif
1006
1007 // Indentation settings for Vim and Emacs
1008 //
1009 // Local Variables:
1010 // c-basic-offset: 2
1011 // indent-tabs-mode: nil
1012 // End:
1013 //
1014 // vim: et sts=2 sw=2