1 /************************************************************************/
3 \brief Realtime audio i/o C++ classes.
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.
10 RtAudio WWW site: http://www.music.mcgill.ca/~gary/rtaudio/
12 RtAudio: realtime audio i/o C++ classes
13 Copyright (c) 2001-2013 Gary P. Scavone
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:
23 The above copyright notice and this permission notice shall be
24 included in all copies or substantial portions of the Software.
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.
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.
39 /************************************************************************/
54 static const std::string VERSION( "4.1.0pre" );
56 /*! \typedef typedef unsigned long RtAudioFormat;
57 \brief RtAudio data format type.
59 Support for signed integers and floats. Audio data fed to/from an
60 RtAudio stream is assumed to ALWAYS be in host byte order. The
61 internal routines will automatically take care of any necessary
62 byte-swapping between the host format and the soundcard. Thus,
63 endian-ness is not a concern in the following format definitions.
65 - \e RTAUDIO_SINT8: 8-bit signed integer.
66 - \e RTAUDIO_SINT16: 16-bit signed integer.
67 - \e RTAUDIO_SINT24: 24-bit signed integer.
68 - \e RTAUDIO_SINT32: 32-bit signed integer.
69 - \e RTAUDIO_FLOAT32: Normalized between plus/minus 1.0.
70 - \e RTAUDIO_FLOAT64: Normalized between plus/minus 1.0.
72 typedef unsigned long RtAudioFormat;
73 static const RtAudioFormat RTAUDIO_SINT8 = 0x1; // 8-bit signed integer.
74 static const RtAudioFormat RTAUDIO_SINT16 = 0x2; // 16-bit signed integer.
75 static const RtAudioFormat RTAUDIO_SINT24 = 0x4; // 24-bit signed integer.
76 static const RtAudioFormat RTAUDIO_SINT32 = 0x8; // 32-bit signed integer.
77 static const RtAudioFormat RTAUDIO_FLOAT32 = 0x10; // Normalized between plus/minus 1.0.
78 static const RtAudioFormat RTAUDIO_FLOAT64 = 0x20; // Normalized between plus/minus 1.0.
80 /*! \typedef typedef unsigned long RtAudioStreamFlags;
81 \brief RtAudio stream option flags.
83 The following flags can be OR'ed together to allow a client to
84 make changes to the default stream behavior:
86 - \e RTAUDIO_NONINTERLEAVED: Use non-interleaved buffers (default = interleaved).
87 - \e RTAUDIO_MINIMIZE_LATENCY: Attempt to set stream parameters for lowest possible latency.
88 - \e RTAUDIO_HOG_DEVICE: Attempt grab device for exclusive use.
89 - \e RTAUDIO_ALSA_USE_DEFAULT: Use the "default" PCM device (ALSA only).
91 By default, RtAudio streams pass and receive audio data from the
92 client in an interleaved format. By passing the
93 RTAUDIO_NONINTERLEAVED flag to the openStream() function, audio
94 data will instead be presented in non-interleaved buffers. In
95 this case, each buffer argument in the RtAudioCallback function
96 will point to a single array of data, with \c nFrames samples for
97 each channel concatenated back-to-back. For example, the first
98 sample of data for the second channel would be located at index \c
99 nFrames (assuming the \c buffer pointer was recast to the correct
100 data type for the stream).
102 Certain audio APIs offer a number of parameters that influence the
103 I/O latency of a stream. By default, RtAudio will attempt to set
104 these parameters internally for robust (glitch-free) performance
105 (though some APIs, like Windows Direct Sound, make this difficult).
106 By passing the RTAUDIO_MINIMIZE_LATENCY flag to the openStream()
107 function, internal stream settings will be influenced in an attempt
108 to minimize stream latency, though possibly at the expense of stream
111 If the RTAUDIO_HOG_DEVICE flag is set, RtAudio will attempt to
112 open the input and/or output stream device(s) for exclusive use.
113 Note that this is not possible with all supported audio APIs.
115 If the RTAUDIO_SCHEDULE_REALTIME flag is set, RtAudio will attempt
116 to select realtime scheduling (round-robin) for the callback thread.
118 If the RTAUDIO_ALSA_USE_DEFAULT flag is set, RtAudio will attempt to
119 open the "default" PCM device when using the ALSA API. Note that this
120 will override any specified input or output device id.
122 typedef unsigned int RtAudioStreamFlags;
123 static const RtAudioStreamFlags RTAUDIO_NONINTERLEAVED = 0x1; // Use non-interleaved buffers (default = interleaved).
124 static const RtAudioStreamFlags RTAUDIO_MINIMIZE_LATENCY = 0x2; // Attempt to set stream parameters for lowest possible latency.
125 static const RtAudioStreamFlags RTAUDIO_HOG_DEVICE = 0x4; // Attempt grab device and prevent use by others.
126 static const RtAudioStreamFlags RTAUDIO_SCHEDULE_REALTIME = 0x8; // Try to select realtime scheduling for callback thread.
127 static const RtAudioStreamFlags RTAUDIO_ALSA_USE_DEFAULT = 0x10; // Use the "default" PCM device (ALSA only).
129 /*! \typedef typedef unsigned long RtAudioStreamStatus;
130 \brief RtAudio stream status (over- or underflow) flags.
132 Notification of a stream over- or underflow is indicated by a
133 non-zero stream \c status argument in the RtAudioCallback function.
134 The stream status can be one of the following two options,
135 depending on whether the stream is open for output and/or input:
137 - \e RTAUDIO_INPUT_OVERFLOW: Input data was discarded because of an overflow condition at the driver.
138 - \e RTAUDIO_OUTPUT_UNDERFLOW: The output buffer ran low, likely producing a break in the output sound.
140 typedef unsigned int RtAudioStreamStatus;
141 static const RtAudioStreamStatus RTAUDIO_INPUT_OVERFLOW = 0x1; // Input data was discarded because of an overflow condition at the driver.
142 static const RtAudioStreamStatus RTAUDIO_OUTPUT_UNDERFLOW = 0x2; // The output buffer ran low, likely causing a gap in the output sound.
144 //! RtAudio callback function prototype.
146 All RtAudio clients must create a function of type RtAudioCallback
147 to read and/or write data from/to the audio stream. When the
148 underlying audio system is ready for new input or output data, this
149 function will be invoked.
151 \param outputBuffer For output (or duplex) streams, the client
152 should write \c nFrames of audio sample frames into this
153 buffer. This argument should be recast to the datatype
154 specified when the stream was opened. For input-only
155 streams, this argument will be NULL.
157 \param inputBuffer For input (or duplex) streams, this buffer will
158 hold \c nFrames of input audio sample frames. This
159 argument should be recast to the datatype specified when the
160 stream was opened. For output-only streams, this argument
163 \param nFrames The number of sample frames of input or output
164 data in the buffers. The actual buffer size in bytes is
165 dependent on the data type and number of channels in use.
167 \param streamTime The number of seconds that have elapsed since the
170 \param status If non-zero, this argument indicates a data overflow
171 or underflow condition for the stream. The particular
172 condition can be determined by comparison with the
173 RtAudioStreamStatus flags.
175 \param userData A pointer to optional data provided by the client
176 when opening the stream (default = NULL).
178 To continue normal stream operation, the RtAudioCallback function
179 should return a value of zero. To stop the stream and drain the
180 output buffer, the function should return a value of one. To abort
181 the stream immediately, the client should return a value of two.
183 typedef int (*RtAudioCallback)( void *outputBuffer, void *inputBuffer,
184 unsigned int nFrames,
186 RtAudioStreamStatus status,
189 /************************************************************************/
190 /*! \class RtAudioError
191 \brief Exception handling class for RtAudio.
193 The RtAudioError class is quite simple but it does allow errors to be
194 "caught" by RtAudioError::Type. See the RtAudio and RtMidi
195 documentation to know which methods can throw an RtAudioError.
198 /************************************************************************/
200 class RtAudioError : public std::exception
203 //! Defined RtAudioError types.
205 WARNING, /*!< A non-critical error. */
206 DEBUG_WARNING, /*!< A non-critical error which might be useful for debugging. */
207 UNSPECIFIED, /*!< The default, unspecified error type. */
208 NO_DEVICES_FOUND, /*!< No devices found on system. */
209 INVALID_DEVICE, /*!< An invalid device ID was specified. */
210 MEMORY_ERROR, /*!< An error occured during memory allocation. */
211 INVALID_PARAMETER, /*!< An invalid parameter was specified to a function. */
212 INVALID_USE, /*!< The function was called incorrectly. */
213 DRIVER_ERROR, /*!< A system driver error occured. */
214 SYSTEM_ERROR, /*!< A system error occured. */
215 THREAD_ERROR /*!< A thread error occured. */
219 RtAudioError( const std::string& message, Type type = RtAudioError::UNSPECIFIED ) throw() : message_(message), type_(type) {}
222 virtual ~RtAudioError( void ) throw() {}
224 //! Prints thrown error message to stderr.
225 virtual void printMessage( void ) const throw() { std::cerr << '\n' << message_ << "\n\n"; }
227 //! Returns the thrown error message type.
228 virtual const Type& getType(void) const throw() { return type_; }
230 //! Returns the thrown error message string.
231 virtual const std::string& getMessage(void) const throw() { return message_; }
233 //! Returns the thrown error message as a c-style string.
234 virtual const char* what( void ) const throw() { return message_.c_str(); }
237 std::string message_;
241 //! RtAudio error callback function prototype.
243 \param type Type of error.
244 \param errorText Error description.
246 typedef void (*RtAudioErrorCallback)( RtAudioError::Type type, const std::string &errorText );
248 // **************************************************************** //
250 // RtAudio class declaration.
252 // RtAudio is a "controller" used to select an available audio i/o
253 // interface. It presents a common API for the user to call but all
254 // functionality is implemented by the class RtApi and its
255 // subclasses. RtAudio creates an instance of an RtApi subclass
256 // based on the user's API choice. If no choice is made, RtAudio
257 // attempts to make a "logical" API selection.
259 // **************************************************************** //
267 //! Audio API specifier arguments.
269 UNSPECIFIED, /*!< Search for a working compiled API. */
270 LINUX_ALSA, /*!< The Advanced Linux Sound Architecture API. */
271 LINUX_PULSE, /*!< The Linux PulseAudio API. */
272 LINUX_OSS, /*!< The Linux Open Sound System API. */
273 UNIX_JACK, /*!< The Jack Low-Latency Audio Server API. */
274 MACOSX_CORE, /*!< Macintosh OS-X Core Audio API. */
275 WINDOWS_ASIO, /*!< The Steinberg Audio Stream I/O API. */
276 WINDOWS_DS, /*!< The Microsoft Direct Sound API. */
277 RTAUDIO_DUMMY /*!< A compilable but non-functional API. */
280 //! The public device information structure for returning queried values.
282 bool probed; /*!< true if the device capabilities were successfully probed. */
283 std::string name; /*!< Character string device identifier. */
284 unsigned int outputChannels; /*!< Maximum output channels supported by device. */
285 unsigned int inputChannels; /*!< Maximum input channels supported by device. */
286 unsigned int duplexChannels; /*!< Maximum simultaneous input/output channels supported by device. */
287 bool isDefaultOutput; /*!< true if this is the default output device. */
288 bool isDefaultInput; /*!< true if this is the default input device. */
289 std::vector<unsigned int> sampleRates; /*!< Supported sample rates (queried from list of standard rates). */
290 RtAudioFormat nativeFormats; /*!< Bit mask of supported data formats. */
292 // Default constructor.
294 :probed(false), outputChannels(0), inputChannels(0), duplexChannels(0),
295 isDefaultOutput(false), isDefaultInput(false), nativeFormats(0) {}
298 //! The structure for specifying input or ouput stream parameters.
299 struct StreamParameters {
300 unsigned int deviceId; /*!< Device index (0 to getDeviceCount() - 1). */
301 unsigned int nChannels; /*!< Number of channels. */
302 unsigned int firstChannel; /*!< First channel index on device (default = 0). */
304 // Default constructor.
306 : deviceId(0), nChannels(0), firstChannel(0) {}
309 //! The structure for specifying stream options.
311 The following flags can be OR'ed together to allow a client to
312 make changes to the default stream behavior:
314 - \e RTAUDIO_NONINTERLEAVED: Use non-interleaved buffers (default = interleaved).
315 - \e RTAUDIO_MINIMIZE_LATENCY: Attempt to set stream parameters for lowest possible latency.
316 - \e RTAUDIO_HOG_DEVICE: Attempt grab device for exclusive use.
317 - \e RTAUDIO_SCHEDULE_REALTIME: Attempt to select realtime scheduling for callback thread.
318 - \e RTAUDIO_ALSA_USE_DEFAULT: Use the "default" PCM device (ALSA only).
320 By default, RtAudio streams pass and receive audio data from the
321 client in an interleaved format. By passing the
322 RTAUDIO_NONINTERLEAVED flag to the openStream() function, audio
323 data will instead be presented in non-interleaved buffers. In
324 this case, each buffer argument in the RtAudioCallback function
325 will point to a single array of data, with \c nFrames samples for
326 each channel concatenated back-to-back. For example, the first
327 sample of data for the second channel would be located at index \c
328 nFrames (assuming the \c buffer pointer was recast to the correct
329 data type for the stream).
331 Certain audio APIs offer a number of parameters that influence the
332 I/O latency of a stream. By default, RtAudio will attempt to set
333 these parameters internally for robust (glitch-free) performance
334 (though some APIs, like Windows Direct Sound, make this difficult).
335 By passing the RTAUDIO_MINIMIZE_LATENCY flag to the openStream()
336 function, internal stream settings will be influenced in an attempt
337 to minimize stream latency, though possibly at the expense of stream
340 If the RTAUDIO_HOG_DEVICE flag is set, RtAudio will attempt to
341 open the input and/or output stream device(s) for exclusive use.
342 Note that this is not possible with all supported audio APIs.
344 If the RTAUDIO_SCHEDULE_REALTIME flag is set, RtAudio will attempt
345 to select realtime scheduling (round-robin) for the callback thread.
346 The \c priority parameter will only be used if the RTAUDIO_SCHEDULE_REALTIME
347 flag is set. It defines the thread's realtime priority.
349 If the RTAUDIO_ALSA_USE_DEFAULT flag is set, RtAudio will attempt to
350 open the "default" PCM device when using the ALSA API. Note that this
351 will override any specified input or output device id.
353 The \c numberOfBuffers parameter can be used to control stream
354 latency in the Windows DirectSound, Linux OSS, and Linux Alsa APIs
355 only. A value of two is usually the smallest allowed. Larger
356 numbers can potentially result in more robust stream performance,
357 though likely at the cost of stream latency. The value set by the
358 user is replaced during execution of the RtAudio::openStream()
359 function by the value actually used by the system.
361 The \c streamName parameter can be used to set the client name
362 when using the Jack API. By default, the client name is set to
363 RtApiJack. However, if you wish to create multiple instances of
364 RtAudio with Jack, each instance must have a unique client name.
366 struct StreamOptions {
367 RtAudioStreamFlags flags; /*!< A bit-mask of stream flags (RTAUDIO_NONINTERLEAVED, RTAUDIO_MINIMIZE_LATENCY, RTAUDIO_HOG_DEVICE, RTAUDIO_ALSA_USE_DEFAULT). */
368 unsigned int numberOfBuffers; /*!< Number of stream buffers. */
369 std::string streamName; /*!< A stream name (currently used only in Jack). */
370 int priority; /*!< Scheduling priority of callback thread (only used with flag RTAUDIO_SCHEDULE_REALTIME). */
372 // Default constructor.
374 : flags(0), numberOfBuffers(0), priority(0) {}
377 //! A static function to determine the current RtAudio version.
378 static std::string getVersion( void ) { return VERSION; }
380 //! A static function to determine the available compiled audio APIs.
382 The values returned in the std::vector can be compared against
383 the enumerated list values. Note that there can be more than one
384 API compiled for certain operating systems.
386 static void getCompiledApi( std::vector<RtAudio::Api> &apis ) throw();
388 //! The class constructor.
390 The constructor performs minor initialization tasks. No exceptions
393 If no API argument is specified and multiple API support has been
394 compiled, the default order of use is JACK, ALSA, OSS (Linux
395 systems) and ASIO, DS (Windows systems).
397 RtAudio( RtAudio::Api api=UNSPECIFIED ) throw();
401 If a stream is running or open, it will be stopped and closed
406 //! Returns the audio API specifier for the current instance of RtAudio.
407 RtAudio::Api getCurrentApi( void ) throw();
409 //! A public function that queries for the number of audio devices available.
411 This function performs a system query of available devices each time it
412 is called, thus supporting devices connected \e after instantiation. If
413 a system error occurs during processing, a warning will be issued.
415 unsigned int getDeviceCount( void ) throw();
417 //! Return an RtAudio::DeviceInfo structure for a specified device number.
420 Any device integer between 0 and getDeviceCount() - 1 is valid.
421 If an invalid argument is provided, an RtAudioError (type = INVALID_USE)
422 will be thrown. If a device is busy or otherwise unavailable, the
423 structure member "probed" will have a value of "false" and all
424 other members are undefined. If the specified device is the
425 current default input or output device, the corresponding
426 "isDefault" member will have a value of "true".
428 RtAudio::DeviceInfo getDeviceInfo( unsigned int device );
430 //! A function that returns the index of the default output device.
432 If the underlying audio API does not provide a "default
433 device", or if no devices are available, the return value will be
434 0. Note that this is a valid device identifier and it is the
435 client's responsibility to verify that a device is available
436 before attempting to open a stream.
438 unsigned int getDefaultOutputDevice( void ) throw();
440 //! A function that returns the index of the default input device.
442 If the underlying audio API does not provide a "default
443 device", or if no devices are available, the return value will be
444 0. Note that this is a valid device identifier and it is the
445 client's responsibility to verify that a device is available
446 before attempting to open a stream.
448 unsigned int getDefaultInputDevice( void ) throw();
450 //! A public function for opening a stream with the specified parameters.
452 An RtAudioError (type = SYSTEM_ERROR) is thrown if a stream cannot be
453 opened with the specified parameters or an error occurs during
454 processing. An RtAudioError (type = INVALID_USE) is thrown if any
455 invalid device ID or channel number parameters are specified.
457 \param outputParameters Specifies output stream parameters to use
458 when opening a stream, including a device ID, number of channels,
459 and starting channel number. For input-only streams, this
460 argument should be NULL. The device ID is an index value between
461 0 and getDeviceCount() - 1.
462 \param inputParameters Specifies input stream parameters to use
463 when opening a stream, including a device ID, number of channels,
464 and starting channel number. For output-only streams, this
465 argument should be NULL. The device ID is an index value between
466 0 and getDeviceCount() - 1.
467 \param format An RtAudioFormat specifying the desired sample data format.
468 \param sampleRate The desired sample rate (sample frames per second).
469 \param *bufferFrames A pointer to a value indicating the desired
470 internal buffer size in sample frames. The actual value
471 used by the device is returned via the same pointer. A
472 value of zero can be specified, in which case the lowest
473 allowable value is determined.
474 \param callback A client-defined function that will be invoked
475 when input data is available and/or output data is needed.
476 \param userData An optional pointer to data that can be accessed
477 from within the callback function.
478 \param options An optional pointer to a structure containing various
479 global stream options, including a list of OR'ed RtAudioStreamFlags
480 and a suggested number of stream buffers that can be used to
481 control stream latency. More buffers typically result in more
482 robust performance, though at a cost of greater latency. If a
483 value of zero is specified, a system-specific median value is
484 chosen. If the RTAUDIO_MINIMIZE_LATENCY flag bit is set, the
485 lowest allowable value is used. The actual value used is
486 returned via the structure argument. The parameter is API dependent.
487 \param errorCallback A client-defined function that will be invoked
488 when an error has occured.
490 void openStream( RtAudio::StreamParameters *outputParameters,
491 RtAudio::StreamParameters *inputParameters,
492 RtAudioFormat format, unsigned int sampleRate,
493 unsigned int *bufferFrames, RtAudioCallback callback,
494 void *userData = NULL, RtAudio::StreamOptions *options = NULL, RtAudioErrorCallback errorCallback = NULL );
496 //! A function that closes a stream and frees any associated stream memory.
498 If a stream is not open, this function issues a warning and
499 returns (no exception is thrown).
501 void closeStream( void ) throw();
503 //! A function that starts a stream.
505 An RtAudioError (type = SYSTEM_ERROR) is thrown if an error occurs
506 during processing. An RtAudioError (type = INVALID_USE) is thrown if a
507 stream is not open. A warning is issued if the stream is already
510 void startStream( void );
512 //! Stop a stream, allowing any samples remaining in the output queue to be played.
514 An RtAudioError (type = SYSTEM_ERROR) is thrown if an error occurs
515 during processing. An RtAudioError (type = INVALID_USE) is thrown if a
516 stream is not open. A warning is issued if the stream is already
519 void stopStream( void );
521 //! Stop a stream, discarding any samples remaining in the input/output queue.
523 An RtAudioError (type = SYSTEM_ERROR) is thrown if an error occurs
524 during processing. An RtAudioError (type = INVALID_USE) is thrown if a
525 stream is not open. A warning is issued if the stream is already
528 void abortStream( void );
530 //! Returns true if a stream is open and false if not.
531 bool isStreamOpen( void ) const throw();
533 //! Returns true if the stream is running and false if it is stopped or not open.
534 bool isStreamRunning( void ) const throw();
536 //! Returns the number of elapsed seconds since the stream was started.
538 If a stream is not open, an RtAudioError (type = INVALID_USE) will be thrown.
540 double getStreamTime( void );
542 //! Returns the internal stream latency in sample frames.
544 The stream latency refers to delay in audio input and/or output
545 caused by internal buffering by the audio system and/or hardware.
546 For duplex streams, the returned value will represent the sum of
547 the input and output latencies. If a stream is not open, an
548 RtAudioError (type = INVALID_USE) will be thrown. If the API does not
549 report latency, the return value will be zero.
551 long getStreamLatency( void );
553 //! Returns actual sample rate in use by the stream.
555 On some systems, the sample rate used may be slightly different
556 than that specified in the stream parameters. If a stream is not
557 open, an RtAudioError (type = INVALID_USE) will be thrown.
559 unsigned int getStreamSampleRate( void );
561 //! Specify whether warning messages should be printed to stderr.
562 void showWarnings( bool value = true ) throw();
566 void openRtApi( RtAudio::Api api );
570 // Operating system dependent thread functionality.
571 #if defined(__WINDOWS_DS__) || defined(__WINDOWS_ASIO__)
575 typedef unsigned long ThreadHandle;
576 typedef CRITICAL_SECTION StreamMutex;
578 #elif defined(__LINUX_ALSA__) || defined(__LINUX_PULSE__) || defined(__UNIX_JACK__) || defined(__LINUX_OSS__) || defined(__MACOSX_CORE__)
579 // Using pthread library for various flavors of unix.
582 typedef pthread_t ThreadHandle;
583 typedef pthread_mutex_t StreamMutex;
585 #else // Setup for "dummy" behavior
587 #define __RTAUDIO_DUMMY__
588 typedef int ThreadHandle;
589 typedef int StreamMutex;
593 // This global structure type is used to pass callback information
594 // between the private RtAudio stream structure and global callback
595 // handling functions.
596 struct CallbackInfo {
597 void *object; // Used as a "this" pointer.
602 void *apiInfo; // void pointer for API specific callback information
607 // Default constructor.
609 :object(0), callback(0), userData(0), errorCallback(0), apiInfo(0), isRunning(false), doRealtime(false) {}
612 // **************************************************************** //
614 // RtApi class declaration.
616 // Subclasses of RtApi contain all API- and OS-specific code necessary
617 // to fully implement the RtAudio API.
619 // Note that RtApi is an abstract base class and cannot be
620 // explicitly instantiated. The class RtAudio will create an
621 // instance of an RtApi subclass (RtApiOss, RtApiAlsa,
622 // RtApiJack, RtApiCore, RtApiDs, or RtApiAsio).
624 // **************************************************************** //
626 #pragma pack(push, 1)
635 S24& operator = ( const int& i ) {
636 c3[0] = (i & 0x000000ff);
637 c3[1] = (i & 0x0000ff00) >> 8;
638 c3[2] = (i & 0x00ff0000) >> 16;
642 S24( const S24& v ) { *this = v; }
643 S24( const double& d ) { *this = (int) d; }
644 S24( const float& f ) { *this = (int) f; }
645 S24( const signed short& s ) { *this = (int) s; }
646 S24( const char& c ) { *this = (int) c; }
649 int i = c3[0] | (c3[1] << 8) | (c3[2] << 16);
650 if (i & 0x800000) i |= ~0xffffff;
656 #if defined( HAVE_GETTIMEOFDAY )
657 #include <sys/time.h>
668 virtual RtAudio::Api getCurrentApi( void ) = 0;
669 virtual unsigned int getDeviceCount( void ) = 0;
670 virtual RtAudio::DeviceInfo getDeviceInfo( unsigned int device ) = 0;
671 virtual unsigned int getDefaultInputDevice( void );
672 virtual unsigned int getDefaultOutputDevice( void );
673 void openStream( RtAudio::StreamParameters *outputParameters,
674 RtAudio::StreamParameters *inputParameters,
675 RtAudioFormat format, unsigned int sampleRate,
676 unsigned int *bufferFrames, RtAudioCallback callback,
677 void *userData, RtAudio::StreamOptions *options,
678 RtAudioErrorCallback errorCallback );
679 virtual void closeStream( void );
680 virtual void startStream( void ) = 0;
681 virtual void stopStream( void ) = 0;
682 virtual void abortStream( void ) = 0;
683 long getStreamLatency( void );
684 unsigned int getStreamSampleRate( void );
685 virtual double getStreamTime( void );
686 bool isStreamOpen( void ) const { return stream_.state != STREAM_CLOSED; }
687 bool isStreamRunning( void ) const { return stream_.state == STREAM_RUNNING; }
688 void showWarnings( bool value ) { showWarnings_ = value; }
693 static const unsigned int MAX_SAMPLE_RATES;
694 static const unsigned int SAMPLE_RATES[];
696 enum { FAILURE, SUCCESS };
712 // A protected structure used for buffer conversion.
716 RtAudioFormat inFormat, outFormat;
717 std::vector<int> inOffset;
718 std::vector<int> outOffset;
721 // A protected structure for audio streams.
723 unsigned int device[2]; // Playback and record, respectively.
724 void *apiHandle; // void pointer for API specific stream handle information
725 StreamMode mode; // OUTPUT, INPUT, or DUPLEX.
726 StreamState state; // STOPPED, RUNNING, or CLOSED
727 char *userBuffer[2]; // Playback and record, respectively.
729 bool doConvertBuffer[2]; // Playback and record, respectively.
730 bool userInterleaved;
731 bool deviceInterleaved[2]; // Playback and record, respectively.
732 bool doByteSwap[2]; // Playback and record, respectively.
733 unsigned int sampleRate;
734 unsigned int bufferSize;
735 unsigned int nBuffers;
736 unsigned int nUserChannels[2]; // Playback and record, respectively.
737 unsigned int nDeviceChannels[2]; // Playback and record channels, respectively.
738 unsigned int channelOffset[2]; // Playback and record, respectively.
739 unsigned long latency[2]; // Playback and record, respectively.
740 RtAudioFormat userFormat;
741 RtAudioFormat deviceFormat[2]; // Playback and record, respectively.
743 CallbackInfo callbackInfo;
744 ConvertInfo convertInfo[2];
745 double streamTime; // Number of elapsed seconds since the stream started.
747 #if defined(HAVE_GETTIMEOFDAY)
748 struct timeval lastTickTimestamp;
752 :apiHandle(0), deviceBuffer(0) { device[0] = 11111; device[1] = 11111; }
756 typedef signed short Int16;
757 typedef signed int Int32;
758 typedef float Float32;
759 typedef double Float64;
761 std::ostringstream errorStream_;
762 std::string errorText_;
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.
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 );
778 //! A protected function used to increment the stream time.
779 void tickStreamTime( void );
781 //! Protected common method to clear an RtApiStream structure.
782 void clearStreamInfo();
785 Protected common method that throws an RtAudioError (type =
786 INVALID_USE) if a stream is not open.
788 void verifyStream( void );
790 //! Protected common error method to allow global control over error handling.
791 void error( RtAudioError::Type type );
794 Protected method used to perform format, channel number, and/or interleaving
795 conversions between the user and device buffers.
797 void convertBuffer( char *outBuffer, char *inBuffer, ConvertInfo &info );
799 //! Protected common method used to perform byte-swapping on buffers.
800 void byteSwapBuffer( char *buffer, unsigned int samples, RtAudioFormat format );
802 //! Protected common method that returns the number of bytes for a given format.
803 unsigned int formatBytes( RtAudioFormat format );
805 //! Protected common method that sets up the parameters for buffer conversion.
806 void setConvertInfo( StreamMode mode, unsigned int firstChannel );
809 // **************************************************************** //
811 // Inline RtAudio definitions.
813 // **************************************************************** //
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 ); }
831 // RtApi Subclass prototypes.
833 #if defined(__MACOSX_CORE__)
835 #include <CoreAudio/AudioHardware.h>
837 class RtApiCore: public RtApi
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 );
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 );
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 );
873 #if defined(__UNIX_JACK__)
875 class RtApiJack: public RtApi
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 );
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 );
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 );
906 #if defined(__WINDOWS_ASIO__)
908 class RtApiAsio: public RtApi
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 );
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 );
931 std::vector<RtAudio::DeviceInfo> devices_;
932 void saveDeviceInfo( void );
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 );
942 #if defined(__WINDOWS_DS__)
944 class RtApiDs: public RtApi
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 );
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 );
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 );
981 #if defined(__LINUX_ALSA__)
983 class RtApiAlsa: public RtApi
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 );
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 );
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 );
1015 #if defined(__LINUX_PULSE__)
1017 class RtApiPulse: public RtApi
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 );
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 );
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 );
1047 #if defined(__LINUX_OSS__)
1049 class RtApiOss: public RtApi
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 );
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 );
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 );
1079 #if defined(__RTAUDIO_DUMMY__)
1081 class RtApiDummy: public RtApi
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 ) {}
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; }
1106 // Indentation settings for Vim and Emacs
1109 // c-basic-offset: 2
1110 // indent-tabs-mode: nil
1113 // vim: et sts=2 sw=2