TagLib
2.0.2
|
A module file tag implementation. More...
#include <modtag.h>
Public Member Functions | |
Tag () | |
~Tag () override | |
Tag (const Tag &)=delete | |
Tag & | operator= (const Tag &)=delete |
String | title () const override |
String | artist () const override |
String | album () const override |
String | comment () const override |
String | genre () const override |
unsigned int | year () const override |
unsigned int | track () const override |
String | trackerName () const |
void | setTitle (const String &title) override |
void | setArtist (const String &artist) override |
void | setAlbum (const String &album) override |
void | setComment (const String &comment) override |
void | setGenre (const String &genre) override |
void | setYear (unsigned int year) override |
void | setTrack (unsigned int track) override |
void | setTrackerName (const String &trackerName) |
PropertyMap | properties () const override |
PropertyMap | setProperties (const PropertyMap &) override |
![]() | |
Tag (const Tag &)=delete | |
Tag & | operator= (const Tag &)=delete |
virtual void | removeUnsupportedProperties (const StringList &properties) |
virtual StringList | complexPropertyKeys () const |
virtual List< VariantMap > | complexProperties (const String &key) const |
virtual bool | setComplexProperties (const String &key, const List< VariantMap > &value) |
virtual bool | isEmpty () const |
Additional Inherited Members | |
![]() | |
static void | duplicate (const Tag *source, Tag *target, bool overwrite=true) |
static String | joinTagValues (const StringList &values) |
![]() | |
Tag () | |
A module file tag implementation.
Tags for module files (Mod, S3M, IT, XM).
Note that only the title is supported as such by most module file formats. Except for XM files the trackerName is derived from the file format or the flavour of the file format. For XM files it is stored in the file.
The comment tag is not strictly supported by module files, but it is common practice to abuse instrument/sample/pattern names as multiline comments. TagLib does so as well.
TagLib::Mod::Tag::Tag | ( | ) |
Referenced by operator=(), and Tag().
|
overridevirtual |
Destroys this Tag instance.
Reimplemented from TagLib::Tag.
|
overridevirtual |
Not supported by module files. Therefore always returns an empty string.
Implements TagLib::Tag.
Referenced by setAlbum().
|
overridevirtual |
Not supported by module files. Therefore always returns an empty string.
Implements TagLib::Tag.
Referenced by setArtist().
|
overridevirtual |
Returns the track comment derived from the instrument/sample/pattern names; if no comment is present in the tag an empty string will be returned.
Implements TagLib::Tag.
Referenced by setComment().
|
overridevirtual |
Not supported by module files. Therefore always returns an empty string.
Implements TagLib::Tag.
Referenced by setGenre().
|
overridevirtual |
Implements the unified property interface – export function. Since the module tag is very limited, the exported map is as well.
Reimplemented from TagLib::Tag.
|
overridevirtual |
|
overridevirtual |
|
overridevirtual |
Sets the comment to comment. If comment is an empty string then this value will be cleared.
Note that module file formats don't actually support a comment tag. Instead the names of instruments/patterns/samples are abused as a multiline comment. Because of this the number of lines in a module file is fixed to the number of instruments/patterns/samples.
Also note that the instrument/pattern/sample name length is limited and thus the line length in comments are limited. Too big comments will be truncated.
The line length limits per file type are (1 character = 1 byte): Mod 22 characters, S3M 27 characters, IT 25 characters and XM 22 characters.
Implements TagLib::Tag.
References comment().
|
overridevirtual |
|
overridevirtual |
Implements the unified property interface – import function. Because of the limitations of the module file tag, any tags besides COMMENT, TITLE and, if it is an XM file, TRACKERNAME, will be returned. Additionally, if the map contains tags with multiple values, all but the first will be contained in the returned map of unsupported properties.
Reimplemented from TagLib::Tag.
References TAGLIB_MSVC_SUPPRESS_WARNING_NEEDS_TO_HAVE_DLL_INTERFACE.
|
overridevirtual |
|
overridevirtual |
void TagLib::Mod::Tag::setTrackerName | ( | const String & | trackerName | ) |
Sets the tracker name to trackerName. If trackerName is an empty string then this value will be cleared.
Note that only XM files support this tag. Setting the tracker name for other module file formats will be ignored.
The length of this tag is limited to 20 characters (1 character = 1 byte).
References trackerName().
|
overridevirtual |
|
overridevirtual |
Returns the track name; if no track name is present in the tag an empty string will be returned.
Implements TagLib::Tag.
Referenced by setTitle().
|
overridevirtual |
Not supported by module files. Therefore always returns 0.
Implements TagLib::Tag.
Referenced by setTrack().
String TagLib::Mod::Tag::trackerName | ( | ) | const |
Returns the name of the tracker used to create/edit the module file. Only XM files store this tag to the file as such, for other formats (Mod, S3M, IT) this is derived from the file type or the flavour of the file type. Therefore only XM files might have an empty tracker name.
Referenced by setTrackerName().
|
overridevirtual |
Not supported by module files. Therefore always returns 0.
Implements TagLib::Tag.
Referenced by setYear().