The RtAudio Tutorial

00001 /******************************************/
-00002 /*
-00003   RtAudio - realtime sound I/O C++ class
-00004   by Gary P. Scavone, 2001-2002.
-00005 */
-00006 /******************************************/
-00007 
-00008 #if !defined(__RTAUDIO_H)
-00009 #define __RTAUDIO_H
-00010 
-00011 #include <map>
-00012 
-00013 #if defined(__LINUX_ALSA__)
-00014   #include <alsa/asoundlib.h>
-00015   #include <pthread.h>
-00016   #include <unistd.h>
-00017 
-00018   #define THREAD_TYPE
-00019   typedef snd_pcm_t *AUDIO_HANDLE;
-00020   typedef int DEVICE_ID;
-00021   typedef pthread_t THREAD_HANDLE;
-00022   typedef pthread_mutex_t MUTEX;
-00023 
-00024 #elif defined(__LINUX_OSS__)
-00025   #include <pthread.h>
-00026   #include <unistd.h>
-00027 
-00028   #define THREAD_TYPE
-00029   typedef int AUDIO_HANDLE;
-00030   typedef int DEVICE_ID;
-00031   typedef pthread_t THREAD_HANDLE;
-00032   typedef pthread_mutex_t MUTEX;
-00033 
-00034 #elif defined(__WINDOWS_DS__)
-00035   #include <windows.h>
-00036   #include <process.h>
-00037 
-00038   // The following struct is used to hold the extra variables
-00039   // specific to the DirectSound implementation.
-00040   typedef struct {
-00041     void * object;
-00042     void * buffer;
-00043     UINT bufferPointer;
-00044   } AUDIO_HANDLE;
-00045 
-00046   #define THREAD_TYPE __stdcall
-00047   typedef LPGUID DEVICE_ID;
-00048   typedef unsigned long THREAD_HANDLE;
-00049   typedef CRITICAL_SECTION MUTEX;
-00050 
-00051 #elif defined(__IRIX_AL__)
-00052   #include <dmedia/audio.h>
-00053   #include <pthread.h>
-00054   #include <unistd.h>
-00055 
-00056   #define THREAD_TYPE
-00057   typedef ALport AUDIO_HANDLE;
-00058   typedef int DEVICE_ID;
-00059   typedef pthread_t THREAD_HANDLE;
-00060   typedef pthread_mutex_t MUTEX;
-00061 
-00062 #endif
-00063 
-00064 
-00065 // *************************************************** //
-00066 //
-00067 // RtError class declaration.
-00068 //
-00069 // *************************************************** //
-00070 
-00071 class RtError
-00072 {
-00073 public:
-00074   enum TYPE {
-00075     WARNING,
-00076     DEBUG_WARNING,
-00077     UNSPECIFIED,
-00078     NO_DEVICES_FOUND,
-00079     INVALID_DEVICE,
-00080     INVALID_STREAM,
-00081     MEMORY_ERROR,
-00082     INVALID_PARAMETER,
-00083     DRIVER_ERROR,
-00084     SYSTEM_ERROR,
-00085     THREAD_ERROR
-00086   };
-00087 
-00088 protected:
-00089   char error_message[256];
-00090   TYPE type;
-00091 
-00092 public:
-00094   RtError(const char *p, TYPE tipe = RtError::UNSPECIFIED);
-00095 
-00097   virtual ~RtError(void);
+RtAudio.h
00001 /************************************************************************/
+00038 /************************************************************************/
+00039 
+00040 #if !defined(__RTAUDIO_H)
+00041 #define __RTAUDIO_H
+00042 
+00043 #include <map>
+00044 
+00045 #if defined(__LINUX_ALSA__)
+00046   #include <alsa/asoundlib.h>
+00047   #include <pthread.h>
+00048   #include <unistd.h>
+00049 
+00050   typedef snd_pcm_t *AUDIO_HANDLE;
+00051   typedef int DEVICE_ID;
+00052   typedef pthread_t THREAD_HANDLE;
+00053   typedef pthread_mutex_t MUTEX;
+00054 
+00055 #elif defined(__LINUX_OSS__)
+00056   #include <pthread.h>
+00057   #include <unistd.h>
+00058 
+00059   typedef int AUDIO_HANDLE;
+00060   typedef int DEVICE_ID;
+00061   typedef pthread_t THREAD_HANDLE;
+00062   typedef pthread_mutex_t MUTEX;
+00063 
+00064 #elif defined(__WINDOWS_DS__)
+00065   #include <windows.h>
+00066   #include <process.h>
+00067 
+00068   // The following struct is used to hold the extra variables
+00069   // specific to the DirectSound implementation.
+00070   typedef struct {
+00071     void * object;
+00072     void * buffer;
+00073     UINT bufferPointer;
+00074   } AUDIO_HANDLE;
+00075 
+00076   typedef LPGUID DEVICE_ID;
+00077   typedef unsigned long THREAD_HANDLE;
+00078   typedef CRITICAL_SECTION MUTEX;
+00079 
+00080 #elif defined(__WINDOWS_ASIO__)
+00081   #include <windows.h>
+00082   #include <process.h>
+00083 
+00084   typedef int AUDIO_HANDLE;
+00085   typedef int DEVICE_ID;
+00086   typedef unsigned long THREAD_HANDLE;
+00087   typedef CRITICAL_SECTION MUTEX;
+00088 
+00089 #elif defined(__IRIX_AL__)
+00090   #include <dmedia/audio.h>
+00091   #include <pthread.h>
+00092   #include <unistd.h>
+00093 
+00094   typedef ALport AUDIO_HANDLE;
+00095   typedef long DEVICE_ID;
+00096   typedef pthread_t THREAD_HANDLE;
+00097   typedef pthread_mutex_t MUTEX;
 00098 
-00100   virtual void printMessage(void);
-00101 
-00103   virtual const TYPE& getType(void) { return type; }
+00099 #elif defined(__MACOSX_CORE__)
+00100 
+00101   #include <CoreServices/CoreServices.h>
+00102   #include <CoreAudio/AudioHardware.h>
+00103   #include <pthread.h>
 00104 
-00106   virtual const char *getMessage(void) { return error_message; }
-00107 };
-00108 
+00105   typedef unsigned int AUDIO_HANDLE;
+00106   typedef AudioDeviceID DEVICE_ID;
+00107   typedef pthread_t THREAD_HANDLE;
+00108   typedef pthread_mutex_t MUTEX;
 00109 
-00110 // *************************************************** //
-00111 //
-00112 // RtAudio class declaration.
-00113 //
-00114 // *************************************************** //
-00115 
-00116 class RtAudio
-00117 {
-00118 public:
-00119 
-00120   // Support for signed integers and floats.  Audio data fed to/from
-00121   // the tickStream() routine is assumed to ALWAYS be in host
-00122   // byte order.  The internal routines will automatically take care of
-00123   // any necessary byte-swapping between the host format and the
-00124   // soundcard.  Thus, endian-ness is not a concern in the following
-00125   // format definitions.
-00126   typedef unsigned long RTAUDIO_FORMAT;
-00127   static const RTAUDIO_FORMAT RTAUDIO_SINT8;
-00128   static const RTAUDIO_FORMAT RTAUDIO_SINT16;
-00129   static const RTAUDIO_FORMAT RTAUDIO_SINT24; 
-00130   static const RTAUDIO_FORMAT RTAUDIO_SINT32;
-00131   static const RTAUDIO_FORMAT RTAUDIO_FLOAT32; 
-00132   static const RTAUDIO_FORMAT RTAUDIO_FLOAT64; 
-00133 
-00134   //static const int MAX_SAMPLE_RATES = 14;
-00135   enum { MAX_SAMPLE_RATES = 14 };
-00136 
-00137   typedef int (*RTAUDIO_CALLBACK)(char *buffer, int bufferSize, void *userData);
-00138 
-00139   typedef struct {
-00140     char name[128];
-00141     DEVICE_ID id[2];  
-00142     bool probed;       
-00143     int maxOutputChannels;
-00144     int maxInputChannels;
-00145     int maxDuplexChannels;
-00146     int minOutputChannels;
-00147     int minInputChannels;
-00148     int minDuplexChannels;
-00149     bool hasDuplexSupport; 
-00150     int nSampleRates;      
-00151     int sampleRates[MAX_SAMPLE_RATES]; 
-00152     RTAUDIO_FORMAT nativeFormats;     
-00153   } RTAUDIO_DEVICE;
-00154 
+00110 #endif
+00111 
+00112 
+00113 /************************************************************************/
+00126 /************************************************************************/
+00127 
+00128 class RtError
+00129 {
+00130 public:
+00132   enum TYPE {
+00133     WARNING,
+00134     DEBUG_WARNING,
+00135     UNSPECIFIED,
+00136     NO_DEVICES_FOUND,
+00137     INVALID_DEVICE,
+00138     INVALID_STREAM,
+00139     MEMORY_ERROR,
+00140     INVALID_PARAMETER,
+00141     DRIVER_ERROR,
+00142     SYSTEM_ERROR,
+00143     THREAD_ERROR
+00144   };
+00145 
+00146 protected:
+00147   char error_message[256];
+00148   TYPE type;
+00149 
+00150 public:
+00152   RtError(const char *p, TYPE tipe = RtError::UNSPECIFIED);
+00153 
+00155   virtual ~RtError(void);
 00156 
-00163   RtAudio();
-00164 
+00158   virtual void printMessage(void);
+00159 
+00161   virtual const TYPE& getType(void) { return type; }
+00162 
+00164   virtual const char *getMessage(void) { return error_message; }
+00165 };
 00166 
-00177   RtAudio(int *streamId,
-00178           int outputDevice, int outputChannels,
-00179           int inputDevice, int inputChannels,
-00180           RTAUDIO_FORMAT format, int sampleRate,
-00181           int *bufferSize, int numberOfBuffers);
-00182 
+00167 
+00168 // This public structure type is used to pass callback information
+00169 // between the private RtAudio stream structure and global callback
+00170 // handling functions.
+00171 typedef struct {
+00172   void *object;  // Used as a "this" pointer.
+00173   int streamId;
+00174   DEVICE_ID device[2];
+00175   THREAD_HANDLE thread;
+00176   void *callback;
+00177   void *buffers;
+00178   unsigned long waitTime;
+00179   bool blockTick;
+00180   bool stopStream;
+00181   bool usingCallback;
+00182   void *userData;
+00183 } CALLBACK_INFO;
 00184 
-00188   ~RtAudio();
-00189 
+00185 
+00186 // *************************************************** //
+00187 //
+00188 // RtAudio class declaration.
+00189 //
+00190 // *************************************************** //
 00191 
-00218   int openStream(int outputDevice, int outputChannels,
-00219                  int inputDevice, int inputChannels,
-00220                  RTAUDIO_FORMAT format, int sampleRate,
-00221                  int *bufferSize, int numberOfBuffers);
-00222 
-00224 
-00243   void setStreamCallback(int streamId, RTAUDIO_CALLBACK callback, void *userData);
-00244 
-00246 
-00253   void cancelStreamCallback(int streamId);
-00254 
-00256   int getDeviceCount(void);
-00257 
+00192 class RtAudio
+00193 {
+00194 public:
+00195 
+00196   // Support for signed integers and floats.  Audio data fed to/from
+00197   // the tickStream() routine is assumed to ALWAYS be in host
+00198   // byte order.  The internal routines will automatically take care of
+00199   // any necessary byte-swapping between the host format and the
+00200   // soundcard.  Thus, endian-ness is not a concern in the following
+00201   // format definitions.
+00202   typedef unsigned long RTAUDIO_FORMAT;
+00203   static const RTAUDIO_FORMAT RTAUDIO_SINT8; 
+00204   static const RTAUDIO_FORMAT RTAUDIO_SINT16; 
+00205   static const RTAUDIO_FORMAT RTAUDIO_SINT24; 
+00206   static const RTAUDIO_FORMAT RTAUDIO_SINT32; 
+00207   static const RTAUDIO_FORMAT RTAUDIO_FLOAT32; 
+00208   static const RTAUDIO_FORMAT RTAUDIO_FLOAT64; 
+00210   //static const int MAX_SAMPLE_RATES = 14;
+00211   enum { MAX_SAMPLE_RATES = 14 };
+00212 
+00213   typedef int (*RTAUDIO_CALLBACK)(char *buffer, int bufferSize, void *userData);
+00214 
+00216   typedef struct {
+00217     char name[128];    
+00218     DEVICE_ID id[2];  /* No value reported by getDeviceInfo(). */
+00219     bool probed;       
+00220     int maxOutputChannels; 
+00221     int maxInputChannels;  
+00222     int maxDuplexChannels; 
+00223     int minOutputChannels; 
+00224     int minInputChannels;  
+00225     int minDuplexChannels; 
+00226     bool hasDuplexSupport; 
+00227     bool isDefault;        
+00228     int nSampleRates;      
+00229     int sampleRates[MAX_SAMPLE_RATES]; 
+00230     RTAUDIO_FORMAT nativeFormats;     
+00231   } RTAUDIO_DEVICE;
+00232 
+00234 
+00240   RtAudio();
+00241 
+00243 
+00254   RtAudio(int *streamId,
+00255           int outputDevice, int outputChannels,
+00256           int inputDevice, int inputChannels,
+00257           RTAUDIO_FORMAT format, int sampleRate,
+00258           int *bufferSize, int numberOfBuffers);
 00259 
-00269   void getDeviceInfo(int device, RTAUDIO_DEVICE *info);
-00270 
-00272 
-00277   char * const getStreamBuffer(int streamId);
-00278 
-00280 
-00285   void tickStream(int streamId);
-00286 
-00288 
-00292   void closeStream(int streamId);
-00293 
-00295 
-00299   void startStream(int streamId);
-00300 
-00302 
-00306   void stopStream(int streamId);
-00307 
-00309 
-00313   void abortStream(int streamId);
-00314 
-00316 
-00321   int streamWillBlock(int streamId);
-00322 
-00323 protected:
-00324 
-00325 private:
-00326 
-00327   static const unsigned int SAMPLE_RATES[MAX_SAMPLE_RATES];
-00328 
-00329   enum { FAILURE, SUCCESS };
-00330 
-00331   enum STREAM_MODE {
-00332     PLAYBACK,
-00333     RECORD,
-00334     DUPLEX,
-00335     UNINITIALIZED = -75
-00336   };
-00337 
-00338   enum STREAM_STATE {
-00339     STREAM_STOPPED,
-00340     STREAM_RUNNING
-00341   };
-00342 
-00343   typedef struct {
-00344     int device[2];          // Playback and record, respectively.
-00345     STREAM_MODE mode;       // PLAYBACK, RECORD, or DUPLEX.
-00346     AUDIO_HANDLE handle[2]; // Playback and record handles, respectively.
-00347     STREAM_STATE state;     // STOPPED or RUNNING
-00348     char *userBuffer;
-00349     char *deviceBuffer;
-00350     bool doConvertBuffer[2]; // Playback and record, respectively.
-00351     bool deInterleave[2];    // Playback and record, respectively.
-00352     bool doByteSwap[2];      // Playback and record, respectively.
-00353     int sampleRate;
-00354     int bufferSize;
-00355     int nBuffers;
-00356     int nUserChannels[2];    // Playback and record, respectively.
-00357     int nDeviceChannels[2];  // Playback and record channels, respectively.
-00358     RTAUDIO_FORMAT userFormat;
-00359     RTAUDIO_FORMAT deviceFormat[2]; // Playback and record, respectively.
-00360     bool usingCallback;
-00361     THREAD_HANDLE thread;
-00362     MUTEX mutex;
-00363     RTAUDIO_CALLBACK callback;
-00364     void *userData;
-00365   } RTAUDIO_STREAM;
-00366 
-00367   typedef signed short INT16;
-00368   typedef signed int INT32;
-00369   typedef float FLOAT32;
-00370   typedef double FLOAT64;
-00371 
-00372   char message[256];
-00373   int nDevices;
-00374   RTAUDIO_DEVICE *devices;
+00261 
+00265   ~RtAudio();
+00266 
+00268 
+00295   int openStream(int outputDevice, int outputChannels,
+00296                  int inputDevice, int inputChannels,
+00297                  RTAUDIO_FORMAT format, int sampleRate,
+00298                  int *bufferSize, int numberOfBuffers);
+00299 
+00301 
+00320   void setStreamCallback(int streamId, RTAUDIO_CALLBACK callback, void *userData);
+00321 
+00323 
+00330   void cancelStreamCallback(int streamId);
+00331 
+00333   int getDeviceCount(void);
+00334 
+00336 
+00344   void getDeviceInfo(int device, RTAUDIO_DEVICE *info);
+00345 
+00347 
+00352   char * const getStreamBuffer(int streamId);
+00353 
+00355 
+00360   void tickStream(int streamId);
+00361 
+00363 
+00367   void closeStream(int streamId);
+00368 
+00370 
+00374   void startStream(int streamId);
 00375 
-00376   std::map<int, void *> streams;
 00377 
-00379   void error(RtError::TYPE type);
-00380 
-00385   void initialize(void);
-00386 
-00388   void clearDeviceInfo(RTAUDIO_DEVICE *info);
+00381   void stopStream(int streamId);
+00382 
+00384 
+00388   void abortStream(int streamId);
 00389 
-00397   void probeDeviceInfo(RTAUDIO_DEVICE *info);
-00398 
-00405   bool probeDeviceOpen(int device, RTAUDIO_STREAM *stream,
-00406                        STREAM_MODE mode, int channels, 
-00407                        int sampleRate, RTAUDIO_FORMAT format,
-00408                        int *bufferSize, int numberOfBuffers);
+00391 
+00396   int streamWillBlock(int streamId);
+00397 
+00398 #if (defined(__MACOSX_CORE__) || defined(__WINDOWS_ASIO__))
+00399   // This function is intended for internal use only.  It must be
+00400   // public because it is called by the internal callback handler,
+00401   // which is not a member of RtAudio.  External use of this function
+00402   // will most likely produce highly undesireable results!
+00403   void callbackEvent(int streamId, DEVICE_ID deviceId, void *inData, void *outData);
+00404 #endif
+00405 
+00406 protected:
+00407 
+00408 private:
 00409 
-00416   void *verifyStream(int streamId);
-00417 
-00422   void convertStreamBuffer(RTAUDIO_STREAM *stream, STREAM_MODE mode);
-00423 
-00425   void byteSwapBuffer(char *buffer, int samples, RTAUDIO_FORMAT format);
-00426 
-00428   int formatBytes(RTAUDIO_FORMAT format);
-00429 };
-00430 
-00431 // Uncomment the following definition to have extra information spewed to stderr.
-00432 //#define RTAUDIO_DEBUG
-00433 
-00434 #endif
-

-
-
-  ©2001-2002 CCRMA, Stanford University. All Rights Reserved.

-  Maintained by Gary P. Scavone, gary@ccrma.stanford.edu
-
-
-
+00410   static const unsigned int SAMPLE_RATES[MAX_SAMPLE_RATES];
+00411 
+00412   enum { FAILURE, SUCCESS };
+00413 
+00414   enum STREAM_MODE {
+00415     OUTPUT,
+00416     INPUT,
+00417     DUPLEX,
+00418     UNINITIALIZED = -75
+00419   };
+00420 
+00421   enum STREAM_STATE {
+00422     STREAM_STOPPED,
+00423     STREAM_RUNNING
+00424   };
+00425 
+00426   typedef struct {
+00427     int device[2];          // Playback and record, respectively.
+00428     STREAM_MODE mode;       // OUTPUT, INPUT, or DUPLEX.
+00429     AUDIO_HANDLE handle[2]; // Playback and record handles, respectively.
+00430     STREAM_STATE state;     // STOPPED or RUNNING
+00431     char *userBuffer;
+00432     char *deviceBuffer;
+00433     bool doConvertBuffer[2]; // Playback and record, respectively.
+00434     bool deInterleave[2];    // Playback and record, respectively.
+00435     bool doByteSwap[2];      // Playback and record, respectively.
+00436     int sampleRate;
+00437     int bufferSize;
+00438     int nBuffers;
+00439     int nUserChannels[2];    // Playback and record, respectively.
+00440     int nDeviceChannels[2];  // Playback and record channels, respectively.
+00441     RTAUDIO_FORMAT userFormat;
+00442     RTAUDIO_FORMAT deviceFormat[2]; // Playback and record, respectively.
+00443     MUTEX mutex;
+00444     CALLBACK_INFO callbackInfo;
+00445   } RTAUDIO_STREAM;
+00446 
+00447   typedef signed short INT16;
+00448   typedef signed int INT32;
+00449   typedef float FLOAT32;
+00450   typedef double FLOAT64;
+00451 
+00452   char message[256];
+00453   int nDevices;
+00454   RTAUDIO_DEVICE *devices;
+00455 
+00456   std::map<int, void *> streams;
+00457 
+00459   void error(RtError::TYPE type);
+00460 
+00465   void initialize(void);
+00466 
+00471   int getDefaultInputDevice(void);
+00472 
+00477   int getDefaultOutputDevice(void);
+00478 
+00480   void clearDeviceInfo(RTAUDIO_DEVICE *info);
+00481 
+00489   void probeDeviceInfo(RTAUDIO_DEVICE *info);
+00490 
+00497   bool probeDeviceOpen(int device, RTAUDIO_STREAM *stream,
+00498                        STREAM_MODE mode, int channels, 
+00499                        int sampleRate, RTAUDIO_FORMAT format,
+00500                        int *bufferSize, int numberOfBuffers);
+00501 
+00508   void *verifyStream(int streamId);
+00509 
+00514   void convertStreamBuffer(RTAUDIO_STREAM *stream, STREAM_MODE mode);
+00515 
+00517   void byteSwapBuffer(char *buffer, int samples, RTAUDIO_FORMAT format);
+00518 
+00520   int formatBytes(RTAUDIO_FORMAT format);
+00521 };
+00522 
+00523 // Define the following flag to have extra information spewed to stderr.
+00524 //#define __RTAUDIO_DEBUG__
+00525 
+00526 #endif
+

-RtAudio incorporates the concept of audio streams, which represent audio output (playback) and/or input (recording). Available audio devices and their capabilities can be enumerated and then specified when opening a stream. Multiple streams can run at the same time and, when allowed by the underlying audio API, a single device can serve multiple streams. +RtAudio incorporates the concept of audio streams, which represent audio output (playback) and/or input (recording). Available audio devices and their capabilities can be enumerated and then specified when opening a stream. When allowed by the underlying audio API, multiple streams can run at the same time and a single device can serve multiple streams. See the OS Notes section for information specific to each of the supported audio APIs.

The RtAudio API provides both blocking (synchronous) and callback (asyncronous) functionality. Callbacks are typically used in conjunction with graphical user interfaces (GUI). Blocking functionality is often necessary for explicit control of multiple input/output stream synchronization or when audio must be synchronized with other system events.

Download

Getting Started

The first thing that must be done when using RtAudio is to create an instance of the class. The default constructor RtAudio::RtAudio() scans the underlying audio system to verify that at least one device is available. RtAudio often uses C++ exceptions to report errors, necessitating try/catch blocks around most member functions. The following code example demonstrates default object construction and destruction:

#include "RtAudio.h"
+#include "RtAudio.h"
 
 int main()
 {
@@ -65,7 +70,7 @@ A programmer may wish to query the available audio device capabilities before de
 // probe.cpp
 
 #include <iostream>
-#include "RtAudio.h"
+#include "RtAudio.h"
 
 int main()
 {
@@ -85,7 +90,7 @@ A programmer may wish to query the available audio device capabilities before de
 
   // Scan through devices for various capabilities
   RtAudio::RTAUDIO_DEVICE info;
-  for (int i=0; i<devices; i++) {
+  for (int i=1; i<=devices; i++) {
 
     try {
       audio->getDeviceInfo(i, &info);
@@ -106,11 +111,10 @@ A programmer may wish to query the available audio device capabilities before de
   return 0;
 }
 
-The RTAUDIO_DEVICE structure is defined in RtAudio.h and provides a variety of information useful in assessing the capabilities of a device:
+The RTAUDIO_DEVICE structure is defined in RtAudio.h and provides a variety of information useful in assessing the capabilities of a device:
 

 
  typedef struct {
     char name[128];
-    DEVICE_ID id[2];                      // No value reported by getDeviceInfo().
     bool probed;                          // true if the device probe was successful.
     int maxOutputChannels;
     int maxInputChannels;
@@ -118,7 +122,8 @@ The RTAUDIO_DEVICE structure is defined in 
     int minOutputChannels;
     int minInputChannels;
     int minDuplexChannels;
-    bool hasDuplexSupport;                // true if duplex supported
+    bool hasDuplexSupport;                // true if duplex mode is supported.
+    bool isDefault;                       // true if this is the default output or input device.
     int nSampleRates;                     // Number of discrete rates, or -1 if range supported.
     double sampleRates[MAX_SAMPLE_RATES]; // Supported sample rates, or {min, max} if range.
     RTAUDIO_FORMAT nativeFormats;
@@ -129,23 +134,23 @@ The following data formats are defined and fully supported by   typedef unsigned long RTAUDIO_FORMAT;
   static const RTAUDIO_FORMAT  RTAUDIO_SINT8;   // Signed 8-bit integer
   static const RTAUDIO_FORMAT  RTAUDIO_SINT16;  // Signed 16-bit integer
-  static const RTAUDIO_FORMAT  RTAUDIO_SINT24;  // Signed 24-bit integer
+  static const RTAUDIO_FORMAT  RTAUDIO_SINT24;  // Signed 24-bit integer (upper 3 bytes of 32-bit signed integer.)
   static const RTAUDIO_FORMAT  RTAUDIO_SINT32;  // Signed 32-bit integer
-  static const RTAUDIO_FORMAT  RTAUDIO_FLOAT32; // 32-bit float
-  static const RTAUDIO_FORMAT  RTAUDIO_FLOAT64; // 64-bit double

+  static const RTAUDIO_FORMAT  RTAUDIO_FLOAT32; // 32-bit float normalized between +/- 1.0
+  static const RTAUDIO_FORMAT  RTAUDIO_FLOAT64; // 64-bit double normalized between +/- 1.0

 
-The nativeFormats member of the RtAudio::RTAUDIO_DEVICE structure is a bit mask of the above formats which are natively supported by the device. However, RtAudio will automatically provide format conversion if a particular format is not natively supported. When the probed member of the RTAUDIO_DEVICE structure is false, the remaining structure members are likely unknown and the device is probably unuseable.
+The nativeFormats member of the RtAudio::RTAUDIO_DEVICE structure is a bit mask of the above formats which are natively supported by the device. However, RtAudio will automatically provide format conversion if a particular format is not natively supported. When the probed member of the RTAUDIO_DEVICE structure is false, the remaining structure members are undefined and the device is probably unuseable.
 

 In general, the user need not be concerned with the minimum channel values reported in the RTAUDIO_DEVICE structure. While some audio devices may require a minimum channel value > 1, RtAudio will provide automatic channel number compensation when the number of channels set by the user is less than that required by the device. Channel compensation is NOT possible when the number of channels set by the user is greater than that supported by the device.
 

-It should be noted that the capabilities reported by a device driver or underlying audio API are not always accurate and/or may be dependent on a combination of device settings.
+It should be noted that the capabilities reported by a device driver or underlying audio API are not always accurate and/or may be dependent on a combination of device settings. For this reason, RtAudio does not rely on the reported values when attempting to open a stream.
 

 
Device Settings
 
 
-The next step in using RtAudio is to open a stream with a particular set of device settings.
+The next step in using RtAudio is to open a stream with particular device and parameter settings.
 

-
#include "RtAudio.h"
+#include "RtAudio.h"
 
 int main()
 {
@@ -174,11 +179,11 @@ The next step in using RtAudio is to
   return 0;
 }
 
-The RtAudio::openStream() method attempts to open a stream with a specified set of parameter values. When successful, a stream identifier is returned. In this case, we attempt to open a playback stream on device 0 with two channels, 32-bit floating point data, a sample rate of 44100 Hz, a frame rate of 256 sample frames per read/write, and 4 internal device buffers. When device = 0, RtAudio first attempts to open the default audio device with the given parameters. If that attempt fails, an attempt is made to find a device or set of devices which will meet the given parameters. If all attempts are unsuccessful, an RtError is thrown. When a non-zero device value is specified, an attempt is made to open that device only.
+The RtAudio::openStream() method attempts to open a stream with a specified set of parameter values. When successful, a stream identifier is returned. In this case, we attempt to open a two channel playback stream with the default output device, 32-bit floating point data, a sample rate of 44100 Hz, a frame rate of 256 sample frames per read/write, and 4 internal device buffers. When device = 0, RtAudio first attempts to open the default audio device with the given parameters. If that attempt fails, RtAudio searches through the remaining available devices in an effort to find a device which will meet the given parameters. If all attempts are unsuccessful, an RtError is thrown. When a non-zero device value is specified, an attempt is made to open that device only (device = 1 specifies the first identified device, as reported by RtAudio::getDeviceInfo()).
 

-RtAudio provides four signed integer and two floating point data formats which can be specified using the RtAudio::RTAUDIO_FORMAT parameter values mentioned earlier. If the opened device does not natively support the given format, RtAudio will automatically perform the necessary data format conversion.
+RtAudio provides four signed integer and two floating point data formats which can be specified using the RtAudio::RTAUDIO_FORMAT parameter values mentioned earlier. If the opened device does not natively support the given format, RtAudio will automatically perform the necessary data format conversion.
 

-The bufferSize parameter specifies the desired number of sample frames which will be written to and/or read from a device per write/read operation. The nBuffers parameter is used in setting the underlying device buffer parameters. Both the bufferSize and nBuffers parameters can be used to control stream latency though there is no guarantee that the passed values will be those used by a device. In general, lower values for both parameters will produce less latency but perhaps less robust performance. Both parameters can be specified with values of zero, in which case the smallest allowable values will be used. The bufferSize parameter is passed as a pointer and the actual value used by the stream is set during the device setup procedure. bufferSize values should be a power of two. Optimal and allowable buffer values tend to vary between systems and devices. Check the OS Notes section for general guidelines.
+The bufferSize parameter specifies the desired number of sample frames which will be written to and/or read from a device per write/read operation. The nBuffers parameter is used in setting the underlying device buffer parameters. Both the bufferSize and nBuffers parameters can be used to control stream latency though there is no guarantee that the passed values will be those used by a device (the nBuffers parameter is ignored when using the OS X CoreAudio and the Windows ASIO APIs). In general, lower values for both parameters will produce less latency but perhaps less robust performance. Both parameters can be specified with values of zero, in which case the smallest allowable values will be used. The bufferSize parameter is passed as a pointer and the actual value used by the stream is set during the device setup procedure. bufferSize values should be a power of two. Optimal and allowable buffer values tend to vary between systems and devices. Check the OS Notes section for general guidelines.
 

 As noted earlier, the device capabilities reported by a driver or underlying audio API are not always accurate and/or may be dependent on a combination of device settings. Because of this, RtAudio does not attempt to query a device's capabilities or use previously reported values when opening a device. Instead, RtAudio simply attempts to set the given parameters on a specified device and then checks whether the setup is successful or not.
 

@@ -189,7 +194,7 @@ Once the device is open for playback, there are only a few final steps necessary
 

 
// playback.cpp
 
-#include "RtAudio.h"
+#include "RtAudio.h"
 
 int main()
 {
@@ -260,7 +265,7 @@ Once the device is open for playback, there are only a few final steps necessary
 
 The first thing to notice in this example is that we attempt to open a stream during class instantiation with an overloaded constructor. This constructor simply combines the functionality of the default constructor, used earlier, and the RtAudio::openStream() method. Again, we have specified a device value of 0, indicating that the default or first available device meeting the given parameters should be used. The integer identifier of the opened stream is returned via the stream pointer value. An attempt is made to open the stream with the specified bufferSize value. However, it is possible that the device will not accept this value, in which case the closest allowable size is used and returned via the pointer value. The constructor can fail if no available devices are found, or a memory allocation or device driver error occurs. Note that you should not call the RtAudio destructor if an exception is thrown during instantiation.
 

-Because RtAudio can be used to simultaneously control more than a single stream, it is necessary that the stream identifier be provided to nearly all public methods. Assuming the constructor is successful, it is necessary to get a pointer to the buffer, provided by RtAudio, for use in feeding data to/from the opened stream. Note that the user should NOT attempt to deallocate the stream buffer memory ... memory management for the stream buffer will be automatically controlled by RtAudio. After starting the stream with RtAudio::startStream(), one simply fills that buffer, which is of length equal to the returned bufferSize value, with interleaved audio data (in the specified format) for playback. Finally, a call to the RtAudio::tickStream() routine triggers a blocking write call for the stream.
+Because RtAudio can typically be used to simultaneously control more than a single stream, it is necessary that the stream identifier be provided to nearly all public methods. Assuming the constructor is successful, it is necessary to get a pointer to the buffer, provided by RtAudio, for use in feeding data to/from the opened stream. Note that the user should NOT attempt to deallocate the stream buffer memory ... memory management for the stream buffer will be automatically controlled by RtAudio. After starting the stream with RtAudio::startStream(), one simply fills that buffer, which is of length equal to the returned bufferSize value, with interleaved audio data (in the specified format) for playback. Finally, a call to the RtAudio::tickStream() routine triggers a blocking write call for the stream.
 

 In general, one should call the RtAudio::stopStream() and RtAudio::closeStream() methods after finishing with a stream. However, both methods will implicitly be called during object destruction if necessary.
 

@@ -270,7 +275,7 @@ In general, one should call the RtAud
 The primary difference in using RtAudio with callback functionality involves the creation of a user-defined callback function. Here is an example which produces a sawtooth waveform for playback.
 

 
#include <iostream>
-#include "RtAudio.h"
+#include "RtAudio.h"
 
 // Two-channel sawtooth wave generator.
 int sawtooth(char *buffer, int buffer_size, void *data)
@@ -344,11 +349,11 @@ The primary difference in using RtAudioreturn 0;
 }

 
-After opening the device in exactly the same way as the previous example (except with a data format change), we must set our callback function for the stream using RtAudio::setStreamCallback(). This method will spawn a new process (or thread) which automatically calls the callback function when more data is needed. Note that the callback function is called only when the stream is "running" (between calls to the RtAudio::startStream() and RtAudio::stopStream() methods). The last argument to RtAudio::setStreamCallback() is a pointer to arbitrary data that you wish to access from within your callback function.
+After opening the device in exactly the same way as the previous example (except with a data format change), we must set our callback function for the stream using RtAudio::setStreamCallback(). When the underlying audio API uses blocking calls (OSS, ALSA, SGI, and Windows DirectSound), this method will spawn a new process (or thread) which automatically calls the callback function when more data is needed. Callback-based audio APIs (OS X CoreAudio and ASIO) implement their own event notification schemes. Note that the callback function is called only when the stream is "running" (between calls to the RtAudio::startStream() and RtAudio::stopStream() methods). The last argument to RtAudio::setStreamCallback() is a pointer to arbitrary data that you wish to access from within your callback function.
 

 In this example, we stop the stream with an explicit call to RtAudio::stopStream(). When using callback functionality, it is also possible to stop a stream by returning a non-zero value from the callback function.
 

-Once set with RtAudio::setStreamCallback, the callback process will continue to run for the life of the stream (until the stream is closed with RtAudio::closeStream() or the RtAudio instance is deleted). It is possible to disassociate a callback function and cancel its process for an open stream using the RtAudio::cancelStreamCallback() method. The stream can then be used with blocking functionality or a new callback can be associated with it.
+Once set with RtAudio::setStreamCallback, the callback process exists for the life of the stream (until the stream is closed with RtAudio::closeStream() or the RtAudio instance is deleted). It is possible to disassociate a callback function and cancel its process for an open stream using the RtAudio::cancelStreamCallback() method. The stream can then be used with blocking functionality or a new callback can be associated with it.
 

 
Recording
 
@@ -357,7 +362,7 @@ Using RtAudio for audio input is almo
 
 
// record.cpp
 
-#include "RtAudio.h"
+#include "RtAudio.h"
 
 int main()
 {
@@ -436,7 +441,7 @@ Finally, it is easy to use RtAudio fo
 // duplex.cpp
 
 #include <iostream>
-#include "RtAudio.h"
+#include "RtAudio.h"
 
 // Pass-through function.
 int pass(char *buffer, int buffer_size, void *)
@@ -501,7 +506,7 @@ When an RtAudio stream is running in
 
 As we see with this example, the write-read sequence of operations does not preclude the use of RtAudio in situations where input data is first processed and then output through a duplex stream. When the stream buffer is first allocated, it is initialized with zeros, which produces no audible result when output to the device. In this example, anything recorded by the audio stream input will be played out during the next round of audio processing.
 

-Note that duplex operation can also be achieved by opening one output stream and one input stream using the same or different devices. However, there may be timing problems when attempting to use two different devices, due to possible device clock variations. This becomes even more difficult to achieve using two separate callback streams because it is not possible to explicitly control the calling order of the callback functions.
+Note that duplex operation can also be achieved by opening one output stream and one input stream using the same or different devices. However, there may be timing problems when attempting to use two different devices, due to possible device clock variations, unless a common external "sync" is provided. This becomes even more difficult to achieve using two separate callback streams because it is not possible to explicitly control the calling order of the callback functions.
 

 
Summary of Methods
 
@@ -519,21 +524,28 @@ In order to compile RtAudio for a spe
 
 
 

-  
-
-
-
-OS: Audio API: Preprocessor Definition: Library: Example Compiler Statement:   
Linux ALSA __LINUX_ALSA__ libasound, libpthread g++ -Wall -D__LINUX_ALSA__ -o probe probe.cpp RtAudio.cpp -lasound -lpthread   
Linux OSS __LINUX_OSS__ libpthread g++ -Wall -D__LINUX_OSS__ -o probe probe.cpp RtAudio.cpp -lpthread   
Irix AL __IRIX_AL__ libaudio, libpthread CC -Wall -D__IRIX_AL__ -o probe probe.cpp RtAudio.cpp -laudio -lpthread   
Windows Direct Sound __WINDOWS_DS__ dsound.lib (ver. 5.0 or higher), multithreaded compiler specific  
+  
+
+
+
+
+
+OS: Audio API: Preprocessor Definition: Library or Framework: Example Compiler Statement:   
Linux ALSA __LINUX_ALSA__ asound, pthread g++ -Wall -D__LINUX_ALSA__ -o probe probe.cpp RtAudio.cpp -lasound -lpthread   
Linux OSS __LINUX_OSS__ pthread g++ -Wall -D__LINUX_OSS__ -o probe probe.cpp RtAudio.cpp -lpthread   
Macintosh OS X CoreAudio __MACOSX_CORE__ pthread, stdc++, CoreAudio cc -Wall -D__MACOSX_CORE__ -o probe probe.cpp RtAudio.cpp -framework CoreAudio -lstdc++ -lpthread   
Irix AL __IRIX_AL__ audio, pthread CC -Wall -D__IRIX_AL__ -o probe probe.cpp RtAudio.cpp -laudio -lpthread   
Windows Direct Sound __WINDOWS_DS__ dsound.lib (ver. 5.0 or higher), multithreaded compiler specific   
Windows ASIO __WINDOWS_ASIO__ various ASIO header and source files compiler specific  
  
 

 
 

-The example compiler statements above could be used to compile the probe.cpp example file, assuming that probe.cpp, RtAudio.h, and RtAudio.cpp all exist in the same directory.
+The example compiler statements above could be used to compile the probe.cpp example file, assuming that probe.cpp, RtAudio.h, and RtAudio.cpp all exist in the same directory.
+

+
Debugging
+
+
+If you are having problems getting RtAudio to run on your system, try passing the preprocessor definition __RTAUDIO_DEBUG__ to the compiler (or uncomment the definition at the bottom of RtAudio.h). A variety of warning messages will be displayed which may help in determining the problem.
 

 
OS Notes
 
 
-RtAudio is designed to provide a common API across the various supported operating systems and audio libraries. Despite that, however, some issues need to be mentioned with regard to each.
+RtAudio is designed to provide a common API across the various supported operating systems and audio libraries. Despite that, some issues need to be mentioned with regard to each.
 

 
Linux:
 
@@ -542,31 +554,57 @@ The example compiler statements above could be used to compile the probe.c
 
 The ALSA library includes OSS emulation support. That means that you can run programs compiled for the OSS API even when using the ALSA drivers and library. It should be noted however that OSS emulation under ALSA is not perfect. Specifically, channel number queries seem to consistently produce invalid results. While OSS emulation is successful for the majority of RtAudio tests, it is recommended that the native ALSA implementation of RtAudio be used on systems which have ALSA drivers installed.
 

-The ALSA implementation of RtAudio makes no use of the ALSA "plug" interface. All necessary data format conversions, channel compensation, deinterleaving, and byte-swapping is handled by internal RtAudio routines.
+The ALSA implementation of RtAudio makes no use of the ALSA "plug" interface. All necessary data format conversions, channel compensation, de-interleaving, and byte-swapping is handled by internal RtAudio routines.
+

+
Macintosh OS X (CoreAudio):
+
+
+The Apple CoreAudio API is based on a callback scheme. RtAudio provides blocking functionality, in addition to callback functionality, within the context of that behavior. CoreAudio is designed to use a separate callback procedure for each of its audio devices. A single RtAudio duplex stream using two different devices is supported, though it cannot be guaranteed to always behave correctly because we cannot synchronize these two callbacks. This same functionality can be achieved with better synchrony by opening two separate streams for the devices and using RtAudio blocking calls (i.e. RtAudio::tickStream()). The numberOfBuffers parameter to the RtAudio::openStream() function has no affect in this implementation. It is not currently possible to have multiple simultaneous RtAudio streams accessing the same device.
 

 
Irix (SGI):
 
 
 The Irix version of RtAudio was written and tested on an SGI Indy running Irix version 6.5.4 and the newer "al" audio library. RtAudio does not compile under Irix version 6.3, mainly because the C++ compiler is too old. Despite the relatively slow speed of the Indy, RtAudio was found to behave quite well and input/output latency was very good. No problems were found with respect to using the pthread library.
 

-
Windows:
+Windows (DirectSound):
+
+
+In order to compile RtAudio under Windows for the DirectSound API, you must have the header and source files for DirectSound version 5.0 or higher. As far as I know, there is no DirectSoundCapture support for Windows NT. Audio output latency with DirectSound can be reasonably good (on the order of 20 milliseconds). On the other hand, input audio latency tends to be terrible (100 milliseconds or more). Further, DirectSound drivers tend to crash easily when experimenting with buffer parameters. On my system, I found it necessary to use values around nBuffers = 8 and bufferSize = 512 to avoid crashes. RtAudio was developed with Visual C++ version 6.0. I was forced in several instances to modify code in order to get it to compile under the non-standard version of C++ that Microsoft so unprofessionally implemented. Unfortunately, it appears they are continuing to undermine the C++ standard with more recent compiler releases.
+

+
Windows (ASIO):
 
 
-RtAudio under Windows is written using the DirectSound API. In order to compile RtAudio under Windows, you must have the header and source files for DirectSound version 5.0 or higher. As far as I know, there is no DirectSoundCapture support for Windows NT (in which case, you cannot use RtAudio). Audio output latency with DirectSound can be reasonably good (on the order of 20 milliseconds). On the other hand, input audio latency tends to be terrible (100 milliseconds or more). Further, DirectSound drivers tend to crash easily when experimenting with buffer parameters. On my system, I found it necessary to use values around nBuffers = 8 and bufferSize = 512 to avoid crashing my system. RtAudio was developed with Visual C++ version 6.0. I was forced in several instances to modify code in order to get it to compile under the non-standard version of C++ that Microsoft so unprofessionally implemented. We can only hope that the developers of Visual C++ 7.0 will have time to read the C++ standard.
+The Steinberg ASIO audio API is based on a callback scheme. In addition, the API allows only a single device driver to be loaded and accessed at a time. Therefore, it is not possible to have multiple simultaneous RtAudio streams running concurrently with this API. ASIO device drivers must be supplied by audio hardware manufacturers, though ASIO emulation is possible on top of systems with DirectSound drivers. The numberOfBuffers parameter to the RtAudio::openStream() function has no affect in this implementation.
+

+A number of ASIO source and header files are required for use with RtAudio. Specifically, an RtAudio project must include the following files: asio.h,cpp; asiodrivers.h,cpp; asiolist.h,cpp; asiodrvr.h; asiosys.h; ginclude.h; iasiodrv.h. See the /tests/asio/ directory for example Visual C++ 6.0 projects.
 

 
Acknowledgements
 
 
 The RtAudio API incorporates many of the concepts developed in the PortAudio project by Phil Burk and Ross Bencina. Early development also incorporated ideas from Bill Schottstaedt's sndlib. The CCRMA SoundWire group provided valuable feedback during the API proposal stages.
 

-RtAudio was slowly developed over the course of many months while in residence at the Institut Universitari de L'Audiovisual (IUA) in Barcelona, Spain, the Laboratory of Acoustics and Audio Signal Processing at the Helsinki University of Technology, Finland, and the Center for Computer Research in Music and Acoustics (CCRMA) at Stanford University. This work was supported in part by the United States Air Force Office of Scientific Research (grant #F49620-99-1-0293).
+RtAudio, version 2.0, was slowly developed over the course of many months while in residence at the Institut Universitari de L'Audiovisual (IUA) in Barcelona, Spain, the Laboratory of Acoustics and Audio Signal Processing at the Helsinki University of Technology, Finland, and the Center for Computer Research in Music and Acoustics (CCRMA) at Stanford University. This work was supported in part by the United States Air Force Office of Scientific Research (grant #F49620-99-1-0293).
+

+
License
+
+
+RtAudio: a realtime audio i/o C++ class

+ Copyright (c) 2001-2002 Gary P. Scavone
+

+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+

+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
 

-

-
-
-  ©2001-2002 CCRMA, Stanford University. All Rights Reserved.

-  Maintained by Gary P. Scavone, gary@ccrma.stanford.edu
-
-
-
+Any person wishing to distribute modifications to the Software is requested to send the modifications to the original developer so that they can be incorporated into the canonical version.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+

+

+
+
+  ©2001-2002 Gary P. Scavone, CCRMA, Stanford University. All Rights Reserved.

+  Maintained by Gary P. Scavone, gary@ccrma.stanford.edu
+
+
+
 
diff --git a/doc/html/structRtAudio_1_1RTAUDIO__DEVICE-members.html b/doc/html/structRtAudio_1_1RTAUDIO__DEVICE-members.html
index 5182b05..21141e9 100644
--- a/doc/html/structRtAudio_1_1RTAUDIO__DEVICE-members.html
+++ b/doc/html/structRtAudio_1_1RTAUDIO__DEVICE-members.html
@@ -1,16 +1,16 @@
-
-
-The RtAudio Tutorial
-
-
-
-
-Tutorial   Class/Enum List   File List   Compound Members   
+
+
+The RtAudio Tutorial
+
+
+
+
+Tutorial   Class/Enum List   File List   Compound Members   
 
 
 RtAudio::RTAUDIO_DEVICE Member List
This is the complete list of members for RtAudio::RTAUDIO_DEVICE, including all inherited members.
 hasDuplexSupport
-
id
+
isDefault
 
maxDuplexChannels
 
maxInputChannels
 
maxOutputChannels
@@ -18,17 +18,17 @@
 
minInputChannels
 
minOutputChannels
 
name
-
nativeFormats
-
nSampleRates
+
nativeFormats
+
nSampleRates
 
probed
-
sampleRates
+
sampleRates
 
-
-
-
-  ©2001-2002 CCRMA, Stanford University. All Rights Reserved.

-  Maintained by Gary P. Scavone, gary@ccrma.stanford.edu
-
-
-
+
+
+
+  ©2001-2002 Gary P. Scavone, CCRMA, Stanford University. All Rights Reserved.

+  Maintained by Gary P. Scavone, gary@ccrma.stanford.edu
+
+
+
 
diff --git a/doc/html/structRtAudio_1_1RTAUDIO__DEVICE.html b/doc/html/structRtAudio_1_1RTAUDIO__DEVICE.html
index 63a4ef3..837c218 100644
--- a/doc/html/structRtAudio_1_1RTAUDIO__DEVICE.html
+++ b/doc/html/structRtAudio_1_1RTAUDIO__DEVICE.html
@@ -1,19 +1,21 @@
-
-
-The RtAudio Tutorial
-
-
-
-
-Tutorial   Class/Enum List   File List   Compound Members   
+
+
+The RtAudio Tutorial
+
+
+
+
+Tutorial   Class/Enum List   File List   Compound Members   
 
 
-RtAudio::RTAUDIO_DEVICE  Struct Reference
#include <RtAudio.h>
+RtAudio::RTAUDIO_DEVICE  Struct ReferenceThe public device information structure for passing queried values. 
+More...
+
+#include <RtAudio.h>
 

 List of all members.
-
@@ -22,10 +24,14 @@
 
-
-
-
+
+
+
+
 
Public Attributes
 char  name [128]
DEVICE_ID  id [2]
 bool  probed
 int  maxOutputChannels
 int  maxInputChannels
int  minInputChannels
 int  minDuplexChannels
 bool  hasDuplexSupport
int  nSampleRates
int  sampleRates [MAX_SAMPLE_RATES]
RTAUDIO_FORMAT  nativeFormats
bool  isDefault
int  nSampleRates
int  sampleRates [MAX_SAMPLE_RATES]
RTAUDIO_FORMAT  nativeFormats
 
+
Detailed Description
+The public device information structure for passing queried values.
+
 
Member Data Documentation
 
 
@@ -50,17 +56,17 @@ char RtAudio::RTAUDIO_DEVICE::name
     
+Character string device identifier.     
 
 
-    
   
 
-

+

 
   
     
       
 
@@ -76,17 +82,17 @@ DEVICE_ID RtAudio::RTAUDIO_DEVICE::id
     
+true if the device capabilities were successfully probed.     
         
            
-DEVICE_ID RtAudio::RTAUDIO_DEVICE::id
+bool RtAudio::RTAUDIO_DEVICE::probed
           
         

 
 
-No value reported by getDeviceInfo().     
   
 
-
+

 
   
     
       
 
@@ -102,17 +108,17 @@ bool RtAudio::RTAUDIO_DEVICE::probed
     
+Maximum output channels supported by device.     
         
            
-bool RtAudio::RTAUDIO_DEVICE::probed
+int RtAudio::RTAUDIO_DEVICE::maxOutputChannels
           
         

 
 
-true if the device capabilities were successfully probed.     
   
 
-
+

 
   
     
       
 
@@ -128,17 +134,17 @@ int RtAudio::RTAUDIO_DEVICE::maxOutputChannels
     
+Maximum input channels supported by device.     
         
            
-int RtAudio::RTAUDIO_DEVICE::maxOutputChannels
+int RtAudio::RTAUDIO_DEVICE::maxInputChannels
           
         

 
 
-    
   
 
-
+

 
   
     
       
 
@@ -154,17 +160,17 @@ int RtAudio::RTAUDIO_DEVICE::maxInputChannels
     
+Maximum simultaneous input/output channels supported by device.     
         
            
-int RtAudio::RTAUDIO_DEVICE::maxInputChannels
+int RtAudio::RTAUDIO_DEVICE::maxDuplexChannels
           
         

 
 
-    
   
 
-
+

 
   
     
       
 
@@ -180,17 +186,17 @@ int RtAudio::RTAUDIO_DEVICE::maxDuplexChannels
     
+Minimum output channels supported by device.     
         
            
-int RtAudio::RTAUDIO_DEVICE::maxDuplexChannels
+int RtAudio::RTAUDIO_DEVICE::minOutputChannels
           
         

 
 
-    
   
 
-
+

 
   
     
       
 
@@ -206,17 +212,17 @@ int RtAudio::RTAUDIO_DEVICE::minOutputChannels
     
+Minimum input channels supported by device.     
         
            
-int RtAudio::RTAUDIO_DEVICE::minOutputChannels
+int RtAudio::RTAUDIO_DEVICE::minInputChannels
           
         

 
 
-    
   
 
-
+

 
   
     
       
 
@@ -232,17 +238,17 @@ int RtAudio::RTAUDIO_DEVICE::minInputChannels
     
+Minimum simultaneous input/output channels supported by device.     
         
            
-int RtAudio::RTAUDIO_DEVICE::minInputChannels
+int RtAudio::RTAUDIO_DEVICE::minDuplexChannels
           
         

 
 
-    
   
 
-
+

 
   
     
       
 
@@ -258,17 +264,17 @@ int RtAudio::RTAUDIO_DEVICE::minDuplexChannels
     
+true if device supports duplex mode.     
         
            
-int RtAudio::RTAUDIO_DEVICE::minDuplexChannels
+bool RtAudio::RTAUDIO_DEVICE::hasDuplexSupport
           
         

 
 
-    
   
 
-
+

 
   
     
       
 
@@ -284,10 +290,10 @@ bool RtAudio::RTAUDIO_DEVICE::hasDuplexSupport
     
+true if this is the default output or input device.     
         
            
-bool RtAudio::RTAUDIO_DEVICE::hasDuplexSupport
+bool RtAudio::RTAUDIO_DEVICE::isDefault
           
         

 
 
-true if device supports duplex mode.     
   
 
-
+

 
   
     
@@ -313,7 +319,7 @@ int RtAudio::RTAUDIO_DEVICE::nSampleRates
 Number of discrete rates or -1 if range supported.     
   
 
-

+

 
   
     
@@ -339,14 +345,14 @@ int RtAudio::RTAUDIO_DEVICE::sampleRates
 Supported rates or (min, max) if range.     
   
 
-

+

 
   
     
       
 
@@ -367,12 +373,12 @@ Bit mask of supported data formats.     
         
            
-RTAUDIO_FORMAT RtAudio::RTAUDIO_DEVICE::nativeFormats
+RTAUDIO_FORMAT RtAudio::RTAUDIO_DEVICE::nativeFormats
           
         
 
 
The documentation for this struct was generated from the following file:
 RtAudio.h
-
-
-
-  ©2001-2002 CCRMA, Stanford University. All Rights Reserved.

-  Maintained by Gary P. Scavone, gary@ccrma.stanford.edu
-
-
-
+
+
+
+  ©2001-2002 Gary P. Scavone, CCRMA, Stanford University. All Rights Reserved.

+  Maintained by Gary P. Scavone, gary@ccrma.stanford.edu
+
+
+
 
diff --git a/doc/html/tutorial_8txt.html b/doc/html/tutorial_8txt.html
deleted file mode 100644
index 9e896a4..0000000
--- a/doc/html/tutorial_8txt.html
+++ /dev/null
@@ -1,21 +0,0 @@
-
-
-The RtAudio Tutorial
-
-
-
-
-Tutorial   Class/Enum List   File List   Compound Members   
-
-
-tutorial.txt File Reference
-
-
-
-
-  ©2001-2002 CCRMA, Stanford University. All Rights Reserved.

-  Maintained by Gary P. Scavone, gary@ccrma.stanford.edu
-
-
-
-
-- 
cgit v1.2.3

Public Types
typedef unsigned long	RTAUDIO_FORMAT
typedef int (*	RTAUDIO_CALLBACK )(char buffer, int bufferSize, void userData)
enum	{ MAX_SAMPLE_RATES = 14 - }
Public Methods
	RtAudio ()
	The default constructor. More...
	RtAudio (int streamId, int outputDevice, int outputChannels, int inputDevice, int inputChannels, RTAUDIO_FORMAT format, int sampleRate, int bufferSize, int numberOfBuffers)
	RtAudio (int streamId, int outputDevice, int outputChannels, int inputDevice, int inputChannels, RTAUDIO_FORMAT format, int sampleRate, int bufferSize, int numberOfBuffers)
	A constructor which can be used to open a stream during instantiation. More...
	~RtAudio ()
	The destructor. More...
int	openStream (int outputDevice, int outputChannels, int inputDevice, int inputChannels, RTAUDIO_FORMAT format, int sampleRate, int *bufferSize, int numberOfBuffers)
int	openStream (int outputDevice, int outputChannels, int inputDevice, int inputChannels, RTAUDIO_FORMAT format, int sampleRate, int *bufferSize, int numberOfBuffers)
	A public method for opening a stream with the specified parameters. More...
void	setStreamCallback (int streamId, RTAUDIO_CALLBACK callback, void *userData)
void	setStreamCallback (int streamId, RTAUDIO_CALLBACK callback, void *userData)
	A public method which sets a user-defined callback function for a given stream. More...
void	cancelStreamCallback (int streamId)
	A public method which cancels a callback process and function for a given stream. More...
int	getDeviceCount (void)
	A public method which returns the number of audio devices found. More...
+int	getDeviceCount (void)
	A public method which returns the number of audio devices found.
void	getDeviceInfo (int device, RTAUDIO_DEVICE *info)
	Fill a user-supplied RTAUDIO_DEVICE structure for a specified device. More...
	Fill a user-supplied RTAUDIO_DEVICE structure for a specified device number. More...
char* const	getStreamBuffer (int streamId)
	A public method which returns a pointer to the buffer for an open stream. More...
void	tickStream (int streamId)
int	streamWillBlock (int streamId)
	Queries a stream to determine whether a call to the tickStream() method will block. More...
Static Public Attributes
const RTAUDIO_FORMAT	RTAUDIO_SINT8
const RTAUDIO_FORMAT	RTAUDIO_SINT16
const RTAUDIO_FORMAT	RTAUDIO_SINT24
const RTAUDIO_FORMAT	RTAUDIO_SINT32
const RTAUDIO_FORMAT	RTAUDIO_FLOAT32
const RTAUDIO_FORMAT	RTAUDIO_FLOAT64

Public Types
enum	TYPE { - WARNING, -DEBUG_WARNING, -UNSPECIFIED, -NO_DEVICES_FOUND, + WARNING, +DEBUG_WARNING, +UNSPECIFIED, +NO_DEVICES_FOUND, - INVALID_DEVICE, -INVALID_STREAM, -MEMORY_ERROR, -INVALID_PARAMETER, + INVALID_DEVICE, +INVALID_STREAM, +MEMORY_ERROR, +INVALID_PARAMETER, - DRIVER_ERROR, -SYSTEM_ERROR, -THREAD_ERROR + DRIVER_ERROR, +SYSTEM_ERROR, +THREAD_ERROR }
	Defined RtError types.
Public Methods
	RtError (const char *p, TYPE tipe=RtError::UNSPECIFIED)
	The constructor. More...
virtual	~RtError (void)
	The destructor. More...
virtual void	printMessage (void)
	Prints "thrown" error message to stdout. More...
virtual const TYPE&	getType (void)
	Returns the "thrown" error message TYPE. More...
virtual const char*	getMessage (void)
	Returns the "thrown" error message string. More...
Protected Attributes
char	error_message [256]
TYPE	type

- -	- - -Prints "thrown" error message to stdout. +
+	RtError (const char *p, TYPE tipe=RtError::UNSPECIFIED)
	The constructor.
+virtual	~RtError (void)
	The destructor.
+virtual void	printMessage (void)
	Prints "thrown" error message to stdout.
+virtual const TYPE&	getType (void)
	Returns the "thrown" error message TYPE.
+virtual const char*	getMessage (void)
	Returns the "thrown" error message string.

OS:	Audio API:	Preprocessor Definition:	Library:	Example Compiler Statement:
Linux	ALSA	__LINUX_ALSA__	`libasound, libpthread`	`g++ -Wall -D__LINUX_ALSA__ -o probe probe.cpp RtAudio.cpp -lasound -lpthread`
Linux	OSS	__LINUX_OSS__	`libpthread`	`g++ -Wall -D__LINUX_OSS__ -o probe probe.cpp RtAudio.cpp -lpthread`
Irix	AL	__IRIX_AL__	`libaudio, libpthread`	`CC -Wall -D__IRIX_AL__ -o probe probe.cpp RtAudio.cpp -laudio -lpthread`
Windows	Direct Sound	__WINDOWS_DS__	`dsound.lib (ver. 5.0 or higher), multithreaded`	compiler specific

Compounds
class	RtError
class	RtAudio
struct	RtAudio::RTAUDIO_DEVICE
struct	RtAudio::RTAUDIO_STREAM
Defines
#define	__RTAUDIO_H

	*-RTAUDIO_FORMAT format, +RTAUDIO_FORMAT format,*
	*-RTAUDIO_FORMAT format, +RTAUDIO_FORMAT format,*
	*-RTAUDIO_CALLBACK callback, +RTAUDIO_CALLBACK callback,*

Public Attributes
char	name [128]
DEVICE_ID	id [2]
bool	probed
int	maxOutputChannels
int	maxInputChannels
int	minInputChannels
int	minDuplexChannels
bool	hasDuplexSupport
int	nSampleRates
int	sampleRates [MAX_SAMPLE_RATES]
RTAUDIO_FORMAT	nativeFormats
bool	isDefault
int	nSampleRates
int	sampleRates [MAX_SAMPLE_RATES]
RTAUDIO_FORMAT	nativeFormats

RtAudio.h

RtAudio.h

RtAudio.h File Reference

Compounds

Defines

Define Documentation

RtAudio Compound List

RtAudio Member List

RtAudio Class Reference

RtAudio Class Reference

Public Types

Public Methods

Static Public Attributes

Member Typedef Documentation

Detailed Description

Member Enumeration Documentation

Constructor & Destructor Documentation

RtError Member List

RtError Class Reference

RtError Class Reference

Public Types

Public Methods

Protected Attributes

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

Detailed Description

Member Data Documentation

RtAudio File List

RtAudio File List

RtAudio Compound Members

RtAudio Compound Members

- c -

- d -

- e -

- g -

- h -

- i -

- m -

- n -

- o -

- p -

- r -

- s -

- t -

- u -

- w -

- ~ -

RtAudio File Members

The RtAudio Tutorial

Introduction

Windows (DirectSound):

RtAudio::RTAUDIO_DEVICE Member List

RtAudio::RTAUDIO_DEVICE Struct Reference

RtAudio::RTAUDIO_DEVICE Struct Reference

Public Attributes

Detailed Description

Member Data Documentation

tutorial.txt File Reference