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-2014 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.1pre"
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 RtAudioFormat nativeFormats; /*!< Bit mask of supported data formats. */
291 // Default constructor.
293 :probed(false), outputChannels(0), inputChannels(0), duplexChannels(0),
294 isDefaultOutput(false), isDefaultInput(false), nativeFormats(0) {}
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). */
303 // Default constructor.
305 : deviceId(0), nChannels(0), firstChannel(0) {}
308 //! The structure for specifying stream options.
310 The following flags can be OR'ed together to allow a client to
311 make changes to the default stream behavior:
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).
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).
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
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.
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.
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.
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.
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.
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). */
371 // Default constructor.
373 : flags(0), numberOfBuffers(0), priority(0) {}
376 //! A static function to determine the current RtAudio version.
377 static std::string getVersion( void ) throw();
379 //! A static function to determine the available compiled audio APIs.
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.
385 static void getCompiledApi( std::vector<RtAudio::Api> &apis ) throw();
387 //! The class constructor.
389 The constructor performs minor initialization tasks. An exception
390 can be thrown if no API support is compiled.
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).
396 RtAudio( RtAudio::Api api=UNSPECIFIED );
400 If a stream is running or open, it will be stopped and closed
405 //! Returns the audio API specifier for the current instance of RtAudio.
406 RtAudio::Api getCurrentApi( void ) throw();
408 //! A public function that queries for the number of audio devices available.
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.
414 unsigned int getDeviceCount( void ) throw();
416 //! Return an RtAudio::DeviceInfo structure for a specified device number.
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".
427 RtAudio::DeviceInfo getDeviceInfo( unsigned int device );
429 //! A function that returns the index of the default output device.
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.
437 unsigned int getDefaultOutputDevice( void ) throw();
439 //! A function that returns the index of the default input device.
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.
447 unsigned int getDefaultInputDevice( void ) throw();
449 //! A public function for opening a stream with the specified parameters.
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.
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.
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 );
495 //! A function that closes a stream and frees any associated stream memory.
497 If a stream is not open, this function issues a warning and
498 returns (no exception is thrown).
500 void closeStream( void ) throw();
502 //! A function that starts a stream.
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
509 void startStream( void );
511 //! Stop a stream, allowing any samples remaining in the output queue to be played.
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
518 void stopStream( void );
520 //! Stop a stream, discarding any samples remaining in the input/output queue.
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
527 void abortStream( void );
529 //! Returns true if a stream is open and false if not.
530 bool isStreamOpen( void ) const throw();
532 //! Returns true if the stream is running and false if it is stopped or not open.
533 bool isStreamRunning( void ) const throw();
535 //! Returns the number of elapsed seconds since the stream was started.
537 If a stream is not open, an RtAudioError (type = INVALID_USE) will be thrown.
539 double getStreamTime( void );
541 //! Returns the internal stream latency in sample frames.
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.
550 long getStreamLatency( void );
552 //! Returns actual sample rate in use by the stream.
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.
558 unsigned int getStreamSampleRate( void );
560 //! Specify whether warning messages should be printed to stderr.
561 void showWarnings( bool value = true ) throw();
565 void openRtApi( RtAudio::Api api );
569 // Operating system dependent thread functionality.
570 #if defined(__WINDOWS_DS__) || defined(__WINDOWS_ASIO__) || defined(__WINDOWS_WASAPI__)
578 typedef uintptr_t ThreadHandle;
579 typedef CRITICAL_SECTION StreamMutex;
581 #elif defined(__LINUX_ALSA__) || defined(__LINUX_PULSE__) || defined(__UNIX_JACK__) || defined(__LINUX_OSS__) || defined(__MACOSX_CORE__)
582 // Using pthread library for various flavors of unix.
585 typedef pthread_t ThreadHandle;
586 typedef pthread_mutex_t StreamMutex;
588 #else // Setup for "dummy" behavior
590 #define __RTAUDIO_DUMMY__
591 typedef int ThreadHandle;
592 typedef int StreamMutex;
596 // This global structure type is used to pass callback information
597 // between the private RtAudio stream structure and global callback
598 // handling functions.
599 struct CallbackInfo {
600 void *object; // Used as a "this" pointer.
605 void *apiInfo; // void pointer for API specific callback information
610 // Default constructor.
612 :object(0), callback(0), userData(0), errorCallback(0), apiInfo(0), isRunning(false), doRealtime(false) {}
615 // **************************************************************** //
617 // RtApi class declaration.
619 // Subclasses of RtApi contain all API- and OS-specific code necessary
620 // to fully implement the RtAudio API.
622 // Note that RtApi is an abstract base class and cannot be
623 // explicitly instantiated. The class RtAudio will create an
624 // instance of an RtApi subclass (RtApiOss, RtApiAlsa,
625 // RtApiJack, RtApiCore, RtApiDs, or RtApiAsio).
627 // **************************************************************** //
629 #pragma pack(push, 1)
638 S24& operator = ( const int& i ) {
639 c3[0] = (i & 0x000000ff);
640 c3[1] = (i & 0x0000ff00) >> 8;
641 c3[2] = (i & 0x00ff0000) >> 16;
645 S24( const S24& v ) { *this = v; }
646 S24( const double& d ) { *this = (int) d; }
647 S24( const float& f ) { *this = (int) f; }
648 S24( const signed short& s ) { *this = (int) s; }
649 S24( const char& c ) { *this = (int) c; }
652 int i = c3[0] | (c3[1] << 8) | (c3[2] << 16);
653 if (i & 0x800000) i |= ~0xffffff;
659 #if defined( HAVE_GETTIMEOFDAY )
660 #include <sys/time.h>
671 virtual RtAudio::Api getCurrentApi( void ) = 0;
672 virtual unsigned int getDeviceCount( void ) = 0;
673 virtual RtAudio::DeviceInfo getDeviceInfo( unsigned int device ) = 0;
674 virtual unsigned int getDefaultInputDevice( void );
675 virtual unsigned int getDefaultOutputDevice( void );
676 void openStream( RtAudio::StreamParameters *outputParameters,
677 RtAudio::StreamParameters *inputParameters,
678 RtAudioFormat format, unsigned int sampleRate,
679 unsigned int *bufferFrames, RtAudioCallback callback,
680 void *userData, RtAudio::StreamOptions *options,
681 RtAudioErrorCallback errorCallback );
682 virtual void closeStream( void );
683 virtual void startStream( void ) = 0;
684 virtual void stopStream( void ) = 0;
685 virtual void abortStream( void ) = 0;
686 long getStreamLatency( void );
687 unsigned int getStreamSampleRate( void );
688 virtual double getStreamTime( void );
689 bool isStreamOpen( void ) const { return stream_.state != STREAM_CLOSED; }
690 bool isStreamRunning( void ) const { return stream_.state == STREAM_RUNNING; }
691 void showWarnings( bool value ) { showWarnings_ = value; }
696 static const unsigned int MAX_SAMPLE_RATES;
697 static const unsigned int SAMPLE_RATES[];
699 enum { FAILURE, SUCCESS };
715 // A protected structure used for buffer conversion.
719 RtAudioFormat inFormat, outFormat;
720 std::vector<int> inOffset;
721 std::vector<int> outOffset;
724 // A protected structure for audio streams.
726 unsigned int device[2]; // Playback and record, respectively.
727 void *apiHandle; // void pointer for API specific stream handle information
728 StreamMode mode; // OUTPUT, INPUT, or DUPLEX.
729 StreamState state; // STOPPED, RUNNING, or CLOSED
730 char *userBuffer[2]; // Playback and record, respectively.
732 bool doConvertBuffer[2]; // Playback and record, respectively.
733 bool userInterleaved;
734 bool deviceInterleaved[2]; // Playback and record, respectively.
735 bool doByteSwap[2]; // Playback and record, respectively.
736 unsigned int sampleRate;
737 unsigned int bufferSize;
738 unsigned int nBuffers;
739 unsigned int nUserChannels[2]; // Playback and record, respectively.
740 unsigned int nDeviceChannels[2]; // Playback and record channels, respectively.
741 unsigned int channelOffset[2]; // Playback and record, respectively.
742 unsigned long latency[2]; // Playback and record, respectively.
743 RtAudioFormat userFormat;
744 RtAudioFormat deviceFormat[2]; // Playback and record, respectively.
746 CallbackInfo callbackInfo;
747 ConvertInfo convertInfo[2];
748 double streamTime; // Number of elapsed seconds since the stream started.
750 #if defined(HAVE_GETTIMEOFDAY)
751 struct timeval lastTickTimestamp;
755 :apiHandle(0), deviceBuffer(0) { device[0] = 11111; device[1] = 11111; }
759 typedef signed short Int16;
760 typedef signed int Int32;
761 typedef float Float32;
762 typedef double Float64;
764 std::ostringstream errorStream_;
765 std::string errorText_;
768 bool firstErrorOccurred_;
771 Protected, api-specific method that attempts to open a device
772 with the given parameters. This function MUST be implemented by
773 all subclasses. If an error is encountered during the probe, a
774 "warning" message is reported and FAILURE is returned. A
775 successful probe is indicated by a return value of SUCCESS.
777 virtual bool probeDeviceOpen( unsigned int device, StreamMode mode, unsigned int channels,
778 unsigned int firstChannel, unsigned int sampleRate,
779 RtAudioFormat format, unsigned int *bufferSize,
780 RtAudio::StreamOptions *options );
782 //! A protected function used to increment the stream time.
783 void tickStreamTime( void );
785 //! Protected common method to clear an RtApiStream structure.
786 void clearStreamInfo();
789 Protected common method that throws an RtAudioError (type =
790 INVALID_USE) if a stream is not open.
792 void verifyStream( void );
794 //! Protected common error method to allow global control over error handling.
795 void error( RtAudioError::Type type );
798 Protected method used to perform format, channel number, and/or interleaving
799 conversions between the user and device buffers.
801 void convertBuffer( char *outBuffer, char *inBuffer, ConvertInfo &info );
803 //! Protected common method used to perform byte-swapping on buffers.
804 void byteSwapBuffer( char *buffer, unsigned int samples, RtAudioFormat format );
806 //! Protected common method that returns the number of bytes for a given format.
807 unsigned int formatBytes( RtAudioFormat format );
809 //! Protected common method that sets up the parameters for buffer conversion.
810 void setConvertInfo( StreamMode mode, unsigned int firstChannel );
813 // **************************************************************** //
815 // Inline RtAudio definitions.
817 // **************************************************************** //
819 inline RtAudio::Api RtAudio :: getCurrentApi( void ) throw() { return rtapi_->getCurrentApi(); }
820 inline unsigned int RtAudio :: getDeviceCount( void ) throw() { return rtapi_->getDeviceCount(); }
821 inline RtAudio::DeviceInfo RtAudio :: getDeviceInfo( unsigned int device ) { return rtapi_->getDeviceInfo( device ); }
822 inline unsigned int RtAudio :: getDefaultInputDevice( void ) throw() { return rtapi_->getDefaultInputDevice(); }
823 inline unsigned int RtAudio :: getDefaultOutputDevice( void ) throw() { return rtapi_->getDefaultOutputDevice(); }
824 inline void RtAudio :: closeStream( void ) throw() { return rtapi_->closeStream(); }
825 inline void RtAudio :: startStream( void ) { return rtapi_->startStream(); }
826 inline void RtAudio :: stopStream( void ) { return rtapi_->stopStream(); }
827 inline void RtAudio :: abortStream( void ) { return rtapi_->abortStream(); }
828 inline bool RtAudio :: isStreamOpen( void ) const throw() { return rtapi_->isStreamOpen(); }
829 inline bool RtAudio :: isStreamRunning( void ) const throw() { return rtapi_->isStreamRunning(); }
830 inline long RtAudio :: getStreamLatency( void ) { return rtapi_->getStreamLatency(); }
831 inline unsigned int RtAudio :: getStreamSampleRate( void ) { return rtapi_->getStreamSampleRate(); }
832 inline double RtAudio :: getStreamTime( void ) { return rtapi_->getStreamTime(); }
833 inline void RtAudio :: showWarnings( bool value ) throw() { rtapi_->showWarnings( value ); }
835 // RtApi Subclass prototypes.
837 #if defined(__MACOSX_CORE__)
839 #include <CoreAudio/AudioHardware.h>
841 class RtApiCore: public RtApi
847 RtAudio::Api getCurrentApi( void ) { return RtAudio::MACOSX_CORE; }
848 unsigned int getDeviceCount( void );
849 RtAudio::DeviceInfo getDeviceInfo( unsigned int device );
850 unsigned int getDefaultOutputDevice( void );
851 unsigned int getDefaultInputDevice( void );
852 void closeStream( void );
853 void startStream( void );
854 void stopStream( void );
855 void abortStream( void );
856 long getStreamLatency( void );
858 // This function is intended for internal use only. It must be
859 // public because it is called by the internal callback handler,
860 // which is not a member of RtAudio. External use of this function
861 // will most likely produce highly undesireable results!
862 bool callbackEvent( AudioDeviceID deviceId,
863 const AudioBufferList *inBufferList,
864 const AudioBufferList *outBufferList );
868 bool probeDeviceOpen( unsigned int device, StreamMode mode, unsigned int channels,
869 unsigned int firstChannel, unsigned int sampleRate,
870 RtAudioFormat format, unsigned int *bufferSize,
871 RtAudio::StreamOptions *options );
872 static const char* getErrorCode( OSStatus code );
877 #if defined(__UNIX_JACK__)
879 class RtApiJack: public RtApi
885 RtAudio::Api getCurrentApi( void ) { return RtAudio::UNIX_JACK; }
886 unsigned int getDeviceCount( void );
887 RtAudio::DeviceInfo getDeviceInfo( unsigned int device );
888 void closeStream( void );
889 void startStream( void );
890 void stopStream( void );
891 void abortStream( void );
892 long getStreamLatency( void );
894 // This function is intended for internal use only. It must be
895 // public because it is called by the internal callback handler,
896 // which is not a member of RtAudio. External use of this function
897 // will most likely produce highly undesireable results!
898 bool callbackEvent( unsigned long nframes );
902 bool probeDeviceOpen( unsigned int device, StreamMode mode, unsigned int channels,
903 unsigned int firstChannel, unsigned int sampleRate,
904 RtAudioFormat format, unsigned int *bufferSize,
905 RtAudio::StreamOptions *options );
910 #if defined(__WINDOWS_ASIO__)
912 class RtApiAsio: public RtApi
918 RtAudio::Api getCurrentApi( void ) { return RtAudio::WINDOWS_ASIO; }
919 unsigned int getDeviceCount( void );
920 RtAudio::DeviceInfo getDeviceInfo( unsigned int device );
921 void closeStream( void );
922 void startStream( void );
923 void stopStream( void );
924 void abortStream( void );
925 long getStreamLatency( void );
927 // This function is intended for internal use only. It must be
928 // public because it is called by the internal callback handler,
929 // which is not a member of RtAudio. External use of this function
930 // will most likely produce highly undesireable results!
931 bool callbackEvent( long bufferIndex );
935 std::vector<RtAudio::DeviceInfo> devices_;
936 void saveDeviceInfo( void );
938 bool probeDeviceOpen( unsigned int device, StreamMode mode, unsigned int channels,
939 unsigned int firstChannel, unsigned int sampleRate,
940 RtAudioFormat format, unsigned int *bufferSize,
941 RtAudio::StreamOptions *options );
946 #if defined(__WINDOWS_DS__)
948 class RtApiDs: public RtApi
954 RtAudio::Api getCurrentApi( void ) { return RtAudio::WINDOWS_DS; }
955 unsigned int getDeviceCount( void );
956 unsigned int getDefaultOutputDevice( void );
957 unsigned int getDefaultInputDevice( void );
958 RtAudio::DeviceInfo getDeviceInfo( unsigned int device );
959 void closeStream( void );
960 void startStream( void );
961 void stopStream( void );
962 void abortStream( void );
963 long getStreamLatency( void );
965 // This function is intended for internal use only. It must be
966 // public because it is called by the internal callback handler,
967 // which is not a member of RtAudio. External use of this function
968 // will most likely produce highly undesireable results!
969 void callbackEvent( void );
975 long duplexPrerollBytes;
976 std::vector<struct DsDevice> dsDevices;
977 bool probeDeviceOpen( unsigned int device, StreamMode mode, unsigned int channels,
978 unsigned int firstChannel, unsigned int sampleRate,
979 RtAudioFormat format, unsigned int *bufferSize,
980 RtAudio::StreamOptions *options );
985 #if defined(__WINDOWS_WASAPI__)
987 struct IMMDeviceEnumerator;
989 class RtApiWasapi : public RtApi
995 RtAudio::Api getCurrentApi( void ) { return RtAudio::WINDOWS_WASAPI; }
996 unsigned int getDeviceCount( void );
997 RtAudio::DeviceInfo getDeviceInfo( unsigned int device );
998 unsigned int getDefaultOutputDevice( void );
999 unsigned int getDefaultInputDevice( void );
1000 void closeStream( void );
1001 void startStream( void );
1002 void stopStream( void );
1003 void abortStream( void );
1006 bool coInitialized_;
1007 IMMDeviceEnumerator* deviceEnumerator_;
1009 bool probeDeviceOpen( unsigned int device, StreamMode mode, unsigned int channels,
1010 unsigned int firstChannel, unsigned int sampleRate,
1011 RtAudioFormat format, unsigned int* bufferSize,
1012 RtAudio::StreamOptions* options );
1014 static DWORD WINAPI runWasapiThread( void* wasapiPtr );
1015 static DWORD WINAPI stopWasapiThread( void* wasapiPtr );
1016 static DWORD WINAPI abortWasapiThread( void* wasapiPtr );
1017 void wasapiThread();
1022 #if defined(__LINUX_ALSA__)
1024 class RtApiAlsa: public RtApi
1030 RtAudio::Api getCurrentApi() { return RtAudio::LINUX_ALSA; }
1031 unsigned int getDeviceCount( void );
1032 RtAudio::DeviceInfo getDeviceInfo( unsigned int device );
1033 void closeStream( void );
1034 void startStream( void );
1035 void stopStream( void );
1036 void abortStream( void );
1038 // This function is intended for internal use only. It must be
1039 // public because it is called by the internal callback handler,
1040 // which is not a member of RtAudio. External use of this function
1041 // will most likely produce highly undesireable results!
1042 void callbackEvent( void );
1046 std::vector<RtAudio::DeviceInfo> devices_;
1047 void saveDeviceInfo( void );
1048 bool probeDeviceOpen( unsigned int device, StreamMode mode, unsigned int channels,
1049 unsigned int firstChannel, unsigned int sampleRate,
1050 RtAudioFormat format, unsigned int *bufferSize,
1051 RtAudio::StreamOptions *options );
1056 #if defined(__LINUX_PULSE__)
1058 class RtApiPulse: public RtApi
1062 RtAudio::Api getCurrentApi() { return RtAudio::LINUX_PULSE; }
1063 unsigned int getDeviceCount( void );
1064 RtAudio::DeviceInfo getDeviceInfo( unsigned int device );
1065 void closeStream( void );
1066 void startStream( void );
1067 void stopStream( void );
1068 void abortStream( void );
1070 // This function is intended for internal use only. It must be
1071 // public because it is called by the internal callback handler,
1072 // which is not a member of RtAudio. External use of this function
1073 // will most likely produce highly undesireable results!
1074 void callbackEvent( void );
1078 std::vector<RtAudio::DeviceInfo> devices_;
1079 void saveDeviceInfo( void );
1080 bool probeDeviceOpen( unsigned int device, StreamMode mode, unsigned int channels,
1081 unsigned int firstChannel, unsigned int sampleRate,
1082 RtAudioFormat format, unsigned int *bufferSize,
1083 RtAudio::StreamOptions *options );
1088 #if defined(__LINUX_OSS__)
1090 class RtApiOss: public RtApi
1096 RtAudio::Api getCurrentApi() { return RtAudio::LINUX_OSS; }
1097 unsigned int getDeviceCount( void );
1098 RtAudio::DeviceInfo getDeviceInfo( unsigned int device );
1099 void closeStream( void );
1100 void startStream( void );
1101 void stopStream( void );
1102 void abortStream( void );
1104 // This function is intended for internal use only. It must be
1105 // public because it is called by the internal callback handler,
1106 // which is not a member of RtAudio. External use of this function
1107 // will most likely produce highly undesireable results!
1108 void callbackEvent( void );
1112 bool probeDeviceOpen( unsigned int device, StreamMode mode, unsigned int channels,
1113 unsigned int firstChannel, unsigned int sampleRate,
1114 RtAudioFormat format, unsigned int *bufferSize,
1115 RtAudio::StreamOptions *options );
1120 #if defined(__RTAUDIO_DUMMY__)
1122 class RtApiDummy: public RtApi
1126 RtApiDummy() { errorText_ = "RtApiDummy: This class provides no functionality."; error( RtAudioError::WARNING ); }
1127 RtAudio::Api getCurrentApi( void ) { return RtAudio::RTAUDIO_DUMMY; }
1128 unsigned int getDeviceCount( void ) { return 0; }
1129 RtAudio::DeviceInfo getDeviceInfo( unsigned int /*device*/ ) { RtAudio::DeviceInfo info; return info; }
1130 void closeStream( void ) {}
1131 void startStream( void ) {}
1132 void stopStream( void ) {}
1133 void abortStream( void ) {}
1137 bool probeDeviceOpen( unsigned int /*device*/, StreamMode /*mode*/, unsigned int /*channels*/,
1138 unsigned int /*firstChannel*/, unsigned int /*sampleRate*/,
1139 RtAudioFormat /*format*/, unsigned int * /*bufferSize*/,
1140 RtAudio::StreamOptions * /*options*/ ) { return false; }
1147 // Indentation settings for Vim and Emacs
1150 // c-basic-offset: 2
1151 // indent-tabs-mode: nil
1154 // vim: et sts=2 sw=2