stk::FileWrite Class Reference

STK audio file output class. More...

#include <FileWrite.h>

Inheritance diagram for stk::FileWrite:

Public Types
typedef unsigned long	FILE_TYPE
Public Types inherited from stk::Stk
typedef unsigned long	StkFormat

Public Member Functions
	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...
Public Member Functions inherited from stk::Stk
void	ignoreSampleRateChange (bool ignore=true)
	A function to enable/disable the automatic updating of class data when the STK sample rate changes. More...

Static Public Attributes
static const FILE_TYPE	FILE_RAW = 1
static const FILE_TYPE	FILE_WAV = 2
static const FILE_TYPE	FILE_SND = 3
static const FILE_TYPE	FILE_AIF = 4
static const FILE_TYPE	FILE_MAT = 5
Static Public Attributes inherited from stk::Stk
static const StkFormat	STK_SINT8 = 0x1
static const StkFormat	STK_SINT16 = 0x2
static const StkFormat	STK_SINT24 = 0x4
static const StkFormat	STK_SINT32 = 0x8
static const StkFormat	STK_FLOAT32 = 0x10
static const StkFormat	STK_FLOAT64 = 0x20

Protected Member Functions
bool	setRawFile (std::string fileName)
bool	setWavFile (std::string fileName)
void	closeWavFile (void)
bool	setSndFile (std::string fileName)
void	closeSndFile (void)
bool	setAifFile (std::string fileName)
void	closeAifFile (void)
bool	setMatFile (std::string fileName)
void	closeMatFile (void)
Protected Member Functions inherited from stk::Stk
	Stk (void)
	Default constructor.
virtual	~Stk (void)
	Class destructor.
virtual void	sampleRateChanged (StkFloat newRate, StkFloat oldRate)
	This function should be implemented in subclasses that depend on the sample rate.
void	addSampleRateAlert (Stk *ptr)
	Add class pointer to list for sample rate change notification.
void	removeSampleRateAlert (Stk *ptr)
	Remove class pointer from list for sample rate change notification.
void	handleError (StkError::Type type) const
	Internal function for error reporting that assumes message in oStream_ variable.

Protected Attributes
FILE *	fd_
FILE_TYPE	fileType_
StkFormat	dataType_
unsigned int	channels_
unsigned long	frameCounter_
bool	byteswap_
Protected Attributes inherited from stk::Stk
bool	ignoreSampleRateChange_

Additional Inherited Members
Static Public Member Functions inherited from stk::Stk
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 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.
Static Protected Attributes inherited from stk::Stk
static std::ostringstream	oStream_

Detailed Description

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–2014.

Constructor & Destructor Documentation

FileWrite::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.

An StkError is thrown for invalid argument values or if an error occurs when initializing the output file.

Member Function Documentation

void FileWrite::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.

An StkError is thrown for invalid argument values or if an error occurs when initializing the output file.

void FileWrite::write

(

StkFrames &

buffer

)

Write sample frames from the StkFrames object to the file.

An StkError will be thrown if the number of channels in the StkFrames argument does not agree with the number of channels specified when opening the file.

Member Data Documentation

const FileWrite::FILE_TYPE FileWrite::FILE_AIF = 4

static

AIFF file type.

const FileWrite::FILE_TYPE FileWrite::FILE_MAT = 5

static

Matlab MAT-file type.

const FileWrite::FILE_TYPE FileWrite::FILE_RAW = 1

static

STK RAW file type.

const FileWrite::FILE_TYPE FileWrite::FILE_SND = 3

static

SND (AU) file type.

const FileWrite::FILE_TYPE FileWrite::FILE_WAV = 2

static

WAV file type.

---

The documentation for this class was generated from the following files:

• Pd++Classes/STK-AudioFile/FileWrite.h
• Pd++Classes/STK-AudioFile/FileWrite.cpp