Miam-Player  0.8.0
A nice music player
TagLib::ID3v2::TextIdentificationFrame Class Reference

An ID3v2 text identification frame implementation. More...

#include <textidentificationframe.h>

Inheritance diagram for TagLib::ID3v2::TextIdentificationFrame:
TagLib::ID3v2::Frame TagLib::ID3v2::Header TagLib::ID3v2::UserTextIdentificationFrame

Public Member Functions

 TextIdentificationFrame (const ByteVector &type, String::Type encoding)
 Construct an empty frame of type type. More...
 
 TextIdentificationFrame (const ByteVector &data)
 This is a dual purpose constructor. More...
 
virtual ~TextIdentificationFrame ()
 Destroys this TextIdentificationFrame instance. More...
 
void setText (const StringList &l)
 Text identification frames are a list of string fields. More...
 
virtual void setText (const String &s)
 Set the text of frame in the sanest way possible. More...
 
virtual String toString () const
 This returns the textual representation of the data in the frame. More...
 
String::Type textEncoding () const
 Returns the text encoding that will be used in rendering this frame. More...
 
void setTextEncoding (String::Type encoding)
 Sets the text encoding to be used when rendering this frame to encoding. More...
 
StringList fieldList () const
 Returns a list of the strings in this frame. More...
 
PropertyMap asProperties () const
 
- Public Member Functions inherited from TagLib::ID3v2::Frame
virtual ~Frame ()
 Destroys this Frame instance. More...
 
ByteVector frameID () const
 Returns the Frame ID (Structure, 4) (Frames, 4) More...
 
unsigned int size () const
 Returns the size of the frame. More...
 
void setData (const ByteVector &data)
 Sets the data that will be used as the frame. More...
 
ByteVector render () const
 Render the frame back to its binary format in a ByteVector. More...
 
 Header (const ByteVector &data, bool synchSafeInts)
 Construct a Frame Header based on data. More...
 
 Header (const ByteVector &data, unsigned int version=4)
 Construct a Frame Header based on data. More...
 
virtual ~Header ()
 Destroys this Header instance. More...
 
void setData (const ByteVector &data, bool synchSafeInts)
 Sets the data for the Header. More...
 
void setData (const ByteVector &data, unsigned int version=4)
 Sets the data for the Header. More...
 
ByteVector frameID () const
 Returns the Frame ID (Structure, 4) (Frames, 4) More...
 
void setFrameID (const ByteVector &id)
 Sets the frame's ID to id. More...
 
unsigned int frameSize () const
 Returns the size of the frame data portion, as set when setData() was called or set explicitly via setFrameSize(). More...
 
void setFrameSize (unsigned int size)
 Sets the size of the frame data portion. More...
 
unsigned int version () const
 Returns the ID3v2 version of the header, as passed in from the construction of the header or set via setVersion(). More...
 
void setVersion (unsigned int version)
 Sets the ID3v2 version of the header, changing has impact on the correct parsing/rendering of frame data. More...
 
bool tagAlterPreservation () const
 Returns true if the flag for tag alter preservation is set. More...
 
void setTagAlterPreservation (bool discard)
 Sets the flag for preservation of this frame if the tag is set. More...
 
bool fileAlterPreservation () const
 Returns true if the flag for file alter preservation is set. More...
 
bool readOnly () const
 Returns true if the frame is meant to be read only. More...
 
bool groupingIdentity () const
 Returns true if the flag for the grouping identity is set. More...
 
bool compression () const
 Returns true if compression is enabled for this frame. More...
 
bool encryption () const
 Returns true if encryption is enabled for this frame. More...
 
bool unsycronisation () const
 
bool unsynchronisation () const
 Returns true if unsynchronisation is enabled for this frame. More...
 
bool dataLengthIndicator () const
 Returns true if the flag for a data length indicator is set. More...
 
ByteVector render () const
 Render the Header back to binary format in a ByteVector. More...
 
bool frameAlterPreservation () const
 

Static Public Member Functions

static TextIdentificationFramecreateTIPLFrame (const PropertyMap &properties)
 This is a special factory method to create a TIPL (involved people list) frame from the given properties. More...
 
static TextIdentificationFramecreateTMCLFrame (const PropertyMap &properties)
 This is a special factory method to create a TMCL (musician credits list) frame from the given properties. More...
 
static const KeyConversionMapinvolvedPeopleMap ()
 Returns a KeyConversionMap mapping a role as it would be used in a PropertyMap to the corresponding key used in a TIPL ID3 frame to describe that role. More...
 
- Static Public Member Functions inherited from TagLib::ID3v2::Frame
static FramecreateTextualFrame (const String &key, const StringList &values)
 Creates a textual frame which corresponds to a single key in the PropertyMap interface. More...
 
static unsigned int headerSize ()
 Returns the size of the frame header. More...
 
static unsigned int headerSize (unsigned int version)
 Returns the size of the frame header for the given ID3v2 version. More...
 
static ByteVector textDelimiter (String::Type t)
 Returns the text delimiter that is used between fields for the string type t. More...
 
static unsigned int size ()
 Returns the size of the frame header in bytes. More...
 
static unsigned int size (unsigned int version)
 Returns the size of the frame header in bytes for the ID3v2 version that's given. More...
 

Protected Member Functions

virtual void parseFields (const ByteVector &data)
 Called by parse() to parse the field data. More...
 
virtual ByteVector renderFields () const
 Render the field data back to a binary format in a ByteVector. More...
 
 TextIdentificationFrame (const ByteVector &data, Header *h)
 The constructor used by the FrameFactory. More...
 
- Protected Member Functions inherited from TagLib::ID3v2::Frame
 Frame (const ByteVector &data)
 Constructs an ID3v2 frame using data to read the header information. More...
 
 Frame (Header *h)
 This creates an Frame using the header h. More...
 
Headerheader () const
 Returns a pointer to the frame header. More...
 
void setHeader (Header *h, bool deleteCurrent=true)
 Sets the header to h. More...
 
void parse (const ByteVector &data)
 Called by setData() to parse the frame data. More...
 
ByteVector fieldData (const ByteVector &frameData) const
 Returns a ByteVector containing the field data given the frame data. More...
 
String readStringField (const ByteVector &data, String::Type encoding, int *positon=0)
 Reads a String of type encoding from the ByteVector data. More...
 
String::Type checkTextEncoding (const StringList &fields, String::Type encoding) const
 Checks a the list of string values to see if they can be used with the specified encoding and returns the recommended encoding. More...
 
PropertyMap asProperties () const
 Parses the contents of this frame as PropertyMap. More...
 

Friends

class FrameFactory
 

Additional Inherited Members

- Static Public Attributes inherited from TagLib::ID3v2::Frame
static const String instrumentPrefix
 The string with which an instrument name is prefixed to build a key in a PropertyMap; used to translate PropertyMaps to TMCL frames. More...
 
static const String commentPrefix
 The PropertyMap key prefix which triggers the use of a COMM frame instead of a TXXX frame for a non-standard key. More...
 
static const String lyricsPrefix
 The PropertyMap key prefix which triggers the use of a USLT frame instead of a TXXX frame for a non-standard key. More...
 
static const String urlPrefix
 The PropertyMap key prefix which triggers the use of a WXXX frame instead of a TXX frame for a non-standard key. More...
 
- Static Protected Member Functions inherited from TagLib::ID3v2::Frame
static String::Type checkEncoding (const StringList &fields, String::Type encoding)
 Checks a the list of string values to see if they can be used with the specified encoding and returns the recommended encoding. More...
 
static String::Type checkEncoding (const StringList &fields, String::Type encoding, unsigned int version)
 Checks a the list of string values to see if they can be used with the specified encoding and returns the recommended encoding. More...
 
static ByteVector keyToFrameID (const String &)
 Returns an appropriate ID3 frame ID for the given free-form tag key. More...
 
static String frameIDToKey (const ByteVector &)
 Returns a free-form tag name for the given ID3 frame ID. More...
 
static String keyToTXXX (const String &)
 Returns an appropriate TXXX frame description for the given free-form tag key. More...
 
static String txxxToKey (const String &)
 Returns a free-form tag name for the given ID3 frame description. More...
 
static void splitProperties (const PropertyMap &original, PropertyMap &singleFrameProperties, PropertyMap &tiplProperties, PropertyMap &tmclProperties)
 This helper function splits the PropertyMap original into three ProperytMaps singleFrameProperties, tiplProperties, and tmclProperties, such that: More...
 

Detailed Description

An ID3v2 text identification frame implementation.

This is an implementation of the most common type of ID3v2 frame – text identification frames. There are a number of variations on this. Those enumerated in the ID3v2.4 standard are:

  • TALB Album/Movie/Show title
  • TBPM BPM (beats per minute)
  • TCOM Composer
  • TCON Content type
  • TCOP Copyright message
  • TDEN Encoding time
  • TDLY Playlist delay
  • TDOR Original release time
  • TDRC Recording time
  • TDRL Release time
  • TDTG Tagging time
  • TENC Encoded by
  • TEXT Lyricist/Text writer
  • TFLT File type
  • TIPL Involved people list
  • TIT1 Content group description
  • TIT2 Title/songname/content description
  • TIT3 Subtitle/Description refinement
  • TKEY Initial key
  • TLAN Language(s)
  • TLEN Length
  • TMCL Musician credits list
  • TMED Media type
  • TMOO Mood
  • TOAL Original album/movie/show title
  • TOFN Original filename
  • TOLY Original lyricist(s)/text writer(s)
  • TOPE Original artist(s)/performer(s)
  • TOWN File owner/licensee
  • TPE1 Lead performer(s)/Soloist(s)
  • TPE2 Band/orchestra/accompaniment
  • TPE3 Conductor/performer refinement
  • TPE4 Interpreted, remixed, or otherwise modified by
  • TPOS Part of a set
  • TPRO Produced notice
  • TPUB Publisher
  • TRCK Track number/Position in set
  • TRSN Internet radio station name
  • TRSO Internet radio station owner
  • TSOA Album sort order
  • TSOP Performer sort order
  • TSOT Title sort order
  • TSRC ISRC (international standard recording code)
  • TSSE Software/Hardware and settings used for encoding
  • TSST Set subtitle

The ID3v2 Frames document gives a description of each of these formats and the expected order of strings in each. ID3v2::Header::frameID() can be used to determine the frame type.

Note
If non-Latin1 compatible strings are used with this class, even if the text encoding is set to Latin1, the frame will be written using UTF8 (with the encoding flag appropriately set in the output).

Constructor & Destructor Documentation

◆ TextIdentificationFrame() [1/3]

TagLib::ID3v2::TextIdentificationFrame::TextIdentificationFrame ( const ByteVector type,
String::Type  encoding 
)

Construct an empty frame of type type.

Uses encoding as the default text encoding.

Note
In this case you must specify the text encoding as it resolves the ambiguity between constructors.
Please see the note in the class description regarding Latin1.

◆ TextIdentificationFrame() [2/3]

TagLib::ID3v2::TextIdentificationFrame::TextIdentificationFrame ( const ByteVector data)
explicit

This is a dual purpose constructor.

data can either be binary data that should be parsed or (at a minimum) the frame ID.

◆ ~TextIdentificationFrame()

virtual TagLib::ID3v2::TextIdentificationFrame::~TextIdentificationFrame ( )
virtual

Destroys this TextIdentificationFrame instance.

◆ TextIdentificationFrame() [3/3]

TagLib::ID3v2::TextIdentificationFrame::TextIdentificationFrame ( const ByteVector data,
Header h 
)
protected

The constructor used by the FrameFactory.

Member Function Documentation

◆ asProperties()

PropertyMap TagLib::ID3v2::TextIdentificationFrame::asProperties ( ) const

◆ createTIPLFrame()

static TextIdentificationFrame* TagLib::ID3v2::TextIdentificationFrame::createTIPLFrame ( const PropertyMap properties)
static

This is a special factory method to create a TIPL (involved people list) frame from the given properties.

Will parse key=[list of values] data into the TIPL format as specified in the ID3 standard.

◆ createTMCLFrame()

static TextIdentificationFrame* TagLib::ID3v2::TextIdentificationFrame::createTMCLFrame ( const PropertyMap properties)
static

This is a special factory method to create a TMCL (musician credits list) frame from the given properties.

Will parse key=[list of values] data into the TMCL format as specified in the ID3 standard, where key should be of the form instrumentPrefix:instrument.

◆ fieldList()

StringList TagLib::ID3v2::TextIdentificationFrame::fieldList ( ) const

Returns a list of the strings in this frame.

◆ involvedPeopleMap()

static const KeyConversionMap& TagLib::ID3v2::TextIdentificationFrame::involvedPeopleMap ( )
static

Returns a KeyConversionMap mapping a role as it would be used in a PropertyMap to the corresponding key used in a TIPL ID3 frame to describe that role.

◆ parseFields()

virtual void TagLib::ID3v2::TextIdentificationFrame::parseFields ( const ByteVector data)
protectedvirtual

Called by parse() to parse the field data.

It makes this information available through the public API. This must be overridden by the subclasses.

Implements TagLib::ID3v2::Frame.

◆ renderFields()

virtual ByteVector TagLib::ID3v2::TextIdentificationFrame::renderFields ( ) const
protectedvirtual

Render the field data back to a binary format in a ByteVector.

This must be overridden by subclasses.

Implements TagLib::ID3v2::Frame.

◆ setText() [1/2]

void TagLib::ID3v2::TextIdentificationFrame::setText ( const StringList l)

Text identification frames are a list of string fields.

This function will accept either a StringList or a String (using the StringList constructor that accepts a single String).

Note
This will not change the text encoding of the frame even if the strings passed in are not of the same encoding. Please use setEncoding(s.type()) if you wish to change the encoding of the frame.

◆ setText() [2/2]

virtual void TagLib::ID3v2::TextIdentificationFrame::setText ( const String text)
virtual

Set the text of frame in the sanest way possible.

This should only be reimplemented in frames where there is some logical mapping to text.

Note
If the frame type supports multiple text encodings, this will not change the text encoding of the frame; the string will be converted to that frame's encoding. Please use the specific APIs of the frame types to set the encoding if that is desired.

Reimplemented from TagLib::ID3v2::Frame.

Reimplemented in TagLib::ID3v2::UserTextIdentificationFrame.

◆ setTextEncoding()

void TagLib::ID3v2::TextIdentificationFrame::setTextEncoding ( String::Type  encoding)

Sets the text encoding to be used when rendering this frame to encoding.

Note
Please see the note in the class description regarding Latin1.
See also
textEncoding()
render()

◆ textEncoding()

String::Type TagLib::ID3v2::TextIdentificationFrame::textEncoding ( ) const

Returns the text encoding that will be used in rendering this frame.

This defaults to the type that was either specified in the constructor or read from the frame when parsed.

Note
Please see the note in the class description regarding Latin1.
See also
setTextEncoding()
render()

◆ toString()

virtual String TagLib::ID3v2::TextIdentificationFrame::toString ( ) const
virtual

This returns the textual representation of the data in the frame.

Subclasses must reimplement this method to provide a string representation of the frame's data.

Implements TagLib::ID3v2::Frame.

Reimplemented in TagLib::ID3v2::UserTextIdentificationFrame.

Friends And Related Function Documentation

◆ FrameFactory

friend class FrameFactory
friend

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