RtAudio.h

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