Tag Parser  8.0.1
C++ library for reading and writing MP4 (iTunes), ID3, Vorbis, Opus, FLAC and Matroska tags
Public Member Functions | Static Public Member Functions | Protected Member Functions | Friends | List of all members
TagParser::MatroskaTrack Class Reference

Implementation of TagParser::AbstractTrack for the Matroska container. More...

#include <matroskatrack.h>

Inheritance diagram for TagParser::MatroskaTrack:
[legend]
Collaboration diagram for TagParser::MatroskaTrack:
[legend]

Public Member Functions

 MatroskaTrack (EbmlElement &trackElement)
 Constructs a new track for the specified trackElement. More...
 
 ~MatroskaTrack () override
 Destroys the track. More...
 
TrackType type () const override
 Returns the type of the track if known; otherwise returns TrackType::Unspecified. More...
 
void readStatisticsFromTags (const std::vector< std::unique_ptr< MatroskaTag >> &tags, Diagnostics &diag)
 Reads track-specific statistics from the specified tags. More...
 
MatroskaTrackHeaderMaker prepareMakingHeader (Diagnostics &diag) const
 Prepares making header. More...
 
void makeHeader (std::ostream &stream, Diagnostics &diag) const
 Writes header information to the specified stream (makes a "TrackEntry"-element). More...
 
- Public Member Functions inherited from TagParser::AbstractTrack
virtual ~AbstractTrack ()
 Destroys the track. More...
 
std::istream & inputStream ()
 Returns the associated input stream. More...
 
void setInputStream (std::istream &stream)
 Assigns another input stream. More...
 
std::ostream & outputStream ()
 Returns the associated output stream. More...
 
void setOutputStream (std::ostream &stream)
 Assigns another output stream. More...
 
IoUtilities::BinaryReader & reader ()
 Returns a binary reader for the associated stream. More...
 
IoUtilities::BinaryWriter & writer ()
 Returns a binary writer for the associated stream. More...
 
uint64 startOffset () const
 Returns the start offset of the track in the associated stream. More...
 
MediaFormat format () const
 Returns the format of the track if known; otherwise returns MediaFormat::Unknown. More...
 
double version () const
 Returns the version/level of the track if known; otherwise returns 0. More...
 
const char * formatName () const
 Returns the format of the track as C-style string if known; otherwise returns the format abbreviation or an empty string. More...
 
const char * formatAbbreviation () const
 Returns the a more or less common abbreviation for the format of the track as C-style string if known; otherwise returns an empty string. More...
 
const std::string & formatId () const
 Returns the format/codec ID. More...
 
MediaType mediaType () const
 Returns the media type if known; otherwise returns MediaType::Other. More...
 
const char * mediaTypeName () const
 Returns the string representation of the media type of the track. More...
 
uint64 size () const
 Returns the size in bytes if known; otherwise returns 0. More...
 
uint32 trackNumber () const
 Returns the track number if known; otherwise returns 0. More...
 
void setTrackNumber (uint32 trackNumber)
 Sets the track number. More...
 
uint64 id () const
 Returns the track ID if known; otherwise returns 0. More...
 
void setId (uint64 id)
 Sets the track ID. More...
 
const std::string name () const
 Returns the track name if known; otherwise returns an empty string. More...
 
void setName (const std::string &name)
 Sets the name. More...
 
const ChronoUtilities::TimeSpanduration () const
 Returns the duration if known; otherwise returns a TimeSpan of zero ticks. More...
 
double bitrate () const
 Returns the average bitrate in kbit/s if known; otherwise returns zero. More...
 
double maxBitrate () const
 Returns the maximum bitrate in kbit/s if known; otherwise returns zero. More...
 
const ChronoUtilities::DateTimecreationTime () const
 Returns the creation time if known; otherwise returns a DateTime of zero ticks. More...
 
const ChronoUtilities::DateTimemodificationTime () const
 Returns the time of the last modification if known; otherwise returns a DateTime of zero ticks. More...
 
const std::string & language () const
 Returns the language of the track if known; otherwise returns an empty string. More...
 
void setLanguage (const std::string &language)
 Sets the language of the track. More...
 
uint32 samplingFrequency () const
 Returns the number of samples per second if known; otherwise returns 0. More...
 
uint32 extensionSamplingFrequency () const
 Returns the number of samples per second if known; otherwise returns 0. More...
 
uint16 bitsPerSample () const
 Returns the number of bits per sample; otherwise returns 0. More...
 
uint16 channelCount () const
 Returns the number of channels if known; otherwise returns 0. More...
 
byte channelConfig () const
 Returns the channel configuration. More...
 
const char * channelConfigString () const
 Returns a string with the channel configuration if available; otherwise returns nullptr. More...
 
byte extensionChannelConfig () const
 Returns the extension channel configuration if available; otherwise returns nullptr. More...
 
const char * extensionChannelConfigString () const
 Returns a string with the extension channel configuration if available; otherwise returns nullptr. More...
 
uint64 sampleCount () const
 Returns the number of samples/frames if known; otherwise returns 0. More...
 
int quality () const
 Returns the quality if known; otherwise returns 0. More...
 
const SizepixelSize () const
 Returns the size of the encoded video frames if known; otherwise returns a zero size. More...
 
const SizedisplaySize () const
 Returns the size of the video frames to display if known; otherwise returns a zero size. More...
 
const Sizeresolution () const
 Returns the resolution if known; otherwise returns a zero size. More...
 
const std::string & compressorName () const
 Returns the compressor name if known; otherwise returns an empty string. More...
 
void setCompressorName (const std::string &compressorName)
 Returns the compressor name if known; otherwise returns an empty string. More...
 
uint16 depth () const
 Returns the bit depth if known; otherwise returns 0. More...
 
uint32 fps () const
 Returns the number of frames per second if known; otherwise returns 0. More...
 
const char * chromaFormat () const
 Returns the chroma subsampling format if known; otherwise returns nullptr. More...
 
const AspectRatiopixelAspectRatio () const
 Returns the pixel aspect ratio (PAR). More...
 
bool isInterlaced () const
 Returns true if the video is denoted as interlaced; otherwise returns false. More...
 
uint32 timeScale () const
 Returns the time scale if known; otherwise returns 0. More...
 
bool isEnabled () const
 Returns true if the track is denoted as enabled; otherwise returns false. More...
 
void setEnabled (bool enabled)
 Sets whether the track is enabled. More...
 
bool isDefault () const
 Returns true if the track is denoted as default; otherwise returns false. More...
 
void setDefault (bool isDefault)
 Sets whether the track is a default track. More...
 
bool isForced () const
 Returns true if the track is denoted as forced; otherwise returns false. More...
 
void setForced (bool forced)
 Sets whether the track is forced. More...
 
bool hasLacing () const
 Returns true if the track has lacing; otherwise returns false. More...
 
bool isEncrypted () const
 Returns true if the track is denoted as encrypted; otherwise returns false. More...
 
uint32 colorSpace () const
 Returns the color space if known; otherwise returns 0. More...
 
const Margincropping () const
 Returns the cropping if known; otherwise returns zero margins. More...
 
std::string label () const
 Returns a label for the track. More...
 
std::string description () const
 Returns a short description about the track. More...
 
void parseHeader (Diagnostics &diag)
 Parses technical information about the track from the header. More...
 
bool isHeaderValid () const
 Returns an indication whether the track header is valid. More...
 

Static Public Member Functions

static MediaFormat codecIdToMediaFormat (const std::string &codecId)
 Returns the MediaFormat for the specified Matroska codec ID. More...
 

Protected Member Functions

void internalParseHeader (Diagnostics &diag) override
 This method is internally called to parse header information. More...
 
- Protected Member Functions inherited from TagParser::AbstractTrack
 AbstractTrack (std::istream &inputStream, std::ostream &outputStream, uint64 startOffset)
 Constructs a new track. More...
 
 AbstractTrack (std::iostream &stream, uint64 startOffset)
 Constructs a new track. More...
 

Friends

class MatroskaContainer
 
class MatroskaTrackHeaderMaker
 

Additional Inherited Members

- Protected Attributes inherited from TagParser::AbstractTrack
std::istream * m_istream
 
std::ostream * m_ostream
 
IoUtilities::BinaryReader m_reader
 
IoUtilities::BinaryWriter m_writer
 
uint64 m_startOffset
 
bool m_headerValid
 
MediaFormat m_format
 
std::string m_formatId
 
std::string m_formatName
 
MediaType m_mediaType
 
double m_version
 
uint64 m_size
 
uint32 m_trackNumber
 
uint64 m_id
 
std::string m_name
 
ChronoUtilities::TimeSpan m_duration
 
double m_bitrate
 
double m_maxBitrate
 
ChronoUtilities::DateTime m_creationTime
 
ChronoUtilities::DateTime m_modificationTime
 
std::string m_language
 
uint32 m_samplingFrequency
 
uint32 m_extensionSamplingFrequency
 
uint16 m_bitsPerSample
 
uint32 m_bytesPerSecond
 
uint16 m_channelCount
 
byte m_channelConfig
 
byte m_extensionChannelConfig
 
uint16 m_chunkSize
 
uint64 m_sampleCount
 
int m_quality
 
Size m_pixelSize
 
Size m_displaySize
 
Size m_resolution
 
std::string m_compressorName
 
uint16 m_depth
 
uint32 m_fps
 
const char * m_chromaFormat
 
AspectRatio m_pixelAspectRatio
 
bool m_interlaced
 
uint32 m_timeScale
 
bool m_enabled
 
bool m_default
 
bool m_forced
 
bool m_lacing
 
bool m_encrypted
 
bool m_usedInPresentation
 
bool m_usedWhenPreviewing
 
uint32 m_colorSpace
 
Margin m_cropping
 

Detailed Description

Implementation of TagParser::AbstractTrack for the Matroska container.

Definition at line 46 of file matroskatrack.h.

Constructor & Destructor Documentation

◆ MatroskaTrack()

TagParser::MatroskaTrack::MatroskaTrack ( EbmlElement trackElement)

Constructs a new track for the specified trackElement.

Each track element (ID: MatroskaId::TrackEntry) holds header information for one track in the Matroska file.

Definition at line 37 of file matroskatrack.cpp.

◆ ~MatroskaTrack()

TagParser::MatroskaTrack::~MatroskaTrack ( )
override

Destroys the track.

Definition at line 46 of file matroskatrack.cpp.

Member Function Documentation

◆ codecIdToMediaFormat()

MediaFormat TagParser::MatroskaTrack::codecIdToMediaFormat ( const std::string &  codecId)
static

Returns the MediaFormat for the specified Matroska codec ID.

Definition at line 58 of file matroskatrack.cpp.

◆ internalParseHeader()

void TagParser::MatroskaTrack::internalParseHeader ( Diagnostics diag)
overrideprotectedvirtual

This method is internally called to parse header information.

It needs to be implemented when subclassing this class.

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

Implements TagParser::AbstractTrack.

Definition at line 283 of file matroskatrack.cpp.

◆ makeHeader()

void TagParser::MatroskaTrack::makeHeader ( std::ostream &  stream,
Diagnostics diag 
) const
inline

Writes header information to the specified stream (makes a "TrackEntry"-element).

Exceptions
Throwsstd::ios_base::failure when an IO error occurs.
ThrowsTagParser::Failure or a derived exception when a making error occurs.
See also
prepareMaking()

Definition at line 96 of file matroskatrack.h.

◆ prepareMakingHeader()

MatroskaTrackHeaderMaker TagParser::MatroskaTrack::prepareMakingHeader ( Diagnostics diag) const
inline

Prepares making header.

Returns
Returns a MatroskaTrackHeaderMaker object which can be used to actually make the track header.
Remarks
The track 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
ThrowsTagParser::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 track header before making it.

See also
make()

Definition at line 84 of file matroskatrack.h.

◆ readStatisticsFromTags()

void TagParser::MatroskaTrack::readStatisticsFromTags ( const std::vector< std::unique_ptr< MatroskaTag >> &  tags,
Diagnostics diag 
)

Reads track-specific statistics from the specified tags.

Remarks
  • Those statistics are generated might be generated by some Muxers, eg. mkvmerge 7.0.0 or newer.
  • Only tags targeting the track are considered. Hence the track ID must have been determined before (either by calling parseHeader() or setId()).
See also
https://github.com/mbunkus/mkvtoolnix/wiki/Automatic-tag-generation for list of track-specific tag fields written by mkvmerge

Definition at line 263 of file matroskatrack.cpp.

◆ type()

TrackType TagParser::MatroskaTrack::type ( ) const
overridevirtual

Returns the type of the track if known; otherwise returns TrackType::Unspecified.

Reimplemented from TagParser::AbstractTrack.

Definition at line 50 of file matroskatrack.cpp.

Friends And Related Function Documentation

◆ MatroskaContainer

friend class MatroskaContainer
friend

Definition at line 47 of file matroskatrack.h.

◆ MatroskaTrackHeaderMaker

friend class MatroskaTrackHeaderMaker
friend

Definition at line 48 of file matroskatrack.h.


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