![]() |
|
An MPEG file class with some useful methods specific to MPEG. More...
#include <mpegfile.h>
Public Types | |
enum | TagTypes { NoTags = 0x0000, ID3v1 = 0x0001, ID3v2 = 0x0002, APE = 0x0004, AllTags = 0xffff } |
![]() | |
enum | Position { Beginning, Current, End } |
Public Member Functions | |
File (FileName file, bool readProperties=true, Properties::ReadStyle propertiesStyle=Properties::Average) | |
File (FileName file, ID3v2::FrameFactory *frameFactory, bool readProperties=true, Properties::ReadStyle propertiesStyle=Properties::Average) | |
File (IOStream *stream, ID3v2::FrameFactory *frameFactory, bool readProperties=true, Properties::ReadStyle propertiesStyle=Properties::Average) | |
virtual | ~File () |
virtual Tag * | tag () const |
PropertyMap | properties () const |
void | removeUnsupportedProperties (const StringList &properties) |
PropertyMap | setProperties (const PropertyMap &) |
virtual Properties * | audioProperties () const |
virtual bool | save () |
bool | save (int tags) |
bool | save (int tags, bool stripOthers) |
bool | save (int tags, bool stripOthers, int id3v2Version) |
bool | save (int tags, bool stripOthers, int id3v2Version, bool duplicateTags) |
ID3v2::Tag * | ID3v2Tag (bool create=false) |
ID3v1::Tag * | ID3v1Tag (bool create=false) |
APE::Tag * | APETag (bool create=false) |
bool | strip (int tags=AllTags) |
bool | strip (int tags, bool freeMemory) |
void | setID3v2FrameFactory (const ID3v2::FrameFactory *factory) |
long | firstFrameOffset () |
long | nextFrameOffset (long position) |
long | previousFrameOffset (long position) |
long | lastFrameOffset () |
bool | hasID3v1Tag () const |
bool | hasID3v2Tag () const |
bool | hasAPETag () const |
![]() | |
FileName | name () const |
ByteVector | readBlock (ulong length) |
void | writeBlock (const ByteVector &data) |
long | find (const ByteVector &pattern, long fromOffset=0, const ByteVector &before=ByteVector::null) |
long | rfind (const ByteVector &pattern, long fromOffset=0, const ByteVector &before=ByteVector::null) |
void | insert (const ByteVector &data, ulong start=0, ulong replace=0) |
void | removeBlock (ulong start=0, ulong length=0) |
bool | readOnly () const |
bool | isOpen () const |
bool | isValid () const |
void | seek (long offset, Position p=Beginning) |
void | clear () |
long | tell () const |
long | length () |
Additional Inherited Members | |
![]() | |
static bool | isReadable (const char *file) |
static bool | isWritable (const char *name) |
![]() | |
File (FileName file) | |
File (IOStream *stream) | |
void | setValid (bool valid) |
void | truncate (long length) |
![]() | |
static uint | bufferSize () |
An MPEG file class with some useful methods specific to MPEG.
This implements the generic TagLib::File API and additionally provides access to properties that are distinct to MPEG files, notably access to the different ID3 tags.
TagLib::MPEG::File::File | ( | FileName | file, |
bool | readProperties = true , |
||
Properties::ReadStyle | propertiesStyle = Properties::Average |
||
) |
Constructs an MPEG file from file. If readProperties is true the file's audio properties will also be read.
TagLib::MPEG::File::File | ( | FileName | file, |
ID3v2::FrameFactory * | frameFactory, | ||
bool | readProperties = true , |
||
Properties::ReadStyle | propertiesStyle = Properties::Average |
||
) |
TagLib::MPEG::File::File | ( | IOStream * | stream, |
ID3v2::FrameFactory * | frameFactory, | ||
bool | readProperties = true , |
||
Properties::ReadStyle | propertiesStyle = Properties::Average |
||
) |
Constructs an MPEG 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.
APE::Tag* TagLib::MPEG::File::APETag | ( | bool | create = false | ) |
Returns a pointer to the APE tag of the file.
If create is false (the default) this may return a null pointer if there is no valid APE tag. If create is true it will create an APE tag if one does not exist and returns a valid pointer.
|
virtual |
Returns the MPEG::Properties for this file. If no audio properties were read then this will return a null pointer.
Implements TagLib::File.
long TagLib::MPEG::File::firstFrameOffset | ( | ) |
Returns the position in the file of the first MPEG frame.
bool TagLib::MPEG::File::hasAPETag | ( | ) | const |
bool TagLib::MPEG::File::hasID3v1Tag | ( | ) | const |
Returns whether or not the file on disk actually has an ID3v1 tag.
bool TagLib::MPEG::File::hasID3v2Tag | ( | ) | const |
Returns whether or not the file on disk actually has an ID3v2 tag.
ID3v1::Tag* TagLib::MPEG::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::MPEG::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.
long TagLib::MPEG::File::lastFrameOffset | ( | ) |
Returns the position in the file of the last MPEG frame.
long TagLib::MPEG::File::nextFrameOffset | ( | long | position | ) |
Returns the position in the file of the next MPEG frame, using the current position as start
long TagLib::MPEG::File::previousFrameOffset | ( | long | position | ) |
Returns the position in the file of the previous MPEG frame, using the current position as start
PropertyMap TagLib::MPEG::File::properties | ( | ) | const |
Implements the reading part of the unified property interface. If the file contains more than one tag, only the first one (in the order ID3v2, APE, ID3v1) will be converted to the PropertyMap.
Reimplemented from TagLib::File.
void TagLib::MPEG::File::removeUnsupportedProperties | ( | const StringList & | properties | ) |
Removes unsupported properties, or a subset of them, from the file's metadata. The parameter properties must contain only entries from properties().unsupportedData(). BIC: Will be mad virtual in future releases.
Reimplemented from TagLib::File.
|
virtual |
Save the file. If at least one tag – ID3v1 or ID3v2 – exists this will duplicate its content into the other tag. This returns true if saving was successful.
If neither exists or if both tags are empty, this will strip the tags from the file.
This is the same as calling save(AllTags);
If you would like more granular control over the content of the tags, with the concession of generality, use paramaterized save call below.
Implements TagLib::File.
bool TagLib::MPEG::File::save | ( | int | tags | ) |
Save the file. This will attempt to save all of the tag types that are specified by OR-ing together TagTypes values. The save() method above uses AllTags. This returns true if saving was successful.
This strips all tags not included in the mask, but does not modify them in memory, so later calls to save() which make use of these tags will remain valid. This also strips empty tags.
bool TagLib::MPEG::File::save | ( | int | tags, |
bool | stripOthers | ||
) |
Save the file. This will attempt to save all of the tag types that are specified by OR-ing together TagTypes values. The save() method above uses AllTags. This returns true if saving was successful.
If stripOthers is true this strips all tags not included in the mask, but does not modify them in memory, so later calls to save() which make use of these tags will remain valid. This also strips empty tags.
bool TagLib::MPEG::File::save | ( | int | tags, |
bool | stripOthers, | ||
int | id3v2Version | ||
) |
Save the file. This will attempt to save all of the tag types that are specified by OR-ing together TagTypes values. The save() method above uses AllTags. This returns true if saving was successful.
If stripOthers is true this strips all tags not included in the mask, but does not modify them in memory, so later calls to save() which make use of these tags will remain valid. This also strips empty tags.
The id3v2Version parameter specifies the version of the saved ID3v2 tag. It can be either 4 or 3.
bool TagLib::MPEG::File::save | ( | int | tags, |
bool | stripOthers, | ||
int | id3v2Version, | ||
bool | duplicateTags | ||
) |
Save the file. This will attempt to save all of the tag types that are specified by OR-ing together TagTypes values. The save() method above uses AllTags. This returns true if saving was successful.
If stripOthers is true this strips all tags not included in the mask, but does not modify them in memory, so later calls to save() which make use of these tags will remain valid. This also strips empty tags.
The id3v2Version parameter specifies the version of the saved ID3v2 tag. It can be either 4 or 3.
If duplicateTags is true and at least one tag – ID3v1 or ID3v2 – exists this will duplicate its content into the other tag.
void TagLib::MPEG::File::setID3v2FrameFactory | ( | const ID3v2::FrameFactory * | factory | ) |
Set the ID3v2::FrameFactory to something other than the default.
PropertyMap TagLib::MPEG::File::setProperties | ( | const PropertyMap & | ) |
Implements the writing part of the unified tag dictionary interface. In order to avoid problems with deprecated tag formats, this method always creates an ID3v2 tag if necessary. If an ID3v1 tag exists, it will be updated as well, within the limitations of that format. The returned PropertyMap refers to the ID3v2 tag only.
Reimplemented from TagLib::File.
bool TagLib::MPEG::File::strip | ( | int | 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.
This is equivalent to strip(tags, true)
bool TagLib::MPEG::File::strip | ( | int | tags, |
bool | freeMemory | ||
) |
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.
If freeMemory is true the ID3 and APE tags will be deleted and pointers to them will be invalidated.
|
virtual |
Returns a pointer to a tag that is the union of the ID3v2 and ID3v1 tags. The ID3v2 tag is given priority in reading the information – if requested information exists in both the ID3v2 tag and the ID3v1 tag, the information from the ID3v2 tag will be returned.
If you would like more granular control over the content of the tags, with the concession of generality, use the tag-type specific calls.
Implements TagLib::File.