Version 4.0

2026-02-02 07:46:14 +00:00 · 2013-09-25 14:50:19 +02:00
parent 3f126af4e5
commit 81475b04c5
473 changed files with 36355 additions and 28396 deletions
--- a/include/RtWvOut.h
+++ b/include/RtWvOut.h
@@ -1,36 +1,92 @@
-/*******************************************/
-/*  Real-Time Audio Output Class,          */
-/*  by Perry R. Cook, 1996                 */
-/*  Revised by Gary P. Scavone, 2000       */
-/*                                         */
-/*  This object opens a realtime soundout  */
-/*  device, and pokes buffers of samples   */
-/*  into it.                               */
-/*******************************************/
-
-#if !defined(__RtWvOut_h)
-#define __RtWvOut_h
-
-#include "Object.h"
-#include "WvOut.h"
-#include "RtAudio.h"
-
-class RtWvOut : public WvOut
-{
- protected:
-	RtAudio *sound_dev;
- public:
-  RtWvOut(int chans = 1, int device = -1);
-  ~RtWvOut();
-  void tick(MY_FLOAT sample);
-  void mtick(MY_MULTI samples);
-
-#if (defined(__OS_Win_) )
-  void stopPlay();
-  void startPlay();
-  void stopRecord();
-  void startRecord();
-#endif
-};
-
-#endif // defined(__RtWvOut_h)
+/***************************************************/
+/*! \class RtWvOut
+    \brief STK realtime audio output class.
+
+    This class provides a simplified interface to
+    RtAudio for realtime audio output.  It is a
+    protected subclass of WvOut.
+
+    RtWvOut supports multi-channel data in
+    interleaved format.  It is important to
+    distinguish the tick() methods, which output
+    single samples to all channels in a sample
+    frame, from the tickFrame() method, which
+    takes a pointer to multi-channel sample
+    frame data.
+
+    by Perry R. Cook and Gary P. Scavone, 1995 - 2002.
+*/
+/***************************************************/
+
+#if !defined(__RTWVOUT_H)
+#define __RTWVOUT_H
+
+#include "WvOut.h"
+#include "RtAudio.h"
+
+class RtWvOut : protected WvOut
+{
+ public:
+  //! Default constructor.
+  /*!
+    The \e device argument is passed to RtAudio during
+    instantiation.  The default value (zero) will select the default
+    device on your system or the first device found meeting the
+    specified parameters.  On systems with multiple
+    soundcards/devices, values greater than zero can be specified in
+    accordance with the order that the devices are enumerated by the
+    underlying audio API.  The default buffer size of RT_BUFFER_SIZE
+    is defined in Stk.h.  An StkError will be thrown if an error
+    occurs duing instantiation.
+  */
+  RtWvOut(unsigned int nChannels = 1, MY_FLOAT sampleRate = Stk::sampleRate(), int device = 0, int bufferFrames = RT_BUFFER_SIZE, int nBuffers = 4 );
+
+  //! Class destructor.
+  ~RtWvOut();
+
+  //! Start the audio output stream.
+  /*!
+    The stream is started automatically, if necessary, when a tick() or tickFrame method is called.
+  */
+  void start(void);
+
+  //! Stop the audio output stream.
+  /*!
+    It may be necessary to use this method to avoid undesireable audio buffer cycling if you wish to temporarily stop audio output.
+  */
+  void stop(void);
+
+  //! Return the number of sample frames output.
+  unsigned long getFrames( void ) const;
+
+  //! Return the number of seconds of data output.
+  MY_FLOAT getTime( void ) const;
+
+  //! Output a single sample to all channels in a sample frame.
+  /*!
+    An StkError will be thrown if an error occurs during output.
+  */
+  void tick(const MY_FLOAT sample);
+
+  //! Output each sample in \e vector to all channels in \e vectorSize sample frames.
+  /*!
+    An StkError will be thrown if an error occurs during output.
+  */
+  void tick(const MY_FLOAT *vector, unsigned int vectorSize);
+
+  //! Output the \e frameVector of sample frames of the given length.
+  /*!
+    An StkError will be thrown if an error occurs during output.
+  */
+  void tickFrame(const MY_FLOAT *frameVector, unsigned int frames = 1);
+
+ protected:
+
+	RtAudio *audio;
+  bool stopped;
+  int stream;
+  int bufferSize;
+
+};
+
+#endif // defined(__RTWVOUT_H)