An implementation of TagLib::File with WAV specific methods. More...

#include <wavfile.h>

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

Public Types
enum	TagTypes { NoTags = 0x0000, ID3v2 = 0x0001, Info = 0x0002, AllTags = 0xffff }

Public Types inherited from TagLib::File
enum	Position { Beginning, Current, End }
	Position in the file used for seeking. More...

Public Member Functions
	File (FileName file, bool readProperties=true, Properties::ReadStyle propertiesStyle=Properties::Average)
	Constructs a WAV file from file. More...

	File (IOStream *stream, bool readProperties=true, Properties::ReadStyle propertiesStyle=Properties::Average)
	Constructs a WAV file from stream. More...

virtual	~File ()
	Destroys this instance of the File. More...

ID3v2::Tag *	tag () const
	Returns the ID3v2 Tag for this file. More...

ID3v2::Tag *	ID3v2Tag () const
	Returns the ID3v2 Tag for this file. More...

Info::Tag *	InfoTag () const
	Returns the RIFF INFO Tag for this file. More...

void	strip (TagTypes tags=AllTags)
	This will strip the tags that match the OR-ed together TagTypes from the file. More...

PropertyMap	properties () const
	Implements the unified property interface – export function. More...

void	removeUnsupportedProperties (const StringList &properties)

PropertyMap	setProperties (const PropertyMap &)
	Implements the unified property interface – import function. More...

virtual Properties *	audioProperties () const
	Returns the WAV::Properties for this file. More...

virtual bool	save ()
	Saves the file. More...

bool	save (TagTypes tags, bool stripOthers=true, int id3v2Version=4)

bool	hasID3v2Tag () const
	Returns whether or not the file on disk actually has an ID3v2 tag. More...

bool	hasInfoTag () const
	Returns whether or not the file on disk actually has a RIFF INFO tag. More...

Public Member Functions inherited from TagLib::File
FileName	name () const
	Returns the file name in the local file system encoding. 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...

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

Friends
class	Properties

Additional Inherited Members
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...

Protected Types inherited from TagLib::RIFF::File
enum	Endianness { BigEndian, LittleEndian }

Protected Member Functions inherited from TagLib::RIFF::File
	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...

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 implementation of TagLib::File with WAV specific methods.

This implements and provides an interface for WAV files to the TagLib::Tag and TagLib::AudioProperties interfaces by way of implementing the abstract TagLib::File API as well as providing some additional information specific to WAV files.

Member Enumeration Documentation

enum TagLib::RIFF::WAV::File::TagTypes

Enumerator
NoTags	Empty set. Matches no tag types.
ID3v2	Matches ID3v2 tags.
Info	Matches INFO tags.
AllTags	Matches all tag types.

Constructor & Destructor Documentation

TagLib::RIFF::WAV::File::File	(	FileName	file,
		bool	readProperties = `true`,
		Properties::ReadStyle	propertiesStyle = `Properties::Average`
	)

Constructs a WAV file from file.

If readProperties is true the file's audio properties will also be read.

Note: In the current implementation, propertiesStyle is ignored.

TagLib::RIFF::WAV::File::File	(	IOStream *	stream,
		bool	readProperties = `true`,
		Properties::ReadStyle	propertiesStyle = `Properties::Average`
	)

Constructs a WAV file from stream.

If readProperties is true the file's audio properties will also be read.

Note: TagLib will not take ownership of the stream, the caller is responsible for deleting it after the File object.; In the current implementation, propertiesStyle is ignored.

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

virtual

Destroys this instance of the File.

Reimplemented from TagLib::RIFF::File.

Member Function Documentation

virtual Properties* TagLib::RIFF::WAV::File::audioProperties ( ) const

virtual

Returns the WAV::Properties for this file.

If no audio properties were read then this will return a null pointer.

Implements TagLib::File.

bool TagLib::RIFF::WAV::File::hasID3v2Tag ( ) const

Returns whether or not the file on disk actually has an ID3v2 tag.

See also: ID3v2Tag()

bool TagLib::RIFF::WAV::File::hasInfoTag ( ) const

Returns whether or not the file on disk actually has a RIFF INFO tag.

See also: InfoTag()

ID3v2::Tag* TagLib::RIFF::WAV::File::ID3v2Tag ( ) const

Returns the ID3v2 Tag for this file.

Note: This always returns a valid pointer regardless of whether or not the file on disk has an ID3v2 tag. Use hasID3v2Tag() to check if the file on disk actually has an ID3v2 tag.

See also: hasID3v2Tag()

Info::Tag* TagLib::RIFF::WAV::File::InfoTag ( ) const

Returns the RIFF INFO Tag for this file.

Note: This always returns a valid pointer regardless of whether or not the file on disk has a RIFF INFO tag. Use hasInfoTag() to check if the file on disk actually has a RIFF INFO tag.

See also: hasInfoTag()

PropertyMap TagLib::RIFF::WAV::File::properties ( ) const

Implements the unified property interface – export function.

This method forwards to ID3v2::Tag::properties().

void TagLib::RIFF::WAV::File::removeUnsupportedProperties ( const StringList & properties )

virtual bool TagLib::RIFF::WAV::File::save ( )

virtual

Saves the file.

Implements TagLib::File.

bool TagLib::RIFF::WAV::File::save	(	TagTypes	tags,
		bool	stripOthers = `true`,
		int	id3v2Version = `4`
	)

PropertyMap TagLib::RIFF::WAV::File::setProperties ( const PropertyMap & )

Implements the unified property interface – import function.

This method forwards to ID3v2::Tag::setProperties().

void TagLib::RIFF::WAV::File::strip ( TagTypes tags = AllTags )

This will strip the tags that match the OR-ed together TagTypes from the file.

By default it strips all tags. It returns true if the tags are successfully stripped.

Note: This will update the file immediately.

ID3v2::Tag* TagLib::RIFF::WAV::File::tag ( ) const

virtual

Returns the ID3v2 Tag for this file.

Note: This method does not return all the tags for this file for backward compatibility. Will be fixed in TagLib 2.0.

Implements TagLib::File.

Friends And Related Function Documentation

friend class Properties

friend

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

src/core/3rdparty/taglib/wavfile.h

Public Types

Public Member Functions

Friends

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation