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, ASIO and WASAPI) 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-2017 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 #ifndef __RTAUDIO_H
  46 #define __RTAUDIO_H
  47
  48 #define RTAUDIO_VERSION "5.0.0"
  49
  50 #if defined _WIN32 || defined __CYGWIN__
  51   #if defined(RTAUDIO_EXPORT)
  52     #define RTAUDIO_DLL_PUBLIC __declspec(dllexport)
  53   #else
  54     #define RTAUDIO_DLL_PUBLIC
  55   #endif
  56 #else
  57   #if __GNUC__ >= 4
  58     #define RTAUDIO_DLL_PUBLIC __attribute__( (visibility( "default" )) )
  59   #else
  60     #define RTAUDIO_DLL_PUBLIC
  61   #endif
  62 #endif
  63
  64 #include <string>
  65 #include <vector>
  66 #include <stdexcept>
  67 #include <iostream>
  68
  69 /*! \typedef typedef unsigned long RtAudioFormat;
  70     \brief RtAudio data format type.
  71
  72     Support for signed integers and floats.  Audio data fed to/from an
  73     RtAudio stream is assumed to ALWAYS be in host byte order.  The
  74     internal routines will automatically take care of any necessary
  75     byte-swapping between the host format and the soundcard.  Thus,
  76     endian-ness is not a concern in the following format definitions.
  77
  78     - \e RTAUDIO_SINT8:   8-bit signed integer.
  79     - \e RTAUDIO_SINT16:  16-bit signed integer.
  80     - \e RTAUDIO_SINT24:  24-bit signed integer.
  81     - \e RTAUDIO_SINT32:  32-bit signed integer.
  82     - \e RTAUDIO_FLOAT32: Normalized between plus/minus 1.0.
  83     - \e RTAUDIO_FLOAT64: Normalized between plus/minus 1.0.
  84 */
  85 typedef unsigned long RtAudioFormat;
  86 static const RtAudioFormat RTAUDIO_SINT8 = 0x1;    // 8-bit signed integer.
  87 static const RtAudioFormat RTAUDIO_SINT16 = 0x2;   // 16-bit signed integer.
  88 static const RtAudioFormat RTAUDIO_SINT24 = 0x4;   // 24-bit signed integer.
  89 static const RtAudioFormat RTAUDIO_SINT32 = 0x8;   // 32-bit signed integer.
  90 static const RtAudioFormat RTAUDIO_FLOAT32 = 0x10; // Normalized between plus/minus 1.0.
  91 static const RtAudioFormat RTAUDIO_FLOAT64 = 0x20; // Normalized between plus/minus 1.0.
  92
  93 /*! \typedef typedef unsigned long RtAudioStreamFlags;
  94     \brief RtAudio stream option flags.
  95
  96     The following flags can be OR'ed together to allow a client to
  97     make changes to the default stream behavior:
  98
  99     - \e RTAUDIO_NONINTERLEAVED:   Use non-interleaved buffers (default = interleaved).
 100     - \e RTAUDIO_MINIMIZE_LATENCY: Attempt to set stream parameters for lowest possible latency.
 101     - \e RTAUDIO_HOG_DEVICE:       Attempt grab device for exclusive use.
 102     - \e RTAUDIO_ALSA_USE_DEFAULT: Use the "default" PCM device (ALSA only).
 103     - \e RTAUDIO_JACK_DONT_CONNECT: Do not automatically connect ports (JACK only).
 104
 105     By default, RtAudio streams pass and receive audio data from the
 106     client in an interleaved format.  By passing the
 107     RTAUDIO_NONINTERLEAVED flag to the openStream() function, audio
 108     data will instead be presented in non-interleaved buffers.  In
 109     this case, each buffer argument in the RtAudioCallback function
 110     will point to a single array of data, with \c nFrames samples for
 111     each channel concatenated back-to-back.  For example, the first
 112     sample of data for the second channel would be located at index \c
 113     nFrames (assuming the \c buffer pointer was recast to the correct
 114     data type for the stream).
 115
 116     Certain audio APIs offer a number of parameters that influence the
 117     I/O latency of a stream.  By default, RtAudio will attempt to set
 118     these parameters internally for robust (glitch-free) performance
 119     (though some APIs, like Windows Direct Sound, make this difficult).
 120     By passing the RTAUDIO_MINIMIZE_LATENCY flag to the openStream()
 121     function, internal stream settings will be influenced in an attempt
 122     to minimize stream latency, though possibly at the expense of stream
 123     performance.
 124
 125     If the RTAUDIO_HOG_DEVICE flag is set, RtAudio will attempt to
 126     open the input and/or output stream device(s) for exclusive use.
 127     Note that this is not possible with all supported audio APIs.
 128
 129     If the RTAUDIO_SCHEDULE_REALTIME flag is set, RtAudio will attempt
 130     to select realtime scheduling (round-robin) for the callback thread.
 131
 132     If the RTAUDIO_ALSA_USE_DEFAULT flag is set, RtAudio will attempt to
 133     open the "default" PCM device when using the ALSA API. Note that this
 134     will override any specified input or output device id.
 135
 136     If the RTAUDIO_JACK_DONT_CONNECT flag is set, RtAudio will not attempt
 137     to automatically connect the ports of the client to the audio device.
 138 */
 139 typedef unsigned int RtAudioStreamFlags;
 140 static const RtAudioStreamFlags RTAUDIO_NONINTERLEAVED = 0x1;    // Use non-interleaved buffers (default = interleaved).
 141 static const RtAudioStreamFlags RTAUDIO_MINIMIZE_LATENCY = 0x2;  // Attempt to set stream parameters for lowest possible latency.
 142 static const RtAudioStreamFlags RTAUDIO_HOG_DEVICE = 0x4;        // Attempt grab device and prevent use by others.
 143 static const RtAudioStreamFlags RTAUDIO_SCHEDULE_REALTIME = 0x8; // Try to select realtime scheduling for callback thread.
 144 static const RtAudioStreamFlags RTAUDIO_ALSA_USE_DEFAULT = 0x10; // Use the "default" PCM device (ALSA only).
 145 static const RtAudioStreamFlags RTAUDIO_JACK_DONT_CONNECT = 0x20; // Do not automatically connect ports (JACK only).
 146
 147 /*! \typedef typedef unsigned long RtAudioStreamStatus;
 148     \brief RtAudio stream status (over- or underflow) flags.
 149
 150     Notification of a stream over- or underflow is indicated by a
 151     non-zero stream \c status argument in the RtAudioCallback function.
 152     The stream status can be one of the following two options,
 153     depending on whether the stream is open for output and/or input:
 154
 155     - \e RTAUDIO_INPUT_OVERFLOW:   Input data was discarded because of an overflow condition at the driver.
 156     - \e RTAUDIO_OUTPUT_UNDERFLOW: The output buffer ran low, likely producing a break in the output sound.
 157 */
 158 typedef unsigned int RtAudioStreamStatus;
 159 static const RtAudioStreamStatus RTAUDIO_INPUT_OVERFLOW = 0x1;    // Input data was discarded because of an overflow condition at the driver.
 160 static const RtAudioStreamStatus RTAUDIO_OUTPUT_UNDERFLOW = 0x2;  // The output buffer ran low, likely causing a gap in the output sound.
 161
 162 //! RtAudio callback function prototype.
 163 /*!
 164    All RtAudio clients must create a function of type RtAudioCallback
 165    to read and/or write data from/to the audio stream.  When the
 166    underlying audio system is ready for new input or output data, this
 167    function will be invoked.
 168
 169    \param outputBuffer For output (or duplex) streams, the client
 170           should write \c nFrames of audio sample frames into this
 171           buffer.  This argument should be recast to the datatype
 172           specified when the stream was opened.  For input-only
 173           streams, this argument will be NULL.
 174
 175    \param inputBuffer For input (or duplex) streams, this buffer will
 176           hold \c nFrames of input audio sample frames.  This
 177           argument should be recast to the datatype specified when the
 178           stream was opened.  For output-only streams, this argument
 179           will be NULL.
 180
 181    \param nFrames The number of sample frames of input or output
 182           data in the buffers.  The actual buffer size in bytes is
 183           dependent on the data type and number of channels in use.
 184
 185    \param streamTime The number of seconds that have elapsed since the
 186           stream was started.
 187
 188    \param status If non-zero, this argument indicates a data overflow
 189           or underflow condition for the stream.  The particular
 190           condition can be determined by comparison with the
 191           RtAudioStreamStatus flags.
 192
 193    \param userData A pointer to optional data provided by the client
 194           when opening the stream (default = NULL).
 195
 196    To continue normal stream operation, the RtAudioCallback function
 197    should return a value of zero.  To stop the stream and drain the
 198    output buffer, the function should return a value of one.  To abort
 199    the stream immediately, the client should return a value of two.
 200  */
 201 typedef int (*RtAudioCallback)( void *outputBuffer, void *inputBuffer,
 202                                 unsigned int nFrames,
 203                                 double streamTime,
 204                                 RtAudioStreamStatus status,
 205                                 void *userData );
 206
 207 /************************************************************************/
 208 /*! \class RtAudioError
 209     \brief Exception handling class for RtAudio.
 210
 211     The RtAudioError class is quite simple but it does allow errors to be
 212     "caught" by RtAudioError::Type. See the RtAudio documentation to know
 213     which methods can throw an RtAudioError.
 214 */
 215 /************************************************************************/
 216
 217 class RTAUDIO_DLL_PUBLIC RtAudioError : public std::runtime_error
 218 {
 219  public:
 220   //! Defined RtAudioError types.
 221   enum Type {
 222     WARNING,           /*!< A non-critical error. */
 223     DEBUG_WARNING,     /*!< A non-critical error which might be useful for debugging. */
 224     UNSPECIFIED,       /*!< The default, unspecified error type. */
 225     NO_DEVICES_FOUND,  /*!< No devices found on system. */
 226     INVALID_DEVICE,    /*!< An invalid device ID was specified. */
 227     MEMORY_ERROR,      /*!< An error occured during memory allocation. */
 228     INVALID_PARAMETER, /*!< An invalid parameter was specified to a function. */
 229     INVALID_USE,       /*!< The function was called incorrectly. */
 230     DRIVER_ERROR,      /*!< A system driver error occured. */
 231     SYSTEM_ERROR,      /*!< A system error occured. */
 232     THREAD_ERROR       /*!< A thread error occured. */
 233   };
 234
 235   //! The constructor.
 236   RtAudioError( const std::string& message,
 237                 Type type = RtAudioError::UNSPECIFIED )
 238     : std::runtime_error(message), type_(type) {}
 239
 240   //! Prints thrown error message to stderr.
 241   virtual void printMessage( void ) const
 242     { std::cerr << '\n' << what() << "\n\n"; }
 243
 244   //! Returns the thrown error message type.
 245   virtual const Type& getType(void) const { return type_; }
 246
 247   //! Returns the thrown error message string.
 248   virtual const std::string getMessage(void) const
 249     { return std::string(what()); }
 250
 251  protected:
 252   Type type_;
 253 };
 254
 255 //! RtAudio error callback function prototype.
 256 /*!
 257     \param type Type of error.
 258     \param errorText Error description.
 259  */
 260 typedef void (*RtAudioErrorCallback)( RtAudioError::Type type, const std::string &errorText );
 261
 262 // **************************************************************** //
 263 //
 264 // RtAudio class declaration.
 265 //
 266 // RtAudio is a "controller" used to select an available audio i/o
 267 // interface.  It presents a common API for the user to call but all
 268 // functionality is implemented by the class RtApi and its
 269 // subclasses.  RtAudio creates an instance of an RtApi subclass
 270 // based on the user's API choice.  If no choice is made, RtAudio
 271 // attempts to make a "logical" API selection.
 272 //
 273 // **************************************************************** //
 274
 275 class RtApi;
 276
 277 class RTAUDIO_DLL_PUBLIC RtAudio
 278 {
 279  public:
 280
 281   //! Audio API specifier arguments.
 282   enum Api {
 283     UNSPECIFIED,    /*!< Search for a working compiled API. */
 284     LINUX_ALSA,     /*!< The Advanced Linux Sound Architecture API. */
 285     LINUX_PULSE,    /*!< The Linux PulseAudio API. */
 286     LINUX_OSS,      /*!< The Linux Open Sound System API. */
 287     UNIX_JACK,      /*!< The Jack Low-Latency Audio Server API. */
 288     MACOSX_CORE,    /*!< Macintosh OS-X Core Audio API. */
 289     WINDOWS_WASAPI, /*!< The Microsoft WASAPI API. */
 290     WINDOWS_ASIO,   /*!< The Steinberg Audio Stream I/O API. */
 291     WINDOWS_DS,     /*!< The Microsoft Direct Sound API. */
 292     RTAUDIO_DUMMY,  /*!< A compilable but non-functional API. */
 293     NUM_APIS        /*!< Number of values in this enum. */
 294   };
 295
 296   //! The public device information structure for returning queried values.
 297   struct DeviceInfo {
 298     bool probed;                  /*!< true if the device capabilities were successfully probed. */
 299     std::string name;             /*!< Character string device identifier. */
 300     unsigned int outputChannels;  /*!< Maximum output channels supported by device. */
 301     unsigned int inputChannels;   /*!< Maximum input channels supported by device. */
 302     unsigned int duplexChannels;  /*!< Maximum simultaneous input/output channels supported by device. */
 303     bool isDefaultOutput;         /*!< true if this is the default output device. */
 304     bool isDefaultInput;          /*!< true if this is the default input device. */
 305     std::vector<unsigned int> sampleRates; /*!< Supported sample rates (queried from list of standard rates). */
 306     unsigned int preferredSampleRate; /*!< Preferred sample rate, eg. for WASAPI the system sample rate. */
 307     RtAudioFormat nativeFormats;  /*!< Bit mask of supported data formats. */
 308
 309     // Default constructor.
 310     DeviceInfo()
 311       :probed(false), outputChannels(0), inputChannels(0), duplexChannels(0),
 312        isDefaultOutput(false), isDefaultInput(false), preferredSampleRate(0), nativeFormats(0) {}
 313   };
 314
 315   //! The structure for specifying input or ouput stream parameters.
 316   struct StreamParameters {
 317     unsigned int deviceId;     /*!< Device index (0 to getDeviceCount() - 1). */
 318     unsigned int nChannels;    /*!< Number of channels. */
 319     unsigned int firstChannel; /*!< First channel index on device (default = 0). */
 320
 321     // Default constructor.
 322     StreamParameters()
 323       : deviceId(0), nChannels(0), firstChannel(0) {}
 324   };
 325
 326   //! The structure for specifying stream options.
 327   /*!
 328     The following flags can be OR'ed together to allow a client to
 329     make changes to the default stream behavior:
 330
 331     - \e RTAUDIO_NONINTERLEAVED:    Use non-interleaved buffers (default = interleaved).
 332     - \e RTAUDIO_MINIMIZE_LATENCY:  Attempt to set stream parameters for lowest possible latency.
 333     - \e RTAUDIO_HOG_DEVICE:        Attempt grab device for exclusive use.
 334     - \e RTAUDIO_SCHEDULE_REALTIME: Attempt to select realtime scheduling for callback thread.
 335     - \e RTAUDIO_ALSA_USE_DEFAULT:  Use the "default" PCM device (ALSA only).
 336
 337     By default, RtAudio streams pass and receive audio data from the
 338     client in an interleaved format.  By passing the
 339     RTAUDIO_NONINTERLEAVED flag to the openStream() function, audio
 340     data will instead be presented in non-interleaved buffers.  In
 341     this case, each buffer argument in the RtAudioCallback function
 342     will point to a single array of data, with \c nFrames samples for
 343     each channel concatenated back-to-back.  For example, the first
 344     sample of data for the second channel would be located at index \c
 345     nFrames (assuming the \c buffer pointer was recast to the correct
 346     data type for the stream).
 347
 348     Certain audio APIs offer a number of parameters that influence the
 349     I/O latency of a stream.  By default, RtAudio will attempt to set
 350     these parameters internally for robust (glitch-free) performance
 351     (though some APIs, like Windows Direct Sound, make this difficult).
 352     By passing the RTAUDIO_MINIMIZE_LATENCY flag to the openStream()
 353     function, internal stream settings will be influenced in an attempt
 354     to minimize stream latency, though possibly at the expense of stream
 355     performance.
 356
 357     If the RTAUDIO_HOG_DEVICE flag is set, RtAudio will attempt to
 358     open the input and/or output stream device(s) for exclusive use.
 359     Note that this is not possible with all supported audio APIs.
 360
 361     If the RTAUDIO_SCHEDULE_REALTIME flag is set, RtAudio will attempt
 362     to select realtime scheduling (round-robin) for the callback thread.
 363     The \c priority parameter will only be used if the RTAUDIO_SCHEDULE_REALTIME
 364     flag is set. It defines the thread's realtime priority.
 365
 366     If the RTAUDIO_ALSA_USE_DEFAULT flag is set, RtAudio will attempt to
 367     open the "default" PCM device when using the ALSA API. Note that this
 368     will override any specified input or output device id.
 369
 370     The \c numberOfBuffers parameter can be used to control stream
 371     latency in the Windows DirectSound, Linux OSS, and Linux Alsa APIs
 372     only.  A value of two is usually the smallest allowed.  Larger
 373     numbers can potentially result in more robust stream performance,
 374     though likely at the cost of stream latency.  The value set by the
 375     user is replaced during execution of the RtAudio::openStream()
 376     function by the value actually used by the system.
 377
 378     The \c streamName parameter can be used to set the client name
 379     when using the Jack API.  By default, the client name is set to
 380     RtApiJack.  However, if you wish to create multiple instances of
 381     RtAudio with Jack, each instance must have a unique client name.
 382   */
 383   struct StreamOptions {
 384     RtAudioStreamFlags flags;      /*!< A bit-mask of stream flags (RTAUDIO_NONINTERLEAVED, RTAUDIO_MINIMIZE_LATENCY, RTAUDIO_HOG_DEVICE, RTAUDIO_ALSA_USE_DEFAULT). */
 385     unsigned int numberOfBuffers;  /*!< Number of stream buffers. */
 386     std::string streamName;        /*!< A stream name (currently used only in Jack). */
 387     int priority;                  /*!< Scheduling priority of callback thread (only used with flag RTAUDIO_SCHEDULE_REALTIME). */
 388
 389     // Default constructor.
 390     StreamOptions()
 391     : flags(0), numberOfBuffers(0), priority(0) {}
 392   };
 393
 394   //! A static function to determine the current RtAudio version.
 395   static std::string getVersion( void );
 396
 397   //! A static function to determine the available compiled audio APIs.
 398   /*!
 399     The values returned in the std::vector can be compared against
 400     the enumerated list values.  Note that there can be more than one
 401     API compiled for certain operating systems.
 402   */
 403   static void getCompiledApi( std::vector<RtAudio::Api> &apis );
 404
 405   //! Return the name of a specified compiled audio API.
 406   /*!
 407     This obtains a short lower-case name used for identification purposes.
 408     This value is guaranteed to remain identical across library versions.
 409     If the API is unknown or not compiled, this function will return
 410     the empty string.
 411   */
 412   static const std::string getCompiledApiName( RtAudio::Api api );
 413
 414   //! Return the display name of a specified compiled audio API.
 415   /*!
 416     This obtains a long name used for display purposes.
 417     If the API is unknown or not compiled, this function will return
 418     the empty string.
 419   */
 420   static const std::string getCompiledApiDisplayName( RtAudio::Api api );
 421
 422   //! Return the compiled audio API having the given name.
 423   /*!
 424     A case insensitive comparison will check the specified name
 425     against the list of compiled APIs, and return the one which
 426     matches. On failure, the function returns UNSPECIFIED.
 427   */
 428   static RtAudio::Api getCompiledApiByName( const std::string &name );
 429
 430   //! The class constructor.
 431   /*!
 432     The constructor performs minor initialization tasks.  An exception
 433     can be thrown if no API support is compiled.
 434
 435     If no API argument is specified and multiple API support has been
 436     compiled, the default order of use is JACK, ALSA, OSS (Linux
 437     systems) and ASIO, DS (Windows systems).
 438   */
 439   RtAudio( RtAudio::Api api=UNSPECIFIED );
 440
 441   //! The destructor.
 442   /*!
 443     If a stream is running or open, it will be stopped and closed
 444     automatically.
 445   */
 446   ~RtAudio();
 447
 448   //! Returns the audio API specifier for the current instance of RtAudio.
 449   RtAudio::Api getCurrentApi( void );
 450
 451   //! A public function that queries for the number of audio devices available.
 452   /*!
 453     This function performs a system query of available devices each time it
 454     is called, thus supporting devices connected \e after instantiation. If
 455     a system error occurs during processing, a warning will be issued.
 456   */
 457   unsigned int getDeviceCount( void );
 458
 459   //! Return an RtAudio::DeviceInfo structure for a specified device number.
 460   /*!
 461
 462     Any device integer between 0 and getDeviceCount() - 1 is valid.
 463     If an invalid argument is provided, an RtAudioError (type = INVALID_USE)
 464     will be thrown.  If a device is busy or otherwise unavailable, the
 465     structure member "probed" will have a value of "false" and all
 466     other members are undefined.  If the specified device is the
 467     current default input or output device, the corresponding
 468     "isDefault" member will have a value of "true".
 469   */
 470   RtAudio::DeviceInfo getDeviceInfo( unsigned int device );
 471
 472   //! A function that returns the index of the default output device.
 473   /*!
 474     If the underlying audio API does not provide a "default
 475     device", or if no devices are available, the return value will be
 476     0.  Note that this is a valid device identifier and it is the
 477     client's responsibility to verify that a device is available
 478     before attempting to open a stream.
 479   */
 480   unsigned int getDefaultOutputDevice( void );
 481
 482   //! A function that returns the index of the default input device.
 483   /*!
 484     If the underlying audio API does not provide a "default
 485     device", or if no devices are available, the return value will be
 486     0.  Note that this is a valid device identifier and it is the
 487     client's responsibility to verify that a device is available
 488     before attempting to open a stream.
 489   */
 490   unsigned int getDefaultInputDevice( void );
 491
 492   //! A public function for opening a stream with the specified parameters.
 493   /*!
 494     An RtAudioError (type = SYSTEM_ERROR) is thrown if a stream cannot be
 495     opened with the specified parameters or an error occurs during
 496     processing.  An RtAudioError (type = INVALID_USE) is thrown if any
 497     invalid device ID or channel number parameters are specified.
 498
 499     \param outputParameters Specifies output stream parameters to use
 500            when opening a stream, including a device ID, number of channels,
 501            and starting channel number.  For input-only streams, this
 502            argument should be NULL.  The device ID is an index value between
 503            0 and getDeviceCount() - 1.
 504     \param inputParameters Specifies input stream parameters to use
 505            when opening a stream, including a device ID, number of channels,
 506            and starting channel number.  For output-only streams, this
 507            argument should be NULL.  The device ID is an index value between
 508            0 and getDeviceCount() - 1.
 509     \param format An RtAudioFormat specifying the desired sample data format.
 510     \param sampleRate The desired sample rate (sample frames per second).
 511     \param *bufferFrames A pointer to a value indicating the desired
 512            internal buffer size in sample frames.  The actual value
 513            used by the device is returned via the same pointer.  A
 514            value of zero can be specified, in which case the lowest
 515            allowable value is determined.
 516     \param callback A client-defined function that will be invoked
 517            when input data is available and/or output data is needed.
 518     \param userData An optional pointer to data that can be accessed
 519            from within the callback function.
 520     \param options An optional pointer to a structure containing various
 521            global stream options, including a list of OR'ed RtAudioStreamFlags
 522            and a suggested number of stream buffers that can be used to
 523            control stream latency.  More buffers typically result in more
 524            robust performance, though at a cost of greater latency.  If a
 525            value of zero is specified, a system-specific median value is
 526            chosen.  If the RTAUDIO_MINIMIZE_LATENCY flag bit is set, the
 527            lowest allowable value is used.  The actual value used is
 528            returned via the structure argument.  The parameter is API dependent.
 529     \param errorCallback A client-defined function that will be invoked
 530            when an error has occured.
 531   */
 532   void openStream( RtAudio::StreamParameters *outputParameters,
 533                    RtAudio::StreamParameters *inputParameters,
 534                    RtAudioFormat format, unsigned int sampleRate,
 535                    unsigned int *bufferFrames, RtAudioCallback callback,
 536                    void *userData = NULL, RtAudio::StreamOptions *options = NULL, RtAudioErrorCallback errorCallback = NULL );
 537
 538   //! A function that closes a stream and frees any associated stream memory.
 539   /*!
 540     If a stream is not open, this function issues a warning and
 541     returns (no exception is thrown).
 542   */
 543   void closeStream( void );
 544
 545   //! A function that starts a stream.
 546   /*!
 547     An RtAudioError (type = SYSTEM_ERROR) is thrown if an error occurs
 548     during processing.  An RtAudioError (type = INVALID_USE) is thrown if a
 549     stream is not open.  A warning is issued if the stream is already
 550     running.
 551   */
 552   void startStream( void );
 553
 554   //! Stop a stream, allowing any samples remaining in the output queue to be played.
 555   /*!
 556     An RtAudioError (type = SYSTEM_ERROR) is thrown if an error occurs
 557     during processing.  An RtAudioError (type = INVALID_USE) is thrown if a
 558     stream is not open.  A warning is issued if the stream is already
 559     stopped.
 560   */
 561   void stopStream( void );
 562
 563   //! Stop a stream, discarding any samples remaining in the input/output queue.
 564   /*!
 565     An RtAudioError (type = SYSTEM_ERROR) is thrown if an error occurs
 566     during processing.  An RtAudioError (type = INVALID_USE) is thrown if a
 567     stream is not open.  A warning is issued if the stream is already
 568     stopped.
 569   */
 570   void abortStream( void );
 571
 572   //! Returns true if a stream is open and false if not.
 573   bool isStreamOpen( void ) const;
 574
 575   //! Returns true if the stream is running and false if it is stopped or not open.
 576   bool isStreamRunning( void ) const;
 577
 578   //! Returns the number of elapsed seconds since the stream was started.
 579   /*!
 580     If a stream is not open, an RtAudioError (type = INVALID_USE) will be thrown.
 581   */
 582   double getStreamTime( void );
 583
 584   //! Set the stream time to a time in seconds greater than or equal to 0.0.
 585   /*!
 586     If a stream is not open, an RtAudioError (type = INVALID_USE) will be thrown.
 587   */
 588   void setStreamTime( double time );
 589
 590   //! Returns the internal stream latency in sample frames.
 591   /*!
 592     The stream latency refers to delay in audio input and/or output
 593     caused by internal buffering by the audio system and/or hardware.
 594     For duplex streams, the returned value will represent the sum of
 595     the input and output latencies.  If a stream is not open, an
 596     RtAudioError (type = INVALID_USE) will be thrown.  If the API does not
 597     report latency, the return value will be zero.
 598   */
 599   long getStreamLatency( void );
 600
 601  //! Returns actual sample rate in use by the stream.
 602  /*!
 603    On some systems, the sample rate used may be slightly different
 604    than that specified in the stream parameters.  If a stream is not
 605    open, an RtAudioError (type = INVALID_USE) will be thrown.
 606  */
 607   unsigned int getStreamSampleRate( void );
 608
 609   //! Specify whether warning messages should be printed to stderr.
 610   void showWarnings( bool value = true );
 611
 612  protected:
 613
 614   void openRtApi( RtAudio::Api api );
 615   RtApi *rtapi_;
 616 };
 617
 618 // Operating system dependent thread functionality.
 619 #if defined(__WINDOWS_DS__) || defined(__WINDOWS_ASIO__) || defined(__WINDOWS_WASAPI__)
 620
 621   #ifndef NOMINMAX
 622     #define NOMINMAX
 623   #endif
 624   #include <windows.h>
 625   #include <process.h>
 626
 627   typedef uintptr_t ThreadHandle;
 628   typedef CRITICAL_SECTION StreamMutex;
 629
 630 #elif defined(__LINUX_ALSA__) || defined(__LINUX_PULSE__) || defined(__UNIX_JACK__) || defined(__LINUX_OSS__) || defined(__MACOSX_CORE__)
 631   // Using pthread library for various flavors of unix.
 632   #include <pthread.h>
 633
 634   typedef pthread_t ThreadHandle;
 635   typedef pthread_mutex_t StreamMutex;
 636
 637 #else // Setup for "dummy" behavior
 638
 639   #define __RTAUDIO_DUMMY__
 640   typedef int ThreadHandle;
 641   typedef int StreamMutex;
 642
 643 #endif
 644
 645 // This global structure type is used to pass callback information
 646 // between the private RtAudio stream structure and global callback
 647 // handling functions.
 648 struct CallbackInfo {
 649   void *object;    // Used as a "this" pointer.
 650   ThreadHandle thread;
 651   void *callback;
 652   void *userData;
 653   void *errorCallback;
 654   void *apiInfo;   // void pointer for API specific callback information
 655   bool isRunning;
 656   bool doRealtime;
 657   int priority;
 658
 659   // Default constructor.
 660   CallbackInfo()
 661   :object(0), callback(0), userData(0), errorCallback(0), apiInfo(0), isRunning(false), doRealtime(false), priority(0) {}
 662 };
 663
 664 // **************************************************************** //
 665 //
 666 // RtApi class declaration.
 667 //
 668 // Subclasses of RtApi contain all API- and OS-specific code necessary
 669 // to fully implement the RtAudio API.
 670 //
 671 // Note that RtApi is an abstract base class and cannot be
 672 // explicitly instantiated.  The class RtAudio will create an
 673 // instance of an RtApi subclass (RtApiOss, RtApiAlsa,
 674 // RtApiJack, RtApiCore, RtApiDs, or RtApiAsio).
 675 //
 676 // **************************************************************** //
 677
 678 #pragma pack(push, 1)
 679 class S24 {
 680
 681  protected:
 682   unsigned char c3[3];
 683
 684  public:
 685   S24() {}
 686
 687   S24& operator = ( const int& i ) {
 688     c3[0] = (i & 0x000000ff);
 689     c3[1] = (i & 0x0000ff00) >> 8;
 690     c3[2] = (i & 0x00ff0000) >> 16;
 691     return *this;
 692   }
 693
 694   S24( const S24& v ) { *this = v; }
 695   S24( const double& d ) { *this = (int) d; }
 696   S24( const float& f ) { *this = (int) f; }
 697   S24( const signed short& s ) { *this = (int) s; }
 698   S24( const char& c ) { *this = (int) c; }
 699
 700   int asInt() {
 701     int i = c3[0] | (c3[1] << 8) | (c3[2] << 16);
 702     if (i & 0x800000) i |= ~0xffffff;
 703     return i;
 704   }
 705 };
 706 #pragma pack(pop)
 707
 708 #if defined( HAVE_GETTIMEOFDAY )
 709   #include <sys/time.h>
 710 #endif
 711
 712 #include <sstream>
 713
 714 class RTAUDIO_DLL_PUBLIC RtApi
 715 {
 716 public:
 717
 718   RtApi();
 719   virtual ~RtApi();
 720   virtual RtAudio::Api getCurrentApi( void ) = 0;
 721   virtual unsigned int getDeviceCount( void ) = 0;
 722   virtual RtAudio::DeviceInfo getDeviceInfo( unsigned int device ) = 0;
 723   virtual unsigned int getDefaultInputDevice( void );
 724   virtual unsigned int getDefaultOutputDevice( void );
 725   void openStream( RtAudio::StreamParameters *outputParameters,
 726                    RtAudio::StreamParameters *inputParameters,
 727                    RtAudioFormat format, unsigned int sampleRate,
 728                    unsigned int *bufferFrames, RtAudioCallback callback,
 729                    void *userData, RtAudio::StreamOptions *options,
 730                    RtAudioErrorCallback errorCallback );
 731   virtual void closeStream( void );
 732   virtual void startStream( void ) = 0;
 733   virtual void stopStream( void ) = 0;
 734   virtual void abortStream( void ) = 0;
 735   long getStreamLatency( void );
 736   unsigned int getStreamSampleRate( void );
 737   virtual double getStreamTime( void );
 738   virtual void setStreamTime( double time );
 739   bool isStreamOpen( void ) const { return stream_.state != STREAM_CLOSED; }
 740   bool isStreamRunning( void ) const { return stream_.state == STREAM_RUNNING; }
 741   void showWarnings( bool value ) { showWarnings_ = value; }
 742
 743
 744 protected:
 745
 746   static const unsigned int MAX_SAMPLE_RATES;
 747   static const unsigned int SAMPLE_RATES[];
 748
 749   enum { FAILURE, SUCCESS };
 750
 751   enum StreamState {
 752     STREAM_STOPPED,
 753     STREAM_STOPPING,
 754     STREAM_RUNNING,
 755     STREAM_CLOSED = -50
 756   };
 757
 758   enum StreamMode {
 759     OUTPUT,
 760     INPUT,
 761     DUPLEX,
 762     UNINITIALIZED = -75
 763   };
 764
 765   // A protected structure used for buffer conversion.
 766   struct ConvertInfo {
 767     int channels;
 768     int inJump, outJump;
 769     RtAudioFormat inFormat, outFormat;
 770     std::vector<int> inOffset;
 771     std::vector<int> outOffset;
 772   };
 773
 774   // A protected structure for audio streams.
 775   struct RtApiStream {
 776     unsigned int device[2];    // Playback and record, respectively.
 777     void *apiHandle;           // void pointer for API specific stream handle information
 778     StreamMode mode;           // OUTPUT, INPUT, or DUPLEX.
 779     StreamState state;         // STOPPED, RUNNING, or CLOSED
 780     char *userBuffer[2];       // Playback and record, respectively.
 781     char *deviceBuffer;
 782     bool doConvertBuffer[2];   // Playback and record, respectively.
 783     bool userInterleaved;
 784     bool deviceInterleaved[2]; // Playback and record, respectively.
 785     bool doByteSwap[2];        // Playback and record, respectively.
 786     unsigned int sampleRate;
 787     unsigned int bufferSize;
 788     unsigned int nBuffers;
 789     unsigned int nUserChannels[2];    // Playback and record, respectively.
 790     unsigned int nDeviceChannels[2];  // Playback and record channels, respectively.
 791     unsigned int channelOffset[2];    // Playback and record, respectively.
 792     unsigned long latency[2];         // Playback and record, respectively.
 793     RtAudioFormat userFormat;
 794     RtAudioFormat deviceFormat[2];    // Playback and record, respectively.
 795     StreamMutex mutex;
 796     CallbackInfo callbackInfo;
 797     ConvertInfo convertInfo[2];
 798     double streamTime;         // Number of elapsed seconds since the stream started.
 799
 800 #if defined(HAVE_GETTIMEOFDAY)
 801     struct timeval lastTickTimestamp;
 802 #endif
 803
 804     RtApiStream()
 805       :apiHandle(0), deviceBuffer(0) { device[0] = 11111; device[1] = 11111; }
 806   };
 807
 808   typedef S24 Int24;
 809   typedef signed short Int16;
 810   typedef signed int Int32;
 811   typedef float Float32;
 812   typedef double Float64;
 813
 814   std::ostringstream errorStream_;
 815   std::string errorText_;
 816   bool showWarnings_;
 817   RtApiStream stream_;
 818   bool firstErrorOccurred_;
 819
 820   /*!
 821     Protected, api-specific method that attempts to open a device
 822     with the given parameters.  This function MUST be implemented by
 823     all subclasses.  If an error is encountered during the probe, a
 824     "warning" message is reported and FAILURE is returned. A
 825     successful probe is indicated by a return value of SUCCESS.
 826   */
 827   virtual bool probeDeviceOpen( unsigned int device, StreamMode mode, unsigned int channels,
 828                                 unsigned int firstChannel, unsigned int sampleRate,
 829                                 RtAudioFormat format, unsigned int *bufferSize,
 830                                 RtAudio::StreamOptions *options );
 831
 832   //! A protected function used to increment the stream time.
 833   void tickStreamTime( void );
 834
 835   //! Protected common method to clear an RtApiStream structure.
 836   void clearStreamInfo();
 837
 838   /*!
 839     Protected common method that throws an RtAudioError (type =
 840     INVALID_USE) if a stream is not open.
 841   */
 842   void verifyStream( void );
 843
 844   //! Protected common error method to allow global control over error handling.
 845   void error( RtAudioError::Type type );
 846
 847   /*!
 848     Protected method used to perform format, channel number, and/or interleaving
 849     conversions between the user and device buffers.
 850   */
 851   void convertBuffer( char *outBuffer, char *inBuffer, ConvertInfo &info );
 852
 853   //! Protected common method used to perform byte-swapping on buffers.
 854   void byteSwapBuffer( char *buffer, unsigned int samples, RtAudioFormat format );
 855
 856   //! Protected common method that returns the number of bytes for a given format.
 857   unsigned int formatBytes( RtAudioFormat format );
 858
 859   //! Protected common method that sets up the parameters for buffer conversion.
 860   void setConvertInfo( StreamMode mode, unsigned int firstChannel );
 861 };
 862
 863 // **************************************************************** //
 864 //
 865 // Inline RtAudio definitions.
 866 //
 867 // **************************************************************** //
 868
 869 inline RtAudio::Api RtAudio :: getCurrentApi( void ) { return rtapi_->getCurrentApi(); }
 870 inline unsigned int RtAudio :: getDeviceCount( void ) { return rtapi_->getDeviceCount(); }
 871 inline RtAudio::DeviceInfo RtAudio :: getDeviceInfo( unsigned int device ) { return rtapi_->getDeviceInfo( device ); }
 872 inline unsigned int RtAudio :: getDefaultInputDevice( void ) { return rtapi_->getDefaultInputDevice(); }
 873 inline unsigned int RtAudio :: getDefaultOutputDevice( void ) { return rtapi_->getDefaultOutputDevice(); }
 874 inline void RtAudio :: closeStream( void ) { return rtapi_->closeStream(); }
 875 inline void RtAudio :: startStream( void ) { return rtapi_->startStream(); }
 876 inline void RtAudio :: stopStream( void )  { return rtapi_->stopStream(); }
 877 inline void RtAudio :: abortStream( void ) { return rtapi_->abortStream(); }
 878 inline bool RtAudio :: isStreamOpen( void ) const { return rtapi_->isStreamOpen(); }
 879 inline bool RtAudio :: isStreamRunning( void ) const { return rtapi_->isStreamRunning(); }
 880 inline long RtAudio :: getStreamLatency( void ) { return rtapi_->getStreamLatency(); }
 881 inline unsigned int RtAudio :: getStreamSampleRate( void ) { return rtapi_->getStreamSampleRate(); }
 882 inline double RtAudio :: getStreamTime( void ) { return rtapi_->getStreamTime(); }
 883 inline void RtAudio :: setStreamTime( double time ) { return rtapi_->setStreamTime( time ); }
 884 inline void RtAudio :: showWarnings( bool value ) { rtapi_->showWarnings( value ); }
 885
 886 // RtApi Subclass prototypes.
 887
 888 #if defined(__MACOSX_CORE__)
 889
 890 #include <CoreAudio/AudioHardware.h>
 891
 892 class RtApiCore: public RtApi
 893 {
 894 public:
 895
 896   RtApiCore();
 897   ~RtApiCore();
 898   RtAudio::Api getCurrentApi( void ) { return RtAudio::MACOSX_CORE; }
 899   unsigned int getDeviceCount( void );
 900   RtAudio::DeviceInfo getDeviceInfo( unsigned int device );
 901   unsigned int getDefaultOutputDevice( void );
 902   unsigned int getDefaultInputDevice( void );
 903   void closeStream( void );
 904   void startStream( void );
 905   void stopStream( void );
 906   void abortStream( void );
 907   long getStreamLatency( void );
 908
 909   // This function is intended for internal use only.  It must be
 910   // public because it is called by the internal callback handler,
 911   // which is not a member of RtAudio.  External use of this function
 912   // will most likely produce highly undesireable results!
 913   bool callbackEvent( AudioDeviceID deviceId,
 914                       const AudioBufferList *inBufferList,
 915                       const AudioBufferList *outBufferList );
 916
 917   private:
 918
 919   bool probeDeviceOpen( unsigned int device, StreamMode mode, unsigned int channels,
 920                         unsigned int firstChannel, unsigned int sampleRate,
 921                         RtAudioFormat format, unsigned int *bufferSize,
 922                         RtAudio::StreamOptions *options );
 923   static const char* getErrorCode( OSStatus code );
 924 };
 925
 926 #endif
 927
 928 #if defined(__UNIX_JACK__)
 929
 930 class RtApiJack: public RtApi
 931 {
 932 public:
 933
 934   RtApiJack();
 935   ~RtApiJack();
 936   RtAudio::Api getCurrentApi( void ) { return RtAudio::UNIX_JACK; }
 937   unsigned int getDeviceCount( void );
 938   RtAudio::DeviceInfo getDeviceInfo( unsigned int device );
 939   void closeStream( void );
 940   void startStream( void );
 941   void stopStream( void );
 942   void abortStream( void );
 943   long getStreamLatency( void );
 944
 945   // This function is intended for internal use only.  It must be
 946   // public because it is called by the internal callback handler,
 947   // which is not a member of RtAudio.  External use of this function
 948   // will most likely produce highly undesireable results!
 949   bool callbackEvent( unsigned long nframes );
 950
 951   private:
 952
 953   bool probeDeviceOpen( unsigned int device, StreamMode mode, unsigned int channels,
 954                         unsigned int firstChannel, unsigned int sampleRate,
 955                         RtAudioFormat format, unsigned int *bufferSize,
 956                         RtAudio::StreamOptions *options );
 957
 958   bool shouldAutoconnect_;
 959 };
 960
 961 #endif
 962
 963 #if defined(__WINDOWS_ASIO__)
 964
 965 class RtApiAsio: public RtApi
 966 {
 967 public:
 968
 969   RtApiAsio();
 970   ~RtApiAsio();
 971   RtAudio::Api getCurrentApi( void ) { return RtAudio::WINDOWS_ASIO; }
 972   unsigned int getDeviceCount( void );
 973   RtAudio::DeviceInfo getDeviceInfo( unsigned int device );
 974   void closeStream( void );
 975   void startStream( void );
 976   void stopStream( void );
 977   void abortStream( void );
 978   long getStreamLatency( void );
 979
 980   // This function is intended for internal use only.  It must be
 981   // public because it is called by the internal callback handler,
 982   // which is not a member of RtAudio.  External use of this function
 983   // will most likely produce highly undesireable results!
 984   bool callbackEvent( long bufferIndex );
 985
 986   private:
 987
 988   std::vector<RtAudio::DeviceInfo> devices_;
 989   void saveDeviceInfo( void );
 990   bool coInitialized_;
 991   bool probeDeviceOpen( unsigned int device, StreamMode mode, unsigned int channels,
 992                         unsigned int firstChannel, unsigned int sampleRate,
 993                         RtAudioFormat format, unsigned int *bufferSize,
 994                         RtAudio::StreamOptions *options );
 995 };
 996
 997 #endif
 998
 999 #if defined(__WINDOWS_DS__)
1000
1001 class RtApiDs: public RtApi
1002 {
1003 public:
1004
1005   RtApiDs();
1006   ~RtApiDs();
1007   RtAudio::Api getCurrentApi( void ) { return RtAudio::WINDOWS_DS; }
1008   unsigned int getDeviceCount( void );
1009   unsigned int getDefaultOutputDevice( void );
1010   unsigned int getDefaultInputDevice( void );
1011   RtAudio::DeviceInfo getDeviceInfo( unsigned int device );
1012   void closeStream( void );
1013   void startStream( void );
1014   void stopStream( void );
1015   void abortStream( void );
1016   long getStreamLatency( void );
1017
1018   // This function is intended for internal use only.  It must be
1019   // public because it is called by the internal callback handler,
1020   // which is not a member of RtAudio.  External use of this function
1021   // will most likely produce highly undesireable results!
1022   void callbackEvent( void );
1023
1024   private:
1025
1026   bool coInitialized_;
1027   bool buffersRolling;
1028   long duplexPrerollBytes;
1029   std::vector<struct DsDevice> dsDevices;
1030   bool probeDeviceOpen( unsigned int device, StreamMode mode, unsigned int channels,
1031                         unsigned int firstChannel, unsigned int sampleRate,
1032                         RtAudioFormat format, unsigned int *bufferSize,
1033                         RtAudio::StreamOptions *options );
1034 };
1035
1036 #endif
1037
1038 #if defined(__WINDOWS_WASAPI__)
1039
1040 struct IMMDeviceEnumerator;
1041
1042 class RtApiWasapi : public RtApi
1043 {
1044 public:
1045   RtApiWasapi();
1046   ~RtApiWasapi();
1047
1048   RtAudio::Api getCurrentApi( void ) { return RtAudio::WINDOWS_WASAPI; }
1049   unsigned int getDeviceCount( void );
1050   RtAudio::DeviceInfo getDeviceInfo( unsigned int device );
1051   unsigned int getDefaultOutputDevice( void );
1052   unsigned int getDefaultInputDevice( void );
1053   void closeStream( void );
1054   void startStream( void );
1055   void stopStream( void );
1056   void abortStream( void );
1057
1058 private:
1059   bool coInitialized_;
1060   IMMDeviceEnumerator* deviceEnumerator_;
1061
1062   bool probeDeviceOpen( unsigned int device, StreamMode mode, unsigned int channels,
1063                         unsigned int firstChannel, unsigned int sampleRate,
1064                         RtAudioFormat format, unsigned int* bufferSize,
1065                         RtAudio::StreamOptions* options );
1066
1067   static DWORD WINAPI runWasapiThread( void* wasapiPtr );
1068   static DWORD WINAPI stopWasapiThread( void* wasapiPtr );
1069   static DWORD WINAPI abortWasapiThread( void* wasapiPtr );
1070   void wasapiThread();
1071 };
1072
1073 #endif
1074
1075 #if defined(__LINUX_ALSA__)
1076
1077 class RtApiAlsa: public RtApi
1078 {
1079 public:
1080
1081   RtApiAlsa();
1082   ~RtApiAlsa();
1083   RtAudio::Api getCurrentApi() { return RtAudio::LINUX_ALSA; }
1084   unsigned int getDeviceCount( void );
1085   RtAudio::DeviceInfo getDeviceInfo( unsigned int device );
1086   void closeStream( void );
1087   void startStream( void );
1088   void stopStream( void );
1089   void abortStream( void );
1090
1091   // This function is intended for internal use only.  It must be
1092   // public because it is called by the internal callback handler,
1093   // which is not a member of RtAudio.  External use of this function
1094   // will most likely produce highly undesireable results!
1095   void callbackEvent( void );
1096
1097   private:
1098
1099   std::vector<RtAudio::DeviceInfo> devices_;
1100   void saveDeviceInfo( void );
1101   bool probeDeviceOpen( unsigned int device, StreamMode mode, unsigned int channels,
1102                         unsigned int firstChannel, unsigned int sampleRate,
1103                         RtAudioFormat format, unsigned int *bufferSize,
1104                         RtAudio::StreamOptions *options );
1105 };
1106
1107 #endif
1108
1109 #if defined(__LINUX_PULSE__)
1110
1111 class RtApiPulse: public RtApi
1112 {
1113 public:
1114   ~RtApiPulse();
1115   RtAudio::Api getCurrentApi() { return RtAudio::LINUX_PULSE; }
1116   unsigned int getDeviceCount( void );
1117   RtAudio::DeviceInfo getDeviceInfo( unsigned int device );
1118   void closeStream( void );
1119   void startStream( void );
1120   void stopStream( void );
1121   void abortStream( void );
1122
1123   // This function is intended for internal use only.  It must be
1124   // public because it is called by the internal callback handler,
1125   // which is not a member of RtAudio.  External use of this function
1126   // will most likely produce highly undesireable results!
1127   void callbackEvent( void );
1128
1129   private:
1130
1131   std::vector<RtAudio::DeviceInfo> devices_;
1132   void saveDeviceInfo( void );
1133   bool probeDeviceOpen( unsigned int device, StreamMode mode, unsigned int channels,
1134                         unsigned int firstChannel, unsigned int sampleRate,
1135                         RtAudioFormat format, unsigned int *bufferSize,
1136                         RtAudio::StreamOptions *options );
1137 };
1138
1139 #endif
1140
1141 #if defined(__LINUX_OSS__)
1142
1143 class RtApiOss: public RtApi
1144 {
1145 public:
1146
1147   RtApiOss();
1148   ~RtApiOss();
1149   RtAudio::Api getCurrentApi() { return RtAudio::LINUX_OSS; }
1150   unsigned int getDeviceCount( void );
1151   RtAudio::DeviceInfo getDeviceInfo( unsigned int device );
1152   void closeStream( void );
1153   void startStream( void );
1154   void stopStream( void );
1155   void abortStream( void );
1156
1157   // This function is intended for internal use only.  It must be
1158   // public because it is called by the internal callback handler,
1159   // which is not a member of RtAudio.  External use of this function
1160   // will most likely produce highly undesireable results!
1161   void callbackEvent( void );
1162
1163   private:
1164
1165   bool probeDeviceOpen( unsigned int device, StreamMode mode, unsigned int channels,
1166                         unsigned int firstChannel, unsigned int sampleRate,
1167                         RtAudioFormat format, unsigned int *bufferSize,
1168                         RtAudio::StreamOptions *options );
1169 };
1170
1171 #endif
1172
1173 #if defined(__RTAUDIO_DUMMY__)
1174
1175 class RtApiDummy: public RtApi
1176 {
1177 public:
1178
1179   RtApiDummy() { errorText_ = "RtApiDummy: This class provides no functionality."; error( RtAudioError::WARNING ); }
1180   RtAudio::Api getCurrentApi( void ) { return RtAudio::RTAUDIO_DUMMY; }
1181   unsigned int getDeviceCount( void ) { return 0; }
1182   RtAudio::DeviceInfo getDeviceInfo( unsigned int /*device*/ ) { RtAudio::DeviceInfo info; return info; }
1183   void closeStream( void ) {}
1184   void startStream( void ) {}
1185   void stopStream( void ) {}
1186   void abortStream( void ) {}
1187
1188   private:
1189
1190   bool probeDeviceOpen( unsigned int /*device*/, StreamMode /*mode*/, unsigned int /*channels*/,
1191                         unsigned int /*firstChannel*/, unsigned int /*sampleRate*/,
1192                         RtAudioFormat /*format*/, unsigned int * /*bufferSize*/,
1193                         RtAudio::StreamOptions * /*options*/ ) { return false; }
1194 };
1195
1196 #endif
1197
1198 #endif
1199
1200 // Indentation settings for Vim and Emacs
1201 //
1202 // Local Variables:
1203 // c-basic-offset: 2
1204 // indent-tabs-mode: nil
1205 // End:
1206 //
1207 // vim: et sts=2 sw=2