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 GitHub site: https://github.com/thestk/rtaudio
  11     RtAudio WWW site: http://www.music.mcgill.ca/~gary/rtaudio/
  12
  13     RtAudio: realtime audio i/o C++ classes
  14     Copyright (c) 2001-2019 Gary P. Scavone
  15
  16     Permission is hereby granted, free of charge, to any person
  17     obtaining a copy of this software and associated documentation files
  18     (the "Software"), to deal in the Software without restriction,
  19     including without limitation the rights to use, copy, modify, merge,
  20     publish, distribute, sublicense, and/or sell copies of the Software,
  21     and to permit persons to whom the Software is furnished to do so,
  22     subject to the following conditions:
  23
  24     The above copyright notice and this permission notice shall be
  25     included in all copies or substantial portions of the Software.
  26
  27     Any person wishing to distribute modifications to the Software is
  28     asked to send the modifications to the original developer so that
  29     they can be incorporated into the canonical version.  This is,
  30     however, not a binding provision of this license.
  31
  32     THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
  33     EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
  34     MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
  35     IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR
  36     ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF
  37     CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
  38     WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  39 */
  40 /************************************************************************/
  41
  42 /*!
  43   \file RtAudio.h
  44  */
  45
  46 #ifndef __RTAUDIO_H
  47 #define __RTAUDIO_H
  48
  49 #define RTAUDIO_VERSION "5.1.0"
  50
  51 #if defined _WIN32 || defined __CYGWIN__
  52   #if defined(RTAUDIO_EXPORT)
  53     #define RTAUDIO_DLL_PUBLIC __declspec(dllexport)
  54   #else
  55     #define RTAUDIO_DLL_PUBLIC
  56   #endif
  57 #else
  58   #if __GNUC__ >= 4
  59     #define RTAUDIO_DLL_PUBLIC __attribute__( (visibility( "default" )) )
  60   #else
  61     #define RTAUDIO_DLL_PUBLIC
  62   #endif
  63 #endif
  64
  65 #include <string>
  66 #include <vector>
  67 #include <stdexcept>
  68 #include <iostream>
  69
  70 /*! \typedef typedef unsigned long RtAudioFormat;
  71     \brief RtAudio data format type.
  72
  73     Support for signed integers and floats.  Audio data fed to/from an
  74     RtAudio stream is assumed to ALWAYS be in host byte order.  The
  75     internal routines will automatically take care of any necessary
  76     byte-swapping between the host format and the soundcard.  Thus,
  77     endian-ness is not a concern in the following format definitions.
  78
  79     - \e RTAUDIO_SINT8:   8-bit signed integer.
  80     - \e RTAUDIO_SINT16:  16-bit signed integer.
  81     - \e RTAUDIO_SINT24:  24-bit signed integer.
  82     - \e RTAUDIO_SINT32:  32-bit signed integer.
  83     - \e RTAUDIO_FLOAT32: Normalized between plus/minus 1.0.
  84     - \e RTAUDIO_FLOAT64: Normalized between plus/minus 1.0.
  85 */
  86 typedef unsigned long RtAudioFormat;
  87 static const RtAudioFormat RTAUDIO_SINT8 = 0x1;    // 8-bit signed integer.
  88 static const RtAudioFormat RTAUDIO_SINT16 = 0x2;   // 16-bit signed integer.
  89 static const RtAudioFormat RTAUDIO_SINT24 = 0x4;   // 24-bit signed integer.
  90 static const RtAudioFormat RTAUDIO_SINT32 = 0x8;   // 32-bit signed integer.
  91 static const RtAudioFormat RTAUDIO_FLOAT32 = 0x10; // Normalized between plus/minus 1.0.
  92 static const RtAudioFormat RTAUDIO_FLOAT64 = 0x20; // Normalized between plus/minus 1.0.
  93
  94 /*! \typedef typedef unsigned long RtAudioStreamFlags;
  95     \brief RtAudio stream option flags.
  96
  97     The following flags can be OR'ed together to allow a client to
  98     make changes to the default stream behavior:
  99
 100     - \e RTAUDIO_NONINTERLEAVED:   Use non-interleaved buffers (default = interleaved).
 101     - \e RTAUDIO_MINIMIZE_LATENCY: Attempt to set stream parameters for lowest possible latency.
 102     - \e RTAUDIO_HOG_DEVICE:       Attempt grab device for exclusive use.
 103     - \e RTAUDIO_ALSA_USE_DEFAULT: Use the "default" PCM device (ALSA only).
 104     - \e RTAUDIO_JACK_DONT_CONNECT: Do not automatically connect ports (JACK only).
 105
 106     By default, RtAudio streams pass and receive audio data from the
 107     client in an interleaved format.  By passing the
 108     RTAUDIO_NONINTERLEAVED flag to the openStream() function, audio
 109     data will instead be presented in non-interleaved buffers.  In
 110     this case, each buffer argument in the RtAudioCallback function
 111     will point to a single array of data, with \c nFrames samples for
 112     each channel concatenated back-to-back.  For example, the first
 113     sample of data for the second channel would be located at index \c
 114     nFrames (assuming the \c buffer pointer was recast to the correct
 115     data type for the stream).
 116
 117     Certain audio APIs offer a number of parameters that influence the
 118     I/O latency of a stream.  By default, RtAudio will attempt to set
 119     these parameters internally for robust (glitch-free) performance
 120     (though some APIs, like Windows DirectSound, make this difficult).
 121     By passing the RTAUDIO_MINIMIZE_LATENCY flag to the openStream()
 122     function, internal stream settings will be influenced in an attempt
 123     to minimize stream latency, though possibly at the expense of stream
 124     performance.
 125
 126     If the RTAUDIO_HOG_DEVICE flag is set, RtAudio will attempt to
 127     open the input and/or output stream device(s) for exclusive use.
 128     Note that this is not possible with all supported audio APIs.
 129
 130     If the RTAUDIO_SCHEDULE_REALTIME flag is set, RtAudio will attempt
 131     to select realtime scheduling (round-robin) for the callback thread.
 132
 133     If the RTAUDIO_ALSA_USE_DEFAULT flag is set, RtAudio will attempt to
 134     open the "default" PCM device when using the ALSA API. Note that this
 135     will override any specified input or output device id.
 136
 137     If the RTAUDIO_JACK_DONT_CONNECT flag is set, RtAudio will not attempt
 138     to automatically connect the ports of the client to the audio device.
 139 */
 140 typedef unsigned int RtAudioStreamFlags;
 141 static const RtAudioStreamFlags RTAUDIO_NONINTERLEAVED = 0x1;    // Use non-interleaved buffers (default = interleaved).
 142 static const RtAudioStreamFlags RTAUDIO_MINIMIZE_LATENCY = 0x2;  // Attempt to set stream parameters for lowest possible latency.
 143 static const RtAudioStreamFlags RTAUDIO_HOG_DEVICE = 0x4;        // Attempt grab device and prevent use by others.
 144 static const RtAudioStreamFlags RTAUDIO_SCHEDULE_REALTIME = 0x8; // Try to select realtime scheduling for callback thread.
 145 static const RtAudioStreamFlags RTAUDIO_ALSA_USE_DEFAULT = 0x10; // Use the "default" PCM device (ALSA only).
 146 static const RtAudioStreamFlags RTAUDIO_JACK_DONT_CONNECT = 0x20; // Do not automatically connect ports (JACK only).
 147
 148 /*! \typedef typedef unsigned long RtAudioStreamStatus;
 149     \brief RtAudio stream status (over- or underflow) flags.
 150
 151     Notification of a stream over- or underflow is indicated by a
 152     non-zero stream \c status argument in the RtAudioCallback function.
 153     The stream status can be one of the following two options,
 154     depending on whether the stream is open for output and/or input:
 155
 156     - \e RTAUDIO_INPUT_OVERFLOW:   Input data was discarded because of an overflow condition at the driver.
 157     - \e RTAUDIO_OUTPUT_UNDERFLOW: The output buffer ran low, likely producing a break in the output sound.
 158 */
 159 typedef unsigned int RtAudioStreamStatus;
 160 static const RtAudioStreamStatus RTAUDIO_INPUT_OVERFLOW = 0x1;    // Input data was discarded because of an overflow condition at the driver.
 161 static const RtAudioStreamStatus RTAUDIO_OUTPUT_UNDERFLOW = 0x2;  // The output buffer ran low, likely causing a gap in the output sound.
 162
 163 //! RtAudio callback function prototype.
 164 /*!
 165    All RtAudio clients must create a function of type RtAudioCallback
 166    to read and/or write data from/to the audio stream.  When the
 167    underlying audio system is ready for new input or output data, this
 168    function will be invoked.
 169
 170    \param outputBuffer For output (or duplex) streams, the client
 171           should write \c nFrames of audio sample frames into this
 172           buffer.  This argument should be recast to the datatype
 173           specified when the stream was opened.  For input-only
 174           streams, this argument will be NULL.
 175
 176    \param inputBuffer For input (or duplex) streams, this buffer will
 177           hold \c nFrames of input audio sample frames.  This
 178           argument should be recast to the datatype specified when the
 179           stream was opened.  For output-only streams, this argument
 180           will be NULL.
 181
 182    \param nFrames The number of sample frames of input or output
 183           data in the buffers.  The actual buffer size in bytes is
 184           dependent on the data type and number of channels in use.
 185
 186    \param streamTime The number of seconds that have elapsed since the
 187           stream was started.
 188
 189    \param status If non-zero, this argument indicates a data overflow
 190           or underflow condition for the stream.  The particular
 191           condition can be determined by comparison with the
 192           RtAudioStreamStatus flags.
 193
 194    \param userData A pointer to optional data provided by the client
 195           when opening the stream (default = NULL).
 196
 197    \return
 198    To continue normal stream operation, the RtAudioCallback function
 199    should return a value of zero.  To stop the stream and drain the
 200    output buffer, the function should return a value of one.  To abort
 201    the stream immediately, the client should return a value of two.
 202  */
 203 typedef int (*RtAudioCallback)( void *outputBuffer, void *inputBuffer,
 204                                 unsigned int nFrames,
 205                                 double streamTime,
 206                                 RtAudioStreamStatus status,
 207                                 void *userData );
 208
 209 /************************************************************************/
 210 /*! \class RtAudioError
 211     \brief Exception handling class for RtAudio.
 212
 213     The RtAudioError class is quite simple but it does allow errors to be
 214     "caught" by RtAudioError::Type. See the RtAudio documentation to know
 215     which methods can throw an RtAudioError.
 216 */
 217 /************************************************************************/
 218
 219 class RTAUDIO_DLL_PUBLIC RtAudioError : public std::runtime_error
 220 {
 221  public:
 222   //! Defined RtAudioError types.
 223   enum Type {
 224     WARNING,           /*!< A non-critical error. */
 225     DEBUG_WARNING,     /*!< A non-critical error which might be useful for debugging. */
 226     UNSPECIFIED,       /*!< The default, unspecified error type. */
 227     NO_DEVICES_FOUND,  /*!< No devices found on system. */
 228     INVALID_DEVICE,    /*!< An invalid device ID was specified. */
 229     MEMORY_ERROR,      /*!< An error occured during memory allocation. */
 230     INVALID_PARAMETER, /*!< An invalid parameter was specified to a function. */
 231     INVALID_USE,       /*!< The function was called incorrectly. */
 232     DRIVER_ERROR,      /*!< A system driver error occured. */
 233     SYSTEM_ERROR,      /*!< A system error occured. */
 234     THREAD_ERROR       /*!< A thread error occured. */
 235   };
 236
 237   //! The constructor.
 238   RtAudioError( const std::string& message,
 239                 Type type = RtAudioError::UNSPECIFIED )
 240     : std::runtime_error(message), type_(type) {}
 241
 242   //! Prints thrown error message to stderr.
 243   virtual void printMessage( void ) const
 244     { std::cerr << '\n' << what() << "\n\n"; }
 245
 246   //! Returns the thrown error message type.
 247   virtual const Type& getType(void) const { return type_; }
 248
 249   //! Returns the thrown error message string.
 250   virtual const std::string getMessage(void) const
 251     { return std::string(what()); }
 252
 253  protected:
 254   Type type_;
 255 };
 256
 257 //! RtAudio error callback function prototype.
 258 /*!
 259     \param type Type of error.
 260     \param errorText Error description.
 261  */
 262 typedef void (*RtAudioErrorCallback)( RtAudioError::Type type, const std::string &errorText );
 263
 264 // **************************************************************** //
 265 //
 266 // RtAudio class declaration.
 267 //
 268 // RtAudio is a "controller" used to select an available audio i/o
 269 // interface.  It presents a common API for the user to call but all
 270 // functionality is implemented by the class RtApi and its
 271 // subclasses.  RtAudio creates an instance of an RtApi subclass
 272 // based on the user's API choice.  If no choice is made, RtAudio
 273 // attempts to make a "logical" API selection.
 274 //
 275 // **************************************************************** //
 276
 277 class RtApi;
 278
 279 class RTAUDIO_DLL_PUBLIC RtAudio
 280 {
 281  public:
 282
 283   //! Audio API specifier arguments.
 284   enum Api {
 285     UNSPECIFIED,    /*!< Search for a working compiled API. */
 286     LINUX_ALSA,     /*!< The Advanced Linux Sound Architecture API. */
 287     LINUX_PULSE,    /*!< The Linux PulseAudio API. */
 288     LINUX_OSS,      /*!< The Linux Open Sound System API. */
 289     UNIX_JACK,      /*!< The Jack Low-Latency Audio Server API. */
 290     MACOSX_CORE,    /*!< Macintosh OS-X Core Audio API. */
 291     WINDOWS_WASAPI, /*!< The Microsoft WASAPI API. */
 292     WINDOWS_ASIO,   /*!< The Steinberg Audio Stream I/O API. */
 293     WINDOWS_DS,     /*!< The Microsoft DirectSound API. */
 294     RTAUDIO_DUMMY,  /*!< A compilable but non-functional API. */
 295     NUM_APIS        /*!< Number of values in this enum. */
 296   };
 297
 298   //! The public device information structure for returning queried values.
 299   struct DeviceInfo {
 300     bool probed;                  /*!< true if the device capabilities were successfully probed. */
 301     std::string name;             /*!< Character string device identifier. */
 302     unsigned int outputChannels;  /*!< Maximum output channels supported by device. */
 303     unsigned int inputChannels;   /*!< Maximum input channels supported by device. */
 304     unsigned int duplexChannels;  /*!< Maximum simultaneous input/output channels supported by device. */
 305     bool isDefaultOutput;         /*!< true if this is the default output device. */
 306     bool isDefaultInput;          /*!< true if this is the default input device. */
 307     std::vector<unsigned int> sampleRates; /*!< Supported sample rates (queried from list of standard rates). */
 308     unsigned int preferredSampleRate; /*!< Preferred sample rate, e.g. for WASAPI the system sample rate. */
 309     RtAudioFormat nativeFormats;  /*!< Bit mask of supported data formats. */
 310
 311     // Default constructor.
 312     DeviceInfo()
 313       :probed(false), outputChannels(0), inputChannels(0), duplexChannels(0),
 314        isDefaultOutput(false), isDefaultInput(false), preferredSampleRate(0), nativeFormats(0) {}
 315   };
 316
 317   //! The structure for specifying input or ouput stream parameters.
 318   struct StreamParameters {
 319     unsigned int deviceId;     /*!< Device index (0 to getDeviceCount() - 1). */
 320     unsigned int nChannels;    /*!< Number of channels. */
 321     unsigned int firstChannel; /*!< First channel index on device (default = 0). */
 322
 323     // Default constructor.
 324     StreamParameters()
 325       : deviceId(0), nChannels(0), firstChannel(0) {}
 326   };
 327
 328   //! The structure for specifying stream options.
 329   /*!
 330     The following flags can be OR'ed together to allow a client to
 331     make changes to the default stream behavior:
 332
 333     - \e RTAUDIO_NONINTERLEAVED:    Use non-interleaved buffers (default = interleaved).
 334     - \e RTAUDIO_MINIMIZE_LATENCY:  Attempt to set stream parameters for lowest possible latency.
 335     - \e RTAUDIO_HOG_DEVICE:        Attempt grab device for exclusive use.
 336     - \e RTAUDIO_SCHEDULE_REALTIME: Attempt to select realtime scheduling for callback thread.
 337     - \e RTAUDIO_ALSA_USE_DEFAULT:  Use the "default" PCM device (ALSA only).
 338
 339     By default, RtAudio streams pass and receive audio data from the
 340     client in an interleaved format.  By passing the
 341     RTAUDIO_NONINTERLEAVED flag to the openStream() function, audio
 342     data will instead be presented in non-interleaved buffers.  In
 343     this case, each buffer argument in the RtAudioCallback function
 344     will point to a single array of data, with \c nFrames samples for
 345     each channel concatenated back-to-back.  For example, the first
 346     sample of data for the second channel would be located at index \c
 347     nFrames (assuming the \c buffer pointer was recast to the correct
 348     data type for the stream).
 349
 350     Certain audio APIs offer a number of parameters that influence the
 351     I/O latency of a stream.  By default, RtAudio will attempt to set
 352     these parameters internally for robust (glitch-free) performance
 353     (though some APIs, like Windows DirectSound, make this difficult).
 354     By passing the RTAUDIO_MINIMIZE_LATENCY flag to the openStream()
 355     function, internal stream settings will be influenced in an attempt
 356     to minimize stream latency, though possibly at the expense of stream
 357     performance.
 358
 359     If the RTAUDIO_HOG_DEVICE flag is set, RtAudio will attempt to
 360     open the input and/or output stream device(s) for exclusive use.
 361     Note that this is not possible with all supported audio APIs.
 362
 363     If the RTAUDIO_SCHEDULE_REALTIME flag is set, RtAudio will attempt
 364     to select realtime scheduling (round-robin) for the callback thread.
 365     The \c priority parameter will only be used if the RTAUDIO_SCHEDULE_REALTIME
 366     flag is set. It defines the thread's realtime priority.
 367
 368     If the RTAUDIO_ALSA_USE_DEFAULT flag is set, RtAudio will attempt to
 369     open the "default" PCM device when using the ALSA API. Note that this
 370     will override any specified input or output device id.
 371
 372     The \c numberOfBuffers parameter can be used to control stream
 373     latency in the Windows DirectSound, Linux OSS, and Linux Alsa APIs
 374     only.  A value of two is usually the smallest allowed.  Larger
 375     numbers can potentially result in more robust stream performance,
 376     though likely at the cost of stream latency.  The value set by the
 377     user is replaced during execution of the RtAudio::openStream()
 378     function by the value actually used by the system.
 379
 380     The \c streamName parameter can be used to set the client name
 381     when using the Jack API.  By default, the client name is set to
 382     RtApiJack.  However, if you wish to create multiple instances of
 383     RtAudio with Jack, each instance must have a unique client name.
 384   */
 385   struct StreamOptions {
 386     RtAudioStreamFlags flags;      /*!< A bit-mask of stream flags (RTAUDIO_NONINTERLEAVED, RTAUDIO_MINIMIZE_LATENCY, RTAUDIO_HOG_DEVICE, RTAUDIO_ALSA_USE_DEFAULT). */
 387     unsigned int numberOfBuffers;  /*!< Number of stream buffers. */
 388     std::string streamName;        /*!< A stream name (currently used only in Jack). */
 389     int priority;                  /*!< Scheduling priority of callback thread (only used with flag RTAUDIO_SCHEDULE_REALTIME). */
 390
 391     // Default constructor.
 392     StreamOptions()
 393     : flags(0), numberOfBuffers(0), priority(0) {}
 394   };
 395
 396   //! A static function to determine the current RtAudio version.
 397   static std::string getVersion( void );
 398
 399   //! A static function to determine the available compiled audio APIs.
 400   /*!
 401     The values returned in the std::vector can be compared against
 402     the enumerated list values.  Note that there can be more than one
 403     API compiled for certain operating systems.
 404   */
 405   static void getCompiledApi( std::vector<RtAudio::Api> &apis );
 406
 407   //! Return the name of a specified compiled audio API.
 408   /*!
 409     This obtains a short lower-case name used for identification purposes.
 410     This value is guaranteed to remain identical across library versions.
 411     If the API is unknown, this function will return the empty string.
 412   */
 413   static std::string getApiName( RtAudio::Api api );
 414
 415   //! Return the display name of a specified compiled audio API.
 416   /*!
 417     This obtains a long name used for display purposes.
 418     If the API is unknown, this function will return the empty string.
 419   */
 420   static std::string getApiDisplayName( 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   #include <stdint.h>
 627
 628   typedef uintptr_t ThreadHandle;
 629   typedef CRITICAL_SECTION StreamMutex;
 630
 631 #elif defined(__LINUX_ALSA__) || defined(__LINUX_PULSE__) || defined(__UNIX_JACK__) || defined(__LINUX_OSS__) || defined(__MACOSX_CORE__)
 632   // Using pthread library for various flavors of unix.
 633   #include <pthread.h>
 634
 635   typedef pthread_t ThreadHandle;
 636   typedef pthread_mutex_t StreamMutex;
 637
 638 #else // Setup for "dummy" behavior
 639
 640   #define __RTAUDIO_DUMMY__
 641   typedef int ThreadHandle;
 642   typedef int StreamMutex;
 643
 644 #endif
 645
 646 // This global structure type is used to pass callback information
 647 // between the private RtAudio stream structure and global callback
 648 // handling functions.
 649 struct CallbackInfo {
 650   void *object;    // Used as a "this" pointer.
 651   ThreadHandle thread;
 652   void *callback;
 653   void *userData;
 654   void *errorCallback;
 655   void *apiInfo;   // void pointer for API specific callback information
 656   bool isRunning;
 657   bool doRealtime;
 658   int priority;
 659
 660   // Default constructor.
 661   CallbackInfo()
 662   :object(0), callback(0), userData(0), errorCallback(0), apiInfo(0), isRunning(false), doRealtime(false), priority(0) {}
 663 };
 664
 665 // **************************************************************** //
 666 //
 667 // RtApi class declaration.
 668 //
 669 // Subclasses of RtApi contain all API- and OS-specific code necessary
 670 // to fully implement the RtAudio API.
 671 //
 672 // Note that RtApi is an abstract base class and cannot be
 673 // explicitly instantiated.  The class RtAudio will create an
 674 // instance of an RtApi subclass (RtApiOss, RtApiAlsa,
 675 // RtApiJack, RtApiCore, RtApiDs, or RtApiAsio).
 676 //
 677 // **************************************************************** //
 678
 679 #pragma pack(push, 1)
 680 class S24 {
 681
 682  protected:
 683   unsigned char c3[3];
 684
 685  public:
 686   S24() {}
 687
 688   S24& operator = ( const int& i ) {
 689     c3[0] = (i & 0x000000ff);
 690     c3[1] = (i & 0x0000ff00) >> 8;
 691     c3[2] = (i & 0x00ff0000) >> 16;
 692     return *this;
 693   }
 694
 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
 908   // This function is intended for internal use only.  It must be
 909   // public because it is called by the internal callback handler,
 910   // which is not a member of RtAudio.  External use of this function
 911   // will most likely produce highly undesireable results!
 912   bool callbackEvent( AudioDeviceID deviceId,
 913                       const AudioBufferList *inBufferList,
 914                       const AudioBufferList *outBufferList );
 915
 916   private:
 917
 918   bool probeDeviceOpen( unsigned int device, StreamMode mode, unsigned int channels,
 919                         unsigned int firstChannel, unsigned int sampleRate,
 920                         RtAudioFormat format, unsigned int *bufferSize,
 921                         RtAudio::StreamOptions *options );
 922   static const char* getErrorCode( OSStatus code );
 923 };
 924
 925 #endif
 926
 927 #if defined(__UNIX_JACK__)
 928
 929 class RtApiJack: public RtApi
 930 {
 931 public:
 932
 933   RtApiJack();
 934   ~RtApiJack();
 935   RtAudio::Api getCurrentApi( void ) { return RtAudio::UNIX_JACK; }
 936   unsigned int getDeviceCount( void );
 937   RtAudio::DeviceInfo getDeviceInfo( unsigned int device );
 938   void closeStream( void );
 939   void startStream( void );
 940   void stopStream( void );
 941   void abortStream( void );
 942
 943   // This function is intended for internal use only.  It must be
 944   // public because it is called by the internal callback handler,
 945   // which is not a member of RtAudio.  External use of this function
 946   // will most likely produce highly undesireable results!
 947   bool callbackEvent( unsigned long nframes );
 948
 949   private:
 950
 951   bool probeDeviceOpen( unsigned int device, StreamMode mode, unsigned int channels,
 952                         unsigned int firstChannel, unsigned int sampleRate,
 953                         RtAudioFormat format, unsigned int *bufferSize,
 954                         RtAudio::StreamOptions *options );
 955
 956   bool shouldAutoconnect_;
 957 };
 958
 959 #endif
 960
 961 #if defined(__WINDOWS_ASIO__)
 962
 963 class RtApiAsio: public RtApi
 964 {
 965 public:
 966
 967   RtApiAsio();
 968   ~RtApiAsio();
 969   RtAudio::Api getCurrentApi( void ) { return RtAudio::WINDOWS_ASIO; }
 970   unsigned int getDeviceCount( void );
 971   RtAudio::DeviceInfo getDeviceInfo( unsigned int device );
 972   void closeStream( void );
 973   void startStream( void );
 974   void stopStream( void );
 975   void abortStream( void );
 976
 977   // This function is intended for internal use only.  It must be
 978   // public because it is called by the internal callback handler,
 979   // which is not a member of RtAudio.  External use of this function
 980   // will most likely produce highly undesireable results!
 981   bool callbackEvent( long bufferIndex );
 982
 983   private:
 984
 985   std::vector<RtAudio::DeviceInfo> devices_;
 986   void saveDeviceInfo( void );
 987   bool coInitialized_;
 988   bool probeDeviceOpen( unsigned int device, StreamMode mode, unsigned int channels,
 989                         unsigned int firstChannel, unsigned int sampleRate,
 990                         RtAudioFormat format, unsigned int *bufferSize,
 991                         RtAudio::StreamOptions *options );
 992 };
 993
 994 #endif
 995
 996 #if defined(__WINDOWS_DS__)
 997
 998 class RtApiDs: public RtApi
 999 {
1000 public:
1001
1002   RtApiDs();
1003   ~RtApiDs();
1004   RtAudio::Api getCurrentApi( void ) { return RtAudio::WINDOWS_DS; }
1005   unsigned int getDeviceCount( void );
1006   unsigned int getDefaultOutputDevice( void );
1007   unsigned int getDefaultInputDevice( void );
1008   RtAudio::DeviceInfo getDeviceInfo( unsigned int device );
1009   void closeStream( void );
1010   void startStream( void );
1011   void stopStream( void );
1012   void abortStream( void );
1013
1014   // This function is intended for internal use only.  It must be
1015   // public because it is called by the internal callback handler,
1016   // which is not a member of RtAudio.  External use of this function
1017   // will most likely produce highly undesireable results!
1018   void callbackEvent( void );
1019
1020   private:
1021
1022   bool coInitialized_;
1023   bool buffersRolling;
1024   long duplexPrerollBytes;
1025   std::vector<struct DsDevice> dsDevices;
1026   bool probeDeviceOpen( unsigned int device, StreamMode mode, unsigned int channels,
1027                         unsigned int firstChannel, unsigned int sampleRate,
1028                         RtAudioFormat format, unsigned int *bufferSize,
1029                         RtAudio::StreamOptions *options );
1030 };
1031
1032 #endif
1033
1034 #if defined(__WINDOWS_WASAPI__)
1035
1036 struct IMMDeviceEnumerator;
1037
1038 class RtApiWasapi : public RtApi
1039 {
1040 public:
1041   RtApiWasapi();
1042   virtual ~RtApiWasapi();
1043
1044   RtAudio::Api getCurrentApi( void ) { return RtAudio::WINDOWS_WASAPI; }
1045   unsigned int getDeviceCount( void );
1046   RtAudio::DeviceInfo getDeviceInfo( unsigned int device );
1047   unsigned int getDefaultOutputDevice( void );
1048   unsigned int getDefaultInputDevice( void );
1049   void closeStream( void );
1050   void startStream( void );
1051   void stopStream( void );
1052   void abortStream( void );
1053
1054 private:
1055   bool coInitialized_;
1056   IMMDeviceEnumerator* deviceEnumerator_;
1057
1058   bool probeDeviceOpen( unsigned int device, StreamMode mode, unsigned int channels,
1059                         unsigned int firstChannel, unsigned int sampleRate,
1060                         RtAudioFormat format, unsigned int* bufferSize,
1061                         RtAudio::StreamOptions* options );
1062
1063   static DWORD WINAPI runWasapiThread( void* wasapiPtr );
1064   static DWORD WINAPI stopWasapiThread( void* wasapiPtr );
1065   static DWORD WINAPI abortWasapiThread( void* wasapiPtr );
1066   void wasapiThread();
1067 };
1068
1069 #endif
1070
1071 #if defined(__LINUX_ALSA__)
1072
1073 class RtApiAlsa: public RtApi
1074 {
1075 public:
1076
1077   RtApiAlsa();
1078   ~RtApiAlsa();
1079   RtAudio::Api getCurrentApi() { return RtAudio::LINUX_ALSA; }
1080   unsigned int getDeviceCount( void );
1081   RtAudio::DeviceInfo getDeviceInfo( unsigned int device );
1082   void closeStream( void );
1083   void startStream( void );
1084   void stopStream( void );
1085   void abortStream( void );
1086
1087   // This function is intended for internal use only.  It must be
1088   // public because it is called by the internal callback handler,
1089   // which is not a member of RtAudio.  External use of this function
1090   // will most likely produce highly undesireable results!
1091   void callbackEvent( void );
1092
1093   private:
1094
1095   std::vector<RtAudio::DeviceInfo> devices_;
1096   void saveDeviceInfo( void );
1097   bool probeDeviceOpen( unsigned int device, StreamMode mode, unsigned int channels,
1098                         unsigned int firstChannel, unsigned int sampleRate,
1099                         RtAudioFormat format, unsigned int *bufferSize,
1100                         RtAudio::StreamOptions *options );
1101 };
1102
1103 #endif
1104
1105 #if defined(__LINUX_PULSE__)
1106
1107 class RtApiPulse: public RtApi
1108 {
1109 public:
1110   ~RtApiPulse();
1111   RtAudio::Api getCurrentApi() { return RtAudio::LINUX_PULSE; }
1112   unsigned int getDeviceCount( void );
1113   RtAudio::DeviceInfo getDeviceInfo( unsigned int device );
1114   void closeStream( void );
1115   void startStream( void );
1116   void stopStream( void );
1117   void abortStream( void );
1118
1119   // This function is intended for internal use only.  It must be
1120   // public because it is called by the internal callback handler,
1121   // which is not a member of RtAudio.  External use of this function
1122   // will most likely produce highly undesireable results!
1123   void callbackEvent( void );
1124
1125   private:
1126
1127   std::vector<RtAudio::DeviceInfo> devices_;
1128   void saveDeviceInfo( void );
1129   bool probeDeviceOpen( unsigned int device, StreamMode mode, unsigned int channels,
1130                         unsigned int firstChannel, unsigned int sampleRate,
1131                         RtAudioFormat format, unsigned int *bufferSize,
1132                         RtAudio::StreamOptions *options );
1133 };
1134
1135 #endif
1136
1137 #if defined(__LINUX_OSS__)
1138
1139 class RtApiOss: public RtApi
1140 {
1141 public:
1142
1143   RtApiOss();
1144   ~RtApiOss();
1145   RtAudio::Api getCurrentApi() { return RtAudio::LINUX_OSS; }
1146   unsigned int getDeviceCount( void );
1147   RtAudio::DeviceInfo getDeviceInfo( unsigned int device );
1148   void closeStream( void );
1149   void startStream( void );
1150   void stopStream( void );
1151   void abortStream( void );
1152
1153   // This function is intended for internal use only.  It must be
1154   // public because it is called by the internal callback handler,
1155   // which is not a member of RtAudio.  External use of this function
1156   // will most likely produce highly undesireable results!
1157   void callbackEvent( void );
1158
1159   private:
1160
1161   bool probeDeviceOpen( unsigned int device, StreamMode mode, unsigned int channels,
1162                         unsigned int firstChannel, unsigned int sampleRate,
1163                         RtAudioFormat format, unsigned int *bufferSize,
1164                         RtAudio::StreamOptions *options );
1165 };
1166
1167 #endif
1168
1169 #if defined(__RTAUDIO_DUMMY__)
1170
1171 class RtApiDummy: public RtApi
1172 {
1173 public:
1174
1175   RtApiDummy() { errorText_ = "RtApiDummy: This class provides no functionality."; error( RtAudioError::WARNING ); }
1176   RtAudio::Api getCurrentApi( void ) { return RtAudio::RTAUDIO_DUMMY; }
1177   unsigned int getDeviceCount( void ) { return 0; }
1178   RtAudio::DeviceInfo getDeviceInfo( unsigned int /*device*/ ) { RtAudio::DeviceInfo info; return info; }
1179   void closeStream( void ) {}
1180   void startStream( void ) {}
1181   void stopStream( void ) {}
1182   void abortStream( void ) {}
1183
1184   private:
1185
1186   bool probeDeviceOpen( unsigned int /*device*/, StreamMode /*mode*/, unsigned int /*channels*/,
1187                         unsigned int /*firstChannel*/, unsigned int /*sampleRate*/,
1188                         RtAudioFormat /*format*/, unsigned int * /*bufferSize*/,
1189                         RtAudio::StreamOptions * /*options*/ ) { return false; }
1190 };
1191
1192 #endif
1193
1194 #endif
1195
1196 // Indentation settings for Vim and Emacs
1197 //
1198 // Local Variables:
1199 // c-basic-offset: 2
1200 // indent-tabs-mode: nil
1201 // End:
1202 //
1203 // vim: et sts=2 sw=2