Tag Parser
9.4.0
C++ library for reading and writing MP4 (iTunes), ID3, Vorbis, Opus, FLAC and Matroska tags
|
Implementation of TagParser::AbstractTrack for the MP4 container. More...
#include <mp4track.h>
Public Member Functions | |
Mp4Track (Mp4Atom &trakAtom) | |
Constructs a new track for the specified trakAtom. More... | |
~Mp4Track () override | |
Destroys the track. More... | |
TrackType | type () const override |
Returns the type of the track if known; otherwise returns TrackType::Unspecified. More... | |
Mp4Atom & | trakAtom () |
Returns the trak atom for the current instance. More... | |
const std::vector< std::uint32_t > & | sampleSizes () const |
Returns the sample size table for the track. More... | |
unsigned int | chunkOffsetSize () const |
Returns the size of a single chunk offset denotation within the stco atom. More... | |
std::uint32_t | chunkCount () const |
Returns the number of chunks denoted by the stco atom. More... | |
std::uint32_t | sampleToChunkEntryCount () const |
Returns the number of "sample to chunk" entries within the stsc atom. More... | |
const Mpeg4ElementaryStreamInfo * | mpeg4ElementaryStreamInfo () const |
Returns information about the MPEG-4 elementary stream. More... | |
const AvcConfiguration * | avcConfiguration () const |
Returns the AVC configuration. More... | |
const Av1Configuration * | av1Configuration () const |
Returns the AV1 configuration. More... | |
std::vector< std::uint64_t > | readChunkOffsets (bool parseFragments, Diagnostics &diag) |
Reads the chunk offsets from the stco atom and fragments if parseFragments is true. More... | |
std::vector< std::tuple< std::uint32_t, std::uint32_t, std::uint32_t > > | readSampleToChunkTable (Diagnostics &diag) |
Reads the sample to chunk table. More... | |
std::vector< std::uint64_t > | readChunkSizes (TagParser::Diagnostics &diag) |
Reads the chunk sizes from the stsz (sample sizes) and stsc (samples per chunk) atom. More... | |
void | bufferTrackAtoms (Diagnostics &diag) |
Buffers all atoms required by the makeTrack() method. More... | |
std::uint64_t | requiredSize (Diagnostics &diag) const |
Returns the number of bytes written when calling makeTrack(). More... | |
void | makeTrack (Diagnostics &diag) |
Makes the track entry ("trak"-atom) for the track. More... | |
void | makeTrackHeader (Diagnostics &diag) |
Makes the track header (tkhd atom) for the track. More... | |
void | makeMedia (Diagnostics &diag) |
Makes the media information (mdia atom) for the track. More... | |
void | makeMediaInfo (Diagnostics &diag) |
Makes a media information (minf atom) for the track. More... | |
void | makeSampleTable (Diagnostics &diag) |
Makes the sample table (stbl atom) for the track. More... | |
void | updateChunkOffsets (const std::vector< std::int64_t > &oldMdatOffsets, const std::vector< std::int64_t > &newMdatOffsets) |
Updates the chunk offsets of the track. More... | |
void | updateChunkOffsets (const std::vector< std::uint64_t > &chunkOffsets) |
Updates the chunk offsets of the track. More... | |
void | updateChunkOffset (std::uint32_t chunkIndex, std::uint64_t offset) |
Updates a particular chunk offset. More... | |
![]() | |
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... | |
CppUtilities::BinaryReader & | reader () |
Returns a binary reader for the associated stream. More... | |
CppUtilities::BinaryWriter & | writer () |
Returns a binary writer for the associated stream. More... | |
std::uint64_t | 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... | |
std::uint64_t | size () const |
Returns the size in bytes if known; otherwise returns 0. More... | |
std::uint32_t | trackNumber () const |
Returns the track number if known; otherwise returns 0. More... | |
void | setTrackNumber (std::uint32_t trackNumber) |
Sets the track number. More... | |
std::uint64_t | id () const |
Returns the track ID if known; otherwise returns 0. More... | |
void | setId (std::uint64_t 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 CppUtilities::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 CppUtilities::DateTime & | creationTime () const |
Returns the creation time if known; otherwise returns a DateTime of zero ticks. More... | |
const CppUtilities::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... | |
std::uint32_t | samplingFrequency () const |
Returns the number of samples per second if known; otherwise returns 0. More... | |
std::uint32_t | extensionSamplingFrequency () const |
Returns the number of samples per second if known; otherwise returns 0. More... | |
std::uint16_t | bitsPerSample () const |
Returns the number of bits per sample; otherwise returns 0. More... | |
std::uint16_t | channelCount () const |
Returns the number of channels if known; otherwise returns 0. More... | |
std::uint8_t | channelConfig () const |
Returns the channel configuration. More... | |
const char * | channelConfigString () const |
Returns a string with the channel configuration if available; otherwise returns nullptr. More... | |
std::uint8_t | 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... | |
std::uint64_t | 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... | |
std::uint16_t | depth () const |
Returns the bit depth if known; otherwise returns 0. More... | |
std::uint32_t | 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... | |
std::uint32_t | 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... | |
std::uint32_t | 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 description about the track. More... | |
std::string | shortDescription () 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 std::unique_ptr< Mpeg4ElementaryStreamInfo > | parseMpeg4ElementaryStreamInfo (CppUtilities::BinaryReader &reader, Mp4Atom *esDescAtom, Diagnostics &diag) |
Reads the MPEG-4 elementary stream descriptor for the track. More... | |
static std::unique_ptr< Mpeg4AudioSpecificConfig > | parseAudioSpecificConfig (std::istream &stream, std::uint64_t startOffset, std::uint64_t size, Diagnostics &diag) |
Parses the audio specific configuration for the track. More... | |
static std::unique_ptr< Mpeg4VideoSpecificConfig > | parseVideoSpecificConfig (CppUtilities::BinaryReader &reader, std::uint64_t startOffset, std::uint64_t size, Diagnostics &diag) |
Parses the video specific configuration for the track. More... | |
static void | addInfo (const AvcConfiguration &avcConfig, AbstractTrack &track) |
Adds the information from the specified avcConfig to the specified track. More... | |
static void | addInfo (const Av1Configuration &av1Config, AbstractTrack &track) |
Adds the information from the specified av1Config to the specified track. More... | |
Protected Member Functions | |
void | internalParseHeader (Diagnostics &diag) override |
This method is internally called to parse header information. More... | |
![]() | |
AbstractTrack (std::istream &inputStream, std::ostream &outputStream, std::uint64_t startOffset) | |
Constructs a new track. More... | |
AbstractTrack (std::iostream &stream, std::uint64_t startOffset) | |
Constructs a new track. More... | |
Implementation of TagParser::AbstractTrack for the MP4 container.
Definition at line 118 of file mp4track.h.
TagParser::Mp4Track::Mp4Track | ( | Mp4Atom & | trakAtom | ) |
Constructs a new track for the specified trakAtom.
"trak"-atoms are stored in the top-level atom "move". Each "trak"-atom holds header information for one track in the MP4 file.
Definition at line 130 of file mp4track.cpp.
|
override |
Destroys the track.
Definition at line 153 of file mp4track.cpp.
|
static |
Adds the information from the specified av1Config to the specified track.
Definition at line 1049 of file mp4track.cpp.
|
static |
Adds the information from the specified avcConfig to the specified track.
Definition at line 1015 of file mp4track.cpp.
|
inline |
Returns the AV1 configuration.
Definition at line 270 of file mp4track.h.
|
inline |
Returns the AVC configuration.
Definition at line 259 of file mp4track.h.
void TagParser::Mp4Track::bufferTrackAtoms | ( | Diagnostics & | diag | ) |
Buffers all atoms required by the makeTrack() method.
This allows to invoke makeTrack() also when the input stream is going to be modified (eg. to apply changed tags without rewriting the file).
Definition at line 1062 of file mp4track.cpp.
|
inline |
Returns the number of chunks denoted by the stco atom.
Definition at line 228 of file mp4track.h.
|
inline |
Returns the size of a single chunk offset denotation within the stco atom.
Valid values are 4 and 8 bytes.
Definition at line 220 of file mp4track.h.
|
overrideprotectedvirtual |
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 | TagParser::Failure or a derived exception when a parsing error occurs. |
Implements TagParser::AbstractTrack.
Definition at line 1474 of file mp4track.cpp.
void TagParser::Mp4Track::makeMedia | ( | Diagnostics & | diag | ) |
Makes the media information (mdia atom) for the track.
The data is written to the assigned output stream at the current position.
Definition at line 1265 of file mp4track.cpp.
void TagParser::Mp4Track::makeMediaInfo | ( | Diagnostics & | diag | ) |
Makes a media information (minf atom) for the track.
The data is written to the assigned output stream at the current position.
Definition at line 1359 of file mp4track.cpp.
void TagParser::Mp4Track::makeSampleTable | ( | Diagnostics & | diag | ) |
Makes the sample table (stbl atom) for the track.
The data is written to the assigned output stream at the current position.
Definition at line 1414 of file mp4track.cpp.
void TagParser::Mp4Track::makeTrack | ( | Diagnostics & | diag | ) |
Makes the track entry ("trak"-atom) for the track.
The data is written to the assigned output stream at the current position. Note that this method uses the assigned input stream to copy some parts from the source file. Hence the input stream must still be valid when calling this method. To avoid this limitation call bufferTrackAtoms() before invalidating the input stream.
Definition at line 1138 of file mp4track.cpp.
void TagParser::Mp4Track::makeTrackHeader | ( | Diagnostics & | diag | ) |
Makes the track header (tkhd atom) for the track.
The data is written to the assigned output stream at the current position.
Definition at line 1167 of file mp4track.cpp.
|
inline |
Returns information about the MPEG-4 elementary stream.
Definition at line 248 of file mp4track.h.
|
static |
Parses the audio specific configuration for the track.
Definition at line 648 of file mp4track.cpp.
|
static |
Reads the MPEG-4 elementary stream descriptor for the track.
Definition at line 556 of file mp4track.cpp.
|
static |
Parses the video specific configuration for the track.
Definition at line 813 of file mp4track.cpp.
std::vector< std::uint64_t > TagParser::Mp4Track::readChunkOffsets | ( | bool | parseFragments, |
Diagnostics & | diag | ||
) |
Reads the chunk offsets from the stco atom and fragments if parseFragments is true.
Throws | InvalidDataException when
|
Throws | std::ios_base::failure when an IO error occurs. |
Definition at line 172 of file mp4track.cpp.
vector< std::uint64_t > TagParser::Mp4Track::readChunkSizes | ( | TagParser::Diagnostics & | diag | ) |
Reads the chunk sizes from the stsz (sample sizes) and stsc (samples per chunk) atom.
Throws | InvalidDataException when
|
Throws | std::ios_base::failure when an IO error occurs. |
Definition at line 506 of file mp4track.cpp.
vector< tuple< std::uint32_t, std::uint32_t, std::uint32_t > > TagParser::Mp4Track::readSampleToChunkTable | ( | Diagnostics & | diag | ) |
Reads the sample to chunk table.
Definition at line 457 of file mp4track.cpp.
std::uint64_t TagParser::Mp4Track::requiredSize | ( | Diagnostics & | diag | ) | const |
Returns the number of bytes written when calling makeTrack().
Definition at line 1085 of file mp4track.cpp.
|
inline |
Returns the sample size table for the track.
Definition at line 210 of file mp4track.h.
|
inline |
Returns the number of "sample to chunk" entries within the stsc atom.
Definition at line 236 of file mp4track.h.
|
inline |
Returns the trak atom for the current instance.
Definition at line 198 of file mp4track.h.
|
overridevirtual |
Returns the type of the track if known; otherwise returns TrackType::Unspecified.
Reimplemented from TagParser::AbstractTrack.
Definition at line 157 of file mp4track.cpp.
void TagParser::Mp4Track::updateChunkOffset | ( | std::uint32_t | chunkIndex, |
std::uint64_t | offset | ||
) |
Updates a particular chunk offset.
chunkIndex | Specifies the index of the chunk offset to be updated. |
offset | Specifies the new chunk offset. If the "stco" atom is used the value must fit into a 32-bit unsigned int. |
Throws | InvalidDataException when
|
Definition at line 994 of file mp4track.cpp.
void TagParser::Mp4Track::updateChunkOffsets | ( | const std::vector< std::int64_t > & | oldMdatOffsets, |
const std::vector< std::int64_t > & | newMdatOffsets | ||
) |
Updates the chunk offsets of the track.
This is necessary when the "mdat"-atom (which contains the actual chunk data) is moved.
oldMdatOffsets | Specifies a vector holding the old offsets of the "mdat"-atoms. |
newMdatOffsets | Specifies a vector holding the new offsets of the "mdat"-atoms. |
Throws | InvalidDataException when
|
Throws | std::ios_base::failure when an IO error occurs. |
Definition at line 889 of file mp4track.cpp.
void TagParser::Mp4Track::updateChunkOffsets | ( | const std::vector< std::uint64_t > & | chunkOffsets | ) |
Updates the chunk offsets of the track.
This is necessary when the "mdat"-atom (which contains the actual chunk data) is moved.
chunkOffsets | Specifies the new chunk offset table. If the "stco" atom is used the values must fit into an 32-bit unsigned int. |
Throws | InvalidDataException when
|
Definition at line 956 of file mp4track.cpp.