![]() |
Miam-Player
0.8.0
A nice music player
|
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 } |
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 an MPEG file from file. More... | |
File (FileName file, ID3v2::FrameFactory *frameFactory, bool readProperties=true, Properties::ReadStyle propertiesStyle=Properties::Average) | |
Constructs an MPEG file from file. More... | |
File (IOStream *stream, ID3v2::FrameFactory *frameFactory, bool readProperties=true, Properties::ReadStyle propertiesStyle=Properties::Average) | |
Constructs an MPEG file from stream. More... | |
virtual | ~File () |
Destroys this instance of the File. More... | |
virtual Tag * | tag () const |
Returns a pointer to a tag that is the union of the ID3v2 and ID3v1 tags. More... | |
PropertyMap | properties () const |
Implements the reading part of the unified property interface. More... | |
void | removeUnsupportedProperties (const StringList &properties) |
PropertyMap | setProperties (const PropertyMap &) |
Implements the writing part of the unified tag dictionary interface. More... | |
virtual Properties * | audioProperties () const |
Returns the MPEG::Properties for this file. More... | |
virtual bool | save () |
Save the file. More... | |
bool | save (int tags) |
Save the file. More... | |
bool | save (int tags, bool stripOthers) |
Save the file. More... | |
bool | save (int tags, bool stripOthers, int id3v2Version) |
Save the file. More... | |
bool | save (int tags, bool stripOthers, int id3v2Version, bool duplicateTags) |
Save the file. More... | |
ID3v2::Tag * | ID3v2Tag (bool create=false) |
Returns a pointer to the ID3v2 tag of the file. More... | |
ID3v1::Tag * | ID3v1Tag (bool create=false) |
Returns a pointer to the ID3v1 tag of the file. More... | |
APE::Tag * | APETag (bool create=false) |
Returns a pointer to the APE tag of the file. More... | |
bool | strip (int tags=AllTags) |
This will strip the tags that match the OR-ed together TagTypes from the file. More... | |
bool | strip (int tags, bool freeMemory) |
This will strip the tags that match the OR-ed together TagTypes from the file. More... | |
void | setID3v2FrameFactory (const ID3v2::FrameFactory *factory) |
Set the ID3v2::FrameFactory to something other than the default. More... | |
long | firstFrameOffset () |
Returns the position in the file of the first MPEG frame. More... | |
long | nextFrameOffset (long position) |
Returns the position in the file of the next MPEG frame, using the current position as start. More... | |
long | previousFrameOffset (long position) |
Returns the position in the file of the previous MPEG frame, using the current position as start. More... | |
long | lastFrameOffset () |
Returns the position in the file of the last MPEG frame. 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... | |
bool | hasAPETag () const |
Returns whether or not the file on disk actually has an APE 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 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.
void TagLib::MPEG::File::removeUnsupportedProperties | ( | const StringList & | properties | ) |
|
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 parameterized 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.
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.