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

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

#include <trueaudiofile.h>

Inheritance diagram for TagLib::TrueAudio::File:
TagLib::File

Public Types

enum  TagTypes { NoTags = 0x0000, ID3v1 = 0x0001, ID3v2 = 0x0002, AllTags = 0xffff }
 This set of flags is used for various operations and is suitable for being OR-ed together. More...
 
- 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 TrueAudio file from file. More...
 
 File (FileName file, ID3v2::FrameFactory *frameFactory, bool readProperties=true, Properties::ReadStyle propertiesStyle=Properties::Average)
 Constructs a TrueAudio file from file. More...
 
 File (IOStream *stream, bool readProperties=true, Properties::ReadStyle propertiesStyle=Properties::Average)
 Constructs a TrueAudio file from stream. More...
 
 File (IOStream *stream, ID3v2::FrameFactory *frameFactory, bool readProperties=true, Properties::ReadStyle propertiesStyle=Properties::Average)
 Constructs a TrueAudio file from stream. More...
 
virtual ~File ()
 Destroys this instance of the File. More...
 
virtual TagLib::Tagtag () const
 Returns the Tag for this file. More...
 
PropertyMap properties () const
 Implements the unified property interface – export function. More...
 
PropertyMap setProperties (const PropertyMap &)
 Implements the unified property interface – import function. More...
 
void removeUnsupportedProperties (const StringList &properties)
 
virtual PropertiesaudioProperties () const
 Returns the TrueAudio::Properties for this file. More...
 
void setID3v2FrameFactory (const ID3v2::FrameFactory *factory)
 Set the ID3v2::FrameFactory to something other than the default. More...
 
virtual bool save ()
 Saves the file. More...
 
ID3v1::TagID3v1Tag (bool create=false)
 Returns a pointer to the ID3v1 tag of the file. More...
 
ID3v2::TagID3v2Tag (bool create=false)
 Returns a pointer to the ID3v2 tag of the file. More...
 
void strip (int tags=AllTags)
 This will remove the tags that match the OR-ed together TagTypes from the file. More...
 
bool hasID3v1Tag () const
 Returns whether or not the file on disk actually has an ID3v1 tag. More...
 
bool hasID3v2Tag () const
 Returns whether or not the file on disk actually has an ID3v2 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...
 

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 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 TrueAudio specific methods.

This implements and provides an interface for TrueAudio 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 TrueAudio files.

Member Enumeration Documentation

This set of flags is used for various operations and is suitable for being OR-ed together.

Enumerator
NoTags 

Empty set. Matches no tag types.

ID3v1 

Matches ID3v1 tags.

ID3v2 

Matches ID3v2 tags.

AllTags 

Matches all tag types.

Constructor & Destructor Documentation

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

Constructs a TrueAudio 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::TrueAudio::File::File ( FileName  file,
ID3v2::FrameFactory frameFactory,
bool  readProperties = true,
Properties::ReadStyle  propertiesStyle = Properties::Average 
)

Constructs a TrueAudio file from file.

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

If this file contains and ID3v2 tag the frames will be created using frameFactory.

Note
In the current implementation, propertiesStyle is ignored.
TagLib::TrueAudio::File::File ( IOStream stream,
bool  readProperties = true,
Properties::ReadStyle  propertiesStyle = Properties::Average 
)

Constructs a TrueAudio 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.
TagLib::TrueAudio::File::File ( IOStream stream,
ID3v2::FrameFactory frameFactory,
bool  readProperties = true,
Properties::ReadStyle  propertiesStyle = Properties::Average 
)

Constructs a TrueAudio 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.

If this file contains and ID3v2 tag the frames will be created using frameFactory.

Note
In the current implementation, propertiesStyle is ignored.
virtual TagLib::TrueAudio::File::~File ( )
virtual

Destroys this instance of the File.

Reimplemented from TagLib::File.

Member Function Documentation

virtual Properties* TagLib::TrueAudio::File::audioProperties ( ) const
virtual

Returns the TrueAudio::Properties for this file.

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

Implements TagLib::File.

bool TagLib::TrueAudio::File::hasID3v1Tag ( ) const

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

See also
ID3v1Tag()
bool TagLib::TrueAudio::File::hasID3v2Tag ( ) const

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

See also
ID3v2Tag()
ID3v1::Tag* TagLib::TrueAudio::File::ID3v1Tag ( bool  create = false)

Returns a pointer to the ID3v1 tag of the file.

If create is false (the default) this may return a null pointer if there is no valid ID3v1 tag. If create is true it will create an ID3v1 tag if one does not exist and returns a valid pointer.

Note
This may return a valid pointer regardless of whether or not the file on disk has an ID3v1 tag. Use hasID3v1Tag() to check if the file on disk actually has an ID3v1 tag.
The Tag is still owned by the MPEG::File and should not be deleted by the user. It will be deleted when the file (object) is destroyed.
See also
hasID3v1Tag()
ID3v2::Tag* TagLib::TrueAudio::File::ID3v2Tag ( bool  create = false)

Returns a pointer to the ID3v2 tag of the file.

If create is false (the default) this may return a null pointer if there is no valid ID3v2 tag. If create is true it will create an ID3v2 tag if one does not exist and returns a valid pointer.

Note
This may return 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.
The Tag is still owned by the MPEG::File and should not be deleted by the user. It will be deleted when the file (object) is destroyed.
See also
hasID3v2Tag()
PropertyMap TagLib::TrueAudio::File::properties ( ) const

Implements the unified property interface – export function.

If the file contains both ID3v1 and v2 tags, only ID3v2 will be converted to the PropertyMap.

void TagLib::TrueAudio::File::removeUnsupportedProperties ( const StringList properties)
virtual bool TagLib::TrueAudio::File::save ( )
virtual

Saves the file.

Implements TagLib::File.

void TagLib::TrueAudio::File::setID3v2FrameFactory ( const ID3v2::FrameFactory factory)

Set the ID3v2::FrameFactory to something other than the default.

See also
ID3v2FrameFactory
Deprecated:
This value should be passed in via the constructor
PropertyMap TagLib::TrueAudio::File::setProperties ( const PropertyMap )

Implements the unified property interface – import function.

Creates in ID3v2 tag if necessary. If an ID3v1 tag exists, it will be updated as well, within the limitations of ID3v1.

void TagLib::TrueAudio::File::strip ( int  tags = AllTags)

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

By default it removes all tags.

Note
This will also invalidate pointers to the tags as their memory will be freed.
In order to make the removal permanent save() still needs to be called
virtual TagLib::Tag* TagLib::TrueAudio::File::tag ( ) const
virtual

Returns the Tag for this file.

Implements TagLib::File.


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