Tag Parser 12.1.0
C++ library for reading and writing MP4 (iTunes), ID3, Vorbis, Opus, FLAC and Matroska tags
|
The MediaFileInfo class allows to read and write tag information providing a container/tag format independent interface. More...
#include <mediafileinfo.h>
Public Member Functions | |
MediaFileInfo () | |
Constructs a new MediaFileInfo. | |
MediaFileInfo (std::string_view path) | |
Constructs a new MediaFileInfo. | |
MediaFileInfo (std::string &&path) | |
Constructs a new MediaFileInfo for the specified file. | |
MediaFileInfo (const MediaFileInfo &)=delete | |
MediaFileInfo & | operator= (const MediaFileInfo &)=delete |
~MediaFileInfo () override | |
Destroys the MediaFileInfo. | |
void | parseContainerFormat (Diagnostics &diag, AbortableProgressFeedback &progress) |
Parses the container format of the current file. | |
void | parseTracks (Diagnostics &diag, AbortableProgressFeedback &progress) |
Parses the tracks of the current file. | |
void | parseTags (Diagnostics &diag, AbortableProgressFeedback &progress) |
Parses the tag(s) of the current file. | |
void | parseChapters (Diagnostics &diag, AbortableProgressFeedback &progress) |
Parses the chapters of the current file. | |
void | parseAttachments (Diagnostics &diag, AbortableProgressFeedback &progress) |
Parses the attachments of the current file. | |
void | parseEverything (Diagnostics &diag, AbortableProgressFeedback &progress) |
Parses the container format, the tracks and the tag information of the current file. | |
void | applyChanges (Diagnostics &diag, AbortableProgressFeedback &progress) |
Applies assigned/changed tag information to the current file. | |
ContainerFormat | containerFormat () const |
Returns the container format of the current file. | |
std::string_view | containerFormatName () const |
Returns the name of the container format as C-style string. | |
std::string_view | containerFormatAbbreviation () const |
Returns the abbreviation of the container format as C-style string. | |
std::string_view | containerFormatSubversion () const |
Returns the subversion of the container format as C-style string. | |
std::string_view | mimeType () const |
Returns the MIME-type of the container format as C-style string. | |
std::uint64_t | containerOffset () const |
Returns the actual container start offset. | |
std::uint64_t | paddingSize () const |
Returns the padding size. | |
std::uint64_t | effectiveSize () const |
Returns the "effective size" of the file if know; otherwise returns 0. | |
AbstractContainer * | container () const |
Returns the container for the current file. | |
ParsingStatus | containerParsingStatus () const |
Returns an indication whether the container format has been parsed yet. | |
ParsingStatus | chaptersParsingStatus () const |
Returns whether the chapters have been parsed yet. | |
std::vector< AbstractChapter * > | chapters () const |
Returns all chapters assigned to the current file. | |
bool | areChaptersSupported () const |
Returns an indication whether this library supports parsing the chapters of the current file. | |
ParsingStatus | attachmentsParsingStatus () const |
Returns whether the attachments have been parsed yet. | |
std::vector< AbstractAttachment * > | attachments () const |
Returns all attachments assigned to the current file. | |
bool | areAttachmentsSupported () const |
Returns an indication whether this library supports attachment format of the current file. | |
ParsingStatus | tracksParsingStatus () const |
Returns an indication whether tracks have been parsed yet. | |
std::size_t | trackCount () const |
Returns the number of tracks that could be parsed. | |
std::vector< AbstractTrack * > | tracks () const |
Returns the tracks for the current file. | |
bool | hasTracksOfType (TagParser::MediaType type) const |
Returns an indication whether the current file has tracks of the specified type. | |
CppUtilities::TimeSpan | duration () const |
Returns the overall duration of the file if known; otherwise returns a TimeSpan with zero ticks. | |
double | overallAverageBitrate () const |
Returns the overall average bitrate in kbit/s of the file if known; otherwise returns 0.0. | |
std::unordered_set< std::string > | availableLanguages (TagParser::MediaType type=TagParser::MediaType::Audio) const |
Determines the available languages for specified media type (by default MediaType::Audio). | |
std::string | technicalSummary () const |
Generates a short technical summary about the file's tracks. | |
bool | areTracksSupported () const |
Returns an indication whether this library supports parsing the tracks information of the current file. | |
ParsingStatus | tagsParsingStatus () const |
Returns an indication whether tag information has been parsed yet. | |
bool | hasId3v1Tag () const |
Returns an indication whether an ID3v1 tag is assigned. | |
bool | hasId3v2Tag () const |
Returns an indication whether an ID3v2 tag is assigned. | |
bool | hasAnyTag () const |
Returns an indication whether a tag of any format is assigned. | |
Id3v1Tag * | id3v1Tag () const |
Returns a pointer to the assigned ID3v1 tag or nullptr if none is assigned. | |
const std::vector< std::unique_ptr< Id3v2Tag > > & | id3v2Tags () const |
Returns pointers to the assigned ID3v2 tags. | |
void | tags (std::vector< Tag * > &tags) const |
Stores all tags assigned to the current file in the specified vector. | |
std::vector< Tag * > | tags () const |
Returns all tags assigned to the current file. | |
void | parsedTags (std::vector< Tag * > &tags) const |
Returns all tags parsed from the current file. | |
std::vector< Tag * > | parsedTags () const |
Returns all tags parsed from the current file. | |
Mp4Tag * | mp4Tag () const |
Returns a pointer to the assigned MP4 tag or nullptr if none is assigned. | |
const std::vector< std::unique_ptr< MatroskaTag > > & | matroskaTags () const |
Returns pointers to the assigned Matroska tags. | |
VorbisComment * | vorbisComment () const |
Returns a pointer to the first assigned Vorbis comment or nullptr if none is assigned. | |
bool | areTagsSupported () const |
Returns an indication whether this library supports the tag format of the current file. | |
bool | createAppropriateTags (const TagCreationSettings &settings=TagCreationSettings()) |
Ensures appropriate tags are created according the given settings. | |
bool | removeId3v1Tag () |
Removes a possibly assigned ID3v1 tag from the current file. | |
Id3v1Tag * | createId3v1Tag () |
Creates an ID3v1 tag for the current file. | |
bool | removeId3v2Tag (Id3v2Tag *tag) |
Removes an assigned ID3v2 tag from the current file. | |
bool | removeAllId3v2Tags () |
Removes all assigned ID3v2 tags from the current file. | |
Id3v2Tag * | createId3v2Tag () |
Creates an ID3v2 tag for the current file. | |
bool | removeTag (Tag *tag) |
Removes a possibly assigned tag from the current file. | |
void | removeAllTags () |
Removes all assigned tags from the file. | |
void | mergeId3v2Tags () |
Merges the assigned ID3v2 tags into a single ID3v2 tag. | |
bool | id3v1ToId3v2 () |
Converts an existing ID3v1 tag into an ID3v2 tag. | |
bool | id3v2ToId3v1 () |
Converts the existing ID3v2 tags into an ID3v1 tag. | |
VorbisComment * | createVorbisComment () |
Creates a Vorbis comment for the current file. | |
bool | removeVorbisComment () |
Removes all assigned Vorbis comment from the current file. | |
void | clearParsingResults () |
Clears all parsing results and assigned/created/changed information such as detected container format, tracks, tags, ... | |
const std::string & | backupDirectory () const |
Returns the directory used to store backup files. | |
void | setBackupDirectory (std::string_view backupDirectory) |
Sets the directory used to store backup files. | |
void | setBackupDirectory (std::string &&backupDirectory) |
Sets the directory used to store backup files. | |
const std::string & | saveFilePath () const |
Returns the "save file path" which has been set using setSaveFilePath(). | |
void | setSaveFilePath (std::string_view saveFilePath) |
Sets the "save file path". | |
void | setSaveFilePath (std::string &&saveFilePath) |
Sets the "save file path". | |
const std::string & | writingApplication () const |
Sets the writing application as container-level meta-data. | |
void | setWritingApplication (std::string_view writingApplication) |
Sets the writing application as container-level meta-data. | |
MediaFileHandlingFlags | fileHandlingFlags () |
Returns the currently configured file handling flags. | |
void | setFileHandlingFlags (MediaFileHandlingFlags flags) |
Replaces all currently configured file handling flags with the specified flags. | |
bool | isForcingFullParse () const |
Returns an indication whether forcing a full parse is enabled. | |
void | setForceFullParse (bool forceFullParse) |
Sets whether forcing a full parse is enabled. | |
bool | isForcingRewrite () const |
Returns whether forcing rewriting (when applying changes) is enabled. | |
void | setForceRewrite (bool forceRewrite) |
Sets whether forcing rewriting (when applying changes) is enabled. | |
std::size_t | minPadding () const |
Returns the minimum padding to be written before the data blocks when applying changes. | |
void | setMinPadding (std::size_t minPadding) |
Sets the minimum padding to be written before the data blocks when applying changes. | |
std::size_t | maxPadding () const |
Returns the maximum padding to be written before the data blocks when applying changes. | |
void | setMaxPadding (std::size_t maxPadding) |
Sets the maximum padding to be written before the data blocks when applying changes. | |
std::size_t | preferredPadding () const |
Returns the padding to be written before the data block when applying changes and the file needs to be rewritten anyways. | |
void | setPreferredPadding (std::size_t preferredPadding) |
Sets the padding to be written before the data block when applying changes and the file needs to be rewritten anyways. | |
ElementPosition | tagPosition () const |
Returns the position (in the output file) where the tag information is written when applying changes. | |
void | setTagPosition (ElementPosition tagPosition) |
Sets the position (in the output file) where the tag information is written when applying changes. | |
bool | forceTagPosition () const |
Returns whether tagPosition() is forced. | |
void | setForceTagPosition (bool forceTagPosition) |
Sets whether tagPosition() is forced. | |
ElementPosition | indexPosition () const |
Returns the position (in the output file) where the index is written when applying changes. | |
void | setIndexPosition (ElementPosition indexPosition) |
Sets the position (in the output file) where the index is written when applying changes. | |
bool | forceIndexPosition () const |
Returns whether indexPosition() is forced. | |
void | setForceIndexPosition (bool forceTagPosition) |
Sets whether indexPosition() is forced. | |
std::uint64_t | maxFullParseSize () const |
Returns the maximal file size for a "full parse" in byte. | |
void | setMaxFullParseSize (std::uint64_t maxFullParseSize) |
Sets the maximal file size for a "full parse" in byte. | |
Public Member Functions inherited from TagParser::BasicFileInfo | |
BasicFileInfo () | |
Constructs a new BasicFileInfo for the specified file. | |
BasicFileInfo (std::string &&path) | |
Constructs a new BasicFileInfo for the specified file. | |
BasicFileInfo (std::string_view path) | |
Constructs a new BasicFileInfo for the specified file. | |
BasicFileInfo (const BasicFileInfo &)=delete | |
BasicFileInfo & | operator= (const BasicFileInfo &)=delete |
virtual | ~BasicFileInfo () |
Destroys the BasicFileInfo. | |
void | open (bool readOnly=false) |
Opens a std::fstream for the current file. | |
void | reopen (bool readOnly=false) |
Opens a std::fstream for the current file. | |
bool | isOpen () const |
Indicates whether a std::fstream is open for the current file. | |
bool | isReadOnly () const |
Indicates whether the last open()/reopen() call was read-only. | |
void | close () |
A possibly opened std::fstream will be closed. | |
void | invalidate () |
Invalidates the file info manually. | |
CppUtilities::NativeFileStream & | stream () |
Returns the std::fstream for the current instance. | |
const CppUtilities::NativeFileStream & | stream () const |
Returns the std::fstream for the current instance. | |
const std::string & | path () const |
Returns the path of the current file. | |
void | setPath (std::string_view path) |
Sets the current file. | |
void | setPath (std::string &&path) |
Sets the current file. | |
std::string | fileName (bool cutExtension=false) const |
Returns the file name of the current file. | |
std::string | extension () const |
Returns the extension of the current file. | |
std::string | pathWithoutExtension () const |
Returns the path of the current file without the extension/suffix. | |
std::string | containingDirectory () const |
Returns the path of the directory containing the current file. | |
std::uint64_t | size () const |
Returns size of the current file in bytes. | |
void | reportSizeChanged (std::uint64_t newSize) |
Call this function to report that the size changed. | |
void | reportPathChanged (std::string_view newPath) |
Call this function to report that the path changed. | |
void | reportPathChanged (std::string &&newPath) |
Call this function to report that the path changed. | |
Protected Member Functions | |
void | invalidated () override |
Reimplemented from BasicFileInfo::invalidated(). | |
Additional Inherited Members | |
Static Public Member Functions inherited from TagParser::BasicFileInfo | |
static std::string | fileName (std::string_view path, bool cutExtension=false) |
Returns the file name of the given file. | |
static std::string | extension (std::string_view path) |
Returns the extension of the given file. | |
static std::string | pathWithoutExtension (std::string_view fullPath) |
Returns a copy of the given path without the extension/suffix. | |
static std::string | containingDirectory (std::string_view path) |
Returns the path of the directory containing the given file. | |
static std::string_view | pathForOpen (std::string_view url) |
Returns removes the "file:/" prefix from url to be able to pass it to functions like open(), stat() and truncate(). | |
The MediaFileInfo class allows to read and write tag information providing a container/tag format independent interface.
It also provides some technical information such as contained streams.
For examples see "cli/mainfeatures.cpp" of the tageditor repository.
Definition at line 80 of file mediafileinfo.h.
|
explicit |
Constructs a new MediaFileInfo.
Definition at line 107 of file mediafileinfo.cpp.
|
explicit |
Constructs a new MediaFileInfo.
Definition at line 115 of file mediafileinfo.cpp.
|
explicit |
Constructs a new MediaFileInfo for the specified file.
path | Specifies the absolute or relative path of the file. |
Definition at line 81 of file mediafileinfo.cpp.
|
delete |
|
override |
Destroys the MediaFileInfo.
Definition at line 123 of file mediafileinfo.cpp.
void TagParser::MediaFileInfo::applyChanges | ( | Diagnostics & | diag, |
AbortableProgressFeedback & | progress | ||
) |
Applies assigned/changed tag information to the current file.
This method applies previously assigned tag information to the current file.
Depending on the changes to be applied the file will be rewritten.
When the file needs to be rewritten it will be renamed. A new file with the old name will be created to replace the old file.
Throws | std::ios_base::failure when an IO error occurs. |
Throws | TagParser::Failure or a derived exception when a making error occurs. |
Definition at line 743 of file mediafileinfo.cpp.
bool TagParser::MediaFileInfo::areAttachmentsSupported | ( | ) | const |
Returns an indication whether this library supports attachment format of the current file.
Definition at line 1230 of file mediafileinfo.cpp.
bool TagParser::MediaFileInfo::areChaptersSupported | ( | ) | const |
Returns an indication whether this library supports parsing the chapters of the current file.
Definition at line 1213 of file mediafileinfo.cpp.
bool TagParser::MediaFileInfo::areTagsSupported | ( | ) | const |
Returns an indication whether this library supports the tag format of the current file.
Definition at line 1268 of file mediafileinfo.cpp.
bool TagParser::MediaFileInfo::areTracksSupported | ( | ) | const |
Returns an indication whether this library supports parsing the tracks information of the current file.
Definition at line 1247 of file mediafileinfo.cpp.
vector< AbstractAttachment * > TagParser::MediaFileInfo::attachments | ( | ) | const |
Returns all attachments assigned to the current file.
Definition at line 1354 of file mediafileinfo.cpp.
|
inline |
Returns whether the attachments have been parsed yet.
Definition at line 355 of file mediafileinfo.h.
unordered_set< string > TagParser::MediaFileInfo::availableLanguages | ( | TagParser::MediaType | type = TagParser::MediaType::Audio | ) | const |
Determines the available languages for specified media type (by default MediaType::Audio).
If type is MediaType::Unknown, all media types are considered.
parseTracks() needs to be called before. Otherwise this method always returns an empty set.
Definition at line 984 of file mediafileinfo.cpp.
|
inline |
Returns the directory used to store backup files.
Definition at line 405 of file mediafileinfo.h.
vector< AbstractChapter * > TagParser::MediaFileInfo::chapters | ( | ) | const |
Returns all chapters assigned to the current file.
Definition at line 1336 of file mediafileinfo.cpp.
|
inline |
Returns whether the chapters have been parsed yet.
Definition at line 347 of file mediafileinfo.h.
void TagParser::MediaFileInfo::clearParsingResults | ( | ) |
Clears all parsing results and assigned/created/changed information such as detected container format, tracks, tags, ...
This allows a rescan of the file using parsing methods like parseContainerFormat(). Otherwise, these methods do nothing if the information to be parsed has already been gathered.
Definition at line 1378 of file mediafileinfo.cpp.
|
inline |
Returns the container for the current file.
If there is not corresponding subclass of AbstractContainer for the container format or the container has not been parsed yet using the parseContainerFormat() method nullptr will be returned.
Definition at line 495 of file mediafileinfo.h.
|
inline |
Returns the container format of the current file.
parseContainerFormat() needs to be called before. Otherwise always ContainerFormat::Unknown will be returned.
Definition at line 255 of file mediafileinfo.h.
string_view TagParser::MediaFileInfo::containerFormatAbbreviation | ( | ) | const |
Returns the abbreviation of the container format as C-style string.
This abbreviation might be used as file extension.
parseContainerFormat() needs to be called before. Otherwise always an empty string will be returned.
Definition at line 809 of file mediafileinfo.cpp.
|
inline |
Returns the name of the container format as C-style string.
parseContainerFormat() needs to be called before. Otherwise always the name "Unknown" will be returned.
Definition at line 270 of file mediafileinfo.h.
|
inline |
Returns the subversion of the container format as C-style string.
parseContainerFormat() needs to be called before. Otherwise always an empty string will be returned.
Definition at line 285 of file mediafileinfo.h.
|
inline |
Returns the actual container start offset.
Definition at line 293 of file mediafileinfo.h.
|
inline |
Returns an indication whether the container format has been parsed yet.
Definition at line 244 of file mediafileinfo.h.
bool TagParser::MediaFileInfo::createAppropriateTags | ( | const TagCreationSettings & | settings = TagCreationSettings() | ) |
Ensures appropriate tags are created according the given settings.
Definition at line 616 of file mediafileinfo.cpp.
Id3v1Tag * TagParser::MediaFileInfo::createId3v1Tag | ( | ) |
Creates an ID3v1 tag for the current file.
This method does nothing the tags of the current file haven't been parsed using the parseTags() method.
If the file has already an ID3v1 tag no new tag will be created.
To apply the created tag and other changings call the applyChanges() method.
Definition at line 1071 of file mediafileinfo.cpp.
Id3v2Tag * TagParser::MediaFileInfo::createId3v2Tag | ( | ) |
Creates an ID3v2 tag for the current file.
This method does nothing the tags of the current file haven't been parsed using the parseTags() method.
If the file has already an ID3v2 tag no new tag will be created.
To apply the created tag and other changings call the applyChanges() method.
Definition at line 1138 of file mediafileinfo.cpp.
VorbisComment * TagParser::MediaFileInfo::createVorbisComment | ( | ) |
Creates a Vorbis comment for the current file.
This method does nothing if the tags/tracks of the current file haven't been parsed using the parseTags() and parseTracks() methods.
If the file has already a Vorbis comment no new tag will be created.
To apply the created tag and other changings call the applyChanges() method.
Definition at line 1481 of file mediafileinfo.cpp.
CppUtilities::TimeSpan TagParser::MediaFileInfo::duration | ( | ) | const |
Returns the overall duration of the file if known; otherwise returns a TimeSpan with zero ticks.
parseTracks() needs to be called before. Otherwise this method always returns false.
Definition at line 946 of file mediafileinfo.cpp.
|
inline |
Returns the "effective size" of the file if know; otherwise returns 0.
Definition at line 310 of file mediafileinfo.h.
|
inline |
Returns the currently configured file handling flags.
Definition at line 503 of file mediafileinfo.h.
|
inline |
Returns whether indexPosition() is forced.
Definition at line 701 of file mediafileinfo.h.
|
inline |
Returns whether tagPosition() is forced.
Definition at line 661 of file mediafileinfo.h.
bool TagParser::MediaFileInfo::hasAnyTag | ( | ) | const |
Returns an indication whether a tag of any format is assigned.
Definition at line 1578 of file mediafileinfo.cpp.
|
inline |
Returns an indication whether an ID3v1 tag is assigned.
Definition at line 363 of file mediafileinfo.h.
|
inline |
Returns an indication whether an ID3v2 tag is assigned.
Definition at line 371 of file mediafileinfo.h.
bool TagParser::MediaFileInfo::hasTracksOfType | ( | TagParser::MediaType | type | ) | const |
Returns an indication whether the current file has tracks of the specified type.
parseTracks() needs to be called before. Otherwise this method always returns false.
Definition at line 920 of file mediafileinfo.cpp.
|
inline |
Returns a pointer to the assigned ID3v1 tag or nullptr if none is assigned.
Definition at line 383 of file mediafileinfo.h.
bool TagParser::MediaFileInfo::id3v1ToId3v2 | ( | ) |
Converts an existing ID3v1 tag into an ID3v2 tag.
Effectively merges all ID3 tags into a single ID3v2 tag.
Definition at line 1439 of file mediafileinfo.cpp.
|
inline |
Returns pointers to the assigned ID3v2 tags.
Definition at line 395 of file mediafileinfo.h.
bool TagParser::MediaFileInfo::id3v2ToId3v1 | ( | ) |
Converts the existing ID3v2 tags into an ID3v1 tag.
Effectively merges all ID3 tags into a single ID3v1 tag.
Definition at line 1458 of file mediafileinfo.cpp.
|
inline |
Returns the position (in the output file) where the index is written when applying changes.
Definition at line 681 of file mediafileinfo.h.
|
overrideprotectedvirtual |
Reimplemented from BasicFileInfo::invalidated().
Reimplemented from TagParser::BasicFileInfo.
Definition at line 1637 of file mediafileinfo.cpp.
|
inline |
Returns an indication whether forcing a full parse is enabled.
If enabled the parser will analyse the file structure as deep as possible. This might cause long parsing times for big files.
Definition at line 524 of file mediafileinfo.h.
|
inline |
Returns whether forcing rewriting (when applying changes) is enabled.
Definition at line 542 of file mediafileinfo.h.
const vector< unique_ptr< MatroskaTag > > & TagParser::MediaFileInfo::matroskaTags | ( | ) | const |
Returns pointers to the assigned Matroska tags.
Definition at line 1308 of file mediafileinfo.cpp.
|
inline |
Returns the maximal file size for a "full parse" in byte.
The default value is 50 MiB.
Definition at line 729 of file mediafileinfo.h.
|
inline |
Returns the maximum padding to be written before the data blocks when applying changes.
Maximum padding in front of the file allows adding additional fields afterwards without needing to rewrite the entire file or to put tag information at the end of the file.
The default value is 0 which will force the library to rewrite the entire file almost always when applying changes. Increate the value using setMaxPadding() to prevent this.
Definition at line 595 of file mediafileinfo.h.
void TagParser::MediaFileInfo::mergeId3v2Tags | ( | ) |
Merges the assigned ID3v2 tags into a single ID3v2 tag.
Some files I've got contain multiple successive ID3v2 tags. If the tags of such an file is parsed by this class, these tags will be kept separate. This method merges all assigned ID3v2 tags. All fields from the additional ID3v2 tags will be inserted to the first tag. All assigned ID3v2 tag instances except thefirst will be destroyed.
A possibly assigned ID3v1 tag remains unaffected.
This method does nothing the tags of the current file haven't been parsed using the parseTags() method.
Definition at line 1412 of file mediafileinfo.cpp.
string_view TagParser::MediaFileInfo::mimeType | ( | ) | const |
Returns the MIME-type of the container format as C-style string.
parseContainerFormat() needs to be called before. Otherwise always an empty string will be returned.
Definition at line 863 of file mediafileinfo.cpp.
|
inline |
Returns the minimum padding to be written before the data blocks when applying changes.
Minimum padding in front of the file allows adding additional fields afterwards without needing to rewrite the entire file or to put tag information at the end of the file.
The default value is 0.
Definition at line 567 of file mediafileinfo.h.
Mp4Tag * TagParser::MediaFileInfo::mp4Tag | ( | ) | const |
Returns a pointer to the assigned MP4 tag or nullptr if none is assigned.
Definition at line 1293 of file mediafileinfo.cpp.
|
delete |
double TagParser::MediaFileInfo::overallAverageBitrate | ( | ) | const |
Returns the overall average bitrate in kbit/s of the file if known; otherwise returns 0.0.
parseTracks() needs to be called before. Otherwise this method always returns false.
Definition at line 965 of file mediafileinfo.cpp.
|
inline |
Returns the padding size.
Container format and tags should have been parsed yet.
Definition at line 301 of file mediafileinfo.h.
void TagParser::MediaFileInfo::parseAttachments | ( | Diagnostics & | diag, |
AbortableProgressFeedback & | progress | ||
) |
Parses the attachments of the current file.
This method parses the attachments of the current file if not been parsed yet.
Throws | std::ios_base::failure when an IO error occurs. |
Definition at line 554 of file mediafileinfo.cpp.
void TagParser::MediaFileInfo::parseChapters | ( | Diagnostics & | diag, |
AbortableProgressFeedback & | progress | ||
) |
Parses the chapters of the current file.
This method parses the chapters of the current file if not been parsed yet.
Throws | std::ios_base::failure when an IO error occurs. |
Definition at line 521 of file mediafileinfo.cpp.
void TagParser::MediaFileInfo::parseContainerFormat | ( | Diagnostics & | diag, |
AbortableProgressFeedback & | progress | ||
) |
Parses the container format of the current file.
This method parses the container of the current file format if it has not been parsed yet.
After calling this method the methods containerFormat(), containerFormatName(), containerFormatAbbreviation(), containerFormatSubversion(), containerMimeType(), container(), mp4Container() and matroskaContainer() will return the parsed information.
Throws | std::ios_base::failure when an IO error occurs. |
Definition at line 140 of file mediafileinfo.cpp.
std::vector< Tag * > TagParser::MediaFileInfo::parsedTags | ( | ) | const |
Returns all tags parsed from the current file.
Definition at line 1627 of file mediafileinfo.cpp.
void TagParser::MediaFileInfo::parsedTags | ( | std::vector< Tag * > & | tags | ) | const |
Returns all tags parsed from the current file.
Definition at line 1593 of file mediafileinfo.cpp.
void TagParser::MediaFileInfo::parseEverything | ( | Diagnostics & | diag, |
AbortableProgressFeedback & | progress | ||
) |
Parses the container format, the tracks and the tag information of the current file.
See the individual methods to for more details and exceptions which might be thrown.
Definition at line 584 of file mediafileinfo.cpp.
void TagParser::MediaFileInfo::parseTags | ( | Diagnostics & | diag, |
AbortableProgressFeedback & | progress | ||
) |
Parses the tag(s) of the current file.
This method parses the tag(s) of the current file if not been parsed yet. After calling this method the methods id3v1Tag(), id3v2Tags(), mp4Tag() and allTags() will return the parsed information.
Previously assigned but not applied tag information will be discarted.
Throws | std::ios_base::failure when an IO error occurs. |
Definition at line 402 of file mediafileinfo.cpp.
void TagParser::MediaFileInfo::parseTracks | ( | Diagnostics & | diag, |
AbortableProgressFeedback & | progress | ||
) |
Parses the tracks of the current file.
This method parses the tracks of the current file if not been parsed yet. After calling this method the methods trackCount(), tracks(), and hasTracksOfType() will return the parsed information.
Throws | std::ios_base::failure when an IO error occurs. |
Definition at line 324 of file mediafileinfo.cpp.
|
inline |
Returns the padding to be written before the data block when applying changes and the file needs to be rewritten anyways.
Padding in front of the file allows adding additional fields afterwards without needing to rewrite the entire file or to put tag information at the end of the file.
Definition at line 616 of file mediafileinfo.h.
bool TagParser::MediaFileInfo::removeAllId3v2Tags | ( | ) |
Removes all assigned ID3v2 tags from the current file.
To apply the removal and other changings call the applyChanges() method
Definition at line 1114 of file mediafileinfo.cpp.
void TagParser::MediaFileInfo::removeAllTags | ( | ) |
Removes all assigned tags from the file.
To apply the removal and other changings call the applyChanges() method.
Definition at line 1198 of file mediafileinfo.cpp.
bool TagParser::MediaFileInfo::removeId3v1Tag | ( | ) |
Removes a possibly assigned ID3v1 tag from the current file.
To apply the removal and other changings call the applyChanges() method.
Definition at line 1044 of file mediafileinfo.cpp.
bool TagParser::MediaFileInfo::removeId3v2Tag | ( | Id3v2Tag * | tag | ) |
Removes an assigned ID3v2 tag from the current file.
To apply the removal and other changings call the applyChanges() method.
tag | Specifies the ID3v2 tag to be removed. |
Definition at line 1092 of file mediafileinfo.cpp.
bool TagParser::MediaFileInfo::removeTag | ( | Tag * | tag | ) |
Removes a possibly assigned tag from the current file.
To apply the removal and other changings call the applyChanges() method.
tag | Specifies the tag to be removed. The tag will not only be detached from the file, it will be destroyed as well. Might be nullptr for convenience (eg. you might want to call file.removeTag(file.mp4Tag()) to ensure no MP4 tag is present without checking before). |
Definition at line 1159 of file mediafileinfo.cpp.
bool TagParser::MediaFileInfo::removeVorbisComment | ( | ) |
Removes all assigned Vorbis comment from the current file.
To apply the removal and other changings call the applyChanges() method.
Definition at line 1508 of file mediafileinfo.cpp.
|
inline |
Returns the "save file path" which has been set using setSaveFilePath().
Definition at line 432 of file mediafileinfo.h.
|
inline |
Sets the directory used to store backup files.
Definition at line 423 of file mediafileinfo.h.
|
inline |
Sets the directory used to store backup files.
Definition at line 414 of file mediafileinfo.h.
|
inline |
Replaces all currently configured file handling flags with the specified flags.
Definition at line 511 of file mediafileinfo.h.
|
inline |
Sets whether forcing a full parse is enabled.
Definition at line 534 of file mediafileinfo.h.
|
inline |
Sets whether indexPosition() is forced.
Definition at line 711 of file mediafileinfo.h.
|
inline |
Sets whether forcing rewriting (when applying changes) is enabled.
Definition at line 550 of file mediafileinfo.h.
|
inline |
Sets whether tagPosition() is forced.
Definition at line 671 of file mediafileinfo.h.
|
inline |
Sets the position (in the output file) where the index is written when applying changes.
Definition at line 691 of file mediafileinfo.h.
|
inline |
Sets the maximal file size for a "full parse" in byte.
Definition at line 738 of file mediafileinfo.h.
|
inline |
Sets the maximum padding to be written before the data blocks when applying changes.
Definition at line 605 of file mediafileinfo.h.
|
inline |
Sets the minimum padding to be written before the data blocks when applying changes.
Definition at line 577 of file mediafileinfo.h.
|
inline |
Sets the padding to be written before the data block when applying changes and the file needs to be rewritten anyways.
Definition at line 626 of file mediafileinfo.h.
|
inline |
Sets the "save file path".
Definition at line 459 of file mediafileinfo.h.
|
inline |
Sets the "save file path".
If saveFilePath is not empty, this path will be used to save the output file when applying changes using applyChanges(). Thus the current file is not modified by applyChanges() in this case and the variable isForcingRewrite() does not affect the behaviour of applyChanges(). If the changes have been applied without fatal errors the "save file path" is cleared and used as the new regular path().
By default, this path is empty.
Definition at line 451 of file mediafileinfo.h.
|
inline |
Sets the position (in the output file) where the tag information is written when applying changes.
Definition at line 651 of file mediafileinfo.h.
|
inline |
Sets the writing application as container-level meta-data.
Put the name of your application here.
Definition at line 480 of file mediafileinfo.h.
|
inline |
Returns the position (in the output file) where the tag information is written when applying changes.
Definition at line 636 of file mediafileinfo.h.
vector< Tag * > TagParser::MediaFileInfo::tags | ( | ) | const |
Returns all tags assigned to the current file.
Definition at line 1565 of file mediafileinfo.cpp.
void TagParser::MediaFileInfo::tags | ( | std::vector< Tag * > & | tags | ) | const |
Stores all tags assigned to the current file in the specified vector.
Definition at line 1537 of file mediafileinfo.cpp.
|
inline |
Returns an indication whether tag information has been parsed yet.
Definition at line 318 of file mediafileinfo.h.
string TagParser::MediaFileInfo::technicalSummary | ( | ) | const |
Generates a short technical summary about the file's tracks.
parseTracks() needs to be called before. Otherwise this method always returns an empty string.
Example (exact format might change in the future!): "H.264-720p / HE-AAC-6ch-eng / HE-AAC-2ch-ger / SRT-eng / SRT-ger"
Definition at line 1016 of file mediafileinfo.cpp.
|
inline |
Returns the number of tracks that could be parsed.
parseTracks() needs to be called before. Otherwise this method always returns zero.
Definition at line 339 of file mediafileinfo.h.
vector< AbstractTrack * > TagParser::MediaFileInfo::tracks | ( | ) | const |
Returns the tracks for the current file.
parseTracks() needs to be called before. Otherwise this method always returns an empty vector.
Definition at line 890 of file mediafileinfo.cpp.
|
inline |
Returns an indication whether tracks have been parsed yet.
Definition at line 326 of file mediafileinfo.h.
VorbisComment * TagParser::MediaFileInfo::vorbisComment | ( | ) | const |
Returns a pointer to the first assigned Vorbis comment or nullptr if none is assigned.
Definition at line 1324 of file mediafileinfo.cpp.
|
inline |
Sets the writing application as container-level meta-data.
Definition at line 469 of file mediafileinfo.h.