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, ASIO and WASAPI) 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-2016 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 /************************************************************************/
48 #define RTAUDIO_VERSION "4.1.2"
55 /*! \typedef typedef unsigned long RtAudioFormat;
56 \brief RtAudio data format type.
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.
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.
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.
79 /*! \typedef typedef unsigned long RtAudioStreamFlags;
80 \brief RtAudio stream option flags.
82 The following flags can be OR'ed together to allow a client to
83 make changes to the default stream behavior:
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).
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).
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
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.
114 If the RTAUDIO_SCHEDULE_REALTIME flag is set, RtAudio will attempt
115 to select realtime scheduling (round-robin) for the callback thread.
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.
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).
128 /*! \typedef typedef unsigned long RtAudioStreamStatus;
129 \brief RtAudio stream status (over- or underflow) flags.
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:
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.
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.
143 //! RtAudio callback function prototype.
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.
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.
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
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.
166 \param streamTime The number of seconds that have elapsed since the
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.
174 \param userData A pointer to optional data provided by the client
175 when opening the stream (default = NULL).
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.
182 typedef int (*RtAudioCallback)( void *outputBuffer, void *inputBuffer,
183 unsigned int nFrames,
185 RtAudioStreamStatus status,
188 /************************************************************************/
189 /*! \class RtAudioError
190 \brief Exception handling class for RtAudio.
192 The RtAudioError class is quite simple but it does allow errors to be
193 "caught" by RtAudioError::Type. See the RtAudio documentation to know
194 which methods can throw an RtAudioError.
196 /************************************************************************/
198 class RtAudioError : public std::exception
201 //! Defined RtAudioError types.
203 WARNING, /*!< A non-critical error. */
204 DEBUG_WARNING, /*!< A non-critical error which might be useful for debugging. */
205 UNSPECIFIED, /*!< The default, unspecified error type. */
206 NO_DEVICES_FOUND, /*!< No devices found on system. */
207 INVALID_DEVICE, /*!< An invalid device ID was specified. */
208 MEMORY_ERROR, /*!< An error occured during memory allocation. */
209 INVALID_PARAMETER, /*!< An invalid parameter was specified to a function. */
210 INVALID_USE, /*!< The function was called incorrectly. */
211 DRIVER_ERROR, /*!< A system driver error occured. */
212 SYSTEM_ERROR, /*!< A system error occured. */
213 THREAD_ERROR /*!< A thread error occured. */
217 RtAudioError( const std::string& message, Type type = RtAudioError::UNSPECIFIED ) throw() : message_(message), type_(type) {}
220 virtual ~RtAudioError( void ) throw() {}
222 //! Prints thrown error message to stderr.
223 virtual void printMessage( void ) const throw() { std::cerr << '\n' << message_ << "\n\n"; }
225 //! Returns the thrown error message type.
226 virtual const Type& getType(void) const throw() { return type_; }
228 //! Returns the thrown error message string.
229 virtual const std::string& getMessage(void) const throw() { return message_; }
231 //! Returns the thrown error message as a c-style string.
232 virtual const char* what( void ) const throw() { return message_.c_str(); }
235 std::string message_;
239 //! RtAudio error callback function prototype.
241 \param type Type of error.
242 \param errorText Error description.
244 typedef void (*RtAudioErrorCallback)( RtAudioError::Type type, const std::string &errorText );
246 // **************************************************************** //
248 // RtAudio class declaration.
250 // RtAudio is a "controller" used to select an available audio i/o
251 // interface. It presents a common API for the user to call but all
252 // functionality is implemented by the class RtApi and its
253 // subclasses. RtAudio creates an instance of an RtApi subclass
254 // based on the user's API choice. If no choice is made, RtAudio
255 // attempts to make a "logical" API selection.
257 // **************************************************************** //
265 //! Audio API specifier arguments.
267 UNSPECIFIED, /*!< Search for a working compiled API. */
268 LINUX_ALSA, /*!< The Advanced Linux Sound Architecture API. */
269 LINUX_PULSE, /*!< The Linux PulseAudio API. */
270 LINUX_OSS, /*!< The Linux Open Sound System API. */
271 UNIX_JACK, /*!< The Jack Low-Latency Audio Server API. */
272 MACOSX_CORE, /*!< Macintosh OS-X Core Audio API. */
273 WINDOWS_WASAPI, /*!< The Microsoft WASAPI 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. */
279 //! The public device information structure for returning queried values.
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 unsigned int preferredSampleRate; /*!< Preferred sample rate, eg. for WASAPI the system sample rate. */
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), preferredSampleRate(0), 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 ) throw();
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. An exception
391 can be thrown if no API support is compiled.
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 );
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 //! Set the stream time to a time in seconds greater than or equal to 0.0.
544 If a stream is not open, an RtAudioError (type = INVALID_USE) will be thrown.
546 void setStreamTime( double time );
548 //! Returns the internal stream latency in sample frames.
550 The stream latency refers to delay in audio input and/or output
551 caused by internal buffering by the audio system and/or hardware.
552 For duplex streams, the returned value will represent the sum of
553 the input and output latencies. If a stream is not open, an
554 RtAudioError (type = INVALID_USE) will be thrown. If the API does not
555 report latency, the return value will be zero.
557 long getStreamLatency( void );
559 //! Returns actual sample rate in use by the stream.
561 On some systems, the sample rate used may be slightly different
562 than that specified in the stream parameters. If a stream is not
563 open, an RtAudioError (type = INVALID_USE) will be thrown.
565 unsigned int getStreamSampleRate( void );
567 //! Specify whether warning messages should be printed to stderr.
568 void showWarnings( bool value = true ) throw();
572 void openRtApi( RtAudio::Api api );
576 // Operating system dependent thread functionality.
577 #if defined(__WINDOWS_DS__) || defined(__WINDOWS_ASIO__) || defined(__WINDOWS_WASAPI__)
585 typedef uintptr_t ThreadHandle;
586 typedef CRITICAL_SECTION StreamMutex;
588 #elif defined(__LINUX_ALSA__) || defined(__LINUX_PULSE__) || defined(__UNIX_JACK__) || defined(__LINUX_OSS__) || defined(__MACOSX_CORE__)
589 // Using pthread library for various flavors of unix.
592 typedef pthread_t ThreadHandle;
593 typedef pthread_mutex_t StreamMutex;
595 #else // Setup for "dummy" behavior
597 #define __RTAUDIO_DUMMY__
598 typedef int ThreadHandle;
599 typedef int StreamMutex;
603 // This global structure type is used to pass callback information
604 // between the private RtAudio stream structure and global callback
605 // handling functions.
606 struct CallbackInfo {
607 void *object; // Used as a "this" pointer.
612 void *apiInfo; // void pointer for API specific callback information
617 // Default constructor.
619 :object(0), callback(0), userData(0), errorCallback(0), apiInfo(0), isRunning(false), doRealtime(false) {}
622 // **************************************************************** //
624 // RtApi class declaration.
626 // Subclasses of RtApi contain all API- and OS-specific code necessary
627 // to fully implement the RtAudio API.
629 // Note that RtApi is an abstract base class and cannot be
630 // explicitly instantiated. The class RtAudio will create an
631 // instance of an RtApi subclass (RtApiOss, RtApiAlsa,
632 // RtApiJack, RtApiCore, RtApiDs, or RtApiAsio).
634 // **************************************************************** //
636 #pragma pack(push, 1)
645 S24& operator = ( const int& i ) {
646 c3[0] = (i & 0x000000ff);
647 c3[1] = (i & 0x0000ff00) >> 8;
648 c3[2] = (i & 0x00ff0000) >> 16;
652 S24( const S24& v ) { *this = v; }
653 S24( const double& d ) { *this = (int) d; }
654 S24( const float& f ) { *this = (int) f; }
655 S24( const signed short& s ) { *this = (int) s; }
656 S24( const char& c ) { *this = (int) c; }
659 int i = c3[0] | (c3[1] << 8) | (c3[2] << 16);
660 if (i & 0x800000) i |= ~0xffffff;
666 #if defined( HAVE_GETTIMEOFDAY )
667 #include <sys/time.h>
678 virtual RtAudio::Api getCurrentApi( void ) = 0;
679 virtual unsigned int getDeviceCount( void ) = 0;
680 virtual RtAudio::DeviceInfo getDeviceInfo( unsigned int device ) = 0;
681 virtual unsigned int getDefaultInputDevice( void );
682 virtual unsigned int getDefaultOutputDevice( void );
683 void openStream( RtAudio::StreamParameters *outputParameters,
684 RtAudio::StreamParameters *inputParameters,
685 RtAudioFormat format, unsigned int sampleRate,
686 unsigned int *bufferFrames, RtAudioCallback callback,
687 void *userData, RtAudio::StreamOptions *options,
688 RtAudioErrorCallback errorCallback );
689 virtual void closeStream( void );
690 virtual void startStream( void ) = 0;
691 virtual void stopStream( void ) = 0;
692 virtual void abortStream( void ) = 0;
693 long getStreamLatency( void );
694 unsigned int getStreamSampleRate( void );
695 virtual double getStreamTime( void );
696 virtual void setStreamTime( double time );
697 bool isStreamOpen( void ) const { return stream_.state != STREAM_CLOSED; }
698 bool isStreamRunning( void ) const { return stream_.state == STREAM_RUNNING; }
699 void showWarnings( bool value ) { showWarnings_ = value; }
704 static const unsigned int MAX_SAMPLE_RATES;
705 static const unsigned int SAMPLE_RATES[];
707 enum { FAILURE, SUCCESS };
723 // A protected structure used for buffer conversion.
727 RtAudioFormat inFormat, outFormat;
728 std::vector<int> inOffset;
729 std::vector<int> outOffset;
732 // A protected structure for audio streams.
734 unsigned int device[2]; // Playback and record, respectively.
735 void *apiHandle; // void pointer for API specific stream handle information
736 StreamMode mode; // OUTPUT, INPUT, or DUPLEX.
737 StreamState state; // STOPPED, RUNNING, or CLOSED
738 char *userBuffer[2]; // Playback and record, respectively.
740 bool doConvertBuffer[2]; // Playback and record, respectively.
741 bool userInterleaved;
742 bool deviceInterleaved[2]; // Playback and record, respectively.
743 bool doByteSwap[2]; // Playback and record, respectively.
744 unsigned int sampleRate;
745 unsigned int bufferSize;
746 unsigned int nBuffers;
747 unsigned int nUserChannels[2]; // Playback and record, respectively.
748 unsigned int nDeviceChannels[2]; // Playback and record channels, respectively.
749 unsigned int channelOffset[2]; // Playback and record, respectively.
750 unsigned long latency[2]; // Playback and record, respectively.
751 RtAudioFormat userFormat;
752 RtAudioFormat deviceFormat[2]; // Playback and record, respectively.
754 CallbackInfo callbackInfo;
755 ConvertInfo convertInfo[2];
756 double streamTime; // Number of elapsed seconds since the stream started.
758 #if defined(HAVE_GETTIMEOFDAY)
759 struct timeval lastTickTimestamp;
763 :apiHandle(0), deviceBuffer(0) { device[0] = 11111; device[1] = 11111; }
767 typedef signed short Int16;
768 typedef signed int Int32;
769 typedef float Float32;
770 typedef double Float64;
772 std::ostringstream errorStream_;
773 std::string errorText_;
776 bool firstErrorOccurred_;
779 Protected, api-specific method that attempts to open a device
780 with the given parameters. This function MUST be implemented by
781 all subclasses. If an error is encountered during the probe, a
782 "warning" message is reported and FAILURE is returned. A
783 successful probe is indicated by a return value of SUCCESS.
785 virtual bool probeDeviceOpen( unsigned int device, StreamMode mode, unsigned int channels,
786 unsigned int firstChannel, unsigned int sampleRate,
787 RtAudioFormat format, unsigned int *bufferSize,
788 RtAudio::StreamOptions *options );
790 //! A protected function used to increment the stream time.
791 void tickStreamTime( void );
793 //! Protected common method to clear an RtApiStream structure.
794 void clearStreamInfo();
797 Protected common method that throws an RtAudioError (type =
798 INVALID_USE) if a stream is not open.
800 void verifyStream( void );
802 //! Protected common error method to allow global control over error handling.
803 void error( RtAudioError::Type type );
806 Protected method used to perform format, channel number, and/or interleaving
807 conversions between the user and device buffers.
809 void convertBuffer( char *outBuffer, char *inBuffer, ConvertInfo &info );
811 //! Protected common method used to perform byte-swapping on buffers.
812 void byteSwapBuffer( char *buffer, unsigned int samples, RtAudioFormat format );
814 //! Protected common method that returns the number of bytes for a given format.
815 unsigned int formatBytes( RtAudioFormat format );
817 //! Protected common method that sets up the parameters for buffer conversion.
818 void setConvertInfo( StreamMode mode, unsigned int firstChannel );
821 // **************************************************************** //
823 // Inline RtAudio definitions.
825 // **************************************************************** //
827 inline RtAudio::Api RtAudio :: getCurrentApi( void ) throw() { return rtapi_->getCurrentApi(); }
828 inline unsigned int RtAudio :: getDeviceCount( void ) throw() { return rtapi_->getDeviceCount(); }
829 inline RtAudio::DeviceInfo RtAudio :: getDeviceInfo( unsigned int device ) { return rtapi_->getDeviceInfo( device ); }
830 inline unsigned int RtAudio :: getDefaultInputDevice( void ) throw() { return rtapi_->getDefaultInputDevice(); }
831 inline unsigned int RtAudio :: getDefaultOutputDevice( void ) throw() { return rtapi_->getDefaultOutputDevice(); }
832 inline void RtAudio :: closeStream( void ) throw() { return rtapi_->closeStream(); }
833 inline void RtAudio :: startStream( void ) { return rtapi_->startStream(); }
834 inline void RtAudio :: stopStream( void ) { return rtapi_->stopStream(); }
835 inline void RtAudio :: abortStream( void ) { return rtapi_->abortStream(); }
836 inline bool RtAudio :: isStreamOpen( void ) const throw() { return rtapi_->isStreamOpen(); }
837 inline bool RtAudio :: isStreamRunning( void ) const throw() { return rtapi_->isStreamRunning(); }
838 inline long RtAudio :: getStreamLatency( void ) { return rtapi_->getStreamLatency(); }
839 inline unsigned int RtAudio :: getStreamSampleRate( void ) { return rtapi_->getStreamSampleRate(); }
840 inline double RtAudio :: getStreamTime( void ) { return rtapi_->getStreamTime(); }
841 inline void RtAudio :: setStreamTime( double time ) { return rtapi_->setStreamTime( time ); }
842 inline void RtAudio :: showWarnings( bool value ) throw() { rtapi_->showWarnings( value ); }
844 // RtApi Subclass prototypes.
846 #if defined(__MACOSX_CORE__)
848 #include <CoreAudio/AudioHardware.h>
850 class RtApiCore: public RtApi
856 RtAudio::Api getCurrentApi( void ) { return RtAudio::MACOSX_CORE; }
857 unsigned int getDeviceCount( void );
858 RtAudio::DeviceInfo getDeviceInfo( unsigned int device );
859 unsigned int getDefaultOutputDevice( void );
860 unsigned int getDefaultInputDevice( void );
861 void closeStream( void );
862 void startStream( void );
863 void stopStream( void );
864 void abortStream( void );
865 long getStreamLatency( void );
867 // This function is intended for internal use only. It must be
868 // public because it is called by the internal callback handler,
869 // which is not a member of RtAudio. External use of this function
870 // will most likely produce highly undesireable results!
871 bool callbackEvent( AudioDeviceID deviceId,
872 const AudioBufferList *inBufferList,
873 const AudioBufferList *outBufferList );
877 bool probeDeviceOpen( unsigned int device, StreamMode mode, unsigned int channels,
878 unsigned int firstChannel, unsigned int sampleRate,
879 RtAudioFormat format, unsigned int *bufferSize,
880 RtAudio::StreamOptions *options );
881 static const char* getErrorCode( OSStatus code );
886 #if defined(__UNIX_JACK__)
888 class RtApiJack: public RtApi
894 RtAudio::Api getCurrentApi( void ) { return RtAudio::UNIX_JACK; }
895 unsigned int getDeviceCount( void );
896 RtAudio::DeviceInfo getDeviceInfo( unsigned int device );
897 void closeStream( void );
898 void startStream( void );
899 void stopStream( void );
900 void abortStream( void );
901 long getStreamLatency( void );
903 // This function is intended for internal use only. It must be
904 // public because it is called by the internal callback handler,
905 // which is not a member of RtAudio. External use of this function
906 // will most likely produce highly undesireable results!
907 bool callbackEvent( unsigned long nframes );
911 bool probeDeviceOpen( unsigned int device, StreamMode mode, unsigned int channels,
912 unsigned int firstChannel, unsigned int sampleRate,
913 RtAudioFormat format, unsigned int *bufferSize,
914 RtAudio::StreamOptions *options );
919 #if defined(__WINDOWS_ASIO__)
921 class RtApiAsio: public RtApi
927 RtAudio::Api getCurrentApi( void ) { return RtAudio::WINDOWS_ASIO; }
928 unsigned int getDeviceCount( void );
929 RtAudio::DeviceInfo getDeviceInfo( unsigned int device );
930 void closeStream( void );
931 void startStream( void );
932 void stopStream( void );
933 void abortStream( void );
934 long getStreamLatency( void );
936 // This function is intended for internal use only. It must be
937 // public because it is called by the internal callback handler,
938 // which is not a member of RtAudio. External use of this function
939 // will most likely produce highly undesireable results!
940 bool callbackEvent( long bufferIndex );
944 std::vector<RtAudio::DeviceInfo> devices_;
945 void saveDeviceInfo( void );
947 bool probeDeviceOpen( unsigned int device, StreamMode mode, unsigned int channels,
948 unsigned int firstChannel, unsigned int sampleRate,
949 RtAudioFormat format, unsigned int *bufferSize,
950 RtAudio::StreamOptions *options );
955 #if defined(__WINDOWS_DS__)
957 class RtApiDs: public RtApi
963 RtAudio::Api getCurrentApi( void ) { return RtAudio::WINDOWS_DS; }
964 unsigned int getDeviceCount( void );
965 unsigned int getDefaultOutputDevice( void );
966 unsigned int getDefaultInputDevice( void );
967 RtAudio::DeviceInfo getDeviceInfo( unsigned int device );
968 void closeStream( void );
969 void startStream( void );
970 void stopStream( void );
971 void abortStream( void );
972 long getStreamLatency( void );
974 // This function is intended for internal use only. It must be
975 // public because it is called by the internal callback handler,
976 // which is not a member of RtAudio. External use of this function
977 // will most likely produce highly undesireable results!
978 void callbackEvent( void );
984 long duplexPrerollBytes;
985 std::vector<struct DsDevice> dsDevices;
986 bool probeDeviceOpen( unsigned int device, StreamMode mode, unsigned int channels,
987 unsigned int firstChannel, unsigned int sampleRate,
988 RtAudioFormat format, unsigned int *bufferSize,
989 RtAudio::StreamOptions *options );
994 #if defined(__WINDOWS_WASAPI__)
996 struct IMMDeviceEnumerator;
998 class RtApiWasapi : public RtApi
1004 RtAudio::Api getCurrentApi( void ) { return RtAudio::WINDOWS_WASAPI; }
1005 unsigned int getDeviceCount( void );
1006 RtAudio::DeviceInfo getDeviceInfo( unsigned int device );
1007 unsigned int getDefaultOutputDevice( void );
1008 unsigned int getDefaultInputDevice( void );
1009 void closeStream( void );
1010 void startStream( void );
1011 void stopStream( void );
1012 void abortStream( void );
1015 bool coInitialized_;
1016 IMMDeviceEnumerator* deviceEnumerator_;
1018 bool probeDeviceOpen( unsigned int device, StreamMode mode, unsigned int channels,
1019 unsigned int firstChannel, unsigned int sampleRate,
1020 RtAudioFormat format, unsigned int* bufferSize,
1021 RtAudio::StreamOptions* options );
1023 static DWORD WINAPI runWasapiThread( void* wasapiPtr );
1024 static DWORD WINAPI stopWasapiThread( void* wasapiPtr );
1025 static DWORD WINAPI abortWasapiThread( void* wasapiPtr );
1026 void wasapiThread();
1031 #if defined(__LINUX_ALSA__)
1033 class RtApiAlsa: public RtApi
1039 RtAudio::Api getCurrentApi() { return RtAudio::LINUX_ALSA; }
1040 unsigned int getDeviceCount( void );
1041 RtAudio::DeviceInfo getDeviceInfo( unsigned int device );
1042 void closeStream( void );
1043 void startStream( void );
1044 void stopStream( void );
1045 void abortStream( void );
1047 // This function is intended for internal use only. It must be
1048 // public because it is called by the internal callback handler,
1049 // which is not a member of RtAudio. External use of this function
1050 // will most likely produce highly undesireable results!
1051 void callbackEvent( void );
1055 std::vector<RtAudio::DeviceInfo> devices_;
1056 void saveDeviceInfo( void );
1057 bool probeDeviceOpen( unsigned int device, StreamMode mode, unsigned int channels,
1058 unsigned int firstChannel, unsigned int sampleRate,
1059 RtAudioFormat format, unsigned int *bufferSize,
1060 RtAudio::StreamOptions *options );
1065 #if defined(__LINUX_PULSE__)
1067 class RtApiPulse: public RtApi
1071 RtAudio::Api getCurrentApi() { return RtAudio::LINUX_PULSE; }
1072 unsigned int getDeviceCount( void );
1073 RtAudio::DeviceInfo getDeviceInfo( unsigned int device );
1074 void closeStream( void );
1075 void startStream( void );
1076 void stopStream( void );
1077 void abortStream( void );
1079 // This function is intended for internal use only. It must be
1080 // public because it is called by the internal callback handler,
1081 // which is not a member of RtAudio. External use of this function
1082 // will most likely produce highly undesireable results!
1083 void callbackEvent( void );
1087 std::vector<RtAudio::DeviceInfo> devices_;
1088 void saveDeviceInfo( void );
1089 bool probeDeviceOpen( unsigned int device, StreamMode mode, unsigned int channels,
1090 unsigned int firstChannel, unsigned int sampleRate,
1091 RtAudioFormat format, unsigned int *bufferSize,
1092 RtAudio::StreamOptions *options );
1097 #if defined(__LINUX_OSS__)
1099 class RtApiOss: public RtApi
1105 RtAudio::Api getCurrentApi() { return RtAudio::LINUX_OSS; }
1106 unsigned int getDeviceCount( void );
1107 RtAudio::DeviceInfo getDeviceInfo( unsigned int device );
1108 void closeStream( void );
1109 void startStream( void );
1110 void stopStream( void );
1111 void abortStream( void );
1113 // This function is intended for internal use only. It must be
1114 // public because it is called by the internal callback handler,
1115 // which is not a member of RtAudio. External use of this function
1116 // will most likely produce highly undesireable results!
1117 void callbackEvent( void );
1121 bool probeDeviceOpen( unsigned int device, StreamMode mode, unsigned int channels,
1122 unsigned int firstChannel, unsigned int sampleRate,
1123 RtAudioFormat format, unsigned int *bufferSize,
1124 RtAudio::StreamOptions *options );
1129 #if defined(__RTAUDIO_DUMMY__)
1131 class RtApiDummy: public RtApi
1135 RtApiDummy() { errorText_ = "RtApiDummy: This class provides no functionality."; error( RtAudioError::WARNING ); }
1136 RtAudio::Api getCurrentApi( void ) { return RtAudio::RTAUDIO_DUMMY; }
1137 unsigned int getDeviceCount( void ) { return 0; }
1138 RtAudio::DeviceInfo getDeviceInfo( unsigned int /*device*/ ) { RtAudio::DeviceInfo info; return info; }
1139 void closeStream( void ) {}
1140 void startStream( void ) {}
1141 void stopStream( void ) {}
1142 void abortStream( void ) {}
1146 bool probeDeviceOpen( unsigned int /*device*/, StreamMode /*mode*/, unsigned int /*channels*/,
1147 unsigned int /*firstChannel*/, unsigned int /*sampleRate*/,
1148 RtAudioFormat /*format*/, unsigned int * /*bufferSize*/,
1149 RtAudio::StreamOptions * /*options*/ ) { return false; }
1156 // Indentation settings for Vim and Emacs
1159 // c-basic-offset: 2
1160 // indent-tabs-mode: nil
1163 // vim: et sts=2 sw=2