Miam-Player  0.8.0
A nice music player
TagLib::RIFF::File Class Reference

An RIFF file class with some useful methods specific to RIFF. More...

#include <rifffile.h>

Inheritance diagram for TagLib::RIFF::File:
TagLib::File TagLib::RIFF::AIFF::File TagLib::RIFF::WAV::File

Public Member Functions

virtual ~File ()
 Destroys this instance of the File. More...
 
- Public Member Functions inherited from TagLib::File
FileName name () const
 Returns the file name in the local file system encoding. More...
 
virtual Tagtag () const =0
 Returns a pointer to this file's tag. More...
 
PropertyMap properties () const
 Exports the tags of the file as dictionary mapping (human readable) tag names (uppercase Strings) to StringLists of tag values. More...
 
void removeUnsupportedProperties (const StringList &properties)
 Removes unsupported properties, or a subset of them, from the file's metadata. More...
 
PropertyMap setProperties (const PropertyMap &properties)
 Sets the tags of this File to those specified in properties. More...
 
virtual AudioPropertiesaudioProperties () const =0
 Returns a pointer to this file's audio properties. More...
 
virtual bool save ()=0
 Save the file and its associated tags. More...
 
ByteVector readBlock (unsigned long length)
 Reads a block of size length at the current get pointer. More...
 
void writeBlock (const ByteVector &data)
 Attempts to write the block data at the current get pointer. More...
 
long find (const ByteVector &pattern, long fromOffset=0, const ByteVector &before=ByteVector())
 Returns the offset in the file that pattern occurs at or -1 if it can not be found. More...
 
long rfind (const ByteVector &pattern, long fromOffset=0, const ByteVector &before=ByteVector())
 Returns the offset in the file that pattern occurs at or -1 if it can not be found. More...
 
void insert (const ByteVector &data, unsigned long start=0, unsigned long replace=0)
 Insert data at position start in the file overwriting replace bytes of the original content. More...
 
void removeBlock (unsigned long start=0, unsigned long length=0)
 Removes a block of the file starting a start and continuing for length bytes. More...
 
bool readOnly () const
 Returns true if the file is read only (or if the file can not be opened). More...
 
bool isOpen () const
 Since the file can currently only be opened as an argument to the constructor (sort-of by design), this returns if that open succeeded. More...
 
bool isValid () const
 Returns true if the file is open and readable. More...
 
void seek (long offset, Position p=Beginning)
 Move the I/O pointer to offset in the file from position p. More...
 
void clear ()
 Reset the end-of-file and error flags on the file. More...
 
long tell () const
 Returns the current offset within the file. More...
 
long length ()
 Returns the length of the file. More...
 

Protected Types

enum  Endianness { BigEndian, LittleEndian }
 

Protected Member Functions

 File (FileName file, Endianness endianness)
 
 File (IOStream *stream, Endianness endianness)
 
unsigned int riffSize () const
 
unsigned int chunkCount () const
 
unsigned int chunkOffset (unsigned int i) const
 
unsigned int chunkDataSize (unsigned int i) const
 
unsigned int chunkPadding (unsigned int i) const
 
ByteVector chunkName (unsigned int i) const
 
ByteVector chunkData (unsigned int i)
 Reads the chunk data from the file and returns it. More...
 
void setChunkData (unsigned int i, const ByteVector &data)
 Sets the data for the specified chunk to data. More...
 
void setChunkData (const ByteVector &name, const ByteVector &data)
 Sets the data for the chunk name to data. More...
 
void setChunkData (const ByteVector &name, const ByteVector &data, bool alwaysCreate)
 Sets the data for the chunk name to data. More...
 
void removeChunk (unsigned int i)
 Removes the specified chunk. More...
 
void removeChunk (const ByteVector &name)
 Removes the chunk name. More...
 
- Protected Member Functions inherited from TagLib::File
 File (FileName file)
 Construct a File object and opens the file. More...
 
 File (IOStream *stream)
 Construct a File object and use the stream instance. More...
 
void setValid (bool valid)
 Marks the file as valid or invalid. More...
 
void truncate (long length)
 Truncates the file to a length. More...
 

Additional Inherited Members

- Public Types inherited from TagLib::File
enum  Position { Beginning, Current, End }
 Position in the file used for seeking. More...
 
- Static Public Member Functions inherited from TagLib::File
static bool isReadable (const char *file)
 Returns true if file can be opened for reading. More...
 
static bool isWritable (const char *name)
 Returns true if file can be opened for writing. More...
 
- Static Protected Member Functions inherited from TagLib::File
static unsigned int bufferSize ()
 Returns the buffer size that is used for internal buffering. More...
 

Detailed Description

An RIFF file class with some useful methods specific to RIFF.

This implements the generic TagLib::File API and additionally provides access to properties that are distinct to RIFF files, notably access to the different ID3 tags.

Member Enumeration Documentation

Enumerator
BigEndian 
LittleEndian 

Constructor & Destructor Documentation

virtual TagLib::RIFF::File::~File ( )
virtual

Destroys this instance of the File.

Reimplemented from TagLib::File.

Reimplemented in TagLib::RIFF::WAV::File, and TagLib::RIFF::AIFF::File.

TagLib::RIFF::File::File ( FileName  file,
Endianness  endianness 
)
protected
TagLib::RIFF::File::File ( IOStream stream,
Endianness  endianness 
)
protected

Member Function Documentation

unsigned int TagLib::RIFF::File::chunkCount ( ) const
protected
Returns
The number of chunks in the file.
ByteVector TagLib::RIFF::File::chunkData ( unsigned int  i)
protected

Reads the chunk data from the file and returns it.

Note
This will move the read pointer for the file.
unsigned int TagLib::RIFF::File::chunkDataSize ( unsigned int  i) const
protected
Returns
The size of the chunk data.
ByteVector TagLib::RIFF::File::chunkName ( unsigned int  i) const
protected
Returns
The name of the specified chunk, for instance, "COMM" or "ID3 "
unsigned int TagLib::RIFF::File::chunkOffset ( unsigned int  i) const
protected
Returns
The offset within the file for the selected chunk number.
unsigned int TagLib::RIFF::File::chunkPadding ( unsigned int  i) const
protected
Returns
The size of the padding after the chunk (can be either 0 or 1).
void TagLib::RIFF::File::removeChunk ( unsigned int  i)
protected

Removes the specified chunk.

Warning
This will update the file immediately.
void TagLib::RIFF::File::removeChunk ( const ByteVector name)
protected

Removes the chunk name.

Warning
This will update the file immediately.
This removes all the chunks with the given name.
unsigned int TagLib::RIFF::File::riffSize ( ) const
protected
Returns
The size of the main RIFF chunk.
void TagLib::RIFF::File::setChunkData ( unsigned int  i,
const ByteVector data 
)
protected

Sets the data for the specified chunk to data.

Warning
This will update the file immediately.
void TagLib::RIFF::File::setChunkData ( const ByteVector name,
const ByteVector data 
)
protected

Sets the data for the chunk name to data.

If a chunk with the given name already exists it will be overwritten, otherwise it will be created after the existing chunks.

Warning
This will update the file immediately.
void TagLib::RIFF::File::setChunkData ( const ByteVector name,
const ByteVector data,
bool  alwaysCreate 
)
protected

Sets the data for the chunk name to data.

If a chunk with the given name already exists it will be overwritten, otherwise it will be created after the existing chunks.

Note
If alwaysCreate is true, a new chunk is created regardless of whether or not the chunk name exists. It should only be used for "LIST" chunks.
Warning
This will update the file immediately.

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