#include <SampleRecorderNode.h>
Inherits cinder::audio::SampleRecorderNode.
Records its inputs to a Buffer. The Buffer record size should be specified by the user (the default size is 44100 frames). Also supports writing the recorded samples to file.
Used to specifiy how the corresponding channels are to be resolved between two connected Node's, based on either a Node's input (the default), it's output, or specified by user.
Enumerator |
---|
SPECIFIED |
Number of channels has been specified by user or is non-settable.
|
MATCHES_INPUT |
This Node matches it's channels with it's input.
|
MATCHES_OUTPUT |
This Node matches it's channels with it's output.
|
cinder::audio::BufferRecorderNode::BufferRecorderNode |
( |
const Format & |
format = Format() | ) |
|
cinder::audio::BufferRecorderNode::BufferRecorderNode |
( |
size_t |
numFrames, |
|
|
const Format & |
format = Format() |
|
) |
| |
Constructs a BufferRecordNode and initializes its buffer to be large enough to hold numFrames frames.
void cinder::audio::BufferRecorderNode::start |
( |
| ) |
|
Starts recording. Resets the write position to zero (call disable() to pause recording).
void cinder::audio::BufferRecorderNode::stop |
( |
| ) |
|
void cinder::audio::BufferRecorderNode::setNumFrames |
( |
size_t |
numFrames, |
|
|
bool |
shrinkToFit = false |
|
) |
| |
Sets the length of the recording buffer in frames.
If the write position is non-zero, the old contents will be preserved (by copying it to the newly allocated Buffer). If shrinkToFit is set to true
, the internal Buffer will be down-sized if necessary, otherwise it will only re-allocate when growing while changing its dimensions to match numFrames (default shrinkToFit = false).
void cinder::audio::BufferRecorderNode::setNumSeconds |
( |
double |
numSeconds, |
|
|
bool |
shrinkToFit = false |
|
) |
| |
Sets the length of the recording buffer in seconds.
- See also
- setNumFrames
size_t cinder::audio::BufferRecorderNode::getNumFrames |
( |
| ) |
const |
Returns the length of the recording buffer in frames.
double cinder::audio::BufferRecorderNode::getNumSeconds |
( |
| ) |
const |
Returns the length of the recording buffer in seconds.
BufferRef cinder::audio::BufferRecorderNode::getRecordedCopy |
( |
| ) |
const |
Returns a copy of the recored samples, up to the current write position.
This method is non locking, and as such any resizing calls must be performed on the same thread or be otherwise synchronized.
Writes the currently recorded samples to a file at filePath.
The encoding format is derived from filePath's extension and sampleType (default = SampleType::INT_16).
- Note
- throws AudioFileExc if the write request cannot be completed.
uint64_t cinder::audio::BufferRecorderNode::getLastOverrun |
( |
| ) |
|
Returns the frame of the last buffer overrun or 0 if none since the last time this method was called. When this happens, it means the recorded buffer probably has skipped some frames.
void cinder::audio::BufferRecorderNode::initialize |
( |
| ) |
|
|
overrideprotectedvirtual |
Called before audio buffers need to be used. There is always a valid Context at this point.
Reimplemented from cinder::audio::Node.
void cinder::audio::BufferRecorderNode::process |
( |
Buffer * |
buffer | ) |
|
|
overrideprotectedvirtual |
void cinder::audio::BufferRecorderNode::initBuffers |
( |
size_t |
numFrames | ) |
|
|
protected |
size_t cinder::audio::SampleRecorderNode::getWritePosition |
( |
| ) |
const |
|
inherited |
Returns the current write position, which represents how many samples are currently recorded.
void cinder::audio::NodeAutoPullable::connect |
( |
const NodeRef & |
output | ) |
|
|
overridevirtualinherited |
void cinder::audio::NodeAutoPullable::connectInput |
( |
const NodeRef & |
input | ) |
|
|
overridevirtualinherited |
- Note
- Connection methods be called on a non-audio thread and synchronized with the Context's mutex.
Reimplemented from cinder::audio::Node.
void cinder::audio::NodeAutoPullable::disconnectInput |
( |
const NodeRef & |
input | ) |
|
|
overridevirtualinherited |
void cinder::audio::NodeAutoPullable::disconnectOutput |
( |
const NodeRef & |
output | ) |
|
|
overridevirtualinherited |
void cinder::audio::NodeAutoPullable::disconnectAllOutputs |
( |
| ) |
|
|
overridevirtualinherited |
void cinder::audio::NodeAutoPullable::updatePullMethod |
( |
| ) |
|
|
protectedinherited |
void cinder::audio::Node::enable |
( |
| ) |
|
|
inherited |
Enables this Node for processing. Same as setEnabled( true )
.
void cinder::audio::Node::enable |
( |
double |
when | ) |
|
|
inherited |
void cinder::audio::Node::disable |
( |
| ) |
|
|
inherited |
Disables this Node for processing. Same as setEnabled( false )
.
void cinder::audio::Node::disable |
( |
double |
when | ) |
|
|
inherited |
void cinder::audio::Node::setEnabled |
( |
bool |
b | ) |
|
|
inherited |
Sets whether this Node is enabled for processing or not.
void cinder::audio::Node::setEnabled |
( |
bool |
b, |
|
|
double |
when |
|
) |
| |
|
inherited |
bool cinder::audio::Node::isEnabled |
( |
| ) |
const |
|
inherited |
Returns whether this Node is enabled for processing or not.
void cinder::audio::Node::disconnect |
( |
const NodeRef & |
output | ) |
|
|
virtualinherited |
Disconnects this Node from output.
void cinder::audio::Node::disconnectAll |
( |
| ) |
|
|
virtualinherited |
Disconnects this Node from all inputs and outputs.
void cinder::audio::Node::disconnectAllInputs |
( |
| ) |
|
|
virtualinherited |
size_t cinder::audio::Node::getNumConnectedInputs |
( |
| ) |
const |
|
inherited |
Returns the number of inputs connected to this Node.
size_t cinder::audio::Node::getNumConnectedOutputs |
( |
| ) |
const |
|
inherited |
Returns the number of outputs this Node is connected to.
bool cinder::audio::Node::isConnectedToInput |
( |
const NodeRef & |
input | ) |
const |
|
inherited |
Returns true if input is connected to this Node as an input, false otherwise.
bool cinder::audio::Node::isConnectedToOutput |
( |
const NodeRef & |
output | ) |
const |
|
inherited |
Returns true if output is connected to this Node as an output, false otherwise.
ContextRef cinder::audio::Node::getContext |
( |
| ) |
const |
|
inherited |
Returns the Context associated with this Node.
- Note
- Cannot be called from within a Node's constructor. Use initialize instead.
size_t cinder::audio::Node::getNumChannels |
( |
| ) |
const |
|
inherited |
Returns the number of channels this Node will process.
ChannelMode cinder::audio::Node::getChannelMode |
( |
| ) |
const |
|
inherited |
size_t cinder::audio::Node::getMaxNumInputChannels |
( |
| ) |
const |
|
inherited |
Returns the maximum number of channels any input has.
size_t cinder::audio::Node::getSampleRate |
( |
| ) |
const |
|
inherited |
size_t cinder::audio::Node::getFramesPerBlock |
( |
| ) |
const |
|
inherited |
Returns the number of frames processed in one block by this Node, which is governed by the Context's OutputNode.
bool cinder::audio::Node::isAutoEnabled |
( |
| ) |
const |
|
inherited |
Returns whether this Node is automatically enabled / disabled when connected.
void cinder::audio::Node::setAutoEnabled |
( |
bool |
b = true | ) |
|
|
inherited |
Sets whether this Node is automatically enabled / disabled when connected.
bool cinder::audio::Node::isInitialized |
( |
| ) |
const |
|
inherited |
Returns whether this Node is in an initialized state and is capable of processing audio.
bool cinder::audio::Node::getProcessesInPlace |
( |
| ) |
const |
|
inherited |
Returns whether this Node will process audio with an in-place Buffer.
bool cinder::audio::Node::canConnectToInput |
( |
const NodeRef & |
input | ) |
|
|
inherited |
Returns whether it is possible to connect to input, example reasons of failure would be this == Node, or Node is already an input.
bool cinder::audio::Node::checkCycle |
( |
const NodeRef & |
sourceNode, |
|
|
const NodeRef & |
destNode |
|
) |
| const |
|
inherited |
Returns true if there is an unmanageable cycle betweeen sourceNode and destNode. If any Node's in the traversal returns true for supportsCycles(), this method will return false.
const std::set<NodeRef>& cinder::audio::Node::getInputs |
( |
| ) |
const |
|
inherited |
Returns an immutable reference to the inputs container.
vector< NodeRef > cinder::audio::Node::getOutputs |
( |
| ) |
const |
|
inherited |
Returns a copy of the NodeRef's referenced by the this Node as outputs. The copy is necessary because outputs are stored internally with weak_ptr's.
std::string cinder::audio::Node::getName |
( |
| ) |
|
|
virtualinherited |
Returns a string representing the name of this Node type. Default returns a demangled, compiler-specific class name.
void cinder::audio::Node::setName |
( |
const std::string & |
name | ) |
|
|
inherited |
Sets this Node's name to a user-specified string.
Buffer* cinder::audio::Node::getInternalBuffer |
( |
| ) |
|
|
inherited |
Usually used internally by a Node subclass, returns a pointer to the internal buffer storage.
const Buffer* cinder::audio::Node::getInternalBuffer |
( |
| ) |
const |
|
inherited |
Usually used internally by a Node subclass, returns a pointer to the internal buffer storage.
void cinder::audio::Node::pullInputs |
( |
Buffer * |
inPlaceBuffer | ) |
|
|
inherited |
Usually called internally by the Node, in special cases sub-classes may need to call this on other Node's.
virtual void cinder::audio::Node::uninitialize |
( |
| ) |
|
|
protectedvirtualinherited |
virtual void cinder::audio::Node::enableProcessing |
( |
| ) |
|
|
protectedvirtualinherited |
virtual void cinder::audio::Node::disableProcessing |
( |
| ) |
|
|
protectedvirtualinherited |
void cinder::audio::Node::sumInputs |
( |
| ) |
|
|
protectedvirtualinherited |
virtual bool cinder::audio::Node::supportsInputNumChannels |
( |
size_t |
numChannels | ) |
const |
|
protectedvirtualinherited |
virtual bool cinder::audio::Node::supportsCycles |
( |
| ) |
const |
|
protectedvirtualinherited |
Default implementation returns false, return true if it makes sense for the Node to be processed in a cycle (eg. Delay).
Reimplemented in cinder::audio::DelayNode.
virtual bool cinder::audio::Node::supportsProcessInPlace |
( |
| ) |
const |
|
protectedvirtualinherited |
void cinder::audio::Node::configureConnections |
( |
| ) |
|
|
protectedvirtualinherited |
void cinder::audio::Node::setupProcessWithSumming |
( |
| ) |
|
|
protectedinherited |
void cinder::audio::Node::notifyConnectionsDidChange |
( |
| ) |
|
|
protectedinherited |
bool cinder::audio::Node::inputChannelsAreUnequal |
( |
| ) |
const |
|
protectedinherited |
void cinder::audio::Node::setNumChannels |
( |
size_t |
numChannels | ) |
|
|
protectedinherited |
Only Node subclasses can specify num channels directly - users specify via Format at construction time.
void cinder::audio::Node::setChannelMode |
( |
ChannelMode |
mode | ) |
|
|
protectedinherited |
Only Node subclasses can specify channel mode directly - users specify via Format at construction time.
const std::pair<size_t, size_t>& cinder::audio::Node::getProcessFramesRange |
( |
| ) |
const |
|
protectedinherited |
Returns a pair of frame indices for Nodes that wish to support sample accurate enable and disable.
The first index is where processing should start, the second is where it should end. Should only be called on the audio thread from within a Node's process() method. Unless scheduled (with Context::schedule()), this will be [0, getFramesPerBlock()]
void cinder::audio::Node::initializeImpl |
( |
| ) |
|
|
protectedinherited |
void cinder::audio::Node::uninitializeImpl |
( |
| ) |
|
|
protectedinherited |
const BufferDynamic* cinder::audio::Node::getSummingBuffer |
( |
| ) |
const |
|
protectedinherited |
std::atomic<uint64_t> cinder::audio::BufferRecorderNode::mLastOverrun |
|
protected |
std::atomic<size_t> cinder::audio::SampleRecorderNode::mWritePos |
|
protectedinherited |
bool cinder::audio::NodeAutoPullable::mIsPulledByContext |
|
protectedinherited |
The documentation for this class was generated from the following files: