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-2017 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 /************************************************************************/
41 // RtAudio: Version 5.0.0
51 // Static variable definitions.
52 const unsigned int RtApi::MAX_SAMPLE_RATES = 14;
53 const unsigned int RtApi::SAMPLE_RATES[] = {
54 4000, 5512, 8000, 9600, 11025, 16000, 22050,
55 32000, 44100, 48000, 88200, 96000, 176400, 192000
58 #if defined(__WINDOWS_DS__) || defined(__WINDOWS_ASIO__) || defined(__WINDOWS_WASAPI__)
59 #define MUTEX_INITIALIZE(A) InitializeCriticalSection(A)
60 #define MUTEX_DESTROY(A) DeleteCriticalSection(A)
61 #define MUTEX_LOCK(A) EnterCriticalSection(A)
62 #define MUTEX_UNLOCK(A) LeaveCriticalSection(A)
66 static std::string convertCharPointerToStdString(const char *text)
68 return std::string(text);
71 static std::string convertCharPointerToStdString(const wchar_t *text)
73 int length = WideCharToMultiByte(CP_UTF8, 0, text, -1, NULL, 0, NULL, NULL);
74 std::string s( length-1, '\0' );
75 WideCharToMultiByte(CP_UTF8, 0, text, -1, &s[0], length, NULL, NULL);
79 #elif defined(__LINUX_ALSA__) || defined(__LINUX_PULSE__) || defined(__UNIX_JACK__) || defined(__LINUX_OSS__) || defined(__MACOSX_CORE__)
81 #define MUTEX_INITIALIZE(A) pthread_mutex_init(A, NULL)
82 #define MUTEX_DESTROY(A) pthread_mutex_destroy(A)
83 #define MUTEX_LOCK(A) pthread_mutex_lock(A)
84 #define MUTEX_UNLOCK(A) pthread_mutex_unlock(A)
86 #define MUTEX_INITIALIZE(A) abs(*A) // dummy definitions
87 #define MUTEX_DESTROY(A) abs(*A) // dummy definitions
90 // *************************************************** //
92 // RtAudio definitions.
94 // *************************************************** //
96 std::string RtAudio :: getVersion( void )
98 return RTAUDIO_VERSION;
101 void RtAudio :: getCompiledApi( std::vector<RtAudio::Api> &apis )
105 // The order here will control the order of RtAudio's API search in
107 #if defined(__UNIX_JACK__)
108 apis.push_back( UNIX_JACK );
110 #if defined(__LINUX_PULSE__)
111 apis.push_back( LINUX_PULSE );
113 #if defined(__LINUX_ALSA__)
114 apis.push_back( LINUX_ALSA );
116 #if defined(__LINUX_OSS__)
117 apis.push_back( LINUX_OSS );
119 #if defined(__WINDOWS_ASIO__)
120 apis.push_back( WINDOWS_ASIO );
122 #if defined(__WINDOWS_WASAPI__)
123 apis.push_back( WINDOWS_WASAPI );
125 #if defined(__WINDOWS_DS__)
126 apis.push_back( WINDOWS_DS );
128 #if defined(__MACOSX_CORE__)
129 apis.push_back( MACOSX_CORE );
131 #if defined(__RTAUDIO_DUMMY__)
132 apis.push_back( RTAUDIO_DUMMY );
136 void RtAudio :: openRtApi( RtAudio::Api api )
142 #if defined(__UNIX_JACK__)
143 if ( api == UNIX_JACK )
144 rtapi_ = new RtApiJack();
146 #if defined(__LINUX_ALSA__)
147 if ( api == LINUX_ALSA )
148 rtapi_ = new RtApiAlsa();
150 #if defined(__LINUX_PULSE__)
151 if ( api == LINUX_PULSE )
152 rtapi_ = new RtApiPulse();
154 #if defined(__LINUX_OSS__)
155 if ( api == LINUX_OSS )
156 rtapi_ = new RtApiOss();
158 #if defined(__WINDOWS_ASIO__)
159 if ( api == WINDOWS_ASIO )
160 rtapi_ = new RtApiAsio();
162 #if defined(__WINDOWS_WASAPI__)
163 if ( api == WINDOWS_WASAPI )
164 rtapi_ = new RtApiWasapi();
166 #if defined(__WINDOWS_DS__)
167 if ( api == WINDOWS_DS )
168 rtapi_ = new RtApiDs();
170 #if defined(__MACOSX_CORE__)
171 if ( api == MACOSX_CORE )
172 rtapi_ = new RtApiCore();
174 #if defined(__RTAUDIO_DUMMY__)
175 if ( api == RTAUDIO_DUMMY )
176 rtapi_ = new RtApiDummy();
180 RtAudio :: RtAudio( RtAudio::Api api )
184 if ( api != UNSPECIFIED ) {
185 // Attempt to open the specified API.
187 if ( rtapi_ ) return;
189 // No compiled support for specified API value. Issue a debug
190 // warning and continue as if no API was specified.
191 std::cerr << "\nRtAudio: no compiled support for specified API argument!\n" << std::endl;
194 // Iterate through the compiled APIs and return as soon as we find
195 // one with at least one device or we reach the end of the list.
196 std::vector< RtAudio::Api > apis;
197 getCompiledApi( apis );
198 for ( unsigned int i=0; i<apis.size(); i++ ) {
199 openRtApi( apis[i] );
200 if ( rtapi_ && rtapi_->getDeviceCount() ) break;
203 if ( rtapi_ ) return;
205 // It should not be possible to get here because the preprocessor
206 // definition __RTAUDIO_DUMMY__ is automatically defined if no
207 // API-specific definitions are passed to the compiler. But just in
208 // case something weird happens, we'll thow an error.
209 std::string errorText = "\nRtAudio: no compiled API support found ... critical error!!\n\n";
210 throw( RtAudioError( errorText, RtAudioError::UNSPECIFIED ) );
213 RtAudio :: ~RtAudio()
219 void RtAudio :: openStream( RtAudio::StreamParameters *outputParameters,
220 RtAudio::StreamParameters *inputParameters,
221 RtAudioFormat format, unsigned int sampleRate,
222 unsigned int *bufferFrames,
223 RtAudioCallback callback, void *userData,
224 RtAudio::StreamOptions *options,
225 RtAudioErrorCallback errorCallback )
227 return rtapi_->openStream( outputParameters, inputParameters, format,
228 sampleRate, bufferFrames, callback,
229 userData, options, errorCallback );
232 // *************************************************** //
234 // Public RtApi definitions (see end of file for
235 // private or protected utility functions).
237 // *************************************************** //
241 stream_.state = STREAM_CLOSED;
242 stream_.mode = UNINITIALIZED;
243 stream_.apiHandle = 0;
244 stream_.userBuffer[0] = 0;
245 stream_.userBuffer[1] = 0;
246 MUTEX_INITIALIZE( &stream_.mutex );
247 showWarnings_ = true;
248 firstErrorOccurred_ = false;
253 MUTEX_DESTROY( &stream_.mutex );
256 void RtApi :: openStream( RtAudio::StreamParameters *oParams,
257 RtAudio::StreamParameters *iParams,
258 RtAudioFormat format, unsigned int sampleRate,
259 unsigned int *bufferFrames,
260 RtAudioCallback callback, void *userData,
261 RtAudio::StreamOptions *options,
262 RtAudioErrorCallback errorCallback )
264 if ( stream_.state != STREAM_CLOSED ) {
265 errorText_ = "RtApi::openStream: a stream is already open!";
266 error( RtAudioError::INVALID_USE );
270 // Clear stream information potentially left from a previously open stream.
273 if ( oParams && oParams->nChannels < 1 ) {
274 errorText_ = "RtApi::openStream: a non-NULL output StreamParameters structure cannot have an nChannels value less than one.";
275 error( RtAudioError::INVALID_USE );
279 if ( iParams && iParams->nChannels < 1 ) {
280 errorText_ = "RtApi::openStream: a non-NULL input StreamParameters structure cannot have an nChannels value less than one.";
281 error( RtAudioError::INVALID_USE );
285 if ( oParams == NULL && iParams == NULL ) {
286 errorText_ = "RtApi::openStream: input and output StreamParameters structures are both NULL!";
287 error( RtAudioError::INVALID_USE );
291 if ( formatBytes(format) == 0 ) {
292 errorText_ = "RtApi::openStream: 'format' parameter value is undefined.";
293 error( RtAudioError::INVALID_USE );
297 unsigned int nDevices = getDeviceCount();
298 unsigned int oChannels = 0;
300 oChannels = oParams->nChannels;
301 if ( oParams->deviceId >= nDevices ) {
302 errorText_ = "RtApi::openStream: output device parameter value is invalid.";
303 error( RtAudioError::INVALID_USE );
308 unsigned int iChannels = 0;
310 iChannels = iParams->nChannels;
311 if ( iParams->deviceId >= nDevices ) {
312 errorText_ = "RtApi::openStream: input device parameter value is invalid.";
313 error( RtAudioError::INVALID_USE );
320 if ( oChannels > 0 ) {
322 result = probeDeviceOpen( oParams->deviceId, OUTPUT, oChannels, oParams->firstChannel,
323 sampleRate, format, bufferFrames, options );
324 if ( result == false ) {
325 error( RtAudioError::SYSTEM_ERROR );
330 if ( iChannels > 0 ) {
332 result = probeDeviceOpen( iParams->deviceId, INPUT, iChannels, iParams->firstChannel,
333 sampleRate, format, bufferFrames, options );
334 if ( result == false ) {
335 if ( oChannels > 0 ) closeStream();
336 error( RtAudioError::SYSTEM_ERROR );
341 stream_.callbackInfo.callback = (void *) callback;
342 stream_.callbackInfo.userData = userData;
343 stream_.callbackInfo.errorCallback = (void *) errorCallback;
345 if ( options ) options->numberOfBuffers = stream_.nBuffers;
346 stream_.state = STREAM_STOPPED;
349 unsigned int RtApi :: getDefaultInputDevice( void )
351 // Should be implemented in subclasses if possible.
355 unsigned int RtApi :: getDefaultOutputDevice( void )
357 // Should be implemented in subclasses if possible.
361 void RtApi :: closeStream( void )
363 // MUST be implemented in subclasses!
367 bool RtApi :: probeDeviceOpen( unsigned int /*device*/, StreamMode /*mode*/, unsigned int /*channels*/,
368 unsigned int /*firstChannel*/, unsigned int /*sampleRate*/,
369 RtAudioFormat /*format*/, unsigned int * /*bufferSize*/,
370 RtAudio::StreamOptions * /*options*/ )
372 // MUST be implemented in subclasses!
376 void RtApi :: tickStreamTime( void )
378 // Subclasses that do not provide their own implementation of
379 // getStreamTime should call this function once per buffer I/O to
380 // provide basic stream time support.
382 stream_.streamTime += ( stream_.bufferSize * 1.0 / stream_.sampleRate );
384 #if defined( HAVE_GETTIMEOFDAY )
385 gettimeofday( &stream_.lastTickTimestamp, NULL );
389 long RtApi :: getStreamLatency( void )
393 long totalLatency = 0;
394 if ( stream_.mode == OUTPUT || stream_.mode == DUPLEX )
395 totalLatency = stream_.latency[0];
396 if ( stream_.mode == INPUT || stream_.mode == DUPLEX )
397 totalLatency += stream_.latency[1];
402 double RtApi :: getStreamTime( void )
406 #if defined( HAVE_GETTIMEOFDAY )
407 // Return a very accurate estimate of the stream time by
408 // adding in the elapsed time since the last tick.
412 if ( stream_.state != STREAM_RUNNING || stream_.streamTime == 0.0 )
413 return stream_.streamTime;
415 gettimeofday( &now, NULL );
416 then = stream_.lastTickTimestamp;
417 return stream_.streamTime +
418 ((now.tv_sec + 0.000001 * now.tv_usec) -
419 (then.tv_sec + 0.000001 * then.tv_usec));
421 return stream_.streamTime;
425 void RtApi :: setStreamTime( double time )
430 stream_.streamTime = time;
431 #if defined( HAVE_GETTIMEOFDAY )
432 gettimeofday( &stream_.lastTickTimestamp, NULL );
436 unsigned int RtApi :: getStreamSampleRate( void )
440 return stream_.sampleRate;
444 // *************************************************** //
446 // OS/API-specific methods.
448 // *************************************************** //
450 #if defined(__MACOSX_CORE__)
452 // The OS X CoreAudio API is designed to use a separate callback
453 // procedure for each of its audio devices. A single RtAudio duplex
454 // stream using two different devices is supported here, though it
455 // cannot be guaranteed to always behave correctly because we cannot
456 // synchronize these two callbacks.
458 // A property listener is installed for over/underrun information.
459 // However, no functionality is currently provided to allow property
460 // listeners to trigger user handlers because it is unclear what could
461 // be done if a critical stream parameter (buffer size, sample rate,
462 // device disconnect) notification arrived. The listeners entail
463 // quite a bit of extra code and most likely, a user program wouldn't
464 // be prepared for the result anyway. However, we do provide a flag
465 // to the client callback function to inform of an over/underrun.
467 // A structure to hold various information related to the CoreAudio API
470 AudioDeviceID id[2]; // device ids
471 #if defined( MAC_OS_X_VERSION_10_5 ) && ( MAC_OS_X_VERSION_MIN_REQUIRED >= MAC_OS_X_VERSION_10_5 )
472 AudioDeviceIOProcID procId[2];
474 UInt32 iStream[2]; // device stream index (or first if using multiple)
475 UInt32 nStreams[2]; // number of streams to use
478 pthread_cond_t condition;
479 int drainCounter; // Tracks callback counts when draining
480 bool internalDrain; // Indicates if stop is initiated from callback or not.
483 :deviceBuffer(0), drainCounter(0), internalDrain(false) { nStreams[0] = 1; nStreams[1] = 1; id[0] = 0; id[1] = 0; xrun[0] = false; xrun[1] = false; }
486 RtApiCore:: RtApiCore()
488 #if defined( AVAILABLE_MAC_OS_X_VERSION_10_6_AND_LATER )
489 // This is a largely undocumented but absolutely necessary
490 // requirement starting with OS-X 10.6. If not called, queries and
491 // updates to various audio device properties are not handled
493 CFRunLoopRef theRunLoop = NULL;
494 AudioObjectPropertyAddress property = { kAudioHardwarePropertyRunLoop,
495 kAudioObjectPropertyScopeGlobal,
496 kAudioObjectPropertyElementMaster };
497 OSStatus result = AudioObjectSetPropertyData( kAudioObjectSystemObject, &property, 0, NULL, sizeof(CFRunLoopRef), &theRunLoop);
498 if ( result != noErr ) {
499 errorText_ = "RtApiCore::RtApiCore: error setting run loop property!";
500 error( RtAudioError::WARNING );
505 RtApiCore :: ~RtApiCore()
507 // The subclass destructor gets called before the base class
508 // destructor, so close an existing stream before deallocating
509 // apiDeviceId memory.
510 if ( stream_.state != STREAM_CLOSED ) closeStream();
513 unsigned int RtApiCore :: getDeviceCount( void )
515 // Find out how many audio devices there are, if any.
517 AudioObjectPropertyAddress propertyAddress = { kAudioHardwarePropertyDevices, kAudioObjectPropertyScopeGlobal, kAudioObjectPropertyElementMaster };
518 OSStatus result = AudioObjectGetPropertyDataSize( kAudioObjectSystemObject, &propertyAddress, 0, NULL, &dataSize );
519 if ( result != noErr ) {
520 errorText_ = "RtApiCore::getDeviceCount: OS-X error getting device info!";
521 error( RtAudioError::WARNING );
525 return dataSize / sizeof( AudioDeviceID );
528 unsigned int RtApiCore :: getDefaultInputDevice( void )
530 unsigned int nDevices = getDeviceCount();
531 if ( nDevices <= 1 ) return 0;
534 UInt32 dataSize = sizeof( AudioDeviceID );
535 AudioObjectPropertyAddress property = { kAudioHardwarePropertyDefaultInputDevice, kAudioObjectPropertyScopeGlobal, kAudioObjectPropertyElementMaster };
536 OSStatus result = AudioObjectGetPropertyData( kAudioObjectSystemObject, &property, 0, NULL, &dataSize, &id );
537 if ( result != noErr ) {
538 errorText_ = "RtApiCore::getDefaultInputDevice: OS-X system error getting device.";
539 error( RtAudioError::WARNING );
543 dataSize *= nDevices;
544 AudioDeviceID deviceList[ nDevices ];
545 property.mSelector = kAudioHardwarePropertyDevices;
546 result = AudioObjectGetPropertyData( kAudioObjectSystemObject, &property, 0, NULL, &dataSize, (void *) &deviceList );
547 if ( result != noErr ) {
548 errorText_ = "RtApiCore::getDefaultInputDevice: OS-X system error getting device IDs.";
549 error( RtAudioError::WARNING );
553 for ( unsigned int i=0; i<nDevices; i++ )
554 if ( id == deviceList[i] ) return i;
556 errorText_ = "RtApiCore::getDefaultInputDevice: No default device found!";
557 error( RtAudioError::WARNING );
561 unsigned int RtApiCore :: getDefaultOutputDevice( void )
563 unsigned int nDevices = getDeviceCount();
564 if ( nDevices <= 1 ) return 0;
567 UInt32 dataSize = sizeof( AudioDeviceID );
568 AudioObjectPropertyAddress property = { kAudioHardwarePropertyDefaultOutputDevice, kAudioObjectPropertyScopeGlobal, kAudioObjectPropertyElementMaster };
569 OSStatus result = AudioObjectGetPropertyData( kAudioObjectSystemObject, &property, 0, NULL, &dataSize, &id );
570 if ( result != noErr ) {
571 errorText_ = "RtApiCore::getDefaultOutputDevice: OS-X system error getting device.";
572 error( RtAudioError::WARNING );
576 dataSize = sizeof( AudioDeviceID ) * nDevices;
577 AudioDeviceID deviceList[ nDevices ];
578 property.mSelector = kAudioHardwarePropertyDevices;
579 result = AudioObjectGetPropertyData( kAudioObjectSystemObject, &property, 0, NULL, &dataSize, (void *) &deviceList );
580 if ( result != noErr ) {
581 errorText_ = "RtApiCore::getDefaultOutputDevice: OS-X system error getting device IDs.";
582 error( RtAudioError::WARNING );
586 for ( unsigned int i=0; i<nDevices; i++ )
587 if ( id == deviceList[i] ) return i;
589 errorText_ = "RtApiCore::getDefaultOutputDevice: No default device found!";
590 error( RtAudioError::WARNING );
594 RtAudio::DeviceInfo RtApiCore :: getDeviceInfo( unsigned int device )
596 RtAudio::DeviceInfo info;
600 unsigned int nDevices = getDeviceCount();
601 if ( nDevices == 0 ) {
602 errorText_ = "RtApiCore::getDeviceInfo: no devices found!";
603 error( RtAudioError::INVALID_USE );
607 if ( device >= nDevices ) {
608 errorText_ = "RtApiCore::getDeviceInfo: device ID is invalid!";
609 error( RtAudioError::INVALID_USE );
613 AudioDeviceID deviceList[ nDevices ];
614 UInt32 dataSize = sizeof( AudioDeviceID ) * nDevices;
615 AudioObjectPropertyAddress property = { kAudioHardwarePropertyDevices,
616 kAudioObjectPropertyScopeGlobal,
617 kAudioObjectPropertyElementMaster };
618 OSStatus result = AudioObjectGetPropertyData( kAudioObjectSystemObject, &property,
619 0, NULL, &dataSize, (void *) &deviceList );
620 if ( result != noErr ) {
621 errorText_ = "RtApiCore::getDeviceInfo: OS-X system error getting device IDs.";
622 error( RtAudioError::WARNING );
626 AudioDeviceID id = deviceList[ device ];
628 // Get the device name.
631 dataSize = sizeof( CFStringRef );
632 property.mSelector = kAudioObjectPropertyManufacturer;
633 result = AudioObjectGetPropertyData( id, &property, 0, NULL, &dataSize, &cfname );
634 if ( result != noErr ) {
635 errorStream_ << "RtApiCore::probeDeviceInfo: system error (" << getErrorCode( result ) << ") getting device manufacturer.";
636 errorText_ = errorStream_.str();
637 error( RtAudioError::WARNING );
641 //const char *mname = CFStringGetCStringPtr( cfname, CFStringGetSystemEncoding() );
642 int length = CFStringGetLength(cfname);
643 char *mname = (char *)malloc(length * 3 + 1);
644 #if defined( UNICODE ) || defined( _UNICODE )
645 CFStringGetCString(cfname, mname, length * 3 + 1, kCFStringEncodingUTF8);
647 CFStringGetCString(cfname, mname, length * 3 + 1, CFStringGetSystemEncoding());
649 info.name.append( (const char *)mname, strlen(mname) );
650 info.name.append( ": " );
654 property.mSelector = kAudioObjectPropertyName;
655 result = AudioObjectGetPropertyData( id, &property, 0, NULL, &dataSize, &cfname );
656 if ( result != noErr ) {
657 errorStream_ << "RtApiCore::probeDeviceInfo: system error (" << getErrorCode( result ) << ") getting device name.";
658 errorText_ = errorStream_.str();
659 error( RtAudioError::WARNING );
663 //const char *name = CFStringGetCStringPtr( cfname, CFStringGetSystemEncoding() );
664 length = CFStringGetLength(cfname);
665 char *name = (char *)malloc(length * 3 + 1);
666 #if defined( UNICODE ) || defined( _UNICODE )
667 CFStringGetCString(cfname, name, length * 3 + 1, kCFStringEncodingUTF8);
669 CFStringGetCString(cfname, name, length * 3 + 1, CFStringGetSystemEncoding());
671 info.name.append( (const char *)name, strlen(name) );
675 // Get the output stream "configuration".
676 AudioBufferList *bufferList = nil;
677 property.mSelector = kAudioDevicePropertyStreamConfiguration;
678 property.mScope = kAudioDevicePropertyScopeOutput;
679 // property.mElement = kAudioObjectPropertyElementWildcard;
681 result = AudioObjectGetPropertyDataSize( id, &property, 0, NULL, &dataSize );
682 if ( result != noErr || dataSize == 0 ) {
683 errorStream_ << "RtApiCore::getDeviceInfo: system error (" << getErrorCode( result ) << ") getting output stream configuration info for device (" << device << ").";
684 errorText_ = errorStream_.str();
685 error( RtAudioError::WARNING );
689 // Allocate the AudioBufferList.
690 bufferList = (AudioBufferList *) malloc( dataSize );
691 if ( bufferList == NULL ) {
692 errorText_ = "RtApiCore::getDeviceInfo: memory error allocating output AudioBufferList.";
693 error( RtAudioError::WARNING );
697 result = AudioObjectGetPropertyData( id, &property, 0, NULL, &dataSize, bufferList );
698 if ( result != noErr || dataSize == 0 ) {
700 errorStream_ << "RtApiCore::getDeviceInfo: system error (" << getErrorCode( result ) << ") getting output stream configuration for device (" << device << ").";
701 errorText_ = errorStream_.str();
702 error( RtAudioError::WARNING );
706 // Get output channel information.
707 unsigned int i, nStreams = bufferList->mNumberBuffers;
708 for ( i=0; i<nStreams; i++ )
709 info.outputChannels += bufferList->mBuffers[i].mNumberChannels;
712 // Get the input stream "configuration".
713 property.mScope = kAudioDevicePropertyScopeInput;
714 result = AudioObjectGetPropertyDataSize( id, &property, 0, NULL, &dataSize );
715 if ( result != noErr || dataSize == 0 ) {
716 errorStream_ << "RtApiCore::getDeviceInfo: system error (" << getErrorCode( result ) << ") getting input stream configuration info for device (" << device << ").";
717 errorText_ = errorStream_.str();
718 error( RtAudioError::WARNING );
722 // Allocate the AudioBufferList.
723 bufferList = (AudioBufferList *) malloc( dataSize );
724 if ( bufferList == NULL ) {
725 errorText_ = "RtApiCore::getDeviceInfo: memory error allocating input AudioBufferList.";
726 error( RtAudioError::WARNING );
730 result = AudioObjectGetPropertyData( id, &property, 0, NULL, &dataSize, bufferList );
731 if (result != noErr || dataSize == 0) {
733 errorStream_ << "RtApiCore::getDeviceInfo: system error (" << getErrorCode( result ) << ") getting input stream configuration for device (" << device << ").";
734 errorText_ = errorStream_.str();
735 error( RtAudioError::WARNING );
739 // Get input channel information.
740 nStreams = bufferList->mNumberBuffers;
741 for ( i=0; i<nStreams; i++ )
742 info.inputChannels += bufferList->mBuffers[i].mNumberChannels;
745 // If device opens for both playback and capture, we determine the channels.
746 if ( info.outputChannels > 0 && info.inputChannels > 0 )
747 info.duplexChannels = (info.outputChannels > info.inputChannels) ? info.inputChannels : info.outputChannels;
749 // Probe the device sample rates.
750 bool isInput = false;
751 if ( info.outputChannels == 0 ) isInput = true;
753 // Determine the supported sample rates.
754 property.mSelector = kAudioDevicePropertyAvailableNominalSampleRates;
755 if ( isInput == false ) property.mScope = kAudioDevicePropertyScopeOutput;
756 result = AudioObjectGetPropertyDataSize( id, &property, 0, NULL, &dataSize );
757 if ( result != kAudioHardwareNoError || dataSize == 0 ) {
758 errorStream_ << "RtApiCore::getDeviceInfo: system error (" << getErrorCode( result ) << ") getting sample rate info.";
759 errorText_ = errorStream_.str();
760 error( RtAudioError::WARNING );
764 UInt32 nRanges = dataSize / sizeof( AudioValueRange );
765 AudioValueRange rangeList[ nRanges ];
766 result = AudioObjectGetPropertyData( id, &property, 0, NULL, &dataSize, &rangeList );
767 if ( result != kAudioHardwareNoError ) {
768 errorStream_ << "RtApiCore::getDeviceInfo: system error (" << getErrorCode( result ) << ") getting sample rates.";
769 errorText_ = errorStream_.str();
770 error( RtAudioError::WARNING );
774 // The sample rate reporting mechanism is a bit of a mystery. It
775 // seems that it can either return individual rates or a range of
776 // rates. I assume that if the min / max range values are the same,
777 // then that represents a single supported rate and if the min / max
778 // range values are different, the device supports an arbitrary
779 // range of values (though there might be multiple ranges, so we'll
780 // use the most conservative range).
781 Float64 minimumRate = 1.0, maximumRate = 10000000000.0;
782 bool haveValueRange = false;
783 info.sampleRates.clear();
784 for ( UInt32 i=0; i<nRanges; i++ ) {
785 if ( rangeList[i].mMinimum == rangeList[i].mMaximum ) {
786 unsigned int tmpSr = (unsigned int) rangeList[i].mMinimum;
787 info.sampleRates.push_back( tmpSr );
789 if ( !info.preferredSampleRate || ( tmpSr <= 48000 && tmpSr > info.preferredSampleRate ) )
790 info.preferredSampleRate = tmpSr;
793 haveValueRange = true;
794 if ( rangeList[i].mMinimum > minimumRate ) minimumRate = rangeList[i].mMinimum;
795 if ( rangeList[i].mMaximum < maximumRate ) maximumRate = rangeList[i].mMaximum;
799 if ( haveValueRange ) {
800 for ( unsigned int k=0; k<MAX_SAMPLE_RATES; k++ ) {
801 if ( SAMPLE_RATES[k] >= (unsigned int) minimumRate && SAMPLE_RATES[k] <= (unsigned int) maximumRate ) {
802 info.sampleRates.push_back( SAMPLE_RATES[k] );
804 if ( !info.preferredSampleRate || ( SAMPLE_RATES[k] <= 48000 && SAMPLE_RATES[k] > info.preferredSampleRate ) )
805 info.preferredSampleRate = SAMPLE_RATES[k];
810 // Sort and remove any redundant values
811 std::sort( info.sampleRates.begin(), info.sampleRates.end() );
812 info.sampleRates.erase( unique( info.sampleRates.begin(), info.sampleRates.end() ), info.sampleRates.end() );
814 if ( info.sampleRates.size() == 0 ) {
815 errorStream_ << "RtApiCore::probeDeviceInfo: No supported sample rates found for device (" << device << ").";
816 errorText_ = errorStream_.str();
817 error( RtAudioError::WARNING );
821 // CoreAudio always uses 32-bit floating point data for PCM streams.
822 // Thus, any other "physical" formats supported by the device are of
823 // no interest to the client.
824 info.nativeFormats = RTAUDIO_FLOAT32;
826 if ( info.outputChannels > 0 )
827 if ( getDefaultOutputDevice() == device ) info.isDefaultOutput = true;
828 if ( info.inputChannels > 0 )
829 if ( getDefaultInputDevice() == device ) info.isDefaultInput = true;
835 static OSStatus callbackHandler( AudioDeviceID inDevice,
836 const AudioTimeStamp* /*inNow*/,
837 const AudioBufferList* inInputData,
838 const AudioTimeStamp* /*inInputTime*/,
839 AudioBufferList* outOutputData,
840 const AudioTimeStamp* /*inOutputTime*/,
843 CallbackInfo *info = (CallbackInfo *) infoPointer;
845 RtApiCore *object = (RtApiCore *) info->object;
846 if ( object->callbackEvent( inDevice, inInputData, outOutputData ) == false )
847 return kAudioHardwareUnspecifiedError;
849 return kAudioHardwareNoError;
852 static OSStatus xrunListener( AudioObjectID /*inDevice*/,
854 const AudioObjectPropertyAddress properties[],
855 void* handlePointer )
857 CoreHandle *handle = (CoreHandle *) handlePointer;
858 for ( UInt32 i=0; i<nAddresses; i++ ) {
859 if ( properties[i].mSelector == kAudioDeviceProcessorOverload ) {
860 if ( properties[i].mScope == kAudioDevicePropertyScopeInput )
861 handle->xrun[1] = true;
863 handle->xrun[0] = true;
867 return kAudioHardwareNoError;
870 static OSStatus rateListener( AudioObjectID inDevice,
871 UInt32 /*nAddresses*/,
872 const AudioObjectPropertyAddress /*properties*/[],
875 Float64 *rate = (Float64 *) ratePointer;
876 UInt32 dataSize = sizeof( Float64 );
877 AudioObjectPropertyAddress property = { kAudioDevicePropertyNominalSampleRate,
878 kAudioObjectPropertyScopeGlobal,
879 kAudioObjectPropertyElementMaster };
880 AudioObjectGetPropertyData( inDevice, &property, 0, NULL, &dataSize, rate );
881 return kAudioHardwareNoError;
884 bool RtApiCore :: probeDeviceOpen( unsigned int device, StreamMode mode, unsigned int channels,
885 unsigned int firstChannel, unsigned int sampleRate,
886 RtAudioFormat format, unsigned int *bufferSize,
887 RtAudio::StreamOptions *options )
890 unsigned int nDevices = getDeviceCount();
891 if ( nDevices == 0 ) {
892 // This should not happen because a check is made before this function is called.
893 errorText_ = "RtApiCore::probeDeviceOpen: no devices found!";
897 if ( device >= nDevices ) {
898 // This should not happen because a check is made before this function is called.
899 errorText_ = "RtApiCore::probeDeviceOpen: device ID is invalid!";
903 AudioDeviceID deviceList[ nDevices ];
904 UInt32 dataSize = sizeof( AudioDeviceID ) * nDevices;
905 AudioObjectPropertyAddress property = { kAudioHardwarePropertyDevices,
906 kAudioObjectPropertyScopeGlobal,
907 kAudioObjectPropertyElementMaster };
908 OSStatus result = AudioObjectGetPropertyData( kAudioObjectSystemObject, &property,
909 0, NULL, &dataSize, (void *) &deviceList );
910 if ( result != noErr ) {
911 errorText_ = "RtApiCore::probeDeviceOpen: OS-X system error getting device IDs.";
915 AudioDeviceID id = deviceList[ device ];
917 // Setup for stream mode.
918 bool isInput = false;
919 if ( mode == INPUT ) {
921 property.mScope = kAudioDevicePropertyScopeInput;
924 property.mScope = kAudioDevicePropertyScopeOutput;
926 // Get the stream "configuration".
927 AudioBufferList *bufferList = nil;
929 property.mSelector = kAudioDevicePropertyStreamConfiguration;
930 result = AudioObjectGetPropertyDataSize( id, &property, 0, NULL, &dataSize );
931 if ( result != noErr || dataSize == 0 ) {
932 errorStream_ << "RtApiCore::probeDeviceOpen: system error (" << getErrorCode( result ) << ") getting stream configuration info for device (" << device << ").";
933 errorText_ = errorStream_.str();
937 // Allocate the AudioBufferList.
938 bufferList = (AudioBufferList *) malloc( dataSize );
939 if ( bufferList == NULL ) {
940 errorText_ = "RtApiCore::probeDeviceOpen: memory error allocating AudioBufferList.";
944 result = AudioObjectGetPropertyData( id, &property, 0, NULL, &dataSize, bufferList );
945 if (result != noErr || dataSize == 0) {
947 errorStream_ << "RtApiCore::probeDeviceOpen: system error (" << getErrorCode( result ) << ") getting stream configuration for device (" << device << ").";
948 errorText_ = errorStream_.str();
952 // Search for one or more streams that contain the desired number of
953 // channels. CoreAudio devices can have an arbitrary number of
954 // streams and each stream can have an arbitrary number of channels.
955 // For each stream, a single buffer of interleaved samples is
956 // provided. RtAudio prefers the use of one stream of interleaved
957 // data or multiple consecutive single-channel streams. However, we
958 // now support multiple consecutive multi-channel streams of
959 // interleaved data as well.
960 UInt32 iStream, offsetCounter = firstChannel;
961 UInt32 nStreams = bufferList->mNumberBuffers;
962 bool monoMode = false;
963 bool foundStream = false;
965 // First check that the device supports the requested number of
967 UInt32 deviceChannels = 0;
968 for ( iStream=0; iStream<nStreams; iStream++ )
969 deviceChannels += bufferList->mBuffers[iStream].mNumberChannels;
971 if ( deviceChannels < ( channels + firstChannel ) ) {
973 errorStream_ << "RtApiCore::probeDeviceOpen: the device (" << device << ") does not support the requested channel count.";
974 errorText_ = errorStream_.str();
978 // Look for a single stream meeting our needs.
979 UInt32 firstStream, streamCount = 1, streamChannels = 0, channelOffset = 0;
980 for ( iStream=0; iStream<nStreams; iStream++ ) {
981 streamChannels = bufferList->mBuffers[iStream].mNumberChannels;
982 if ( streamChannels >= channels + offsetCounter ) {
983 firstStream = iStream;
984 channelOffset = offsetCounter;
988 if ( streamChannels > offsetCounter ) break;
989 offsetCounter -= streamChannels;
992 // If we didn't find a single stream above, then we should be able
993 // to meet the channel specification with multiple streams.
994 if ( foundStream == false ) {
996 offsetCounter = firstChannel;
997 for ( iStream=0; iStream<nStreams; iStream++ ) {
998 streamChannels = bufferList->mBuffers[iStream].mNumberChannels;
999 if ( streamChannels > offsetCounter ) break;
1000 offsetCounter -= streamChannels;
1003 firstStream = iStream;
1004 channelOffset = offsetCounter;
1005 Int32 channelCounter = channels + offsetCounter - streamChannels;
1007 if ( streamChannels > 1 ) monoMode = false;
1008 while ( channelCounter > 0 ) {
1009 streamChannels = bufferList->mBuffers[++iStream].mNumberChannels;
1010 if ( streamChannels > 1 ) monoMode = false;
1011 channelCounter -= streamChannels;
1018 // Determine the buffer size.
1019 AudioValueRange bufferRange;
1020 dataSize = sizeof( AudioValueRange );
1021 property.mSelector = kAudioDevicePropertyBufferFrameSizeRange;
1022 result = AudioObjectGetPropertyData( id, &property, 0, NULL, &dataSize, &bufferRange );
1024 if ( result != noErr ) {
1025 errorStream_ << "RtApiCore::probeDeviceOpen: system error (" << getErrorCode( result ) << ") getting buffer size range for device (" << device << ").";
1026 errorText_ = errorStream_.str();
1030 if ( bufferRange.mMinimum > *bufferSize ) *bufferSize = (unsigned long) bufferRange.mMinimum;
1031 else if ( bufferRange.mMaximum < *bufferSize ) *bufferSize = (unsigned long) bufferRange.mMaximum;
1032 if ( options && options->flags & RTAUDIO_MINIMIZE_LATENCY ) *bufferSize = (unsigned long) bufferRange.mMinimum;
1034 // Set the buffer size. For multiple streams, I'm assuming we only
1035 // need to make this setting for the master channel.
1036 UInt32 theSize = (UInt32) *bufferSize;
1037 dataSize = sizeof( UInt32 );
1038 property.mSelector = kAudioDevicePropertyBufferFrameSize;
1039 result = AudioObjectSetPropertyData( id, &property, 0, NULL, dataSize, &theSize );
1041 if ( result != noErr ) {
1042 errorStream_ << "RtApiCore::probeDeviceOpen: system error (" << getErrorCode( result ) << ") setting the buffer size for device (" << device << ").";
1043 errorText_ = errorStream_.str();
1047 // If attempting to setup a duplex stream, the bufferSize parameter
1048 // MUST be the same in both directions!
1049 *bufferSize = theSize;
1050 if ( stream_.mode == OUTPUT && mode == INPUT && *bufferSize != stream_.bufferSize ) {
1051 errorStream_ << "RtApiCore::probeDeviceOpen: system error setting buffer size for duplex stream on device (" << device << ").";
1052 errorText_ = errorStream_.str();
1056 stream_.bufferSize = *bufferSize;
1057 stream_.nBuffers = 1;
1059 // Try to set "hog" mode ... it's not clear to me this is working.
1060 if ( options && options->flags & RTAUDIO_HOG_DEVICE ) {
1062 dataSize = sizeof( hog_pid );
1063 property.mSelector = kAudioDevicePropertyHogMode;
1064 result = AudioObjectGetPropertyData( id, &property, 0, NULL, &dataSize, &hog_pid );
1065 if ( result != noErr ) {
1066 errorStream_ << "RtApiCore::probeDeviceOpen: system error (" << getErrorCode( result ) << ") getting 'hog' state!";
1067 errorText_ = errorStream_.str();
1071 if ( hog_pid != getpid() ) {
1073 result = AudioObjectSetPropertyData( id, &property, 0, NULL, dataSize, &hog_pid );
1074 if ( result != noErr ) {
1075 errorStream_ << "RtApiCore::probeDeviceOpen: system error (" << getErrorCode( result ) << ") setting 'hog' state!";
1076 errorText_ = errorStream_.str();
1082 // Check and if necessary, change the sample rate for the device.
1083 Float64 nominalRate;
1084 dataSize = sizeof( Float64 );
1085 property.mSelector = kAudioDevicePropertyNominalSampleRate;
1086 result = AudioObjectGetPropertyData( id, &property, 0, NULL, &dataSize, &nominalRate );
1087 if ( result != noErr ) {
1088 errorStream_ << "RtApiCore::probeDeviceOpen: system error (" << getErrorCode( result ) << ") getting current sample rate.";
1089 errorText_ = errorStream_.str();
1093 // Only change the sample rate if off by more than 1 Hz.
1094 if ( fabs( nominalRate - (double)sampleRate ) > 1.0 ) {
1096 // Set a property listener for the sample rate change
1097 Float64 reportedRate = 0.0;
1098 AudioObjectPropertyAddress tmp = { kAudioDevicePropertyNominalSampleRate, kAudioObjectPropertyScopeGlobal, kAudioObjectPropertyElementMaster };
1099 result = AudioObjectAddPropertyListener( id, &tmp, rateListener, (void *) &reportedRate );
1100 if ( result != noErr ) {
1101 errorStream_ << "RtApiCore::probeDeviceOpen: system error (" << getErrorCode( result ) << ") setting sample rate property listener for device (" << device << ").";
1102 errorText_ = errorStream_.str();
1106 nominalRate = (Float64) sampleRate;
1107 result = AudioObjectSetPropertyData( id, &property, 0, NULL, dataSize, &nominalRate );
1108 if ( result != noErr ) {
1109 AudioObjectRemovePropertyListener( id, &tmp, rateListener, (void *) &reportedRate );
1110 errorStream_ << "RtApiCore::probeDeviceOpen: system error (" << getErrorCode( result ) << ") setting sample rate for device (" << device << ").";
1111 errorText_ = errorStream_.str();
1115 // Now wait until the reported nominal rate is what we just set.
1116 UInt32 microCounter = 0;
1117 while ( reportedRate != nominalRate ) {
1118 microCounter += 5000;
1119 if ( microCounter > 5000000 ) break;
1123 // Remove the property listener.
1124 AudioObjectRemovePropertyListener( id, &tmp, rateListener, (void *) &reportedRate );
1126 if ( microCounter > 5000000 ) {
1127 errorStream_ << "RtApiCore::probeDeviceOpen: timeout waiting for sample rate update for device (" << device << ").";
1128 errorText_ = errorStream_.str();
1133 // Now set the stream format for all streams. Also, check the
1134 // physical format of the device and change that if necessary.
1135 AudioStreamBasicDescription description;
1136 dataSize = sizeof( AudioStreamBasicDescription );
1137 property.mSelector = kAudioStreamPropertyVirtualFormat;
1138 result = AudioObjectGetPropertyData( id, &property, 0, NULL, &dataSize, &description );
1139 if ( result != noErr ) {
1140 errorStream_ << "RtApiCore::probeDeviceOpen: system error (" << getErrorCode( result ) << ") getting stream format for device (" << device << ").";
1141 errorText_ = errorStream_.str();
1145 // Set the sample rate and data format id. However, only make the
1146 // change if the sample rate is not within 1.0 of the desired
1147 // rate and the format is not linear pcm.
1148 bool updateFormat = false;
1149 if ( fabs( description.mSampleRate - (Float64)sampleRate ) > 1.0 ) {
1150 description.mSampleRate = (Float64) sampleRate;
1151 updateFormat = true;
1154 if ( description.mFormatID != kAudioFormatLinearPCM ) {
1155 description.mFormatID = kAudioFormatLinearPCM;
1156 updateFormat = true;
1159 if ( updateFormat ) {
1160 result = AudioObjectSetPropertyData( id, &property, 0, NULL, dataSize, &description );
1161 if ( result != noErr ) {
1162 errorStream_ << "RtApiCore::probeDeviceOpen: system error (" << getErrorCode( result ) << ") setting sample rate or data format for device (" << device << ").";
1163 errorText_ = errorStream_.str();
1168 // Now check the physical format.
1169 property.mSelector = kAudioStreamPropertyPhysicalFormat;
1170 result = AudioObjectGetPropertyData( id, &property, 0, NULL, &dataSize, &description );
1171 if ( result != noErr ) {
1172 errorStream_ << "RtApiCore::probeDeviceOpen: system error (" << getErrorCode( result ) << ") getting stream physical format for device (" << device << ").";
1173 errorText_ = errorStream_.str();
1177 //std::cout << "Current physical stream format:" << std::endl;
1178 //std::cout << " mBitsPerChan = " << description.mBitsPerChannel << std::endl;
1179 //std::cout << " aligned high = " << (description.mFormatFlags & kAudioFormatFlagIsAlignedHigh) << ", isPacked = " << (description.mFormatFlags & kAudioFormatFlagIsPacked) << std::endl;
1180 //std::cout << " bytesPerFrame = " << description.mBytesPerFrame << std::endl;
1181 //std::cout << " sample rate = " << description.mSampleRate << std::endl;
1183 if ( description.mFormatID != kAudioFormatLinearPCM || description.mBitsPerChannel < 16 ) {
1184 description.mFormatID = kAudioFormatLinearPCM;
1185 //description.mSampleRate = (Float64) sampleRate;
1186 AudioStreamBasicDescription testDescription = description;
1189 // We'll try higher bit rates first and then work our way down.
1190 std::vector< std::pair<UInt32, UInt32> > physicalFormats;
1191 formatFlags = (description.mFormatFlags | kLinearPCMFormatFlagIsFloat) & ~kLinearPCMFormatFlagIsSignedInteger;
1192 physicalFormats.push_back( std::pair<Float32, UInt32>( 32, formatFlags ) );
1193 formatFlags = (description.mFormatFlags | kLinearPCMFormatFlagIsSignedInteger | kAudioFormatFlagIsPacked) & ~kLinearPCMFormatFlagIsFloat;
1194 physicalFormats.push_back( std::pair<Float32, UInt32>( 32, formatFlags ) );
1195 physicalFormats.push_back( std::pair<Float32, UInt32>( 24, formatFlags ) ); // 24-bit packed
1196 formatFlags &= ~( kAudioFormatFlagIsPacked | kAudioFormatFlagIsAlignedHigh );
1197 physicalFormats.push_back( std::pair<Float32, UInt32>( 24.2, formatFlags ) ); // 24-bit in 4 bytes, aligned low
1198 formatFlags |= kAudioFormatFlagIsAlignedHigh;
1199 physicalFormats.push_back( std::pair<Float32, UInt32>( 24.4, formatFlags ) ); // 24-bit in 4 bytes, aligned high
1200 formatFlags = (description.mFormatFlags | kLinearPCMFormatFlagIsSignedInteger | kAudioFormatFlagIsPacked) & ~kLinearPCMFormatFlagIsFloat;
1201 physicalFormats.push_back( std::pair<Float32, UInt32>( 16, formatFlags ) );
1202 physicalFormats.push_back( std::pair<Float32, UInt32>( 8, formatFlags ) );
1204 bool setPhysicalFormat = false;
1205 for( unsigned int i=0; i<physicalFormats.size(); i++ ) {
1206 testDescription = description;
1207 testDescription.mBitsPerChannel = (UInt32) physicalFormats[i].first;
1208 testDescription.mFormatFlags = physicalFormats[i].second;
1209 if ( (24 == (UInt32)physicalFormats[i].first) && ~( physicalFormats[i].second & kAudioFormatFlagIsPacked ) )
1210 testDescription.mBytesPerFrame = 4 * testDescription.mChannelsPerFrame;
1212 testDescription.mBytesPerFrame = testDescription.mBitsPerChannel/8 * testDescription.mChannelsPerFrame;
1213 testDescription.mBytesPerPacket = testDescription.mBytesPerFrame * testDescription.mFramesPerPacket;
1214 result = AudioObjectSetPropertyData( id, &property, 0, NULL, dataSize, &testDescription );
1215 if ( result == noErr ) {
1216 setPhysicalFormat = true;
1217 //std::cout << "Updated physical stream format:" << std::endl;
1218 //std::cout << " mBitsPerChan = " << testDescription.mBitsPerChannel << std::endl;
1219 //std::cout << " aligned high = " << (testDescription.mFormatFlags & kAudioFormatFlagIsAlignedHigh) << ", isPacked = " << (testDescription.mFormatFlags & kAudioFormatFlagIsPacked) << std::endl;
1220 //std::cout << " bytesPerFrame = " << testDescription.mBytesPerFrame << std::endl;
1221 //std::cout << " sample rate = " << testDescription.mSampleRate << std::endl;
1226 if ( !setPhysicalFormat ) {
1227 errorStream_ << "RtApiCore::probeDeviceOpen: system error (" << getErrorCode( result ) << ") setting physical data format for device (" << device << ").";
1228 errorText_ = errorStream_.str();
1231 } // done setting virtual/physical formats.
1233 // Get the stream / device latency.
1235 dataSize = sizeof( UInt32 );
1236 property.mSelector = kAudioDevicePropertyLatency;
1237 if ( AudioObjectHasProperty( id, &property ) == true ) {
1238 result = AudioObjectGetPropertyData( id, &property, 0, NULL, &dataSize, &latency );
1239 if ( result == kAudioHardwareNoError ) stream_.latency[ mode ] = latency;
1241 errorStream_ << "RtApiCore::probeDeviceOpen: system error (" << getErrorCode( result ) << ") getting device latency for device (" << device << ").";
1242 errorText_ = errorStream_.str();
1243 error( RtAudioError::WARNING );
1247 // Byte-swapping: According to AudioHardware.h, the stream data will
1248 // always be presented in native-endian format, so we should never
1249 // need to byte swap.
1250 stream_.doByteSwap[mode] = false;
1252 // From the CoreAudio documentation, PCM data must be supplied as
1254 stream_.userFormat = format;
1255 stream_.deviceFormat[mode] = RTAUDIO_FLOAT32;
1257 if ( streamCount == 1 )
1258 stream_.nDeviceChannels[mode] = description.mChannelsPerFrame;
1259 else // multiple streams
1260 stream_.nDeviceChannels[mode] = channels;
1261 stream_.nUserChannels[mode] = channels;
1262 stream_.channelOffset[mode] = channelOffset; // offset within a CoreAudio stream
1263 if ( options && options->flags & RTAUDIO_NONINTERLEAVED ) stream_.userInterleaved = false;
1264 else stream_.userInterleaved = true;
1265 stream_.deviceInterleaved[mode] = true;
1266 if ( monoMode == true ) stream_.deviceInterleaved[mode] = false;
1268 // Set flags for buffer conversion.
1269 stream_.doConvertBuffer[mode] = false;
1270 if ( stream_.userFormat != stream_.deviceFormat[mode] )
1271 stream_.doConvertBuffer[mode] = true;
1272 if ( stream_.nUserChannels[mode] < stream_.nDeviceChannels[mode] )
1273 stream_.doConvertBuffer[mode] = true;
1274 if ( streamCount == 1 ) {
1275 if ( stream_.nUserChannels[mode] > 1 &&
1276 stream_.userInterleaved != stream_.deviceInterleaved[mode] )
1277 stream_.doConvertBuffer[mode] = true;
1279 else if ( monoMode && stream_.userInterleaved )
1280 stream_.doConvertBuffer[mode] = true;
1282 // Allocate our CoreHandle structure for the stream.
1283 CoreHandle *handle = 0;
1284 if ( stream_.apiHandle == 0 ) {
1286 handle = new CoreHandle;
1288 catch ( std::bad_alloc& ) {
1289 errorText_ = "RtApiCore::probeDeviceOpen: error allocating CoreHandle memory.";
1293 if ( pthread_cond_init( &handle->condition, NULL ) ) {
1294 errorText_ = "RtApiCore::probeDeviceOpen: error initializing pthread condition variable.";
1297 stream_.apiHandle = (void *) handle;
1300 handle = (CoreHandle *) stream_.apiHandle;
1301 handle->iStream[mode] = firstStream;
1302 handle->nStreams[mode] = streamCount;
1303 handle->id[mode] = id;
1305 // Allocate necessary internal buffers.
1306 unsigned long bufferBytes;
1307 bufferBytes = stream_.nUserChannels[mode] * *bufferSize * formatBytes( stream_.userFormat );
1308 // stream_.userBuffer[mode] = (char *) calloc( bufferBytes, 1 );
1309 stream_.userBuffer[mode] = (char *) malloc( bufferBytes * sizeof(char) );
1310 memset( stream_.userBuffer[mode], 0, bufferBytes * sizeof(char) );
1311 if ( stream_.userBuffer[mode] == NULL ) {
1312 errorText_ = "RtApiCore::probeDeviceOpen: error allocating user buffer memory.";
1316 // If possible, we will make use of the CoreAudio stream buffers as
1317 // "device buffers". However, we can't do this if using multiple
1319 if ( stream_.doConvertBuffer[mode] && handle->nStreams[mode] > 1 ) {
1321 bool makeBuffer = true;
1322 bufferBytes = stream_.nDeviceChannels[mode] * formatBytes( stream_.deviceFormat[mode] );
1323 if ( mode == INPUT ) {
1324 if ( stream_.mode == OUTPUT && stream_.deviceBuffer ) {
1325 unsigned long bytesOut = stream_.nDeviceChannels[0] * formatBytes( stream_.deviceFormat[0] );
1326 if ( bufferBytes <= bytesOut ) makeBuffer = false;
1331 bufferBytes *= *bufferSize;
1332 if ( stream_.deviceBuffer ) free( stream_.deviceBuffer );
1333 stream_.deviceBuffer = (char *) calloc( bufferBytes, 1 );
1334 if ( stream_.deviceBuffer == NULL ) {
1335 errorText_ = "RtApiCore::probeDeviceOpen: error allocating device buffer memory.";
1341 stream_.sampleRate = sampleRate;
1342 stream_.device[mode] = device;
1343 stream_.state = STREAM_STOPPED;
1344 stream_.callbackInfo.object = (void *) this;
1346 // Setup the buffer conversion information structure.
1347 if ( stream_.doConvertBuffer[mode] ) {
1348 if ( streamCount > 1 ) setConvertInfo( mode, 0 );
1349 else setConvertInfo( mode, channelOffset );
1352 if ( mode == INPUT && stream_.mode == OUTPUT && stream_.device[0] == device )
1353 // Only one callback procedure per device.
1354 stream_.mode = DUPLEX;
1356 #if defined( MAC_OS_X_VERSION_10_5 ) && ( MAC_OS_X_VERSION_MIN_REQUIRED >= MAC_OS_X_VERSION_10_5 )
1357 result = AudioDeviceCreateIOProcID( id, callbackHandler, (void *) &stream_.callbackInfo, &handle->procId[mode] );
1359 // deprecated in favor of AudioDeviceCreateIOProcID()
1360 result = AudioDeviceAddIOProc( id, callbackHandler, (void *) &stream_.callbackInfo );
1362 if ( result != noErr ) {
1363 errorStream_ << "RtApiCore::probeDeviceOpen: system error setting callback for device (" << device << ").";
1364 errorText_ = errorStream_.str();
1367 if ( stream_.mode == OUTPUT && mode == INPUT )
1368 stream_.mode = DUPLEX;
1370 stream_.mode = mode;
1373 // Setup the device property listener for over/underload.
1374 property.mSelector = kAudioDeviceProcessorOverload;
1375 property.mScope = kAudioObjectPropertyScopeGlobal;
1376 result = AudioObjectAddPropertyListener( id, &property, xrunListener, (void *) handle );
1382 pthread_cond_destroy( &handle->condition );
1384 stream_.apiHandle = 0;
1387 for ( int i=0; i<2; i++ ) {
1388 if ( stream_.userBuffer[i] ) {
1389 free( stream_.userBuffer[i] );
1390 stream_.userBuffer[i] = 0;
1394 if ( stream_.deviceBuffer ) {
1395 free( stream_.deviceBuffer );
1396 stream_.deviceBuffer = 0;
1399 stream_.state = STREAM_CLOSED;
1403 void RtApiCore :: closeStream( void )
1405 if ( stream_.state == STREAM_CLOSED ) {
1406 errorText_ = "RtApiCore::closeStream(): no open stream to close!";
1407 error( RtAudioError::WARNING );
1411 CoreHandle *handle = (CoreHandle *) stream_.apiHandle;
1412 if ( stream_.mode == OUTPUT || stream_.mode == DUPLEX ) {
1414 AudioObjectPropertyAddress property = { kAudioHardwarePropertyDevices,
1415 kAudioObjectPropertyScopeGlobal,
1416 kAudioObjectPropertyElementMaster };
1418 property.mSelector = kAudioDeviceProcessorOverload;
1419 property.mScope = kAudioObjectPropertyScopeGlobal;
1420 if (AudioObjectRemovePropertyListener( handle->id[0], &property, xrunListener, (void *) handle ) != noErr) {
1421 errorText_ = "RtApiCore::closeStream(): error removing property listener!";
1422 error( RtAudioError::WARNING );
1425 if ( stream_.state == STREAM_RUNNING )
1426 AudioDeviceStop( handle->id[0], callbackHandler );
1427 #if defined( MAC_OS_X_VERSION_10_5 ) && ( MAC_OS_X_VERSION_MIN_REQUIRED >= MAC_OS_X_VERSION_10_5 )
1428 AudioDeviceDestroyIOProcID( handle->id[0], handle->procId[0] );
1430 // deprecated in favor of AudioDeviceDestroyIOProcID()
1431 AudioDeviceRemoveIOProc( handle->id[0], callbackHandler );
1435 if ( stream_.mode == INPUT || ( stream_.mode == DUPLEX && stream_.device[0] != stream_.device[1] ) ) {
1437 AudioObjectPropertyAddress property = { kAudioHardwarePropertyDevices,
1438 kAudioObjectPropertyScopeGlobal,
1439 kAudioObjectPropertyElementMaster };
1441 property.mSelector = kAudioDeviceProcessorOverload;
1442 property.mScope = kAudioObjectPropertyScopeGlobal;
1443 if (AudioObjectRemovePropertyListener( handle->id[1], &property, xrunListener, (void *) handle ) != noErr) {
1444 errorText_ = "RtApiCore::closeStream(): error removing property listener!";
1445 error( RtAudioError::WARNING );
1448 if ( stream_.state == STREAM_RUNNING )
1449 AudioDeviceStop( handle->id[1], callbackHandler );
1450 #if defined( MAC_OS_X_VERSION_10_5 ) && ( MAC_OS_X_VERSION_MIN_REQUIRED >= MAC_OS_X_VERSION_10_5 )
1451 AudioDeviceDestroyIOProcID( handle->id[1], handle->procId[1] );
1453 // deprecated in favor of AudioDeviceDestroyIOProcID()
1454 AudioDeviceRemoveIOProc( handle->id[1], callbackHandler );
1458 for ( int i=0; i<2; i++ ) {
1459 if ( stream_.userBuffer[i] ) {
1460 free( stream_.userBuffer[i] );
1461 stream_.userBuffer[i] = 0;
1465 if ( stream_.deviceBuffer ) {
1466 free( stream_.deviceBuffer );
1467 stream_.deviceBuffer = 0;
1470 // Destroy pthread condition variable.
1471 pthread_cond_destroy( &handle->condition );
1473 stream_.apiHandle = 0;
1475 stream_.mode = UNINITIALIZED;
1476 stream_.state = STREAM_CLOSED;
1479 void RtApiCore :: startStream( void )
1482 if ( stream_.state == STREAM_RUNNING ) {
1483 errorText_ = "RtApiCore::startStream(): the stream is already running!";
1484 error( RtAudioError::WARNING );
1488 OSStatus result = noErr;
1489 CoreHandle *handle = (CoreHandle *) stream_.apiHandle;
1490 if ( stream_.mode == OUTPUT || stream_.mode == DUPLEX ) {
1492 result = AudioDeviceStart( handle->id[0], callbackHandler );
1493 if ( result != noErr ) {
1494 errorStream_ << "RtApiCore::startStream: system error (" << getErrorCode( result ) << ") starting callback procedure on device (" << stream_.device[0] << ").";
1495 errorText_ = errorStream_.str();
1500 if ( stream_.mode == INPUT ||
1501 ( stream_.mode == DUPLEX && stream_.device[0] != stream_.device[1] ) ) {
1503 result = AudioDeviceStart( handle->id[1], callbackHandler );
1504 if ( result != noErr ) {
1505 errorStream_ << "RtApiCore::startStream: system error starting input callback procedure on device (" << stream_.device[1] << ").";
1506 errorText_ = errorStream_.str();
1511 handle->drainCounter = 0;
1512 handle->internalDrain = false;
1513 stream_.state = STREAM_RUNNING;
1516 if ( result == noErr ) return;
1517 error( RtAudioError::SYSTEM_ERROR );
1520 void RtApiCore :: stopStream( void )
1523 if ( stream_.state == STREAM_STOPPED ) {
1524 errorText_ = "RtApiCore::stopStream(): the stream is already stopped!";
1525 error( RtAudioError::WARNING );
1529 OSStatus result = noErr;
1530 CoreHandle *handle = (CoreHandle *) stream_.apiHandle;
1531 if ( stream_.mode == OUTPUT || stream_.mode == DUPLEX ) {
1533 if ( handle->drainCounter == 0 ) {
1534 handle->drainCounter = 2;
1535 pthread_cond_wait( &handle->condition, &stream_.mutex ); // block until signaled
1538 result = AudioDeviceStop( handle->id[0], callbackHandler );
1539 if ( result != noErr ) {
1540 errorStream_ << "RtApiCore::stopStream: system error (" << getErrorCode( result ) << ") stopping callback procedure on device (" << stream_.device[0] << ").";
1541 errorText_ = errorStream_.str();
1546 if ( stream_.mode == INPUT || ( stream_.mode == DUPLEX && stream_.device[0] != stream_.device[1] ) ) {
1548 result = AudioDeviceStop( handle->id[1], callbackHandler );
1549 if ( result != noErr ) {
1550 errorStream_ << "RtApiCore::stopStream: system error (" << getErrorCode( result ) << ") stopping input callback procedure on device (" << stream_.device[1] << ").";
1551 errorText_ = errorStream_.str();
1556 stream_.state = STREAM_STOPPED;
1559 if ( result == noErr ) return;
1560 error( RtAudioError::SYSTEM_ERROR );
1563 void RtApiCore :: abortStream( void )
1566 if ( stream_.state == STREAM_STOPPED ) {
1567 errorText_ = "RtApiCore::abortStream(): the stream is already stopped!";
1568 error( RtAudioError::WARNING );
1572 CoreHandle *handle = (CoreHandle *) stream_.apiHandle;
1573 handle->drainCounter = 2;
1578 // This function will be called by a spawned thread when the user
1579 // callback function signals that the stream should be stopped or
1580 // aborted. It is better to handle it this way because the
1581 // callbackEvent() function probably should return before the AudioDeviceStop()
1582 // function is called.
1583 static void *coreStopStream( void *ptr )
1585 CallbackInfo *info = (CallbackInfo *) ptr;
1586 RtApiCore *object = (RtApiCore *) info->object;
1588 object->stopStream();
1589 pthread_exit( NULL );
1592 bool RtApiCore :: callbackEvent( AudioDeviceID deviceId,
1593 const AudioBufferList *inBufferList,
1594 const AudioBufferList *outBufferList )
1596 if ( stream_.state == STREAM_STOPPED || stream_.state == STREAM_STOPPING ) return SUCCESS;
1597 if ( stream_.state == STREAM_CLOSED ) {
1598 errorText_ = "RtApiCore::callbackEvent(): the stream is closed ... this shouldn't happen!";
1599 error( RtAudioError::WARNING );
1603 CallbackInfo *info = (CallbackInfo *) &stream_.callbackInfo;
1604 CoreHandle *handle = (CoreHandle *) stream_.apiHandle;
1606 // Check if we were draining the stream and signal is finished.
1607 if ( handle->drainCounter > 3 ) {
1608 ThreadHandle threadId;
1610 stream_.state = STREAM_STOPPING;
1611 if ( handle->internalDrain == true )
1612 pthread_create( &threadId, NULL, coreStopStream, info );
1613 else // external call to stopStream()
1614 pthread_cond_signal( &handle->condition );
1618 AudioDeviceID outputDevice = handle->id[0];
1620 // Invoke user callback to get fresh output data UNLESS we are
1621 // draining stream or duplex mode AND the input/output devices are
1622 // different AND this function is called for the input device.
1623 if ( handle->drainCounter == 0 && ( stream_.mode != DUPLEX || deviceId == outputDevice ) ) {
1624 RtAudioCallback callback = (RtAudioCallback) info->callback;
1625 double streamTime = getStreamTime();
1626 RtAudioStreamStatus status = 0;
1627 if ( stream_.mode != INPUT && handle->xrun[0] == true ) {
1628 status |= RTAUDIO_OUTPUT_UNDERFLOW;
1629 handle->xrun[0] = false;
1631 if ( stream_.mode != OUTPUT && handle->xrun[1] == true ) {
1632 status |= RTAUDIO_INPUT_OVERFLOW;
1633 handle->xrun[1] = false;
1636 int cbReturnValue = callback( stream_.userBuffer[0], stream_.userBuffer[1],
1637 stream_.bufferSize, streamTime, status, info->userData );
1638 if ( cbReturnValue == 2 ) {
1639 stream_.state = STREAM_STOPPING;
1640 handle->drainCounter = 2;
1644 else if ( cbReturnValue == 1 ) {
1645 handle->drainCounter = 1;
1646 handle->internalDrain = true;
1650 if ( stream_.mode == OUTPUT || ( stream_.mode == DUPLEX && deviceId == outputDevice ) ) {
1652 if ( handle->drainCounter > 1 ) { // write zeros to the output stream
1654 if ( handle->nStreams[0] == 1 ) {
1655 memset( outBufferList->mBuffers[handle->iStream[0]].mData,
1657 outBufferList->mBuffers[handle->iStream[0]].mDataByteSize );
1659 else { // fill multiple streams with zeros
1660 for ( unsigned int i=0; i<handle->nStreams[0]; i++ ) {
1661 memset( outBufferList->mBuffers[handle->iStream[0]+i].mData,
1663 outBufferList->mBuffers[handle->iStream[0]+i].mDataByteSize );
1667 else if ( handle->nStreams[0] == 1 ) {
1668 if ( stream_.doConvertBuffer[0] ) { // convert directly to CoreAudio stream buffer
1669 convertBuffer( (char *) outBufferList->mBuffers[handle->iStream[0]].mData,
1670 stream_.userBuffer[0], stream_.convertInfo[0] );
1672 else { // copy from user buffer
1673 memcpy( outBufferList->mBuffers[handle->iStream[0]].mData,
1674 stream_.userBuffer[0],
1675 outBufferList->mBuffers[handle->iStream[0]].mDataByteSize );
1678 else { // fill multiple streams
1679 Float32 *inBuffer = (Float32 *) stream_.userBuffer[0];
1680 if ( stream_.doConvertBuffer[0] ) {
1681 convertBuffer( stream_.deviceBuffer, stream_.userBuffer[0], stream_.convertInfo[0] );
1682 inBuffer = (Float32 *) stream_.deviceBuffer;
1685 if ( stream_.deviceInterleaved[0] == false ) { // mono mode
1686 UInt32 bufferBytes = outBufferList->mBuffers[handle->iStream[0]].mDataByteSize;
1687 for ( unsigned int i=0; i<stream_.nUserChannels[0]; i++ ) {
1688 memcpy( outBufferList->mBuffers[handle->iStream[0]+i].mData,
1689 (void *)&inBuffer[i*stream_.bufferSize], bufferBytes );
1692 else { // fill multiple multi-channel streams with interleaved data
1693 UInt32 streamChannels, channelsLeft, inJump, outJump, inOffset;
1696 bool inInterleaved = ( stream_.userInterleaved ) ? true : false;
1697 UInt32 inChannels = stream_.nUserChannels[0];
1698 if ( stream_.doConvertBuffer[0] ) {
1699 inInterleaved = true; // device buffer will always be interleaved for nStreams > 1 and not mono mode
1700 inChannels = stream_.nDeviceChannels[0];
1703 if ( inInterleaved ) inOffset = 1;
1704 else inOffset = stream_.bufferSize;
1706 channelsLeft = inChannels;
1707 for ( unsigned int i=0; i<handle->nStreams[0]; i++ ) {
1709 out = (Float32 *) outBufferList->mBuffers[handle->iStream[0]+i].mData;
1710 streamChannels = outBufferList->mBuffers[handle->iStream[0]+i].mNumberChannels;
1713 // Account for possible channel offset in first stream
1714 if ( i == 0 && stream_.channelOffset[0] > 0 ) {
1715 streamChannels -= stream_.channelOffset[0];
1716 outJump = stream_.channelOffset[0];
1720 // Account for possible unfilled channels at end of the last stream
1721 if ( streamChannels > channelsLeft ) {
1722 outJump = streamChannels - channelsLeft;
1723 streamChannels = channelsLeft;
1726 // Determine input buffer offsets and skips
1727 if ( inInterleaved ) {
1728 inJump = inChannels;
1729 in += inChannels - channelsLeft;
1733 in += (inChannels - channelsLeft) * inOffset;
1736 for ( unsigned int i=0; i<stream_.bufferSize; i++ ) {
1737 for ( unsigned int j=0; j<streamChannels; j++ ) {
1738 *out++ = in[j*inOffset];
1743 channelsLeft -= streamChannels;
1749 // Don't bother draining input
1750 if ( handle->drainCounter ) {
1751 handle->drainCounter++;
1755 AudioDeviceID inputDevice;
1756 inputDevice = handle->id[1];
1757 if ( stream_.mode == INPUT || ( stream_.mode == DUPLEX && deviceId == inputDevice ) ) {
1759 if ( handle->nStreams[1] == 1 ) {
1760 if ( stream_.doConvertBuffer[1] ) { // convert directly from CoreAudio stream buffer
1761 convertBuffer( stream_.userBuffer[1],
1762 (char *) inBufferList->mBuffers[handle->iStream[1]].mData,
1763 stream_.convertInfo[1] );
1765 else { // copy to user buffer
1766 memcpy( stream_.userBuffer[1],
1767 inBufferList->mBuffers[handle->iStream[1]].mData,
1768 inBufferList->mBuffers[handle->iStream[1]].mDataByteSize );
1771 else { // read from multiple streams
1772 Float32 *outBuffer = (Float32 *) stream_.userBuffer[1];
1773 if ( stream_.doConvertBuffer[1] ) outBuffer = (Float32 *) stream_.deviceBuffer;
1775 if ( stream_.deviceInterleaved[1] == false ) { // mono mode
1776 UInt32 bufferBytes = inBufferList->mBuffers[handle->iStream[1]].mDataByteSize;
1777 for ( unsigned int i=0; i<stream_.nUserChannels[1]; i++ ) {
1778 memcpy( (void *)&outBuffer[i*stream_.bufferSize],
1779 inBufferList->mBuffers[handle->iStream[1]+i].mData, bufferBytes );
1782 else { // read from multiple multi-channel streams
1783 UInt32 streamChannels, channelsLeft, inJump, outJump, outOffset;
1786 bool outInterleaved = ( stream_.userInterleaved ) ? true : false;
1787 UInt32 outChannels = stream_.nUserChannels[1];
1788 if ( stream_.doConvertBuffer[1] ) {
1789 outInterleaved = true; // device buffer will always be interleaved for nStreams > 1 and not mono mode
1790 outChannels = stream_.nDeviceChannels[1];
1793 if ( outInterleaved ) outOffset = 1;
1794 else outOffset = stream_.bufferSize;
1796 channelsLeft = outChannels;
1797 for ( unsigned int i=0; i<handle->nStreams[1]; i++ ) {
1799 in = (Float32 *) inBufferList->mBuffers[handle->iStream[1]+i].mData;
1800 streamChannels = inBufferList->mBuffers[handle->iStream[1]+i].mNumberChannels;
1803 // Account for possible channel offset in first stream
1804 if ( i == 0 && stream_.channelOffset[1] > 0 ) {
1805 streamChannels -= stream_.channelOffset[1];
1806 inJump = stream_.channelOffset[1];
1810 // Account for possible unread channels at end of the last stream
1811 if ( streamChannels > channelsLeft ) {
1812 inJump = streamChannels - channelsLeft;
1813 streamChannels = channelsLeft;
1816 // Determine output buffer offsets and skips
1817 if ( outInterleaved ) {
1818 outJump = outChannels;
1819 out += outChannels - channelsLeft;
1823 out += (outChannels - channelsLeft) * outOffset;
1826 for ( unsigned int i=0; i<stream_.bufferSize; i++ ) {
1827 for ( unsigned int j=0; j<streamChannels; j++ ) {
1828 out[j*outOffset] = *in++;
1833 channelsLeft -= streamChannels;
1837 if ( stream_.doConvertBuffer[1] ) { // convert from our internal "device" buffer
1838 convertBuffer( stream_.userBuffer[1],
1839 stream_.deviceBuffer,
1840 stream_.convertInfo[1] );
1846 //MUTEX_UNLOCK( &stream_.mutex );
1848 RtApi::tickStreamTime();
1852 const char* RtApiCore :: getErrorCode( OSStatus code )
1856 case kAudioHardwareNotRunningError:
1857 return "kAudioHardwareNotRunningError";
1859 case kAudioHardwareUnspecifiedError:
1860 return "kAudioHardwareUnspecifiedError";
1862 case kAudioHardwareUnknownPropertyError:
1863 return "kAudioHardwareUnknownPropertyError";
1865 case kAudioHardwareBadPropertySizeError:
1866 return "kAudioHardwareBadPropertySizeError";
1868 case kAudioHardwareIllegalOperationError:
1869 return "kAudioHardwareIllegalOperationError";
1871 case kAudioHardwareBadObjectError:
1872 return "kAudioHardwareBadObjectError";
1874 case kAudioHardwareBadDeviceError:
1875 return "kAudioHardwareBadDeviceError";
1877 case kAudioHardwareBadStreamError:
1878 return "kAudioHardwareBadStreamError";
1880 case kAudioHardwareUnsupportedOperationError:
1881 return "kAudioHardwareUnsupportedOperationError";
1883 case kAudioDeviceUnsupportedFormatError:
1884 return "kAudioDeviceUnsupportedFormatError";
1886 case kAudioDevicePermissionsError:
1887 return "kAudioDevicePermissionsError";
1890 return "CoreAudio unknown error";
1894 //******************** End of __MACOSX_CORE__ *********************//
1897 #if defined(__UNIX_JACK__)
1899 // JACK is a low-latency audio server, originally written for the
1900 // GNU/Linux operating system and now also ported to OS-X. It can
1901 // connect a number of different applications to an audio device, as
1902 // well as allowing them to share audio between themselves.
1904 // When using JACK with RtAudio, "devices" refer to JACK clients that
1905 // have ports connected to the server. The JACK server is typically
1906 // started in a terminal as follows:
1908 // .jackd -d alsa -d hw:0
1910 // or through an interface program such as qjackctl. Many of the
1911 // parameters normally set for a stream are fixed by the JACK server
1912 // and can be specified when the JACK server is started. In
1915 // .jackd -d alsa -d hw:0 -r 44100 -p 512 -n 4
1917 // specifies a sample rate of 44100 Hz, a buffer size of 512 sample
1918 // frames, and number of buffers = 4. Once the server is running, it
1919 // is not possible to override these values. If the values are not
1920 // specified in the command-line, the JACK server uses default values.
1922 // The JACK server does not have to be running when an instance of
1923 // RtApiJack is created, though the function getDeviceCount() will
1924 // report 0 devices found until JACK has been started. When no
1925 // devices are available (i.e., the JACK server is not running), a
1926 // stream cannot be opened.
1928 #include <jack/jack.h>
1932 // A structure to hold various information related to the Jack API
1935 jack_client_t *client;
1936 jack_port_t **ports[2];
1937 std::string deviceName[2];
1939 pthread_cond_t condition;
1940 int drainCounter; // Tracks callback counts when draining
1941 bool internalDrain; // Indicates if stop is initiated from callback or not.
1944 :client(0), drainCounter(0), internalDrain(false) { ports[0] = 0; ports[1] = 0; xrun[0] = false; xrun[1] = false; }
1947 #if !defined(__RTAUDIO_DEBUG__)
1948 static void jackSilentError( const char * ) {};
1951 RtApiJack :: RtApiJack()
1952 :shouldAutoconnect_(true) {
1953 // Nothing to do here.
1954 #if !defined(__RTAUDIO_DEBUG__)
1955 // Turn off Jack's internal error reporting.
1956 jack_set_error_function( &jackSilentError );
1960 RtApiJack :: ~RtApiJack()
1962 if ( stream_.state != STREAM_CLOSED ) closeStream();
1965 unsigned int RtApiJack :: getDeviceCount( void )
1967 // See if we can become a jack client.
1968 jack_options_t options = (jack_options_t) ( JackNoStartServer ); //JackNullOption;
1969 jack_status_t *status = NULL;
1970 jack_client_t *client = jack_client_open( "RtApiJackCount", options, status );
1971 if ( client == 0 ) return 0;
1974 std::string port, previousPort;
1975 unsigned int nChannels = 0, nDevices = 0;
1976 ports = jack_get_ports( client, NULL, NULL, 0 );
1978 // Parse the port names up to the first colon (:).
1981 port = (char *) ports[ nChannels ];
1982 iColon = port.find(":");
1983 if ( iColon != std::string::npos ) {
1984 port = port.substr( 0, iColon + 1 );
1985 if ( port != previousPort ) {
1987 previousPort = port;
1990 } while ( ports[++nChannels] );
1994 jack_client_close( client );
1998 RtAudio::DeviceInfo RtApiJack :: getDeviceInfo( unsigned int device )
2000 RtAudio::DeviceInfo info;
2001 info.probed = false;
2003 jack_options_t options = (jack_options_t) ( JackNoStartServer ); //JackNullOption
2004 jack_status_t *status = NULL;
2005 jack_client_t *client = jack_client_open( "RtApiJackInfo", options, status );
2006 if ( client == 0 ) {
2007 errorText_ = "RtApiJack::getDeviceInfo: Jack server not found or connection error!";
2008 error( RtAudioError::WARNING );
2013 std::string port, previousPort;
2014 unsigned int nPorts = 0, nDevices = 0;
2015 ports = jack_get_ports( client, NULL, NULL, 0 );
2017 // Parse the port names up to the first colon (:).
2020 port = (char *) ports[ nPorts ];
2021 iColon = port.find(":");
2022 if ( iColon != std::string::npos ) {
2023 port = port.substr( 0, iColon );
2024 if ( port != previousPort ) {
2025 if ( nDevices == device ) info.name = port;
2027 previousPort = port;
2030 } while ( ports[++nPorts] );
2034 if ( device >= nDevices ) {
2035 jack_client_close( client );
2036 errorText_ = "RtApiJack::getDeviceInfo: device ID is invalid!";
2037 error( RtAudioError::INVALID_USE );
2041 // Get the current jack server sample rate.
2042 info.sampleRates.clear();
2044 info.preferredSampleRate = jack_get_sample_rate( client );
2045 info.sampleRates.push_back( info.preferredSampleRate );
2047 // Count the available ports containing the client name as device
2048 // channels. Jack "input ports" equal RtAudio output channels.
2049 unsigned int nChannels = 0;
2050 ports = jack_get_ports( client, info.name.c_str(), NULL, JackPortIsInput );
2052 while ( ports[ nChannels ] ) nChannels++;
2054 info.outputChannels = nChannels;
2057 // Jack "output ports" equal RtAudio input channels.
2059 ports = jack_get_ports( client, info.name.c_str(), NULL, JackPortIsOutput );
2061 while ( ports[ nChannels ] ) nChannels++;
2063 info.inputChannels = nChannels;
2066 if ( info.outputChannels == 0 && info.inputChannels == 0 ) {
2067 jack_client_close(client);
2068 errorText_ = "RtApiJack::getDeviceInfo: error determining Jack input/output channels!";
2069 error( RtAudioError::WARNING );
2073 // If device opens for both playback and capture, we determine the channels.
2074 if ( info.outputChannels > 0 && info.inputChannels > 0 )
2075 info.duplexChannels = (info.outputChannels > info.inputChannels) ? info.inputChannels : info.outputChannels;
2077 // Jack always uses 32-bit floats.
2078 info.nativeFormats = RTAUDIO_FLOAT32;
2080 // Jack doesn't provide default devices so we'll use the first available one.
2081 if ( device == 0 && info.outputChannels > 0 )
2082 info.isDefaultOutput = true;
2083 if ( device == 0 && info.inputChannels > 0 )
2084 info.isDefaultInput = true;
2086 jack_client_close(client);
2091 static int jackCallbackHandler( jack_nframes_t nframes, void *infoPointer )
2093 CallbackInfo *info = (CallbackInfo *) infoPointer;
2095 RtApiJack *object = (RtApiJack *) info->object;
2096 if ( object->callbackEvent( (unsigned long) nframes ) == false ) return 1;
2101 // This function will be called by a spawned thread when the Jack
2102 // server signals that it is shutting down. It is necessary to handle
2103 // it this way because the jackShutdown() function must return before
2104 // the jack_deactivate() function (in closeStream()) will return.
2105 static void *jackCloseStream( void *ptr )
2107 CallbackInfo *info = (CallbackInfo *) ptr;
2108 RtApiJack *object = (RtApiJack *) info->object;
2110 object->closeStream();
2112 pthread_exit( NULL );
2114 static void jackShutdown( void *infoPointer )
2116 CallbackInfo *info = (CallbackInfo *) infoPointer;
2117 RtApiJack *object = (RtApiJack *) info->object;
2119 // Check current stream state. If stopped, then we'll assume this
2120 // was called as a result of a call to RtApiJack::stopStream (the
2121 // deactivation of a client handle causes this function to be called).
2122 // If not, we'll assume the Jack server is shutting down or some
2123 // other problem occurred and we should close the stream.
2124 if ( object->isStreamRunning() == false ) return;
2126 ThreadHandle threadId;
2127 pthread_create( &threadId, NULL, jackCloseStream, info );
2128 std::cerr << "\nRtApiJack: the Jack server is shutting down this client ... stream stopped and closed!!\n" << std::endl;
2131 static int jackXrun( void *infoPointer )
2133 JackHandle *handle = *((JackHandle **) infoPointer);
2135 if ( handle->ports[0] ) handle->xrun[0] = true;
2136 if ( handle->ports[1] ) handle->xrun[1] = true;
2141 bool RtApiJack :: probeDeviceOpen( unsigned int device, StreamMode mode, unsigned int channels,
2142 unsigned int firstChannel, unsigned int sampleRate,
2143 RtAudioFormat format, unsigned int *bufferSize,
2144 RtAudio::StreamOptions *options )
2146 JackHandle *handle = (JackHandle *) stream_.apiHandle;
2148 // Look for jack server and try to become a client (only do once per stream).
2149 jack_client_t *client = 0;
2150 if ( mode == OUTPUT || ( mode == INPUT && stream_.mode != OUTPUT ) ) {
2151 jack_options_t jackoptions = (jack_options_t) ( JackNoStartServer ); //JackNullOption;
2152 jack_status_t *status = NULL;
2153 if ( options && !options->streamName.empty() )
2154 client = jack_client_open( options->streamName.c_str(), jackoptions, status );
2156 client = jack_client_open( "RtApiJack", jackoptions, status );
2157 if ( client == 0 ) {
2158 errorText_ = "RtApiJack::probeDeviceOpen: Jack server not found or connection error!";
2159 error( RtAudioError::WARNING );
2164 // The handle must have been created on an earlier pass.
2165 client = handle->client;
2169 std::string port, previousPort, deviceName;
2170 unsigned int nPorts = 0, nDevices = 0;
2171 ports = jack_get_ports( client, NULL, NULL, 0 );
2173 // Parse the port names up to the first colon (:).
2176 port = (char *) ports[ nPorts ];
2177 iColon = port.find(":");
2178 if ( iColon != std::string::npos ) {
2179 port = port.substr( 0, iColon );
2180 if ( port != previousPort ) {
2181 if ( nDevices == device ) deviceName = port;
2183 previousPort = port;
2186 } while ( ports[++nPorts] );
2190 if ( device >= nDevices ) {
2191 errorText_ = "RtApiJack::probeDeviceOpen: device ID is invalid!";
2195 // Count the available ports containing the client name as device
2196 // channels. Jack "input ports" equal RtAudio output channels.
2197 unsigned int nChannels = 0;
2198 unsigned long flag = JackPortIsInput;
2199 if ( mode == INPUT ) flag = JackPortIsOutput;
2200 ports = jack_get_ports( client, deviceName.c_str(), NULL, flag );
2202 while ( ports[ nChannels ] ) nChannels++;
2206 // Compare the jack ports for specified client to the requested number of channels.
2207 if ( nChannels < (channels + firstChannel) ) {
2208 errorStream_ << "RtApiJack::probeDeviceOpen: requested number of channels (" << channels << ") + offset (" << firstChannel << ") not found for specified device (" << device << ":" << deviceName << ").";
2209 errorText_ = errorStream_.str();
2213 // Check the jack server sample rate.
2214 unsigned int jackRate = jack_get_sample_rate( client );
2215 if ( sampleRate != jackRate ) {
2216 jack_client_close( client );
2217 errorStream_ << "RtApiJack::probeDeviceOpen: the requested sample rate (" << sampleRate << ") is different than the JACK server rate (" << jackRate << ").";
2218 errorText_ = errorStream_.str();
2221 stream_.sampleRate = jackRate;
2223 // Get the latency of the JACK port.
2224 ports = jack_get_ports( client, deviceName.c_str(), NULL, flag );
2225 if ( ports[ firstChannel ] ) {
2227 jack_latency_callback_mode_t cbmode = (mode == INPUT ? JackCaptureLatency : JackPlaybackLatency);
2228 // the range (usually the min and max are equal)
2229 jack_latency_range_t latrange; latrange.min = latrange.max = 0;
2230 // get the latency range
2231 jack_port_get_latency_range( jack_port_by_name( client, ports[firstChannel] ), cbmode, &latrange );
2232 // be optimistic, use the min!
2233 stream_.latency[mode] = latrange.min;
2234 //stream_.latency[mode] = jack_port_get_latency( jack_port_by_name( client, ports[ firstChannel ] ) );
2238 // The jack server always uses 32-bit floating-point data.
2239 stream_.deviceFormat[mode] = RTAUDIO_FLOAT32;
2240 stream_.userFormat = format;
2242 if ( options && options->flags & RTAUDIO_NONINTERLEAVED ) stream_.userInterleaved = false;
2243 else stream_.userInterleaved = true;
2245 // Jack always uses non-interleaved buffers.
2246 stream_.deviceInterleaved[mode] = false;
2248 // Jack always provides host byte-ordered data.
2249 stream_.doByteSwap[mode] = false;
2251 // Get the buffer size. The buffer size and number of buffers
2252 // (periods) is set when the jack server is started.
2253 stream_.bufferSize = (int) jack_get_buffer_size( client );
2254 *bufferSize = stream_.bufferSize;
2256 stream_.nDeviceChannels[mode] = channels;
2257 stream_.nUserChannels[mode] = channels;
2259 // Set flags for buffer conversion.
2260 stream_.doConvertBuffer[mode] = false;
2261 if ( stream_.userFormat != stream_.deviceFormat[mode] )
2262 stream_.doConvertBuffer[mode] = true;
2263 if ( stream_.userInterleaved != stream_.deviceInterleaved[mode] &&
2264 stream_.nUserChannels[mode] > 1 )
2265 stream_.doConvertBuffer[mode] = true;
2267 // Allocate our JackHandle structure for the stream.
2268 if ( handle == 0 ) {
2270 handle = new JackHandle;
2272 catch ( std::bad_alloc& ) {
2273 errorText_ = "RtApiJack::probeDeviceOpen: error allocating JackHandle memory.";
2277 if ( pthread_cond_init(&handle->condition, NULL) ) {
2278 errorText_ = "RtApiJack::probeDeviceOpen: error initializing pthread condition variable.";
2281 stream_.apiHandle = (void *) handle;
2282 handle->client = client;
2284 handle->deviceName[mode] = deviceName;
2286 // Allocate necessary internal buffers.
2287 unsigned long bufferBytes;
2288 bufferBytes = stream_.nUserChannels[mode] * *bufferSize * formatBytes( stream_.userFormat );
2289 stream_.userBuffer[mode] = (char *) calloc( bufferBytes, 1 );
2290 if ( stream_.userBuffer[mode] == NULL ) {
2291 errorText_ = "RtApiJack::probeDeviceOpen: error allocating user buffer memory.";
2295 if ( stream_.doConvertBuffer[mode] ) {
2297 bool makeBuffer = true;
2298 if ( mode == OUTPUT )
2299 bufferBytes = stream_.nDeviceChannels[0] * formatBytes( stream_.deviceFormat[0] );
2300 else { // mode == INPUT
2301 bufferBytes = stream_.nDeviceChannels[1] * formatBytes( stream_.deviceFormat[1] );
2302 if ( stream_.mode == OUTPUT && stream_.deviceBuffer ) {
2303 unsigned long bytesOut = stream_.nDeviceChannels[0] * formatBytes(stream_.deviceFormat[0]);
2304 if ( bufferBytes < bytesOut ) makeBuffer = false;
2309 bufferBytes *= *bufferSize;
2310 if ( stream_.deviceBuffer ) free( stream_.deviceBuffer );
2311 stream_.deviceBuffer = (char *) calloc( bufferBytes, 1 );
2312 if ( stream_.deviceBuffer == NULL ) {
2313 errorText_ = "RtApiJack::probeDeviceOpen: error allocating device buffer memory.";
2319 // Allocate memory for the Jack ports (channels) identifiers.
2320 handle->ports[mode] = (jack_port_t **) malloc ( sizeof (jack_port_t *) * channels );
2321 if ( handle->ports[mode] == NULL ) {
2322 errorText_ = "RtApiJack::probeDeviceOpen: error allocating port memory.";
2326 stream_.device[mode] = device;
2327 stream_.channelOffset[mode] = firstChannel;
2328 stream_.state = STREAM_STOPPED;
2329 stream_.callbackInfo.object = (void *) this;
2331 if ( stream_.mode == OUTPUT && mode == INPUT )
2332 // We had already set up the stream for output.
2333 stream_.mode = DUPLEX;
2335 stream_.mode = mode;
2336 jack_set_process_callback( handle->client, jackCallbackHandler, (void *) &stream_.callbackInfo );
2337 jack_set_xrun_callback( handle->client, jackXrun, (void *) &stream_.apiHandle );
2338 jack_on_shutdown( handle->client, jackShutdown, (void *) &stream_.callbackInfo );
2341 // Register our ports.
2343 if ( mode == OUTPUT ) {
2344 for ( unsigned int i=0; i<stream_.nUserChannels[0]; i++ ) {
2345 snprintf( label, 64, "outport %d", i );
2346 handle->ports[0][i] = jack_port_register( handle->client, (const char *)label,
2347 JACK_DEFAULT_AUDIO_TYPE, JackPortIsOutput, 0 );
2351 for ( unsigned int i=0; i<stream_.nUserChannels[1]; i++ ) {
2352 snprintf( label, 64, "inport %d", i );
2353 handle->ports[1][i] = jack_port_register( handle->client, (const char *)label,
2354 JACK_DEFAULT_AUDIO_TYPE, JackPortIsInput, 0 );
2358 // Setup the buffer conversion information structure. We don't use
2359 // buffers to do channel offsets, so we override that parameter
2361 if ( stream_.doConvertBuffer[mode] ) setConvertInfo( mode, 0 );
2363 if ( options && options->flags & RTAUDIO_JACK_DONT_CONNECT ) shouldAutoconnect_ = false;
2369 pthread_cond_destroy( &handle->condition );
2370 jack_client_close( handle->client );
2372 if ( handle->ports[0] ) free( handle->ports[0] );
2373 if ( handle->ports[1] ) free( handle->ports[1] );
2376 stream_.apiHandle = 0;
2379 for ( int i=0; i<2; i++ ) {
2380 if ( stream_.userBuffer[i] ) {
2381 free( stream_.userBuffer[i] );
2382 stream_.userBuffer[i] = 0;
2386 if ( stream_.deviceBuffer ) {
2387 free( stream_.deviceBuffer );
2388 stream_.deviceBuffer = 0;
2394 void RtApiJack :: closeStream( void )
2396 if ( stream_.state == STREAM_CLOSED ) {
2397 errorText_ = "RtApiJack::closeStream(): no open stream to close!";
2398 error( RtAudioError::WARNING );
2402 JackHandle *handle = (JackHandle *) stream_.apiHandle;
2405 if ( stream_.state == STREAM_RUNNING )
2406 jack_deactivate( handle->client );
2408 jack_client_close( handle->client );
2412 if ( handle->ports[0] ) free( handle->ports[0] );
2413 if ( handle->ports[1] ) free( handle->ports[1] );
2414 pthread_cond_destroy( &handle->condition );
2416 stream_.apiHandle = 0;
2419 for ( int i=0; i<2; i++ ) {
2420 if ( stream_.userBuffer[i] ) {
2421 free( stream_.userBuffer[i] );
2422 stream_.userBuffer[i] = 0;
2426 if ( stream_.deviceBuffer ) {
2427 free( stream_.deviceBuffer );
2428 stream_.deviceBuffer = 0;
2431 stream_.mode = UNINITIALIZED;
2432 stream_.state = STREAM_CLOSED;
2435 void RtApiJack :: startStream( void )
2438 if ( stream_.state == STREAM_RUNNING ) {
2439 errorText_ = "RtApiJack::startStream(): the stream is already running!";
2440 error( RtAudioError::WARNING );
2444 JackHandle *handle = (JackHandle *) stream_.apiHandle;
2445 int result = jack_activate( handle->client );
2447 errorText_ = "RtApiJack::startStream(): unable to activate JACK client!";
2453 // Get the list of available ports.
2454 if ( shouldAutoconnect_ && (stream_.mode == OUTPUT || stream_.mode == DUPLEX) ) {
2456 ports = jack_get_ports( handle->client, handle->deviceName[0].c_str(), NULL, JackPortIsInput);
2457 if ( ports == NULL) {
2458 errorText_ = "RtApiJack::startStream(): error determining available JACK input ports!";
2462 // Now make the port connections. Since RtAudio wasn't designed to
2463 // allow the user to select particular channels of a device, we'll
2464 // just open the first "nChannels" ports with offset.
2465 for ( unsigned int i=0; i<stream_.nUserChannels[0]; i++ ) {
2467 if ( ports[ stream_.channelOffset[0] + i ] )
2468 result = jack_connect( handle->client, jack_port_name( handle->ports[0][i] ), ports[ stream_.channelOffset[0] + i ] );
2471 errorText_ = "RtApiJack::startStream(): error connecting output ports!";
2478 if ( shouldAutoconnect_ && (stream_.mode == INPUT || stream_.mode == DUPLEX) ) {
2480 ports = jack_get_ports( handle->client, handle->deviceName[1].c_str(), NULL, JackPortIsOutput );
2481 if ( ports == NULL) {
2482 errorText_ = "RtApiJack::startStream(): error determining available JACK output ports!";
2486 // Now make the port connections. See note above.
2487 for ( unsigned int i=0; i<stream_.nUserChannels[1]; i++ ) {
2489 if ( ports[ stream_.channelOffset[1] + i ] )
2490 result = jack_connect( handle->client, ports[ stream_.channelOffset[1] + i ], jack_port_name( handle->ports[1][i] ) );
2493 errorText_ = "RtApiJack::startStream(): error connecting input ports!";
2500 handle->drainCounter = 0;
2501 handle->internalDrain = false;
2502 stream_.state = STREAM_RUNNING;
2505 if ( result == 0 ) return;
2506 error( RtAudioError::SYSTEM_ERROR );
2509 void RtApiJack :: stopStream( void )
2512 if ( stream_.state == STREAM_STOPPED ) {
2513 errorText_ = "RtApiJack::stopStream(): the stream is already stopped!";
2514 error( RtAudioError::WARNING );
2518 JackHandle *handle = (JackHandle *) stream_.apiHandle;
2519 if ( stream_.mode == OUTPUT || stream_.mode == DUPLEX ) {
2521 if ( handle->drainCounter == 0 ) {
2522 handle->drainCounter = 2;
2523 pthread_cond_wait( &handle->condition, &stream_.mutex ); // block until signaled
2527 jack_deactivate( handle->client );
2528 stream_.state = STREAM_STOPPED;
2531 void RtApiJack :: abortStream( void )
2534 if ( stream_.state == STREAM_STOPPED ) {
2535 errorText_ = "RtApiJack::abortStream(): the stream is already stopped!";
2536 error( RtAudioError::WARNING );
2540 JackHandle *handle = (JackHandle *) stream_.apiHandle;
2541 handle->drainCounter = 2;
2546 // This function will be called by a spawned thread when the user
2547 // callback function signals that the stream should be stopped or
2548 // aborted. It is necessary to handle it this way because the
2549 // callbackEvent() function must return before the jack_deactivate()
2550 // function will return.
2551 static void *jackStopStream( void *ptr )
2553 CallbackInfo *info = (CallbackInfo *) ptr;
2554 RtApiJack *object = (RtApiJack *) info->object;
2556 object->stopStream();
2557 pthread_exit( NULL );
2560 bool RtApiJack :: callbackEvent( unsigned long nframes )
2562 if ( stream_.state == STREAM_STOPPED || stream_.state == STREAM_STOPPING ) return SUCCESS;
2563 if ( stream_.state == STREAM_CLOSED ) {
2564 errorText_ = "RtApiCore::callbackEvent(): the stream is closed ... this shouldn't happen!";
2565 error( RtAudioError::WARNING );
2568 if ( stream_.bufferSize != nframes ) {
2569 errorText_ = "RtApiCore::callbackEvent(): the JACK buffer size has changed ... cannot process!";
2570 error( RtAudioError::WARNING );
2574 CallbackInfo *info = (CallbackInfo *) &stream_.callbackInfo;
2575 JackHandle *handle = (JackHandle *) stream_.apiHandle;
2577 // Check if we were draining the stream and signal is finished.
2578 if ( handle->drainCounter > 3 ) {
2579 ThreadHandle threadId;
2581 stream_.state = STREAM_STOPPING;
2582 if ( handle->internalDrain == true )
2583 pthread_create( &threadId, NULL, jackStopStream, info );
2585 pthread_cond_signal( &handle->condition );
2589 // Invoke user callback first, to get fresh output data.
2590 if ( handle->drainCounter == 0 ) {
2591 RtAudioCallback callback = (RtAudioCallback) info->callback;
2592 double streamTime = getStreamTime();
2593 RtAudioStreamStatus status = 0;
2594 if ( stream_.mode != INPUT && handle->xrun[0] == true ) {
2595 status |= RTAUDIO_OUTPUT_UNDERFLOW;
2596 handle->xrun[0] = false;
2598 if ( stream_.mode != OUTPUT && handle->xrun[1] == true ) {
2599 status |= RTAUDIO_INPUT_OVERFLOW;
2600 handle->xrun[1] = false;
2602 int cbReturnValue = callback( stream_.userBuffer[0], stream_.userBuffer[1],
2603 stream_.bufferSize, streamTime, status, info->userData );
2604 if ( cbReturnValue == 2 ) {
2605 stream_.state = STREAM_STOPPING;
2606 handle->drainCounter = 2;
2608 pthread_create( &id, NULL, jackStopStream, info );
2611 else if ( cbReturnValue == 1 ) {
2612 handle->drainCounter = 1;
2613 handle->internalDrain = true;
2617 jack_default_audio_sample_t *jackbuffer;
2618 unsigned long bufferBytes = nframes * sizeof( jack_default_audio_sample_t );
2619 if ( stream_.mode == OUTPUT || stream_.mode == DUPLEX ) {
2621 if ( handle->drainCounter > 1 ) { // write zeros to the output stream
2623 for ( unsigned int i=0; i<stream_.nDeviceChannels[0]; i++ ) {
2624 jackbuffer = (jack_default_audio_sample_t *) jack_port_get_buffer( handle->ports[0][i], (jack_nframes_t) nframes );
2625 memset( jackbuffer, 0, bufferBytes );
2629 else if ( stream_.doConvertBuffer[0] ) {
2631 convertBuffer( stream_.deviceBuffer, stream_.userBuffer[0], stream_.convertInfo[0] );
2633 for ( unsigned int i=0; i<stream_.nDeviceChannels[0]; i++ ) {
2634 jackbuffer = (jack_default_audio_sample_t *) jack_port_get_buffer( handle->ports[0][i], (jack_nframes_t) nframes );
2635 memcpy( jackbuffer, &stream_.deviceBuffer[i*bufferBytes], bufferBytes );
2638 else { // no buffer conversion
2639 for ( unsigned int i=0; i<stream_.nUserChannels[0]; i++ ) {
2640 jackbuffer = (jack_default_audio_sample_t *) jack_port_get_buffer( handle->ports[0][i], (jack_nframes_t) nframes );
2641 memcpy( jackbuffer, &stream_.userBuffer[0][i*bufferBytes], bufferBytes );
2646 // Don't bother draining input
2647 if ( handle->drainCounter ) {
2648 handle->drainCounter++;
2652 if ( stream_.mode == INPUT || stream_.mode == DUPLEX ) {
2654 if ( stream_.doConvertBuffer[1] ) {
2655 for ( unsigned int i=0; i<stream_.nDeviceChannels[1]; i++ ) {
2656 jackbuffer = (jack_default_audio_sample_t *) jack_port_get_buffer( handle->ports[1][i], (jack_nframes_t) nframes );
2657 memcpy( &stream_.deviceBuffer[i*bufferBytes], jackbuffer, bufferBytes );
2659 convertBuffer( stream_.userBuffer[1], stream_.deviceBuffer, stream_.convertInfo[1] );
2661 else { // no buffer conversion
2662 for ( unsigned int i=0; i<stream_.nUserChannels[1]; i++ ) {
2663 jackbuffer = (jack_default_audio_sample_t *) jack_port_get_buffer( handle->ports[1][i], (jack_nframes_t) nframes );
2664 memcpy( &stream_.userBuffer[1][i*bufferBytes], jackbuffer, bufferBytes );
2670 RtApi::tickStreamTime();
2673 //******************** End of __UNIX_JACK__ *********************//
2676 #if defined(__WINDOWS_ASIO__) // ASIO API on Windows
2678 // The ASIO API is designed around a callback scheme, so this
2679 // implementation is similar to that used for OS-X CoreAudio and Linux
2680 // Jack. The primary constraint with ASIO is that it only allows
2681 // access to a single driver at a time. Thus, it is not possible to
2682 // have more than one simultaneous RtAudio stream.
2684 // This implementation also requires a number of external ASIO files
2685 // and a few global variables. The ASIO callback scheme does not
2686 // allow for the passing of user data, so we must create a global
2687 // pointer to our callbackInfo structure.
2689 // On unix systems, we make use of a pthread condition variable.
2690 // Since there is no equivalent in Windows, I hacked something based
2691 // on information found in
2692 // http://www.cs.wustl.edu/~schmidt/win32-cv-1.html.
2694 #include "asiosys.h"
2696 #include "iasiothiscallresolver.h"
2697 #include "asiodrivers.h"
2700 static AsioDrivers drivers;
2701 static ASIOCallbacks asioCallbacks;
2702 static ASIODriverInfo driverInfo;
2703 static CallbackInfo *asioCallbackInfo;
2704 static bool asioXRun;
2707 int drainCounter; // Tracks callback counts when draining
2708 bool internalDrain; // Indicates if stop is initiated from callback or not.
2709 ASIOBufferInfo *bufferInfos;
2713 :drainCounter(0), internalDrain(false), bufferInfos(0) {}
2716 // Function declarations (definitions at end of section)
2717 static const char* getAsioErrorString( ASIOError result );
2718 static void sampleRateChanged( ASIOSampleRate sRate );
2719 static long asioMessages( long selector, long value, void* message, double* opt );
2721 RtApiAsio :: RtApiAsio()
2723 // ASIO cannot run on a multi-threaded appartment. You can call
2724 // CoInitialize beforehand, but it must be for appartment threading
2725 // (in which case, CoInitilialize will return S_FALSE here).
2726 coInitialized_ = false;
2727 HRESULT hr = CoInitialize( NULL );
2729 errorText_ = "RtApiAsio::ASIO requires a single-threaded appartment. Call CoInitializeEx(0,COINIT_APARTMENTTHREADED)";
2730 error( RtAudioError::WARNING );
2732 coInitialized_ = true;
2734 drivers.removeCurrentDriver();
2735 driverInfo.asioVersion = 2;
2737 // See note in DirectSound implementation about GetDesktopWindow().
2738 driverInfo.sysRef = GetForegroundWindow();
2741 RtApiAsio :: ~RtApiAsio()
2743 if ( stream_.state != STREAM_CLOSED ) closeStream();
2744 if ( coInitialized_ ) CoUninitialize();
2747 unsigned int RtApiAsio :: getDeviceCount( void )
2749 return (unsigned int) drivers.asioGetNumDev();
2752 RtAudio::DeviceInfo RtApiAsio :: getDeviceInfo( unsigned int device )
2754 RtAudio::DeviceInfo info;
2755 info.probed = false;
2758 unsigned int nDevices = getDeviceCount();
2759 if ( nDevices == 0 ) {
2760 errorText_ = "RtApiAsio::getDeviceInfo: no devices found!";
2761 error( RtAudioError::INVALID_USE );
2765 if ( device >= nDevices ) {
2766 errorText_ = "RtApiAsio::getDeviceInfo: device ID is invalid!";
2767 error( RtAudioError::INVALID_USE );
2771 // If a stream is already open, we cannot probe other devices. Thus, use the saved results.
2772 if ( stream_.state != STREAM_CLOSED ) {
2773 if ( device >= devices_.size() ) {
2774 errorText_ = "RtApiAsio::getDeviceInfo: device ID was not present before stream was opened.";
2775 error( RtAudioError::WARNING );
2778 return devices_[ device ];
2781 char driverName[32];
2782 ASIOError result = drivers.asioGetDriverName( (int) device, driverName, 32 );
2783 if ( result != ASE_OK ) {
2784 errorStream_ << "RtApiAsio::getDeviceInfo: unable to get driver name (" << getAsioErrorString( result ) << ").";
2785 errorText_ = errorStream_.str();
2786 error( RtAudioError::WARNING );
2790 info.name = driverName;
2792 if ( !drivers.loadDriver( driverName ) ) {
2793 errorStream_ << "RtApiAsio::getDeviceInfo: unable to load driver (" << driverName << ").";
2794 errorText_ = errorStream_.str();
2795 error( RtAudioError::WARNING );
2799 result = ASIOInit( &driverInfo );
2800 if ( result != ASE_OK ) {
2801 errorStream_ << "RtApiAsio::getDeviceInfo: error (" << getAsioErrorString( result ) << ") initializing driver (" << driverName << ").";
2802 errorText_ = errorStream_.str();
2803 error( RtAudioError::WARNING );
2807 // Determine the device channel information.
2808 long inputChannels, outputChannels;
2809 result = ASIOGetChannels( &inputChannels, &outputChannels );
2810 if ( result != ASE_OK ) {
2811 drivers.removeCurrentDriver();
2812 errorStream_ << "RtApiAsio::getDeviceInfo: error (" << getAsioErrorString( result ) << ") getting channel count (" << driverName << ").";
2813 errorText_ = errorStream_.str();
2814 error( RtAudioError::WARNING );
2818 info.outputChannels = outputChannels;
2819 info.inputChannels = inputChannels;
2820 if ( info.outputChannels > 0 && info.inputChannels > 0 )
2821 info.duplexChannels = (info.outputChannels > info.inputChannels) ? info.inputChannels : info.outputChannels;
2823 // Determine the supported sample rates.
2824 info.sampleRates.clear();
2825 for ( unsigned int i=0; i<MAX_SAMPLE_RATES; i++ ) {
2826 result = ASIOCanSampleRate( (ASIOSampleRate) SAMPLE_RATES[i] );
2827 if ( result == ASE_OK ) {
2828 info.sampleRates.push_back( SAMPLE_RATES[i] );
2830 if ( !info.preferredSampleRate || ( SAMPLE_RATES[i] <= 48000 && SAMPLE_RATES[i] > info.preferredSampleRate ) )
2831 info.preferredSampleRate = SAMPLE_RATES[i];
2835 // Determine supported data types ... just check first channel and assume rest are the same.
2836 ASIOChannelInfo channelInfo;
2837 channelInfo.channel = 0;
2838 channelInfo.isInput = true;
2839 if ( info.inputChannels <= 0 ) channelInfo.isInput = false;
2840 result = ASIOGetChannelInfo( &channelInfo );
2841 if ( result != ASE_OK ) {
2842 drivers.removeCurrentDriver();
2843 errorStream_ << "RtApiAsio::getDeviceInfo: error (" << getAsioErrorString( result ) << ") getting driver channel info (" << driverName << ").";
2844 errorText_ = errorStream_.str();
2845 error( RtAudioError::WARNING );
2849 info.nativeFormats = 0;
2850 if ( channelInfo.type == ASIOSTInt16MSB || channelInfo.type == ASIOSTInt16LSB )
2851 info.nativeFormats |= RTAUDIO_SINT16;
2852 else if ( channelInfo.type == ASIOSTInt32MSB || channelInfo.type == ASIOSTInt32LSB )
2853 info.nativeFormats |= RTAUDIO_SINT32;
2854 else if ( channelInfo.type == ASIOSTFloat32MSB || channelInfo.type == ASIOSTFloat32LSB )
2855 info.nativeFormats |= RTAUDIO_FLOAT32;
2856 else if ( channelInfo.type == ASIOSTFloat64MSB || channelInfo.type == ASIOSTFloat64LSB )
2857 info.nativeFormats |= RTAUDIO_FLOAT64;
2858 else if ( channelInfo.type == ASIOSTInt24MSB || channelInfo.type == ASIOSTInt24LSB )
2859 info.nativeFormats |= RTAUDIO_SINT24;
2861 if ( info.outputChannels > 0 )
2862 if ( getDefaultOutputDevice() == device ) info.isDefaultOutput = true;
2863 if ( info.inputChannels > 0 )
2864 if ( getDefaultInputDevice() == device ) info.isDefaultInput = true;
2867 drivers.removeCurrentDriver();
2871 static void bufferSwitch( long index, ASIOBool /*processNow*/ )
2873 RtApiAsio *object = (RtApiAsio *) asioCallbackInfo->object;
2874 object->callbackEvent( index );
2877 void RtApiAsio :: saveDeviceInfo( void )
2881 unsigned int nDevices = getDeviceCount();
2882 devices_.resize( nDevices );
2883 for ( unsigned int i=0; i<nDevices; i++ )
2884 devices_[i] = getDeviceInfo( i );
2887 bool RtApiAsio :: probeDeviceOpen( unsigned int device, StreamMode mode, unsigned int channels,
2888 unsigned int firstChannel, unsigned int sampleRate,
2889 RtAudioFormat format, unsigned int *bufferSize,
2890 RtAudio::StreamOptions *options )
2891 {////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
2893 bool isDuplexInput = mode == INPUT && stream_.mode == OUTPUT;
2895 // For ASIO, a duplex stream MUST use the same driver.
2896 if ( isDuplexInput && stream_.device[0] != device ) {
2897 errorText_ = "RtApiAsio::probeDeviceOpen: an ASIO duplex stream must use the same device for input and output!";
2901 char driverName[32];
2902 ASIOError result = drivers.asioGetDriverName( (int) device, driverName, 32 );
2903 if ( result != ASE_OK ) {
2904 errorStream_ << "RtApiAsio::probeDeviceOpen: unable to get driver name (" << getAsioErrorString( result ) << ").";
2905 errorText_ = errorStream_.str();
2909 // Only load the driver once for duplex stream.
2910 if ( !isDuplexInput ) {
2911 // The getDeviceInfo() function will not work when a stream is open
2912 // because ASIO does not allow multiple devices to run at the same
2913 // time. Thus, we'll probe the system before opening a stream and
2914 // save the results for use by getDeviceInfo().
2915 this->saveDeviceInfo();
2917 if ( !drivers.loadDriver( driverName ) ) {
2918 errorStream_ << "RtApiAsio::probeDeviceOpen: unable to load driver (" << driverName << ").";
2919 errorText_ = errorStream_.str();
2923 result = ASIOInit( &driverInfo );
2924 if ( result != ASE_OK ) {
2925 errorStream_ << "RtApiAsio::probeDeviceOpen: error (" << getAsioErrorString( result ) << ") initializing driver (" << driverName << ").";
2926 errorText_ = errorStream_.str();
2931 // keep them before any "goto error", they are used for error cleanup + goto device boundary checks
2932 bool buffersAllocated = false;
2933 AsioHandle *handle = (AsioHandle *) stream_.apiHandle;
2934 unsigned int nChannels;
2937 // Check the device channel count.
2938 long inputChannels, outputChannels;
2939 result = ASIOGetChannels( &inputChannels, &outputChannels );
2940 if ( result != ASE_OK ) {
2941 errorStream_ << "RtApiAsio::probeDeviceOpen: error (" << getAsioErrorString( result ) << ") getting channel count (" << driverName << ").";
2942 errorText_ = errorStream_.str();
2946 if ( ( mode == OUTPUT && (channels+firstChannel) > (unsigned int) outputChannels) ||
2947 ( mode == INPUT && (channels+firstChannel) > (unsigned int) inputChannels) ) {
2948 errorStream_ << "RtApiAsio::probeDeviceOpen: driver (" << driverName << ") does not support requested channel count (" << channels << ") + offset (" << firstChannel << ").";
2949 errorText_ = errorStream_.str();
2952 stream_.nDeviceChannels[mode] = channels;
2953 stream_.nUserChannels[mode] = channels;
2954 stream_.channelOffset[mode] = firstChannel;
2956 // Verify the sample rate is supported.
2957 result = ASIOCanSampleRate( (ASIOSampleRate) sampleRate );
2958 if ( result != ASE_OK ) {
2959 errorStream_ << "RtApiAsio::probeDeviceOpen: driver (" << driverName << ") does not support requested sample rate (" << sampleRate << ").";
2960 errorText_ = errorStream_.str();
2964 // Get the current sample rate
2965 ASIOSampleRate currentRate;
2966 result = ASIOGetSampleRate( ¤tRate );
2967 if ( result != ASE_OK ) {
2968 errorStream_ << "RtApiAsio::probeDeviceOpen: driver (" << driverName << ") error getting sample rate.";
2969 errorText_ = errorStream_.str();
2973 // Set the sample rate only if necessary
2974 if ( currentRate != sampleRate ) {
2975 result = ASIOSetSampleRate( (ASIOSampleRate) sampleRate );
2976 if ( result != ASE_OK ) {
2977 errorStream_ << "RtApiAsio::probeDeviceOpen: driver (" << driverName << ") error setting sample rate (" << sampleRate << ").";
2978 errorText_ = errorStream_.str();
2983 // Determine the driver data type.
2984 ASIOChannelInfo channelInfo;
2985 channelInfo.channel = 0;
2986 if ( mode == OUTPUT ) channelInfo.isInput = false;
2987 else channelInfo.isInput = true;
2988 result = ASIOGetChannelInfo( &channelInfo );
2989 if ( result != ASE_OK ) {
2990 errorStream_ << "RtApiAsio::probeDeviceOpen: driver (" << driverName << ") error (" << getAsioErrorString( result ) << ") getting data format.";
2991 errorText_ = errorStream_.str();
2995 // Assuming WINDOWS host is always little-endian.
2996 stream_.doByteSwap[mode] = false;
2997 stream_.userFormat = format;
2998 stream_.deviceFormat[mode] = 0;
2999 if ( channelInfo.type == ASIOSTInt16MSB || channelInfo.type == ASIOSTInt16LSB ) {
3000 stream_.deviceFormat[mode] = RTAUDIO_SINT16;
3001 if ( channelInfo.type == ASIOSTInt16MSB ) stream_.doByteSwap[mode] = true;
3003 else if ( channelInfo.type == ASIOSTInt32MSB || channelInfo.type == ASIOSTInt32LSB ) {
3004 stream_.deviceFormat[mode] = RTAUDIO_SINT32;
3005 if ( channelInfo.type == ASIOSTInt32MSB ) stream_.doByteSwap[mode] = true;
3007 else if ( channelInfo.type == ASIOSTFloat32MSB || channelInfo.type == ASIOSTFloat32LSB ) {
3008 stream_.deviceFormat[mode] = RTAUDIO_FLOAT32;
3009 if ( channelInfo.type == ASIOSTFloat32MSB ) stream_.doByteSwap[mode] = true;
3011 else if ( channelInfo.type == ASIOSTFloat64MSB || channelInfo.type == ASIOSTFloat64LSB ) {
3012 stream_.deviceFormat[mode] = RTAUDIO_FLOAT64;
3013 if ( channelInfo.type == ASIOSTFloat64MSB ) stream_.doByteSwap[mode] = true;
3015 else if ( channelInfo.type == ASIOSTInt24MSB || channelInfo.type == ASIOSTInt24LSB ) {
3016 stream_.deviceFormat[mode] = RTAUDIO_SINT24;
3017 if ( channelInfo.type == ASIOSTInt24MSB ) stream_.doByteSwap[mode] = true;
3020 if ( stream_.deviceFormat[mode] == 0 ) {
3021 errorStream_ << "RtApiAsio::probeDeviceOpen: driver (" << driverName << ") data format not supported by RtAudio.";
3022 errorText_ = errorStream_.str();
3026 // Set the buffer size. For a duplex stream, this will end up
3027 // setting the buffer size based on the input constraints, which
3029 long minSize, maxSize, preferSize, granularity;
3030 result = ASIOGetBufferSize( &minSize, &maxSize, &preferSize, &granularity );
3031 if ( result != ASE_OK ) {
3032 errorStream_ << "RtApiAsio::probeDeviceOpen: driver (" << driverName << ") error (" << getAsioErrorString( result ) << ") getting buffer size.";
3033 errorText_ = errorStream_.str();
3037 if ( isDuplexInput ) {
3038 // When this is the duplex input (output was opened before), then we have to use the same
3039 // buffersize as the output, because it might use the preferred buffer size, which most
3040 // likely wasn't passed as input to this. The buffer sizes have to be identically anyway,
3041 // So instead of throwing an error, make them equal. The caller uses the reference
3042 // to the "bufferSize" param as usual to set up processing buffers.
3044 *bufferSize = stream_.bufferSize;
3047 if ( *bufferSize == 0 ) *bufferSize = preferSize;
3048 else if ( *bufferSize < (unsigned int) minSize ) *bufferSize = (unsigned int) minSize;
3049 else if ( *bufferSize > (unsigned int) maxSize ) *bufferSize = (unsigned int) maxSize;
3050 else if ( granularity == -1 ) {
3051 // Make sure bufferSize is a power of two.
3052 int log2_of_min_size = 0;
3053 int log2_of_max_size = 0;
3055 for ( unsigned int i = 0; i < sizeof(long) * 8; i++ ) {
3056 if ( minSize & ((long)1 << i) ) log2_of_min_size = i;
3057 if ( maxSize & ((long)1 << i) ) log2_of_max_size = i;
3060 long min_delta = std::abs( (long)*bufferSize - ((long)1 << log2_of_min_size) );
3061 int min_delta_num = log2_of_min_size;
3063 for (int i = log2_of_min_size + 1; i <= log2_of_max_size; i++) {
3064 long current_delta = std::abs( (long)*bufferSize - ((long)1 << i) );
3065 if (current_delta < min_delta) {
3066 min_delta = current_delta;
3071 *bufferSize = ( (unsigned int)1 << min_delta_num );
3072 if ( *bufferSize < (unsigned int) minSize ) *bufferSize = (unsigned int) minSize;
3073 else if ( *bufferSize > (unsigned int) maxSize ) *bufferSize = (unsigned int) maxSize;
3075 else if ( granularity != 0 ) {
3076 // Set to an even multiple of granularity, rounding up.
3077 *bufferSize = (*bufferSize + granularity-1) / granularity * granularity;
3082 // we don't use it anymore, see above!
3083 // Just left it here for the case...
3084 if ( isDuplexInput && stream_.bufferSize != *bufferSize ) {
3085 errorText_ = "RtApiAsio::probeDeviceOpen: input/output buffersize discrepancy!";
3090 stream_.bufferSize = *bufferSize;
3091 stream_.nBuffers = 2;
3093 if ( options && options->flags & RTAUDIO_NONINTERLEAVED ) stream_.userInterleaved = false;
3094 else stream_.userInterleaved = true;
3096 // ASIO always uses non-interleaved buffers.
3097 stream_.deviceInterleaved[mode] = false;
3099 // Allocate, if necessary, our AsioHandle structure for the stream.
3100 if ( handle == 0 ) {
3102 handle = new AsioHandle;
3104 catch ( std::bad_alloc& ) {
3105 errorText_ = "RtApiAsio::probeDeviceOpen: error allocating AsioHandle memory.";
3108 handle->bufferInfos = 0;
3110 // Create a manual-reset event.
3111 handle->condition = CreateEvent( NULL, // no security
3112 TRUE, // manual-reset
3113 FALSE, // non-signaled initially
3115 stream_.apiHandle = (void *) handle;
3118 // Create the ASIO internal buffers. Since RtAudio sets up input
3119 // and output separately, we'll have to dispose of previously
3120 // created output buffers for a duplex stream.
3121 if ( mode == INPUT && stream_.mode == OUTPUT ) {
3122 ASIODisposeBuffers();
3123 if ( handle->bufferInfos ) free( handle->bufferInfos );
3126 // Allocate, initialize, and save the bufferInfos in our stream callbackInfo structure.
3128 nChannels = stream_.nDeviceChannels[0] + stream_.nDeviceChannels[1];
3129 handle->bufferInfos = (ASIOBufferInfo *) malloc( nChannels * sizeof(ASIOBufferInfo) );
3130 if ( handle->bufferInfos == NULL ) {
3131 errorStream_ << "RtApiAsio::probeDeviceOpen: error allocating bufferInfo memory for driver (" << driverName << ").";
3132 errorText_ = errorStream_.str();
3136 ASIOBufferInfo *infos;
3137 infos = handle->bufferInfos;
3138 for ( i=0; i<stream_.nDeviceChannels[0]; i++, infos++ ) {
3139 infos->isInput = ASIOFalse;
3140 infos->channelNum = i + stream_.channelOffset[0];
3141 infos->buffers[0] = infos->buffers[1] = 0;
3143 for ( i=0; i<stream_.nDeviceChannels[1]; i++, infos++ ) {
3144 infos->isInput = ASIOTrue;
3145 infos->channelNum = i + stream_.channelOffset[1];
3146 infos->buffers[0] = infos->buffers[1] = 0;
3149 // prepare for callbacks
3150 stream_.sampleRate = sampleRate;
3151 stream_.device[mode] = device;
3152 stream_.mode = isDuplexInput ? DUPLEX : mode;
3154 // store this class instance before registering callbacks, that are going to use it
3155 asioCallbackInfo = &stream_.callbackInfo;
3156 stream_.callbackInfo.object = (void *) this;
3158 // Set up the ASIO callback structure and create the ASIO data buffers.
3159 asioCallbacks.bufferSwitch = &bufferSwitch;
3160 asioCallbacks.sampleRateDidChange = &sampleRateChanged;
3161 asioCallbacks.asioMessage = &asioMessages;
3162 asioCallbacks.bufferSwitchTimeInfo = NULL;
3163 result = ASIOCreateBuffers( handle->bufferInfos, nChannels, stream_.bufferSize, &asioCallbacks );
3164 if ( result != ASE_OK ) {
3165 // Standard method failed. This can happen with strict/misbehaving drivers that return valid buffer size ranges
3166 // but only accept the preferred buffer size as parameter for ASIOCreateBuffers. eg. Creatives ASIO driver
3167 // in that case, let's be naïve and try that instead
3168 *bufferSize = preferSize;
3169 stream_.bufferSize = *bufferSize;
3170 result = ASIOCreateBuffers( handle->bufferInfos, nChannels, stream_.bufferSize, &asioCallbacks );
3173 if ( result != ASE_OK ) {
3174 errorStream_ << "RtApiAsio::probeDeviceOpen: driver (" << driverName << ") error (" << getAsioErrorString( result ) << ") creating buffers.";
3175 errorText_ = errorStream_.str();
3178 buffersAllocated = true;
3179 stream_.state = STREAM_STOPPED;
3181 // Set flags for buffer conversion.
3182 stream_.doConvertBuffer[mode] = false;
3183 if ( stream_.userFormat != stream_.deviceFormat[mode] )
3184 stream_.doConvertBuffer[mode] = true;
3185 if ( stream_.userInterleaved != stream_.deviceInterleaved[mode] &&
3186 stream_.nUserChannels[mode] > 1 )
3187 stream_.doConvertBuffer[mode] = true;
3189 // Allocate necessary internal buffers
3190 unsigned long bufferBytes;
3191 bufferBytes = stream_.nUserChannels[mode] * *bufferSize * formatBytes( stream_.userFormat );
3192 stream_.userBuffer[mode] = (char *) calloc( bufferBytes, 1 );
3193 if ( stream_.userBuffer[mode] == NULL ) {
3194 errorText_ = "RtApiAsio::probeDeviceOpen: error allocating user buffer memory.";
3198 if ( stream_.doConvertBuffer[mode] ) {
3200 bool makeBuffer = true;
3201 bufferBytes = stream_.nDeviceChannels[mode] * formatBytes( stream_.deviceFormat[mode] );
3202 if ( isDuplexInput && stream_.deviceBuffer ) {
3203 unsigned long bytesOut = stream_.nDeviceChannels[0] * formatBytes( stream_.deviceFormat[0] );
3204 if ( bufferBytes <= bytesOut ) makeBuffer = false;
3208 bufferBytes *= *bufferSize;
3209 if ( stream_.deviceBuffer ) free( stream_.deviceBuffer );
3210 stream_.deviceBuffer = (char *) calloc( bufferBytes, 1 );
3211 if ( stream_.deviceBuffer == NULL ) {
3212 errorText_ = "RtApiAsio::probeDeviceOpen: error allocating device buffer memory.";
3218 // Determine device latencies
3219 long inputLatency, outputLatency;
3220 result = ASIOGetLatencies( &inputLatency, &outputLatency );
3221 if ( result != ASE_OK ) {
3222 errorStream_ << "RtApiAsio::probeDeviceOpen: driver (" << driverName << ") error (" << getAsioErrorString( result ) << ") getting latency.";
3223 errorText_ = errorStream_.str();
3224 error( RtAudioError::WARNING); // warn but don't fail
3227 stream_.latency[0] = outputLatency;
3228 stream_.latency[1] = inputLatency;
3231 // Setup the buffer conversion information structure. We don't use
3232 // buffers to do channel offsets, so we override that parameter
3234 if ( stream_.doConvertBuffer[mode] ) setConvertInfo( mode, 0 );
3239 if ( !isDuplexInput ) {
3240 // the cleanup for error in the duplex input, is done by RtApi::openStream
3241 // So we clean up for single channel only
3243 if ( buffersAllocated )
3244 ASIODisposeBuffers();
3246 drivers.removeCurrentDriver();
3249 CloseHandle( handle->condition );
3250 if ( handle->bufferInfos )
3251 free( handle->bufferInfos );
3254 stream_.apiHandle = 0;
3258 if ( stream_.userBuffer[mode] ) {
3259 free( stream_.userBuffer[mode] );
3260 stream_.userBuffer[mode] = 0;
3263 if ( stream_.deviceBuffer ) {
3264 free( stream_.deviceBuffer );
3265 stream_.deviceBuffer = 0;
3270 }////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
3272 void RtApiAsio :: closeStream()
3274 if ( stream_.state == STREAM_CLOSED ) {
3275 errorText_ = "RtApiAsio::closeStream(): no open stream to close!";
3276 error( RtAudioError::WARNING );
3280 if ( stream_.state == STREAM_RUNNING ) {
3281 stream_.state = STREAM_STOPPED;
3284 ASIODisposeBuffers();
3285 drivers.removeCurrentDriver();
3287 AsioHandle *handle = (AsioHandle *) stream_.apiHandle;
3289 CloseHandle( handle->condition );
3290 if ( handle->bufferInfos )
3291 free( handle->bufferInfos );
3293 stream_.apiHandle = 0;
3296 for ( int i=0; i<2; i++ ) {
3297 if ( stream_.userBuffer[i] ) {
3298 free( stream_.userBuffer[i] );
3299 stream_.userBuffer[i] = 0;
3303 if ( stream_.deviceBuffer ) {
3304 free( stream_.deviceBuffer );
3305 stream_.deviceBuffer = 0;
3308 stream_.mode = UNINITIALIZED;
3309 stream_.state = STREAM_CLOSED;
3312 bool stopThreadCalled = false;
3314 void RtApiAsio :: startStream()
3317 if ( stream_.state == STREAM_RUNNING ) {
3318 errorText_ = "RtApiAsio::startStream(): the stream is already running!";
3319 error( RtAudioError::WARNING );
3323 AsioHandle *handle = (AsioHandle *) stream_.apiHandle;
3324 ASIOError result = ASIOStart();
3325 if ( result != ASE_OK ) {
3326 errorStream_ << "RtApiAsio::startStream: error (" << getAsioErrorString( result ) << ") starting device.";
3327 errorText_ = errorStream_.str();
3331 handle->drainCounter = 0;
3332 handle->internalDrain = false;
3333 ResetEvent( handle->condition );
3334 stream_.state = STREAM_RUNNING;
3338 stopThreadCalled = false;
3340 if ( result == ASE_OK ) return;
3341 error( RtAudioError::SYSTEM_ERROR );
3344 void RtApiAsio :: stopStream()
3347 if ( stream_.state == STREAM_STOPPED ) {
3348 errorText_ = "RtApiAsio::stopStream(): the stream is already stopped!";
3349 error( RtAudioError::WARNING );
3353 AsioHandle *handle = (AsioHandle *) stream_.apiHandle;
3354 if ( stream_.mode == OUTPUT || stream_.mode == DUPLEX ) {
3355 if ( handle->drainCounter == 0 ) {
3356 handle->drainCounter = 2;
3357 WaitForSingleObject( handle->condition, INFINITE ); // block until signaled
3361 stream_.state = STREAM_STOPPED;
3363 ASIOError result = ASIOStop();
3364 if ( result != ASE_OK ) {
3365 errorStream_ << "RtApiAsio::stopStream: error (" << getAsioErrorString( result ) << ") stopping device.";
3366 errorText_ = errorStream_.str();
3369 if ( result == ASE_OK ) return;
3370 error( RtAudioError::SYSTEM_ERROR );
3373 void RtApiAsio :: abortStream()
3376 if ( stream_.state == STREAM_STOPPED ) {
3377 errorText_ = "RtApiAsio::abortStream(): the stream is already stopped!";
3378 error( RtAudioError::WARNING );
3382 // The following lines were commented-out because some behavior was
3383 // noted where the device buffers need to be zeroed to avoid
3384 // continuing sound, even when the device buffers are completely
3385 // disposed. So now, calling abort is the same as calling stop.
3386 // AsioHandle *handle = (AsioHandle *) stream_.apiHandle;
3387 // handle->drainCounter = 2;
3391 // This function will be called by a spawned thread when the user
3392 // callback function signals that the stream should be stopped or
3393 // aborted. It is necessary to handle it this way because the
3394 // callbackEvent() function must return before the ASIOStop()
3395 // function will return.
3396 static unsigned __stdcall asioStopStream( void *ptr )
3398 CallbackInfo *info = (CallbackInfo *) ptr;
3399 RtApiAsio *object = (RtApiAsio *) info->object;
3401 object->stopStream();
3406 bool RtApiAsio :: callbackEvent( long bufferIndex )
3408 if ( stream_.state == STREAM_STOPPED || stream_.state == STREAM_STOPPING ) return SUCCESS;
3409 if ( stream_.state == STREAM_CLOSED ) {
3410 errorText_ = "RtApiAsio::callbackEvent(): the stream is closed ... this shouldn't happen!";
3411 error( RtAudioError::WARNING );
3415 CallbackInfo *info = (CallbackInfo *) &stream_.callbackInfo;
3416 AsioHandle *handle = (AsioHandle *) stream_.apiHandle;
3418 // Check if we were draining the stream and signal if finished.
3419 if ( handle->drainCounter > 3 ) {
3421 stream_.state = STREAM_STOPPING;
3422 if ( handle->internalDrain == false )
3423 SetEvent( handle->condition );
3424 else { // spawn a thread to stop the stream
3426 stream_.callbackInfo.thread = _beginthreadex( NULL, 0, &asioStopStream,
3427 &stream_.callbackInfo, 0, &threadId );
3432 // Invoke user callback to get fresh output data UNLESS we are
3434 if ( handle->drainCounter == 0 ) {
3435 RtAudioCallback callback = (RtAudioCallback) info->callback;
3436 double streamTime = getStreamTime();
3437 RtAudioStreamStatus status = 0;
3438 if ( stream_.mode != INPUT && asioXRun == true ) {
3439 status |= RTAUDIO_OUTPUT_UNDERFLOW;
3442 if ( stream_.mode != OUTPUT && asioXRun == true ) {
3443 status |= RTAUDIO_INPUT_OVERFLOW;
3446 int cbReturnValue = callback( stream_.userBuffer[0], stream_.userBuffer[1],
3447 stream_.bufferSize, streamTime, status, info->userData );
3448 if ( cbReturnValue == 2 ) {
3449 stream_.state = STREAM_STOPPING;
3450 handle->drainCounter = 2;
3452 stream_.callbackInfo.thread = _beginthreadex( NULL, 0, &asioStopStream,
3453 &stream_.callbackInfo, 0, &threadId );
3456 else if ( cbReturnValue == 1 ) {
3457 handle->drainCounter = 1;
3458 handle->internalDrain = true;
3462 unsigned int nChannels, bufferBytes, i, j;
3463 nChannels = stream_.nDeviceChannels[0] + stream_.nDeviceChannels[1];
3464 if ( stream_.mode == OUTPUT || stream_.mode == DUPLEX ) {
3466 bufferBytes = stream_.bufferSize * formatBytes( stream_.deviceFormat[0] );
3468 if ( handle->drainCounter > 1 ) { // write zeros to the output stream
3470 for ( i=0, j=0; i<nChannels; i++ ) {
3471 if ( handle->bufferInfos[i].isInput != ASIOTrue )
3472 memset( handle->bufferInfos[i].buffers[bufferIndex], 0, bufferBytes );
3476 else if ( stream_.doConvertBuffer[0] ) {
3478 convertBuffer( stream_.deviceBuffer, stream_.userBuffer[0], stream_.convertInfo[0] );
3479 if ( stream_.doByteSwap[0] )
3480 byteSwapBuffer( stream_.deviceBuffer,
3481 stream_.bufferSize * stream_.nDeviceChannels[0],
3482 stream_.deviceFormat[0] );
3484 for ( i=0, j=0; i<nChannels; i++ ) {
3485 if ( handle->bufferInfos[i].isInput != ASIOTrue )
3486 memcpy( handle->bufferInfos[i].buffers[bufferIndex],
3487 &stream_.deviceBuffer[j++*bufferBytes], bufferBytes );
3493 if ( stream_.doByteSwap[0] )
3494 byteSwapBuffer( stream_.userBuffer[0],
3495 stream_.bufferSize * stream_.nUserChannels[0],
3496 stream_.userFormat );
3498 for ( i=0, j=0; i<nChannels; i++ ) {
3499 if ( handle->bufferInfos[i].isInput != ASIOTrue )
3500 memcpy( handle->bufferInfos[i].buffers[bufferIndex],
3501 &stream_.userBuffer[0][bufferBytes*j++], bufferBytes );
3507 // Don't bother draining input
3508 if ( handle->drainCounter ) {
3509 handle->drainCounter++;
3513 if ( stream_.mode == INPUT || stream_.mode == DUPLEX ) {
3515 bufferBytes = stream_.bufferSize * formatBytes(stream_.deviceFormat[1]);
3517 if (stream_.doConvertBuffer[1]) {
3519 // Always interleave ASIO input data.
3520 for ( i=0, j=0; i<nChannels; i++ ) {
3521 if ( handle->bufferInfos[i].isInput == ASIOTrue )
3522 memcpy( &stream_.deviceBuffer[j++*bufferBytes],
3523 handle->bufferInfos[i].buffers[bufferIndex],
3527 if ( stream_.doByteSwap[1] )
3528 byteSwapBuffer( stream_.deviceBuffer,
3529 stream_.bufferSize * stream_.nDeviceChannels[1],
3530 stream_.deviceFormat[1] );
3531 convertBuffer( stream_.userBuffer[1], stream_.deviceBuffer, stream_.convertInfo[1] );
3535 for ( i=0, j=0; i<nChannels; i++ ) {
3536 if ( handle->bufferInfos[i].isInput == ASIOTrue ) {
3537 memcpy( &stream_.userBuffer[1][bufferBytes*j++],
3538 handle->bufferInfos[i].buffers[bufferIndex],
3543 if ( stream_.doByteSwap[1] )
3544 byteSwapBuffer( stream_.userBuffer[1],
3545 stream_.bufferSize * stream_.nUserChannels[1],
3546 stream_.userFormat );
3551 // The following call was suggested by Malte Clasen. While the API
3552 // documentation indicates it should not be required, some device
3553 // drivers apparently do not function correctly without it.
3556 RtApi::tickStreamTime();
3560 static void sampleRateChanged( ASIOSampleRate sRate )
3562 // The ASIO documentation says that this usually only happens during
3563 // external sync. Audio processing is not stopped by the driver,
3564 // actual sample rate might not have even changed, maybe only the
3565 // sample rate status of an AES/EBU or S/PDIF digital input at the
3568 RtApi *object = (RtApi *) asioCallbackInfo->object;
3570 object->stopStream();
3572 catch ( RtAudioError &exception ) {
3573 std::cerr << "\nRtApiAsio: sampleRateChanged() error (" << exception.getMessage() << ")!\n" << std::endl;
3577 std::cerr << "\nRtApiAsio: driver reports sample rate changed to " << sRate << " ... stream stopped!!!\n" << std::endl;
3580 static long asioMessages( long selector, long value, void* /*message*/, double* /*opt*/ )
3584 switch( selector ) {
3585 case kAsioSelectorSupported:
3586 if ( value == kAsioResetRequest
3587 || value == kAsioEngineVersion
3588 || value == kAsioResyncRequest
3589 || value == kAsioLatenciesChanged
3590 // The following three were added for ASIO 2.0, you don't
3591 // necessarily have to support them.
3592 || value == kAsioSupportsTimeInfo
3593 || value == kAsioSupportsTimeCode
3594 || value == kAsioSupportsInputMonitor)
3597 case kAsioResetRequest:
3598 // Defer the task and perform the reset of the driver during the
3599 // next "safe" situation. You cannot reset the driver right now,
3600 // as this code is called from the driver. Reset the driver is
3601 // done by completely destruct is. I.e. ASIOStop(),
3602 // ASIODisposeBuffers(), Destruction Afterwards you initialize the
3604 std::cerr << "\nRtApiAsio: driver reset requested!!!" << std::endl;
3607 case kAsioResyncRequest:
3608 // This informs the application that the driver encountered some
3609 // non-fatal data loss. It is used for synchronization purposes
3610 // of different media. Added mainly to work around the Win16Mutex
3611 // problems in Windows 95/98 with the Windows Multimedia system,
3612 // which could lose data because the Mutex was held too long by
3613 // another thread. However a driver can issue it in other
3615 // std::cerr << "\nRtApiAsio: driver resync requested!!!" << std::endl;
3619 case kAsioLatenciesChanged:
3620 // This will inform the host application that the drivers were
3621 // latencies changed. Beware, it this does not mean that the
3622 // buffer sizes have changed! You might need to update internal
3624 std::cerr << "\nRtApiAsio: driver latency may have changed!!!" << std::endl;
3627 case kAsioEngineVersion:
3628 // Return the supported ASIO version of the host application. If
3629 // a host application does not implement this selector, ASIO 1.0
3630 // is assumed by the driver.
3633 case kAsioSupportsTimeInfo:
3634 // Informs the driver whether the
3635 // asioCallbacks.bufferSwitchTimeInfo() callback is supported.
3636 // For compatibility with ASIO 1.0 drivers the host application
3637 // should always support the "old" bufferSwitch method, too.
3640 case kAsioSupportsTimeCode:
3641 // Informs the driver whether application is interested in time
3642 // code info. If an application does not need to know about time
3643 // code, the driver has less work to do.
3650 static const char* getAsioErrorString( ASIOError result )
3658 static const Messages m[] =
3660 { ASE_NotPresent, "Hardware input or output is not present or available." },
3661 { ASE_HWMalfunction, "Hardware is malfunctioning." },
3662 { ASE_InvalidParameter, "Invalid input parameter." },
3663 { ASE_InvalidMode, "Invalid mode." },
3664 { ASE_SPNotAdvancing, "Sample position not advancing." },
3665 { ASE_NoClock, "Sample clock or rate cannot be determined or is not present." },
3666 { ASE_NoMemory, "Not enough memory to complete the request." }
3669 for ( unsigned int i = 0; i < sizeof(m)/sizeof(m[0]); ++i )
3670 if ( m[i].value == result ) return m[i].message;
3672 return "Unknown error.";
3675 //******************** End of __WINDOWS_ASIO__ *********************//
3679 #if defined(__WINDOWS_WASAPI__) // Windows WASAPI API
3681 // Authored by Marcus Tomlinson <themarcustomlinson@gmail.com>, April 2014
3682 // - Introduces support for the Windows WASAPI API
3683 // - Aims to deliver bit streams to and from hardware at the lowest possible latency, via the absolute minimum buffer sizes required
3684 // - Provides flexible stream configuration to an otherwise strict and inflexible WASAPI interface
3685 // - Includes automatic internal conversion of sample rate and buffer size between hardware and the user
3690 #include <audioclient.h>
3692 #include <mmdeviceapi.h>
3693 #include <functiondiscoverykeys_devpkey.h>
3696 //=============================================================================
3698 #define SAFE_RELEASE( objectPtr )\
3701 objectPtr->Release();\
3705 typedef HANDLE ( __stdcall *TAvSetMmThreadCharacteristicsPtr )( LPCWSTR TaskName, LPDWORD TaskIndex );
3707 //-----------------------------------------------------------------------------
3709 // WASAPI dictates stream sample rate, format, channel count, and in some cases, buffer size.
3710 // Therefore we must perform all necessary conversions to user buffers in order to satisfy these
3711 // requirements. WasapiBuffer ring buffers are used between HwIn->UserIn and UserOut->HwOut to
3712 // provide intermediate storage for read / write synchronization.
3726 // sets the length of the internal ring buffer
3727 void setBufferSize( unsigned int bufferSize, unsigned int formatBytes ) {
3730 buffer_ = ( char* ) calloc( bufferSize, formatBytes );
3732 bufferSize_ = bufferSize;
3737 // attempt to push a buffer into the ring buffer at the current "in" index
3738 bool pushBuffer( char* buffer, unsigned int bufferSize, RtAudioFormat format )
3740 if ( !buffer || // incoming buffer is NULL
3741 bufferSize == 0 || // incoming buffer has no data
3742 bufferSize > bufferSize_ ) // incoming buffer too large
3747 unsigned int relOutIndex = outIndex_;
3748 unsigned int inIndexEnd = inIndex_ + bufferSize;
3749 if ( relOutIndex < inIndex_ && inIndexEnd >= bufferSize_ ) {
3750 relOutIndex += bufferSize_;
3753 // "in" index can end on the "out" index but cannot begin at it
3754 if ( inIndex_ <= relOutIndex && inIndexEnd > relOutIndex ) {
3755 return false; // not enough space between "in" index and "out" index
3758 // copy buffer from external to internal
3759 int fromZeroSize = inIndex_ + bufferSize - bufferSize_;
3760 fromZeroSize = fromZeroSize < 0 ? 0 : fromZeroSize;
3761 int fromInSize = bufferSize - fromZeroSize;
3766 memcpy( &( ( char* ) buffer_ )[inIndex_], buffer, fromInSize * sizeof( char ) );
3767 memcpy( buffer_, &( ( char* ) buffer )[fromInSize], fromZeroSize * sizeof( char ) );
3769 case RTAUDIO_SINT16:
3770 memcpy( &( ( short* ) buffer_ )[inIndex_], buffer, fromInSize * sizeof( short ) );
3771 memcpy( buffer_, &( ( short* ) buffer )[fromInSize], fromZeroSize * sizeof( short ) );
3773 case RTAUDIO_SINT24:
3774 memcpy( &( ( S24* ) buffer_ )[inIndex_], buffer, fromInSize * sizeof( S24 ) );
3775 memcpy( buffer_, &( ( S24* ) buffer )[fromInSize], fromZeroSize * sizeof( S24 ) );
3777 case RTAUDIO_SINT32:
3778 memcpy( &( ( int* ) buffer_ )[inIndex_], buffer, fromInSize * sizeof( int ) );
3779 memcpy( buffer_, &( ( int* ) buffer )[fromInSize], fromZeroSize * sizeof( int ) );
3781 case RTAUDIO_FLOAT32:
3782 memcpy( &( ( float* ) buffer_ )[inIndex_], buffer, fromInSize * sizeof( float ) );
3783 memcpy( buffer_, &( ( float* ) buffer )[fromInSize], fromZeroSize * sizeof( float ) );
3785 case RTAUDIO_FLOAT64:
3786 memcpy( &( ( double* ) buffer_ )[inIndex_], buffer, fromInSize * sizeof( double ) );
3787 memcpy( buffer_, &( ( double* ) buffer )[fromInSize], fromZeroSize * sizeof( double ) );
3791 // update "in" index
3792 inIndex_ += bufferSize;
3793 inIndex_ %= bufferSize_;
3798 // attempt to pull a buffer from the ring buffer from the current "out" index
3799 bool pullBuffer( char* buffer, unsigned int bufferSize, RtAudioFormat format )
3801 if ( !buffer || // incoming buffer is NULL
3802 bufferSize == 0 || // incoming buffer has no data
3803 bufferSize > bufferSize_ ) // incoming buffer too large
3808 unsigned int relInIndex = inIndex_;
3809 unsigned int outIndexEnd = outIndex_ + bufferSize;
3810 if ( relInIndex < outIndex_ && outIndexEnd >= bufferSize_ ) {
3811 relInIndex += bufferSize_;
3814 // "out" index can begin at and end on the "in" index
3815 if ( outIndex_ < relInIndex && outIndexEnd > relInIndex ) {
3816 return false; // not enough space between "out" index and "in" index
3819 // copy buffer from internal to external
3820 int fromZeroSize = outIndex_ + bufferSize - bufferSize_;
3821 fromZeroSize = fromZeroSize < 0 ? 0 : fromZeroSize;
3822 int fromOutSize = bufferSize - fromZeroSize;
3827 memcpy( buffer, &( ( char* ) buffer_ )[outIndex_], fromOutSize * sizeof( char ) );
3828 memcpy( &( ( char* ) buffer )[fromOutSize], buffer_, fromZeroSize * sizeof( char ) );
3830 case RTAUDIO_SINT16:
3831 memcpy( buffer, &( ( short* ) buffer_ )[outIndex_], fromOutSize * sizeof( short ) );
3832 memcpy( &( ( short* ) buffer )[fromOutSize], buffer_, fromZeroSize * sizeof( short ) );
3834 case RTAUDIO_SINT24:
3835 memcpy( buffer, &( ( S24* ) buffer_ )[outIndex_], fromOutSize * sizeof( S24 ) );
3836 memcpy( &( ( S24* ) buffer )[fromOutSize], buffer_, fromZeroSize * sizeof( S24 ) );
3838 case RTAUDIO_SINT32:
3839 memcpy( buffer, &( ( int* ) buffer_ )[outIndex_], fromOutSize * sizeof( int ) );
3840 memcpy( &( ( int* ) buffer )[fromOutSize], buffer_, fromZeroSize * sizeof( int ) );
3842 case RTAUDIO_FLOAT32:
3843 memcpy( buffer, &( ( float* ) buffer_ )[outIndex_], fromOutSize * sizeof( float ) );
3844 memcpy( &( ( float* ) buffer )[fromOutSize], buffer_, fromZeroSize * sizeof( float ) );
3846 case RTAUDIO_FLOAT64:
3847 memcpy( buffer, &( ( double* ) buffer_ )[outIndex_], fromOutSize * sizeof( double ) );
3848 memcpy( &( ( double* ) buffer )[fromOutSize], buffer_, fromZeroSize * sizeof( double ) );
3852 // update "out" index
3853 outIndex_ += bufferSize;
3854 outIndex_ %= bufferSize_;
3861 unsigned int bufferSize_;
3862 unsigned int inIndex_;
3863 unsigned int outIndex_;
3866 //-----------------------------------------------------------------------------
3868 // A structure to hold various information related to the WASAPI implementation.
3871 IAudioClient* captureAudioClient;
3872 IAudioClient* renderAudioClient;
3873 IAudioCaptureClient* captureClient;
3874 IAudioRenderClient* renderClient;
3875 HANDLE captureEvent;
3879 : captureAudioClient( NULL ),
3880 renderAudioClient( NULL ),
3881 captureClient( NULL ),
3882 renderClient( NULL ),
3883 captureEvent( NULL ),
3884 renderEvent( NULL ) {}
3887 //=============================================================================
3889 RtApiWasapi::RtApiWasapi()
3890 : coInitialized_( false ), deviceEnumerator_( NULL )
3892 // WASAPI can run either apartment or multi-threaded
3893 HRESULT hr = CoInitialize( NULL );
3894 if ( !FAILED( hr ) )
3895 coInitialized_ = true;
3897 // Instantiate device enumerator
3898 hr = CoCreateInstance( __uuidof( MMDeviceEnumerator ), NULL,
3899 CLSCTX_ALL, __uuidof( IMMDeviceEnumerator ),
3900 ( void** ) &deviceEnumerator_ );
3902 if ( FAILED( hr ) ) {
3903 errorText_ = "RtApiWasapi::RtApiWasapi: Unable to instantiate device enumerator";
3904 error( RtAudioError::DRIVER_ERROR );
3908 //-----------------------------------------------------------------------------
3910 RtApiWasapi::~RtApiWasapi()
3912 if ( stream_.state != STREAM_CLOSED )
3915 SAFE_RELEASE( deviceEnumerator_ );
3917 // If this object previously called CoInitialize()
3918 if ( coInitialized_ )
3922 //=============================================================================
3924 unsigned int RtApiWasapi::getDeviceCount( void )
3926 unsigned int captureDeviceCount = 0;
3927 unsigned int renderDeviceCount = 0;
3929 IMMDeviceCollection* captureDevices = NULL;
3930 IMMDeviceCollection* renderDevices = NULL;
3932 // Count capture devices
3934 HRESULT hr = deviceEnumerator_->EnumAudioEndpoints( eCapture, DEVICE_STATE_ACTIVE, &captureDevices );
3935 if ( FAILED( hr ) ) {
3936 errorText_ = "RtApiWasapi::getDeviceCount: Unable to retrieve capture device collection.";
3940 hr = captureDevices->GetCount( &captureDeviceCount );
3941 if ( FAILED( hr ) ) {
3942 errorText_ = "RtApiWasapi::getDeviceCount: Unable to retrieve capture device count.";
3946 // Count render devices
3947 hr = deviceEnumerator_->EnumAudioEndpoints( eRender, DEVICE_STATE_ACTIVE, &renderDevices );
3948 if ( FAILED( hr ) ) {
3949 errorText_ = "RtApiWasapi::getDeviceCount: Unable to retrieve render device collection.";
3953 hr = renderDevices->GetCount( &renderDeviceCount );
3954 if ( FAILED( hr ) ) {
3955 errorText_ = "RtApiWasapi::getDeviceCount: Unable to retrieve render device count.";
3960 // release all references
3961 SAFE_RELEASE( captureDevices );
3962 SAFE_RELEASE( renderDevices );
3964 if ( errorText_.empty() )
3965 return captureDeviceCount + renderDeviceCount;
3967 error( RtAudioError::DRIVER_ERROR );
3971 //-----------------------------------------------------------------------------
3973 RtAudio::DeviceInfo RtApiWasapi::getDeviceInfo( unsigned int device )
3975 RtAudio::DeviceInfo info;
3976 unsigned int captureDeviceCount = 0;
3977 unsigned int renderDeviceCount = 0;
3978 std::string defaultDeviceName;
3979 bool isCaptureDevice = false;
3981 PROPVARIANT deviceNameProp;
3982 PROPVARIANT defaultDeviceNameProp;
3984 IMMDeviceCollection* captureDevices = NULL;
3985 IMMDeviceCollection* renderDevices = NULL;
3986 IMMDevice* devicePtr = NULL;
3987 IMMDevice* defaultDevicePtr = NULL;
3988 IAudioClient* audioClient = NULL;
3989 IPropertyStore* devicePropStore = NULL;
3990 IPropertyStore* defaultDevicePropStore = NULL;
3992 WAVEFORMATEX* deviceFormat = NULL;
3993 WAVEFORMATEX* closestMatchFormat = NULL;
3996 info.probed = false;
3998 // Count capture devices
4000 RtAudioError::Type errorType = RtAudioError::DRIVER_ERROR;
4001 HRESULT hr = deviceEnumerator_->EnumAudioEndpoints( eCapture, DEVICE_STATE_ACTIVE, &captureDevices );
4002 if ( FAILED( hr ) ) {
4003 errorText_ = "RtApiWasapi::getDeviceInfo: Unable to retrieve capture device collection.";
4007 hr = captureDevices->GetCount( &captureDeviceCount );
4008 if ( FAILED( hr ) ) {
4009 errorText_ = "RtApiWasapi::getDeviceInfo: Unable to retrieve capture device count.";
4013 // Count render devices
4014 hr = deviceEnumerator_->EnumAudioEndpoints( eRender, DEVICE_STATE_ACTIVE, &renderDevices );
4015 if ( FAILED( hr ) ) {
4016 errorText_ = "RtApiWasapi::getDeviceInfo: Unable to retrieve render device collection.";
4020 hr = renderDevices->GetCount( &renderDeviceCount );
4021 if ( FAILED( hr ) ) {
4022 errorText_ = "RtApiWasapi::getDeviceInfo: Unable to retrieve render device count.";
4026 // validate device index
4027 if ( device >= captureDeviceCount + renderDeviceCount ) {
4028 errorText_ = "RtApiWasapi::getDeviceInfo: Invalid device index.";
4029 errorType = RtAudioError::INVALID_USE;
4033 // determine whether index falls within capture or render devices
4034 if ( device >= renderDeviceCount ) {
4035 hr = captureDevices->Item( device - renderDeviceCount, &devicePtr );
4036 if ( FAILED( hr ) ) {
4037 errorText_ = "RtApiWasapi::getDeviceInfo: Unable to retrieve capture device handle.";
4040 isCaptureDevice = true;
4043 hr = renderDevices->Item( device, &devicePtr );
4044 if ( FAILED( hr ) ) {
4045 errorText_ = "RtApiWasapi::getDeviceInfo: Unable to retrieve render device handle.";
4048 isCaptureDevice = false;
4051 // get default device name
4052 if ( isCaptureDevice ) {
4053 hr = deviceEnumerator_->GetDefaultAudioEndpoint( eCapture, eConsole, &defaultDevicePtr );
4054 if ( FAILED( hr ) ) {
4055 errorText_ = "RtApiWasapi::getDeviceInfo: Unable to retrieve default capture device handle.";
4060 hr = deviceEnumerator_->GetDefaultAudioEndpoint( eRender, eConsole, &defaultDevicePtr );
4061 if ( FAILED( hr ) ) {
4062 errorText_ = "RtApiWasapi::getDeviceInfo: Unable to retrieve default render device handle.";
4067 hr = defaultDevicePtr->OpenPropertyStore( STGM_READ, &defaultDevicePropStore );
4068 if ( FAILED( hr ) ) {
4069 errorText_ = "RtApiWasapi::getDeviceInfo: Unable to open default device property store.";
4072 PropVariantInit( &defaultDeviceNameProp );
4074 hr = defaultDevicePropStore->GetValue( PKEY_Device_FriendlyName, &defaultDeviceNameProp );
4075 if ( FAILED( hr ) ) {
4076 errorText_ = "RtApiWasapi::getDeviceInfo: Unable to retrieve default device property: PKEY_Device_FriendlyName.";
4080 defaultDeviceName = convertCharPointerToStdString(defaultDeviceNameProp.pwszVal);
4083 hr = devicePtr->OpenPropertyStore( STGM_READ, &devicePropStore );
4084 if ( FAILED( hr ) ) {
4085 errorText_ = "RtApiWasapi::getDeviceInfo: Unable to open device property store.";
4089 PropVariantInit( &deviceNameProp );
4091 hr = devicePropStore->GetValue( PKEY_Device_FriendlyName, &deviceNameProp );
4092 if ( FAILED( hr ) ) {
4093 errorText_ = "RtApiWasapi::getDeviceInfo: Unable to retrieve device property: PKEY_Device_FriendlyName.";
4097 info.name =convertCharPointerToStdString(deviceNameProp.pwszVal);
4100 if ( isCaptureDevice ) {
4101 info.isDefaultInput = info.name == defaultDeviceName;
4102 info.isDefaultOutput = false;
4105 info.isDefaultInput = false;
4106 info.isDefaultOutput = info.name == defaultDeviceName;
4110 hr = devicePtr->Activate( __uuidof( IAudioClient ), CLSCTX_ALL, NULL, ( void** ) &audioClient );
4111 if ( FAILED( hr ) ) {
4112 errorText_ = "RtApiWasapi::getDeviceInfo: Unable to retrieve device audio client.";
4116 hr = audioClient->GetMixFormat( &deviceFormat );
4117 if ( FAILED( hr ) ) {
4118 errorText_ = "RtApiWasapi::getDeviceInfo: Unable to retrieve device mix format.";
4122 if ( isCaptureDevice ) {
4123 info.inputChannels = deviceFormat->nChannels;
4124 info.outputChannels = 0;
4125 info.duplexChannels = 0;
4128 info.inputChannels = 0;
4129 info.outputChannels = deviceFormat->nChannels;
4130 info.duplexChannels = 0;
4133 // sample rates (WASAPI only supports the one native sample rate)
4134 info.preferredSampleRate = deviceFormat->nSamplesPerSec;
4136 info.sampleRates.clear();
4137 info.sampleRates.push_back( deviceFormat->nSamplesPerSec );
4140 info.nativeFormats = 0;
4142 if ( deviceFormat->wFormatTag == WAVE_FORMAT_IEEE_FLOAT ||
4143 ( deviceFormat->wFormatTag == WAVE_FORMAT_EXTENSIBLE &&
4144 ( ( WAVEFORMATEXTENSIBLE* ) deviceFormat )->SubFormat == KSDATAFORMAT_SUBTYPE_IEEE_FLOAT ) )
4146 if ( deviceFormat->wBitsPerSample == 32 ) {
4147 info.nativeFormats |= RTAUDIO_FLOAT32;
4149 else if ( deviceFormat->wBitsPerSample == 64 ) {
4150 info.nativeFormats |= RTAUDIO_FLOAT64;
4153 else if ( deviceFormat->wFormatTag == WAVE_FORMAT_PCM ||
4154 ( deviceFormat->wFormatTag == WAVE_FORMAT_EXTENSIBLE &&
4155 ( ( WAVEFORMATEXTENSIBLE* ) deviceFormat )->SubFormat == KSDATAFORMAT_SUBTYPE_PCM ) )
4157 if ( deviceFormat->wBitsPerSample == 8 ) {
4158 info.nativeFormats |= RTAUDIO_SINT8;
4160 else if ( deviceFormat->wBitsPerSample == 16 ) {
4161 info.nativeFormats |= RTAUDIO_SINT16;
4163 else if ( deviceFormat->wBitsPerSample == 24 ) {
4164 info.nativeFormats |= RTAUDIO_SINT24;
4166 else if ( deviceFormat->wBitsPerSample == 32 ) {
4167 info.nativeFormats |= RTAUDIO_SINT32;
4175 // release all references
4176 PropVariantClear( &deviceNameProp );
4177 PropVariantClear( &defaultDeviceNameProp );
4179 SAFE_RELEASE( captureDevices );
4180 SAFE_RELEASE( renderDevices );
4181 SAFE_RELEASE( devicePtr );
4182 SAFE_RELEASE( defaultDevicePtr );
4183 SAFE_RELEASE( audioClient );
4184 SAFE_RELEASE( devicePropStore );
4185 SAFE_RELEASE( defaultDevicePropStore );
4187 CoTaskMemFree( deviceFormat );
4188 CoTaskMemFree( closestMatchFormat );
4190 if ( !errorText_.empty() )
4195 //-----------------------------------------------------------------------------
4197 unsigned int RtApiWasapi::getDefaultOutputDevice( void )
4199 for ( unsigned int i = 0; i < getDeviceCount(); i++ ) {
4200 if ( getDeviceInfo( i ).isDefaultOutput ) {
4208 //-----------------------------------------------------------------------------
4210 unsigned int RtApiWasapi::getDefaultInputDevice( void )
4212 for ( unsigned int i = 0; i < getDeviceCount(); i++ ) {
4213 if ( getDeviceInfo( i ).isDefaultInput ) {
4221 //-----------------------------------------------------------------------------
4223 void RtApiWasapi::closeStream( void )
4225 if ( stream_.state == STREAM_CLOSED ) {
4226 errorText_ = "RtApiWasapi::closeStream: No open stream to close.";
4227 error( RtAudioError::WARNING );
4231 if ( stream_.state != STREAM_STOPPED )
4234 // clean up stream memory
4235 SAFE_RELEASE( ( ( WasapiHandle* ) stream_.apiHandle )->captureAudioClient )
4236 SAFE_RELEASE( ( ( WasapiHandle* ) stream_.apiHandle )->renderAudioClient )
4238 SAFE_RELEASE( ( ( WasapiHandle* ) stream_.apiHandle )->captureClient )
4239 SAFE_RELEASE( ( ( WasapiHandle* ) stream_.apiHandle )->renderClient )
4241 if ( ( ( WasapiHandle* ) stream_.apiHandle )->captureEvent )
4242 CloseHandle( ( ( WasapiHandle* ) stream_.apiHandle )->captureEvent );
4244 if ( ( ( WasapiHandle* ) stream_.apiHandle )->renderEvent )
4245 CloseHandle( ( ( WasapiHandle* ) stream_.apiHandle )->renderEvent );
4247 delete ( WasapiHandle* ) stream_.apiHandle;
4248 stream_.apiHandle = NULL;
4250 for ( int i = 0; i < 2; i++ ) {
4251 if ( stream_.userBuffer[i] ) {
4252 free( stream_.userBuffer[i] );
4253 stream_.userBuffer[i] = 0;
4257 if ( stream_.deviceBuffer ) {
4258 free( stream_.deviceBuffer );
4259 stream_.deviceBuffer = 0;
4262 // update stream state
4263 stream_.state = STREAM_CLOSED;
4266 //-----------------------------------------------------------------------------
4268 void RtApiWasapi::startStream( void )
4272 if ( stream_.state == STREAM_RUNNING ) {
4273 errorText_ = "RtApiWasapi::startStream: The stream is already running.";
4274 error( RtAudioError::WARNING );
4278 // update stream state
4279 stream_.state = STREAM_RUNNING;
4281 // create WASAPI stream thread
4282 stream_.callbackInfo.thread = ( ThreadHandle ) CreateThread( NULL, 0, runWasapiThread, this, CREATE_SUSPENDED, NULL );
4284 if ( !stream_.callbackInfo.thread ) {
4285 errorText_ = "RtApiWasapi::startStream: Unable to instantiate callback thread.";
4286 error( RtAudioError::THREAD_ERROR );
4289 SetThreadPriority( ( void* ) stream_.callbackInfo.thread, stream_.callbackInfo.priority );
4290 ResumeThread( ( void* ) stream_.callbackInfo.thread );
4294 //-----------------------------------------------------------------------------
4296 void RtApiWasapi::stopStream( void )
4300 if ( stream_.state == STREAM_STOPPED ) {
4301 errorText_ = "RtApiWasapi::stopStream: The stream is already stopped.";
4302 error( RtAudioError::WARNING );
4306 // inform stream thread by setting stream state to STREAM_STOPPING
4307 stream_.state = STREAM_STOPPING;
4309 // wait until stream thread is stopped
4310 while( stream_.state != STREAM_STOPPED ) {
4314 // Wait for the last buffer to play before stopping.
4315 Sleep( 1000 * stream_.bufferSize / stream_.sampleRate );
4317 // stop capture client if applicable
4318 if ( ( ( WasapiHandle* ) stream_.apiHandle )->captureAudioClient ) {
4319 HRESULT hr = ( ( WasapiHandle* ) stream_.apiHandle )->captureAudioClient->Stop();
4320 if ( FAILED( hr ) ) {
4321 errorText_ = "RtApiWasapi::stopStream: Unable to stop capture stream.";
4322 error( RtAudioError::DRIVER_ERROR );
4327 // stop render client if applicable
4328 if ( ( ( WasapiHandle* ) stream_.apiHandle )->renderAudioClient ) {
4329 HRESULT hr = ( ( WasapiHandle* ) stream_.apiHandle )->renderAudioClient->Stop();
4330 if ( FAILED( hr ) ) {
4331 errorText_ = "RtApiWasapi::stopStream: Unable to stop render stream.";
4332 error( RtAudioError::DRIVER_ERROR );
4337 // close thread handle
4338 if ( stream_.callbackInfo.thread && !CloseHandle( ( void* ) stream_.callbackInfo.thread ) ) {
4339 errorText_ = "RtApiWasapi::stopStream: Unable to close callback thread.";
4340 error( RtAudioError::THREAD_ERROR );
4344 stream_.callbackInfo.thread = (ThreadHandle) NULL;
4347 //-----------------------------------------------------------------------------
4349 void RtApiWasapi::abortStream( void )
4353 if ( stream_.state == STREAM_STOPPED ) {
4354 errorText_ = "RtApiWasapi::abortStream: The stream is already stopped.";
4355 error( RtAudioError::WARNING );
4359 // inform stream thread by setting stream state to STREAM_STOPPING
4360 stream_.state = STREAM_STOPPING;
4362 // wait until stream thread is stopped
4363 while ( stream_.state != STREAM_STOPPED ) {
4367 // stop capture client if applicable
4368 if ( ( ( WasapiHandle* ) stream_.apiHandle )->captureAudioClient ) {
4369 HRESULT hr = ( ( WasapiHandle* ) stream_.apiHandle )->captureAudioClient->Stop();
4370 if ( FAILED( hr ) ) {
4371 errorText_ = "RtApiWasapi::abortStream: Unable to stop capture stream.";
4372 error( RtAudioError::DRIVER_ERROR );
4377 // stop render client if applicable
4378 if ( ( ( WasapiHandle* ) stream_.apiHandle )->renderAudioClient ) {
4379 HRESULT hr = ( ( WasapiHandle* ) stream_.apiHandle )->renderAudioClient->Stop();
4380 if ( FAILED( hr ) ) {
4381 errorText_ = "RtApiWasapi::abortStream: Unable to stop render stream.";
4382 error( RtAudioError::DRIVER_ERROR );
4387 // close thread handle
4388 if ( stream_.callbackInfo.thread && !CloseHandle( ( void* ) stream_.callbackInfo.thread ) ) {
4389 errorText_ = "RtApiWasapi::abortStream: Unable to close callback thread.";
4390 error( RtAudioError::THREAD_ERROR );
4394 stream_.callbackInfo.thread = (ThreadHandle) NULL;
4397 //-----------------------------------------------------------------------------
4399 bool RtApiWasapi::probeDeviceOpen( unsigned int device, StreamMode mode, unsigned int channels,
4400 unsigned int firstChannel, unsigned int sampleRate,
4401 RtAudioFormat format, unsigned int* bufferSize,
4402 RtAudio::StreamOptions* options )
4404 bool methodResult = FAILURE;
4405 unsigned int captureDeviceCount = 0;
4406 unsigned int renderDeviceCount = 0;
4408 IMMDeviceCollection* captureDevices = NULL;
4409 IMMDeviceCollection* renderDevices = NULL;
4410 IMMDevice* devicePtr = NULL;
4411 WAVEFORMATEX* deviceFormat = NULL;
4412 unsigned int bufferBytes;
4413 stream_.state = STREAM_STOPPED;
4414 RtAudio::DeviceInfo deviceInfo;
4416 // create API Handle if not already created
4417 if ( !stream_.apiHandle )
4418 stream_.apiHandle = ( void* ) new WasapiHandle();
4420 // Count capture devices
4422 RtAudioError::Type errorType = RtAudioError::DRIVER_ERROR;
4423 HRESULT hr = deviceEnumerator_->EnumAudioEndpoints( eCapture, DEVICE_STATE_ACTIVE, &captureDevices );
4424 if ( FAILED( hr ) ) {
4425 errorText_ = "RtApiWasapi::probeDeviceOpen: Unable to retrieve capture device collection.";
4429 hr = captureDevices->GetCount( &captureDeviceCount );
4430 if ( FAILED( hr ) ) {
4431 errorText_ = "RtApiWasapi::probeDeviceOpen: Unable to retrieve capture device count.";
4435 // Count render devices
4436 hr = deviceEnumerator_->EnumAudioEndpoints( eRender, DEVICE_STATE_ACTIVE, &renderDevices );
4437 if ( FAILED( hr ) ) {
4438 errorText_ = "RtApiWasapi::probeDeviceOpen: Unable to retrieve render device collection.";
4442 hr = renderDevices->GetCount( &renderDeviceCount );
4443 if ( FAILED( hr ) ) {
4444 errorText_ = "RtApiWasapi::probeDeviceOpen: Unable to retrieve render device count.";
4448 // validate device index
4449 if ( device >= captureDeviceCount + renderDeviceCount ) {
4450 errorType = RtAudioError::INVALID_USE;
4451 errorText_ = "RtApiWasapi::probeDeviceOpen: Invalid device index.";
4455 deviceInfo = getDeviceInfo( device );
4457 // validate sample rate
4458 if ( sampleRate != deviceInfo.preferredSampleRate )
4460 errorType = RtAudioError::INVALID_USE;
4461 std::stringstream ss;
4462 ss << "RtApiWasapi::probeDeviceOpen: " << sampleRate
4463 << "Hz sample rate not supported. This device only supports "
4464 << deviceInfo.preferredSampleRate << "Hz.";
4465 errorText_ = ss.str();
4469 // determine whether index falls within capture or render devices
4470 if ( device >= renderDeviceCount ) {
4471 if ( mode != INPUT ) {
4472 errorType = RtAudioError::INVALID_USE;
4473 errorText_ = "RtApiWasapi::probeDeviceOpen: Capture device selected as output device.";
4477 // retrieve captureAudioClient from devicePtr
4478 IAudioClient*& captureAudioClient = ( ( WasapiHandle* ) stream_.apiHandle )->captureAudioClient;
4480 hr = captureDevices->Item( device - renderDeviceCount, &devicePtr );
4481 if ( FAILED( hr ) ) {
4482 errorText_ = "RtApiWasapi::probeDeviceOpen: Unable to retrieve capture device handle.";
4486 hr = devicePtr->Activate( __uuidof( IAudioClient ), CLSCTX_ALL,
4487 NULL, ( void** ) &captureAudioClient );
4488 if ( FAILED( hr ) ) {
4489 errorText_ = "RtApiWasapi::probeDeviceOpen: Unable to retrieve device audio client.";
4493 hr = captureAudioClient->GetMixFormat( &deviceFormat );
4494 if ( FAILED( hr ) ) {
4495 errorText_ = "RtApiWasapi::probeDeviceOpen: Unable to retrieve device mix format.";
4499 stream_.nDeviceChannels[mode] = deviceFormat->nChannels;
4500 captureAudioClient->GetStreamLatency( ( long long* ) &stream_.latency[mode] );
4503 if ( mode != OUTPUT ) {
4504 errorType = RtAudioError::INVALID_USE;
4505 errorText_ = "RtApiWasapi::probeDeviceOpen: Render device selected as input device.";
4509 // retrieve renderAudioClient from devicePtr
4510 IAudioClient*& renderAudioClient = ( ( WasapiHandle* ) stream_.apiHandle )->renderAudioClient;
4512 hr = renderDevices->Item( device, &devicePtr );
4513 if ( FAILED( hr ) ) {
4514 errorText_ = "RtApiWasapi::probeDeviceOpen: Unable to retrieve render device handle.";
4518 hr = devicePtr->Activate( __uuidof( IAudioClient ), CLSCTX_ALL,
4519 NULL, ( void** ) &renderAudioClient );
4520 if ( FAILED( hr ) ) {
4521 errorText_ = "RtApiWasapi::probeDeviceOpen: Unable to retrieve device audio client.";
4525 hr = renderAudioClient->GetMixFormat( &deviceFormat );
4526 if ( FAILED( hr ) ) {
4527 errorText_ = "RtApiWasapi::probeDeviceOpen: Unable to retrieve device mix format.";
4531 stream_.nDeviceChannels[mode] = deviceFormat->nChannels;
4532 renderAudioClient->GetStreamLatency( ( long long* ) &stream_.latency[mode] );
4536 if ( ( stream_.mode == OUTPUT && mode == INPUT ) ||
4537 ( stream_.mode == INPUT && mode == OUTPUT ) ) {
4538 stream_.mode = DUPLEX;
4541 stream_.mode = mode;
4544 stream_.device[mode] = device;
4545 stream_.doByteSwap[mode] = false;
4546 stream_.sampleRate = sampleRate;
4547 stream_.bufferSize = *bufferSize;
4548 stream_.nBuffers = 1;
4549 stream_.nUserChannels[mode] = channels;
4550 stream_.channelOffset[mode] = firstChannel;
4551 stream_.userFormat = format;
4552 stream_.deviceFormat[mode] = deviceInfo.nativeFormats;
4554 if ( options && options->flags & RTAUDIO_NONINTERLEAVED )
4555 stream_.userInterleaved = false;
4557 stream_.userInterleaved = true;
4558 stream_.deviceInterleaved[mode] = true;
4560 // Set flags for buffer conversion.
4561 stream_.doConvertBuffer[mode] = false;
4562 if ( stream_.userFormat != stream_.deviceFormat[mode] ||
4563 stream_.nUserChannels != stream_.nDeviceChannels )
4564 stream_.doConvertBuffer[mode] = true;
4565 else if ( stream_.userInterleaved != stream_.deviceInterleaved[mode] &&
4566 stream_.nUserChannels[mode] > 1 )
4567 stream_.doConvertBuffer[mode] = true;
4569 if ( stream_.doConvertBuffer[mode] )
4570 setConvertInfo( mode, 0 );
4572 // Allocate necessary internal buffers
4573 bufferBytes = stream_.nUserChannels[mode] * stream_.bufferSize * formatBytes( stream_.userFormat );
4575 stream_.userBuffer[mode] = ( char* ) calloc( bufferBytes, 1 );
4576 if ( !stream_.userBuffer[mode] ) {
4577 errorType = RtAudioError::MEMORY_ERROR;
4578 errorText_ = "RtApiWasapi::probeDeviceOpen: Error allocating user buffer memory.";
4582 if ( options && options->flags & RTAUDIO_SCHEDULE_REALTIME )
4583 stream_.callbackInfo.priority = 15;
4585 stream_.callbackInfo.priority = 0;
4587 ///! TODO: RTAUDIO_MINIMIZE_LATENCY // Provide stream buffers directly to callback
4588 ///! TODO: RTAUDIO_HOG_DEVICE // Exclusive mode
4590 methodResult = SUCCESS;
4594 SAFE_RELEASE( captureDevices );
4595 SAFE_RELEASE( renderDevices );
4596 SAFE_RELEASE( devicePtr );
4597 CoTaskMemFree( deviceFormat );
4599 // if method failed, close the stream
4600 if ( methodResult == FAILURE )
4603 if ( !errorText_.empty() )
4605 return methodResult;
4608 //=============================================================================
4610 DWORD WINAPI RtApiWasapi::runWasapiThread( void* wasapiPtr )
4613 ( ( RtApiWasapi* ) wasapiPtr )->wasapiThread();
4618 DWORD WINAPI RtApiWasapi::stopWasapiThread( void* wasapiPtr )
4621 ( ( RtApiWasapi* ) wasapiPtr )->stopStream();
4626 DWORD WINAPI RtApiWasapi::abortWasapiThread( void* wasapiPtr )
4629 ( ( RtApiWasapi* ) wasapiPtr )->abortStream();
4634 //-----------------------------------------------------------------------------
4636 void RtApiWasapi::wasapiThread()
4638 // as this is a new thread, we must CoInitialize it
4639 CoInitialize( NULL );
4643 IAudioClient* captureAudioClient = ( ( WasapiHandle* ) stream_.apiHandle )->captureAudioClient;
4644 IAudioClient* renderAudioClient = ( ( WasapiHandle* ) stream_.apiHandle )->renderAudioClient;
4645 IAudioCaptureClient* captureClient = ( ( WasapiHandle* ) stream_.apiHandle )->captureClient;
4646 IAudioRenderClient* renderClient = ( ( WasapiHandle* ) stream_.apiHandle )->renderClient;
4647 HANDLE captureEvent = ( ( WasapiHandle* ) stream_.apiHandle )->captureEvent;
4648 HANDLE renderEvent = ( ( WasapiHandle* ) stream_.apiHandle )->renderEvent;
4650 WAVEFORMATEX* captureFormat = NULL;
4651 WAVEFORMATEX* renderFormat = NULL;
4652 WasapiBuffer captureBuffer;
4653 WasapiBuffer renderBuffer;
4655 // declare local stream variables
4656 RtAudioCallback callback = ( RtAudioCallback ) stream_.callbackInfo.callback;
4657 BYTE* streamBuffer = NULL;
4658 unsigned long captureFlags = 0;
4659 unsigned int bufferFrameCount = 0;
4660 unsigned int numFramesPadding = 0;
4661 bool callbackPushed = false;
4662 bool callbackPulled = false;
4663 bool callbackStopped = false;
4664 int callbackResult = 0;
4666 unsigned int deviceBuffSize = 0;
4669 RtAudioError::Type errorType = RtAudioError::DRIVER_ERROR;
4671 // Attempt to assign "Pro Audio" characteristic to thread
4672 HMODULE AvrtDll = LoadLibrary( (LPCTSTR) "AVRT.dll" );
4674 DWORD taskIndex = 0;
4675 TAvSetMmThreadCharacteristicsPtr AvSetMmThreadCharacteristicsPtr = ( TAvSetMmThreadCharacteristicsPtr ) GetProcAddress( AvrtDll, "AvSetMmThreadCharacteristicsW" );
4676 AvSetMmThreadCharacteristicsPtr( L"Pro Audio", &taskIndex );
4677 FreeLibrary( AvrtDll );
4680 // start capture stream if applicable
4681 if ( captureAudioClient ) {
4682 hr = captureAudioClient->GetMixFormat( &captureFormat );
4683 if ( FAILED( hr ) ) {
4684 errorText_ = "RtApiWasapi::wasapiThread: Unable to retrieve device mix format.";
4688 // initialize capture stream according to desire buffer size
4689 REFERENCE_TIME desiredBufferPeriod = ( REFERENCE_TIME ) ( ( float ) stream_.bufferSize * 10000000 / captureFormat->nSamplesPerSec );
4691 if ( !captureClient ) {
4692 hr = captureAudioClient->Initialize( AUDCLNT_SHAREMODE_SHARED,
4693 AUDCLNT_STREAMFLAGS_EVENTCALLBACK,
4694 desiredBufferPeriod,
4695 desiredBufferPeriod,
4698 if ( FAILED( hr ) ) {
4699 errorText_ = "RtApiWasapi::wasapiThread: Unable to initialize capture audio client.";
4703 hr = captureAudioClient->GetService( __uuidof( IAudioCaptureClient ),
4704 ( void** ) &captureClient );
4705 if ( FAILED( hr ) ) {
4706 errorText_ = "RtApiWasapi::wasapiThread: Unable to retrieve capture client handle.";
4710 // configure captureEvent to trigger on every available capture buffer
4711 captureEvent = CreateEvent( NULL, FALSE, FALSE, NULL );
4712 if ( !captureEvent ) {
4713 errorType = RtAudioError::SYSTEM_ERROR;
4714 errorText_ = "RtApiWasapi::wasapiThread: Unable to create capture event.";
4718 hr = captureAudioClient->SetEventHandle( captureEvent );
4719 if ( FAILED( hr ) ) {
4720 errorText_ = "RtApiWasapi::wasapiThread: Unable to set capture event handle.";
4724 ( ( WasapiHandle* ) stream_.apiHandle )->captureClient = captureClient;
4725 ( ( WasapiHandle* ) stream_.apiHandle )->captureEvent = captureEvent;
4728 unsigned int inBufferSize = 0;
4729 hr = captureAudioClient->GetBufferSize( &inBufferSize );
4730 if ( FAILED( hr ) ) {
4731 errorText_ = "RtApiWasapi::wasapiThread: Unable to get capture buffer size.";
4735 // scale outBufferSize according to stream->user sample rate ratio
4736 unsigned int outBufferSize = ( unsigned int ) stream_.bufferSize * stream_.nDeviceChannels[INPUT];
4737 inBufferSize *= stream_.nDeviceChannels[INPUT];
4739 // set captureBuffer size
4740 captureBuffer.setBufferSize( inBufferSize + outBufferSize, formatBytes( stream_.deviceFormat[INPUT] ) );
4742 // reset the capture stream
4743 hr = captureAudioClient->Reset();
4744 if ( FAILED( hr ) ) {
4745 errorText_ = "RtApiWasapi::wasapiThread: Unable to reset capture stream.";
4749 // start the capture stream
4750 hr = captureAudioClient->Start();
4751 if ( FAILED( hr ) ) {
4752 errorText_ = "RtApiWasapi::wasapiThread: Unable to start capture stream.";
4757 // start render stream if applicable
4758 if ( renderAudioClient ) {
4759 hr = renderAudioClient->GetMixFormat( &renderFormat );
4760 if ( FAILED( hr ) ) {
4761 errorText_ = "RtApiWasapi::wasapiThread: Unable to retrieve device mix format.";
4765 // initialize render stream according to desire buffer size
4766 REFERENCE_TIME desiredBufferPeriod = ( REFERENCE_TIME ) ( ( float ) stream_.bufferSize * 10000000 / renderFormat->nSamplesPerSec );
4768 if ( !renderClient ) {
4769 hr = renderAudioClient->Initialize( AUDCLNT_SHAREMODE_SHARED,
4770 AUDCLNT_STREAMFLAGS_EVENTCALLBACK,
4771 desiredBufferPeriod,
4772 desiredBufferPeriod,
4775 if ( FAILED( hr ) ) {
4776 errorText_ = "RtApiWasapi::wasapiThread: Unable to initialize render audio client.";
4780 hr = renderAudioClient->GetService( __uuidof( IAudioRenderClient ),
4781 ( void** ) &renderClient );
4782 if ( FAILED( hr ) ) {
4783 errorText_ = "RtApiWasapi::wasapiThread: Unable to retrieve render client handle.";
4787 // configure renderEvent to trigger on every available render buffer
4788 renderEvent = CreateEvent( NULL, FALSE, FALSE, NULL );
4789 if ( !renderEvent ) {
4790 errorType = RtAudioError::SYSTEM_ERROR;
4791 errorText_ = "RtApiWasapi::wasapiThread: Unable to create render event.";
4795 hr = renderAudioClient->SetEventHandle( renderEvent );
4796 if ( FAILED( hr ) ) {
4797 errorText_ = "RtApiWasapi::wasapiThread: Unable to set render event handle.";
4801 ( ( WasapiHandle* ) stream_.apiHandle )->renderClient = renderClient;
4802 ( ( WasapiHandle* ) stream_.apiHandle )->renderEvent = renderEvent;
4805 unsigned int outBufferSize = 0;
4806 hr = renderAudioClient->GetBufferSize( &outBufferSize );
4807 if ( FAILED( hr ) ) {
4808 errorText_ = "RtApiWasapi::wasapiThread: Unable to get render buffer size.";
4812 // scale inBufferSize according to user->stream sample rate ratio
4813 unsigned int inBufferSize = ( unsigned int ) stream_.bufferSize * stream_.nDeviceChannels[OUTPUT];
4814 outBufferSize *= stream_.nDeviceChannels[OUTPUT];
4816 // set renderBuffer size
4817 renderBuffer.setBufferSize( inBufferSize + outBufferSize, formatBytes( stream_.deviceFormat[OUTPUT] ) );
4819 // reset the render stream
4820 hr = renderAudioClient->Reset();
4821 if ( FAILED( hr ) ) {
4822 errorText_ = "RtApiWasapi::wasapiThread: Unable to reset render stream.";
4826 // start the render stream
4827 hr = renderAudioClient->Start();
4828 if ( FAILED( hr ) ) {
4829 errorText_ = "RtApiWasapi::wasapiThread: Unable to start render stream.";
4834 if ( stream_.mode == INPUT ) {
4835 using namespace std; // for roundf
4836 deviceBuffSize = stream_.bufferSize * stream_.nDeviceChannels[INPUT] * formatBytes( stream_.deviceFormat[INPUT] );
4838 else if ( stream_.mode == OUTPUT ) {
4839 deviceBuffSize = stream_.bufferSize * stream_.nDeviceChannels[OUTPUT] * formatBytes( stream_.deviceFormat[OUTPUT] );
4841 else if ( stream_.mode == DUPLEX ) {
4842 deviceBuffSize = std::max( stream_.bufferSize * stream_.nDeviceChannels[INPUT] * formatBytes( stream_.deviceFormat[INPUT] ),
4843 stream_.bufferSize * stream_.nDeviceChannels[OUTPUT] * formatBytes( stream_.deviceFormat[OUTPUT] ) );
4846 stream_.deviceBuffer = ( char* ) malloc( deviceBuffSize );
4847 if ( !stream_.deviceBuffer ) {
4848 errorType = RtAudioError::MEMORY_ERROR;
4849 errorText_ = "RtApiWasapi::wasapiThread: Error allocating device buffer memory.";
4853 // stream process loop
4854 while ( stream_.state != STREAM_STOPPING ) {
4855 if ( !callbackPulled ) {
4858 // 1. Pull callback buffer from inputBuffer
4859 // 2. If 1. was successful: Convert callback buffer to user format
4861 if ( captureAudioClient ) {
4862 // Pull callback buffer from inputBuffer
4863 callbackPulled = captureBuffer.pullBuffer( stream_.deviceBuffer,
4864 ( unsigned int ) stream_.bufferSize * stream_.nDeviceChannels[INPUT],
4865 stream_.deviceFormat[INPUT] );
4867 if ( callbackPulled ) {
4868 if ( stream_.doConvertBuffer[INPUT] ) {
4869 // Convert callback buffer to user format
4870 convertBuffer( stream_.userBuffer[INPUT],
4871 stream_.deviceBuffer,
4872 stream_.convertInfo[INPUT] );
4875 // no further conversion, simple copy deviceBuffer to userBuffer
4876 memcpy( stream_.userBuffer[INPUT],
4877 stream_.deviceBuffer,
4878 stream_.bufferSize * stream_.nUserChannels[INPUT] * formatBytes( stream_.userFormat ) );
4883 // if there is no capture stream, set callbackPulled flag
4884 callbackPulled = true;
4889 // 1. Execute user callback method
4890 // 2. Handle return value from callback
4892 // if callback has not requested the stream to stop
4893 if ( callbackPulled && !callbackStopped ) {
4894 // Execute user callback method
4895 callbackResult = callback( stream_.userBuffer[OUTPUT],
4896 stream_.userBuffer[INPUT],
4899 captureFlags & AUDCLNT_BUFFERFLAGS_DATA_DISCONTINUITY ? RTAUDIO_INPUT_OVERFLOW : 0,
4900 stream_.callbackInfo.userData );
4902 // Handle return value from callback
4903 if ( callbackResult == 1 ) {
4904 // instantiate a thread to stop this thread
4905 HANDLE threadHandle = CreateThread( NULL, 0, stopWasapiThread, this, 0, NULL );
4906 if ( !threadHandle ) {
4907 errorType = RtAudioError::THREAD_ERROR;
4908 errorText_ = "RtApiWasapi::wasapiThread: Unable to instantiate stream stop thread.";
4911 else if ( !CloseHandle( threadHandle ) ) {
4912 errorType = RtAudioError::THREAD_ERROR;
4913 errorText_ = "RtApiWasapi::wasapiThread: Unable to close stream stop thread handle.";
4917 callbackStopped = true;
4919 else if ( callbackResult == 2 ) {
4920 // instantiate a thread to stop this thread
4921 HANDLE threadHandle = CreateThread( NULL, 0, abortWasapiThread, this, 0, NULL );
4922 if ( !threadHandle ) {
4923 errorType = RtAudioError::THREAD_ERROR;
4924 errorText_ = "RtApiWasapi::wasapiThread: Unable to instantiate stream abort thread.";
4927 else if ( !CloseHandle( threadHandle ) ) {
4928 errorType = RtAudioError::THREAD_ERROR;
4929 errorText_ = "RtApiWasapi::wasapiThread: Unable to close stream abort thread handle.";
4933 callbackStopped = true;
4940 // 1. Convert callback buffer to stream format
4941 // 2. Push callback buffer into outputBuffer
4943 if ( renderAudioClient && callbackPulled ) {
4944 if ( stream_.doConvertBuffer[OUTPUT] ) {
4945 // Convert callback buffer to stream format
4946 convertBuffer( stream_.deviceBuffer,
4947 stream_.userBuffer[OUTPUT],
4948 stream_.convertInfo[OUTPUT] );
4952 // Push callback buffer into outputBuffer
4953 callbackPushed = renderBuffer.pushBuffer( stream_.deviceBuffer,
4954 stream_.bufferSize * stream_.nDeviceChannels[OUTPUT],
4955 stream_.deviceFormat[OUTPUT] );
4958 // if there is no render stream, set callbackPushed flag
4959 callbackPushed = true;
4964 // 1. Get capture buffer from stream
4965 // 2. Push capture buffer into inputBuffer
4966 // 3. If 2. was successful: Release capture buffer
4968 if ( captureAudioClient ) {
4969 // if the callback input buffer was not pulled from captureBuffer, wait for next capture event
4970 if ( !callbackPulled ) {
4971 WaitForSingleObject( captureEvent, INFINITE );
4974 // Get capture buffer from stream
4975 hr = captureClient->GetBuffer( &streamBuffer,
4977 &captureFlags, NULL, NULL );
4978 if ( FAILED( hr ) ) {
4979 errorText_ = "RtApiWasapi::wasapiThread: Unable to retrieve capture buffer.";
4983 if ( bufferFrameCount != 0 ) {
4984 // Push capture buffer into inputBuffer
4985 if ( captureBuffer.pushBuffer( ( char* ) streamBuffer,
4986 bufferFrameCount * stream_.nDeviceChannels[INPUT],
4987 stream_.deviceFormat[INPUT] ) )
4989 // Release capture buffer
4990 hr = captureClient->ReleaseBuffer( bufferFrameCount );
4991 if ( FAILED( hr ) ) {
4992 errorText_ = "RtApiWasapi::wasapiThread: Unable to release capture buffer.";
4998 // Inform WASAPI that capture was unsuccessful
4999 hr = captureClient->ReleaseBuffer( 0 );
5000 if ( FAILED( hr ) ) {
5001 errorText_ = "RtApiWasapi::wasapiThread: Unable to release capture buffer.";
5008 // Inform WASAPI that capture was unsuccessful
5009 hr = captureClient->ReleaseBuffer( 0 );
5010 if ( FAILED( hr ) ) {
5011 errorText_ = "RtApiWasapi::wasapiThread: Unable to release capture buffer.";
5019 // 1. Get render buffer from stream
5020 // 2. Pull next buffer from outputBuffer
5021 // 3. If 2. was successful: Fill render buffer with next buffer
5022 // Release render buffer
5024 if ( renderAudioClient ) {
5025 // if the callback output buffer was not pushed to renderBuffer, wait for next render event
5026 if ( callbackPulled && !callbackPushed ) {
5027 WaitForSingleObject( renderEvent, INFINITE );
5030 // Get render buffer from stream
5031 hr = renderAudioClient->GetBufferSize( &bufferFrameCount );
5032 if ( FAILED( hr ) ) {
5033 errorText_ = "RtApiWasapi::wasapiThread: Unable to retrieve render buffer size.";
5037 hr = renderAudioClient->GetCurrentPadding( &numFramesPadding );
5038 if ( FAILED( hr ) ) {
5039 errorText_ = "RtApiWasapi::wasapiThread: Unable to retrieve render buffer padding.";
5043 bufferFrameCount -= numFramesPadding;
5045 if ( bufferFrameCount != 0 ) {
5046 hr = renderClient->GetBuffer( bufferFrameCount, &streamBuffer );
5047 if ( FAILED( hr ) ) {
5048 errorText_ = "RtApiWasapi::wasapiThread: Unable to retrieve render buffer.";
5052 // Pull next buffer from outputBuffer
5053 // Fill render buffer with next buffer
5054 if ( renderBuffer.pullBuffer( ( char* ) streamBuffer,
5055 bufferFrameCount * stream_.nDeviceChannels[OUTPUT],
5056 stream_.deviceFormat[OUTPUT] ) )
5058 // Release render buffer
5059 hr = renderClient->ReleaseBuffer( bufferFrameCount, 0 );
5060 if ( FAILED( hr ) ) {
5061 errorText_ = "RtApiWasapi::wasapiThread: Unable to release render buffer.";
5067 // Inform WASAPI that render was unsuccessful
5068 hr = renderClient->ReleaseBuffer( 0, 0 );
5069 if ( FAILED( hr ) ) {
5070 errorText_ = "RtApiWasapi::wasapiThread: Unable to release render buffer.";
5077 // Inform WASAPI that render was unsuccessful
5078 hr = renderClient->ReleaseBuffer( 0, 0 );
5079 if ( FAILED( hr ) ) {
5080 errorText_ = "RtApiWasapi::wasapiThread: Unable to release render buffer.";
5086 // if the callback buffer was pushed renderBuffer reset callbackPulled flag
5087 if ( callbackPushed ) {
5088 callbackPulled = false;
5090 RtApi::tickStreamTime();
5097 CoTaskMemFree( captureFormat );
5098 CoTaskMemFree( renderFormat );
5102 // update stream state
5103 stream_.state = STREAM_STOPPED;
5105 if ( errorText_.empty() )
5111 //******************** End of __WINDOWS_WASAPI__ *********************//
5115 #if defined(__WINDOWS_DS__) // Windows DirectSound API
5117 // Modified by Robin Davies, October 2005
5118 // - Improvements to DirectX pointer chasing.
5119 // - Bug fix for non-power-of-two Asio granularity used by Edirol PCR-A30.
5120 // - Auto-call CoInitialize for DSOUND and ASIO platforms.
5121 // Various revisions for RtAudio 4.0 by Gary Scavone, April 2007
5122 // Changed device query structure for RtAudio 4.0.7, January 2010
5124 #include <mmsystem.h>
5128 #include <algorithm>
5130 #if defined(__MINGW32__)
5131 // missing from latest mingw winapi
5132 #define WAVE_FORMAT_96M08 0x00010000 /* 96 kHz, Mono, 8-bit */
5133 #define WAVE_FORMAT_96S08 0x00020000 /* 96 kHz, Stereo, 8-bit */
5134 #define WAVE_FORMAT_96M16 0x00040000 /* 96 kHz, Mono, 16-bit */
5135 #define WAVE_FORMAT_96S16 0x00080000 /* 96 kHz, Stereo, 16-bit */
5138 #define MINIMUM_DEVICE_BUFFER_SIZE 32768
5140 #ifdef _MSC_VER // if Microsoft Visual C++
5141 #pragma comment( lib, "winmm.lib" ) // then, auto-link winmm.lib. Otherwise, it has to be added manually.
5144 static inline DWORD dsPointerBetween( DWORD pointer, DWORD laterPointer, DWORD earlierPointer, DWORD bufferSize )
5146 if ( pointer > bufferSize ) pointer -= bufferSize;
5147 if ( laterPointer < earlierPointer ) laterPointer += bufferSize;
5148 if ( pointer < earlierPointer ) pointer += bufferSize;
5149 return pointer >= earlierPointer && pointer < laterPointer;
5152 // A structure to hold various information related to the DirectSound
5153 // API implementation.
5155 unsigned int drainCounter; // Tracks callback counts when draining
5156 bool internalDrain; // Indicates if stop is initiated from callback or not.
5160 UINT bufferPointer[2];
5161 DWORD dsBufferSize[2];
5162 DWORD dsPointerLeadTime[2]; // the number of bytes ahead of the safe pointer to lead by.
5166 :drainCounter(0), internalDrain(false) { id[0] = 0; id[1] = 0; buffer[0] = 0; buffer[1] = 0; xrun[0] = false; xrun[1] = false; bufferPointer[0] = 0; bufferPointer[1] = 0; }
5169 // Declarations for utility functions, callbacks, and structures
5170 // specific to the DirectSound implementation.
5171 static BOOL CALLBACK deviceQueryCallback( LPGUID lpguid,
5172 LPCTSTR description,
5176 static const char* getErrorString( int code );
5178 static unsigned __stdcall callbackHandler( void *ptr );
5187 : found(false) { validId[0] = false; validId[1] = false; }
5190 struct DsProbeData {
5192 std::vector<struct DsDevice>* dsDevices;
5195 RtApiDs :: RtApiDs()
5197 // Dsound will run both-threaded. If CoInitialize fails, then just
5198 // accept whatever the mainline chose for a threading model.
5199 coInitialized_ = false;
5200 HRESULT hr = CoInitialize( NULL );
5201 if ( !FAILED( hr ) ) coInitialized_ = true;
5204 RtApiDs :: ~RtApiDs()
5206 if ( stream_.state != STREAM_CLOSED ) closeStream();
5207 if ( coInitialized_ ) CoUninitialize(); // balanced call.
5210 // The DirectSound default output is always the first device.
5211 unsigned int RtApiDs :: getDefaultOutputDevice( void )
5216 // The DirectSound default input is always the first input device,
5217 // which is the first capture device enumerated.
5218 unsigned int RtApiDs :: getDefaultInputDevice( void )
5223 unsigned int RtApiDs :: getDeviceCount( void )
5225 // Set query flag for previously found devices to false, so that we
5226 // can check for any devices that have disappeared.
5227 for ( unsigned int i=0; i<dsDevices.size(); i++ )
5228 dsDevices[i].found = false;
5230 // Query DirectSound devices.
5231 struct DsProbeData probeInfo;
5232 probeInfo.isInput = false;
5233 probeInfo.dsDevices = &dsDevices;
5234 HRESULT result = DirectSoundEnumerate( (LPDSENUMCALLBACK) deviceQueryCallback, &probeInfo );
5235 if ( FAILED( result ) ) {
5236 errorStream_ << "RtApiDs::getDeviceCount: error (" << getErrorString( result ) << ") enumerating output devices!";
5237 errorText_ = errorStream_.str();
5238 error( RtAudioError::WARNING );
5241 // Query DirectSoundCapture devices.
5242 probeInfo.isInput = true;
5243 result = DirectSoundCaptureEnumerate( (LPDSENUMCALLBACK) deviceQueryCallback, &probeInfo );
5244 if ( FAILED( result ) ) {
5245 errorStream_ << "RtApiDs::getDeviceCount: error (" << getErrorString( result ) << ") enumerating input devices!";
5246 errorText_ = errorStream_.str();
5247 error( RtAudioError::WARNING );
5250 // Clean out any devices that may have disappeared (code update submitted by Eli Zehngut).
5251 for ( unsigned int i=0; i<dsDevices.size(); ) {
5252 if ( dsDevices[i].found == false ) dsDevices.erase( dsDevices.begin() + i );
5256 return static_cast<unsigned int>(dsDevices.size());
5259 RtAudio::DeviceInfo RtApiDs :: getDeviceInfo( unsigned int device )
5261 RtAudio::DeviceInfo info;
5262 info.probed = false;
5264 if ( dsDevices.size() == 0 ) {
5265 // Force a query of all devices
5267 if ( dsDevices.size() == 0 ) {
5268 errorText_ = "RtApiDs::getDeviceInfo: no devices found!";
5269 error( RtAudioError::INVALID_USE );
5274 if ( device >= dsDevices.size() ) {
5275 errorText_ = "RtApiDs::getDeviceInfo: device ID is invalid!";
5276 error( RtAudioError::INVALID_USE );
5281 if ( dsDevices[ device ].validId[0] == false ) goto probeInput;
5283 LPDIRECTSOUND output;
5285 result = DirectSoundCreate( dsDevices[ device ].id[0], &output, NULL );
5286 if ( FAILED( result ) ) {
5287 errorStream_ << "RtApiDs::getDeviceInfo: error (" << getErrorString( result ) << ") opening output device (" << dsDevices[ device ].name << ")!";
5288 errorText_ = errorStream_.str();
5289 error( RtAudioError::WARNING );
5293 outCaps.dwSize = sizeof( outCaps );
5294 result = output->GetCaps( &outCaps );
5295 if ( FAILED( result ) ) {
5297 errorStream_ << "RtApiDs::getDeviceInfo: error (" << getErrorString( result ) << ") getting capabilities!";
5298 errorText_ = errorStream_.str();
5299 error( RtAudioError::WARNING );
5303 // Get output channel information.
5304 info.outputChannels = ( outCaps.dwFlags & DSCAPS_PRIMARYSTEREO ) ? 2 : 1;
5306 // Get sample rate information.
5307 info.sampleRates.clear();
5308 for ( unsigned int k=0; k<MAX_SAMPLE_RATES; k++ ) {
5309 if ( SAMPLE_RATES[k] >= (unsigned int) outCaps.dwMinSecondarySampleRate &&
5310 SAMPLE_RATES[k] <= (unsigned int) outCaps.dwMaxSecondarySampleRate ) {
5311 info.sampleRates.push_back( SAMPLE_RATES[k] );
5313 if ( !info.preferredSampleRate || ( SAMPLE_RATES[k] <= 48000 && SAMPLE_RATES[k] > info.preferredSampleRate ) )
5314 info.preferredSampleRate = SAMPLE_RATES[k];
5318 // Get format information.
5319 if ( outCaps.dwFlags & DSCAPS_PRIMARY16BIT ) info.nativeFormats |= RTAUDIO_SINT16;
5320 if ( outCaps.dwFlags & DSCAPS_PRIMARY8BIT ) info.nativeFormats |= RTAUDIO_SINT8;
5324 if ( getDefaultOutputDevice() == device )
5325 info.isDefaultOutput = true;
5327 if ( dsDevices[ device ].validId[1] == false ) {
5328 info.name = dsDevices[ device ].name;
5335 LPDIRECTSOUNDCAPTURE input;
5336 result = DirectSoundCaptureCreate( dsDevices[ device ].id[1], &input, NULL );
5337 if ( FAILED( result ) ) {
5338 errorStream_ << "RtApiDs::getDeviceInfo: error (" << getErrorString( result ) << ") opening input device (" << dsDevices[ device ].name << ")!";
5339 errorText_ = errorStream_.str();
5340 error( RtAudioError::WARNING );
5345 inCaps.dwSize = sizeof( inCaps );
5346 result = input->GetCaps( &inCaps );
5347 if ( FAILED( result ) ) {
5349 errorStream_ << "RtApiDs::getDeviceInfo: error (" << getErrorString( result ) << ") getting object capabilities (" << dsDevices[ device ].name << ")!";
5350 errorText_ = errorStream_.str();
5351 error( RtAudioError::WARNING );
5355 // Get input channel information.
5356 info.inputChannels = inCaps.dwChannels;
5358 // Get sample rate and format information.
5359 std::vector<unsigned int> rates;
5360 if ( inCaps.dwChannels >= 2 ) {
5361 if ( inCaps.dwFormats & WAVE_FORMAT_1S16 ) info.nativeFormats |= RTAUDIO_SINT16;
5362 if ( inCaps.dwFormats & WAVE_FORMAT_2S16 ) info.nativeFormats |= RTAUDIO_SINT16;
5363 if ( inCaps.dwFormats & WAVE_FORMAT_4S16 ) info.nativeFormats |= RTAUDIO_SINT16;
5364 if ( inCaps.dwFormats & WAVE_FORMAT_96S16 ) info.nativeFormats |= RTAUDIO_SINT16;
5365 if ( inCaps.dwFormats & WAVE_FORMAT_1S08 ) info.nativeFormats |= RTAUDIO_SINT8;
5366 if ( inCaps.dwFormats & WAVE_FORMAT_2S08 ) info.nativeFormats |= RTAUDIO_SINT8;
5367 if ( inCaps.dwFormats & WAVE_FORMAT_4S08 ) info.nativeFormats |= RTAUDIO_SINT8;
5368 if ( inCaps.dwFormats & WAVE_FORMAT_96S08 ) info.nativeFormats |= RTAUDIO_SINT8;
5370 if ( info.nativeFormats & RTAUDIO_SINT16 ) {
5371 if ( inCaps.dwFormats & WAVE_FORMAT_1S16 ) rates.push_back( 11025 );
5372 if ( inCaps.dwFormats & WAVE_FORMAT_2S16 ) rates.push_back( 22050 );
5373 if ( inCaps.dwFormats & WAVE_FORMAT_4S16 ) rates.push_back( 44100 );
5374 if ( inCaps.dwFormats & WAVE_FORMAT_96S16 ) rates.push_back( 96000 );
5376 else if ( info.nativeFormats & RTAUDIO_SINT8 ) {
5377 if ( inCaps.dwFormats & WAVE_FORMAT_1S08 ) rates.push_back( 11025 );
5378 if ( inCaps.dwFormats & WAVE_FORMAT_2S08 ) rates.push_back( 22050 );
5379 if ( inCaps.dwFormats & WAVE_FORMAT_4S08 ) rates.push_back( 44100 );
5380 if ( inCaps.dwFormats & WAVE_FORMAT_96S08 ) rates.push_back( 96000 );
5383 else if ( inCaps.dwChannels == 1 ) {
5384 if ( inCaps.dwFormats & WAVE_FORMAT_1M16 ) info.nativeFormats |= RTAUDIO_SINT16;
5385 if ( inCaps.dwFormats & WAVE_FORMAT_2M16 ) info.nativeFormats |= RTAUDIO_SINT16;
5386 if ( inCaps.dwFormats & WAVE_FORMAT_4M16 ) info.nativeFormats |= RTAUDIO_SINT16;
5387 if ( inCaps.dwFormats & WAVE_FORMAT_96M16 ) info.nativeFormats |= RTAUDIO_SINT16;
5388 if ( inCaps.dwFormats & WAVE_FORMAT_1M08 ) info.nativeFormats |= RTAUDIO_SINT8;
5389 if ( inCaps.dwFormats & WAVE_FORMAT_2M08 ) info.nativeFormats |= RTAUDIO_SINT8;
5390 if ( inCaps.dwFormats & WAVE_FORMAT_4M08 ) info.nativeFormats |= RTAUDIO_SINT8;
5391 if ( inCaps.dwFormats & WAVE_FORMAT_96M08 ) info.nativeFormats |= RTAUDIO_SINT8;
5393 if ( info.nativeFormats & RTAUDIO_SINT16 ) {
5394 if ( inCaps.dwFormats & WAVE_FORMAT_1M16 ) rates.push_back( 11025 );
5395 if ( inCaps.dwFormats & WAVE_FORMAT_2M16 ) rates.push_back( 22050 );
5396 if ( inCaps.dwFormats & WAVE_FORMAT_4M16 ) rates.push_back( 44100 );
5397 if ( inCaps.dwFormats & WAVE_FORMAT_96M16 ) rates.push_back( 96000 );
5399 else if ( info.nativeFormats & RTAUDIO_SINT8 ) {
5400 if ( inCaps.dwFormats & WAVE_FORMAT_1M08 ) rates.push_back( 11025 );
5401 if ( inCaps.dwFormats & WAVE_FORMAT_2M08 ) rates.push_back( 22050 );
5402 if ( inCaps.dwFormats & WAVE_FORMAT_4M08 ) rates.push_back( 44100 );
5403 if ( inCaps.dwFormats & WAVE_FORMAT_96M08 ) rates.push_back( 96000 );
5406 else info.inputChannels = 0; // technically, this would be an error
5410 if ( info.inputChannels == 0 ) return info;
5412 // Copy the supported rates to the info structure but avoid duplication.
5414 for ( unsigned int i=0; i<rates.size(); i++ ) {
5416 for ( unsigned int j=0; j<info.sampleRates.size(); j++ ) {
5417 if ( rates[i] == info.sampleRates[j] ) {
5422 if ( found == false ) info.sampleRates.push_back( rates[i] );
5424 std::sort( info.sampleRates.begin(), info.sampleRates.end() );
5426 // If device opens for both playback and capture, we determine the channels.
5427 if ( info.outputChannels > 0 && info.inputChannels > 0 )
5428 info.duplexChannels = (info.outputChannels > info.inputChannels) ? info.inputChannels : info.outputChannels;
5430 if ( device == 0 ) info.isDefaultInput = true;
5432 // Copy name and return.
5433 info.name = dsDevices[ device ].name;
5438 bool RtApiDs :: probeDeviceOpen( unsigned int device, StreamMode mode, unsigned int channels,
5439 unsigned int firstChannel, unsigned int sampleRate,
5440 RtAudioFormat format, unsigned int *bufferSize,
5441 RtAudio::StreamOptions *options )
5443 if ( channels + firstChannel > 2 ) {
5444 errorText_ = "RtApiDs::probeDeviceOpen: DirectSound does not support more than 2 channels per device.";
5448 size_t nDevices = dsDevices.size();
5449 if ( nDevices == 0 ) {
5450 // This should not happen because a check is made before this function is called.
5451 errorText_ = "RtApiDs::probeDeviceOpen: no devices found!";
5455 if ( device >= nDevices ) {
5456 // This should not happen because a check is made before this function is called.
5457 errorText_ = "RtApiDs::probeDeviceOpen: device ID is invalid!";
5461 if ( mode == OUTPUT ) {
5462 if ( dsDevices[ device ].validId[0] == false ) {
5463 errorStream_ << "RtApiDs::probeDeviceOpen: device (" << device << ") does not support output!";
5464 errorText_ = errorStream_.str();
5468 else { // mode == INPUT
5469 if ( dsDevices[ device ].validId[1] == false ) {
5470 errorStream_ << "RtApiDs::probeDeviceOpen: device (" << device << ") does not support input!";
5471 errorText_ = errorStream_.str();
5476 // According to a note in PortAudio, using GetDesktopWindow()
5477 // instead of GetForegroundWindow() is supposed to avoid problems
5478 // that occur when the application's window is not the foreground
5479 // window. Also, if the application window closes before the
5480 // DirectSound buffer, DirectSound can crash. In the past, I had
5481 // problems when using GetDesktopWindow() but it seems fine now
5482 // (January 2010). I'll leave it commented here.
5483 // HWND hWnd = GetForegroundWindow();
5484 HWND hWnd = GetDesktopWindow();
5486 // Check the numberOfBuffers parameter and limit the lowest value to
5487 // two. This is a judgement call and a value of two is probably too
5488 // low for capture, but it should work for playback.
5490 if ( options ) nBuffers = options->numberOfBuffers;
5491 if ( options && options->flags & RTAUDIO_MINIMIZE_LATENCY ) nBuffers = 2;
5492 if ( nBuffers < 2 ) nBuffers = 3;
5494 // Check the lower range of the user-specified buffer size and set
5495 // (arbitrarily) to a lower bound of 32.
5496 if ( *bufferSize < 32 ) *bufferSize = 32;
5498 // Create the wave format structure. The data format setting will
5499 // be determined later.
5500 WAVEFORMATEX waveFormat;
5501 ZeroMemory( &waveFormat, sizeof(WAVEFORMATEX) );
5502 waveFormat.wFormatTag = WAVE_FORMAT_PCM;
5503 waveFormat.nChannels = channels + firstChannel;
5504 waveFormat.nSamplesPerSec = (unsigned long) sampleRate;
5506 // Determine the device buffer size. By default, we'll use the value
5507 // defined above (32K), but we will grow it to make allowances for
5508 // very large software buffer sizes.
5509 DWORD dsBufferSize = MINIMUM_DEVICE_BUFFER_SIZE;
5510 DWORD dsPointerLeadTime = 0;
5512 void *ohandle = 0, *bhandle = 0;
5514 if ( mode == OUTPUT ) {
5516 LPDIRECTSOUND output;
5517 result = DirectSoundCreate( dsDevices[ device ].id[0], &output, NULL );
5518 if ( FAILED( result ) ) {
5519 errorStream_ << "RtApiDs::probeDeviceOpen: error (" << getErrorString( result ) << ") opening output device (" << dsDevices[ device ].name << ")!";
5520 errorText_ = errorStream_.str();
5525 outCaps.dwSize = sizeof( outCaps );
5526 result = output->GetCaps( &outCaps );
5527 if ( FAILED( result ) ) {
5529 errorStream_ << "RtApiDs::probeDeviceOpen: error (" << getErrorString( result ) << ") getting capabilities (" << dsDevices[ device ].name << ")!";
5530 errorText_ = errorStream_.str();
5534 // Check channel information.
5535 if ( channels + firstChannel == 2 && !( outCaps.dwFlags & DSCAPS_PRIMARYSTEREO ) ) {
5536 errorStream_ << "RtApiDs::getDeviceInfo: the output device (" << dsDevices[ device ].name << ") does not support stereo playback.";
5537 errorText_ = errorStream_.str();
5541 // Check format information. Use 16-bit format unless not
5542 // supported or user requests 8-bit.
5543 if ( outCaps.dwFlags & DSCAPS_PRIMARY16BIT &&
5544 !( format == RTAUDIO_SINT8 && outCaps.dwFlags & DSCAPS_PRIMARY8BIT ) ) {
5545 waveFormat.wBitsPerSample = 16;
5546 stream_.deviceFormat[mode] = RTAUDIO_SINT16;
5549 waveFormat.wBitsPerSample = 8;
5550 stream_.deviceFormat[mode] = RTAUDIO_SINT8;
5552 stream_.userFormat = format;
5554 // Update wave format structure and buffer information.
5555 waveFormat.nBlockAlign = waveFormat.nChannels * waveFormat.wBitsPerSample / 8;
5556 waveFormat.nAvgBytesPerSec = waveFormat.nSamplesPerSec * waveFormat.nBlockAlign;
5557 dsPointerLeadTime = nBuffers * (*bufferSize) * (waveFormat.wBitsPerSample / 8) * channels;
5559 // If the user wants an even bigger buffer, increase the device buffer size accordingly.
5560 while ( dsPointerLeadTime * 2U > dsBufferSize )
5563 // Set cooperative level to DSSCL_EXCLUSIVE ... sound stops when window focus changes.
5564 // result = output->SetCooperativeLevel( hWnd, DSSCL_EXCLUSIVE );
5565 // Set cooperative level to DSSCL_PRIORITY ... sound remains when window focus changes.
5566 result = output->SetCooperativeLevel( hWnd, DSSCL_PRIORITY );
5567 if ( FAILED( result ) ) {
5569 errorStream_ << "RtApiDs::probeDeviceOpen: error (" << getErrorString( result ) << ") setting cooperative level (" << dsDevices[ device ].name << ")!";
5570 errorText_ = errorStream_.str();
5574 // Even though we will write to the secondary buffer, we need to
5575 // access the primary buffer to set the correct output format
5576 // (since the default is 8-bit, 22 kHz!). Setup the DS primary
5577 // buffer description.
5578 DSBUFFERDESC bufferDescription;
5579 ZeroMemory( &bufferDescription, sizeof( DSBUFFERDESC ) );
5580 bufferDescription.dwSize = sizeof( DSBUFFERDESC );
5581 bufferDescription.dwFlags = DSBCAPS_PRIMARYBUFFER;
5583 // Obtain the primary buffer
5584 LPDIRECTSOUNDBUFFER buffer;
5585 result = output->CreateSoundBuffer( &bufferDescription, &buffer, NULL );
5586 if ( FAILED( result ) ) {
5588 errorStream_ << "RtApiDs::probeDeviceOpen: error (" << getErrorString( result ) << ") accessing primary buffer (" << dsDevices[ device ].name << ")!";
5589 errorText_ = errorStream_.str();
5593 // Set the primary DS buffer sound format.
5594 result = buffer->SetFormat( &waveFormat );
5595 if ( FAILED( result ) ) {
5597 errorStream_ << "RtApiDs::probeDeviceOpen: error (" << getErrorString( result ) << ") setting primary buffer format (" << dsDevices[ device ].name << ")!";
5598 errorText_ = errorStream_.str();
5602 // Setup the secondary DS buffer description.
5603 ZeroMemory( &bufferDescription, sizeof( DSBUFFERDESC ) );
5604 bufferDescription.dwSize = sizeof( DSBUFFERDESC );
5605 bufferDescription.dwFlags = ( DSBCAPS_STICKYFOCUS |
5606 DSBCAPS_GLOBALFOCUS |
5607 DSBCAPS_GETCURRENTPOSITION2 |
5608 DSBCAPS_LOCHARDWARE ); // Force hardware mixing
5609 bufferDescription.dwBufferBytes = dsBufferSize;
5610 bufferDescription.lpwfxFormat = &waveFormat;
5612 // Try to create the secondary DS buffer. If that doesn't work,
5613 // try to use software mixing. Otherwise, there's a problem.
5614 result = output->CreateSoundBuffer( &bufferDescription, &buffer, NULL );
5615 if ( FAILED( result ) ) {
5616 bufferDescription.dwFlags = ( DSBCAPS_STICKYFOCUS |
5617 DSBCAPS_GLOBALFOCUS |
5618 DSBCAPS_GETCURRENTPOSITION2 |
5619 DSBCAPS_LOCSOFTWARE ); // Force software mixing
5620 result = output->CreateSoundBuffer( &bufferDescription, &buffer, NULL );
5621 if ( FAILED( result ) ) {
5623 errorStream_ << "RtApiDs::probeDeviceOpen: error (" << getErrorString( result ) << ") creating secondary buffer (" << dsDevices[ device ].name << ")!";
5624 errorText_ = errorStream_.str();
5629 // Get the buffer size ... might be different from what we specified.
5631 dsbcaps.dwSize = sizeof( DSBCAPS );
5632 result = buffer->GetCaps( &dsbcaps );
5633 if ( FAILED( result ) ) {
5636 errorStream_ << "RtApiDs::probeDeviceOpen: error (" << getErrorString( result ) << ") getting buffer settings (" << dsDevices[ device ].name << ")!";
5637 errorText_ = errorStream_.str();
5641 dsBufferSize = dsbcaps.dwBufferBytes;
5643 // Lock the DS buffer
5646 result = buffer->Lock( 0, dsBufferSize, &audioPtr, &dataLen, NULL, NULL, 0 );
5647 if ( FAILED( result ) ) {
5650 errorStream_ << "RtApiDs::probeDeviceOpen: error (" << getErrorString( result ) << ") locking buffer (" << dsDevices[ device ].name << ")!";
5651 errorText_ = errorStream_.str();
5655 // Zero the DS buffer
5656 ZeroMemory( audioPtr, dataLen );
5658 // Unlock the DS buffer
5659 result = buffer->Unlock( audioPtr, dataLen, NULL, 0 );
5660 if ( FAILED( result ) ) {
5663 errorStream_ << "RtApiDs::probeDeviceOpen: error (" << getErrorString( result ) << ") unlocking buffer (" << dsDevices[ device ].name << ")!";
5664 errorText_ = errorStream_.str();
5668 ohandle = (void *) output;
5669 bhandle = (void *) buffer;
5672 if ( mode == INPUT ) {
5674 LPDIRECTSOUNDCAPTURE input;
5675 result = DirectSoundCaptureCreate( dsDevices[ device ].id[1], &input, NULL );
5676 if ( FAILED( result ) ) {
5677 errorStream_ << "RtApiDs::probeDeviceOpen: error (" << getErrorString( result ) << ") opening input device (" << dsDevices[ device ].name << ")!";
5678 errorText_ = errorStream_.str();
5683 inCaps.dwSize = sizeof( inCaps );
5684 result = input->GetCaps( &inCaps );
5685 if ( FAILED( result ) ) {
5687 errorStream_ << "RtApiDs::probeDeviceOpen: error (" << getErrorString( result ) << ") getting input capabilities (" << dsDevices[ device ].name << ")!";
5688 errorText_ = errorStream_.str();
5692 // Check channel information.
5693 if ( inCaps.dwChannels < channels + firstChannel ) {
5694 errorText_ = "RtApiDs::getDeviceInfo: the input device does not support requested input channels.";
5698 // Check format information. Use 16-bit format unless user
5700 DWORD deviceFormats;
5701 if ( channels + firstChannel == 2 ) {
5702 deviceFormats = WAVE_FORMAT_1S08 | WAVE_FORMAT_2S08 | WAVE_FORMAT_4S08 | WAVE_FORMAT_96S08;
5703 if ( format == RTAUDIO_SINT8 && inCaps.dwFormats & deviceFormats ) {
5704 waveFormat.wBitsPerSample = 8;
5705 stream_.deviceFormat[mode] = RTAUDIO_SINT8;
5707 else { // assume 16-bit is supported
5708 waveFormat.wBitsPerSample = 16;
5709 stream_.deviceFormat[mode] = RTAUDIO_SINT16;
5712 else { // channel == 1
5713 deviceFormats = WAVE_FORMAT_1M08 | WAVE_FORMAT_2M08 | WAVE_FORMAT_4M08 | WAVE_FORMAT_96M08;
5714 if ( format == RTAUDIO_SINT8 && inCaps.dwFormats & deviceFormats ) {
5715 waveFormat.wBitsPerSample = 8;
5716 stream_.deviceFormat[mode] = RTAUDIO_SINT8;
5718 else { // assume 16-bit is supported
5719 waveFormat.wBitsPerSample = 16;
5720 stream_.deviceFormat[mode] = RTAUDIO_SINT16;
5723 stream_.userFormat = format;
5725 // Update wave format structure and buffer information.
5726 waveFormat.nBlockAlign = waveFormat.nChannels * waveFormat.wBitsPerSample / 8;
5727 waveFormat.nAvgBytesPerSec = waveFormat.nSamplesPerSec * waveFormat.nBlockAlign;
5728 dsPointerLeadTime = nBuffers * (*bufferSize) * (waveFormat.wBitsPerSample / 8) * channels;
5730 // If the user wants an even bigger buffer, increase the device buffer size accordingly.
5731 while ( dsPointerLeadTime * 2U > dsBufferSize )
5734 // Setup the secondary DS buffer description.
5735 DSCBUFFERDESC bufferDescription;
5736 ZeroMemory( &bufferDescription, sizeof( DSCBUFFERDESC ) );
5737 bufferDescription.dwSize = sizeof( DSCBUFFERDESC );
5738 bufferDescription.dwFlags = 0;
5739 bufferDescription.dwReserved = 0;
5740 bufferDescription.dwBufferBytes = dsBufferSize;
5741 bufferDescription.lpwfxFormat = &waveFormat;
5743 // Create the capture buffer.
5744 LPDIRECTSOUNDCAPTUREBUFFER buffer;
5745 result = input->CreateCaptureBuffer( &bufferDescription, &buffer, NULL );
5746 if ( FAILED( result ) ) {
5748 errorStream_ << "RtApiDs::probeDeviceOpen: error (" << getErrorString( result ) << ") creating input buffer (" << dsDevices[ device ].name << ")!";
5749 errorText_ = errorStream_.str();
5753 // Get the buffer size ... might be different from what we specified.
5755 dscbcaps.dwSize = sizeof( DSCBCAPS );
5756 result = buffer->GetCaps( &dscbcaps );
5757 if ( FAILED( result ) ) {
5760 errorStream_ << "RtApiDs::probeDeviceOpen: error (" << getErrorString( result ) << ") getting buffer settings (" << dsDevices[ device ].name << ")!";
5761 errorText_ = errorStream_.str();
5765 dsBufferSize = dscbcaps.dwBufferBytes;
5767 // NOTE: We could have a problem here if this is a duplex stream
5768 // and the play and capture hardware buffer sizes are different
5769 // (I'm actually not sure if that is a problem or not).
5770 // Currently, we are not verifying that.
5772 // Lock the capture buffer
5775 result = buffer->Lock( 0, dsBufferSize, &audioPtr, &dataLen, NULL, NULL, 0 );
5776 if ( FAILED( result ) ) {
5779 errorStream_ << "RtApiDs::probeDeviceOpen: error (" << getErrorString( result ) << ") locking input buffer (" << dsDevices[ device ].name << ")!";
5780 errorText_ = errorStream_.str();
5785 ZeroMemory( audioPtr, dataLen );
5787 // Unlock the buffer
5788 result = buffer->Unlock( audioPtr, dataLen, NULL, 0 );
5789 if ( FAILED( result ) ) {
5792 errorStream_ << "RtApiDs::probeDeviceOpen: error (" << getErrorString( result ) << ") unlocking input buffer (" << dsDevices[ device ].name << ")!";
5793 errorText_ = errorStream_.str();
5797 ohandle = (void *) input;
5798 bhandle = (void *) buffer;
5801 // Set various stream parameters
5802 DsHandle *handle = 0;
5803 stream_.nDeviceChannels[mode] = channels + firstChannel;
5804 stream_.nUserChannels[mode] = channels;
5805 stream_.bufferSize = *bufferSize;
5806 stream_.channelOffset[mode] = firstChannel;
5807 stream_.deviceInterleaved[mode] = true;
5808 if ( options && options->flags & RTAUDIO_NONINTERLEAVED ) stream_.userInterleaved = false;
5809 else stream_.userInterleaved = true;
5811 // Set flag for buffer conversion
5812 stream_.doConvertBuffer[mode] = false;
5813 if (stream_.nUserChannels[mode] != stream_.nDeviceChannels[mode])
5814 stream_.doConvertBuffer[mode] = true;
5815 if (stream_.userFormat != stream_.deviceFormat[mode])
5816 stream_.doConvertBuffer[mode] = true;
5817 if ( stream_.userInterleaved != stream_.deviceInterleaved[mode] &&
5818 stream_.nUserChannels[mode] > 1 )
5819 stream_.doConvertBuffer[mode] = true;
5821 // Allocate necessary internal buffers
5822 long bufferBytes = stream_.nUserChannels[mode] * *bufferSize * formatBytes( stream_.userFormat );
5823 stream_.userBuffer[mode] = (char *) calloc( bufferBytes, 1 );
5824 if ( stream_.userBuffer[mode] == NULL ) {
5825 errorText_ = "RtApiDs::probeDeviceOpen: error allocating user buffer memory.";
5829 if ( stream_.doConvertBuffer[mode] ) {
5831 bool makeBuffer = true;
5832 bufferBytes = stream_.nDeviceChannels[mode] * formatBytes( stream_.deviceFormat[mode] );
5833 if ( mode == INPUT ) {
5834 if ( stream_.mode == OUTPUT && stream_.deviceBuffer ) {
5835 unsigned long bytesOut = stream_.nDeviceChannels[0] * formatBytes( stream_.deviceFormat[0] );
5836 if ( bufferBytes <= (long) bytesOut ) makeBuffer = false;
5841 bufferBytes *= *bufferSize;
5842 if ( stream_.deviceBuffer ) free( stream_.deviceBuffer );
5843 stream_.deviceBuffer = (char *) calloc( bufferBytes, 1 );
5844 if ( stream_.deviceBuffer == NULL ) {
5845 errorText_ = "RtApiDs::probeDeviceOpen: error allocating device buffer memory.";
5851 // Allocate our DsHandle structures for the stream.
5852 if ( stream_.apiHandle == 0 ) {
5854 handle = new DsHandle;
5856 catch ( std::bad_alloc& ) {
5857 errorText_ = "RtApiDs::probeDeviceOpen: error allocating AsioHandle memory.";
5861 // Create a manual-reset event.
5862 handle->condition = CreateEvent( NULL, // no security
5863 TRUE, // manual-reset
5864 FALSE, // non-signaled initially
5866 stream_.apiHandle = (void *) handle;
5869 handle = (DsHandle *) stream_.apiHandle;
5870 handle->id[mode] = ohandle;
5871 handle->buffer[mode] = bhandle;
5872 handle->dsBufferSize[mode] = dsBufferSize;
5873 handle->dsPointerLeadTime[mode] = dsPointerLeadTime;
5875 stream_.device[mode] = device;
5876 stream_.state = STREAM_STOPPED;
5877 if ( stream_.mode == OUTPUT && mode == INPUT )
5878 // We had already set up an output stream.
5879 stream_.mode = DUPLEX;
5881 stream_.mode = mode;
5882 stream_.nBuffers = nBuffers;
5883 stream_.sampleRate = sampleRate;
5885 // Setup the buffer conversion information structure.
5886 if ( stream_.doConvertBuffer[mode] ) setConvertInfo( mode, firstChannel );
5888 // Setup the callback thread.
5889 if ( stream_.callbackInfo.isRunning == false ) {
5891 stream_.callbackInfo.isRunning = true;
5892 stream_.callbackInfo.object = (void *) this;
5893 stream_.callbackInfo.thread = _beginthreadex( NULL, 0, &callbackHandler,
5894 &stream_.callbackInfo, 0, &threadId );
5895 if ( stream_.callbackInfo.thread == 0 ) {
5896 errorText_ = "RtApiDs::probeDeviceOpen: error creating callback thread!";
5900 // Boost DS thread priority
5901 SetThreadPriority( (HANDLE) stream_.callbackInfo.thread, THREAD_PRIORITY_HIGHEST );
5907 if ( handle->buffer[0] ) { // the object pointer can be NULL and valid
5908 LPDIRECTSOUND object = (LPDIRECTSOUND) handle->id[0];
5909 LPDIRECTSOUNDBUFFER buffer = (LPDIRECTSOUNDBUFFER) handle->buffer[0];
5910 if ( buffer ) buffer->Release();
5913 if ( handle->buffer[1] ) {
5914 LPDIRECTSOUNDCAPTURE object = (LPDIRECTSOUNDCAPTURE) handle->id[1];
5915 LPDIRECTSOUNDCAPTUREBUFFER buffer = (LPDIRECTSOUNDCAPTUREBUFFER) handle->buffer[1];
5916 if ( buffer ) buffer->Release();
5919 CloseHandle( handle->condition );
5921 stream_.apiHandle = 0;
5924 for ( int i=0; i<2; i++ ) {
5925 if ( stream_.userBuffer[i] ) {
5926 free( stream_.userBuffer[i] );
5927 stream_.userBuffer[i] = 0;
5931 if ( stream_.deviceBuffer ) {
5932 free( stream_.deviceBuffer );
5933 stream_.deviceBuffer = 0;
5936 stream_.state = STREAM_CLOSED;
5940 void RtApiDs :: closeStream()
5942 if ( stream_.state == STREAM_CLOSED ) {
5943 errorText_ = "RtApiDs::closeStream(): no open stream to close!";
5944 error( RtAudioError::WARNING );
5948 // Stop the callback thread.
5949 stream_.callbackInfo.isRunning = false;
5950 WaitForSingleObject( (HANDLE) stream_.callbackInfo.thread, INFINITE );
5951 CloseHandle( (HANDLE) stream_.callbackInfo.thread );
5953 DsHandle *handle = (DsHandle *) stream_.apiHandle;
5955 if ( handle->buffer[0] ) { // the object pointer can be NULL and valid
5956 LPDIRECTSOUND object = (LPDIRECTSOUND) handle->id[0];
5957 LPDIRECTSOUNDBUFFER buffer = (LPDIRECTSOUNDBUFFER) handle->buffer[0];
5964 if ( handle->buffer[1] ) {
5965 LPDIRECTSOUNDCAPTURE object = (LPDIRECTSOUNDCAPTURE) handle->id[1];
5966 LPDIRECTSOUNDCAPTUREBUFFER buffer = (LPDIRECTSOUNDCAPTUREBUFFER) handle->buffer[1];
5973 CloseHandle( handle->condition );
5975 stream_.apiHandle = 0;
5978 for ( int i=0; i<2; i++ ) {
5979 if ( stream_.userBuffer[i] ) {
5980 free( stream_.userBuffer[i] );
5981 stream_.userBuffer[i] = 0;
5985 if ( stream_.deviceBuffer ) {
5986 free( stream_.deviceBuffer );
5987 stream_.deviceBuffer = 0;
5990 stream_.mode = UNINITIALIZED;
5991 stream_.state = STREAM_CLOSED;
5994 void RtApiDs :: startStream()
5997 if ( stream_.state == STREAM_RUNNING ) {
5998 errorText_ = "RtApiDs::startStream(): the stream is already running!";
5999 error( RtAudioError::WARNING );
6003 DsHandle *handle = (DsHandle *) stream_.apiHandle;
6005 // Increase scheduler frequency on lesser windows (a side-effect of
6006 // increasing timer accuracy). On greater windows (Win2K or later),
6007 // this is already in effect.
6008 timeBeginPeriod( 1 );
6010 buffersRolling = false;
6011 duplexPrerollBytes = 0;
6013 if ( stream_.mode == DUPLEX ) {
6014 // 0.5 seconds of silence in DUPLEX mode while the devices spin up and synchronize.
6015 duplexPrerollBytes = (int) ( 0.5 * stream_.sampleRate * formatBytes( stream_.deviceFormat[1] ) * stream_.nDeviceChannels[1] );
6019 if ( stream_.mode == OUTPUT || stream_.mode == DUPLEX ) {
6021 LPDIRECTSOUNDBUFFER buffer = (LPDIRECTSOUNDBUFFER) handle->buffer[0];
6022 result = buffer->Play( 0, 0, DSBPLAY_LOOPING );
6023 if ( FAILED( result ) ) {
6024 errorStream_ << "RtApiDs::startStream: error (" << getErrorString( result ) << ") starting output buffer!";
6025 errorText_ = errorStream_.str();
6030 if ( stream_.mode == INPUT || stream_.mode == DUPLEX ) {
6032 LPDIRECTSOUNDCAPTUREBUFFER buffer = (LPDIRECTSOUNDCAPTUREBUFFER) handle->buffer[1];
6033 result = buffer->Start( DSCBSTART_LOOPING );
6034 if ( FAILED( result ) ) {
6035 errorStream_ << "RtApiDs::startStream: error (" << getErrorString( result ) << ") starting input buffer!";
6036 errorText_ = errorStream_.str();
6041 handle->drainCounter = 0;
6042 handle->internalDrain = false;
6043 ResetEvent( handle->condition );
6044 stream_.state = STREAM_RUNNING;
6047 if ( FAILED( result ) ) error( RtAudioError::SYSTEM_ERROR );
6050 void RtApiDs :: stopStream()
6053 if ( stream_.state == STREAM_STOPPED ) {
6054 errorText_ = "RtApiDs::stopStream(): the stream is already stopped!";
6055 error( RtAudioError::WARNING );
6062 DsHandle *handle = (DsHandle *) stream_.apiHandle;
6063 if ( stream_.mode == OUTPUT || stream_.mode == DUPLEX ) {
6064 if ( handle->drainCounter == 0 ) {
6065 handle->drainCounter = 2;
6066 WaitForSingleObject( handle->condition, INFINITE ); // block until signaled
6069 stream_.state = STREAM_STOPPED;
6071 MUTEX_LOCK( &stream_.mutex );
6073 // Stop the buffer and clear memory
6074 LPDIRECTSOUNDBUFFER buffer = (LPDIRECTSOUNDBUFFER) handle->buffer[0];
6075 result = buffer->Stop();
6076 if ( FAILED( result ) ) {
6077 errorStream_ << "RtApiDs::stopStream: error (" << getErrorString( result ) << ") stopping output buffer!";
6078 errorText_ = errorStream_.str();
6082 // Lock the buffer and clear it so that if we start to play again,
6083 // we won't have old data playing.
6084 result = buffer->Lock( 0, handle->dsBufferSize[0], &audioPtr, &dataLen, NULL, NULL, 0 );
6085 if ( FAILED( result ) ) {
6086 errorStream_ << "RtApiDs::stopStream: error (" << getErrorString( result ) << ") locking output buffer!";
6087 errorText_ = errorStream_.str();
6091 // Zero the DS buffer
6092 ZeroMemory( audioPtr, dataLen );
6094 // Unlock the DS buffer
6095 result = buffer->Unlock( audioPtr, dataLen, NULL, 0 );
6096 if ( FAILED( result ) ) {
6097 errorStream_ << "RtApiDs::stopStream: error (" << getErrorString( result ) << ") unlocking output buffer!";
6098 errorText_ = errorStream_.str();
6102 // If we start playing again, we must begin at beginning of buffer.
6103 handle->bufferPointer[0] = 0;
6106 if ( stream_.mode == INPUT || stream_.mode == DUPLEX ) {
6107 LPDIRECTSOUNDCAPTUREBUFFER buffer = (LPDIRECTSOUNDCAPTUREBUFFER) handle->buffer[1];
6111 stream_.state = STREAM_STOPPED;
6113 if ( stream_.mode != DUPLEX )
6114 MUTEX_LOCK( &stream_.mutex );
6116 result = buffer->Stop();
6117 if ( FAILED( result ) ) {
6118 errorStream_ << "RtApiDs::stopStream: error (" << getErrorString( result ) << ") stopping input buffer!";
6119 errorText_ = errorStream_.str();
6123 // Lock the buffer and clear it so that if we start to play again,
6124 // we won't have old data playing.
6125 result = buffer->Lock( 0, handle->dsBufferSize[1], &audioPtr, &dataLen, NULL, NULL, 0 );
6126 if ( FAILED( result ) ) {
6127 errorStream_ << "RtApiDs::stopStream: error (" << getErrorString( result ) << ") locking input buffer!";
6128 errorText_ = errorStream_.str();
6132 // Zero the DS buffer
6133 ZeroMemory( audioPtr, dataLen );
6135 // Unlock the DS buffer
6136 result = buffer->Unlock( audioPtr, dataLen, NULL, 0 );
6137 if ( FAILED( result ) ) {
6138 errorStream_ << "RtApiDs::stopStream: error (" << getErrorString( result ) << ") unlocking input buffer!";
6139 errorText_ = errorStream_.str();
6143 // If we start recording again, we must begin at beginning of buffer.
6144 handle->bufferPointer[1] = 0;
6148 timeEndPeriod( 1 ); // revert to normal scheduler frequency on lesser windows.
6149 MUTEX_UNLOCK( &stream_.mutex );
6151 if ( FAILED( result ) ) error( RtAudioError::SYSTEM_ERROR );
6154 void RtApiDs :: abortStream()
6157 if ( stream_.state == STREAM_STOPPED ) {
6158 errorText_ = "RtApiDs::abortStream(): the stream is already stopped!";
6159 error( RtAudioError::WARNING );
6163 DsHandle *handle = (DsHandle *) stream_.apiHandle;
6164 handle->drainCounter = 2;
6169 void RtApiDs :: callbackEvent()
6171 if ( stream_.state == STREAM_STOPPED || stream_.state == STREAM_STOPPING ) {
6172 Sleep( 50 ); // sleep 50 milliseconds
6176 if ( stream_.state == STREAM_CLOSED ) {
6177 errorText_ = "RtApiDs::callbackEvent(): the stream is closed ... this shouldn't happen!";
6178 error( RtAudioError::WARNING );
6182 CallbackInfo *info = (CallbackInfo *) &stream_.callbackInfo;
6183 DsHandle *handle = (DsHandle *) stream_.apiHandle;
6185 // Check if we were draining the stream and signal is finished.
6186 if ( handle->drainCounter > stream_.nBuffers + 2 ) {
6188 stream_.state = STREAM_STOPPING;
6189 if ( handle->internalDrain == false )
6190 SetEvent( handle->condition );
6196 // Invoke user callback to get fresh output data UNLESS we are
6198 if ( handle->drainCounter == 0 ) {
6199 RtAudioCallback callback = (RtAudioCallback) info->callback;
6200 double streamTime = getStreamTime();
6201 RtAudioStreamStatus status = 0;
6202 if ( stream_.mode != INPUT && handle->xrun[0] == true ) {
6203 status |= RTAUDIO_OUTPUT_UNDERFLOW;
6204 handle->xrun[0] = false;
6206 if ( stream_.mode != OUTPUT && handle->xrun[1] == true ) {
6207 status |= RTAUDIO_INPUT_OVERFLOW;
6208 handle->xrun[1] = false;
6210 int cbReturnValue = callback( stream_.userBuffer[0], stream_.userBuffer[1],
6211 stream_.bufferSize, streamTime, status, info->userData );
6212 if ( cbReturnValue == 2 ) {
6213 stream_.state = STREAM_STOPPING;
6214 handle->drainCounter = 2;
6218 else if ( cbReturnValue == 1 ) {
6219 handle->drainCounter = 1;
6220 handle->internalDrain = true;
6225 DWORD currentWritePointer, safeWritePointer;
6226 DWORD currentReadPointer, safeReadPointer;
6227 UINT nextWritePointer;
6229 LPVOID buffer1 = NULL;
6230 LPVOID buffer2 = NULL;
6231 DWORD bufferSize1 = 0;
6232 DWORD bufferSize2 = 0;
6237 MUTEX_LOCK( &stream_.mutex );
6238 if ( stream_.state == STREAM_STOPPED ) {
6239 MUTEX_UNLOCK( &stream_.mutex );
6243 if ( buffersRolling == false ) {
6244 if ( stream_.mode == DUPLEX ) {
6245 //assert( handle->dsBufferSize[0] == handle->dsBufferSize[1] );
6247 // It takes a while for the devices to get rolling. As a result,
6248 // there's no guarantee that the capture and write device pointers
6249 // will move in lockstep. Wait here for both devices to start
6250 // rolling, and then set our buffer pointers accordingly.
6251 // e.g. Crystal Drivers: the capture buffer starts up 5700 to 9600
6252 // bytes later than the write buffer.
6254 // Stub: a serious risk of having a pre-emptive scheduling round
6255 // take place between the two GetCurrentPosition calls... but I'm
6256 // really not sure how to solve the problem. Temporarily boost to
6257 // Realtime priority, maybe; but I'm not sure what priority the
6258 // DirectSound service threads run at. We *should* be roughly
6259 // within a ms or so of correct.
6261 LPDIRECTSOUNDBUFFER dsWriteBuffer = (LPDIRECTSOUNDBUFFER) handle->buffer[0];
6262 LPDIRECTSOUNDCAPTUREBUFFER dsCaptureBuffer = (LPDIRECTSOUNDCAPTUREBUFFER) handle->buffer[1];
6264 DWORD startSafeWritePointer, startSafeReadPointer;
6266 result = dsWriteBuffer->GetCurrentPosition( NULL, &startSafeWritePointer );
6267 if ( FAILED( result ) ) {
6268 errorStream_ << "RtApiDs::callbackEvent: error (" << getErrorString( result ) << ") getting current write position!";
6269 errorText_ = errorStream_.str();
6270 MUTEX_UNLOCK( &stream_.mutex );
6271 error( RtAudioError::SYSTEM_ERROR );
6274 result = dsCaptureBuffer->GetCurrentPosition( NULL, &startSafeReadPointer );
6275 if ( FAILED( result ) ) {
6276 errorStream_ << "RtApiDs::callbackEvent: error (" << getErrorString( result ) << ") getting current read position!";
6277 errorText_ = errorStream_.str();
6278 MUTEX_UNLOCK( &stream_.mutex );
6279 error( RtAudioError::SYSTEM_ERROR );
6283 result = dsWriteBuffer->GetCurrentPosition( NULL, &safeWritePointer );
6284 if ( FAILED( result ) ) {
6285 errorStream_ << "RtApiDs::callbackEvent: error (" << getErrorString( result ) << ") getting current write position!";
6286 errorText_ = errorStream_.str();
6287 MUTEX_UNLOCK( &stream_.mutex );
6288 error( RtAudioError::SYSTEM_ERROR );
6291 result = dsCaptureBuffer->GetCurrentPosition( NULL, &safeReadPointer );
6292 if ( FAILED( result ) ) {
6293 errorStream_ << "RtApiDs::callbackEvent: error (" << getErrorString( result ) << ") getting current read position!";
6294 errorText_ = errorStream_.str();
6295 MUTEX_UNLOCK( &stream_.mutex );
6296 error( RtAudioError::SYSTEM_ERROR );
6299 if ( safeWritePointer != startSafeWritePointer && safeReadPointer != startSafeReadPointer ) break;
6303 //assert( handle->dsBufferSize[0] == handle->dsBufferSize[1] );
6305 handle->bufferPointer[0] = safeWritePointer + handle->dsPointerLeadTime[0];
6306 if ( handle->bufferPointer[0] >= handle->dsBufferSize[0] ) handle->bufferPointer[0] -= handle->dsBufferSize[0];
6307 handle->bufferPointer[1] = safeReadPointer;
6309 else if ( stream_.mode == OUTPUT ) {
6311 // Set the proper nextWritePosition after initial startup.
6312 LPDIRECTSOUNDBUFFER dsWriteBuffer = (LPDIRECTSOUNDBUFFER) handle->buffer[0];
6313 result = dsWriteBuffer->GetCurrentPosition( ¤tWritePointer, &safeWritePointer );
6314 if ( FAILED( result ) ) {
6315 errorStream_ << "RtApiDs::callbackEvent: error (" << getErrorString( result ) << ") getting current write position!";
6316 errorText_ = errorStream_.str();
6317 MUTEX_UNLOCK( &stream_.mutex );
6318 error( RtAudioError::SYSTEM_ERROR );
6321 handle->bufferPointer[0] = safeWritePointer + handle->dsPointerLeadTime[0];
6322 if ( handle->bufferPointer[0] >= handle->dsBufferSize[0] ) handle->bufferPointer[0] -= handle->dsBufferSize[0];
6325 buffersRolling = true;
6328 if ( stream_.mode == OUTPUT || stream_.mode == DUPLEX ) {
6330 LPDIRECTSOUNDBUFFER dsBuffer = (LPDIRECTSOUNDBUFFER) handle->buffer[0];
6332 if ( handle->drainCounter > 1 ) { // write zeros to the output stream
6333 bufferBytes = stream_.bufferSize * stream_.nUserChannels[0];
6334 bufferBytes *= formatBytes( stream_.userFormat );
6335 memset( stream_.userBuffer[0], 0, bufferBytes );
6338 // Setup parameters and do buffer conversion if necessary.
6339 if ( stream_.doConvertBuffer[0] ) {
6340 buffer = stream_.deviceBuffer;
6341 convertBuffer( buffer, stream_.userBuffer[0], stream_.convertInfo[0] );
6342 bufferBytes = stream_.bufferSize * stream_.nDeviceChannels[0];
6343 bufferBytes *= formatBytes( stream_.deviceFormat[0] );
6346 buffer = stream_.userBuffer[0];
6347 bufferBytes = stream_.bufferSize * stream_.nUserChannels[0];
6348 bufferBytes *= formatBytes( stream_.userFormat );
6351 // No byte swapping necessary in DirectSound implementation.
6353 // Ahhh ... windoze. 16-bit data is signed but 8-bit data is
6354 // unsigned. So, we need to convert our signed 8-bit data here to
6356 if ( stream_.deviceFormat[0] == RTAUDIO_SINT8 )
6357 for ( int i=0; i<bufferBytes; i++ ) buffer[i] = (unsigned char) ( buffer[i] + 128 );
6359 DWORD dsBufferSize = handle->dsBufferSize[0];
6360 nextWritePointer = handle->bufferPointer[0];
6362 DWORD endWrite, leadPointer;
6364 // Find out where the read and "safe write" pointers are.
6365 result = dsBuffer->GetCurrentPosition( ¤tWritePointer, &safeWritePointer );
6366 if ( FAILED( result ) ) {
6367 errorStream_ << "RtApiDs::callbackEvent: error (" << getErrorString( result ) << ") getting current write position!";
6368 errorText_ = errorStream_.str();
6369 MUTEX_UNLOCK( &stream_.mutex );
6370 error( RtAudioError::SYSTEM_ERROR );
6374 // We will copy our output buffer into the region between
6375 // safeWritePointer and leadPointer. If leadPointer is not
6376 // beyond the next endWrite position, wait until it is.
6377 leadPointer = safeWritePointer + handle->dsPointerLeadTime[0];
6378 //std::cout << "safeWritePointer = " << safeWritePointer << ", leadPointer = " << leadPointer << ", nextWritePointer = " << nextWritePointer << std::endl;
6379 if ( leadPointer > dsBufferSize ) leadPointer -= dsBufferSize;
6380 if ( leadPointer < nextWritePointer ) leadPointer += dsBufferSize; // unwrap offset
6381 endWrite = nextWritePointer + bufferBytes;
6383 // Check whether the entire write region is behind the play pointer.
6384 if ( leadPointer >= endWrite ) break;
6386 // If we are here, then we must wait until the leadPointer advances
6387 // beyond the end of our next write region. We use the
6388 // Sleep() function to suspend operation until that happens.
6389 double millis = ( endWrite - leadPointer ) * 1000.0;
6390 millis /= ( formatBytes( stream_.deviceFormat[0]) * stream_.nDeviceChannels[0] * stream_.sampleRate);
6391 if ( millis < 1.0 ) millis = 1.0;
6392 Sleep( (DWORD) millis );
6395 if ( dsPointerBetween( nextWritePointer, safeWritePointer, currentWritePointer, dsBufferSize )
6396 || dsPointerBetween( endWrite, safeWritePointer, currentWritePointer, dsBufferSize ) ) {
6397 // We've strayed into the forbidden zone ... resync the read pointer.
6398 handle->xrun[0] = true;
6399 nextWritePointer = safeWritePointer + handle->dsPointerLeadTime[0] - bufferBytes;
6400 if ( nextWritePointer >= dsBufferSize ) nextWritePointer -= dsBufferSize;
6401 handle->bufferPointer[0] = nextWritePointer;
6402 endWrite = nextWritePointer + bufferBytes;
6405 // Lock free space in the buffer
6406 result = dsBuffer->Lock( nextWritePointer, bufferBytes, &buffer1,
6407 &bufferSize1, &buffer2, &bufferSize2, 0 );
6408 if ( FAILED( result ) ) {
6409 errorStream_ << "RtApiDs::callbackEvent: error (" << getErrorString( result ) << ") locking buffer during playback!";
6410 errorText_ = errorStream_.str();
6411 MUTEX_UNLOCK( &stream_.mutex );
6412 error( RtAudioError::SYSTEM_ERROR );
6416 // Copy our buffer into the DS buffer
6417 CopyMemory( buffer1, buffer, bufferSize1 );
6418 if ( buffer2 != NULL ) CopyMemory( buffer2, buffer+bufferSize1, bufferSize2 );
6420 // Update our buffer offset and unlock sound buffer
6421 dsBuffer->Unlock( buffer1, bufferSize1, buffer2, bufferSize2 );
6422 if ( FAILED( result ) ) {
6423 errorStream_ << "RtApiDs::callbackEvent: error (" << getErrorString( result ) << ") unlocking buffer during playback!";
6424 errorText_ = errorStream_.str();
6425 MUTEX_UNLOCK( &stream_.mutex );
6426 error( RtAudioError::SYSTEM_ERROR );
6429 nextWritePointer = ( nextWritePointer + bufferSize1 + bufferSize2 ) % dsBufferSize;
6430 handle->bufferPointer[0] = nextWritePointer;
6433 // Don't bother draining input
6434 if ( handle->drainCounter ) {
6435 handle->drainCounter++;
6439 if ( stream_.mode == INPUT || stream_.mode == DUPLEX ) {
6441 // Setup parameters.
6442 if ( stream_.doConvertBuffer[1] ) {
6443 buffer = stream_.deviceBuffer;
6444 bufferBytes = stream_.bufferSize * stream_.nDeviceChannels[1];
6445 bufferBytes *= formatBytes( stream_.deviceFormat[1] );
6448 buffer = stream_.userBuffer[1];
6449 bufferBytes = stream_.bufferSize * stream_.nUserChannels[1];
6450 bufferBytes *= formatBytes( stream_.userFormat );
6453 LPDIRECTSOUNDCAPTUREBUFFER dsBuffer = (LPDIRECTSOUNDCAPTUREBUFFER) handle->buffer[1];
6454 long nextReadPointer = handle->bufferPointer[1];
6455 DWORD dsBufferSize = handle->dsBufferSize[1];
6457 // Find out where the write and "safe read" pointers are.
6458 result = dsBuffer->GetCurrentPosition( ¤tReadPointer, &safeReadPointer );
6459 if ( FAILED( result ) ) {
6460 errorStream_ << "RtApiDs::callbackEvent: error (" << getErrorString( result ) << ") getting current read position!";
6461 errorText_ = errorStream_.str();
6462 MUTEX_UNLOCK( &stream_.mutex );
6463 error( RtAudioError::SYSTEM_ERROR );
6467 if ( safeReadPointer < (DWORD)nextReadPointer ) safeReadPointer += dsBufferSize; // unwrap offset
6468 DWORD endRead = nextReadPointer + bufferBytes;
6470 // Handling depends on whether we are INPUT or DUPLEX.
6471 // If we're in INPUT mode then waiting is a good thing. If we're in DUPLEX mode,
6472 // then a wait here will drag the write pointers into the forbidden zone.
6474 // In DUPLEX mode, rather than wait, we will back off the read pointer until
6475 // it's in a safe position. This causes dropouts, but it seems to be the only
6476 // practical way to sync up the read and write pointers reliably, given the
6477 // the very complex relationship between phase and increment of the read and write
6480 // In order to minimize audible dropouts in DUPLEX mode, we will
6481 // provide a pre-roll period of 0.5 seconds in which we return
6482 // zeros from the read buffer while the pointers sync up.
6484 if ( stream_.mode == DUPLEX ) {
6485 if ( safeReadPointer < endRead ) {
6486 if ( duplexPrerollBytes <= 0 ) {
6487 // Pre-roll time over. Be more agressive.
6488 int adjustment = endRead-safeReadPointer;
6490 handle->xrun[1] = true;
6492 // - large adjustments: we've probably run out of CPU cycles, so just resync exactly,
6493 // and perform fine adjustments later.
6494 // - small adjustments: back off by twice as much.
6495 if ( adjustment >= 2*bufferBytes )
6496 nextReadPointer = safeReadPointer-2*bufferBytes;
6498 nextReadPointer = safeReadPointer-bufferBytes-adjustment;
6500 if ( nextReadPointer < 0 ) nextReadPointer += dsBufferSize;
6504 // In pre=roll time. Just do it.
6505 nextReadPointer = safeReadPointer - bufferBytes;
6506 while ( nextReadPointer < 0 ) nextReadPointer += dsBufferSize;
6508 endRead = nextReadPointer + bufferBytes;
6511 else { // mode == INPUT
6512 while ( safeReadPointer < endRead && stream_.callbackInfo.isRunning ) {
6513 // See comments for playback.
6514 double millis = (endRead - safeReadPointer) * 1000.0;
6515 millis /= ( formatBytes(stream_.deviceFormat[1]) * stream_.nDeviceChannels[1] * stream_.sampleRate);
6516 if ( millis < 1.0 ) millis = 1.0;
6517 Sleep( (DWORD) millis );
6519 // Wake up and find out where we are now.
6520 result = dsBuffer->GetCurrentPosition( ¤tReadPointer, &safeReadPointer );
6521 if ( FAILED( result ) ) {
6522 errorStream_ << "RtApiDs::callbackEvent: error (" << getErrorString( result ) << ") getting current read position!";
6523 errorText_ = errorStream_.str();
6524 MUTEX_UNLOCK( &stream_.mutex );
6525 error( RtAudioError::SYSTEM_ERROR );
6529 if ( safeReadPointer < (DWORD)nextReadPointer ) safeReadPointer += dsBufferSize; // unwrap offset
6533 // Lock free space in the buffer
6534 result = dsBuffer->Lock( nextReadPointer, bufferBytes, &buffer1,
6535 &bufferSize1, &buffer2, &bufferSize2, 0 );
6536 if ( FAILED( result ) ) {
6537 errorStream_ << "RtApiDs::callbackEvent: error (" << getErrorString( result ) << ") locking capture buffer!";
6538 errorText_ = errorStream_.str();
6539 MUTEX_UNLOCK( &stream_.mutex );
6540 error( RtAudioError::SYSTEM_ERROR );
6544 if ( duplexPrerollBytes <= 0 ) {
6545 // Copy our buffer into the DS buffer
6546 CopyMemory( buffer, buffer1, bufferSize1 );
6547 if ( buffer2 != NULL ) CopyMemory( buffer+bufferSize1, buffer2, bufferSize2 );
6550 memset( buffer, 0, bufferSize1 );
6551 if ( buffer2 != NULL ) memset( buffer + bufferSize1, 0, bufferSize2 );
6552 duplexPrerollBytes -= bufferSize1 + bufferSize2;
6555 // Update our buffer offset and unlock sound buffer
6556 nextReadPointer = ( nextReadPointer + bufferSize1 + bufferSize2 ) % dsBufferSize;
6557 dsBuffer->Unlock( buffer1, bufferSize1, buffer2, bufferSize2 );
6558 if ( FAILED( result ) ) {
6559 errorStream_ << "RtApiDs::callbackEvent: error (" << getErrorString( result ) << ") unlocking capture buffer!";
6560 errorText_ = errorStream_.str();
6561 MUTEX_UNLOCK( &stream_.mutex );
6562 error( RtAudioError::SYSTEM_ERROR );
6565 handle->bufferPointer[1] = nextReadPointer;
6567 // No byte swapping necessary in DirectSound implementation.
6569 // If necessary, convert 8-bit data from unsigned to signed.
6570 if ( stream_.deviceFormat[1] == RTAUDIO_SINT8 )
6571 for ( int j=0; j<bufferBytes; j++ ) buffer[j] = (signed char) ( buffer[j] - 128 );
6573 // Do buffer conversion if necessary.
6574 if ( stream_.doConvertBuffer[1] )
6575 convertBuffer( stream_.userBuffer[1], stream_.deviceBuffer, stream_.convertInfo[1] );
6579 MUTEX_UNLOCK( &stream_.mutex );
6580 RtApi::tickStreamTime();
6583 // Definitions for utility functions and callbacks
6584 // specific to the DirectSound implementation.
6586 static unsigned __stdcall callbackHandler( void *ptr )
6588 CallbackInfo *info = (CallbackInfo *) ptr;
6589 RtApiDs *object = (RtApiDs *) info->object;
6590 bool* isRunning = &info->isRunning;
6592 while ( *isRunning == true ) {
6593 object->callbackEvent();
6600 static BOOL CALLBACK deviceQueryCallback( LPGUID lpguid,
6601 LPCTSTR description,
6605 struct DsProbeData& probeInfo = *(struct DsProbeData*) lpContext;
6606 std::vector<struct DsDevice>& dsDevices = *probeInfo.dsDevices;
6609 bool validDevice = false;
6610 if ( probeInfo.isInput == true ) {
6612 LPDIRECTSOUNDCAPTURE object;
6614 hr = DirectSoundCaptureCreate( lpguid, &object, NULL );
6615 if ( hr != DS_OK ) return TRUE;
6617 caps.dwSize = sizeof(caps);
6618 hr = object->GetCaps( &caps );
6619 if ( hr == DS_OK ) {
6620 if ( caps.dwChannels > 0 && caps.dwFormats > 0 )
6627 LPDIRECTSOUND object;
6628 hr = DirectSoundCreate( lpguid, &object, NULL );
6629 if ( hr != DS_OK ) return TRUE;
6631 caps.dwSize = sizeof(caps);
6632 hr = object->GetCaps( &caps );
6633 if ( hr == DS_OK ) {
6634 if ( caps.dwFlags & DSCAPS_PRIMARYMONO || caps.dwFlags & DSCAPS_PRIMARYSTEREO )
6640 // If good device, then save its name and guid.
6641 std::string name = convertCharPointerToStdString( description );
6642 //if ( name == "Primary Sound Driver" || name == "Primary Sound Capture Driver" )
6643 if ( lpguid == NULL )
6644 name = "Default Device";
6645 if ( validDevice ) {
6646 for ( unsigned int i=0; i<dsDevices.size(); i++ ) {
6647 if ( dsDevices[i].name == name ) {
6648 dsDevices[i].found = true;
6649 if ( probeInfo.isInput ) {
6650 dsDevices[i].id[1] = lpguid;
6651 dsDevices[i].validId[1] = true;
6654 dsDevices[i].id[0] = lpguid;
6655 dsDevices[i].validId[0] = true;
6663 device.found = true;
6664 if ( probeInfo.isInput ) {
6665 device.id[1] = lpguid;
6666 device.validId[1] = true;
6669 device.id[0] = lpguid;
6670 device.validId[0] = true;
6672 dsDevices.push_back( device );
6678 static const char* getErrorString( int code )
6682 case DSERR_ALLOCATED:
6683 return "Already allocated";
6685 case DSERR_CONTROLUNAVAIL:
6686 return "Control unavailable";
6688 case DSERR_INVALIDPARAM:
6689 return "Invalid parameter";
6691 case DSERR_INVALIDCALL:
6692 return "Invalid call";
6695 return "Generic error";
6697 case DSERR_PRIOLEVELNEEDED:
6698 return "Priority level needed";
6700 case DSERR_OUTOFMEMORY:
6701 return "Out of memory";
6703 case DSERR_BADFORMAT:
6704 return "The sample rate or the channel format is not supported";
6706 case DSERR_UNSUPPORTED:
6707 return "Not supported";
6709 case DSERR_NODRIVER:
6712 case DSERR_ALREADYINITIALIZED:
6713 return "Already initialized";
6715 case DSERR_NOAGGREGATION:
6716 return "No aggregation";
6718 case DSERR_BUFFERLOST:
6719 return "Buffer lost";
6721 case DSERR_OTHERAPPHASPRIO:
6722 return "Another application already has priority";
6724 case DSERR_UNINITIALIZED:
6725 return "Uninitialized";
6728 return "DirectSound unknown error";
6731 //******************** End of __WINDOWS_DS__ *********************//
6735 #if defined(__LINUX_ALSA__)
6737 #include <alsa/asoundlib.h>
6740 // A structure to hold various information related to the ALSA API
6743 snd_pcm_t *handles[2];
6746 pthread_cond_t runnable_cv;
6750 :synchronized(false), runnable(false) { xrun[0] = false; xrun[1] = false; }
6753 static void *alsaCallbackHandler( void * ptr );
6755 RtApiAlsa :: RtApiAlsa()
6757 // Nothing to do here.
6760 RtApiAlsa :: ~RtApiAlsa()
6762 if ( stream_.state != STREAM_CLOSED ) closeStream();
6765 unsigned int RtApiAlsa :: getDeviceCount( void )
6767 unsigned nDevices = 0;
6768 int result, subdevice, card;
6772 // Count cards and devices
6774 snd_card_next( &card );
6775 while ( card >= 0 ) {
6776 sprintf( name, "hw:%d", card );
6777 result = snd_ctl_open( &handle, name, 0 );
6779 errorStream_ << "RtApiAlsa::getDeviceCount: control open, card = " << card << ", " << snd_strerror( result ) << ".";
6780 errorText_ = errorStream_.str();
6781 error( RtAudioError::WARNING );
6786 result = snd_ctl_pcm_next_device( handle, &subdevice );
6788 errorStream_ << "RtApiAlsa::getDeviceCount: control next device, card = " << card << ", " << snd_strerror( result ) << ".";
6789 errorText_ = errorStream_.str();
6790 error( RtAudioError::WARNING );
6793 if ( subdevice < 0 )
6798 snd_ctl_close( handle );
6799 snd_card_next( &card );
6802 result = snd_ctl_open( &handle, "default", 0 );
6805 snd_ctl_close( handle );
6811 RtAudio::DeviceInfo RtApiAlsa :: getDeviceInfo( unsigned int device )
6813 RtAudio::DeviceInfo info;
6814 info.probed = false;
6816 unsigned nDevices = 0;
6817 int result, subdevice, card;
6821 // Count cards and devices
6824 snd_card_next( &card );
6825 while ( card >= 0 ) {
6826 sprintf( name, "hw:%d", card );
6827 result = snd_ctl_open( &chandle, name, SND_CTL_NONBLOCK );
6829 errorStream_ << "RtApiAlsa::getDeviceInfo: control open, card = " << card << ", " << snd_strerror( result ) << ".";
6830 errorText_ = errorStream_.str();
6831 error( RtAudioError::WARNING );
6836 result = snd_ctl_pcm_next_device( chandle, &subdevice );
6838 errorStream_ << "RtApiAlsa::getDeviceInfo: control next device, card = " << card << ", " << snd_strerror( result ) << ".";
6839 errorText_ = errorStream_.str();
6840 error( RtAudioError::WARNING );
6843 if ( subdevice < 0 ) break;
6844 if ( nDevices == device ) {
6845 sprintf( name, "hw:%d,%d", card, subdevice );
6851 snd_ctl_close( chandle );
6852 snd_card_next( &card );
6855 result = snd_ctl_open( &chandle, "default", SND_CTL_NONBLOCK );
6856 if ( result == 0 ) {
6857 if ( nDevices == device ) {
6858 strcpy( name, "default" );
6864 if ( nDevices == 0 ) {
6865 errorText_ = "RtApiAlsa::getDeviceInfo: no devices found!";
6866 error( RtAudioError::INVALID_USE );
6870 if ( device >= nDevices ) {
6871 errorText_ = "RtApiAlsa::getDeviceInfo: device ID is invalid!";
6872 error( RtAudioError::INVALID_USE );
6878 // If a stream is already open, we cannot probe the stream devices.
6879 // Thus, use the saved results.
6880 if ( stream_.state != STREAM_CLOSED &&
6881 ( stream_.device[0] == device || stream_.device[1] == device ) ) {
6882 snd_ctl_close( chandle );
6883 if ( device >= devices_.size() ) {
6884 errorText_ = "RtApiAlsa::getDeviceInfo: device ID was not present before stream was opened.";
6885 error( RtAudioError::WARNING );
6888 return devices_[ device ];
6891 int openMode = SND_PCM_ASYNC;
6892 snd_pcm_stream_t stream;
6893 snd_pcm_info_t *pcminfo;
6894 snd_pcm_info_alloca( &pcminfo );
6896 snd_pcm_hw_params_t *params;
6897 snd_pcm_hw_params_alloca( ¶ms );
6899 // First try for playback unless default device (which has subdev -1)
6900 stream = SND_PCM_STREAM_PLAYBACK;
6901 snd_pcm_info_set_stream( pcminfo, stream );
6902 if ( subdevice != -1 ) {
6903 snd_pcm_info_set_device( pcminfo, subdevice );
6904 snd_pcm_info_set_subdevice( pcminfo, 0 );
6906 result = snd_ctl_pcm_info( chandle, pcminfo );
6908 // Device probably doesn't support playback.
6913 result = snd_pcm_open( &phandle, name, stream, openMode | SND_PCM_NONBLOCK );
6915 errorStream_ << "RtApiAlsa::getDeviceInfo: snd_pcm_open error for device (" << name << "), " << snd_strerror( result ) << ".";
6916 errorText_ = errorStream_.str();
6917 error( RtAudioError::WARNING );
6921 // The device is open ... fill the parameter structure.
6922 result = snd_pcm_hw_params_any( phandle, params );
6924 snd_pcm_close( phandle );
6925 errorStream_ << "RtApiAlsa::getDeviceInfo: snd_pcm_hw_params error for device (" << name << "), " << snd_strerror( result ) << ".";
6926 errorText_ = errorStream_.str();
6927 error( RtAudioError::WARNING );
6931 // Get output channel information.
6933 result = snd_pcm_hw_params_get_channels_max( params, &value );
6935 snd_pcm_close( phandle );
6936 errorStream_ << "RtApiAlsa::getDeviceInfo: error getting device (" << name << ") output channels, " << snd_strerror( result ) << ".";
6937 errorText_ = errorStream_.str();
6938 error( RtAudioError::WARNING );
6941 info.outputChannels = value;
6942 snd_pcm_close( phandle );
6945 stream = SND_PCM_STREAM_CAPTURE;
6946 snd_pcm_info_set_stream( pcminfo, stream );
6948 // Now try for capture unless default device (with subdev = -1)
6949 if ( subdevice != -1 ) {
6950 result = snd_ctl_pcm_info( chandle, pcminfo );
6951 snd_ctl_close( chandle );
6953 // Device probably doesn't support capture.
6954 if ( info.outputChannels == 0 ) return info;
6955 goto probeParameters;
6959 snd_ctl_close( chandle );
6961 result = snd_pcm_open( &phandle, name, stream, openMode | SND_PCM_NONBLOCK);
6963 errorStream_ << "RtApiAlsa::getDeviceInfo: snd_pcm_open error for device (" << name << "), " << snd_strerror( result ) << ".";
6964 errorText_ = errorStream_.str();
6965 error( RtAudioError::WARNING );
6966 if ( info.outputChannels == 0 ) return info;
6967 goto probeParameters;
6970 // The device is open ... fill the parameter structure.
6971 result = snd_pcm_hw_params_any( phandle, params );
6973 snd_pcm_close( phandle );
6974 errorStream_ << "RtApiAlsa::getDeviceInfo: snd_pcm_hw_params error for device (" << name << "), " << snd_strerror( result ) << ".";
6975 errorText_ = errorStream_.str();
6976 error( RtAudioError::WARNING );
6977 if ( info.outputChannels == 0 ) return info;
6978 goto probeParameters;
6981 result = snd_pcm_hw_params_get_channels_max( params, &value );
6983 snd_pcm_close( phandle );
6984 errorStream_ << "RtApiAlsa::getDeviceInfo: error getting device (" << name << ") input channels, " << snd_strerror( result ) << ".";
6985 errorText_ = errorStream_.str();
6986 error( RtAudioError::WARNING );
6987 if ( info.outputChannels == 0 ) return info;
6988 goto probeParameters;
6990 info.inputChannels = value;
6991 snd_pcm_close( phandle );
6993 // If device opens for both playback and capture, we determine the channels.
6994 if ( info.outputChannels > 0 && info.inputChannels > 0 )
6995 info.duplexChannels = (info.outputChannels > info.inputChannels) ? info.inputChannels : info.outputChannels;
6997 // ALSA doesn't provide default devices so we'll use the first available one.
6998 if ( device == 0 && info.outputChannels > 0 )
6999 info.isDefaultOutput = true;
7000 if ( device == 0 && info.inputChannels > 0 )
7001 info.isDefaultInput = true;
7004 // At this point, we just need to figure out the supported data
7005 // formats and sample rates. We'll proceed by opening the device in
7006 // the direction with the maximum number of channels, or playback if
7007 // they are equal. This might limit our sample rate options, but so
7010 if ( info.outputChannels >= info.inputChannels )
7011 stream = SND_PCM_STREAM_PLAYBACK;
7013 stream = SND_PCM_STREAM_CAPTURE;
7014 snd_pcm_info_set_stream( pcminfo, stream );
7016 result = snd_pcm_open( &phandle, name, stream, openMode | SND_PCM_NONBLOCK);
7018 errorStream_ << "RtApiAlsa::getDeviceInfo: snd_pcm_open error for device (" << name << "), " << snd_strerror( result ) << ".";
7019 errorText_ = errorStream_.str();
7020 error( RtAudioError::WARNING );
7024 // The device is open ... fill the parameter structure.
7025 result = snd_pcm_hw_params_any( phandle, params );
7027 snd_pcm_close( phandle );
7028 errorStream_ << "RtApiAlsa::getDeviceInfo: snd_pcm_hw_params error for device (" << name << "), " << snd_strerror( result ) << ".";
7029 errorText_ = errorStream_.str();
7030 error( RtAudioError::WARNING );
7034 // Test our discrete set of sample rate values.
7035 info.sampleRates.clear();
7036 for ( unsigned int i=0; i<MAX_SAMPLE_RATES; i++ ) {
7037 if ( snd_pcm_hw_params_test_rate( phandle, params, SAMPLE_RATES[i], 0 ) == 0 ) {
7038 info.sampleRates.push_back( SAMPLE_RATES[i] );
7040 if ( !info.preferredSampleRate || ( SAMPLE_RATES[i] <= 48000 && SAMPLE_RATES[i] > info.preferredSampleRate ) )
7041 info.preferredSampleRate = SAMPLE_RATES[i];
7044 if ( info.sampleRates.size() == 0 ) {
7045 snd_pcm_close( phandle );
7046 errorStream_ << "RtApiAlsa::getDeviceInfo: no supported sample rates found for device (" << name << ").";
7047 errorText_ = errorStream_.str();
7048 error( RtAudioError::WARNING );
7052 // Probe the supported data formats ... we don't care about endian-ness just yet
7053 snd_pcm_format_t format;
7054 info.nativeFormats = 0;
7055 format = SND_PCM_FORMAT_S8;
7056 if ( snd_pcm_hw_params_test_format( phandle, params, format ) == 0 )
7057 info.nativeFormats |= RTAUDIO_SINT8;
7058 format = SND_PCM_FORMAT_S16;
7059 if ( snd_pcm_hw_params_test_format( phandle, params, format ) == 0 )
7060 info.nativeFormats |= RTAUDIO_SINT16;
7061 format = SND_PCM_FORMAT_S24;
7062 if ( snd_pcm_hw_params_test_format( phandle, params, format ) == 0 )
7063 info.nativeFormats |= RTAUDIO_SINT24;
7064 format = SND_PCM_FORMAT_S32;
7065 if ( snd_pcm_hw_params_test_format( phandle, params, format ) == 0 )
7066 info.nativeFormats |= RTAUDIO_SINT32;
7067 format = SND_PCM_FORMAT_FLOAT;
7068 if ( snd_pcm_hw_params_test_format( phandle, params, format ) == 0 )
7069 info.nativeFormats |= RTAUDIO_FLOAT32;
7070 format = SND_PCM_FORMAT_FLOAT64;
7071 if ( snd_pcm_hw_params_test_format( phandle, params, format ) == 0 )
7072 info.nativeFormats |= RTAUDIO_FLOAT64;
7074 // Check that we have at least one supported format
7075 if ( info.nativeFormats == 0 ) {
7076 snd_pcm_close( phandle );
7077 errorStream_ << "RtApiAlsa::getDeviceInfo: pcm device (" << name << ") data format not supported by RtAudio.";
7078 errorText_ = errorStream_.str();
7079 error( RtAudioError::WARNING );
7083 // Get the device name
7085 result = snd_card_get_name( card, &cardname );
7086 if ( result >= 0 ) {
7087 sprintf( name, "hw:%s,%d", cardname, subdevice );
7092 // That's all ... close the device and return
7093 snd_pcm_close( phandle );
7098 void RtApiAlsa :: saveDeviceInfo( void )
7102 unsigned int nDevices = getDeviceCount();
7103 devices_.resize( nDevices );
7104 for ( unsigned int i=0; i<nDevices; i++ )
7105 devices_[i] = getDeviceInfo( i );
7108 bool RtApiAlsa :: probeDeviceOpen( unsigned int device, StreamMode mode, unsigned int channels,
7109 unsigned int firstChannel, unsigned int sampleRate,
7110 RtAudioFormat format, unsigned int *bufferSize,
7111 RtAudio::StreamOptions *options )
7114 #if defined(__RTAUDIO_DEBUG__)
7116 snd_output_stdio_attach(&out, stderr, 0);
7119 // I'm not using the "plug" interface ... too much inconsistent behavior.
7121 unsigned nDevices = 0;
7122 int result, subdevice, card;
7126 if ( options && options->flags & RTAUDIO_ALSA_USE_DEFAULT )
7127 snprintf(name, sizeof(name), "%s", "default");
7129 // Count cards and devices
7131 snd_card_next( &card );
7132 while ( card >= 0 ) {
7133 sprintf( name, "hw:%d", card );
7134 result = snd_ctl_open( &chandle, name, SND_CTL_NONBLOCK );
7136 errorStream_ << "RtApiAlsa::probeDeviceOpen: control open, card = " << card << ", " << snd_strerror( result ) << ".";
7137 errorText_ = errorStream_.str();
7142 result = snd_ctl_pcm_next_device( chandle, &subdevice );
7143 if ( result < 0 ) break;
7144 if ( subdevice < 0 ) break;
7145 if ( nDevices == device ) {
7146 sprintf( name, "hw:%d,%d", card, subdevice );
7147 snd_ctl_close( chandle );
7152 snd_ctl_close( chandle );
7153 snd_card_next( &card );
7156 result = snd_ctl_open( &chandle, "default", SND_CTL_NONBLOCK );
7157 if ( result == 0 ) {
7158 if ( nDevices == device ) {
7159 strcpy( name, "default" );
7165 if ( nDevices == 0 ) {
7166 // This should not happen because a check is made before this function is called.
7167 errorText_ = "RtApiAlsa::probeDeviceOpen: no devices found!";
7171 if ( device >= nDevices ) {
7172 // This should not happen because a check is made before this function is called.
7173 errorText_ = "RtApiAlsa::probeDeviceOpen: device ID is invalid!";
7180 // The getDeviceInfo() function will not work for a device that is
7181 // already open. Thus, we'll probe the system before opening a
7182 // stream and save the results for use by getDeviceInfo().
7183 if ( mode == OUTPUT || ( mode == INPUT && stream_.mode != OUTPUT ) ) // only do once
7184 this->saveDeviceInfo();
7186 snd_pcm_stream_t stream;
7187 if ( mode == OUTPUT )
7188 stream = SND_PCM_STREAM_PLAYBACK;
7190 stream = SND_PCM_STREAM_CAPTURE;
7193 int openMode = SND_PCM_ASYNC;
7194 result = snd_pcm_open( &phandle, name, stream, openMode );
7196 if ( mode == OUTPUT )
7197 errorStream_ << "RtApiAlsa::probeDeviceOpen: pcm device (" << name << ") won't open for output.";
7199 errorStream_ << "RtApiAlsa::probeDeviceOpen: pcm device (" << name << ") won't open for input.";
7200 errorText_ = errorStream_.str();
7204 // Fill the parameter structure.
7205 snd_pcm_hw_params_t *hw_params;
7206 snd_pcm_hw_params_alloca( &hw_params );
7207 result = snd_pcm_hw_params_any( phandle, hw_params );
7209 snd_pcm_close( phandle );
7210 errorStream_ << "RtApiAlsa::probeDeviceOpen: error getting pcm device (" << name << ") parameters, " << snd_strerror( result ) << ".";
7211 errorText_ = errorStream_.str();
7215 #if defined(__RTAUDIO_DEBUG__)
7216 fprintf( stderr, "\nRtApiAlsa: dump hardware params just after device open:\n\n" );
7217 snd_pcm_hw_params_dump( hw_params, out );
7220 // Set access ... check user preference.
7221 if ( options && options->flags & RTAUDIO_NONINTERLEAVED ) {
7222 stream_.userInterleaved = false;
7223 result = snd_pcm_hw_params_set_access( phandle, hw_params, SND_PCM_ACCESS_RW_NONINTERLEAVED );
7225 result = snd_pcm_hw_params_set_access( phandle, hw_params, SND_PCM_ACCESS_RW_INTERLEAVED );
7226 stream_.deviceInterleaved[mode] = true;
7229 stream_.deviceInterleaved[mode] = false;
7232 stream_.userInterleaved = true;
7233 result = snd_pcm_hw_params_set_access( phandle, hw_params, SND_PCM_ACCESS_RW_INTERLEAVED );
7235 result = snd_pcm_hw_params_set_access( phandle, hw_params, SND_PCM_ACCESS_RW_NONINTERLEAVED );
7236 stream_.deviceInterleaved[mode] = false;
7239 stream_.deviceInterleaved[mode] = true;
7243 snd_pcm_close( phandle );
7244 errorStream_ << "RtApiAlsa::probeDeviceOpen: error setting pcm device (" << name << ") access, " << snd_strerror( result ) << ".";
7245 errorText_ = errorStream_.str();
7249 // Determine how to set the device format.
7250 stream_.userFormat = format;
7251 snd_pcm_format_t deviceFormat = SND_PCM_FORMAT_UNKNOWN;
7253 if ( format == RTAUDIO_SINT8 )
7254 deviceFormat = SND_PCM_FORMAT_S8;
7255 else if ( format == RTAUDIO_SINT16 )
7256 deviceFormat = SND_PCM_FORMAT_S16;
7257 else if ( format == RTAUDIO_SINT24 )
7258 deviceFormat = SND_PCM_FORMAT_S24;
7259 else if ( format == RTAUDIO_SINT32 )
7260 deviceFormat = SND_PCM_FORMAT_S32;
7261 else if ( format == RTAUDIO_FLOAT32 )
7262 deviceFormat = SND_PCM_FORMAT_FLOAT;
7263 else if ( format == RTAUDIO_FLOAT64 )
7264 deviceFormat = SND_PCM_FORMAT_FLOAT64;
7266 if ( snd_pcm_hw_params_test_format(phandle, hw_params, deviceFormat) == 0) {
7267 stream_.deviceFormat[mode] = format;
7271 // The user requested format is not natively supported by the device.
7272 deviceFormat = SND_PCM_FORMAT_FLOAT64;
7273 if ( snd_pcm_hw_params_test_format( phandle, hw_params, deviceFormat ) == 0 ) {
7274 stream_.deviceFormat[mode] = RTAUDIO_FLOAT64;
7278 deviceFormat = SND_PCM_FORMAT_FLOAT;
7279 if ( snd_pcm_hw_params_test_format(phandle, hw_params, deviceFormat ) == 0 ) {
7280 stream_.deviceFormat[mode] = RTAUDIO_FLOAT32;
7284 deviceFormat = SND_PCM_FORMAT_S32;
7285 if ( snd_pcm_hw_params_test_format(phandle, hw_params, deviceFormat ) == 0 ) {
7286 stream_.deviceFormat[mode] = RTAUDIO_SINT32;
7290 deviceFormat = SND_PCM_FORMAT_S24;
7291 if ( snd_pcm_hw_params_test_format(phandle, hw_params, deviceFormat ) == 0 ) {
7292 stream_.deviceFormat[mode] = RTAUDIO_SINT24;
7296 deviceFormat = SND_PCM_FORMAT_S16;
7297 if ( snd_pcm_hw_params_test_format(phandle, hw_params, deviceFormat ) == 0 ) {
7298 stream_.deviceFormat[mode] = RTAUDIO_SINT16;
7302 deviceFormat = SND_PCM_FORMAT_S8;
7303 if ( snd_pcm_hw_params_test_format(phandle, hw_params, deviceFormat ) == 0 ) {
7304 stream_.deviceFormat[mode] = RTAUDIO_SINT8;
7308 // If we get here, no supported format was found.
7309 snd_pcm_close( phandle );
7310 errorStream_ << "RtApiAlsa::probeDeviceOpen: pcm device " << device << " data format not supported by RtAudio.";
7311 errorText_ = errorStream_.str();
7315 result = snd_pcm_hw_params_set_format( phandle, hw_params, deviceFormat );
7317 snd_pcm_close( phandle );
7318 errorStream_ << "RtApiAlsa::probeDeviceOpen: error setting pcm device (" << name << ") data format, " << snd_strerror( result ) << ".";
7319 errorText_ = errorStream_.str();
7323 // Determine whether byte-swaping is necessary.
7324 stream_.doByteSwap[mode] = false;
7325 if ( deviceFormat != SND_PCM_FORMAT_S8 ) {
7326 result = snd_pcm_format_cpu_endian( deviceFormat );
7328 stream_.doByteSwap[mode] = true;
7329 else if (result < 0) {
7330 snd_pcm_close( phandle );
7331 errorStream_ << "RtApiAlsa::probeDeviceOpen: error getting pcm device (" << name << ") endian-ness, " << snd_strerror( result ) << ".";
7332 errorText_ = errorStream_.str();
7337 // Set the sample rate.
7338 result = snd_pcm_hw_params_set_rate_near( phandle, hw_params, (unsigned int*) &sampleRate, 0 );
7340 snd_pcm_close( phandle );
7341 errorStream_ << "RtApiAlsa::probeDeviceOpen: error setting sample rate on device (" << name << "), " << snd_strerror( result ) << ".";
7342 errorText_ = errorStream_.str();
7346 // Determine the number of channels for this device. We support a possible
7347 // minimum device channel number > than the value requested by the user.
7348 stream_.nUserChannels[mode] = channels;
7350 result = snd_pcm_hw_params_get_channels_max( hw_params, &value );
7351 unsigned int deviceChannels = value;
7352 if ( result < 0 || deviceChannels < channels + firstChannel ) {
7353 snd_pcm_close( phandle );
7354 errorStream_ << "RtApiAlsa::probeDeviceOpen: requested channel parameters not supported by device (" << name << "), " << snd_strerror( result ) << ".";
7355 errorText_ = errorStream_.str();
7359 result = snd_pcm_hw_params_get_channels_min( hw_params, &value );
7361 snd_pcm_close( phandle );
7362 errorStream_ << "RtApiAlsa::probeDeviceOpen: error getting minimum channels for device (" << name << "), " << snd_strerror( result ) << ".";
7363 errorText_ = errorStream_.str();
7366 deviceChannels = value;
7367 if ( deviceChannels < channels + firstChannel ) deviceChannels = channels + firstChannel;
7368 stream_.nDeviceChannels[mode] = deviceChannels;
7370 // Set the device channels.
7371 result = snd_pcm_hw_params_set_channels( phandle, hw_params, deviceChannels );
7373 snd_pcm_close( phandle );
7374 errorStream_ << "RtApiAlsa::probeDeviceOpen: error setting channels for device (" << name << "), " << snd_strerror( result ) << ".";
7375 errorText_ = errorStream_.str();
7379 // Set the buffer (or period) size.
7381 snd_pcm_uframes_t periodSize = *bufferSize;
7382 result = snd_pcm_hw_params_set_period_size_near( phandle, hw_params, &periodSize, &dir );
7384 snd_pcm_close( phandle );
7385 errorStream_ << "RtApiAlsa::probeDeviceOpen: error setting period size for device (" << name << "), " << snd_strerror( result ) << ".";
7386 errorText_ = errorStream_.str();
7389 *bufferSize = periodSize;
7391 // Set the buffer number, which in ALSA is referred to as the "period".
7392 unsigned int periods = 0;
7393 if ( options && options->flags & RTAUDIO_MINIMIZE_LATENCY ) periods = 2;
7394 if ( options && options->numberOfBuffers > 0 ) periods = options->numberOfBuffers;
7395 if ( periods < 2 ) periods = 4; // a fairly safe default value
7396 result = snd_pcm_hw_params_set_periods_near( phandle, hw_params, &periods, &dir );
7398 snd_pcm_close( phandle );
7399 errorStream_ << "RtApiAlsa::probeDeviceOpen: error setting periods for device (" << name << "), " << snd_strerror( result ) << ".";
7400 errorText_ = errorStream_.str();
7404 // If attempting to setup a duplex stream, the bufferSize parameter
7405 // MUST be the same in both directions!
7406 if ( stream_.mode == OUTPUT && mode == INPUT && *bufferSize != stream_.bufferSize ) {
7407 snd_pcm_close( phandle );
7408 errorStream_ << "RtApiAlsa::probeDeviceOpen: system error setting buffer size for duplex stream on device (" << name << ").";
7409 errorText_ = errorStream_.str();
7413 stream_.bufferSize = *bufferSize;
7415 // Install the hardware configuration
7416 result = snd_pcm_hw_params( phandle, hw_params );
7418 snd_pcm_close( phandle );
7419 errorStream_ << "RtApiAlsa::probeDeviceOpen: error installing hardware configuration on device (" << name << "), " << snd_strerror( result ) << ".";
7420 errorText_ = errorStream_.str();
7424 #if defined(__RTAUDIO_DEBUG__)
7425 fprintf(stderr, "\nRtApiAlsa: dump hardware params after installation:\n\n");
7426 snd_pcm_hw_params_dump( hw_params, out );
7429 // Set the software configuration to fill buffers with zeros and prevent device stopping on xruns.
7430 snd_pcm_sw_params_t *sw_params = NULL;
7431 snd_pcm_sw_params_alloca( &sw_params );
7432 snd_pcm_sw_params_current( phandle, sw_params );
7433 snd_pcm_sw_params_set_start_threshold( phandle, sw_params, *bufferSize );
7434 snd_pcm_sw_params_set_stop_threshold( phandle, sw_params, ULONG_MAX );
7435 snd_pcm_sw_params_set_silence_threshold( phandle, sw_params, 0 );
7437 // The following two settings were suggested by Theo Veenker
7438 //snd_pcm_sw_params_set_avail_min( phandle, sw_params, *bufferSize );
7439 //snd_pcm_sw_params_set_xfer_align( phandle, sw_params, 1 );
7441 // here are two options for a fix
7442 //snd_pcm_sw_params_set_silence_size( phandle, sw_params, ULONG_MAX );
7443 snd_pcm_uframes_t val;
7444 snd_pcm_sw_params_get_boundary( sw_params, &val );
7445 snd_pcm_sw_params_set_silence_size( phandle, sw_params, val );
7447 result = snd_pcm_sw_params( phandle, sw_params );
7449 snd_pcm_close( phandle );
7450 errorStream_ << "RtApiAlsa::probeDeviceOpen: error installing software configuration on device (" << name << "), " << snd_strerror( result ) << ".";
7451 errorText_ = errorStream_.str();
7455 #if defined(__RTAUDIO_DEBUG__)
7456 fprintf(stderr, "\nRtApiAlsa: dump software params after installation:\n\n");
7457 snd_pcm_sw_params_dump( sw_params, out );
7460 // Set flags for buffer conversion
7461 stream_.doConvertBuffer[mode] = false;
7462 if ( stream_.userFormat != stream_.deviceFormat[mode] )
7463 stream_.doConvertBuffer[mode] = true;
7464 if ( stream_.nUserChannels[mode] < stream_.nDeviceChannels[mode] )
7465 stream_.doConvertBuffer[mode] = true;
7466 if ( stream_.userInterleaved != stream_.deviceInterleaved[mode] &&
7467 stream_.nUserChannels[mode] > 1 )
7468 stream_.doConvertBuffer[mode] = true;
7470 // Allocate the ApiHandle if necessary and then save.
7471 AlsaHandle *apiInfo = 0;
7472 if ( stream_.apiHandle == 0 ) {
7474 apiInfo = (AlsaHandle *) new AlsaHandle;
7476 catch ( std::bad_alloc& ) {
7477 errorText_ = "RtApiAlsa::probeDeviceOpen: error allocating AlsaHandle memory.";
7481 if ( pthread_cond_init( &apiInfo->runnable_cv, NULL ) ) {
7482 errorText_ = "RtApiAlsa::probeDeviceOpen: error initializing pthread condition variable.";
7486 stream_.apiHandle = (void *) apiInfo;
7487 apiInfo->handles[0] = 0;
7488 apiInfo->handles[1] = 0;
7491 apiInfo = (AlsaHandle *) stream_.apiHandle;
7493 apiInfo->handles[mode] = phandle;
7496 // Allocate necessary internal buffers.
7497 unsigned long bufferBytes;
7498 bufferBytes = stream_.nUserChannels[mode] * *bufferSize * formatBytes( stream_.userFormat );
7499 stream_.userBuffer[mode] = (char *) calloc( bufferBytes, 1 );
7500 if ( stream_.userBuffer[mode] == NULL ) {
7501 errorText_ = "RtApiAlsa::probeDeviceOpen: error allocating user buffer memory.";
7505 if ( stream_.doConvertBuffer[mode] ) {
7507 bool makeBuffer = true;
7508 bufferBytes = stream_.nDeviceChannels[mode] * formatBytes( stream_.deviceFormat[mode] );
7509 if ( mode == INPUT ) {
7510 if ( stream_.mode == OUTPUT && stream_.deviceBuffer ) {
7511 unsigned long bytesOut = stream_.nDeviceChannels[0] * formatBytes( stream_.deviceFormat[0] );
7512 if ( bufferBytes <= bytesOut ) makeBuffer = false;
7517 bufferBytes *= *bufferSize;
7518 if ( stream_.deviceBuffer ) free( stream_.deviceBuffer );
7519 stream_.deviceBuffer = (char *) calloc( bufferBytes, 1 );
7520 if ( stream_.deviceBuffer == NULL ) {
7521 errorText_ = "RtApiAlsa::probeDeviceOpen: error allocating device buffer memory.";
7527 stream_.sampleRate = sampleRate;
7528 stream_.nBuffers = periods;
7529 stream_.device[mode] = device;
7530 stream_.state = STREAM_STOPPED;
7532 // Setup the buffer conversion information structure.
7533 if ( stream_.doConvertBuffer[mode] ) setConvertInfo( mode, firstChannel );
7535 // Setup thread if necessary.
7536 if ( stream_.mode == OUTPUT && mode == INPUT ) {
7537 // We had already set up an output stream.
7538 stream_.mode = DUPLEX;
7539 // Link the streams if possible.
7540 apiInfo->synchronized = false;
7541 if ( snd_pcm_link( apiInfo->handles[0], apiInfo->handles[1] ) == 0 )
7542 apiInfo->synchronized = true;
7544 errorText_ = "RtApiAlsa::probeDeviceOpen: unable to synchronize input and output devices.";
7545 error( RtAudioError::WARNING );
7549 stream_.mode = mode;
7551 // Setup callback thread.
7552 stream_.callbackInfo.object = (void *) this;
7554 // Set the thread attributes for joinable and realtime scheduling
7555 // priority (optional). The higher priority will only take affect
7556 // if the program is run as root or suid. Note, under Linux
7557 // processes with CAP_SYS_NICE privilege, a user can change
7558 // scheduling policy and priority (thus need not be root). See
7559 // POSIX "capabilities".
7560 pthread_attr_t attr;
7561 pthread_attr_init( &attr );
7562 pthread_attr_setdetachstate( &attr, PTHREAD_CREATE_JOINABLE );
7563 #ifdef SCHED_RR // Undefined with some OSes (eg: NetBSD 1.6.x with GNU Pthread)
7564 if ( options && options->flags & RTAUDIO_SCHEDULE_REALTIME ) {
7565 stream_.callbackInfo.doRealtime = true;
7566 struct sched_param param;
7567 int priority = options->priority;
7568 int min = sched_get_priority_min( SCHED_RR );
7569 int max = sched_get_priority_max( SCHED_RR );
7570 if ( priority < min ) priority = min;
7571 else if ( priority > max ) priority = max;
7572 param.sched_priority = priority;
7574 // Set the policy BEFORE the priority. Otherwise it fails.
7575 pthread_attr_setschedpolicy(&attr, SCHED_RR);
7576 pthread_attr_setscope (&attr, PTHREAD_SCOPE_SYSTEM);
7577 // This is definitely required. Otherwise it fails.
7578 pthread_attr_setinheritsched(&attr, PTHREAD_EXPLICIT_SCHED);
7579 pthread_attr_setschedparam(&attr, ¶m);
7582 pthread_attr_setschedpolicy( &attr, SCHED_OTHER );
7584 pthread_attr_setschedpolicy( &attr, SCHED_OTHER );
7587 stream_.callbackInfo.isRunning = true;
7588 result = pthread_create( &stream_.callbackInfo.thread, &attr, alsaCallbackHandler, &stream_.callbackInfo );
7589 pthread_attr_destroy( &attr );
7591 // Failed. Try instead with default attributes.
7592 result = pthread_create( &stream_.callbackInfo.thread, NULL, alsaCallbackHandler, &stream_.callbackInfo );
7594 stream_.callbackInfo.isRunning = false;
7595 errorText_ = "RtApiAlsa::error creating callback thread!";
7605 pthread_cond_destroy( &apiInfo->runnable_cv );
7606 if ( apiInfo->handles[0] ) snd_pcm_close( apiInfo->handles[0] );
7607 if ( apiInfo->handles[1] ) snd_pcm_close( apiInfo->handles[1] );
7609 stream_.apiHandle = 0;
7612 if ( phandle) snd_pcm_close( phandle );
7614 for ( int i=0; i<2; i++ ) {
7615 if ( stream_.userBuffer[i] ) {
7616 free( stream_.userBuffer[i] );
7617 stream_.userBuffer[i] = 0;
7621 if ( stream_.deviceBuffer ) {
7622 free( stream_.deviceBuffer );
7623 stream_.deviceBuffer = 0;
7626 stream_.state = STREAM_CLOSED;
7630 void RtApiAlsa :: closeStream()
7632 if ( stream_.state == STREAM_CLOSED ) {
7633 errorText_ = "RtApiAlsa::closeStream(): no open stream to close!";
7634 error( RtAudioError::WARNING );
7638 AlsaHandle *apiInfo = (AlsaHandle *) stream_.apiHandle;
7639 stream_.callbackInfo.isRunning = false;
7640 MUTEX_LOCK( &stream_.mutex );
7641 if ( stream_.state == STREAM_STOPPED ) {
7642 apiInfo->runnable = true;
7643 pthread_cond_signal( &apiInfo->runnable_cv );
7645 MUTEX_UNLOCK( &stream_.mutex );
7646 pthread_join( stream_.callbackInfo.thread, NULL );
7648 if ( stream_.state == STREAM_RUNNING ) {
7649 stream_.state = STREAM_STOPPED;
7650 if ( stream_.mode == OUTPUT || stream_.mode == DUPLEX )
7651 snd_pcm_drop( apiInfo->handles[0] );
7652 if ( stream_.mode == INPUT || stream_.mode == DUPLEX )
7653 snd_pcm_drop( apiInfo->handles[1] );
7657 pthread_cond_destroy( &apiInfo->runnable_cv );
7658 if ( apiInfo->handles[0] ) snd_pcm_close( apiInfo->handles[0] );
7659 if ( apiInfo->handles[1] ) snd_pcm_close( apiInfo->handles[1] );
7661 stream_.apiHandle = 0;
7664 for ( int i=0; i<2; i++ ) {
7665 if ( stream_.userBuffer[i] ) {
7666 free( stream_.userBuffer[i] );
7667 stream_.userBuffer[i] = 0;
7671 if ( stream_.deviceBuffer ) {
7672 free( stream_.deviceBuffer );
7673 stream_.deviceBuffer = 0;
7676 stream_.mode = UNINITIALIZED;
7677 stream_.state = STREAM_CLOSED;
7680 void RtApiAlsa :: startStream()
7682 // This method calls snd_pcm_prepare if the device isn't already in that state.
7685 if ( stream_.state == STREAM_RUNNING ) {
7686 errorText_ = "RtApiAlsa::startStream(): the stream is already running!";
7687 error( RtAudioError::WARNING );
7691 MUTEX_LOCK( &stream_.mutex );
7694 snd_pcm_state_t state;
7695 AlsaHandle *apiInfo = (AlsaHandle *) stream_.apiHandle;
7696 snd_pcm_t **handle = (snd_pcm_t **) apiInfo->handles;
7697 if ( stream_.mode == OUTPUT || stream_.mode == DUPLEX ) {
7698 state = snd_pcm_state( handle[0] );
7699 if ( state != SND_PCM_STATE_PREPARED ) {
7700 result = snd_pcm_prepare( handle[0] );
7702 errorStream_ << "RtApiAlsa::startStream: error preparing output pcm device, " << snd_strerror( result ) << ".";
7703 errorText_ = errorStream_.str();
7709 if ( ( stream_.mode == INPUT || stream_.mode == DUPLEX ) && !apiInfo->synchronized ) {
7710 result = snd_pcm_drop(handle[1]); // fix to remove stale data received since device has been open
7711 state = snd_pcm_state( handle[1] );
7712 if ( state != SND_PCM_STATE_PREPARED ) {
7713 result = snd_pcm_prepare( handle[1] );
7715 errorStream_ << "RtApiAlsa::startStream: error preparing input pcm device, " << snd_strerror( result ) << ".";
7716 errorText_ = errorStream_.str();
7722 stream_.state = STREAM_RUNNING;
7725 apiInfo->runnable = true;
7726 pthread_cond_signal( &apiInfo->runnable_cv );
7727 MUTEX_UNLOCK( &stream_.mutex );
7729 if ( result >= 0 ) return;
7730 error( RtAudioError::SYSTEM_ERROR );
7733 void RtApiAlsa :: stopStream()
7736 if ( stream_.state == STREAM_STOPPED ) {
7737 errorText_ = "RtApiAlsa::stopStream(): the stream is already stopped!";
7738 error( RtAudioError::WARNING );
7742 stream_.state = STREAM_STOPPED;
7743 MUTEX_LOCK( &stream_.mutex );
7746 AlsaHandle *apiInfo = (AlsaHandle *) stream_.apiHandle;
7747 snd_pcm_t **handle = (snd_pcm_t **) apiInfo->handles;
7748 if ( stream_.mode == OUTPUT || stream_.mode == DUPLEX ) {
7749 if ( apiInfo->synchronized )
7750 result = snd_pcm_drop( handle[0] );
7752 result = snd_pcm_drain( handle[0] );
7754 errorStream_ << "RtApiAlsa::stopStream: error draining output pcm device, " << snd_strerror( result ) << ".";
7755 errorText_ = errorStream_.str();
7760 if ( ( stream_.mode == INPUT || stream_.mode == DUPLEX ) && !apiInfo->synchronized ) {
7761 result = snd_pcm_drop( handle[1] );
7763 errorStream_ << "RtApiAlsa::stopStream: error stopping input pcm device, " << snd_strerror( result ) << ".";
7764 errorText_ = errorStream_.str();
7770 apiInfo->runnable = false; // fixes high CPU usage when stopped
7771 MUTEX_UNLOCK( &stream_.mutex );
7773 if ( result >= 0 ) return;
7774 error( RtAudioError::SYSTEM_ERROR );
7777 void RtApiAlsa :: abortStream()
7780 if ( stream_.state == STREAM_STOPPED ) {
7781 errorText_ = "RtApiAlsa::abortStream(): the stream is already stopped!";
7782 error( RtAudioError::WARNING );
7786 stream_.state = STREAM_STOPPED;
7787 MUTEX_LOCK( &stream_.mutex );
7790 AlsaHandle *apiInfo = (AlsaHandle *) stream_.apiHandle;
7791 snd_pcm_t **handle = (snd_pcm_t **) apiInfo->handles;
7792 if ( stream_.mode == OUTPUT || stream_.mode == DUPLEX ) {
7793 result = snd_pcm_drop( handle[0] );
7795 errorStream_ << "RtApiAlsa::abortStream: error aborting output pcm device, " << snd_strerror( result ) << ".";
7796 errorText_ = errorStream_.str();
7801 if ( ( stream_.mode == INPUT || stream_.mode == DUPLEX ) && !apiInfo->synchronized ) {
7802 result = snd_pcm_drop( handle[1] );
7804 errorStream_ << "RtApiAlsa::abortStream: error aborting input pcm device, " << snd_strerror( result ) << ".";
7805 errorText_ = errorStream_.str();
7811 apiInfo->runnable = false; // fixes high CPU usage when stopped
7812 MUTEX_UNLOCK( &stream_.mutex );
7814 if ( result >= 0 ) return;
7815 error( RtAudioError::SYSTEM_ERROR );
7818 void RtApiAlsa :: callbackEvent()
7820 AlsaHandle *apiInfo = (AlsaHandle *) stream_.apiHandle;
7821 if ( stream_.state == STREAM_STOPPED ) {
7822 MUTEX_LOCK( &stream_.mutex );
7823 while ( !apiInfo->runnable )
7824 pthread_cond_wait( &apiInfo->runnable_cv, &stream_.mutex );
7826 if ( stream_.state != STREAM_RUNNING ) {
7827 MUTEX_UNLOCK( &stream_.mutex );
7830 MUTEX_UNLOCK( &stream_.mutex );
7833 if ( stream_.state == STREAM_CLOSED ) {
7834 errorText_ = "RtApiAlsa::callbackEvent(): the stream is closed ... this shouldn't happen!";
7835 error( RtAudioError::WARNING );
7839 int doStopStream = 0;
7840 RtAudioCallback callback = (RtAudioCallback) stream_.callbackInfo.callback;
7841 double streamTime = getStreamTime();
7842 RtAudioStreamStatus status = 0;
7843 if ( stream_.mode != INPUT && apiInfo->xrun[0] == true ) {
7844 status |= RTAUDIO_OUTPUT_UNDERFLOW;
7845 apiInfo->xrun[0] = false;
7847 if ( stream_.mode != OUTPUT && apiInfo->xrun[1] == true ) {
7848 status |= RTAUDIO_INPUT_OVERFLOW;
7849 apiInfo->xrun[1] = false;
7851 doStopStream = callback( stream_.userBuffer[0], stream_.userBuffer[1],
7852 stream_.bufferSize, streamTime, status, stream_.callbackInfo.userData );
7854 if ( doStopStream == 2 ) {
7859 MUTEX_LOCK( &stream_.mutex );
7861 // The state might change while waiting on a mutex.
7862 if ( stream_.state == STREAM_STOPPED ) goto unlock;
7868 snd_pcm_sframes_t frames;
7869 RtAudioFormat format;
7870 handle = (snd_pcm_t **) apiInfo->handles;
7872 if ( stream_.mode == INPUT || stream_.mode == DUPLEX ) {
7874 // Setup parameters.
7875 if ( stream_.doConvertBuffer[1] ) {
7876 buffer = stream_.deviceBuffer;
7877 channels = stream_.nDeviceChannels[1];
7878 format = stream_.deviceFormat[1];
7881 buffer = stream_.userBuffer[1];
7882 channels = stream_.nUserChannels[1];
7883 format = stream_.userFormat;
7886 // Read samples from device in interleaved/non-interleaved format.
7887 if ( stream_.deviceInterleaved[1] )
7888 result = snd_pcm_readi( handle[1], buffer, stream_.bufferSize );
7890 void *bufs[channels];
7891 size_t offset = stream_.bufferSize * formatBytes( format );
7892 for ( int i=0; i<channels; i++ )
7893 bufs[i] = (void *) (buffer + (i * offset));
7894 result = snd_pcm_readn( handle[1], bufs, stream_.bufferSize );
7897 if ( result < (int) stream_.bufferSize ) {
7898 // Either an error or overrun occured.
7899 if ( result == -EPIPE ) {
7900 snd_pcm_state_t state = snd_pcm_state( handle[1] );
7901 if ( state == SND_PCM_STATE_XRUN ) {
7902 apiInfo->xrun[1] = true;
7903 result = snd_pcm_prepare( handle[1] );
7905 errorStream_ << "RtApiAlsa::callbackEvent: error preparing device after overrun, " << snd_strerror( result ) << ".";
7906 errorText_ = errorStream_.str();
7910 errorStream_ << "RtApiAlsa::callbackEvent: error, current state is " << snd_pcm_state_name( state ) << ", " << snd_strerror( result ) << ".";
7911 errorText_ = errorStream_.str();
7915 errorStream_ << "RtApiAlsa::callbackEvent: audio read error, " << snd_strerror( result ) << ".";
7916 errorText_ = errorStream_.str();
7918 error( RtAudioError::WARNING );
7922 // Do byte swapping if necessary.
7923 if ( stream_.doByteSwap[1] )
7924 byteSwapBuffer( buffer, stream_.bufferSize * channels, format );
7926 // Do buffer conversion if necessary.
7927 if ( stream_.doConvertBuffer[1] )
7928 convertBuffer( stream_.userBuffer[1], stream_.deviceBuffer, stream_.convertInfo[1] );
7930 // Check stream latency
7931 result = snd_pcm_delay( handle[1], &frames );
7932 if ( result == 0 && frames > 0 ) stream_.latency[1] = frames;
7937 if ( stream_.mode == OUTPUT || stream_.mode == DUPLEX ) {
7939 // Setup parameters and do buffer conversion if necessary.
7940 if ( stream_.doConvertBuffer[0] ) {
7941 buffer = stream_.deviceBuffer;
7942 convertBuffer( buffer, stream_.userBuffer[0], stream_.convertInfo[0] );
7943 channels = stream_.nDeviceChannels[0];
7944 format = stream_.deviceFormat[0];
7947 buffer = stream_.userBuffer[0];
7948 channels = stream_.nUserChannels[0];
7949 format = stream_.userFormat;
7952 // Do byte swapping if necessary.
7953 if ( stream_.doByteSwap[0] )
7954 byteSwapBuffer(buffer, stream_.bufferSize * channels, format);
7956 // Write samples to device in interleaved/non-interleaved format.
7957 if ( stream_.deviceInterleaved[0] )
7958 result = snd_pcm_writei( handle[0], buffer, stream_.bufferSize );
7960 void *bufs[channels];
7961 size_t offset = stream_.bufferSize * formatBytes( format );
7962 for ( int i=0; i<channels; i++ )
7963 bufs[i] = (void *) (buffer + (i * offset));
7964 result = snd_pcm_writen( handle[0], bufs, stream_.bufferSize );
7967 if ( result < (int) stream_.bufferSize ) {
7968 // Either an error or underrun occured.
7969 if ( result == -EPIPE ) {
7970 snd_pcm_state_t state = snd_pcm_state( handle[0] );
7971 if ( state == SND_PCM_STATE_XRUN ) {
7972 apiInfo->xrun[0] = true;
7973 result = snd_pcm_prepare( handle[0] );
7975 errorStream_ << "RtApiAlsa::callbackEvent: error preparing device after underrun, " << snd_strerror( result ) << ".";
7976 errorText_ = errorStream_.str();
7979 errorText_ = "RtApiAlsa::callbackEvent: audio write error, underrun.";
7982 errorStream_ << "RtApiAlsa::callbackEvent: error, current state is " << snd_pcm_state_name( state ) << ", " << snd_strerror( result ) << ".";
7983 errorText_ = errorStream_.str();
7987 errorStream_ << "RtApiAlsa::callbackEvent: audio write error, " << snd_strerror( result ) << ".";
7988 errorText_ = errorStream_.str();
7990 error( RtAudioError::WARNING );
7994 // Check stream latency
7995 result = snd_pcm_delay( handle[0], &frames );
7996 if ( result == 0 && frames > 0 ) stream_.latency[0] = frames;
8000 MUTEX_UNLOCK( &stream_.mutex );
8002 RtApi::tickStreamTime();
8003 if ( doStopStream == 1 ) this->stopStream();
8006 static void *alsaCallbackHandler( void *ptr )
8008 CallbackInfo *info = (CallbackInfo *) ptr;
8009 RtApiAlsa *object = (RtApiAlsa *) info->object;
8010 bool *isRunning = &info->isRunning;
8012 #ifdef SCHED_RR // Undefined with some OSes (eg: NetBSD 1.6.x with GNU Pthread)
8013 if ( info->doRealtime ) {
8014 std::cerr << "RtAudio alsa: " <<
8015 (sched_getscheduler(0) == SCHED_RR ? "" : "_NOT_ ") <<
8016 "running realtime scheduling" << std::endl;
8020 while ( *isRunning == true ) {
8021 pthread_testcancel();
8022 object->callbackEvent();
8025 pthread_exit( NULL );
8028 //******************** End of __LINUX_ALSA__ *********************//
8031 #if defined(__LINUX_PULSE__)
8033 // Code written by Peter Meerwald, pmeerw@pmeerw.net
8034 // and Tristan Matthews.
8036 #include <pulse/error.h>
8037 #include <pulse/simple.h>
8040 static const unsigned int SUPPORTED_SAMPLERATES[] = { 8000, 16000, 22050, 32000,
8041 44100, 48000, 96000, 0};
8043 struct rtaudio_pa_format_mapping_t {
8044 RtAudioFormat rtaudio_format;
8045 pa_sample_format_t pa_format;
8048 static const rtaudio_pa_format_mapping_t supported_sampleformats[] = {
8049 {RTAUDIO_SINT16, PA_SAMPLE_S16LE},
8050 {RTAUDIO_SINT32, PA_SAMPLE_S32LE},
8051 {RTAUDIO_FLOAT32, PA_SAMPLE_FLOAT32LE},
8052 {0, PA_SAMPLE_INVALID}};
8054 struct PulseAudioHandle {
8058 pthread_cond_t runnable_cv;
8060 PulseAudioHandle() : s_play(0), s_rec(0), runnable(false) { }
8063 RtApiPulse::~RtApiPulse()
8065 if ( stream_.state != STREAM_CLOSED )
8069 unsigned int RtApiPulse::getDeviceCount( void )
8074 RtAudio::DeviceInfo RtApiPulse::getDeviceInfo( unsigned int /*device*/ )
8076 RtAudio::DeviceInfo info;
8078 info.name = "PulseAudio";
8079 info.outputChannels = 2;
8080 info.inputChannels = 2;
8081 info.duplexChannels = 2;
8082 info.isDefaultOutput = true;
8083 info.isDefaultInput = true;
8085 for ( const unsigned int *sr = SUPPORTED_SAMPLERATES; *sr; ++sr )
8086 info.sampleRates.push_back( *sr );
8088 info.preferredSampleRate = 48000;
8089 info.nativeFormats = RTAUDIO_SINT16 | RTAUDIO_SINT32 | RTAUDIO_FLOAT32;
8094 static void *pulseaudio_callback( void * user )
8096 CallbackInfo *cbi = static_cast<CallbackInfo *>( user );
8097 RtApiPulse *context = static_cast<RtApiPulse *>( cbi->object );
8098 volatile bool *isRunning = &cbi->isRunning;
8100 #ifdef SCHED_RR // Undefined with some OSes (eg: NetBSD 1.6.x with GNU Pthread)
8101 if (cbi->doRealtime) {
8102 std::cerr << "RtAudio pulse: " <<
8103 (sched_getscheduler(0) == SCHED_RR ? "" : "_NOT_ ") <<
8104 "running realtime scheduling" << std::endl;
8108 while ( *isRunning ) {
8109 pthread_testcancel();
8110 context->callbackEvent();
8113 pthread_exit( NULL );
8116 void RtApiPulse::closeStream( void )
8118 PulseAudioHandle *pah = static_cast<PulseAudioHandle *>( stream_.apiHandle );
8120 stream_.callbackInfo.isRunning = false;
8122 MUTEX_LOCK( &stream_.mutex );
8123 if ( stream_.state == STREAM_STOPPED ) {
8124 pah->runnable = true;
8125 pthread_cond_signal( &pah->runnable_cv );
8127 MUTEX_UNLOCK( &stream_.mutex );
8129 pthread_join( pah->thread, 0 );
8130 if ( pah->s_play ) {
8131 pa_simple_flush( pah->s_play, NULL );
8132 pa_simple_free( pah->s_play );
8135 pa_simple_free( pah->s_rec );
8137 pthread_cond_destroy( &pah->runnable_cv );
8139 stream_.apiHandle = 0;
8142 if ( stream_.userBuffer[0] ) {
8143 free( stream_.userBuffer[0] );
8144 stream_.userBuffer[0] = 0;
8146 if ( stream_.userBuffer[1] ) {
8147 free( stream_.userBuffer[1] );
8148 stream_.userBuffer[1] = 0;
8151 stream_.state = STREAM_CLOSED;
8152 stream_.mode = UNINITIALIZED;
8155 void RtApiPulse::callbackEvent( void )
8157 PulseAudioHandle *pah = static_cast<PulseAudioHandle *>( stream_.apiHandle );
8159 if ( stream_.state == STREAM_STOPPED ) {
8160 MUTEX_LOCK( &stream_.mutex );
8161 while ( !pah->runnable )
8162 pthread_cond_wait( &pah->runnable_cv, &stream_.mutex );
8164 if ( stream_.state != STREAM_RUNNING ) {
8165 MUTEX_UNLOCK( &stream_.mutex );
8168 MUTEX_UNLOCK( &stream_.mutex );
8171 if ( stream_.state == STREAM_CLOSED ) {
8172 errorText_ = "RtApiPulse::callbackEvent(): the stream is closed ... "
8173 "this shouldn't happen!";
8174 error( RtAudioError::WARNING );
8178 RtAudioCallback callback = (RtAudioCallback) stream_.callbackInfo.callback;
8179 double streamTime = getStreamTime();
8180 RtAudioStreamStatus status = 0;
8181 int doStopStream = callback( stream_.userBuffer[OUTPUT], stream_.userBuffer[INPUT],
8182 stream_.bufferSize, streamTime, status,
8183 stream_.callbackInfo.userData );
8185 if ( doStopStream == 2 ) {
8190 MUTEX_LOCK( &stream_.mutex );
8191 void *pulse_in = stream_.doConvertBuffer[INPUT] ? stream_.deviceBuffer : stream_.userBuffer[INPUT];
8192 void *pulse_out = stream_.doConvertBuffer[OUTPUT] ? stream_.deviceBuffer : stream_.userBuffer[OUTPUT];
8194 if ( stream_.state != STREAM_RUNNING )
8199 if (stream_.mode == OUTPUT || stream_.mode == DUPLEX ) {
8200 if ( stream_.doConvertBuffer[OUTPUT] ) {
8201 convertBuffer( stream_.deviceBuffer,
8202 stream_.userBuffer[OUTPUT],
8203 stream_.convertInfo[OUTPUT] );
8204 bytes = stream_.nDeviceChannels[OUTPUT] * stream_.bufferSize *
8205 formatBytes( stream_.deviceFormat[OUTPUT] );
8207 bytes = stream_.nUserChannels[OUTPUT] * stream_.bufferSize *
8208 formatBytes( stream_.userFormat );
8210 if ( pa_simple_write( pah->s_play, pulse_out, bytes, &pa_error ) < 0 ) {
8211 errorStream_ << "RtApiPulse::callbackEvent: audio write error, " <<
8212 pa_strerror( pa_error ) << ".";
8213 errorText_ = errorStream_.str();
8214 error( RtAudioError::WARNING );
8218 if ( stream_.mode == INPUT || stream_.mode == DUPLEX) {
8219 if ( stream_.doConvertBuffer[INPUT] )
8220 bytes = stream_.nDeviceChannels[INPUT] * stream_.bufferSize *
8221 formatBytes( stream_.deviceFormat[INPUT] );
8223 bytes = stream_.nUserChannels[INPUT] * stream_.bufferSize *
8224 formatBytes( stream_.userFormat );
8226 if ( pa_simple_read( pah->s_rec, pulse_in, bytes, &pa_error ) < 0 ) {
8227 errorStream_ << "RtApiPulse::callbackEvent: audio read error, " <<
8228 pa_strerror( pa_error ) << ".";
8229 errorText_ = errorStream_.str();
8230 error( RtAudioError::WARNING );
8232 if ( stream_.doConvertBuffer[INPUT] ) {
8233 convertBuffer( stream_.userBuffer[INPUT],
8234 stream_.deviceBuffer,
8235 stream_.convertInfo[INPUT] );
8240 MUTEX_UNLOCK( &stream_.mutex );
8241 RtApi::tickStreamTime();
8243 if ( doStopStream == 1 )
8247 void RtApiPulse::startStream( void )
8249 PulseAudioHandle *pah = static_cast<PulseAudioHandle *>( stream_.apiHandle );
8251 if ( stream_.state == STREAM_CLOSED ) {
8252 errorText_ = "RtApiPulse::startStream(): the stream is not open!";
8253 error( RtAudioError::INVALID_USE );
8256 if ( stream_.state == STREAM_RUNNING ) {
8257 errorText_ = "RtApiPulse::startStream(): the stream is already running!";
8258 error( RtAudioError::WARNING );
8262 MUTEX_LOCK( &stream_.mutex );
8264 stream_.state = STREAM_RUNNING;
8266 pah->runnable = true;
8267 pthread_cond_signal( &pah->runnable_cv );
8268 MUTEX_UNLOCK( &stream_.mutex );
8271 void RtApiPulse::stopStream( void )
8273 PulseAudioHandle *pah = static_cast<PulseAudioHandle *>( stream_.apiHandle );
8275 if ( stream_.state == STREAM_CLOSED ) {
8276 errorText_ = "RtApiPulse::stopStream(): the stream is not open!";
8277 error( RtAudioError::INVALID_USE );
8280 if ( stream_.state == STREAM_STOPPED ) {
8281 errorText_ = "RtApiPulse::stopStream(): the stream is already stopped!";
8282 error( RtAudioError::WARNING );
8286 stream_.state = STREAM_STOPPED;
8287 MUTEX_LOCK( &stream_.mutex );
8289 if ( pah && pah->s_play ) {
8291 if ( pa_simple_drain( pah->s_play, &pa_error ) < 0 ) {
8292 errorStream_ << "RtApiPulse::stopStream: error draining output device, " <<
8293 pa_strerror( pa_error ) << ".";
8294 errorText_ = errorStream_.str();
8295 MUTEX_UNLOCK( &stream_.mutex );
8296 error( RtAudioError::SYSTEM_ERROR );
8301 stream_.state = STREAM_STOPPED;
8302 MUTEX_UNLOCK( &stream_.mutex );
8305 void RtApiPulse::abortStream( void )
8307 PulseAudioHandle *pah = static_cast<PulseAudioHandle*>( stream_.apiHandle );
8309 if ( stream_.state == STREAM_CLOSED ) {
8310 errorText_ = "RtApiPulse::abortStream(): the stream is not open!";
8311 error( RtAudioError::INVALID_USE );
8314 if ( stream_.state == STREAM_STOPPED ) {
8315 errorText_ = "RtApiPulse::abortStream(): the stream is already stopped!";
8316 error( RtAudioError::WARNING );
8320 stream_.state = STREAM_STOPPED;
8321 MUTEX_LOCK( &stream_.mutex );
8323 if ( pah && pah->s_play ) {
8325 if ( pa_simple_flush( pah->s_play, &pa_error ) < 0 ) {
8326 errorStream_ << "RtApiPulse::abortStream: error flushing output device, " <<
8327 pa_strerror( pa_error ) << ".";
8328 errorText_ = errorStream_.str();
8329 MUTEX_UNLOCK( &stream_.mutex );
8330 error( RtAudioError::SYSTEM_ERROR );
8335 stream_.state = STREAM_STOPPED;
8336 MUTEX_UNLOCK( &stream_.mutex );
8339 bool RtApiPulse::probeDeviceOpen( unsigned int device, StreamMode mode,
8340 unsigned int channels, unsigned int firstChannel,
8341 unsigned int sampleRate, RtAudioFormat format,
8342 unsigned int *bufferSize, RtAudio::StreamOptions *options )
8344 PulseAudioHandle *pah = 0;
8345 unsigned long bufferBytes = 0;
8348 if ( device != 0 ) return false;
8349 if ( mode != INPUT && mode != OUTPUT ) return false;
8350 if ( channels != 1 && channels != 2 ) {
8351 errorText_ = "RtApiPulse::probeDeviceOpen: unsupported number of channels.";
8354 ss.channels = channels;
8356 if ( firstChannel != 0 ) return false;
8358 bool sr_found = false;
8359 for ( const unsigned int *sr = SUPPORTED_SAMPLERATES; *sr; ++sr ) {
8360 if ( sampleRate == *sr ) {
8362 stream_.sampleRate = sampleRate;
8363 ss.rate = sampleRate;
8368 errorText_ = "RtApiPulse::probeDeviceOpen: unsupported sample rate.";
8373 for ( const rtaudio_pa_format_mapping_t *sf = supported_sampleformats;
8374 sf->rtaudio_format && sf->pa_format != PA_SAMPLE_INVALID; ++sf ) {
8375 if ( format == sf->rtaudio_format ) {
8377 stream_.userFormat = sf->rtaudio_format;
8378 stream_.deviceFormat[mode] = stream_.userFormat;
8379 ss.format = sf->pa_format;
8383 if ( !sf_found ) { // Use internal data format conversion.
8384 stream_.userFormat = format;
8385 stream_.deviceFormat[mode] = RTAUDIO_FLOAT32;
8386 ss.format = PA_SAMPLE_FLOAT32LE;
8389 // Set other stream parameters.
8390 if ( options && options->flags & RTAUDIO_NONINTERLEAVED ) stream_.userInterleaved = false;
8391 else stream_.userInterleaved = true;
8392 stream_.deviceInterleaved[mode] = true;
8393 stream_.nBuffers = 1;
8394 stream_.doByteSwap[mode] = false;
8395 stream_.nUserChannels[mode] = channels;
8396 stream_.nDeviceChannels[mode] = channels + firstChannel;
8397 stream_.channelOffset[mode] = 0;
8398 std::string streamName = "RtAudio";
8400 // Set flags for buffer conversion.
8401 stream_.doConvertBuffer[mode] = false;
8402 if ( stream_.userFormat != stream_.deviceFormat[mode] )
8403 stream_.doConvertBuffer[mode] = true;
8404 if ( stream_.nUserChannels[mode] < stream_.nDeviceChannels[mode] )
8405 stream_.doConvertBuffer[mode] = true;
8407 // Allocate necessary internal buffers.
8408 bufferBytes = stream_.nUserChannels[mode] * *bufferSize * formatBytes( stream_.userFormat );
8409 stream_.userBuffer[mode] = (char *) calloc( bufferBytes, 1 );
8410 if ( stream_.userBuffer[mode] == NULL ) {
8411 errorText_ = "RtApiPulse::probeDeviceOpen: error allocating user buffer memory.";
8414 stream_.bufferSize = *bufferSize;
8416 if ( stream_.doConvertBuffer[mode] ) {
8418 bool makeBuffer = true;
8419 bufferBytes = stream_.nDeviceChannels[mode] * formatBytes( stream_.deviceFormat[mode] );
8420 if ( mode == INPUT ) {
8421 if ( stream_.mode == OUTPUT && stream_.deviceBuffer ) {
8422 unsigned long bytesOut = stream_.nDeviceChannels[0] * formatBytes( stream_.deviceFormat[0] );
8423 if ( bufferBytes <= bytesOut ) makeBuffer = false;
8428 bufferBytes *= *bufferSize;
8429 if ( stream_.deviceBuffer ) free( stream_.deviceBuffer );
8430 stream_.deviceBuffer = (char *) calloc( bufferBytes, 1 );
8431 if ( stream_.deviceBuffer == NULL ) {
8432 errorText_ = "RtApiPulse::probeDeviceOpen: error allocating device buffer memory.";
8438 stream_.device[mode] = device;
8440 // Setup the buffer conversion information structure.
8441 if ( stream_.doConvertBuffer[mode] ) setConvertInfo( mode, firstChannel );
8443 if ( !stream_.apiHandle ) {
8444 PulseAudioHandle *pah = new PulseAudioHandle;
8446 errorText_ = "RtApiPulse::probeDeviceOpen: error allocating memory for handle.";
8450 stream_.apiHandle = pah;
8451 if ( pthread_cond_init( &pah->runnable_cv, NULL ) != 0 ) {
8452 errorText_ = "RtApiPulse::probeDeviceOpen: error creating condition variable.";
8456 pah = static_cast<PulseAudioHandle *>( stream_.apiHandle );
8459 if ( options && !options->streamName.empty() ) streamName = options->streamName;
8462 pa_buffer_attr buffer_attr;
8463 buffer_attr.fragsize = bufferBytes;
8464 buffer_attr.maxlength = -1;
8466 pah->s_rec = pa_simple_new( NULL, streamName.c_str(), PA_STREAM_RECORD, NULL, "Record", &ss, NULL, &buffer_attr, &error );
8467 if ( !pah->s_rec ) {
8468 errorText_ = "RtApiPulse::probeDeviceOpen: error connecting input to PulseAudio server.";
8473 pah->s_play = pa_simple_new( NULL, streamName.c_str(), PA_STREAM_PLAYBACK, NULL, "Playback", &ss, NULL, NULL, &error );
8474 if ( !pah->s_play ) {
8475 errorText_ = "RtApiPulse::probeDeviceOpen: error connecting output to PulseAudio server.";
8483 if ( stream_.mode == UNINITIALIZED )
8484 stream_.mode = mode;
8485 else if ( stream_.mode == mode )
8488 stream_.mode = DUPLEX;
8490 if ( !stream_.callbackInfo.isRunning ) {
8491 stream_.callbackInfo.object = this;
8493 stream_.state = STREAM_STOPPED;
8494 // Set the thread attributes for joinable and realtime scheduling
8495 // priority (optional). The higher priority will only take affect
8496 // if the program is run as root or suid. Note, under Linux
8497 // processes with CAP_SYS_NICE privilege, a user can change
8498 // scheduling policy and priority (thus need not be root). See
8499 // POSIX "capabilities".
8500 pthread_attr_t attr;
8501 pthread_attr_init( &attr );
8502 pthread_attr_setdetachstate( &attr, PTHREAD_CREATE_JOINABLE );
8503 #ifdef SCHED_RR // Undefined with some OSes (eg: NetBSD 1.6.x with GNU Pthread)
8504 if ( options && options->flags & RTAUDIO_SCHEDULE_REALTIME ) {
8505 stream_.callbackInfo.doRealtime = true;
8506 struct sched_param param;
8507 int priority = options->priority;
8508 int min = sched_get_priority_min( SCHED_RR );
8509 int max = sched_get_priority_max( SCHED_RR );
8510 if ( priority < min ) priority = min;
8511 else if ( priority > max ) priority = max;
8512 param.sched_priority = priority;
8514 // Set the policy BEFORE the priority. Otherwise it fails.
8515 pthread_attr_setschedpolicy(&attr, SCHED_RR);
8516 pthread_attr_setscope (&attr, PTHREAD_SCOPE_SYSTEM);
8517 // This is definitely required. Otherwise it fails.
8518 pthread_attr_setinheritsched(&attr, PTHREAD_EXPLICIT_SCHED);
8519 pthread_attr_setschedparam(&attr, ¶m);
8522 pthread_attr_setschedpolicy( &attr, SCHED_OTHER );
8524 pthread_attr_setschedpolicy( &attr, SCHED_OTHER );
8527 stream_.callbackInfo.isRunning = true;
8528 int result = pthread_create( &pah->thread, &attr, pulseaudio_callback, (void *)&stream_.callbackInfo);
8529 pthread_attr_destroy(&attr);
8531 // Failed. Try instead with default attributes.
8532 result = pthread_create( &pah->thread, NULL, pulseaudio_callback, (void *)&stream_.callbackInfo);
8534 stream_.callbackInfo.isRunning = false;
8535 errorText_ = "RtApiPulse::probeDeviceOpen: error creating thread.";
8544 if ( pah && stream_.callbackInfo.isRunning ) {
8545 pthread_cond_destroy( &pah->runnable_cv );
8547 stream_.apiHandle = 0;
8550 for ( int i=0; i<2; i++ ) {
8551 if ( stream_.userBuffer[i] ) {
8552 free( stream_.userBuffer[i] );
8553 stream_.userBuffer[i] = 0;
8557 if ( stream_.deviceBuffer ) {
8558 free( stream_.deviceBuffer );
8559 stream_.deviceBuffer = 0;
8562 stream_.state = STREAM_CLOSED;
8566 //******************** End of __LINUX_PULSE__ *********************//
8569 #if defined(__LINUX_OSS__)
8572 #include <sys/ioctl.h>
8575 #include <sys/soundcard.h>
8579 static void *ossCallbackHandler(void * ptr);
8581 // A structure to hold various information related to the OSS API
8584 int id[2]; // device ids
8587 pthread_cond_t runnable;
8590 :triggered(false) { id[0] = 0; id[1] = 0; xrun[0] = false; xrun[1] = false; }
8593 RtApiOss :: RtApiOss()
8595 // Nothing to do here.
8598 RtApiOss :: ~RtApiOss()
8600 if ( stream_.state != STREAM_CLOSED ) closeStream();
8603 unsigned int RtApiOss :: getDeviceCount( void )
8605 int mixerfd = open( "/dev/mixer", O_RDWR, 0 );
8606 if ( mixerfd == -1 ) {
8607 errorText_ = "RtApiOss::getDeviceCount: error opening '/dev/mixer'.";
8608 error( RtAudioError::WARNING );
8612 oss_sysinfo sysinfo;
8613 if ( ioctl( mixerfd, SNDCTL_SYSINFO, &sysinfo ) == -1 ) {
8615 errorText_ = "RtApiOss::getDeviceCount: error getting sysinfo, OSS version >= 4.0 is required.";
8616 error( RtAudioError::WARNING );
8621 return sysinfo.numaudios;
8624 RtAudio::DeviceInfo RtApiOss :: getDeviceInfo( unsigned int device )
8626 RtAudio::DeviceInfo info;
8627 info.probed = false;
8629 int mixerfd = open( "/dev/mixer", O_RDWR, 0 );
8630 if ( mixerfd == -1 ) {
8631 errorText_ = "RtApiOss::getDeviceInfo: error opening '/dev/mixer'.";
8632 error( RtAudioError::WARNING );
8636 oss_sysinfo sysinfo;
8637 int result = ioctl( mixerfd, SNDCTL_SYSINFO, &sysinfo );
8638 if ( result == -1 ) {
8640 errorText_ = "RtApiOss::getDeviceInfo: error getting sysinfo, OSS version >= 4.0 is required.";
8641 error( RtAudioError::WARNING );
8645 unsigned nDevices = sysinfo.numaudios;
8646 if ( nDevices == 0 ) {
8648 errorText_ = "RtApiOss::getDeviceInfo: no devices found!";
8649 error( RtAudioError::INVALID_USE );
8653 if ( device >= nDevices ) {
8655 errorText_ = "RtApiOss::getDeviceInfo: device ID is invalid!";
8656 error( RtAudioError::INVALID_USE );
8660 oss_audioinfo ainfo;
8662 result = ioctl( mixerfd, SNDCTL_AUDIOINFO, &ainfo );
8664 if ( result == -1 ) {
8665 errorStream_ << "RtApiOss::getDeviceInfo: error getting device (" << ainfo.name << ") info.";
8666 errorText_ = errorStream_.str();
8667 error( RtAudioError::WARNING );
8672 if ( ainfo.caps & PCM_CAP_OUTPUT ) info.outputChannels = ainfo.max_channels;
8673 if ( ainfo.caps & PCM_CAP_INPUT ) info.inputChannels = ainfo.max_channels;
8674 if ( ainfo.caps & PCM_CAP_DUPLEX ) {
8675 if ( info.outputChannels > 0 && info.inputChannels > 0 && ainfo.caps & PCM_CAP_DUPLEX )
8676 info.duplexChannels = (info.outputChannels > info.inputChannels) ? info.inputChannels : info.outputChannels;
8679 // Probe data formats ... do for input
8680 unsigned long mask = ainfo.iformats;
8681 if ( mask & AFMT_S16_LE || mask & AFMT_S16_BE )
8682 info.nativeFormats |= RTAUDIO_SINT16;
8683 if ( mask & AFMT_S8 )
8684 info.nativeFormats |= RTAUDIO_SINT8;
8685 if ( mask & AFMT_S32_LE || mask & AFMT_S32_BE )
8686 info.nativeFormats |= RTAUDIO_SINT32;
8688 if ( mask & AFMT_FLOAT )
8689 info.nativeFormats |= RTAUDIO_FLOAT32;
8691 if ( mask & AFMT_S24_LE || mask & AFMT_S24_BE )
8692 info.nativeFormats |= RTAUDIO_SINT24;
8694 // Check that we have at least one supported format
8695 if ( info.nativeFormats == 0 ) {
8696 errorStream_ << "RtApiOss::getDeviceInfo: device (" << ainfo.name << ") data format not supported by RtAudio.";
8697 errorText_ = errorStream_.str();
8698 error( RtAudioError::WARNING );
8702 // Probe the supported sample rates.
8703 info.sampleRates.clear();
8704 if ( ainfo.nrates ) {
8705 for ( unsigned int i=0; i<ainfo.nrates; i++ ) {
8706 for ( unsigned int k=0; k<MAX_SAMPLE_RATES; k++ ) {
8707 if ( ainfo.rates[i] == SAMPLE_RATES[k] ) {
8708 info.sampleRates.push_back( SAMPLE_RATES[k] );
8710 if ( !info.preferredSampleRate || ( SAMPLE_RATES[k] <= 48000 && SAMPLE_RATES[k] > info.preferredSampleRate ) )
8711 info.preferredSampleRate = SAMPLE_RATES[k];
8719 // Check min and max rate values;
8720 for ( unsigned int k=0; k<MAX_SAMPLE_RATES; k++ ) {
8721 if ( ainfo.min_rate <= (int) SAMPLE_RATES[k] && ainfo.max_rate >= (int) SAMPLE_RATES[k] ) {
8722 info.sampleRates.push_back( SAMPLE_RATES[k] );
8724 if ( !info.preferredSampleRate || ( SAMPLE_RATES[k] <= 48000 && SAMPLE_RATES[k] > info.preferredSampleRate ) )
8725 info.preferredSampleRate = SAMPLE_RATES[k];
8730 if ( info.sampleRates.size() == 0 ) {
8731 errorStream_ << "RtApiOss::getDeviceInfo: no supported sample rates found for device (" << ainfo.name << ").";
8732 errorText_ = errorStream_.str();
8733 error( RtAudioError::WARNING );
8737 info.name = ainfo.name;
8744 bool RtApiOss :: probeDeviceOpen( unsigned int device, StreamMode mode, unsigned int channels,
8745 unsigned int firstChannel, unsigned int sampleRate,
8746 RtAudioFormat format, unsigned int *bufferSize,
8747 RtAudio::StreamOptions *options )
8749 int mixerfd = open( "/dev/mixer", O_RDWR, 0 );
8750 if ( mixerfd == -1 ) {
8751 errorText_ = "RtApiOss::probeDeviceOpen: error opening '/dev/mixer'.";
8755 oss_sysinfo sysinfo;
8756 int result = ioctl( mixerfd, SNDCTL_SYSINFO, &sysinfo );
8757 if ( result == -1 ) {
8759 errorText_ = "RtApiOss::probeDeviceOpen: error getting sysinfo, OSS version >= 4.0 is required.";
8763 unsigned nDevices = sysinfo.numaudios;
8764 if ( nDevices == 0 ) {
8765 // This should not happen because a check is made before this function is called.
8767 errorText_ = "RtApiOss::probeDeviceOpen: no devices found!";
8771 if ( device >= nDevices ) {
8772 // This should not happen because a check is made before this function is called.
8774 errorText_ = "RtApiOss::probeDeviceOpen: device ID is invalid!";
8778 oss_audioinfo ainfo;
8780 result = ioctl( mixerfd, SNDCTL_AUDIOINFO, &ainfo );
8782 if ( result == -1 ) {
8783 errorStream_ << "RtApiOss::getDeviceInfo: error getting device (" << ainfo.name << ") info.";
8784 errorText_ = errorStream_.str();
8788 // Check if device supports input or output
8789 if ( ( mode == OUTPUT && !( ainfo.caps & PCM_CAP_OUTPUT ) ) ||
8790 ( mode == INPUT && !( ainfo.caps & PCM_CAP_INPUT ) ) ) {
8791 if ( mode == OUTPUT )
8792 errorStream_ << "RtApiOss::probeDeviceOpen: device (" << ainfo.name << ") does not support output.";
8794 errorStream_ << "RtApiOss::probeDeviceOpen: device (" << ainfo.name << ") does not support input.";
8795 errorText_ = errorStream_.str();
8800 OssHandle *handle = (OssHandle *) stream_.apiHandle;
8801 if ( mode == OUTPUT )
8803 else { // mode == INPUT
8804 if (stream_.mode == OUTPUT && stream_.device[0] == device) {
8805 // We just set the same device for playback ... close and reopen for duplex (OSS only).
8806 close( handle->id[0] );
8808 if ( !( ainfo.caps & PCM_CAP_DUPLEX ) ) {
8809 errorStream_ << "RtApiOss::probeDeviceOpen: device (" << ainfo.name << ") does not support duplex mode.";
8810 errorText_ = errorStream_.str();
8813 // Check that the number previously set channels is the same.
8814 if ( stream_.nUserChannels[0] != channels ) {
8815 errorStream_ << "RtApiOss::probeDeviceOpen: input/output channels must be equal for OSS duplex device (" << ainfo.name << ").";
8816 errorText_ = errorStream_.str();
8825 // Set exclusive access if specified.
8826 if ( options && options->flags & RTAUDIO_HOG_DEVICE ) flags |= O_EXCL;
8828 // Try to open the device.
8830 fd = open( ainfo.devnode, flags, 0 );
8832 if ( errno == EBUSY )
8833 errorStream_ << "RtApiOss::probeDeviceOpen: device (" << ainfo.name << ") is busy.";
8835 errorStream_ << "RtApiOss::probeDeviceOpen: error opening device (" << ainfo.name << ").";
8836 errorText_ = errorStream_.str();
8840 // For duplex operation, specifically set this mode (this doesn't seem to work).
8842 if ( flags | O_RDWR ) {
8843 result = ioctl( fd, SNDCTL_DSP_SETDUPLEX, NULL );
8844 if ( result == -1) {
8845 errorStream_ << "RtApiOss::probeDeviceOpen: error setting duplex mode for device (" << ainfo.name << ").";
8846 errorText_ = errorStream_.str();
8852 // Check the device channel support.
8853 stream_.nUserChannels[mode] = channels;
8854 if ( ainfo.max_channels < (int)(channels + firstChannel) ) {
8856 errorStream_ << "RtApiOss::probeDeviceOpen: the device (" << ainfo.name << ") does not support requested channel parameters.";
8857 errorText_ = errorStream_.str();
8861 // Set the number of channels.
8862 int deviceChannels = channels + firstChannel;
8863 result = ioctl( fd, SNDCTL_DSP_CHANNELS, &deviceChannels );
8864 if ( result == -1 || deviceChannels < (int)(channels + firstChannel) ) {
8866 errorStream_ << "RtApiOss::probeDeviceOpen: error setting channel parameters on device (" << ainfo.name << ").";
8867 errorText_ = errorStream_.str();
8870 stream_.nDeviceChannels[mode] = deviceChannels;
8872 // Get the data format mask
8874 result = ioctl( fd, SNDCTL_DSP_GETFMTS, &mask );
8875 if ( result == -1 ) {
8877 errorStream_ << "RtApiOss::probeDeviceOpen: error getting device (" << ainfo.name << ") data formats.";
8878 errorText_ = errorStream_.str();
8882 // Determine how to set the device format.
8883 stream_.userFormat = format;
8884 int deviceFormat = -1;
8885 stream_.doByteSwap[mode] = false;
8886 if ( format == RTAUDIO_SINT8 ) {
8887 if ( mask & AFMT_S8 ) {
8888 deviceFormat = AFMT_S8;
8889 stream_.deviceFormat[mode] = RTAUDIO_SINT8;
8892 else if ( format == RTAUDIO_SINT16 ) {
8893 if ( mask & AFMT_S16_NE ) {
8894 deviceFormat = AFMT_S16_NE;
8895 stream_.deviceFormat[mode] = RTAUDIO_SINT16;
8897 else if ( mask & AFMT_S16_OE ) {
8898 deviceFormat = AFMT_S16_OE;
8899 stream_.deviceFormat[mode] = RTAUDIO_SINT16;
8900 stream_.doByteSwap[mode] = true;
8903 else if ( format == RTAUDIO_SINT24 ) {
8904 if ( mask & AFMT_S24_NE ) {
8905 deviceFormat = AFMT_S24_NE;
8906 stream_.deviceFormat[mode] = RTAUDIO_SINT24;
8908 else if ( mask & AFMT_S24_OE ) {
8909 deviceFormat = AFMT_S24_OE;
8910 stream_.deviceFormat[mode] = RTAUDIO_SINT24;
8911 stream_.doByteSwap[mode] = true;
8914 else if ( format == RTAUDIO_SINT32 ) {
8915 if ( mask & AFMT_S32_NE ) {
8916 deviceFormat = AFMT_S32_NE;
8917 stream_.deviceFormat[mode] = RTAUDIO_SINT32;
8919 else if ( mask & AFMT_S32_OE ) {
8920 deviceFormat = AFMT_S32_OE;
8921 stream_.deviceFormat[mode] = RTAUDIO_SINT32;
8922 stream_.doByteSwap[mode] = true;
8926 if ( deviceFormat == -1 ) {
8927 // The user requested format is not natively supported by the device.
8928 if ( mask & AFMT_S16_NE ) {
8929 deviceFormat = AFMT_S16_NE;
8930 stream_.deviceFormat[mode] = RTAUDIO_SINT16;
8932 else if ( mask & AFMT_S32_NE ) {
8933 deviceFormat = AFMT_S32_NE;
8934 stream_.deviceFormat[mode] = RTAUDIO_SINT32;
8936 else if ( mask & AFMT_S24_NE ) {
8937 deviceFormat = AFMT_S24_NE;
8938 stream_.deviceFormat[mode] = RTAUDIO_SINT24;
8940 else if ( mask & AFMT_S16_OE ) {
8941 deviceFormat = AFMT_S16_OE;
8942 stream_.deviceFormat[mode] = RTAUDIO_SINT16;
8943 stream_.doByteSwap[mode] = true;
8945 else if ( mask & AFMT_S32_OE ) {
8946 deviceFormat = AFMT_S32_OE;
8947 stream_.deviceFormat[mode] = RTAUDIO_SINT32;
8948 stream_.doByteSwap[mode] = true;
8950 else if ( mask & AFMT_S24_OE ) {
8951 deviceFormat = AFMT_S24_OE;
8952 stream_.deviceFormat[mode] = RTAUDIO_SINT24;
8953 stream_.doByteSwap[mode] = true;
8955 else if ( mask & AFMT_S8) {
8956 deviceFormat = AFMT_S8;
8957 stream_.deviceFormat[mode] = RTAUDIO_SINT8;
8961 if ( stream_.deviceFormat[mode] == 0 ) {
8962 // This really shouldn't happen ...
8964 errorStream_ << "RtApiOss::probeDeviceOpen: device (" << ainfo.name << ") data format not supported by RtAudio.";
8965 errorText_ = errorStream_.str();
8969 // Set the data format.
8970 int temp = deviceFormat;
8971 result = ioctl( fd, SNDCTL_DSP_SETFMT, &deviceFormat );
8972 if ( result == -1 || deviceFormat != temp ) {
8974 errorStream_ << "RtApiOss::probeDeviceOpen: error setting data format on device (" << ainfo.name << ").";
8975 errorText_ = errorStream_.str();
8979 // Attempt to set the buffer size. According to OSS, the minimum
8980 // number of buffers is two. The supposed minimum buffer size is 16
8981 // bytes, so that will be our lower bound. The argument to this
8982 // call is in the form 0xMMMMSSSS (hex), where the buffer size (in
8983 // bytes) is given as 2^SSSS and the number of buffers as 2^MMMM.
8984 // We'll check the actual value used near the end of the setup
8986 int ossBufferBytes = *bufferSize * formatBytes( stream_.deviceFormat[mode] ) * deviceChannels;
8987 if ( ossBufferBytes < 16 ) ossBufferBytes = 16;
8989 if ( options ) buffers = options->numberOfBuffers;
8990 if ( options && options->flags & RTAUDIO_MINIMIZE_LATENCY ) buffers = 2;
8991 if ( buffers < 2 ) buffers = 3;
8992 temp = ((int) buffers << 16) + (int)( log10( (double)ossBufferBytes ) / log10( 2.0 ) );
8993 result = ioctl( fd, SNDCTL_DSP_SETFRAGMENT, &temp );
8994 if ( result == -1 ) {
8996 errorStream_ << "RtApiOss::probeDeviceOpen: error setting buffer size on device (" << ainfo.name << ").";
8997 errorText_ = errorStream_.str();
9000 stream_.nBuffers = buffers;
9002 // Save buffer size (in sample frames).
9003 *bufferSize = ossBufferBytes / ( formatBytes(stream_.deviceFormat[mode]) * deviceChannels );
9004 stream_.bufferSize = *bufferSize;
9006 // Set the sample rate.
9007 int srate = sampleRate;
9008 result = ioctl( fd, SNDCTL_DSP_SPEED, &srate );
9009 if ( result == -1 ) {
9011 errorStream_ << "RtApiOss::probeDeviceOpen: error setting sample rate (" << sampleRate << ") on device (" << ainfo.name << ").";
9012 errorText_ = errorStream_.str();
9016 // Verify the sample rate setup worked.
9017 if ( abs( srate - (int)sampleRate ) > 100 ) {
9019 errorStream_ << "RtApiOss::probeDeviceOpen: device (" << ainfo.name << ") does not support sample rate (" << sampleRate << ").";
9020 errorText_ = errorStream_.str();
9023 stream_.sampleRate = sampleRate;
9025 if ( mode == INPUT && stream_.mode == OUTPUT && stream_.device[0] == device) {
9026 // We're doing duplex setup here.
9027 stream_.deviceFormat[0] = stream_.deviceFormat[1];
9028 stream_.nDeviceChannels[0] = deviceChannels;
9031 // Set interleaving parameters.
9032 stream_.userInterleaved = true;
9033 stream_.deviceInterleaved[mode] = true;
9034 if ( options && options->flags & RTAUDIO_NONINTERLEAVED )
9035 stream_.userInterleaved = false;
9037 // Set flags for buffer conversion
9038 stream_.doConvertBuffer[mode] = false;
9039 if ( stream_.userFormat != stream_.deviceFormat[mode] )
9040 stream_.doConvertBuffer[mode] = true;
9041 if ( stream_.nUserChannels[mode] < stream_.nDeviceChannels[mode] )
9042 stream_.doConvertBuffer[mode] = true;
9043 if ( stream_.userInterleaved != stream_.deviceInterleaved[mode] &&
9044 stream_.nUserChannels[mode] > 1 )
9045 stream_.doConvertBuffer[mode] = true;
9047 // Allocate the stream handles if necessary and then save.
9048 if ( stream_.apiHandle == 0 ) {
9050 handle = new OssHandle;
9052 catch ( std::bad_alloc& ) {
9053 errorText_ = "RtApiOss::probeDeviceOpen: error allocating OssHandle memory.";
9057 if ( pthread_cond_init( &handle->runnable, NULL ) ) {
9058 errorText_ = "RtApiOss::probeDeviceOpen: error initializing pthread condition variable.";
9062 stream_.apiHandle = (void *) handle;
9065 handle = (OssHandle *) stream_.apiHandle;
9067 handle->id[mode] = fd;
9069 // Allocate necessary internal buffers.
9070 unsigned long bufferBytes;
9071 bufferBytes = stream_.nUserChannels[mode] * *bufferSize * formatBytes( stream_.userFormat );
9072 stream_.userBuffer[mode] = (char *) calloc( bufferBytes, 1 );
9073 if ( stream_.userBuffer[mode] == NULL ) {
9074 errorText_ = "RtApiOss::probeDeviceOpen: error allocating user buffer memory.";
9078 if ( stream_.doConvertBuffer[mode] ) {
9080 bool makeBuffer = true;
9081 bufferBytes = stream_.nDeviceChannels[mode] * formatBytes( stream_.deviceFormat[mode] );
9082 if ( mode == INPUT ) {
9083 if ( stream_.mode == OUTPUT && stream_.deviceBuffer ) {
9084 unsigned long bytesOut = stream_.nDeviceChannels[0] * formatBytes( stream_.deviceFormat[0] );
9085 if ( bufferBytes <= bytesOut ) makeBuffer = false;
9090 bufferBytes *= *bufferSize;
9091 if ( stream_.deviceBuffer ) free( stream_.deviceBuffer );
9092 stream_.deviceBuffer = (char *) calloc( bufferBytes, 1 );
9093 if ( stream_.deviceBuffer == NULL ) {
9094 errorText_ = "RtApiOss::probeDeviceOpen: error allocating device buffer memory.";
9100 stream_.device[mode] = device;
9101 stream_.state = STREAM_STOPPED;
9103 // Setup the buffer conversion information structure.
9104 if ( stream_.doConvertBuffer[mode] ) setConvertInfo( mode, firstChannel );
9106 // Setup thread if necessary.
9107 if ( stream_.mode == OUTPUT && mode == INPUT ) {
9108 // We had already set up an output stream.
9109 stream_.mode = DUPLEX;
9110 if ( stream_.device[0] == device ) handle->id[0] = fd;
9113 stream_.mode = mode;
9115 // Setup callback thread.
9116 stream_.callbackInfo.object = (void *) this;
9118 // Set the thread attributes for joinable and realtime scheduling
9119 // priority. The higher priority will only take affect if the
9120 // program is run as root or suid.
9121 pthread_attr_t attr;
9122 pthread_attr_init( &attr );
9123 pthread_attr_setdetachstate( &attr, PTHREAD_CREATE_JOINABLE );
9124 #ifdef SCHED_RR // Undefined with some OSes (eg: NetBSD 1.6.x with GNU Pthread)
9125 if ( options && options->flags & RTAUDIO_SCHEDULE_REALTIME ) {
9126 stream_.callbackInfo.doRealtime = true;
9127 struct sched_param param;
9128 int priority = options->priority;
9129 int min = sched_get_priority_min( SCHED_RR );
9130 int max = sched_get_priority_max( SCHED_RR );
9131 if ( priority < min ) priority = min;
9132 else if ( priority > max ) priority = max;
9133 param.sched_priority = priority;
9135 // Set the policy BEFORE the priority. Otherwise it fails.
9136 pthread_attr_setschedpolicy(&attr, SCHED_RR);
9137 pthread_attr_setscope (&attr, PTHREAD_SCOPE_SYSTEM);
9138 // This is definitely required. Otherwise it fails.
9139 pthread_attr_setinheritsched(&attr, PTHREAD_EXPLICIT_SCHED);
9140 pthread_attr_setschedparam(&attr, ¶m);
9143 pthread_attr_setschedpolicy( &attr, SCHED_OTHER );
9145 pthread_attr_setschedpolicy( &attr, SCHED_OTHER );
9148 stream_.callbackInfo.isRunning = true;
9149 result = pthread_create( &stream_.callbackInfo.thread, &attr, ossCallbackHandler, &stream_.callbackInfo );
9150 pthread_attr_destroy( &attr );
9152 // Failed. Try instead with default attributes.
9153 result = pthread_create( &stream_.callbackInfo.thread, NULL, ossCallbackHandler, &stream_.callbackInfo );
9155 stream_.callbackInfo.isRunning = false;
9156 errorText_ = "RtApiOss::error creating callback thread!";
9166 pthread_cond_destroy( &handle->runnable );
9167 if ( handle->id[0] ) close( handle->id[0] );
9168 if ( handle->id[1] ) close( handle->id[1] );
9170 stream_.apiHandle = 0;
9173 for ( int i=0; i<2; i++ ) {
9174 if ( stream_.userBuffer[i] ) {
9175 free( stream_.userBuffer[i] );
9176 stream_.userBuffer[i] = 0;
9180 if ( stream_.deviceBuffer ) {
9181 free( stream_.deviceBuffer );
9182 stream_.deviceBuffer = 0;
9185 stream_.state = STREAM_CLOSED;
9189 void RtApiOss :: closeStream()
9191 if ( stream_.state == STREAM_CLOSED ) {
9192 errorText_ = "RtApiOss::closeStream(): no open stream to close!";
9193 error( RtAudioError::WARNING );
9197 OssHandle *handle = (OssHandle *) stream_.apiHandle;
9198 stream_.callbackInfo.isRunning = false;
9199 MUTEX_LOCK( &stream_.mutex );
9200 if ( stream_.state == STREAM_STOPPED )
9201 pthread_cond_signal( &handle->runnable );
9202 MUTEX_UNLOCK( &stream_.mutex );
9203 pthread_join( stream_.callbackInfo.thread, NULL );
9205 if ( stream_.state == STREAM_RUNNING ) {
9206 if ( stream_.mode == OUTPUT || stream_.mode == DUPLEX )
9207 ioctl( handle->id[0], SNDCTL_DSP_HALT, 0 );
9209 ioctl( handle->id[1], SNDCTL_DSP_HALT, 0 );
9210 stream_.state = STREAM_STOPPED;
9214 pthread_cond_destroy( &handle->runnable );
9215 if ( handle->id[0] ) close( handle->id[0] );
9216 if ( handle->id[1] ) close( handle->id[1] );
9218 stream_.apiHandle = 0;
9221 for ( int i=0; i<2; i++ ) {
9222 if ( stream_.userBuffer[i] ) {
9223 free( stream_.userBuffer[i] );
9224 stream_.userBuffer[i] = 0;
9228 if ( stream_.deviceBuffer ) {
9229 free( stream_.deviceBuffer );
9230 stream_.deviceBuffer = 0;
9233 stream_.mode = UNINITIALIZED;
9234 stream_.state = STREAM_CLOSED;
9237 void RtApiOss :: startStream()
9240 if ( stream_.state == STREAM_RUNNING ) {
9241 errorText_ = "RtApiOss::startStream(): the stream is already running!";
9242 error( RtAudioError::WARNING );
9246 MUTEX_LOCK( &stream_.mutex );
9248 stream_.state = STREAM_RUNNING;
9250 // No need to do anything else here ... OSS automatically starts
9251 // when fed samples.
9253 MUTEX_UNLOCK( &stream_.mutex );
9255 OssHandle *handle = (OssHandle *) stream_.apiHandle;
9256 pthread_cond_signal( &handle->runnable );
9259 void RtApiOss :: stopStream()
9262 if ( stream_.state == STREAM_STOPPED ) {
9263 errorText_ = "RtApiOss::stopStream(): the stream is already stopped!";
9264 error( RtAudioError::WARNING );
9268 MUTEX_LOCK( &stream_.mutex );
9270 // The state might change while waiting on a mutex.
9271 if ( stream_.state == STREAM_STOPPED ) {
9272 MUTEX_UNLOCK( &stream_.mutex );
9277 OssHandle *handle = (OssHandle *) stream_.apiHandle;
9278 if ( stream_.mode == OUTPUT || stream_.mode == DUPLEX ) {
9280 // Flush the output with zeros a few times.
9283 RtAudioFormat format;
9285 if ( stream_.doConvertBuffer[0] ) {
9286 buffer = stream_.deviceBuffer;
9287 samples = stream_.bufferSize * stream_.nDeviceChannels[0];
9288 format = stream_.deviceFormat[0];
9291 buffer = stream_.userBuffer[0];
9292 samples = stream_.bufferSize * stream_.nUserChannels[0];
9293 format = stream_.userFormat;
9296 memset( buffer, 0, samples * formatBytes(format) );
9297 for ( unsigned int i=0; i<stream_.nBuffers+1; i++ ) {
9298 result = write( handle->id[0], buffer, samples * formatBytes(format) );
9299 if ( result == -1 ) {
9300 errorText_ = "RtApiOss::stopStream: audio write error.";
9301 error( RtAudioError::WARNING );
9305 result = ioctl( handle->id[0], SNDCTL_DSP_HALT, 0 );
9306 if ( result == -1 ) {
9307 errorStream_ << "RtApiOss::stopStream: system error stopping callback procedure on device (" << stream_.device[0] << ").";
9308 errorText_ = errorStream_.str();
9311 handle->triggered = false;
9314 if ( stream_.mode == INPUT || ( stream_.mode == DUPLEX && handle->id[0] != handle->id[1] ) ) {
9315 result = ioctl( handle->id[1], SNDCTL_DSP_HALT, 0 );
9316 if ( result == -1 ) {
9317 errorStream_ << "RtApiOss::stopStream: system error stopping input callback procedure on device (" << stream_.device[0] << ").";
9318 errorText_ = errorStream_.str();
9324 stream_.state = STREAM_STOPPED;
9325 MUTEX_UNLOCK( &stream_.mutex );
9327 if ( result != -1 ) return;
9328 error( RtAudioError::SYSTEM_ERROR );
9331 void RtApiOss :: abortStream()
9334 if ( stream_.state == STREAM_STOPPED ) {
9335 errorText_ = "RtApiOss::abortStream(): the stream is already stopped!";
9336 error( RtAudioError::WARNING );
9340 MUTEX_LOCK( &stream_.mutex );
9342 // The state might change while waiting on a mutex.
9343 if ( stream_.state == STREAM_STOPPED ) {
9344 MUTEX_UNLOCK( &stream_.mutex );
9349 OssHandle *handle = (OssHandle *) stream_.apiHandle;
9350 if ( stream_.mode == OUTPUT || stream_.mode == DUPLEX ) {
9351 result = ioctl( handle->id[0], SNDCTL_DSP_HALT, 0 );
9352 if ( result == -1 ) {
9353 errorStream_ << "RtApiOss::abortStream: system error stopping callback procedure on device (" << stream_.device[0] << ").";
9354 errorText_ = errorStream_.str();
9357 handle->triggered = false;
9360 if ( stream_.mode == INPUT || ( stream_.mode == DUPLEX && handle->id[0] != handle->id[1] ) ) {
9361 result = ioctl( handle->id[1], SNDCTL_DSP_HALT, 0 );
9362 if ( result == -1 ) {
9363 errorStream_ << "RtApiOss::abortStream: system error stopping input callback procedure on device (" << stream_.device[0] << ").";
9364 errorText_ = errorStream_.str();
9370 stream_.state = STREAM_STOPPED;
9371 MUTEX_UNLOCK( &stream_.mutex );
9373 if ( result != -1 ) return;
9374 error( RtAudioError::SYSTEM_ERROR );
9377 void RtApiOss :: callbackEvent()
9379 OssHandle *handle = (OssHandle *) stream_.apiHandle;
9380 if ( stream_.state == STREAM_STOPPED ) {
9381 MUTEX_LOCK( &stream_.mutex );
9382 pthread_cond_wait( &handle->runnable, &stream_.mutex );
9383 if ( stream_.state != STREAM_RUNNING ) {
9384 MUTEX_UNLOCK( &stream_.mutex );
9387 MUTEX_UNLOCK( &stream_.mutex );
9390 if ( stream_.state == STREAM_CLOSED ) {
9391 errorText_ = "RtApiOss::callbackEvent(): the stream is closed ... this shouldn't happen!";
9392 error( RtAudioError::WARNING );
9396 // Invoke user callback to get fresh output data.
9397 int doStopStream = 0;
9398 RtAudioCallback callback = (RtAudioCallback) stream_.callbackInfo.callback;
9399 double streamTime = getStreamTime();
9400 RtAudioStreamStatus status = 0;
9401 if ( stream_.mode != INPUT && handle->xrun[0] == true ) {
9402 status |= RTAUDIO_OUTPUT_UNDERFLOW;
9403 handle->xrun[0] = false;
9405 if ( stream_.mode != OUTPUT && handle->xrun[1] == true ) {
9406 status |= RTAUDIO_INPUT_OVERFLOW;
9407 handle->xrun[1] = false;
9409 doStopStream = callback( stream_.userBuffer[0], stream_.userBuffer[1],
9410 stream_.bufferSize, streamTime, status, stream_.callbackInfo.userData );
9411 if ( doStopStream == 2 ) {
9412 this->abortStream();
9416 MUTEX_LOCK( &stream_.mutex );
9418 // The state might change while waiting on a mutex.
9419 if ( stream_.state == STREAM_STOPPED ) goto unlock;
9424 RtAudioFormat format;
9426 if ( stream_.mode == OUTPUT || stream_.mode == DUPLEX ) {
9428 // Setup parameters and do buffer conversion if necessary.
9429 if ( stream_.doConvertBuffer[0] ) {
9430 buffer = stream_.deviceBuffer;
9431 convertBuffer( buffer, stream_.userBuffer[0], stream_.convertInfo[0] );
9432 samples = stream_.bufferSize * stream_.nDeviceChannels[0];
9433 format = stream_.deviceFormat[0];
9436 buffer = stream_.userBuffer[0];
9437 samples = stream_.bufferSize * stream_.nUserChannels[0];
9438 format = stream_.userFormat;
9441 // Do byte swapping if necessary.
9442 if ( stream_.doByteSwap[0] )
9443 byteSwapBuffer( buffer, samples, format );
9445 if ( stream_.mode == DUPLEX && handle->triggered == false ) {
9447 ioctl( handle->id[0], SNDCTL_DSP_SETTRIGGER, &trig );
9448 result = write( handle->id[0], buffer, samples * formatBytes(format) );
9449 trig = PCM_ENABLE_INPUT|PCM_ENABLE_OUTPUT;
9450 ioctl( handle->id[0], SNDCTL_DSP_SETTRIGGER, &trig );
9451 handle->triggered = true;
9454 // Write samples to device.
9455 result = write( handle->id[0], buffer, samples * formatBytes(format) );
9457 if ( result == -1 ) {
9458 // We'll assume this is an underrun, though there isn't a
9459 // specific means for determining that.
9460 handle->xrun[0] = true;
9461 errorText_ = "RtApiOss::callbackEvent: audio write error.";
9462 error( RtAudioError::WARNING );
9463 // Continue on to input section.
9467 if ( stream_.mode == INPUT || stream_.mode == DUPLEX ) {
9469 // Setup parameters.
9470 if ( stream_.doConvertBuffer[1] ) {
9471 buffer = stream_.deviceBuffer;
9472 samples = stream_.bufferSize * stream_.nDeviceChannels[1];
9473 format = stream_.deviceFormat[1];
9476 buffer = stream_.userBuffer[1];
9477 samples = stream_.bufferSize * stream_.nUserChannels[1];
9478 format = stream_.userFormat;
9481 // Read samples from device.
9482 result = read( handle->id[1], buffer, samples * formatBytes(format) );
9484 if ( result == -1 ) {
9485 // We'll assume this is an overrun, though there isn't a
9486 // specific means for determining that.
9487 handle->xrun[1] = true;
9488 errorText_ = "RtApiOss::callbackEvent: audio read error.";
9489 error( RtAudioError::WARNING );
9493 // Do byte swapping if necessary.
9494 if ( stream_.doByteSwap[1] )
9495 byteSwapBuffer( buffer, samples, format );
9497 // Do buffer conversion if necessary.
9498 if ( stream_.doConvertBuffer[1] )
9499 convertBuffer( stream_.userBuffer[1], stream_.deviceBuffer, stream_.convertInfo[1] );
9503 MUTEX_UNLOCK( &stream_.mutex );
9505 RtApi::tickStreamTime();
9506 if ( doStopStream == 1 ) this->stopStream();
9509 static void *ossCallbackHandler( void *ptr )
9511 CallbackInfo *info = (CallbackInfo *) ptr;
9512 RtApiOss *object = (RtApiOss *) info->object;
9513 bool *isRunning = &info->isRunning;
9515 #ifdef SCHED_RR // Undefined with some OSes (eg: NetBSD 1.6.x with GNU Pthread)
9516 if (info->doRealtime) {
9517 std::cerr << "RtAudio oss: " <<
9518 (sched_getscheduler(0) == SCHED_RR ? "" : "_NOT_ ") <<
9519 "running realtime scheduling" << std::endl;
9523 while ( *isRunning == true ) {
9524 pthread_testcancel();
9525 object->callbackEvent();
9528 pthread_exit( NULL );
9531 //******************** End of __LINUX_OSS__ *********************//
9535 // *************************************************** //
9537 // Protected common (OS-independent) RtAudio methods.
9539 // *************************************************** //
9541 // This method can be modified to control the behavior of error
9542 // message printing.
9543 void RtApi :: error( RtAudioError::Type type )
9545 errorStream_.str(""); // clear the ostringstream
9547 RtAudioErrorCallback errorCallback = (RtAudioErrorCallback) stream_.callbackInfo.errorCallback;
9548 if ( errorCallback ) {
9549 // abortStream() can generate new error messages. Ignore them. Just keep original one.
9551 if ( firstErrorOccurred_ )
9554 firstErrorOccurred_ = true;
9555 const std::string errorMessage = errorText_;
9557 if ( type != RtAudioError::WARNING && stream_.state != STREAM_STOPPED) {
9558 stream_.callbackInfo.isRunning = false; // exit from the thread
9562 errorCallback( type, errorMessage );
9563 firstErrorOccurred_ = false;
9567 if ( type == RtAudioError::WARNING && showWarnings_ == true )
9568 std::cerr << '\n' << errorText_ << "\n\n";
9569 else if ( type != RtAudioError::WARNING )
9570 throw( RtAudioError( errorText_, type ) );
9573 void RtApi :: verifyStream()
9575 if ( stream_.state == STREAM_CLOSED ) {
9576 errorText_ = "RtApi:: a stream is not open!";
9577 error( RtAudioError::INVALID_USE );
9581 void RtApi :: clearStreamInfo()
9583 stream_.mode = UNINITIALIZED;
9584 stream_.state = STREAM_CLOSED;
9585 stream_.sampleRate = 0;
9586 stream_.bufferSize = 0;
9587 stream_.nBuffers = 0;
9588 stream_.userFormat = 0;
9589 stream_.userInterleaved = true;
9590 stream_.streamTime = 0.0;
9591 stream_.apiHandle = 0;
9592 stream_.deviceBuffer = 0;
9593 stream_.callbackInfo.callback = 0;
9594 stream_.callbackInfo.userData = 0;
9595 stream_.callbackInfo.isRunning = false;
9596 stream_.callbackInfo.errorCallback = 0;
9597 for ( int i=0; i<2; i++ ) {
9598 stream_.device[i] = 11111;
9599 stream_.doConvertBuffer[i] = false;
9600 stream_.deviceInterleaved[i] = true;
9601 stream_.doByteSwap[i] = false;
9602 stream_.nUserChannels[i] = 0;
9603 stream_.nDeviceChannels[i] = 0;
9604 stream_.channelOffset[i] = 0;
9605 stream_.deviceFormat[i] = 0;
9606 stream_.latency[i] = 0;
9607 stream_.userBuffer[i] = 0;
9608 stream_.convertInfo[i].channels = 0;
9609 stream_.convertInfo[i].inJump = 0;
9610 stream_.convertInfo[i].outJump = 0;
9611 stream_.convertInfo[i].inFormat = 0;
9612 stream_.convertInfo[i].outFormat = 0;
9613 stream_.convertInfo[i].inOffset.clear();
9614 stream_.convertInfo[i].outOffset.clear();
9618 unsigned int RtApi :: formatBytes( RtAudioFormat format )
9620 if ( format == RTAUDIO_SINT16 )
9622 else if ( format == RTAUDIO_SINT32 || format == RTAUDIO_FLOAT32 )
9624 else if ( format == RTAUDIO_FLOAT64 )
9626 else if ( format == RTAUDIO_SINT24 )
9628 else if ( format == RTAUDIO_SINT8 )
9631 errorText_ = "RtApi::formatBytes: undefined format.";
9632 error( RtAudioError::WARNING );
9637 void RtApi :: setConvertInfo( StreamMode mode, unsigned int firstChannel )
9639 if ( mode == INPUT ) { // convert device to user buffer
9640 stream_.convertInfo[mode].inJump = stream_.nDeviceChannels[1];
9641 stream_.convertInfo[mode].outJump = stream_.nUserChannels[1];
9642 stream_.convertInfo[mode].inFormat = stream_.deviceFormat[1];
9643 stream_.convertInfo[mode].outFormat = stream_.userFormat;
9645 else { // convert user to device buffer
9646 stream_.convertInfo[mode].inJump = stream_.nUserChannels[0];
9647 stream_.convertInfo[mode].outJump = stream_.nDeviceChannels[0];
9648 stream_.convertInfo[mode].inFormat = stream_.userFormat;
9649 stream_.convertInfo[mode].outFormat = stream_.deviceFormat[0];
9652 if ( stream_.convertInfo[mode].inJump < stream_.convertInfo[mode].outJump )
9653 stream_.convertInfo[mode].channels = stream_.convertInfo[mode].inJump;
9655 stream_.convertInfo[mode].channels = stream_.convertInfo[mode].outJump;
9657 // Set up the interleave/deinterleave offsets.
9658 if ( stream_.deviceInterleaved[mode] != stream_.userInterleaved ) {
9659 if ( ( mode == OUTPUT && stream_.deviceInterleaved[mode] ) ||
9660 ( mode == INPUT && stream_.userInterleaved ) ) {
9661 for ( int k=0; k<stream_.convertInfo[mode].channels; k++ ) {
9662 stream_.convertInfo[mode].inOffset.push_back( k * stream_.bufferSize );
9663 stream_.convertInfo[mode].outOffset.push_back( k );
9664 stream_.convertInfo[mode].inJump = 1;
9668 for ( int k=0; k<stream_.convertInfo[mode].channels; k++ ) {
9669 stream_.convertInfo[mode].inOffset.push_back( k );
9670 stream_.convertInfo[mode].outOffset.push_back( k * stream_.bufferSize );
9671 stream_.convertInfo[mode].outJump = 1;
9675 else { // no (de)interleaving
9676 if ( stream_.userInterleaved ) {
9677 for ( int k=0; k<stream_.convertInfo[mode].channels; k++ ) {
9678 stream_.convertInfo[mode].inOffset.push_back( k );
9679 stream_.convertInfo[mode].outOffset.push_back( k );
9683 for ( int k=0; k<stream_.convertInfo[mode].channels; k++ ) {
9684 stream_.convertInfo[mode].inOffset.push_back( k * stream_.bufferSize );
9685 stream_.convertInfo[mode].outOffset.push_back( k * stream_.bufferSize );
9686 stream_.convertInfo[mode].inJump = 1;
9687 stream_.convertInfo[mode].outJump = 1;
9692 // Add channel offset.
9693 if ( firstChannel > 0 ) {
9694 if ( stream_.deviceInterleaved[mode] ) {
9695 if ( mode == OUTPUT ) {
9696 for ( int k=0; k<stream_.convertInfo[mode].channels; k++ )
9697 stream_.convertInfo[mode].outOffset[k] += firstChannel;
9700 for ( int k=0; k<stream_.convertInfo[mode].channels; k++ )
9701 stream_.convertInfo[mode].inOffset[k] += firstChannel;
9705 if ( mode == OUTPUT ) {
9706 for ( int k=0; k<stream_.convertInfo[mode].channels; k++ )
9707 stream_.convertInfo[mode].outOffset[k] += ( firstChannel * stream_.bufferSize );
9710 for ( int k=0; k<stream_.convertInfo[mode].channels; k++ )
9711 stream_.convertInfo[mode].inOffset[k] += ( firstChannel * stream_.bufferSize );
9717 void RtApi :: convertBuffer( char *outBuffer, char *inBuffer, ConvertInfo &info )
9719 // This function does format conversion, input/output channel compensation, and
9720 // data interleaving/deinterleaving. 24-bit integers are assumed to occupy
9721 // the lower three bytes of a 32-bit integer.
9723 // Clear our device buffer when in/out duplex device channels are different
9724 if ( outBuffer == stream_.deviceBuffer && stream_.mode == DUPLEX &&
9725 ( stream_.nDeviceChannels[0] < stream_.nDeviceChannels[1] ) )
9726 memset( outBuffer, 0, stream_.bufferSize * info.outJump * formatBytes( info.outFormat ) );
9729 if (info.outFormat == RTAUDIO_FLOAT64) {
9731 Float64 *out = (Float64 *)outBuffer;
9733 if (info.inFormat == RTAUDIO_SINT8) {
9734 signed char *in = (signed char *)inBuffer;
9735 scale = 1.0 / 127.5;
9736 for (unsigned int i=0; i<stream_.bufferSize; i++) {
9737 for (j=0; j<info.channels; j++) {
9738 out[info.outOffset[j]] = (Float64) in[info.inOffset[j]];
9739 out[info.outOffset[j]] += 0.5;
9740 out[info.outOffset[j]] *= scale;
9743 out += info.outJump;
9746 else if (info.inFormat == RTAUDIO_SINT16) {
9747 Int16 *in = (Int16 *)inBuffer;
9748 scale = 1.0 / 32767.5;
9749 for (unsigned int i=0; i<stream_.bufferSize; i++) {
9750 for (j=0; j<info.channels; j++) {
9751 out[info.outOffset[j]] = (Float64) in[info.inOffset[j]];
9752 out[info.outOffset[j]] += 0.5;
9753 out[info.outOffset[j]] *= scale;
9756 out += info.outJump;
9759 else if (info.inFormat == RTAUDIO_SINT24) {
9760 Int24 *in = (Int24 *)inBuffer;
9761 scale = 1.0 / 8388607.5;
9762 for (unsigned int i=0; i<stream_.bufferSize; i++) {
9763 for (j=0; j<info.channels; j++) {
9764 out[info.outOffset[j]] = (Float64) (in[info.inOffset[j]].asInt());
9765 out[info.outOffset[j]] += 0.5;
9766 out[info.outOffset[j]] *= scale;
9769 out += info.outJump;
9772 else if (info.inFormat == RTAUDIO_SINT32) {
9773 Int32 *in = (Int32 *)inBuffer;
9774 scale = 1.0 / 2147483647.5;
9775 for (unsigned int i=0; i<stream_.bufferSize; i++) {
9776 for (j=0; j<info.channels; j++) {
9777 out[info.outOffset[j]] = (Float64) in[info.inOffset[j]];
9778 out[info.outOffset[j]] += 0.5;
9779 out[info.outOffset[j]] *= scale;
9782 out += info.outJump;
9785 else if (info.inFormat == RTAUDIO_FLOAT32) {
9786 Float32 *in = (Float32 *)inBuffer;
9787 for (unsigned int i=0; i<stream_.bufferSize; i++) {
9788 for (j=0; j<info.channels; j++) {
9789 out[info.outOffset[j]] = (Float64) in[info.inOffset[j]];
9792 out += info.outJump;
9795 else if (info.inFormat == RTAUDIO_FLOAT64) {
9796 // Channel compensation and/or (de)interleaving only.
9797 Float64 *in = (Float64 *)inBuffer;
9798 for (unsigned int i=0; i<stream_.bufferSize; i++) {
9799 for (j=0; j<info.channels; j++) {
9800 out[info.outOffset[j]] = in[info.inOffset[j]];
9803 out += info.outJump;
9807 else if (info.outFormat == RTAUDIO_FLOAT32) {
9809 Float32 *out = (Float32 *)outBuffer;
9811 if (info.inFormat == RTAUDIO_SINT8) {
9812 signed char *in = (signed char *)inBuffer;
9813 scale = (Float32) ( 1.0 / 127.5 );
9814 for (unsigned int i=0; i<stream_.bufferSize; i++) {
9815 for (j=0; j<info.channels; j++) {
9816 out[info.outOffset[j]] = (Float32) in[info.inOffset[j]];
9817 out[info.outOffset[j]] += 0.5;
9818 out[info.outOffset[j]] *= scale;
9821 out += info.outJump;
9824 else if (info.inFormat == RTAUDIO_SINT16) {
9825 Int16 *in = (Int16 *)inBuffer;
9826 scale = (Float32) ( 1.0 / 32767.5 );
9827 for (unsigned int i=0; i<stream_.bufferSize; i++) {
9828 for (j=0; j<info.channels; j++) {
9829 out[info.outOffset[j]] = (Float32) in[info.inOffset[j]];
9830 out[info.outOffset[j]] += 0.5;
9831 out[info.outOffset[j]] *= scale;
9834 out += info.outJump;
9837 else if (info.inFormat == RTAUDIO_SINT24) {
9838 Int24 *in = (Int24 *)inBuffer;
9839 scale = (Float32) ( 1.0 / 8388607.5 );
9840 for (unsigned int i=0; i<stream_.bufferSize; i++) {
9841 for (j=0; j<info.channels; j++) {
9842 out[info.outOffset[j]] = (Float32) (in[info.inOffset[j]].asInt());
9843 out[info.outOffset[j]] += 0.5;
9844 out[info.outOffset[j]] *= scale;
9847 out += info.outJump;
9850 else if (info.inFormat == RTAUDIO_SINT32) {
9851 Int32 *in = (Int32 *)inBuffer;
9852 scale = (Float32) ( 1.0 / 2147483647.5 );
9853 for (unsigned int i=0; i<stream_.bufferSize; i++) {
9854 for (j=0; j<info.channels; j++) {
9855 out[info.outOffset[j]] = (Float32) in[info.inOffset[j]];
9856 out[info.outOffset[j]] += 0.5;
9857 out[info.outOffset[j]] *= scale;
9860 out += info.outJump;
9863 else if (info.inFormat == RTAUDIO_FLOAT32) {
9864 // Channel compensation and/or (de)interleaving only.
9865 Float32 *in = (Float32 *)inBuffer;
9866 for (unsigned int i=0; i<stream_.bufferSize; i++) {
9867 for (j=0; j<info.channels; j++) {
9868 out[info.outOffset[j]] = in[info.inOffset[j]];
9871 out += info.outJump;
9874 else if (info.inFormat == RTAUDIO_FLOAT64) {
9875 Float64 *in = (Float64 *)inBuffer;
9876 for (unsigned int i=0; i<stream_.bufferSize; i++) {
9877 for (j=0; j<info.channels; j++) {
9878 out[info.outOffset[j]] = (Float32) in[info.inOffset[j]];
9881 out += info.outJump;
9885 else if (info.outFormat == RTAUDIO_SINT32) {
9886 Int32 *out = (Int32 *)outBuffer;
9887 if (info.inFormat == RTAUDIO_SINT8) {
9888 signed char *in = (signed char *)inBuffer;
9889 for (unsigned int i=0; i<stream_.bufferSize; i++) {
9890 for (j=0; j<info.channels; j++) {
9891 out[info.outOffset[j]] = (Int32) in[info.inOffset[j]];
9892 out[info.outOffset[j]] <<= 24;
9895 out += info.outJump;
9898 else if (info.inFormat == RTAUDIO_SINT16) {
9899 Int16 *in = (Int16 *)inBuffer;
9900 for (unsigned int i=0; i<stream_.bufferSize; i++) {
9901 for (j=0; j<info.channels; j++) {
9902 out[info.outOffset[j]] = (Int32) in[info.inOffset[j]];
9903 out[info.outOffset[j]] <<= 16;
9906 out += info.outJump;
9909 else if (info.inFormat == RTAUDIO_SINT24) {
9910 Int24 *in = (Int24 *)inBuffer;
9911 for (unsigned int i=0; i<stream_.bufferSize; i++) {
9912 for (j=0; j<info.channels; j++) {
9913 out[info.outOffset[j]] = (Int32) in[info.inOffset[j]].asInt();
9914 out[info.outOffset[j]] <<= 8;
9917 out += info.outJump;
9920 else if (info.inFormat == RTAUDIO_SINT32) {
9921 // Channel compensation and/or (de)interleaving only.
9922 Int32 *in = (Int32 *)inBuffer;
9923 for (unsigned int i=0; i<stream_.bufferSize; i++) {
9924 for (j=0; j<info.channels; j++) {
9925 out[info.outOffset[j]] = in[info.inOffset[j]];
9928 out += info.outJump;
9931 else if (info.inFormat == RTAUDIO_FLOAT32) {
9932 Float32 *in = (Float32 *)inBuffer;
9933 for (unsigned int i=0; i<stream_.bufferSize; i++) {
9934 for (j=0; j<info.channels; j++) {
9935 out[info.outOffset[j]] = (Int32) (in[info.inOffset[j]] * 2147483647.5 - 0.5);
9938 out += info.outJump;
9941 else if (info.inFormat == RTAUDIO_FLOAT64) {
9942 Float64 *in = (Float64 *)inBuffer;
9943 for (unsigned int i=0; i<stream_.bufferSize; i++) {
9944 for (j=0; j<info.channels; j++) {
9945 out[info.outOffset[j]] = (Int32) (in[info.inOffset[j]] * 2147483647.5 - 0.5);
9948 out += info.outJump;
9952 else if (info.outFormat == RTAUDIO_SINT24) {
9953 Int24 *out = (Int24 *)outBuffer;
9954 if (info.inFormat == RTAUDIO_SINT8) {
9955 signed char *in = (signed char *)inBuffer;
9956 for (unsigned int i=0; i<stream_.bufferSize; i++) {
9957 for (j=0; j<info.channels; j++) {
9958 out[info.outOffset[j]] = (Int32) (in[info.inOffset[j]] << 16);
9959 //out[info.outOffset[j]] <<= 16;
9962 out += info.outJump;
9965 else if (info.inFormat == RTAUDIO_SINT16) {
9966 Int16 *in = (Int16 *)inBuffer;
9967 for (unsigned int i=0; i<stream_.bufferSize; i++) {
9968 for (j=0; j<info.channels; j++) {
9969 out[info.outOffset[j]] = (Int32) (in[info.inOffset[j]] << 8);
9970 //out[info.outOffset[j]] <<= 8;
9973 out += info.outJump;
9976 else if (info.inFormat == RTAUDIO_SINT24) {
9977 // Channel compensation and/or (de)interleaving only.
9978 Int24 *in = (Int24 *)inBuffer;
9979 for (unsigned int i=0; i<stream_.bufferSize; i++) {
9980 for (j=0; j<info.channels; j++) {
9981 out[info.outOffset[j]] = in[info.inOffset[j]];
9984 out += info.outJump;
9987 else if (info.inFormat == RTAUDIO_SINT32) {
9988 Int32 *in = (Int32 *)inBuffer;
9989 for (unsigned int i=0; i<stream_.bufferSize; i++) {
9990 for (j=0; j<info.channels; j++) {
9991 out[info.outOffset[j]] = (Int32) (in[info.inOffset[j]] >> 8);
9992 //out[info.outOffset[j]] >>= 8;
9995 out += info.outJump;
9998 else if (info.inFormat == RTAUDIO_FLOAT32) {
9999 Float32 *in = (Float32 *)inBuffer;
10000 for (unsigned int i=0; i<stream_.bufferSize; i++) {
10001 for (j=0; j<info.channels; j++) {
10002 out[info.outOffset[j]] = (Int32) (in[info.inOffset[j]] * 8388607.5 - 0.5);
10005 out += info.outJump;
10008 else if (info.inFormat == RTAUDIO_FLOAT64) {
10009 Float64 *in = (Float64 *)inBuffer;
10010 for (unsigned int i=0; i<stream_.bufferSize; i++) {
10011 for (j=0; j<info.channels; j++) {
10012 out[info.outOffset[j]] = (Int32) (in[info.inOffset[j]] * 8388607.5 - 0.5);
10015 out += info.outJump;
10019 else if (info.outFormat == RTAUDIO_SINT16) {
10020 Int16 *out = (Int16 *)outBuffer;
10021 if (info.inFormat == RTAUDIO_SINT8) {
10022 signed char *in = (signed char *)inBuffer;
10023 for (unsigned int i=0; i<stream_.bufferSize; i++) {
10024 for (j=0; j<info.channels; j++) {
10025 out[info.outOffset[j]] = (Int16) in[info.inOffset[j]];
10026 out[info.outOffset[j]] <<= 8;
10029 out += info.outJump;
10032 else if (info.inFormat == RTAUDIO_SINT16) {
10033 // Channel compensation and/or (de)interleaving only.
10034 Int16 *in = (Int16 *)inBuffer;
10035 for (unsigned int i=0; i<stream_.bufferSize; i++) {
10036 for (j=0; j<info.channels; j++) {
10037 out[info.outOffset[j]] = in[info.inOffset[j]];
10040 out += info.outJump;
10043 else if (info.inFormat == RTAUDIO_SINT24) {
10044 Int24 *in = (Int24 *)inBuffer;
10045 for (unsigned int i=0; i<stream_.bufferSize; i++) {
10046 for (j=0; j<info.channels; j++) {
10047 out[info.outOffset[j]] = (Int16) (in[info.inOffset[j]].asInt() >> 8);
10050 out += info.outJump;
10053 else if (info.inFormat == RTAUDIO_SINT32) {
10054 Int32 *in = (Int32 *)inBuffer;
10055 for (unsigned int i=0; i<stream_.bufferSize; i++) {
10056 for (j=0; j<info.channels; j++) {
10057 out[info.outOffset[j]] = (Int16) ((in[info.inOffset[j]] >> 16) & 0x0000ffff);
10060 out += info.outJump;
10063 else if (info.inFormat == RTAUDIO_FLOAT32) {
10064 Float32 *in = (Float32 *)inBuffer;
10065 for (unsigned int i=0; i<stream_.bufferSize; i++) {
10066 for (j=0; j<info.channels; j++) {
10067 out[info.outOffset[j]] = (Int16) (in[info.inOffset[j]] * 32767.5 - 0.5);
10070 out += info.outJump;
10073 else if (info.inFormat == RTAUDIO_FLOAT64) {
10074 Float64 *in = (Float64 *)inBuffer;
10075 for (unsigned int i=0; i<stream_.bufferSize; i++) {
10076 for (j=0; j<info.channels; j++) {
10077 out[info.outOffset[j]] = (Int16) (in[info.inOffset[j]] * 32767.5 - 0.5);
10080 out += info.outJump;
10084 else if (info.outFormat == RTAUDIO_SINT8) {
10085 signed char *out = (signed char *)outBuffer;
10086 if (info.inFormat == RTAUDIO_SINT8) {
10087 // Channel compensation and/or (de)interleaving only.
10088 signed char *in = (signed char *)inBuffer;
10089 for (unsigned int i=0; i<stream_.bufferSize; i++) {
10090 for (j=0; j<info.channels; j++) {
10091 out[info.outOffset[j]] = in[info.inOffset[j]];
10094 out += info.outJump;
10097 if (info.inFormat == RTAUDIO_SINT16) {
10098 Int16 *in = (Int16 *)inBuffer;
10099 for (unsigned int i=0; i<stream_.bufferSize; i++) {
10100 for (j=0; j<info.channels; j++) {
10101 out[info.outOffset[j]] = (signed char) ((in[info.inOffset[j]] >> 8) & 0x00ff);
10104 out += info.outJump;
10107 else if (info.inFormat == RTAUDIO_SINT24) {
10108 Int24 *in = (Int24 *)inBuffer;
10109 for (unsigned int i=0; i<stream_.bufferSize; i++) {
10110 for (j=0; j<info.channels; j++) {
10111 out[info.outOffset[j]] = (signed char) (in[info.inOffset[j]].asInt() >> 16);
10114 out += info.outJump;
10117 else if (info.inFormat == RTAUDIO_SINT32) {
10118 Int32 *in = (Int32 *)inBuffer;
10119 for (unsigned int i=0; i<stream_.bufferSize; i++) {
10120 for (j=0; j<info.channels; j++) {
10121 out[info.outOffset[j]] = (signed char) ((in[info.inOffset[j]] >> 24) & 0x000000ff);
10124 out += info.outJump;
10127 else if (info.inFormat == RTAUDIO_FLOAT32) {
10128 Float32 *in = (Float32 *)inBuffer;
10129 for (unsigned int i=0; i<stream_.bufferSize; i++) {
10130 for (j=0; j<info.channels; j++) {
10131 out[info.outOffset[j]] = (signed char) (in[info.inOffset[j]] * 127.5 - 0.5);
10134 out += info.outJump;
10137 else if (info.inFormat == RTAUDIO_FLOAT64) {
10138 Float64 *in = (Float64 *)inBuffer;
10139 for (unsigned int i=0; i<stream_.bufferSize; i++) {
10140 for (j=0; j<info.channels; j++) {
10141 out[info.outOffset[j]] = (signed char) (in[info.inOffset[j]] * 127.5 - 0.5);
10144 out += info.outJump;
10150 //static inline uint16_t bswap_16(uint16_t x) { return (x>>8) | (x<<8); }
10151 //static inline uint32_t bswap_32(uint32_t x) { return (bswap_16(x&0xffff)<<16) | (bswap_16(x>>16)); }
10152 //static inline uint64_t bswap_64(uint64_t x) { return (((unsigned long long)bswap_32(x&0xffffffffull))<<32) | (bswap_32(x>>32)); }
10154 void RtApi :: byteSwapBuffer( char *buffer, unsigned int samples, RtAudioFormat format )
10160 if ( format == RTAUDIO_SINT16 ) {
10161 for ( unsigned int i=0; i<samples; i++ ) {
10162 // Swap 1st and 2nd bytes.
10167 // Increment 2 bytes.
10171 else if ( format == RTAUDIO_SINT32 ||
10172 format == RTAUDIO_FLOAT32 ) {
10173 for ( unsigned int i=0; i<samples; i++ ) {
10174 // Swap 1st and 4th bytes.
10179 // Swap 2nd and 3rd bytes.
10185 // Increment 3 more bytes.
10189 else if ( format == RTAUDIO_SINT24 ) {
10190 for ( unsigned int i=0; i<samples; i++ ) {
10191 // Swap 1st and 3rd bytes.
10196 // Increment 2 more bytes.
10200 else if ( format == RTAUDIO_FLOAT64 ) {
10201 for ( unsigned int i=0; i<samples; i++ ) {
10202 // Swap 1st and 8th bytes
10207 // Swap 2nd and 7th bytes
10213 // Swap 3rd and 6th bytes
10219 // Swap 4th and 5th bytes
10225 // Increment 5 more bytes.
10231 // Indentation settings for Vim and Emacs
10233 // Local Variables:
10234 // c-basic-offset: 2
10235 // indent-tabs-mode: nil
10238 // vim: et sts=2 sw=2