PTLib
Version 2.10.4
|
A class representing a WAV audio file. More...
#include <pwavfile.h>
Public Member Functions | |
PBoolean | RawRead (void *buf, PINDEX len) |
PBoolean | RawWrite (const void *buf, PINDEX len) |
PBoolean | FileRead (void *buf, PINDEX len) |
PBoolean | FileWrite (const void *buf, PINDEX len) |
off_t | RawGetPosition () const |
PBoolean | RawSetPosition (off_t pos, FilePositionOrigin origin) |
off_t | RawGetDataLength () |
void | SetLastReadCount (PINDEX v) |
void | SetLastWriteCount (PINDEX v) |
Overrides from class PFile | |
virtual PBoolean | Read (void *buf, PINDEX len) |
Call PFile::Read() to read in audio data and perform necessary processing such as byte-order swaping. | |
virtual PBoolean | Write (const void *buf, PINDEX len) |
Call PFile::Write() to write out audio data and perform necessary processing such as byte-order swaping. | |
virtual PBoolean | Open (OpenMode mode=ReadWrite, int opts=ModeDefault) |
Open the current file in the specified mode and with the specified options. | |
virtual PBoolean | Open (const PFilePath &name, OpenMode mode=ReadWrite, int opts=ModeDefault) |
Open the specified WAV file name in the specified mode and with the specified options. | |
virtual PBoolean | Close () |
Close the file channel. | |
virtual PBoolean | SetPosition (off_t pos, FilePositionOrigin origin=Start) |
Set the current active position in the file for the next read or write operation. | |
virtual off_t | GetPosition () const |
Get the current active position in the file for the next read or write operation. | |
Member variable access | |
virtual PBoolean | SetFormat (unsigned fmt) |
Find out the format of the WAV file. | |
virtual PBoolean | SetFormat (const PString &format) |
virtual unsigned | GetFormat () const |
Find out the format of the WAV file. | |
virtual PString | GetFormatAsString () const |
virtual unsigned | GetChannels () const |
Find out the number of channels the WAV file has. | |
virtual void | SetChannels (unsigned v) |
virtual unsigned | GetSampleRate () const |
Find out the sample rate of the WAV file in Hz. | |
virtual void | SetSampleRate (unsigned v) |
virtual unsigned | GetSampleSize () const |
Find out how may bits there are per sample, eg 8 or 16. | |
virtual void | SetSampleSize (unsigned v) |
virtual unsigned | GetBytesPerSecond () const |
Find out how may bytes there are per second. | |
virtual void | SetBytesPerSecond (unsigned v) |
off_t | GetHeaderLength () const |
Find out the size of WAV header presented in the file. | |
virtual off_t | GetDataLength () |
Find out how many bytes of audio data there are. | |
PBoolean | IsValid () const |
Determine if the WAV file is a valid wave file. | |
PString | GetFormatString () const |
Return a string that describes the WAV format. | |
void | SetAutoconvert () |
Enable autoconversion between PCM-16 and the native format. | |
![]() | |
Comparison | Compare (const PObject &obj) const |
Determine the relative rank of the two objects. | |
virtual PString | GetName () const |
Get the platform and I/O channel type name of the channel. | |
PFile () | |
Create a file object but do not open it. | |
PFile (OpenMode mode, int opts=ModeDefault) | |
Create a unique temporary file name, and open the file in the specified mode and using the specified options. | |
PFile (const PFilePath &name, OpenMode mode=ReadWrite, int opts=ModeDefault) | |
Create a file object with the specified name and open it in the specified mode and with the specified options. | |
~PFile () | |
Close the file on destruction. | |
PBoolean | Exists () const |
Check for file existance. | |
PBoolean | Access (OpenMode mode) |
Check for file access modes. | |
PBoolean | Remove (PBoolean force=false) |
Delete the current file. | |
PBoolean | Rename (const PString &newname, PBoolean force=false) |
Change the current files name. | |
PBoolean | Copy (const PFilePath &newname, PBoolean force=false) |
Make a copy of the current file. | |
PBoolean | Move (const PFilePath &newname, PBoolean force=false) |
Move the current file. | |
const PFilePath & | GetFilePath () const |
Get the full path name of the file. | |
void | SetFilePath (const PString &path) |
Set the full path name of the file. | |
virtual off_t | GetLength () const |
Get the current size of the file. | |
virtual PBoolean | SetLength (off_t len) |
Set the size of the file, padding with 0 bytes if it would require expanding the file, or truncating it if being made shorter. | |
PBoolean | IsEndOfFile () const |
Determine if the current file position is at the end of the file. | |
PBoolean | GetInfo (PFileInfo &info) |
Get information (eg protection, timestamps) on the current file. | |
PBoolean | SetPermissions (int permissions) |
Set permissions on the current file. | |
![]() | |
PBoolean | SetErrorValues (Errors errorCode, int osError, ErrorGroup group=LastGeneralError) |
Set error values to those specified. | |
PChannel () | |
Create the channel. | |
~PChannel () | |
Close down the channel. | |
virtual PINDEX | HashFunction () const |
Calculate a hash value for use in sets and dictionaries. | |
virtual PBoolean | IsOpen () const |
Determine if the channel is currently open. | |
int | GetHandle () const |
Get the integer operating system handle for the channel. | |
virtual PChannel * | GetBaseReadChannel () const |
Get the base channel of channel indirection using PIndirectChannel. | |
virtual PChannel * | GetBaseWriteChannel () const |
Get the base channel of channel indirection using PIndirectChannel. | |
void | SetReadTimeout (const PTimeInterval &time) |
Set the timeout for read operations. | |
PTimeInterval | GetReadTimeout () const |
Get the timeout for read operations. | |
virtual PINDEX | GetLastReadCount () const |
Get the number of bytes read by the last Read() call. | |
virtual int | ReadChar () |
Read a single 8 bit byte from the channel. | |
PBoolean | ReadBlock (void *buf, PINDEX len) |
Read len bytes into the buffer from the channel. | |
PString | ReadString (PINDEX len) |
Read len character into a string from the channel. | |
virtual PBoolean | ReadAsync (void *buf, PINDEX len) |
Begin an asynchronous read from channel. | |
virtual void | OnReadComplete (void *buf, PINDEX len) |
User callback function for when a ReadAsync() call has completed or timed out. | |
void | SetWriteTimeout (const PTimeInterval &time) |
Set the timeout for write operations to complete. | |
PTimeInterval | GetWriteTimeout () const |
Get the timeout for write operations to complete. | |
virtual PBoolean | Write (const void *buf, PINDEX len, const void *mark) |
Low level write to the channel with marker. | |
virtual PINDEX | GetLastWriteCount () const |
Get the number of bytes written by the last Write() call. | |
PBoolean | WriteChar (int c) |
Write a single character to the channel. | |
PBoolean | WriteString (const PString &str) |
Write a string to the channel. | |
virtual PBoolean | WriteAsync (const void *buf, PINDEX len) |
Begin an asynchronous write from channel. | |
virtual void | OnWriteComplete (const void *buf, PINDEX len) |
User callback function for when a WriteAsync() call has completed or timed out. | |
virtual PBoolean | Shutdown (ShutdownValue option) |
Close one or both of the data streams associated with a channel. | |
virtual bool | SetLocalEcho (bool localEcho) |
Set local echo mode. | |
virtual bool | FlowControl (const void *flowData) |
Flow Control information Pass data to the channel for flowControl determination. | |
PBoolean | SetBufferSize (PINDEX newSize) |
Set the iostream buffer size for reads and writes. | |
PBoolean | SendCommandString (const PString &command) |
Send a command meta-string. | |
void | AbortCommandString () |
Abort a command string that is in progress. | |
Errors | GetErrorCode (ErrorGroup group=NumErrorGroups) const |
Get normalised error code. | |
int | GetErrorNumber (ErrorGroup group=NumErrorGroups) const |
Get OS errro code. | |
virtual PString | GetErrorText (ErrorGroup group=NumErrorGroups) const |
Get error message description. | |
virtual PBoolean | Read (const VectorOfSlice &slices) |
Low level scattered read from the channel. | |
virtual PBoolean | Write (const VectorOfSlice &slices) |
Low level scattered write to the channel. | |
![]() | |
virtual | ~PObject () |
virtual PObject * | Clone () const |
Create a copy of the class on the heap. | |
virtual const char * | GetClass (unsigned ancestor=0) const |
Get the current dynamic type of the object instance. | |
PBoolean | IsClass (const char *cls) const |
virtual PBoolean | InternalIsDescendant (const char *clsName) const |
Determine if the dynamic type of the current instance is a descendent of the specified class. | |
virtual Comparison | CompareObjectMemoryDirect (const PObject &obj) const |
Determine the byte wise comparison of two objects. | |
bool | operator== (const PObject &obj) const |
Compare the two objects. | |
bool | operator!= (const PObject &obj) const |
Compare the two objects. | |
bool | operator< (const PObject &obj) const |
Compare the two objects. | |
bool | operator> (const PObject &obj) const |
Compare the two objects. | |
bool | operator<= (const PObject &obj) const |
Compare the two objects. | |
bool | operator>= (const PObject &obj) const |
Compare the two objects. | |
virtual void | PrintOn (ostream &strm) const |
Output the contents of the object to the stream. | |
virtual void | ReadFrom (istream &strm) |
Input the contents of the object from the stream. |
Static Public Member Functions | |
static PWAVFile * | format (const PString &format) |
static PWAVFile * | format (const PString &format, PFile::OpenMode mode, int opts=PFile::ModeDefault) |
![]() | |
static PBoolean | Exists (const PFilePath &name) |
Check for file existance. | |
static PBoolean | Access (const PFilePath &name, OpenMode mode) |
Check for file access modes. | |
static PBoolean | Remove (const PFilePath &name, PBoolean force=false) |
Delete the specified file. | |
static PBoolean | Remove (const PString &name, PBoolean force=false) |
static PBoolean | Rename (const PFilePath &oldname, const PString &newname, PBoolean force=false) |
Change the specified files name. | |
static PBoolean | Copy (const PFilePath &oldname, const PFilePath &newname, PBoolean force=false) |
Make a copy of the specified file. | |
static PBoolean | Move (const PFilePath &oldname, const PFilePath &newname, PBoolean force=false) |
Move the specified file. | |
static PBoolean | GetInfo (const PFilePath &name, PFileInfo &info) |
Get information (eg protection, timestamps) on the specified file. | |
static PBoolean | SetPermissions (const PFilePath &name, int permissions) |
Set permissions on the specified file. |
Protected Member Functions | |
void | Construct () |
bool | SelectFormat (unsigned fmt) |
bool | SelectFormat (const PString &format) |
PBoolean | ProcessHeader () |
PBoolean | GenerateHeader () |
PBoolean | UpdateHeader () |
Protected Attributes | |
PBYTEArray | wavHeaderData |
PWAV::FMTChunk | wavFmtChunk |
PBYTEArray | extendedHeader |
bool | isValidWAV |
unsigned int | origFmt |
PWAVFileFormat * | formatHandler |
PBoolean | autoConvert |
PWAVFileConverter * | autoConverter |
off_t | lenHeader |
off_t | lenData |
bool | header_needs_updating |
![]() | |
PFilePath | path |
The fully qualified path name for the file. | |
PBoolean | removeOnClose |
File is to be removed when closed. | |
![]() | |
int | os_handle |
The operating system file handle return by standard open() function. | |
Errors | lastErrorCode [NumErrorGroups+1] |
The platform independant error code. | |
int | lastErrorNumber [NumErrorGroups+1] |
The operating system error number (eg as returned by errno). | |
PINDEX | lastReadCount |
Number of byte last read by the Read() function. | |
PINDEX | lastWriteCount |
Number of byte last written by the Write() function. | |
PTimeInterval | readTimeout |
Timeout for read operations. | |
PTimeInterval | writeTimeout |
Timeout for write operations. | |
PString | channelName |
PMutex | px_threadMutex |
PXBlockType | px_lastBlockType |
PThread * | px_readThread |
PThread * | px_writeThread |
PMutex | px_writeMutex |
PThread * | px_selectThread [3] |
PMutex | px_selectMutex [3] |
Construction | |
enum | WaveType { fmt_PCM = 1, fmt_MSADPCM = 2, fmt_ALaw = 6, fmt_uLaw = 7, fmt_VOXADPCM = 0x10, fmt_IMAADPCM = 0x11, fmt_GSM = 0x31, fmt_G728 = 0x41, fmt_G723 = 0x42, fmt_MSG7231 = 0x42, fmt_G726 = 0x64, fmt_G722 = 0x65, fmt_G729 = 0x83, fmt_VivoG7231 = 0x111, PCM_WavFile = fmt_PCM, G7231_WavFile = fmt_VivoG7231, fmt_NotKnown = 0x10000 } |
When a file is opened for writing, we can specify if this is a PCM wav file or a G.723.1 wav file. More... | |
PWAVFile (unsigned format=fmt_PCM) | |
Create a WAV file object but do not open it. | |
PWAVFile (OpenMode mode, int opts=ModeDefault, unsigned format=fmt_PCM) | |
Create a unique temporary file name, and open the file in the specified mode and using the specified options. | |
PWAVFile (const PFilePath &name, OpenMode mode=ReadWrite, int opts=ModeDefault, unsigned format=fmt_PCM) | |
Create a WAV file object with the specified name and open it in the specified mode and with the specified options. | |
PWAVFile (const PString &format, const PFilePath &name, OpenMode mode=PFile::ReadWrite, int opts=PFile::ModeDefault) | |
~PWAVFile () | |
Close the file before destruction. |
Additional Inherited Members | |
![]() | |
enum | OpenMode { ReadOnly, WriteOnly, ReadWrite } |
When a file is opened, it may restrict the access available to operations on the object instance. More... | |
enum | OpenOptions { ModeDefault = -1, MustExist = 0, Create = 1, Truncate = 2, Exclusive = 4, Temporary = 8, DenySharedRead = 16, DenySharedWrite = 32 } |
When a file is opened, a number of options may be associated with the open file. More... | |
enum | FilePositionOrigin { Start = SEEK_SET, Current = SEEK_CUR, End = SEEK_END } |
Options for the origin in setting the file position. More... | |
![]() | |
enum | PXBlockType { PXReadBlock, PXWriteBlock, PXAcceptBlock, PXConnectBlock } |
enum | ShutdownValue { ShutdownRead = 0, ShutdownWrite = 1, ShutdownReadAndWrite = 2 } |
enum | Errors { NoError, NotFound, FileExists, DiskFull, AccessDenied, DeviceInUse, BadParameter, NoMemory, NotOpen, Timeout, Interrupted, BufferTooSmall, Miscellaneous, ProtocolFailure, NumNormalisedErrors } |
Normalised error codes. More... | |
enum | ErrorGroup { LastReadError, LastWriteError, LastGeneralError, NumErrorGroups } |
Error groups. More... | |
typedef std::vector< Slice > | VectorOfSlice |
![]() |
A class representing a WAV audio file.
enum PWAVFile::WaveType |
When a file is opened for writing, we can specify if this is a PCM wav file or a G.723.1 wav file.
PWAVFile::PWAVFile | ( | unsigned | format = fmt_PCM | ) |
Create a WAV file object but do not open it.
It does not initially have a valid file name. However, an attempt to open the file using the PFile::Open()
function will generate a unique temporary file.
If a WAV file is being created, the type parameter can be used to create a PCM Wave file or a G.723.1 Wave file by using WaveType
enum.
format | Type of WAV File to create |
PWAVFile::PWAVFile | ( | OpenMode | mode, |
int | opts = ModeDefault , |
||
unsigned | format = fmt_PCM |
||
) |
Create a unique temporary file name, and open the file in the specified mode and using the specified options.
Note that opening a new, unique, temporary file name in ReadOnly mode will always fail. This would only be usefull in a mode and options that will create the file.
If a WAV file is being created, the type parameter can be used to create a PCM Wave file or a G.723.1 Wave file by using WaveType
enum.
The PChannel::IsOpen()
function may be used after object construction to determine if the file was successfully opened.
mode | Mode in which to open the file. |
opts | OpenOptions enum for open operation. |
format | Type of WAV File to create |
PWAVFile::PWAVFile | ( | const PFilePath & | name, |
OpenMode | mode = ReadWrite , |
||
int | opts = ModeDefault , |
||
unsigned | format = fmt_PCM |
||
) |
Create a WAV file object with the specified name and open it in the specified mode and with the specified options.
If a WAV file is being created, the type parameter can be used to create a PCM Wave file or a G.723.1 Wave file by using WaveType
enum.
The PChannel::IsOpen()
function may be used after object construction to determine if the file was successfully opened.
name | Name of file to open. |
mode | Mode in which to open the file. |
opts | OpenOptions enum for open operation. |
format | Type of WAV File to create |
PWAVFile::PWAVFile | ( | const PString & | format, |
const PFilePath & | name, | ||
OpenMode | mode = PFile::ReadWrite , |
||
int | opts = PFile::ModeDefault |
||
) |
format | Type of WAV File to create |
name | Name of file to open. |
mode | Mode in which to open the file. |
opts | OpenOptions enum for open operation. |
PWAVFile::~PWAVFile | ( | ) |
Close the file before destruction.
|
virtual |
Close the file channel.
If a WAV file has been written to, this will update the header to contain the correct size information.
Reimplemented from PFile.
|
protected |
Reimplemented from PChannel.
PBoolean PWAVFile::FileRead | ( | void * | buf, |
PINDEX | len | ||
) |
PBoolean PWAVFile::FileWrite | ( | const void * | buf, |
PINDEX | len | ||
) |
|
static |
|
protected |
|
virtual |
Find out how may bytes there are per second.
|
virtual |
Find out the number of channels the WAV file has.
Typically this is 1 for mono and 2 for stereo.
|
virtual |
Find out how many bytes of audio data there are.
|
virtual |
Find out the format of the WAV file.
Eg 0x01 for PCM, 0x42 or 0x111 for G.723.1.
|
virtual |
|
inline |
Return a string that describes the WAV format.
References formatHandler, and PWAVFileFormat::GetFormatString().
off_t PWAVFile::GetHeaderLength | ( | ) | const |
Find out the size of WAV header presented in the file.
|
virtual |
Get the current active position in the file for the next read or write operation.
The WAV header is excluded from calculation the position.
Reimplemented from PFile.
|
virtual |
Find out the sample rate of the WAV file in Hz.
|
virtual |
Find out how may bits there are per sample, eg 8 or 16.
|
inline |
Determine if the WAV file is a valid wave file.
References isValidWAV.
|
virtual |
Open the current file in the specified mode and with the specified options.
If the file object already has an open file then it is closed.
If there has not been a filename attached to the file object (via SetFilePath()
, the name
parameter in the constructor or a previous open) then a new unique temporary filename is generated.
mode | Mode in which to open the file. |
opts | Options for open operation. |
Reimplemented from PFile.
|
virtual |
Open the specified WAV file name in the specified mode and with the specified options.
If the file object already has an open file then it is closed. This reads (and validates) the header for existing files. For new files, it creates a new file (and header) using the type of WAV file specified in the class constructor.
Note: if mode
is StandardInput, StandardOutput or StandardError, then the name
parameter is ignored.
name | Name of file to open. |
mode | Mode in which to open the file. |
opts | OpenOptions enum for open operation. |
Reimplemented from PFile.
|
protected |
off_t PWAVFile::RawGetDataLength | ( | ) |
off_t PWAVFile::RawGetPosition | ( | ) | const |
PBoolean PWAVFile::RawRead | ( | void * | buf, |
PINDEX | len | ||
) |
PBoolean PWAVFile::RawSetPosition | ( | off_t | pos, |
FilePositionOrigin | origin | ||
) |
PBoolean PWAVFile::RawWrite | ( | const void * | buf, |
PINDEX | len | ||
) |
|
virtual |
Call PFile::Read() to read in audio data and perform necessary processing such as byte-order swaping.
buf | Pointer to a block of memory to receive the read bytes. |
len | Maximum number of bytes to read into the buffer. |
Reimplemented from PFile.
|
protected |
|
protected |
void PWAVFile::SetAutoconvert | ( | ) |
Enable autoconversion between PCM-16 and the native format.
|
virtual |
|
virtual |
|
virtual |
Find out the format of the WAV file.
Eg 0x01 for PCM, 0x42 or 0x111 for G.723.1.
|
inline |
References PChannel::lastReadCount.
|
inline |
References PChannel::lastWriteCount.
|
virtual |
Set the current active position in the file for the next read or write operation.
The pos
variable is a signed number which is added to the specified origin. For origin
== PFile::Start only positive values for pos
are meaningful. For origin
== PFile::End only negative values for pos
are meaningful.
Note that for a WAV file, the origin of the file is right after the header. That is, the WAV header is not included when perform SetPosition().
pos | New position to set. |
origin | Origin for position change. |
Reimplemented from PFile.
|
virtual |
|
virtual |
|
protected |
|
virtual |
Call PFile::Write() to write out audio data and perform necessary processing such as byte-order swaping.
buf | Pointer to a block of memory to receive the write bytes. |
len | Maximum number of bytes to write to the channel. |
Reimplemented from PFile.
|
protected |
|
protected |
|
protected |
|
protected |
Referenced by GetFormatString().
|
protected |
|
protected |
Referenced by IsValid().
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |