Kwave::ID3_PropertyMap Class Reference

#include <ID3_PropertyMap.h>

Collaboration diagram for Kwave::ID3_PropertyMap:

Classes
struct	Mapping

Public Types
enum	Encoding {   ENC_NONE = 0, ENC_COMMENT, ENC_GENRE_TYPE, ENC_LENGTH,   ENC_TERMS_OF_USE, ENC_TEXT, ENC_TEXT_SLASH, ENC_TEXT_LIST,   ENC_TEXT_URL, ENC_TEXT_PARTINSET, ENC_TEXT_TIMESTAMP, ENC_TRACK_NUM }

Public Member Functions
	ID3_PropertyMap ()
virtual	~ID3_PropertyMap ()
ID3_FrameID	findProperty (const Kwave::FileProperty property) const
bool	containsProperty (const Kwave::FileProperty property) const
void	insert (const Kwave::FileProperty property, const ID3_FrameID id, const Encoding encoding)
bool	containsID (const ID3_FrameID id) const
Encoding	encoding (const ID3_FrameID id) const
QList< ID3_FrameID >	knownIDs () const
Kwave::FileProperty	property (const ID3_FrameID id) const
QList< Kwave::FileProperty >	properties () const

Private Member Functions
bool	supported (const ID3_FrameID id) const

Private Attributes
QList< Mapping >	m_list

Detailed Description

Definition at line 33 of file ID3_PropertyMap.h.

Member Enumeration Documentation

Encoding

enum Kwave::ID3_PropertyMap::Encoding

encoding of the ID3 tag

Enumerator
ENC_NONE
ENC_COMMENT	comment frame
ENC_GENRE_TYPE	genre type, numeric or text
ENC_LENGTH	string with length in ms
ENC_TERMS_OF_USE	terms of use
ENC_TEXT	text, appended by ';'
ENC_TEXT_SLASH	text list, separated by slash '/'
ENC_TEXT_LIST	list of zero terminated strings
ENC_TEXT_URL	URL
ENC_TEXT_PARTINSET	part in set (x/y)
ENC_TEXT_TIMESTAMP	ISO 8601 timestamp
ENC_TRACK_NUM	track/tracks (x/y)

Definition at line 38 of file ID3_PropertyMap.h.

                     {
            ENC_NONE = 0,
            ENC_COMMENT,        
            ENC_GENRE_TYPE,     
            ENC_LENGTH,         
            ENC_TERMS_OF_USE,   
            ENC_TEXT,           
            ENC_TEXT_SLASH,     
            ENC_TEXT_LIST,      
            ENC_TEXT_URL,       
            ENC_TEXT_PARTINSET, 
            ENC_TEXT_TIMESTAMP, 
            ENC_TRACK_NUM       
        } Encoding;

Constructor & Destructor Documentation

ID3_PropertyMap()

Kwave::ID3_PropertyMap::ID3_PropertyMap

(

)

Default constructor, with initializing

Definition at line 25 of file ID3_PropertyMap.cpp.

References ENC_COMMENT, ENC_GENRE_TYPE, ENC_LENGTH, ENC_NONE, ENC_TERMS_OF_USE, ENC_TEXT, ENC_TEXT_LIST, ENC_TEXT_PARTINSET, ENC_TEXT_SLASH, ENC_TEXT_TIMESTAMP, ENC_TEXT_URL, ENC_TRACK_NUM, Kwave::INF_ALBUM, Kwave::INF_ANNOTATION, Kwave::INF_AUTHOR, Kwave::INF_CD, Kwave::INF_CDS, Kwave::INF_COMMENTS, Kwave::INF_COMMISSIONED, Kwave::INF_CONTACT, Kwave::INF_COPYRIGHT, Kwave::INF_CREATION_DATE, Kwave::INF_GENRE, Kwave::INF_ISRC, Kwave::INF_LENGTH, Kwave::INF_LICENSE, Kwave::INF_MEDIUM, Kwave::INF_NAME, Kwave::INF_ORGANIZATION, Kwave::INF_PERFORMER, Kwave::INF_SOFTWARE, Kwave::INF_TECHNICAN, Kwave::INF_TRACK, Kwave::INF_TRACKS, Kwave::INF_UNKNOWN, Kwave::INF_VERSION, and insert().

    :m_list()
{
    // NOTE #1: the left column is allowed to have multiple entries with the
    //          same property, when encoding the first one is used, when
    //          decoding, the other ones serve as alternatives
    // NOTE #2: the ID3 tag names in the right column must be *unique* !

    // Album/Movie/Show title
    insert(Kwave::INF_ALBUM,         ID3FID_ALBUM              , ENC_TEXT);
    // Original album/movie/show title
    insert(Kwave::INF_ALBUM,         ID3FID_ORIGALBUM          , ENC_TEXT);
    // Subtitle/Description refinement
    insert(Kwave::INF_ANNOTATION,    ID3FID_SUBTITLE           , ENC_TEXT);
    // User defined text information
    insert(Kwave::INF_ANNOTATION,    ID3FID_USERTEXT           , ENC_TEXT);
    //     Kwave::INF_ARCHIVAL
    // Original artist(s)/performer(s)
    insert(Kwave::INF_AUTHOR,        ID3FID_ORIGARTIST         , ENC_TEXT_SLASH);
    // Involved people list
    insert(Kwave::INF_AUTHOR,        ID3FID_INVOLVEDPEOPLE     , ENC_TEXT_LIST);
    // Involved people list
    insert(Kwave::INF_AUTHOR,        ID3FID_INVOLVEDPEOPLE2    , ENC_TEXT_LIST);
    // Band/orchestra/accompaniment
    insert(Kwave::INF_AUTHOR,        ID3FID_BAND               , ENC_TEXT);
    // Original lyricist(s)/text writer(s)
    insert(Kwave::INF_AUTHOR,        ID3FID_ORIGLYRICIST       , ENC_TEXT_SLASH);
    // Official artist/performer webpage
    insert(Kwave::INF_AUTHOR,        ID3FID_WWWARTIST          , ENC_TEXT_URL);
    // Official publisher webpage
    insert(Kwave::INF_AUTHOR,        ID3FID_WWWPUBLISHER       , ENC_TEXT_URL);
    //     Kwave::INF_BITRATE_LOWER
    //     Kwave::INF_BITRATE_NOMINAL
    //     Kwave::INF_BITRATE_UPPER
    //     Kwave::INF_BITS_PER_SAMPLE
    // Part of a set
    insert(Kwave::INF_CD,            ID3FID_PARTINSET          , ENC_TEXT_PARTINSET);
    insert(Kwave::INF_CDS,           ID3FID_PARTINSET          , ENC_TEXT_PARTINSET);
    // Internet radio station name
    insert(Kwave::INF_COMMISSIONED,  ID3FID_NETRADIOSTATION    , ENC_TEXT);
    // Internet radio station owner
    insert(Kwave::INF_COMMISSIONED,  ID3FID_NETRADIOOWNER      , ENC_TEXT);
    // Comments
    insert(Kwave::INF_COMMENTS,      ID3FID_COMMENT            , ENC_COMMENT);
    // Official audio source webpage
    insert(Kwave::INF_CONTACT,       ID3FID_WWWAUDIOSOURCE     , ENC_TEXT_SLASH);
    // Official internet radio station homepage
    insert(Kwave::INF_CONTACT,       ID3FID_WWWRADIOPAGE       , ENC_TEXT_SLASH);
    // Official audio file webpage
    insert(Kwave::INF_CONTACT,       ID3FID_WWWAUDIOFILE       , ENC_TEXT_SLASH);
    // Ownership (not supported by id3lib)
    //    (Kwave::INF_CONTACT,       ID3FID_OWNERSHIP          , ENC_OWNERSHIP?);
    // Copyright message.
    insert(Kwave::INF_COPYRIGHT,     ID3FID_COPYRIGHT          , ENC_TEXT);
    // Copyright/Legal infromation
    insert(Kwave::INF_COPYRIGHT,     ID3FID_WWWCOPYRIGHT       , ENC_TEXT_URL);
    // Terms of use
    insert(Kwave::INF_COPYRIGHT,     ID3FID_TERMSOFUSE         , ENC_TERMS_OF_USE);
    //     Kwave::INF_COPYRIGHTED

    // Recording dates
    insert(Kwave::INF_CREATION_DATE, ID3FID_RECORDINGDATES     , ENC_TEXT_TIMESTAMP);
    // Recording time (not supported by id3lib)
    //    (Kwave::INF_CREATION_DATE, ID3FID_RECORDINGTIME      , ENC_TEXT_TIMESTAMP);
    // Date
    insert(Kwave::INF_CREATION_DATE, ID3FID_DATE               , ENC_TEXT_TIMESTAMP);
    // Year
    insert(Kwave::INF_CREATION_DATE, ID3FID_YEAR               , ENC_TEXT_TIMESTAMP);
    // Time
    insert(Kwave::INF_CREATION_DATE, ID3FID_TIME               , ENC_TEXT_TIMESTAMP);
    // Release time (not supported by id3lib)
    //    (Kwave::INF_CREATION_DATE, ID3FID_RELEASETIME        , ENC_TEXT_TIMESTAMP);
    // Original release year
    insert(Kwave::INF_CREATION_DATE, ID3FID_ORIGYEAR           , ENC_TEXT_TIMESTAMP);
    // Original release time (not supported by id3lib)
    //    (Kwave::INF_CREATION_DATE, ID3FID_ORIGRELEASETIME    , ENC_TEXT_TIMESTAMP);
    // Tagging time (not supported by id3lib)
    //    (Kwave::INF_CREATION_DATE, ID3FID_TAGGINGTIME        , ENC_TEXT_TIMESTAMP);
    // Encoding time (not supported by id3lib)
    //    (Kwave::INF_CREATION_DATE, ID3FID_ENCODINGTIME       , ENC_TEXT_TIMESTAMP);

    //     Kwave::INF_ENGINEER
    //     Kwave::INF_FILENAME
    //     Kwave::INF_FILESIZE
    // Content type (Genre)
    insert(Kwave::INF_GENRE,         ID3FID_CONTENTTYPE        , ENC_GENRE_TYPE);
    // ISRC
    insert(Kwave::INF_ISRC,          ID3FID_ISRC               , ENC_TEXT);
    //     Kwave::INF_KEYWORDS
    //     Kwave::INF_LABELS
    // Length
    insert(Kwave::INF_LENGTH,        ID3FID_SONGLEN            , ENC_LENGTH);
    // File owner/licensee
    insert(Kwave::INF_LICENSE,       ID3FID_FILEOWNER          , ENC_TEXT);
    // Medium type
    insert(Kwave::INF_MEDIUM,        ID3FID_MEDIATYPE          , ENC_TEXT);
    //     Kwave::INF_MIMETYPE
    //     Kwave::INF_MPEG_EMPHASIS
    //     Kwave::INF_MPEG_LAYER
    //     Kwave::INF_MPEG_MODEEXT
    //     Kwave::INF_MPEG_VERSION
    // Title/songname/content description
    insert(Kwave::INF_NAME,          ID3FID_TITLE              , ENC_TEXT);
    // Composer
    insert(Kwave::INF_ORGANIZATION,  ID3FID_COMPOSER           , ENC_TEXT_SLASH);
    // Publisher
    insert(Kwave::INF_ORGANIZATION,  ID3FID_PUBLISHER          , ENC_TEXT_SLASH);
    // Produced notice
    insert(Kwave::INF_ORGANIZATION,  ID3FID_PRODUCEDNOTICE     , ENC_TEXT_SLASH);
    //     Kwave::INF_ORIGINAL
    // Lyricist/Text writer
    insert(Kwave::INF_PERFORMER,     ID3FID_LYRICIST           , ENC_TEXT_SLASH);
    // Lead performer(s)/Soloist(s).
    insert(Kwave::INF_PERFORMER,     ID3FID_LEADARTIST         , ENC_TEXT_SLASH);
    // Musician credits list
    insert(Kwave::INF_PERFORMER,     ID3FID_MUSICIANCREDITLIST , ENC_TEXT_SLASH);
    // Conductor/performer refinement
    insert(Kwave::INF_PERFORMER,     ID3FID_CONDUCTOR          , ENC_TEXT);
    // Private frame
    //     Kwave::INF_PRIVATE
    //     Kwave::INF_PRODUCT
    //     Kwave::INF_SAMPLE_FORMAT
    //     Kwave::INF_SAMPLE_RATE
    insert(Kwave::INF_SOFTWARE,      ID3FID_ENCODERSETTINGS    , ENC_TEXT);
    //     Kwave::INF_SOURCE
    //     Kwave::INF_SOURCE_FORM
    //     Kwave::INF_SUBJECT
    // Encoded by.
    insert(Kwave::INF_TECHNICAN,     ID3FID_ENCODEDBY          , ENC_TEXT);
    // Track number/Position in set
    insert(Kwave::INF_TRACK,         ID3FID_TRACKNUM           , ENC_TRACK_NUM);
    // Number of Tracks
    insert(Kwave::INF_TRACKS,        ID3FID_TRACKNUM           , ENC_TRACK_NUM);
    //     Kwave::INF_VBR_QUALITY
    // Interpreted, remixed / modified by
    insert(Kwave::INF_VERSION,       ID3FID_MIXARTIST          , ENC_TEXT);
    // Set subtitle
    insert(Kwave::INF_VERSION,       ID3FID_SETSUBTITLE        , ENC_TEXT);
    //                               ID3FID_PRIVATE => user defined data

    insert(Kwave::INF_UNKNOWN,       ID3FID_NOFRAME            , ENC_NONE);
}

Here is the call graph for this function:

~ID3_PropertyMap()

virtual Kwave::ID3_PropertyMap::~ID3_PropertyMap ( )

inlinevirtual

Destructor

Definition at line 57 of file ID3_PropertyMap.h.

References containsID(), containsProperty(), encoding(), findProperty(), insert(), knownIDs(), properties(), property(), and supported().

{}

Here is the call graph for this function:

Member Function Documentation

containsID()

bool Kwave::ID3_PropertyMap::containsID

(

const ID3_FrameID

id

)

const

returns true if a given ID3 frame ID is in the map

Parameters

id	a ID3 frame ID

Returns

true if found, false if not

Definition at line 203 of file ID3_PropertyMap.cpp.

References Kwave::ID3_PropertyMap::Mapping::m_frame_id, m_list, and supported().

Referenced by ~ID3_PropertyMap().

{
    if (!supported(id))
        return false;

    foreach(const Kwave::ID3_PropertyMap::Mapping &m, m_list) {
        if (m.m_frame_id == id)
            return true;
    }
    return false;
}

Here is the call graph for this function:

Here is the caller graph for this function:

containsProperty()

bool Kwave::ID3_PropertyMap::containsProperty

(

const Kwave::FileProperty

property

)

const

Returns true if the map contains a given property

Definition at line 192 of file ID3_PropertyMap.cpp.

References Kwave::ID3_PropertyMap::Mapping::m_frame_id, m_list, Kwave::ID3_PropertyMap::Mapping::m_property, and supported().

Referenced by ~ID3_PropertyMap().

{
    foreach(const Kwave::ID3_PropertyMap::Mapping &m, m_list) {
        if ((m.m_property == property) && supported(m.m_frame_id))
            return true;
    }
    return false;
}

Here is the call graph for this function:

Here is the caller graph for this function:

encoding()

Kwave::ID3_PropertyMap::Encoding Kwave::ID3_PropertyMap::encoding

(

const ID3_FrameID

id

)

const

returns the encoding of the ID3 frame

Parameters

id	a ID3 frame ID

Returns

the encoding of the content of the frame

Definition at line 216 of file ID3_PropertyMap.cpp.

References ENC_NONE, Kwave::ID3_PropertyMap::Mapping::m_encoding, Kwave::ID3_PropertyMap::Mapping::m_frame_id, and m_list.

Referenced by Kwave::MP3Encoder::encodeID3Tags(), insert(), Kwave::MP3Decoder::parseID3Tags(), and ~ID3_PropertyMap().

{
    foreach(const Kwave::ID3_PropertyMap::Mapping &m, m_list) {
        if (m.m_frame_id == id)
            return m.m_encoding;
    }
    return ID3_PropertyMap::ENC_NONE;
}

Here is the caller graph for this function:

findProperty()

ID3_FrameID Kwave::ID3_PropertyMap::findProperty

(

const Kwave::FileProperty

property

)

const

Returns the frame ID of a property or an empty string if nothing found (reverse lookup).

Definition at line 181 of file ID3_PropertyMap.cpp.

References Kwave::ID3_PropertyMap::Mapping::m_frame_id, m_list, Kwave::ID3_PropertyMap::Mapping::m_property, and supported().

Referenced by Kwave::MP3Encoder::encodeID3Tags(), and ~ID3_PropertyMap().

{
    foreach(const Kwave::ID3_PropertyMap::Mapping &m, m_list) {
        if ((m.m_property == property) && supported(m.m_frame_id))
            return m.m_frame_id;
    }
    return ID3FID_NOFRAME;
}

Here is the call graph for this function:

Here is the caller graph for this function:

insert()

void Kwave::ID3_PropertyMap::insert	(	const Kwave::FileProperty	property,
		const ID3_FrameID	id,
		const Encoding	encoding
	)

insert a new property / frame ID mapping

Parameters

property	a Kwave FileProperty
id	a ID3 frame ID
encoding	the type of the encoding of the tag

Definition at line 169 of file ID3_PropertyMap.cpp.

References encoding(), Kwave::ID3_PropertyMap::Mapping::m_encoding, Kwave::ID3_PropertyMap::Mapping::m_frame_id, m_list, Kwave::ID3_PropertyMap::Mapping::m_property, and property().

Referenced by ID3_PropertyMap(), and ~ID3_PropertyMap().

{
    Kwave::ID3_PropertyMap::Mapping mapping;

    mapping.m_property = property;
    mapping.m_frame_id = id;
    mapping.m_encoding = encoding;
    m_list.append(mapping);
}

Here is the call graph for this function:

Here is the caller graph for this function:

knownIDs()

QList< ID3_FrameID > Kwave::ID3_PropertyMap::knownIDs

(

)

const

returns a list of all known ID3 frame IDs

Definition at line 227 of file ID3_PropertyMap.cpp.

References Kwave::ID3_PropertyMap::Mapping::m_frame_id, and m_list.

Referenced by ~ID3_PropertyMap().

{
    QList<ID3_FrameID> list;
    foreach(const Kwave::ID3_PropertyMap::Mapping &m, m_list) {
        if (!list.contains(m.m_frame_id))
            list.append(m.m_frame_id);
    }
    return list;
}

Here is the caller graph for this function:

properties()

QList< Kwave::FileProperty > Kwave::ID3_PropertyMap::properties

(

)

const

Returns a list with all supported properties

Definition at line 247 of file ID3_PropertyMap.cpp.

References m_list, and Kwave::ID3_PropertyMap::Mapping::m_property.

Referenced by Kwave::MP3Encoder::supportedProperties(), and ~ID3_PropertyMap().

{
    QList<Kwave::FileProperty> list;
    foreach(const Kwave::ID3_PropertyMap::Mapping &m, m_list) {
        if (!list.contains(m.m_property))
            list.append(m.m_property);
    }
    return list;
}

Here is the caller graph for this function:

property()

Kwave::FileProperty Kwave::ID3_PropertyMap::property

(

const ID3_FrameID

id

)

const

Returns the first FileProperty that matches a given ID3 frame ID

Parameters

id	a ID3 frame ID

Returns

a FileProperty

Definition at line 238 of file ID3_PropertyMap.cpp.

References Kwave::INF_UNKNOWN, Kwave::ID3_PropertyMap::Mapping::m_frame_id, m_list, and Kwave::ID3_PropertyMap::Mapping::m_property.

Referenced by insert(), Kwave::MP3Decoder::parseID3Tags(), and ~ID3_PropertyMap().

{
    foreach(const Kwave::ID3_PropertyMap::Mapping &m, m_list) {
        if (m.m_frame_id == id) return m.m_property;
    }
    return Kwave::INF_UNKNOWN;
}

Here is the caller graph for this function:

supported()

bool Kwave::ID3_PropertyMap::supported ( const ID3_FrameID  id ) const

private

returns true if a frame is supported by id3lib

Definition at line 258 of file ID3_PropertyMap.cpp.

Referenced by containsID(), containsProperty(), findProperty(), and ~ID3_PropertyMap().

{
    ID3_FrameInfo frameInfo;
    return (frameInfo.NumFields(id) != 0);
}

Here is the caller graph for this function:

Member Data Documentation

m_list

QList<Mapping> Kwave::ID3_PropertyMap::m_list

private

list of mappings

Definition at line 123 of file ID3_PropertyMap.h.

Referenced by containsID(), containsProperty(), encoding(), findProperty(), insert(), knownIDs(), properties(), and property().

---

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

• plugins/codec_mp3/ID3_PropertyMap.h
• plugins/codec_mp3/ID3_PropertyMap.cpp