Tag Parser  6.5.1
C++ library for reading and writing MP4 (iTunes), ID3, Vorbis, Opus, FLAC and Matroska tags
Public Member Functions | Static Public Attributes | List of all members
Media::MatroskaTag Class Reference

Implementation of Media::Tag for the Matroska container. More...

#include <matroskatag.h>

Inheritance diagram for Media::MatroskaTag:
[legend]
Collaboration diagram for Media::MatroskaTag:
[legend]

Public Member Functions

 MatroskaTag ()
 Constructs a new tag. More...
 
TagType type () const
 Returns the type of the tag as Media::TagType. More...
 
const char * typeName () const
 Returns the type name of the tag as C-style string. More...
 
TagTextEncoding proposedTextEncoding () const
 Returns the proposed text encoding. More...
 
bool canEncodingBeUsed (TagTextEncoding encoding) const
 Returns an indication whether the specified encoding can be used to provide string values for the tag. More...
 
bool supportsTarget () const
 Returns an indication whether a target is supported by the tag. More...
 
TagTargetLevel targetLevel () const
 Returns the name of the current tag target level. More...
 
std::string fieldId (KnownField field) const
 Returns the ID for the specified field. More...
 
KnownField knownField (const std::string &id) const
 
void parse (EbmlElement &tagElement)
 Parses tag information from the specified tagElement. More...
 
MatroskaTagMaker prepareMaking ()
 Prepares making. More...
 
void make (std::ostream &stream)
 Writes tag information to the specified stream (makes a "Tag"-element). More...
 
- Public Member Functions inherited from Media::FieldMapBasedTag< MatroskaTagField >
 FieldMapBasedTag ()
 Constructs a new FieldMapBasedTag. More...
 
virtual const TagValuevalue (const typename MatroskaTagField ::identifierType &id) const
 Returns the value of the field with the specified id. More...
 
const TagValuevalue (KnownField field) const
 Returns the value of the specified field. More...
 
std::vector< const TagValue *> values (const typename MatroskaTagField ::identifierType &id) const
 Returns the values of the field with the specified id. More...
 
std::vector< const TagValue *> values (KnownField field) const
 Returns the values of the specified field. More...
 
virtual bool setValue (const typename MatroskaTagField ::identifierType &id, const TagValue &value)
 Assigns the given value to the field with the specified id. More...
 
bool setValue (KnownField field, const TagValue &value)
 Assigns the given value to the specified field. More...
 
bool setValues (const typename MatroskaTagField ::identifierType &id, const std::vector< TagValue > &values)
 Assigns the given values to the field with the specified id. More...
 
bool setValues (KnownField field, const std::vector< TagValue > &values)
 Assigns the given values to the field with the specified id. More...
 
bool hasField (KnownField field) const
 Returns an indication whether the specified field is present. More...
 
virtual bool hasField (const typename MatroskaTagField ::identifierType &id) const
 Returns an indication whether the field with the specified id is present. More...
 
void removeAllFields ()
 Removes all fields from the tag. More...
 
const std::multimap< typename MatroskaTagField ::identifierType, MatroskaTagField, std::less< typename MatroskaTagField ::identifierType > > & fields () const
 Returns the fields of the tag by providing direct access to the field map of the tag. More...
 
std::multimap< typename MatroskaTagField ::identifierType, MatroskaTagField, std::less< typename MatroskaTagField ::identifierType > > & fields ()
 Returns the fields of the tag by providing direct access to the field map of the tag. More...
 
unsigned int fieldCount () const
 Returns the number of present fields. More...
 
virtual KnownField knownField (const typename MatroskaTagField ::identifierType &id) const=0
 Returns the field for the specified ID. More...
 
bool supportsField (KnownField field) const
 Returns an indication whether the specified field is supported by the tag. More...
 
virtual TagDataType proposedDataType (const typename MatroskaTagField ::identifierType &id) const
 Returns the proposed data type for the field with the specified id. More...
 
virtual TagDataType proposedDataType (KnownField field) const
 Returns the proposed data type for the specified field as TagDataType. More...
 
int insertFields (const FieldMapBasedTag< MatroskaTagField, std::less< typename MatroskaTagField ::identifierType > > &from, bool overwrite)
 Inserts all fields from another tag of the same field type and compare function. More...
 
unsigned int insertValues (const Tag &from, bool overwrite)
 Inserts all compatible values from another Tag. More...
 
void ensureTextValuesAreProperlyEncoded ()
 Ensures the encoding of all assigned text values is supported by the tag by converting the character set if neccessary. More...
 
- Public Member Functions inherited from Media::Tag
virtual ~Tag ()
 Destroys the Tag. More...
 
std::string toString () const
 Returns a string representation of the tag. More...
 
const std::string & version () const
 Returns the version of the tag as std::string. More...
 
uint32 size () const
 Returns the size of the tag in bytes. More...
 
const TagTargettarget () const
 Returns the target of tag. More...
 
void setTarget (const TagTarget &target)
 Sets the target of tag. More...
 
const char * targetLevelName () const
 Returns the name of the current target level. More...
 
bool isTargetingLevel (TagTargetLevel tagTargetLevel) const
 Returns whether the tag is targeting the specified tagTargetLevel. More...
 
std::string targetString () const
 Returns the string representation for the assigned tag target. More...
 
virtual TagDataType proposedDataType (KnownField field) const
 Returns the proposed data type for the specified field as TagDataType. More...
 
virtual bool supportsDescription (KnownField field) const
 Returns an indications whether the specified field supports descriptions. More...
 
virtual bool supportsMimeType (KnownField field) const
 Returns an indications whether the specified field supports mime types. More...
 
- Public Member Functions inherited from Media::StatusProvider
const NotificationListnotifications () const
 Returns notifications for the current object. More...
 
bool hasNotifications () const
 Returns an indication whether there are notifications for the current object. More...
 
bool hasCriticalNotifications () const
 Returns an indication whether there are critical notifications for the current object. More...
 
NotificationType worstNotificationType () const
 Returns the worst notification type. More...
 
const std::string & currentStatus () const
 Returns a status information for the current object. More...
 
double currentPercentage () const
 Returns the progress percentage of the current object. More...
 
size_t registerCallback (CallbackFunction callback)
 Registers a callback function. More...
 
void unregisterCallback (size_t id)
 Unregisters a previously registered callback function whith the specified id. More...
 
void unregisterAllCallbacks ()
 Unregisters all callback functions. More...
 
void forwardStatusUpdateCalls (StatusProvider *other=nullptr)
 Forwards all status updates calls to the specified statusProvider. More...
 
StatusProviderusedProvider ()
 Returns the provider which callback functions will be called when the status or the percentage is updated. More...
 
void tryToAbort ()
 Commands the object to abort the current operation. More...
 
bool isAborted () const
 Returns an indication whether the current operation should be aborted. More...
 
void invalidateStatus ()
 Invalidates the current status. More...
 
void invalidateNotifications ()
 Invalidates the object's notifications. More...
 
void updateStatus (const std::string &status)
 This method is meant to be called by the derived class to report updated status information. More...
 
void updateStatus (const std::string &status, double percentage)
 This method is meant to be called by the derived class to report updated status information. More...
 
void updatePercentage (double percentage)
 This method is meant to be called by the derived class to report updated progress percentage only. More...
 
void addNotification (const Notification &notification)
 This method is meant to be called by the derived class to add a notification. More...
 
void addNotification (NotificationType type, const std::string &message, const std::string &context)
 This method is meant to be called by the derived class to add a notification of the specified type, message and context. More...
 
void addNotifications (const StatusProvider &from)
 This method is meant to be called by the derived class to add all notifications from another StatusProvider instance. More...
 
void addNotifications (const std::string &higherContext, const StatusProvider &from)
 This method is meant to be called by the derived class to add all notifications from another StatusProvider instance. More...
 
void addNotifications (const NotificationList &notifications)
 This method is meant to be called by the derived class to add the specified notifications. More...
 

Static Public Attributes

static constexpr TagType tagType = TagType::MatroskaTag
 

Additional Inherited Members

- Public Types inherited from Media::FieldMapBasedTag< MatroskaTagField >
typedef MatroskaTagField fieldType
 
- Public Types inherited from Media::StatusProvider
typedef std::function< void(StatusProvider &sender)> CallbackFunction
 
typedef std::vector< CallbackFunctionCallbackVector
 
typedef std::pair< int, CallbackFunctionCallbackPair
 
- Protected Member Functions inherited from Media::Tag
 Tag ()
 Constructs a new Tag. More...
 
- Protected Member Functions inherited from Media::StatusProvider
 StatusProvider ()
 Constructs a new StatusProvider. More...
 
- Protected Attributes inherited from Media::Tag
std::string m_version
 
uint32 m_size
 
TagTarget m_target
 

Detailed Description

Implementation of Media::Tag for the Matroska container.

Definition at line 50 of file matroskatag.h.

Constructor & Destructor Documentation

◆ MatroskaTag()

Media::MatroskaTag::MatroskaTag ( )
inline

Constructs a new tag.

Definition at line 78 of file matroskatag.h.

Member Function Documentation

◆ canEncodingBeUsed()

bool Media::MatroskaTag::canEncodingBeUsed ( TagTextEncoding  encoding) const
inlinevirtual

Returns an indication whether the specified encoding can be used to provide string values for the tag.

Only the proposedTextEncoding() is accepted by default. This might be overwritten when subclassing.

The tag class and its subclasses do not perform any conversions. You have to provide all string values using an encoding which is appropriate for the specific tag type. This method is meant to determine if a particular encoding can be used.

See also
canEncodingBeUsed()

Reimplemented from Media::Tag.

Definition at line 106 of file matroskatag.h.

◆ fieldId()

std::string Media::MatroskaTag::fieldId ( KnownField  value) const
virtual

Returns the ID for the specified field.

Needs to be implemented when subclassing.

Implements Media::FieldMapBasedTag< MatroskaTagField >.

Definition at line 18 of file matroskatag.cpp.

◆ knownField()

KnownField Media::MatroskaTag::knownField ( const std::string &  id) const

Definition at line 48 of file matroskatag.cpp.

◆ make()

void Media::MatroskaTag::make ( std::ostream &  stream)

Writes tag information to the specified stream (makes a "Tag"-element).

Exceptions
Throwsstd::ios_base::failure when an IO error occurs.
ThrowsMedia::Failure or a derived exception when a making error occurs.
See also
prepareMaking()
Todo:
Make inline in next major release.

Definition at line 138 of file matroskatag.cpp.

◆ parse()

void Media::MatroskaTag::parse ( EbmlElement tagElement)

Parses tag information from the specified tagElement.

Exceptions
Throwsstd::ios_base::failure when an IO error occurs.
ThrowsMedia::Failure or a derived exception when a parsing error occurs.

Definition at line 88 of file matroskatag.cpp.

◆ prepareMaking()

MatroskaTagMaker Media::MatroskaTag::prepareMaking ( )

Prepares making.

Returns
Returns a MatroskaTagMaker object which can be used to actually make the tag.
Remarks
The tag must NOT be mutated after making is prepared when it is intended to actually make the tag using the make() method of the returned object.
Exceptions
ThrowsMedia::Failure or a derived exception when a making error occurs.

This method might be useful when it is necessary to know the size of the tag before making it.

See also
make()
Todo:
Make inline in next major release.

Definition at line 125 of file matroskatag.cpp.

◆ proposedTextEncoding()

TagTextEncoding Media::MatroskaTag::proposedTextEncoding ( ) const
inlinevirtual

Returns the proposed text encoding.

This is TagTextEncoding::Latin1 by default an might be overwritten when subclassing.

The tag class and its subclasses do not perform any conversions. You have to provide all string values using an encoding which is appropriate for the specific tag type. This method returns such an encoding.

See also
canEncodingBeUsed()

Reimplemented from Media::Tag.

Definition at line 101 of file matroskatag.h.

◆ supportsTarget()

bool Media::MatroskaTag::supportsTarget ( ) const
inlinevirtual

Returns an indication whether a target is supported by the tag.

If no target is supported, setting a target using setTarget() has no effect when saving the tag.

Most tag types don't support this feature so the default implementation returns always false. This might be overwritten when subclassing.

Reimplemented from Media::Tag.

Definition at line 81 of file matroskatag.h.

◆ targetLevel()

TagTargetLevel Media::MatroskaTag::targetLevel ( ) const
inlinevirtual

Returns the name of the current tag target level.

Remarks
Returns TagTargetLevel::Unspecified if target levels are not supported by the tag.

Reimplemented from Media::Tag.

Definition at line 86 of file matroskatag.h.

◆ type()

TagType Media::MatroskaTag::type ( ) const
inlinevirtual

Returns the type of the tag as Media::TagType.

This is TagType::Unspecified by default and might be overwritten when subclassing.

Reimplemented from Media::Tag.

Definition at line 91 of file matroskatag.h.

◆ typeName()

const char * Media::MatroskaTag::typeName ( ) const
inlinevirtual

Returns the type name of the tag as C-style string.

This is "unspecified" by default and might be overwritten when subclassing.

Reimplemented from Media::Tag.

Definition at line 96 of file matroskatag.h.

Member Data Documentation

◆ tagType

constexpr TagType Media::MatroskaTag::tagType = TagType::MatroskaTag
static

Definition at line 55 of file matroskatag.h.


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