|
|
| FileWrite (void) |
| | Default constructor.
|
| |
| | FileWrite (std::string fileName, unsigned int nChannels=1, FILE_TYPE type=FILE_WAV, Stk::StkFormat format=STK_SINT16) |
| | Overloaded constructor used to specify a file name, type, and data format with this object. More...
|
| |
|
virtual | ~FileWrite () |
| | Class destructor.
|
| |
| void | open (std::string fileName, unsigned int nChannels=1, FileWrite::FILE_TYPE type=FILE_WAV, Stk::StkFormat format=STK_SINT16) |
| | Create a file of the specified type and name and output samples to it in the given data format. More...
|
| |
|
void | close (void) |
| | If a file is open, write out samples in the queue and then close it.
|
| |
|
bool | isOpen (void) |
| | Returns true if a file is currently open.
|
| |
| void | write (StkFrames &buffer) |
| | Write sample frames from the StkFrames object to the file. More...
|
| |
| void | ignoreSampleRateChange (bool ignore=true) |
| | A function to enable/disable the automatic updating of class data when the STK sample rate changes. More...
|
| |
|
|
static StkFloat | sampleRate (void) |
| | Static method that returns the current STK sample rate.
|
| |
| static void | setSampleRate (StkFloat rate) |
| | Static method that sets the STK sample rate. More...
|
| |
|
static void | clear_alertList () |
| | Static method that frees memory from alertList_.
|
| |
|
static std::string | rawwavePath (void) |
| | Static method that returns the current rawwave path.
|
| |
|
static void | setRawwavePath (std::string path) |
| | Static method that sets the STK rawwave path.
|
| |
|
static void | swap16 (unsigned char *ptr) |
| | Static method that byte-swaps a 16-bit data type.
|
| |
|
static void | swap32 (unsigned char *ptr) |
| | Static method that byte-swaps a 32-bit data type.
|
| |
|
static void | swap64 (unsigned char *ptr) |
| | Static method that byte-swaps a 64-bit data type.
|
| |
|
static void | sleep (unsigned long milliseconds) |
| | Static cross-platform method to sleep for a number of milliseconds.
|
| |
|
static bool | inRange (StkFloat value, StkFloat min, StkFloat max) |
| | Static method to check whether a value is within a specified range.
|
| |
|
static void | handleError (const char *message, StkError::Type type) |
| | Static function for error reporting and handling using c-strings.
|
| |
|
static void | handleError (std::string message, StkError::Type type) |
| | Static function for error reporting and handling using c++ strings.
|
| |
|
static void | showWarnings (bool status) |
| | Toggle display of WARNING and STATUS messages.
|
| |
|
static void | printErrors (bool status) |
| | Toggle display of error messages before throwing exceptions.
|
| |
STK audio file output class.
This class provides output support for various audio file formats.
FileWrite writes samples to an audio file. It supports multi-channel data.
FileWrite currently supports uncompressed WAV, AIFF, AIFC, SND (AU), MAT-file (Matlab), and STK RAW file formats. Signed integer (8-, 16-, 24-, and 32-bit) and floating- point (32- and 64-bit) data types are supported. STK RAW files use 16-bit integers by definition. MAT-files will always be written as 64-bit floats. If a data type specification does not match the specified file type, the data type will automatically be modified. Compressed data types are not supported.
by Perry R. Cook and Gary P. Scavone, 1995–2019.
| static void stk::Stk::setSampleRate |
( |
StkFloat |
rate | ) |
|
|
staticinherited |
Static method that sets the STK sample rate.
The sample rate set using this method is queried by all STK classes that depend on its value. It is initialized to the default SRATE set in Stk.h. Many STK classes use the sample rate during instantiation. Therefore, if you wish to use a rate that is different from the default rate, it is imperative that it be set BEFORE STK objects are instantiated. A few classes that make use of the global STK sample rate are automatically notified when the rate changes so that internal class data can be appropriately updated. However, this has not been fully implemented. Specifically, classes that appropriately update their own data when either a setFrequency() or noteOn() function is called do not currently receive the automatic notification of rate change. If the user wants a specific class instance to ignore such notifications, perhaps in a multi-rate context, the function Stk::ignoreSampleRateChange() should be called.
