![]() |
Miam-Player
0.8.0
A nice music player
|
An implementation of TagLib::File with TrueAudio specific methods. More...
#include <trueaudiofile.h>
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... | |
![]() | |
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::Tag * | tag () 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 Properties * | audioProperties () 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::Tag * | ID3v1Tag (bool create=false) |
Returns a pointer to the ID3v1 tag of the file. More... | |
ID3v2::Tag * | ID3v2Tag (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... | |
![]() | |
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 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... | |
![]() | |
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 unsigned int | bufferSize () |
Returns the buffer size that is used for internal buffering. More... | |
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.
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.
TagLib::TrueAudio::File::File | ( | FileName | file, |
ID3v2::FrameFactory * | frameFactory, | ||
bool | readProperties = true , |
||
Properties::ReadStyle | propertiesStyle = Properties::Average |
||
) |
TagLib::TrueAudio::File::File | ( | IOStream * | stream, |
bool | readProperties = true , |
||
Properties::ReadStyle | propertiesStyle = Properties::Average |
||
) |
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.
If this file contains and ID3v2 tag the frames will be created using frameFactory.
|
virtual |
Destroys this instance of the File.
Reimplemented from TagLib::File.
|
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.
bool TagLib::TrueAudio::File::hasID3v2Tag | ( | ) | const |
Returns whether or not the file on disk actually has an ID3v2 tag.
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.
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.
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 |
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.
PropertyMap TagLib::TrueAudio::File::setProperties | ( | const PropertyMap & | ) |
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.
|
virtual |
Returns the Tag for this file.
Implements TagLib::File.