diff options
| author | Gary Scavone <gary@music.mcgill.ca> | 2013-10-11 00:05:34 +0200 |
|---|---|---|
| committer | Stephen Sinclair <sinclair@music.mcgill.ca> | 2013-10-11 00:05:34 +0200 |
| commit | b6fb0b3c1d1564d533d8dcf96cb538ea099048ba (patch) | |
| tree | f8d6a644b91767004f10dfb50199320229e6dfb2 /doc/html/RtAudio_8h-source.html | |
| parent | 4f061e63d79365f16cb60293a88b07a17cbf6ad3 (diff) | |
Release 3.0.3 tarball3.0.3
Diffstat (limited to 'doc/html/RtAudio_8h-source.html')
| -rw-r--r-- | doc/html/RtAudio_8h-source.html | 519 |
1 files changed, 260 insertions, 259 deletions
diff --git a/doc/html/RtAudio_8h-source.html b/doc/html/RtAudio_8h-source.html index 52b8224..4d853be 100644 --- a/doc/html/RtAudio_8h-source.html +++ b/doc/html/RtAudio_8h-source.html @@ -11,7 +11,7 @@ <h1>RtAudio.h</h1><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">/************************************************************************/</span> <a name="l00038"></a>00038 <span class="comment">/************************************************************************/</span> <a name="l00039"></a>00039 -<a name="l00040"></a>00040 <span class="comment">// RtAudio: Version 3.0.2 (14 October 2005)</span> +<a name="l00040"></a>00040 <span class="comment">// RtAudio: Version 3.0.3 (18 November 2005)</span> <a name="l00041"></a>00041 <a name="l00042"></a>00042 <span class="preprocessor">#ifndef __RTAUDIO_H</span> <a name="l00043"></a>00043 <span class="preprocessor"></span><span class="preprocessor">#define __RTAUDIO_H</span> @@ -352,264 +352,265 @@ <a name="l00552"></a>00552 <span class="keyword">private</span>: <a name="l00553"></a>00553 <a name="l00554"></a>00554 <span class="keywordtype">void</span> initialize(<span class="keywordtype">void</span>); -<a name="l00555"></a>00555 <span class="keywordtype">void</span> probeDeviceInfo( RtApiDevice *info ); -<a name="l00556"></a>00556 <span class="keywordtype">bool</span> probeDeviceOpen( <span class="keywordtype">int</span> device, StreamMode mode, <span class="keywordtype">int</span> channels, -<a name="l00557"></a>00557 <span class="keywordtype">int</span> sampleRate, RtAudioFormat format, -<a name="l00558"></a>00558 <span class="keywordtype">int</span> *bufferSize, <span class="keywordtype">int</span> numberOfBuffers ); -<a name="l00559"></a>00559 }; -<a name="l00560"></a>00560 -<a name="l00561"></a>00561 <span class="preprocessor">#endif</span> -<a name="l00562"></a>00562 <span class="preprocessor"></span> -<a name="l00563"></a>00563 <span class="preprocessor">#if defined(__LINUX_JACK__)</span> -<a name="l00564"></a>00564 <span class="preprocessor"></span> -<a name="l00565"></a>00565 <span class="keyword">class </span>RtApiJack: <span class="keyword">public</span> RtApi -<a name="l00566"></a>00566 { -<a name="l00567"></a>00567 <span class="keyword">public</span>: -<a name="l00568"></a>00568 -<a name="l00569"></a>00569 RtApiJack(); -<a name="l00570"></a>00570 ~RtApiJack(); -<a name="l00571"></a>00571 <span class="keywordtype">void</span> tickStream(); -<a name="l00572"></a>00572 <span class="keywordtype">void</span> closeStream(); -<a name="l00573"></a>00573 <span class="keywordtype">void</span> startStream(); -<a name="l00574"></a>00574 <span class="keywordtype">void</span> stopStream(); -<a name="l00575"></a>00575 <span class="keywordtype">void</span> abortStream(); -<a name="l00576"></a>00576 <span class="keywordtype">void</span> setStreamCallback( RtAudioCallback callback, <span class="keywordtype">void</span> *userData ); -<a name="l00577"></a>00577 <span class="keywordtype">void</span> cancelStreamCallback(); -<a name="l00578"></a>00578 <span class="comment">// This function is intended for internal use only. It must be</span> -<a name="l00579"></a>00579 <span class="comment">// public because it is called by the internal callback handler,</span> -<a name="l00580"></a>00580 <span class="comment">// which is not a member of RtAudio. External use of this function</span> -<a name="l00581"></a>00581 <span class="comment">// will most likely produce highly undesireable results!</span> -<a name="l00582"></a>00582 <span class="keywordtype">void</span> callbackEvent( <span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> nframes ); -<a name="l00583"></a>00583 -<a name="l00584"></a>00584 <span class="keyword">private</span>: -<a name="l00585"></a>00585 -<a name="l00586"></a>00586 <span class="keywordtype">void</span> initialize(<span class="keywordtype">void</span>); -<a name="l00587"></a>00587 <span class="keywordtype">void</span> probeDeviceInfo( RtApiDevice *info ); -<a name="l00588"></a>00588 <span class="keywordtype">bool</span> probeDeviceOpen( <span class="keywordtype">int</span> device, StreamMode mode, <span class="keywordtype">int</span> channels, -<a name="l00589"></a>00589 <span class="keywordtype">int</span> sampleRate, RtAudioFormat format, -<a name="l00590"></a>00590 <span class="keywordtype">int</span> *bufferSize, <span class="keywordtype">int</span> numberOfBuffers ); -<a name="l00591"></a>00591 }; -<a name="l00592"></a>00592 -<a name="l00593"></a>00593 <span class="preprocessor">#endif</span> -<a name="l00594"></a>00594 <span class="preprocessor"></span> -<a name="l00595"></a>00595 <span class="preprocessor">#if defined(__LINUX_OSS__)</span> -<a name="l00596"></a>00596 <span class="preprocessor"></span> -<a name="l00597"></a>00597 <span class="keyword">class </span>RtApiOss: <span class="keyword">public</span> RtApi -<a name="l00598"></a>00598 { -<a name="l00599"></a>00599 <span class="keyword">public</span>: -<a name="l00600"></a>00600 -<a name="l00601"></a>00601 RtApiOss(); -<a name="l00602"></a>00602 ~RtApiOss(); -<a name="l00603"></a>00603 <span class="keywordtype">void</span> tickStream(); -<a name="l00604"></a>00604 <span class="keywordtype">void</span> closeStream(); -<a name="l00605"></a>00605 <span class="keywordtype">void</span> startStream(); -<a name="l00606"></a>00606 <span class="keywordtype">void</span> stopStream(); -<a name="l00607"></a>00607 <span class="keywordtype">void</span> abortStream(); -<a name="l00608"></a>00608 <span class="keywordtype">int</span> streamWillBlock(); -<a name="l00609"></a>00609 <span class="keywordtype">void</span> setStreamCallback( RtAudioCallback callback, <span class="keywordtype">void</span> *userData ); -<a name="l00610"></a>00610 <span class="keywordtype">void</span> cancelStreamCallback(); -<a name="l00611"></a>00611 -<a name="l00612"></a>00612 <span class="keyword">private</span>: -<a name="l00613"></a>00613 -<a name="l00614"></a>00614 <span class="keywordtype">void</span> initialize(<span class="keywordtype">void</span>); -<a name="l00615"></a>00615 <span class="keywordtype">void</span> probeDeviceInfo( RtApiDevice *info ); -<a name="l00616"></a>00616 <span class="keywordtype">bool</span> probeDeviceOpen( <span class="keywordtype">int</span> device, StreamMode mode, <span class="keywordtype">int</span> channels, -<a name="l00617"></a>00617 <span class="keywordtype">int</span> sampleRate, RtAudioFormat format, -<a name="l00618"></a>00618 <span class="keywordtype">int</span> *bufferSize, <span class="keywordtype">int</span> numberOfBuffers ); -<a name="l00619"></a>00619 }; -<a name="l00620"></a>00620 -<a name="l00621"></a>00621 <span class="preprocessor">#endif</span> -<a name="l00622"></a>00622 <span class="preprocessor"></span> -<a name="l00623"></a>00623 <span class="preprocessor">#if defined(__MACOSX_CORE__)</span> -<a name="l00624"></a>00624 <span class="preprocessor"></span> -<a name="l00625"></a>00625 <span class="preprocessor">#include <CoreAudio/AudioHardware.h></span> -<a name="l00626"></a>00626 -<a name="l00627"></a>00627 <span class="keyword">class </span>RtApiCore: <span class="keyword">public</span> RtApi -<a name="l00628"></a>00628 { -<a name="l00629"></a>00629 <span class="keyword">public</span>: -<a name="l00630"></a>00630 -<a name="l00631"></a>00631 RtApiCore(); -<a name="l00632"></a>00632 ~RtApiCore(); -<a name="l00633"></a>00633 <span class="keywordtype">int</span> getDefaultOutputDevice(<span class="keywordtype">void</span>); -<a name="l00634"></a>00634 <span class="keywordtype">int</span> getDefaultInputDevice(<span class="keywordtype">void</span>); -<a name="l00635"></a>00635 <span class="keywordtype">void</span> tickStream(); -<a name="l00636"></a>00636 <span class="keywordtype">void</span> closeStream(); -<a name="l00637"></a>00637 <span class="keywordtype">void</span> startStream(); -<a name="l00638"></a>00638 <span class="keywordtype">void</span> stopStream(); -<a name="l00639"></a>00639 <span class="keywordtype">void</span> abortStream(); -<a name="l00640"></a>00640 <span class="keywordtype">void</span> setStreamCallback( RtAudioCallback callback, <span class="keywordtype">void</span> *userData ); -<a name="l00641"></a>00641 <span class="keywordtype">void</span> cancelStreamCallback(); -<a name="l00642"></a>00642 -<a name="l00643"></a>00643 <span class="comment">// This function is intended for internal use only. It must be</span> -<a name="l00644"></a>00644 <span class="comment">// public because it is called by the internal callback handler,</span> -<a name="l00645"></a>00645 <span class="comment">// which is not a member of RtAudio. External use of this function</span> -<a name="l00646"></a>00646 <span class="comment">// will most likely produce highly undesireable results!</span> -<a name="l00647"></a>00647 <span class="keywordtype">void</span> callbackEvent( AudioDeviceID deviceId, <span class="keywordtype">void</span> *inData, <span class="keywordtype">void</span> *outData ); -<a name="l00648"></a>00648 -<a name="l00649"></a>00649 <span class="keyword">private</span>: -<a name="l00650"></a>00650 -<a name="l00651"></a>00651 <span class="keywordtype">void</span> initialize(<span class="keywordtype">void</span>); -<a name="l00652"></a>00652 <span class="keywordtype">void</span> probeDeviceInfo( RtApiDevice *info ); -<a name="l00653"></a>00653 <span class="keywordtype">bool</span> probeDeviceOpen( <span class="keywordtype">int</span> device, StreamMode mode, <span class="keywordtype">int</span> channels, -<a name="l00654"></a>00654 <span class="keywordtype">int</span> sampleRate, RtAudioFormat format, -<a name="l00655"></a>00655 <span class="keywordtype">int</span> *bufferSize, <span class="keywordtype">int</span> numberOfBuffers ); -<a name="l00656"></a>00656 }; -<a name="l00657"></a>00657 -<a name="l00658"></a>00658 <span class="preprocessor">#endif</span> -<a name="l00659"></a>00659 <span class="preprocessor"></span> -<a name="l00660"></a>00660 <span class="preprocessor">#if defined(__WINDOWS_DS__)</span> -<a name="l00661"></a>00661 <span class="preprocessor"></span> -<a name="l00662"></a>00662 <span class="keyword">class </span>RtApiDs: <span class="keyword">public</span> RtApi -<a name="l00663"></a>00663 { -<a name="l00664"></a>00664 <span class="keyword">public</span>: -<a name="l00665"></a>00665 -<a name="l00666"></a>00666 RtApiDs(); -<a name="l00667"></a>00667 ~RtApiDs(); -<a name="l00668"></a>00668 <span class="keywordtype">int</span> getDefaultOutputDevice(<span class="keywordtype">void</span>); -<a name="l00669"></a>00669 <span class="keywordtype">int</span> getDefaultInputDevice(<span class="keywordtype">void</span>); -<a name="l00670"></a>00670 <span class="keywordtype">void</span> tickStream(); -<a name="l00671"></a>00671 <span class="keywordtype">void</span> closeStream(); -<a name="l00672"></a>00672 <span class="keywordtype">void</span> startStream(); -<a name="l00673"></a>00673 <span class="keywordtype">void</span> stopStream(); -<a name="l00674"></a>00674 <span class="keywordtype">void</span> abortStream(); -<a name="l00675"></a>00675 <span class="keywordtype">int</span> streamWillBlock(); -<a name="l00676"></a>00676 <span class="keywordtype">void</span> setStreamCallback( RtAudioCallback callback, <span class="keywordtype">void</span> *userData ); -<a name="l00677"></a>00677 <span class="keywordtype">void</span> cancelStreamCallback(); -<a name="l00678"></a>00678 -<a name="l00679"></a>00679 <span class="keyword">public</span>: -<a name="l00680"></a>00680 <span class="comment">// \brief Internal structure that provide debug information on the state of a running DSound device.</span> -<a name="l00681"></a>00681 <span class="keyword">struct </span>RtDsStatistics { -<a name="l00682"></a>00682 <span class="comment">// \brief Sample Rate.</span> -<a name="l00683"></a>00683 <span class="keywordtype">long</span> sampleRate; -<a name="l00684"></a>00684 <span class="comment">// \brief The size of one sample * number of channels on the input device.</span> -<a name="l00685"></a>00685 <span class="keywordtype">int</span> inputFrameSize; -<a name="l00686"></a>00686 <span class="comment">// \brief The size of one sample * number of channels on the output device.</span> -<a name="l00687"></a>00687 <span class="keywordtype">int</span> outputFrameSize; -<a name="l00688"></a>00688 <span class="comment">/* \brief The number of times the read pointer had to be adjusted to avoid reading from an unsafe buffer position.</span> -<a name="l00689"></a>00689 <span class="comment"> *</span> -<a name="l00690"></a>00690 <span class="comment"> * This field is only used when running in DUPLEX mode. INPUT mode devices just wait until the data is </span> -<a name="l00691"></a>00691 <span class="comment"> * available.</span> -<a name="l00692"></a>00692 <span class="comment"> */</span> -<a name="l00693"></a>00693 <span class="keywordtype">int</span> numberOfReadOverruns; -<a name="l00694"></a>00694 <span class="comment">// \brief The number of times the write pointer had to be adjusted to avoid writing in an unsafe buffer position.</span> -<a name="l00695"></a>00695 <span class="keywordtype">int</span> numberOfWriteUnderruns; -<a name="l00696"></a>00696 <span class="comment">// \brief Number of bytes by attribute to buffer configuration by which writing must lead the current write pointer.</span> -<a name="l00697"></a>00697 <span class="keywordtype">int</span> writeDeviceBufferLeadBytes; -<a name="l00698"></a>00698 <span class="comment">// \brief Number of bytes by attributable to the device driver by which writing must lead the current write pointer on this output device.</span> -<a name="l00699"></a>00699 <span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> writeDeviceSafeLeadBytes; -<a name="l00700"></a>00700 <span class="comment">// \brief Number of bytes by which reading must trail the current read pointer on this input device.</span> -<a name="l00701"></a>00701 <span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> readDeviceSafeLeadBytes; -<a name="l00702"></a>00702 <span class="comment">/* \brief Estimated latency in seconds. </span> -<a name="l00703"></a>00703 <span class="comment"> *</span> -<a name="l00704"></a>00704 <span class="comment"> * For INPUT mode devices, based the latency of the device's safe read pointer, plus one buffer's</span> -<a name="l00705"></a>00705 <span class="comment"> * worth of additional latency.</span> -<a name="l00706"></a>00706 <span class="comment"> *</span> -<a name="l00707"></a>00707 <span class="comment"> * For OUTPUT mode devices, the latency of the device's safe write pointer, plus N buffers of </span> -<a name="l00708"></a>00708 <span class="comment"> * additional buffer latency.</span> -<a name="l00709"></a>00709 <span class="comment"> *</span> -<a name="l00710"></a>00710 <span class="comment"> * For DUPLEX devices, the sum of latencies for both input and output devices. DUPLEX devices</span> -<a name="l00711"></a>00711 <span class="comment"> * also back off the read pointers an additional amount in order to maintain synchronization </span> -<a name="l00712"></a>00712 <span class="comment"> * between out-of-phase read and write pointers. This time is also included.</span> -<a name="l00713"></a>00713 <span class="comment"> *</span> -<a name="l00714"></a>00714 <span class="comment"> * Note that most software packages report latency between the safe write pointer </span> -<a name="l00715"></a>00715 <span class="comment"> * and the software lead pointer, excluding the hardware device's safe write pointer </span> -<a name="l00716"></a>00716 <span class="comment"> * latency. Figures of 1 or 2ms of latency on Windows audio devices are invariably of this type.</span> -<a name="l00717"></a>00717 <span class="comment"> * The reality is that hardware devices often have latencies of 30ms or more (often much </span> -<a name="l00718"></a>00718 <span class="comment"> * higher for duplex operation).</span> -<a name="l00719"></a>00719 <span class="comment"> */</span> -<a name="l00720"></a>00720 -<a name="l00721"></a>00721 <span class="keywordtype">double</span> latency; -<a name="l00722"></a>00722 }; -<a name="l00723"></a>00723 <span class="comment">// \brief Report on the current state of a running DSound device.</span> -<a name="l00724"></a>00724 <span class="keyword">static</span> RtDsStatistics getDsStatistics(); -<a name="l00725"></a>00725 -<a name="l00726"></a>00726 <span class="keyword">private</span>: -<a name="l00727"></a>00727 -<a name="l00728"></a>00728 <span class="keywordtype">void</span> initialize(<span class="keywordtype">void</span>); -<a name="l00729"></a>00729 <span class="keywordtype">void</span> probeDeviceInfo( RtApiDevice *info ); -<a name="l00730"></a>00730 <span class="keywordtype">bool</span> probeDeviceOpen( <span class="keywordtype">int</span> device, StreamMode mode, <span class="keywordtype">int</span> channels, -<a name="l00731"></a>00731 <span class="keywordtype">int</span> sampleRate, RtAudioFormat format, -<a name="l00732"></a>00732 <span class="keywordtype">int</span> *bufferSize, <span class="keywordtype">int</span> numberOfBuffers ); -<a name="l00733"></a>00733 -<a name="l00734"></a>00734 <span class="keywordtype">bool</span> coInitialized; -<a name="l00735"></a>00735 <span class="keywordtype">bool</span> buffersRolling; -<a name="l00736"></a>00736 <span class="keywordtype">long</span> duplexPrerollBytes; -<a name="l00737"></a>00737 <span class="keyword">static</span> RtDsStatistics statistics; -<a name="l00738"></a>00738 -<a name="l00739"></a>00739 }; -<a name="l00740"></a>00740 -<a name="l00741"></a>00741 <span class="preprocessor">#endif</span> -<a name="l00742"></a>00742 <span class="preprocessor"></span> -<a name="l00743"></a>00743 <span class="preprocessor">#if defined(__WINDOWS_ASIO__)</span> -<a name="l00744"></a>00744 <span class="preprocessor"></span> -<a name="l00745"></a>00745 <span class="keyword">class </span>RtApiAsio: <span class="keyword">public</span> RtApi -<a name="l00746"></a>00746 { -<a name="l00747"></a>00747 <span class="keyword">public</span>: -<a name="l00748"></a>00748 -<a name="l00749"></a>00749 RtApiAsio(); -<a name="l00750"></a>00750 ~RtApiAsio(); -<a name="l00751"></a>00751 <span class="keywordtype">void</span> tickStream(); -<a name="l00752"></a>00752 <span class="keywordtype">void</span> closeStream(); -<a name="l00753"></a>00753 <span class="keywordtype">void</span> startStream(); -<a name="l00754"></a>00754 <span class="keywordtype">void</span> stopStream(); -<a name="l00755"></a>00755 <span class="keywordtype">void</span> abortStream(); -<a name="l00756"></a>00756 <span class="keywordtype">void</span> setStreamCallback( RtAudioCallback callback, <span class="keywordtype">void</span> *userData ); -<a name="l00757"></a>00757 <span class="keywordtype">void</span> cancelStreamCallback(); -<a name="l00758"></a>00758 -<a name="l00759"></a>00759 <span class="comment">// This function is intended for internal use only. It must be</span> -<a name="l00760"></a>00760 <span class="comment">// public because it is called by the internal callback handler,</span> -<a name="l00761"></a>00761 <span class="comment">// which is not a member of RtAudio. External use of this function</span> -<a name="l00762"></a>00762 <span class="comment">// will most likely produce highly undesireable results!</span> -<a name="l00763"></a>00763 <span class="keywordtype">void</span> callbackEvent( <span class="keywordtype">long</span> bufferIndex ); -<a name="l00764"></a>00764 -<a name="l00765"></a>00765 <span class="keyword">private</span>: -<a name="l00766"></a>00766 -<a name="l00767"></a>00767 <span class="keywordtype">void</span> initialize(<span class="keywordtype">void</span>); -<a name="l00768"></a>00768 <span class="keywordtype">void</span> probeDeviceInfo( RtApiDevice *info ); -<a name="l00769"></a>00769 <span class="keywordtype">bool</span> probeDeviceOpen( <span class="keywordtype">int</span> device, StreamMode mode, <span class="keywordtype">int</span> channels, -<a name="l00770"></a>00770 <span class="keywordtype">int</span> sampleRate, RtAudioFormat format, -<a name="l00771"></a>00771 <span class="keywordtype">int</span> *bufferSize, <span class="keywordtype">int</span> numberOfBuffers ); -<a name="l00772"></a>00772 -<a name="l00773"></a>00773 <span class="keywordtype">bool</span> coInitialized; -<a name="l00774"></a>00774 -<a name="l00775"></a>00775 }; -<a name="l00776"></a>00776 -<a name="l00777"></a>00777 <span class="preprocessor">#endif</span> -<a name="l00778"></a>00778 <span class="preprocessor"></span> -<a name="l00779"></a>00779 <span class="preprocessor">#if defined(__IRIX_AL__)</span> -<a name="l00780"></a>00780 <span class="preprocessor"></span> -<a name="l00781"></a>00781 <span class="keyword">class </span>RtApiAl: <span class="keyword">public</span> RtApi -<a name="l00782"></a>00782 { -<a name="l00783"></a>00783 <span class="keyword">public</span>: -<a name="l00784"></a>00784 -<a name="l00785"></a>00785 RtApiAl(); -<a name="l00786"></a>00786 ~RtApiAl(); -<a name="l00787"></a>00787 <span class="keywordtype">int</span> getDefaultOutputDevice(<span class="keywordtype">void</span>); -<a name="l00788"></a>00788 <span class="keywordtype">int</span> getDefaultInputDevice(<span class="keywordtype">void</span>); -<a name="l00789"></a>00789 <span class="keywordtype">void</span> tickStream(); -<a name="l00790"></a>00790 <span class="keywordtype">void</span> closeStream(); -<a name="l00791"></a>00791 <span class="keywordtype">void</span> startStream(); -<a name="l00792"></a>00792 <span class="keywordtype">void</span> stopStream(); -<a name="l00793"></a>00793 <span class="keywordtype">void</span> abortStream(); -<a name="l00794"></a>00794 <span class="keywordtype">int</span> streamWillBlock(); -<a name="l00795"></a>00795 <span class="keywordtype">void</span> setStreamCallback( RtAudioCallback callback, <span class="keywordtype">void</span> *userData ); -<a name="l00796"></a>00796 <span class="keywordtype">void</span> cancelStreamCallback(); -<a name="l00797"></a>00797 -<a name="l00798"></a>00798 <span class="keyword">private</span>: -<a name="l00799"></a>00799 -<a name="l00800"></a>00800 <span class="keywordtype">void</span> initialize(<span class="keywordtype">void</span>); -<a name="l00801"></a>00801 <span class="keywordtype">void</span> probeDeviceInfo( RtApiDevice *info ); -<a name="l00802"></a>00802 <span class="keywordtype">bool</span> probeDeviceOpen( <span class="keywordtype">int</span> device, StreamMode mode, <span class="keywordtype">int</span> channels, -<a name="l00803"></a>00803 <span class="keywordtype">int</span> sampleRate, RtAudioFormat format, -<a name="l00804"></a>00804 <span class="keywordtype">int</span> *bufferSize, <span class="keywordtype">int</span> numberOfBuffers ); -<a name="l00805"></a>00805 }; -<a name="l00806"></a>00806 -<a name="l00807"></a>00807 <span class="preprocessor">#endif</span> -<a name="l00808"></a>00808 <span class="preprocessor"></span> -<a name="l00809"></a>00809 <span class="comment">// Define the following flag to have extra information spewed to stderr.</span> -<a name="l00810"></a>00810 <span class="comment">//#define __RTAUDIO_DEBUG__</span> -<a name="l00811"></a>00811 -<a name="l00812"></a>00812 <span class="preprocessor">#endif</span> +<a name="l00555"></a>00555 <span class="keywordtype">bool</span> primeOutputBuffer(); +<a name="l00556"></a>00556 <span class="keywordtype">void</span> probeDeviceInfo( RtApiDevice *info ); +<a name="l00557"></a>00557 <span class="keywordtype">bool</span> probeDeviceOpen( <span class="keywordtype">int</span> device, StreamMode mode, <span class="keywordtype">int</span> channels, +<a name="l00558"></a>00558 <span class="keywordtype">int</span> sampleRate, RtAudioFormat format, +<a name="l00559"></a>00559 <span class="keywordtype">int</span> *bufferSize, <span class="keywordtype">int</span> numberOfBuffers ); +<a name="l00560"></a>00560 }; +<a name="l00561"></a>00561 +<a name="l00562"></a>00562 <span class="preprocessor">#endif</span> +<a name="l00563"></a>00563 <span class="preprocessor"></span> +<a name="l00564"></a>00564 <span class="preprocessor">#if defined(__LINUX_JACK__)</span> +<a name="l00565"></a>00565 <span class="preprocessor"></span> +<a name="l00566"></a>00566 <span class="keyword">class </span>RtApiJack: <span class="keyword">public</span> RtApi +<a name="l00567"></a>00567 { +<a name="l00568"></a>00568 <span class="keyword">public</span>: +<a name="l00569"></a>00569 +<a name="l00570"></a>00570 RtApiJack(); +<a name="l00571"></a>00571 ~RtApiJack(); +<a name="l00572"></a>00572 <span class="keywordtype">void</span> tickStream(); +<a name="l00573"></a>00573 <span class="keywordtype">void</span> closeStream(); +<a name="l00574"></a>00574 <span class="keywordtype">void</span> startStream(); +<a name="l00575"></a>00575 <span class="keywordtype">void</span> stopStream(); +<a name="l00576"></a>00576 <span class="keywordtype">void</span> abortStream(); +<a name="l00577"></a>00577 <span class="keywordtype">void</span> setStreamCallback( RtAudioCallback callback, <span class="keywordtype">void</span> *userData ); +<a name="l00578"></a>00578 <span class="keywordtype">void</span> cancelStreamCallback(); +<a name="l00579"></a>00579 <span class="comment">// This function is intended for internal use only. It must be</span> +<a name="l00580"></a>00580 <span class="comment">// public because it is called by the internal callback handler,</span> +<a name="l00581"></a>00581 <span class="comment">// which is not a member of RtAudio. External use of this function</span> +<a name="l00582"></a>00582 <span class="comment">// will most likely produce highly undesireable results!</span> +<a name="l00583"></a>00583 <span class="keywordtype">void</span> callbackEvent( <span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> nframes ); +<a name="l00584"></a>00584 +<a name="l00585"></a>00585 <span class="keyword">private</span>: +<a name="l00586"></a>00586 +<a name="l00587"></a>00587 <span class="keywordtype">void</span> initialize(<span class="keywordtype">void</span>); +<a name="l00588"></a>00588 <span class="keywordtype">void</span> probeDeviceInfo( RtApiDevice *info ); +<a name="l00589"></a>00589 <span class="keywordtype">bool</span> probeDeviceOpen( <span class="keywordtype">int</span> device, StreamMode mode, <span class="keywordtype">int</span> channels, +<a name="l00590"></a>00590 <span class="keywordtype">int</span> sampleRate, RtAudioFormat format, +<a name="l00591"></a>00591 <span class="keywordtype">int</span> *bufferSize, <span class="keywordtype">int</span> numberOfBuffers ); +<a name="l00592"></a>00592 }; +<a name="l00593"></a>00593 +<a name="l00594"></a>00594 <span class="preprocessor">#endif</span> +<a name="l00595"></a>00595 <span class="preprocessor"></span> +<a name="l00596"></a>00596 <span class="preprocessor">#if defined(__LINUX_OSS__)</span> +<a name="l00597"></a>00597 <span class="preprocessor"></span> +<a name="l00598"></a>00598 <span class="keyword">class </span>RtApiOss: <span class="keyword">public</span> RtApi +<a name="l00599"></a>00599 { +<a name="l00600"></a>00600 <span class="keyword">public</span>: +<a name="l00601"></a>00601 +<a name="l00602"></a>00602 RtApiOss(); +<a name="l00603"></a>00603 ~RtApiOss(); +<a name="l00604"></a>00604 <span class="keywordtype">void</span> tickStream(); +<a name="l00605"></a>00605 <span class="keywordtype">void</span> closeStream(); +<a name="l00606"></a>00606 <span class="keywordtype">void</span> startStream(); +<a name="l00607"></a>00607 <span class="keywordtype">void</span> stopStream(); +<a name="l00608"></a>00608 <span class="keywordtype">void</span> abortStream(); +<a name="l00609"></a>00609 <span class="keywordtype">int</span> streamWillBlock(); +<a name="l00610"></a>00610 <span class="keywordtype">void</span> setStreamCallback( RtAudioCallback callback, <span class="keywordtype">void</span> *userData ); +<a name="l00611"></a>00611 <span class="keywordtype">void</span> cancelStreamCallback(); +<a name="l00612"></a>00612 +<a name="l00613"></a>00613 <span class="keyword">private</span>: +<a name="l00614"></a>00614 +<a name="l00615"></a>00615 <span class="keywordtype">void</span> initialize(<span class="keywordtype">void</span>); +<a name="l00616"></a>00616 <span class="keywordtype">void</span> probeDeviceInfo( RtApiDevice *info ); +<a name="l00617"></a>00617 <span class="keywordtype">bool</span> probeDeviceOpen( <span class="keywordtype">int</span> device, StreamMode mode, <span class="keywordtype">int</span> channels, +<a name="l00618"></a>00618 <span class="keywordtype">int</span> sampleRate, RtAudioFormat format, +<a name="l00619"></a>00619 <span class="keywordtype">int</span> *bufferSize, <span class="keywordtype">int</span> numberOfBuffers ); +<a name="l00620"></a>00620 }; +<a name="l00621"></a>00621 +<a name="l00622"></a>00622 <span class="preprocessor">#endif</span> +<a name="l00623"></a>00623 <span class="preprocessor"></span> +<a name="l00624"></a>00624 <span class="preprocessor">#if defined(__MACOSX_CORE__)</span> +<a name="l00625"></a>00625 <span class="preprocessor"></span> +<a name="l00626"></a>00626 <span class="preprocessor">#include <CoreAudio/AudioHardware.h></span> +<a name="l00627"></a>00627 +<a name="l00628"></a>00628 <span class="keyword">class </span>RtApiCore: <span class="keyword">public</span> RtApi +<a name="l00629"></a>00629 { +<a name="l00630"></a>00630 <span class="keyword">public</span>: +<a name="l00631"></a>00631 +<a name="l00632"></a>00632 RtApiCore(); +<a name="l00633"></a>00633 ~RtApiCore(); +<a name="l00634"></a>00634 <span class="keywordtype">int</span> getDefaultOutputDevice(<span class="keywordtype">void</span>); +<a name="l00635"></a>00635 <span class="keywordtype">int</span> getDefaultInputDevice(<span class="keywordtype">void</span>); +<a name="l00636"></a>00636 <span class="keywordtype">void</span> tickStream(); +<a name="l00637"></a>00637 <span class="keywordtype">void</span> closeStream(); +<a name="l00638"></a>00638 <span class="keywordtype">void</span> startStream(); +<a name="l00639"></a>00639 <span class="keywordtype">void</span> stopStream(); +<a name="l00640"></a>00640 <span class="keywordtype">void</span> abortStream(); +<a name="l00641"></a>00641 <span class="keywordtype">void</span> setStreamCallback( RtAudioCallback callback, <span class="keywordtype">void</span> *userData ); +<a name="l00642"></a>00642 <span class="keywordtype">void</span> cancelStreamCallback(); +<a name="l00643"></a>00643 +<a name="l00644"></a>00644 <span class="comment">// This function is intended for internal use only. It must be</span> +<a name="l00645"></a>00645 <span class="comment">// public because it is called by the internal callback handler,</span> +<a name="l00646"></a>00646 <span class="comment">// which is not a member of RtAudio. External use of this function</span> +<a name="l00647"></a>00647 <span class="comment">// will most likely produce highly undesireable results!</span> +<a name="l00648"></a>00648 <span class="keywordtype">void</span> callbackEvent( AudioDeviceID deviceId, <span class="keywordtype">void</span> *inData, <span class="keywordtype">void</span> *outData ); +<a name="l00649"></a>00649 +<a name="l00650"></a>00650 <span class="keyword">private</span>: +<a name="l00651"></a>00651 +<a name="l00652"></a>00652 <span class="keywordtype">void</span> initialize(<span class="keywordtype">void</span>); +<a name="l00653"></a>00653 <span class="keywordtype">void</span> probeDeviceInfo( RtApiDevice *info ); +<a name="l00654"></a>00654 <span class="keywordtype">bool</span> probeDeviceOpen( <span class="keywordtype">int</span> device, StreamMode mode, <span class="keywordtype">int</span> channels, +<a name="l00655"></a>00655 <span class="keywordtype">int</span> sampleRate, RtAudioFormat format, +<a name="l00656"></a>00656 <span class="keywordtype">int</span> *bufferSize, <span class="keywordtype">int</span> numberOfBuffers ); +<a name="l00657"></a>00657 }; +<a name="l00658"></a>00658 +<a name="l00659"></a>00659 <span class="preprocessor">#endif</span> +<a name="l00660"></a>00660 <span class="preprocessor"></span> +<a name="l00661"></a>00661 <span class="preprocessor">#if defined(__WINDOWS_DS__)</span> +<a name="l00662"></a>00662 <span class="preprocessor"></span> +<a name="l00663"></a>00663 <span class="keyword">class </span>RtApiDs: <span class="keyword">public</span> RtApi +<a name="l00664"></a>00664 { +<a name="l00665"></a>00665 <span class="keyword">public</span>: +<a name="l00666"></a>00666 +<a name="l00667"></a>00667 RtApiDs(); +<a name="l00668"></a>00668 ~RtApiDs(); +<a name="l00669"></a>00669 <span class="keywordtype">int</span> getDefaultOutputDevice(<span class="keywordtype">void</span>); +<a name="l00670"></a>00670 <span class="keywordtype">int</span> getDefaultInputDevice(<span class="keywordtype">void</span>); +<a name="l00671"></a>00671 <span class="keywordtype">void</span> tickStream(); +<a name="l00672"></a>00672 <span class="keywordtype">void</span> closeStream(); +<a name="l00673"></a>00673 <span class="keywordtype">void</span> startStream(); +<a name="l00674"></a>00674 <span class="keywordtype">void</span> stopStream(); +<a name="l00675"></a>00675 <span class="keywordtype">void</span> abortStream(); +<a name="l00676"></a>00676 <span class="keywordtype">int</span> streamWillBlock(); +<a name="l00677"></a>00677 <span class="keywordtype">void</span> setStreamCallback( RtAudioCallback callback, <span class="keywordtype">void</span> *userData ); +<a name="l00678"></a>00678 <span class="keywordtype">void</span> cancelStreamCallback(); +<a name="l00679"></a>00679 +<a name="l00680"></a>00680 <span class="keyword">public</span>: +<a name="l00681"></a>00681 <span class="comment">// \brief Internal structure that provide debug information on the state of a running DSound device.</span> +<a name="l00682"></a>00682 <span class="keyword">struct </span>RtDsStatistics { +<a name="l00683"></a>00683 <span class="comment">// \brief Sample Rate.</span> +<a name="l00684"></a>00684 <span class="keywordtype">long</span> sampleRate; +<a name="l00685"></a>00685 <span class="comment">// \brief The size of one sample * number of channels on the input device.</span> +<a name="l00686"></a>00686 <span class="keywordtype">int</span> inputFrameSize; +<a name="l00687"></a>00687 <span class="comment">// \brief The size of one sample * number of channels on the output device.</span> +<a name="l00688"></a>00688 <span class="keywordtype">int</span> outputFrameSize; +<a name="l00689"></a>00689 <span class="comment">/* \brief The number of times the read pointer had to be adjusted to avoid reading from an unsafe buffer position.</span> +<a name="l00690"></a>00690 <span class="comment"> *</span> +<a name="l00691"></a>00691 <span class="comment"> * This field is only used when running in DUPLEX mode. INPUT mode devices just wait until the data is </span> +<a name="l00692"></a>00692 <span class="comment"> * available.</span> +<a name="l00693"></a>00693 <span class="comment"> */</span> +<a name="l00694"></a>00694 <span class="keywordtype">int</span> numberOfReadOverruns; +<a name="l00695"></a>00695 <span class="comment">// \brief The number of times the write pointer had to be adjusted to avoid writing in an unsafe buffer position.</span> +<a name="l00696"></a>00696 <span class="keywordtype">int</span> numberOfWriteUnderruns; +<a name="l00697"></a>00697 <span class="comment">// \brief Number of bytes by attribute to buffer configuration by which writing must lead the current write pointer.</span> +<a name="l00698"></a>00698 <span class="keywordtype">int</span> writeDeviceBufferLeadBytes; +<a name="l00699"></a>00699 <span class="comment">// \brief Number of bytes by attributable to the device driver by which writing must lead the current write pointer on this output device.</span> +<a name="l00700"></a>00700 <span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> writeDeviceSafeLeadBytes; +<a name="l00701"></a>00701 <span class="comment">// \brief Number of bytes by which reading must trail the current read pointer on this input device.</span> +<a name="l00702"></a>00702 <span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> readDeviceSafeLeadBytes; +<a name="l00703"></a>00703 <span class="comment">/* \brief Estimated latency in seconds. </span> +<a name="l00704"></a>00704 <span class="comment"> *</span> +<a name="l00705"></a>00705 <span class="comment"> * For INPUT mode devices, based the latency of the device's safe read pointer, plus one buffer's</span> +<a name="l00706"></a>00706 <span class="comment"> * worth of additional latency.</span> +<a name="l00707"></a>00707 <span class="comment"> *</span> +<a name="l00708"></a>00708 <span class="comment"> * For OUTPUT mode devices, the latency of the device's safe write pointer, plus N buffers of </span> +<a name="l00709"></a>00709 <span class="comment"> * additional buffer latency.</span> +<a name="l00710"></a>00710 <span class="comment"> *</span> +<a name="l00711"></a>00711 <span class="comment"> * For DUPLEX devices, the sum of latencies for both input and output devices. DUPLEX devices</span> +<a name="l00712"></a>00712 <span class="comment"> * also back off the read pointers an additional amount in order to maintain synchronization </span> +<a name="l00713"></a>00713 <span class="comment"> * between out-of-phase read and write pointers. This time is also included.</span> +<a name="l00714"></a>00714 <span class="comment"> *</span> +<a name="l00715"></a>00715 <span class="comment"> * Note that most software packages report latency between the safe write pointer </span> +<a name="l00716"></a>00716 <span class="comment"> * and the software lead pointer, excluding the hardware device's safe write pointer </span> +<a name="l00717"></a>00717 <span class="comment"> * latency. Figures of 1 or 2ms of latency on Windows audio devices are invariably of this type.</span> +<a name="l00718"></a>00718 <span class="comment"> * The reality is that hardware devices often have latencies of 30ms or more (often much </span> +<a name="l00719"></a>00719 <span class="comment"> * higher for duplex operation).</span> +<a name="l00720"></a>00720 <span class="comment"> */</span> +<a name="l00721"></a>00721 +<a name="l00722"></a>00722 <span class="keywordtype">double</span> latency; +<a name="l00723"></a>00723 }; +<a name="l00724"></a>00724 <span class="comment">// \brief Report on the current state of a running DSound device.</span> +<a name="l00725"></a>00725 <span class="keyword">static</span> RtDsStatistics getDsStatistics(); +<a name="l00726"></a>00726 +<a name="l00727"></a>00727 <span class="keyword">private</span>: +<a name="l00728"></a>00728 +<a name="l00729"></a>00729 <span class="keywordtype">void</span> initialize(<span class="keywordtype">void</span>); +<a name="l00730"></a>00730 <span class="keywordtype">void</span> probeDeviceInfo( RtApiDevice *info ); +<a name="l00731"></a>00731 <span class="keywordtype">bool</span> probeDeviceOpen( <span class="keywordtype">int</span> device, StreamMode mode, <span class="keywordtype">int</span> channels, +<a name="l00732"></a>00732 <span class="keywordtype">int</span> sampleRate, RtAudioFormat format, +<a name="l00733"></a>00733 <span class="keywordtype">int</span> *bufferSize, <span class="keywordtype">int</span> numberOfBuffers ); +<a name="l00734"></a>00734 +<a name="l00735"></a>00735 <span class="keywordtype">bool</span> coInitialized; +<a name="l00736"></a>00736 <span class="keywordtype">bool</span> buffersRolling; +<a name="l00737"></a>00737 <span class="keywordtype">long</span> duplexPrerollBytes; +<a name="l00738"></a>00738 <span class="keyword">static</span> RtDsStatistics statistics; +<a name="l00739"></a>00739 +<a name="l00740"></a>00740 }; +<a name="l00741"></a>00741 +<a name="l00742"></a>00742 <span class="preprocessor">#endif</span> +<a name="l00743"></a>00743 <span class="preprocessor"></span> +<a name="l00744"></a>00744 <span class="preprocessor">#if defined(__WINDOWS_ASIO__)</span> +<a name="l00745"></a>00745 <span class="preprocessor"></span> +<a name="l00746"></a>00746 <span class="keyword">class </span>RtApiAsio: <span class="keyword">public</span> RtApi +<a name="l00747"></a>00747 { +<a name="l00748"></a>00748 <span class="keyword">public</span>: +<a name="l00749"></a>00749 +<a name="l00750"></a>00750 RtApiAsio(); +<a name="l00751"></a>00751 ~RtApiAsio(); +<a name="l00752"></a>00752 <span class="keywordtype">void</span> tickStream(); +<a name="l00753"></a>00753 <span class="keywordtype">void</span> closeStream(); +<a name="l00754"></a>00754 <span class="keywordtype">void</span> startStream(); +<a name="l00755"></a>00755 <span class="keywordtype">void</span> stopStream(); +<a name="l00756"></a>00756 <span class="keywordtype">void</span> abortStream(); +<a name="l00757"></a>00757 <span class="keywordtype">void</span> setStreamCallback( RtAudioCallback callback, <span class="keywordtype">void</span> *userData ); +<a name="l00758"></a>00758 <span class="keywordtype">void</span> cancelStreamCallback(); +<a name="l00759"></a>00759 +<a name="l00760"></a>00760 <span class="comment">// This function is intended for internal use only. It must be</span> +<a name="l00761"></a>00761 <span class="comment">// public because it is called by the internal callback handler,</span> +<a name="l00762"></a>00762 <span class="comment">// which is not a member of RtAudio. External use of this function</span> +<a name="l00763"></a>00763 <span class="comment">// will most likely produce highly undesireable results!</span> +<a name="l00764"></a>00764 <span class="keywordtype">void</span> callbackEvent( <span class="keywordtype">long</span> bufferIndex ); +<a name="l00765"></a>00765 +<a name="l00766"></a>00766 <span class="keyword">private</span>: +<a name="l00767"></a>00767 +<a name="l00768"></a>00768 <span class="keywordtype">void</span> initialize(<span class="keywordtype">void</span>); +<a name="l00769"></a>00769 <span class="keywordtype">void</span> probeDeviceInfo( RtApiDevice *info ); +<a name="l00770"></a>00770 <span class="keywordtype">bool</span> probeDeviceOpen( <span class="keywordtype">int</span> device, StreamMode mode, <span class="keywordtype">int</span> channels, +<a name="l00771"></a>00771 <span class="keywordtype">int</span> sampleRate, RtAudioFormat format, +<a name="l00772"></a>00772 <span class="keywordtype">int</span> *bufferSize, <span class="keywordtype">int</span> numberOfBuffers ); +<a name="l00773"></a>00773 +<a name="l00774"></a>00774 <span class="keywordtype">bool</span> coInitialized; +<a name="l00775"></a>00775 +<a name="l00776"></a>00776 }; +<a name="l00777"></a>00777 +<a name="l00778"></a>00778 <span class="preprocessor">#endif</span> +<a name="l00779"></a>00779 <span class="preprocessor"></span> +<a name="l00780"></a>00780 <span class="preprocessor">#if defined(__IRIX_AL__)</span> +<a name="l00781"></a>00781 <span class="preprocessor"></span> +<a name="l00782"></a>00782 <span class="keyword">class </span>RtApiAl: <span class="keyword">public</span> RtApi +<a name="l00783"></a>00783 { +<a name="l00784"></a>00784 <span class="keyword">public</span>: +<a name="l00785"></a>00785 +<a name="l00786"></a>00786 RtApiAl(); +<a name="l00787"></a>00787 ~RtApiAl(); +<a name="l00788"></a>00788 <span class="keywordtype">int</span> getDefaultOutputDevice(<span class="keywordtype">void</span>); +<a name="l00789"></a>00789 <span class="keywordtype">int</span> getDefaultInputDevice(<span class="keywordtype">void</span>); +<a name="l00790"></a>00790 <span class="keywordtype">void</span> tickStream(); +<a name="l00791"></a>00791 <span class="keywordtype">void</span> closeStream(); +<a name="l00792"></a>00792 <span class="keywordtype">void</span> startStream(); +<a name="l00793"></a>00793 <span class="keywordtype">void</span> stopStream(); +<a name="l00794"></a>00794 <span class="keywordtype">void</span> abortStream(); +<a name="l00795"></a>00795 <span class="keywordtype">int</span> streamWillBlock(); +<a name="l00796"></a>00796 <span class="keywordtype">void</span> setStreamCallback( RtAudioCallback callback, <span class="keywordtype">void</span> *userData ); +<a name="l00797"></a>00797 <span class="keywordtype">void</span> cancelStreamCallback(); +<a name="l00798"></a>00798 +<a name="l00799"></a>00799 <span class="keyword">private</span>: +<a name="l00800"></a>00800 +<a name="l00801"></a>00801 <span class="keywordtype">void</span> initialize(<span class="keywordtype">void</span>); +<a name="l00802"></a>00802 <span class="keywordtype">void</span> probeDeviceInfo( RtApiDevice *info ); +<a name="l00803"></a>00803 <span class="keywordtype">bool</span> probeDeviceOpen( <span class="keywordtype">int</span> device, StreamMode mode, <span class="keywordtype">int</span> channels, +<a name="l00804"></a>00804 <span class="keywordtype">int</span> sampleRate, RtAudioFormat format, +<a name="l00805"></a>00805 <span class="keywordtype">int</span> *bufferSize, <span class="keywordtype">int</span> numberOfBuffers ); +<a name="l00806"></a>00806 }; +<a name="l00807"></a>00807 +<a name="l00808"></a>00808 <span class="preprocessor">#endif</span> +<a name="l00809"></a>00809 <span class="preprocessor"></span> +<a name="l00810"></a>00810 <span class="comment">// Define the following flag to have extra information spewed to stderr.</span> +<a name="l00811"></a>00811 <span class="comment">//#define __RTAUDIO_DEBUG__</span> +<a name="l00812"></a>00812 +<a name="l00813"></a>00813 <span class="preprocessor">#endif</span> </pre></div><HR> <table><tr><td><img src="../images/mcgill.gif" width=165></td> |