e1lama/stk
1
0
Fork 0
mirror of https://github.com/thestk/stk synced 2026-01-18 23:21:53 +00:00
Code Issues Packages Projects Releases Wiki Activity

Version 4.2.1

Browse Source
This commit is contained in:
Gary Scavone
2009-03-24 23:02:14 -04:00
committed by Stephen Sinclair
parent a6381b9d38
commit 2cbce2d8bd
275 changed files with 8949 additions and 6906 deletions
Download Patch File Download Diff File Expand all files Collapse all files

89
include/RtWvOut.h
View File

@@ -2,23 +2,19 @@
/*! \class RtWvOut
\brief STK realtime audio (blocking) output class.
This class provides a simplified interface to
RtAudio for realtime audio output. It is a
protected subclass of WvOut. Because this
class makes use of RtAudio's blocking output
routines, its performance is less robust on
systems where the audio API is callback-based
This class provides a simplified interface to RtAudio for realtime
audio output. It is a subclass of WvOut. Because this class
makes use of RtAudio's blocking output routines, its performance
is less robust on systems where the audio API is callback-based
(Macintosh CoreAudio and Windows ASIO).
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
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 take a pointer or reference to multi-channel sample
frame data.
by Perry R. Cook and Gary P. Scavone, 1995 - 2004.
by Perry R. Cook and Gary P. Scavone, 1995 - 2005.
*/
/***************************************************/
@@ -28,7 +24,7 @@
#include "WvOut.h"
#include "RtAudio.h"
class RtWvOut : protected WvOut
class RtWvOut : public WvOut
{
public:
@@ -44,70 +40,41 @@ class RtWvOut : protected WvOut
is defined in Stk.h. An StkError will be thrown if an error
occurs duing instantiation.
*/
RtWvOut(unsigned int nChannels = 1, StkFloat sampleRate = Stk::sampleRate(), int device = 0, int bufferFrames = RT_BUFFER_SIZE, int nBuffers = 4 );
RtWvOut( unsigned int nChannels = 1, StkFloat 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.
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.
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.
StkFloat 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 StkFloat 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 StkFloat *vector, unsigned int vectorSize );
//! Output a channel of the StkFrames object to all channels of the RtWvOut object.
/*!
The \c channel argument should be one or greater (the first
channel is specified by 1). An StkError will be thrown if an
error occurs during output or the \c channel argument is zero or
it is greater than the number of channels in the StkFrames object.
*/
void tick( const StkFrames& frames, unsigned int channel = 1 );
//! 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 StkFloat *frameVector, unsigned int frames = 1 );
//! Output the StkFrames data to the RtWvOut object.
/*!
An StkError will be thrown if an error occurs during output or
if there is an incompatability between the number of channels in
the WvOut object and that in the StkFrames object.
*/
void tickFrame( const StkFrames& frames );
protected:
RtAudio *audio_;
StkFloat *dataPtr_;
void computeSample( const StkFloat sample );
void computeFrames( const StkFrames& frames );
void incrementFrame( void );
RtAudio *dac_;
StkFloat *buffer_;
bool stopped_;
int bufferSize_;
unsigned int nChannels_;
unsigned int bufferIndex_;
unsigned int iBuffer_;
unsigned int bufferFrames_;
};