![]() |
|
#include <id3v2tag.h>
Public Member Functions | |
Tag () | |
Tag (File *file, long tagOffset, const FrameFactory *factory=FrameFactory::instance()) | |
virtual | ~Tag () |
virtual String | title () const |
virtual String | artist () const |
virtual String | album () const |
virtual String | comment () const |
virtual String | genre () const |
virtual uint | year () const |
virtual uint | track () const |
virtual void | setTitle (const String &s) |
virtual void | setArtist (const String &s) |
virtual void | setAlbum (const String &s) |
virtual void | setComment (const String &s) |
virtual void | setGenre (const String &s) |
virtual void | setYear (uint i) |
virtual void | setTrack (uint i) |
virtual bool | isEmpty () const |
Header * | header () const |
ExtendedHeader * | extendedHeader () const |
Footer * | footer () const |
const FrameListMap & | frameListMap () const |
const FrameList & | frameList () const |
const FrameList & | frameList (const ByteVector &frameID) const |
void | addFrame (Frame *frame) |
void | removeFrame (Frame *frame, bool del=true) |
void | removeFrames (const ByteVector &id) |
ByteVector | render () const |
Protected Member Functions | |
void | read () |
void | parse (const ByteVector &data) |
void | setTextFrame (const ByteVector &id, const String &value) |
This is the main class in the ID3v2 implementation. It serves two functions. This first, as is obvious from the public API, is to provide a container for the other ID3v2 related classes. In addition, through the read() and parse() protected methods, it provides the most basic level of parsing. In these methods the ID3v2 tag is extracted from the file and split into data components.
ID3v2 tags have several parts, TagLib attempts to provide an interface for them all. header(), footer() and extendedHeader() corespond to those data structures in the ID3v2 standard and the APIs for the classes that they return attempt to reflect this.
Also ID3v2 tags are built up from a list of frames, which are in turn have a header and a list of fields. TagLib provides two ways of accessing the list of frames that are in a given ID3v2 tag. The first is simply via the frameList() method. This is just a list of pointers to the frames. The second is a map from the frame type -- i.e. "COMM" for comments -- and a list of frames of that type. (In some cases ID3v2 allows for multiple frames of the same type, hence this being a map to a list rather than just a map to an individual frame.)
More information on the structure of frames can be found in the ID3v2::Frame class.
read() and parse() pass binary data to the other ID3v2 class structures, they do not handle parsing of flags or fields, for instace. Those are handled by similar functions within those classes.
TagLib::ID3v2::Tag::Tag | ( | ) |
Constructs an empty ID3v2 tag.
Reimplemented from TagLib::Tag.
TagLib::ID3v2::Tag::Tag | ( | File * | file, | |
long | tagOffset, | |||
const FrameFactory * | factory = FrameFactory::instance() | |||
) |
Constructs an ID3v2 tag read from file starting at tagOffset. factory specifies which FrameFactory will be used for the construction of new frames.
virtual TagLib::ID3v2::Tag::~Tag | ( | ) | [virtual] |
Destroys this Tag instance.
Reimplemented from TagLib::Tag.
void TagLib::ID3v2::Tag::addFrame | ( | Frame * | frame | ) |
Add a frame to the tag. At this point the tag takes ownership of the frame and will handle freeing its memory.
virtual String TagLib::ID3v2::Tag::album | ( | ) | const [virtual] |
Returns the album name; if no album name is present in the tag String::null will be returned.
Implements TagLib::Tag.
virtual String TagLib::ID3v2::Tag::artist | ( | ) | const [virtual] |
Returns the artist name; if no artist name is present in the tag String::null will be returned.
Implements TagLib::Tag.
virtual String TagLib::ID3v2::Tag::comment | ( | ) | const [virtual] |
Returns the track comment; if no comment is present in the tag String::null will be returned.
Implements TagLib::Tag.
ExtendedHeader* TagLib::ID3v2::Tag::extendedHeader | ( | ) | const |
Returns a pointer to the tag's extended header or null if there is no extended header.
Footer* TagLib::ID3v2::Tag::footer | ( | ) | const |
Returns a pointer to the tag's footer or null if there is no footer.
const FrameList& TagLib::ID3v2::Tag::frameList | ( | const ByteVector & | frameID | ) | const |
Returns the frame list for frames with the id frameID or an empty list if there are no frames of that type. This is just a convenience and is equivalent to:
frameListMap()[frameID];
const FrameList& TagLib::ID3v2::Tag::frameList | ( | ) | const |
Returns a reference to the frame list. This is an FrameList of all of the frames in the tag in the order that they were parsed.
This can be useful if for example you want iterate over the tag's frames in the order that they occur in the tag.
const FrameListMap& TagLib::ID3v2::Tag::frameListMap | ( | ) | const |
Returns a reference to the frame list map. This is an FrameListMap of all of the frames in the tag.
This is the most convenient structure for accessing the tag's frames. Many frame types allow multiple instances of the same frame type so this is a map of lists. In most cases however there will only be a single frame of a certain type.
Let's say for instance that you wanted to access the frame for total beats per minute -- the TBPM frame.
TagLib::MPEG::File f("foo.mp3"); // Check to make sure that it has an ID3v2 tag if(f.ID3v2Tag()) { // Get the list of frames for a specific frame type TagLib::ID3v2::FrameList l = f.ID3v2Tag()->frameListMap()["TBPM"]; if(!l.isEmpty()) std::cout << l.front()->toString() << std::endl; }
virtual String TagLib::ID3v2::Tag::genre | ( | ) | const [virtual] |
Returns the genre name; if no genre is present in the tag String::null will be returned.
Implements TagLib::Tag.
Header* TagLib::ID3v2::Tag::header | ( | ) | const |
Returns a pointer to the tag's header.
virtual bool TagLib::ID3v2::Tag::isEmpty | ( | ) | const [virtual] |
Returns true if the tag does not contain any data. This should be reimplemented in subclasses that provide more than the basic tagging abilities in this class.
Reimplemented from TagLib::Tag.
void TagLib::ID3v2::Tag::parse | ( | const ByteVector & | data | ) | [protected] |
This is called by read to parse the body of the tag. It determines if an extended header exists and adds frames to the FrameListMap.
void TagLib::ID3v2::Tag::read | ( | ) | [protected] |
Reads data from the file specified in the constructor. It does basic parsing of the data in the largest chunks. It partitions the tag into the Header, the body of the tag (which contains the ExtendedHeader and frames) and Footer.
void TagLib::ID3v2::Tag::removeFrame | ( | Frame * | frame, | |
bool | del = true | |||
) |
Remove a frame from the tag. If del is true the frame's memory will be freed; if it is false, it must be deleted by the user.
void TagLib::ID3v2::Tag::removeFrames | ( | const ByteVector & | id | ) |
Remove all frames of type id from the tag and free their memory.
ByteVector TagLib::ID3v2::Tag::render | ( | ) | const |
Render the tag back to binary data, suitable to be written to disk.
virtual void TagLib::ID3v2::Tag::setAlbum | ( | const String & | s | ) | [virtual] |
Sets the album to s. If s is String::null then this value will be cleared.
Implements TagLib::Tag.
virtual void TagLib::ID3v2::Tag::setArtist | ( | const String & | s | ) | [virtual] |
Sets the artist to s. If s is String::null then this value will be cleared.
Implements TagLib::Tag.
virtual void TagLib::ID3v2::Tag::setComment | ( | const String & | s | ) | [virtual] |
Sets the comment to s. If s is String::null then this value will be cleared.
Implements TagLib::Tag.
virtual void TagLib::ID3v2::Tag::setGenre | ( | const String & | s | ) | [virtual] |
Sets the genre to s. If s is String::null then this value will be cleared. For tag formats that use a fixed set of genres, the appropriate value will be selected based on a string comparison. A list of available genres for those formats should be available in that type's implementation.
Implements TagLib::Tag.
void TagLib::ID3v2::Tag::setTextFrame | ( | const ByteVector & | id, | |
const String & | value | |||
) | [protected] |
Sets the value of the text frame with the Frame ID id to value. If the frame does not exist, it is created.
virtual void TagLib::ID3v2::Tag::setTitle | ( | const String & | s | ) | [virtual] |
Sets the title to s. If s is String::null then this value will be cleared.
Implements TagLib::Tag.
virtual void TagLib::ID3v2::Tag::setTrack | ( | uint | i | ) | [virtual] |
Sets the track to i. If s is 0 then this value will be cleared.
Implements TagLib::Tag.
virtual void TagLib::ID3v2::Tag::setYear | ( | uint | i | ) | [virtual] |
Sets the year to i. If s is 0 then this value will be cleared.
Implements TagLib::Tag.
virtual String TagLib::ID3v2::Tag::title | ( | ) | const [virtual] |
Returns the track name; if no track name is present in the tag String::null will be returned.
Implements TagLib::Tag.
virtual uint TagLib::ID3v2::Tag::track | ( | ) | const [virtual] |
Returns the track number; if there is no track number set, this will return 0.
Implements TagLib::Tag.
virtual uint TagLib::ID3v2::Tag::year | ( | ) | const [virtual] |
Returns the year; if there is no year set, this will return 0.
Implements TagLib::Tag.