Tag Parser
7.0.0
C++ library for reading and writing MP4 (iTunes), ID3, Vorbis, Opus, FLAC and Matroska tags
|
#include <abstracttrack.h>
Public Member Functions | |
virtual | ~AbstractTrack () |
Destroys the track. More... | |
virtual TrackType | type () const |
Returns the type of the track if known; otherwise returns TrackType::Unspecified. 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::TimeSpan & | duration () 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::DateTime & | creationTime () const |
Returns the creation time if known; otherwise returns a DateTime of zero ticks. More... | |
const ChronoUtilities::DateTime & | modificationTime () 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 Size & | pixelSize () const |
Returns the size of the encoded video frames if known; otherwise returns a zero size. More... | |
const Size & | displaySize () const |
Returns the size of the video frames to display if known; otherwise returns a zero size. More... | |
const Size & | resolution () 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 AspectRatio & | pixelAspectRatio () 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 Margin & | cropping () 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... | |
Protected Member Functions | |
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... | |
virtual void | internalParseHeader (Diagnostics &diag)=0 |
This method is internally called to parse header information. More... | |
Friends | |
class | MpegAudioFrameStream |
class | WaveAudioStream |
class | Mp4Track |
Definition at line 39 of file abstracttrack.h.
|
virtual |
Destroys the track.
Definition at line 87 of file abstracttrack.cpp.
|
protected |
Constructs a new track.
inputStream | Specifies the stream the track will read from to perform particular operations such as reading header information. |
outputStream | Specifies the stream the track will write to to perform particular operations such as updating or making header information. |
startOffset | The start offset of the track in the specified stream. |
Definition at line 32 of file abstracttrack.cpp.
|
protected |
Constructs a new track.
stream | Specifies the stream the track will read from or write to to perform particular operations such as reading header information. |
startOffset | The start offset of the track in the specified stream. |
Definition at line 79 of file abstracttrack.cpp.
|
inline |
Returns the average bitrate in kbit/s if known; otherwise returns zero.
Definition at line 379 of file abstracttrack.h.
|
inline |
Returns the number of bits per sample; otherwise returns 0.
Definition at line 447 of file abstracttrack.h.
|
inline |
Returns the channel configuration.
This is the MPEG-4 channel config for MPEG-4 audio.
Definition at line 468 of file abstracttrack.h.
const char * TagParser::AbstractTrack::channelConfigString | ( | ) | const |
Returns a string with the channel configuration if available; otherwise returns nullptr.
Definition at line 94 of file abstracttrack.cpp.
|
inline |
Returns the number of channels if known; otherwise returns 0.
This value only makes sense for audio tracks.
Definition at line 457 of file abstracttrack.h.
|
inline |
Returns the chroma subsampling format if known; otherwise returns nullptr.
This value only makes sense for video tracks.
Definition at line 561 of file abstracttrack.h.
|
inline |
Returns the color space if known; otherwise returns 0.
Definition at line 664 of file abstracttrack.h.
|
inline |
Returns the compressor name if known; otherwise returns an empty string.
Definition at line 524 of file abstracttrack.h.
|
inline |
Returns the creation time if known; otherwise returns a DateTime of zero ticks.
Definition at line 395 of file abstracttrack.h.
|
inline |
Returns the cropping if known; otherwise returns zero margins.
Definition at line 672 of file abstracttrack.h.
|
inline |
Returns the bit depth if known; otherwise returns 0.
Definition at line 541 of file abstracttrack.h.
string TagParser::AbstractTrack::description | ( | ) | const |
Returns a short description about the track.
The description contains the abbreviated format and further information depending on the media type (eg. display size in case of video, language in case of audio/text). It is intended to be joined with descriptions of other tracks to get a short technical description about the file.
Examples (exact format might change in the future!):
Definition at line 159 of file abstracttrack.cpp.
|
inline |
Returns the size of the video frames to display if known; otherwise returns a zero size.
This value only makes sense for video tracks.
Definition at line 506 of file abstracttrack.h.
|
inline |
Returns the duration if known; otherwise returns a TimeSpan of zero ticks.
Definition at line 371 of file abstracttrack.h.
byte TagParser::AbstractTrack::extensionChannelConfig | ( | ) | const |
Returns the extension channel configuration if available; otherwise returns nullptr.
Definition at line 110 of file abstracttrack.cpp.
const char * TagParser::AbstractTrack::extensionChannelConfigString | ( | ) | const |
Returns a string with the extension channel configuration if available; otherwise returns nullptr.
Definition at line 118 of file abstracttrack.cpp.
|
inline |
Returns the number of samples per second if known; otherwise returns 0.
Definition at line 439 of file abstracttrack.h.
|
inline |
Returns the format of the track if known; otherwise returns MediaFormat::Unknown.
Definition at line 249 of file abstracttrack.h.
|
inline |
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.
Definition at line 278 of file abstracttrack.h.
|
inline |
Returns the format/codec ID.
This is usually the raw format identifier extracted from the container) if known; otherwise returns an empty string.
Definition at line 288 of file abstracttrack.h.
|
inline |
Returns the format of the track as C-style string if known; otherwise returns the format abbreviation or an empty string.
Definition at line 269 of file abstracttrack.h.
|
inline |
Returns the number of frames per second if known; otherwise returns 0.
This value only makes sense for video tracks.
Definition at line 551 of file abstracttrack.h.
|
inline |
Returns true if the track has lacing; otherwise returns false.
Definition at line 648 of file abstracttrack.h.
|
inline |
Returns the track ID if known; otherwise returns 0.
Definition at line 337 of file abstracttrack.h.
|
inline |
Returns the associated input stream.
Definition at line 173 of file abstracttrack.h.
|
protectedpure virtual |
This method is internally called to parse header information.
It needs to be implemented when subclassing this class.
Throws | std::ios_base::failure when an IO error occurs. |
Throws | Media::Failure or a derived exception when a parsing error occurs. |
Implemented in TagParser::Mp4Track, TagParser::MatroskaTrack, TagParser::WaveAudioStream, TagParser::FlacStream, TagParser::OggStream, TagParser::MpegAudioFrameStream, and TagParser::AdtsStream.
|
inline |
Returns true if the track is denoted as default; otherwise returns false.
Definition at line 614 of file abstracttrack.h.
|
inline |
Returns true if the track is denoted as enabled; otherwise returns false.
Definition at line 597 of file abstracttrack.h.
|
inline |
Returns true if the track is denoted as encrypted; otherwise returns false.
Definition at line 656 of file abstracttrack.h.
|
inline |
Returns true if the track is denoted as forced; otherwise returns false.
Definition at line 631 of file abstracttrack.h.
|
inline |
Returns an indication whether the track header is valid.
Definition at line 680 of file abstracttrack.h.
|
inline |
Returns true if the video is denoted as interlaced; otherwise returns false.
This value only makes sense for video tracks.
Definition at line 579 of file abstracttrack.h.
string TagParser::AbstractTrack::label | ( | ) | const |
Returns a label for the track.
The label contains the ID, type, name and language of the track. It is intended to be used in a menu for selecting a track from the file.
Definition at line 134 of file abstracttrack.cpp.
|
inline |
Returns the language of the track if known; otherwise returns an empty string.
The format of the language denotation depends on the particular implementation.
Definition at line 413 of file abstracttrack.h.
|
inline |
Returns the maximum bitrate in kbit/s if known; otherwise returns zero.
Definition at line 387 of file abstracttrack.h.
|
inline |
Returns the media type if known; otherwise returns MediaType::Other.
Definition at line 296 of file abstracttrack.h.
|
inline |
Returns the string representation of the media type of the track.
Definition at line 304 of file abstracttrack.h.
|
inline |
Returns the time of the last modification if known; otherwise returns a DateTime of zero ticks.
Definition at line 403 of file abstracttrack.h.
|
inline |
Returns the track name if known; otherwise returns an empty string.
Definition at line 354 of file abstracttrack.h.
|
inline |
Returns the associated output stream.
Definition at line 192 of file abstracttrack.h.
void TagParser::AbstractTrack::parseHeader | ( | Diagnostics & | diag | ) |
Parses technical information about the track from the header.
The information will be read from the associated stream. The stream and the start offset of the track have been specified when constructing the Track.
The parsed information can be accessed using the corresponding methods.
Throws | std::ios_base::failure when an IO error occurs. |
Throws | Media::Failure or a derived exception when a parsing error occurs. |
Definition at line 211 of file abstracttrack.cpp.
|
inline |
Returns the pixel aspect ratio (PAR).
Definition at line 569 of file abstracttrack.h.
|
inline |
Returns the size of the encoded video frames if known; otherwise returns a zero size.
This value only makes sense for video tracks.
Definition at line 496 of file abstracttrack.h.
|
inline |
Returns the quality if known; otherwise returns 0.
The scale depends on the format.
Definition at line 486 of file abstracttrack.h.
|
inline |
Returns a binary reader for the associated stream.
Definition at line 214 of file abstracttrack.h.
|
inline |
Returns the resolution if known; otherwise returns a zero size.
This value only makes sense for video tracks.
Definition at line 516 of file abstracttrack.h.
|
inline |
Returns the number of samples/frames if known; otherwise returns 0.
Definition at line 476 of file abstracttrack.h.
|
inline |
Returns the number of samples per second if known; otherwise returns 0.
Definition at line 430 of file abstracttrack.h.
|
inline |
Returns the compressor name if known; otherwise returns an empty string.
Definition at line 533 of file abstracttrack.h.
|
inline |
Sets whether the track is a default track.
Definition at line 623 of file abstracttrack.h.
|
inline |
Sets whether the track is enabled.
Definition at line 606 of file abstracttrack.h.
|
inline |
Sets whether the track is forced.
Definition at line 640 of file abstracttrack.h.
|
inline |
Sets the track ID.
Definition at line 346 of file abstracttrack.h.
|
inline |
Assigns another input stream.
The track will read from the stream to perform particular operations such as reading header information.
Definition at line 184 of file abstracttrack.h.
|
inline |
Sets the language of the track.
Definition at line 422 of file abstracttrack.h.
|
inline |
Sets the name.
Definition at line 363 of file abstracttrack.h.
|
inline |
Assigns another output stream.
The track will write to the stream to perform particular operations such as updating or making header information.
Definition at line 203 of file abstracttrack.h.
|
inline |
Sets the track number.
Definition at line 329 of file abstracttrack.h.
|
inline |
Returns the size in bytes if known; otherwise returns 0.
Definition at line 312 of file abstracttrack.h.
|
inline |
Returns the start offset of the track in the associated stream.
Definition at line 241 of file abstracttrack.h.
|
inline |
Returns the time scale if known; otherwise returns 0.
The time scale depends on the format.
Definition at line 589 of file abstracttrack.h.
|
inline |
Returns the track number if known; otherwise returns 0.
Definition at line 320 of file abstracttrack.h.
|
inlinevirtual |
Returns the type of the track if known; otherwise returns TrackType::Unspecified.
Reimplemented in TagParser::Mp4Track, TagParser::MatroskaTrack, TagParser::WaveAudioStream, TagParser::OggStream, TagParser::FlacStream, TagParser::MpegAudioFrameStream, and TagParser::AdtsStream.
Definition at line 233 of file abstracttrack.h.
|
inline |
Returns the version/level of the track if known; otherwise returns 0.
Definition at line 257 of file abstracttrack.h.
|
inline |
Returns a binary writer for the associated stream.
Definition at line 225 of file abstracttrack.h.
|
friend |
Definition at line 42 of file abstracttrack.h.
|
friend |
Definition at line 40 of file abstracttrack.h.
|
friend |
Definition at line 41 of file abstracttrack.h.
|
protected |
Definition at line 134 of file abstracttrack.h.
|
protected |
Definition at line 141 of file abstracttrack.h.
|
protected |
Definition at line 142 of file abstracttrack.h.
|
protected |
Definition at line 144 of file abstracttrack.h.
|
protected |
Definition at line 143 of file abstracttrack.h.
|
protected |
Definition at line 155 of file abstracttrack.h.
|
protected |
Definition at line 146 of file abstracttrack.h.
|
protected |
Definition at line 166 of file abstracttrack.h.
|
protected |
Definition at line 152 of file abstracttrack.h.
|
protected |
Definition at line 136 of file abstracttrack.h.
|
protected |
Definition at line 167 of file abstracttrack.h.
|
protected |
Definition at line 160 of file abstracttrack.h.
|
protected |
Definition at line 153 of file abstracttrack.h.
|
protected |
Definition at line 150 of file abstracttrack.h.
|
protected |
Definition at line 133 of file abstracttrack.h.
|
protected |
Definition at line 159 of file abstracttrack.h.
|
protected |
Definition at line 163 of file abstracttrack.h.
|
protected |
Definition at line 145 of file abstracttrack.h.
|
protected |
Definition at line 140 of file abstracttrack.h.
|
protected |
Definition at line 161 of file abstracttrack.h.
|
protected |
Definition at line 124 of file abstracttrack.h.
|
protected |
Definition at line 125 of file abstracttrack.h.
|
protected |
Definition at line 126 of file abstracttrack.h.
|
protected |
Definition at line 154 of file abstracttrack.h.
|
protected |
Definition at line 123 of file abstracttrack.h.
|
protected |
Definition at line 131 of file abstracttrack.h.
|
protected |
Definition at line 157 of file abstracttrack.h.
|
protected |
Definition at line 118 of file abstracttrack.h.
|
protected |
Definition at line 162 of file abstracttrack.h.
|
protected |
Definition at line 138 of file abstracttrack.h.
|
protected |
Definition at line 135 of file abstracttrack.h.
|
protected |
Definition at line 127 of file abstracttrack.h.
|
protected |
Definition at line 137 of file abstracttrack.h.
|
protected |
Definition at line 132 of file abstracttrack.h.
|
protected |
Definition at line 119 of file abstracttrack.h.
|
protected |
Definition at line 156 of file abstracttrack.h.
|
protected |
Definition at line 149 of file abstracttrack.h.
|
protected |
Definition at line 148 of file abstracttrack.h.
|
protected |
Definition at line 120 of file abstracttrack.h.
|
protected |
Definition at line 151 of file abstracttrack.h.
|
protected |
Definition at line 147 of file abstracttrack.h.
|
protected |
Definition at line 139 of file abstracttrack.h.
|
protected |
Definition at line 129 of file abstracttrack.h.
|
protected |
Definition at line 122 of file abstracttrack.h.
|
protected |
Definition at line 158 of file abstracttrack.h.
|
protected |
Definition at line 130 of file abstracttrack.h.
|
protected |
Definition at line 164 of file abstracttrack.h.
|
protected |
Definition at line 165 of file abstracttrack.h.
|
protected |
Definition at line 128 of file abstracttrack.h.
|
protected |
Definition at line 121 of file abstracttrack.h.