Kwave::WavPropertyMap Class Reference

#include <WavPropertyMap.h>

Inheritance diagram for Kwave::WavPropertyMap:

Collaboration diagram for Kwave::WavPropertyMap:

Public Member Functions
	WavPropertyMap ()
virtual	~WavPropertyMap ()
QByteArray	findProperty (const Kwave::FileProperty property) const
bool	containsProperty (const Kwave::FileProperty property) const
void	insert (const Kwave::FileProperty property, const QByteArray &chunk)
bool	containsChunk (const QByteArray &chunk) const
QList< QByteArray >	chunks () const
Kwave::FileProperty	property (const QByteArray &chunk) const
QList< Kwave::FileProperty >	properties () const

Private Types
typedef QPair< Kwave::FileProperty, QByteArray >	Pair

Detailed Description

Definition at line 32 of file WavPropertyMap.h.

Member Typedef Documentation

Pair

typedef QPair<Kwave::FileProperty, QByteArray> Kwave::WavPropertyMap::Pair

private

Definition at line 83 of file WavPropertyMap.h.

Constructor & Destructor Documentation

WavPropertyMap()

Kwave::WavPropertyMap::WavPropertyMap

(

)

Default constructor, with initializing

Definition at line 21 of file WavPropertyMap.cpp.

References Kwave::INF_ALBUM, Kwave::INF_ANNOTATION, Kwave::INF_ARCHIVAL, Kwave::INF_AUTHOR, Kwave::INF_CD, Kwave::INF_COMMENTS, Kwave::INF_COMMISSIONED, Kwave::INF_CONTACT, Kwave::INF_COPYRIGHT, Kwave::INF_CREATION_DATE, Kwave::INF_ENGINEER, Kwave::INF_GENRE, Kwave::INF_ISRC, Kwave::INF_KEYWORDS, Kwave::INF_LICENSE, Kwave::INF_MEDIUM, Kwave::INF_NAME, Kwave::INF_ORGANIZATION, Kwave::INF_PERFORMER, Kwave::INF_PRODUCT, Kwave::INF_SOFTWARE, Kwave::INF_SOURCE, Kwave::INF_SOURCE_FORM, Kwave::INF_SUBJECT, Kwave::INF_TECHNICAN, Kwave::INF_TRACK, Kwave::INF_VERSION, and insert().

{
    // 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 chunk names in the right column must be *unique* !
    // well-known tags
    insert(Kwave::INF_AUTHOR        ,"AUTH"); // author's name
    insert(Kwave::INF_ANNOTATION    ,"ANNO"); // annotations
    insert(Kwave::INF_ARCHIVAL      ,"IARL"); // archival location (EXIF 2.3)
    insert(Kwave::INF_PERFORMER     ,"IART"); // performer  (EXIF 2.3)
    insert(Kwave::INF_COMMISSIONED  ,"ICMS"); // commissioned  (EXIF 2.3)
    insert(Kwave::INF_COMMENTS      ,"ICMT"); // comments  (EXIF 2.3)
    insert(Kwave::INF_COPYRIGHT     ,"ICOP"); // copyright  (EXIF 2.3)
    insert(Kwave::INF_CREATION_DATE ,"ICRD"); // creation date (iso)  (EXIF 2.3)
    insert(Kwave::INF_ENGINEER      ,"IENG"); // engineer  (EXIF 2.3)
    insert(Kwave::INF_GENRE         ,"IGNR"); // genre  (EXIF 2.3)
    insert(Kwave::INF_KEYWORDS      ,"IKEY"); // keywords  (EXIF 2.3)
    insert(Kwave::INF_MEDIUM        ,"IMED"); // medium  (EXIF 2.3)
    insert(Kwave::INF_NAME          ,"INAM"); // name  (EXIF 2.3)
    insert(Kwave::INF_PRODUCT       ,"IPRD"); // product  (EXIF 2.3)
    insert(Kwave::INF_SOFTWARE      ,"ISFT"); // software  (EXIF 2.3)
    insert(Kwave::INF_SOURCE        ,"ISRC"); // source  (EXIF 2.3)
    insert(Kwave::INF_SOURCE_FORM   ,"ISRF"); // source form  (EXIF 2.3)
    insert(Kwave::INF_TECHNICAN     ,"ITCH"); // technician  (EXIF 2.3)
    insert(Kwave::INF_SUBJECT       ,"ISBJ"); // subject  (EXIF 2.3)

    // tags from SoundForge Pro
    insert(Kwave::INF_TRACK         ,"TRCK"); // track number
    insert(Kwave::INF_VERSION       ,"TVER"); // version/remix
    insert(Kwave::INF_ORGANIZATION  ,"TORG"); // organization/label

    // some others, alternatives
    insert(Kwave::INF_ALBUM         ,"IALB"); // name of the album
    insert(Kwave::INF_COPYRIGHT     ,"(c) "); // copyright
    insert(Kwave::INF_CREATION_DATE ,"DTIM"); // date/time original
    insert(Kwave::INF_CREATION_DATE ,"YEAR"); // year  (MovieID ref12)
    insert(Kwave::INF_GENRE         ,"GENR"); // genre (MovieID ref12)
    insert(Kwave::INF_GENRE         ,"ISGN"); // second genre (IMDB)
    insert(Kwave::INF_AUTHOR        ,"IWRI"); // written by (IMDB)
    insert(Kwave::INF_ENGINEER      ,"IEDT"); // edited by (IMDB)
    insert(Kwave::INF_CD            ,"IPTR"); // part (?)

    // non-standard, probably only known by Kwave
    insert(Kwave::INF_CONTACT       ,"cnt "); // contact information for creator
    insert(Kwave::INF_ISRC          ,"isrc"); // International Standard Recording Code
    insert(Kwave::INF_LICENSE       ,"lic "); // license information
}

Here is the call graph for this function:

~WavPropertyMap()

virtual Kwave::WavPropertyMap::~WavPropertyMap ( )

inlinevirtual

Destructor

Definition at line 40 of file WavPropertyMap.h.

References chunks(), containsChunk(), containsProperty(), findProperty(), insert(), properties(), and property().

{}

Here is the call graph for this function:

Member Function Documentation

chunks()

QList< QByteArray > Kwave::WavPropertyMap::chunks

(

)

const

returns a list of all known chunks

Definition at line 111 of file WavPropertyMap.cpp.

Referenced by Kwave::WavDecoder::WavDecoder(), and ~WavPropertyMap().

{
    QList<QByteArray> list;
    foreach(const Pair &p, QList<Pair>(*this)) {
        if (!list.contains(p.second))
            list.append(p.second);
    }
    return list;
}

Here is the caller graph for this function:

containsChunk()

bool Kwave::WavPropertyMap::containsChunk

(

const QByteArray &

chunk

)

const

returns true if a given chunk is in the list

Parameters

chunk

a 4-byte chunk name

Returns

true if found, false if not

Definition at line 101 of file WavPropertyMap.cpp.

Referenced by Kwave::WavDecoder::open(), and ~WavPropertyMap().

{
    foreach(const Pair &p, QList<Pair>(*this)) {
        if (p.second == chunk)
            return true;
    }
    return false;
}

Here is the caller graph for this function:

containsProperty()

bool Kwave::WavPropertyMap::containsProperty

(

const Kwave::FileProperty

property

)

const

Returns true if the map contains a given property

Definition at line 90 of file WavPropertyMap.cpp.

Referenced by Kwave::WavEncoder::writeInfoChunk(), and ~WavPropertyMap().

{
    foreach(const Pair &p, QList<Pair>(*this)) {
        if (p.first == property)
            return true;
    }
    return false;
}

Here is the caller graph for this function:

findProperty()

QByteArray Kwave::WavPropertyMap::findProperty

(

const Kwave::FileProperty

property

)

const

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

Definition at line 79 of file WavPropertyMap.cpp.

Referenced by Kwave::WavEncoder::writeInfoChunk(), and ~WavPropertyMap().

{
    foreach(const Pair &p, QList<Pair>(*this)) {
        if (p.first == property)
            return p.second;
    }
    return "";
}

Here is the caller graph for this function:

insert()

void Kwave::WavPropertyMap::insert	(	const Kwave::FileProperty	property,
		const QByteArray &	chunk
	)

insert a new property / chunk mapping

Parameters

property	a Kwave FileProperty
chunk	a 4-byte chunk name

Definition at line 71 of file WavPropertyMap.cpp.

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

{
    Pair p(property, chunk);
    append(p);
}

Here is the caller graph for this function:

properties()

QList< Kwave::FileProperty > Kwave::WavPropertyMap::properties

(

)

const

Returns a list with all supported properties

Definition at line 132 of file WavPropertyMap.cpp.

Referenced by Kwave::WavEncoder::supportedProperties(), and ~WavPropertyMap().

{
    QList<Kwave::FileProperty> list;
    foreach(const Pair &p, QList<Pair>(*this)) {
        if (!list.contains(p.first))
            list.append(p.first);
    }
    return list;
}

Here is the caller graph for this function:

property()

Kwave::FileProperty Kwave::WavPropertyMap::property

(

const QByteArray &

chunk

)

const

Returns the first FileProperty that matches a given chunk

Parameters

chunk

a 4-byte chunk name

Returns

a FileProperty

Definition at line 122 of file WavPropertyMap.cpp.

Referenced by Kwave::WavDecoder::open(), and ~WavPropertyMap().

{
    foreach(const Pair &p, QList<Pair>(*this)) {
        if (p.second == chunk) return p.first;
    }
    return static_cast<Kwave::FileProperty>(-1);
}

Here is the caller graph for this function:

---

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

• plugins/codec_wav/WavPropertyMap.h
• plugins/codec_wav/WavPropertyMap.cpp