MKVPROPEDIT(1) | User Commands | MKVPROPEDIT(1) |
NAME¶
mkvpropedit - Modify properties of existing Matroska files without a complete remux
SYNOPSIS¶
mkvpropedit [options] {source-filename} {actions}
DESCRIPTION¶
This program analyses an existing Matroska file and modifies some of its properties. Then it writes those modifications to the existing file. Among the properties that can be changed are the segment information elements (e.g. the title) and the track headers (e.g. the language code, 'default track' flag or the name).
Options:
-l, --list-property-names
-p, --parse-mode mode
Actions that deal with track and segment info properties:
-e, --edit selector
By default mkvpropedit(1) will edit the segment information section.
See the section about edit selectors for a full description of the syntax.
-a, --add name=value
-s, --set name=value
-d, --delete name
Actions that deal with tags and chapters:
-t, --tags selector:filename
The selector must be one of the words all, global or track. For all mkvpropedit(1) will replace or remove all tags in a file. With global only global tags will be replaced or removed.
With track mkvpropedit(1) will replace tags for a specific track. Additionally the tags read from filename will be assigned to the same track. The track is specified in the same way edit selectors are specified (see below), e.g. --tags track:a1:new-audio-tags.xml.
--add-track-statistics-tags
--delete-track-statistics-tags
-c, --chapters filename
Actions for handling attachments:
--add-attachment filename
If the option --attachment-name has been used prior to this option then its value is used as the new attachment's name. Otherwise it is derived from filename.
If the option --attachment-mime-type has been used prior to this option then its value is used as the new attachment's MIME type. Otherwise it is auto-detected from the content of filename.
If the option --attachment-description has been used prior to this option then its value is used as the new attachment's description. Otherwise no description will be set.
If the option --attachment-uid has been used prior to this option then its value is used as the new attachment's UID. Otherwise a random UID will be generated automatically.
--replace-attachment selector:filename
The selector can have one of four forms. They're explained below in the section attachment selectors.
If the option --attachment-name has been used prior to this option then its value is set as the new name for each modified attachment. Otherwise the names aren't changed.
If the option --attachment-mime-type has been used prior to this option then its value is set as the new MIME type for each modified attachment. Otherwise the MIME types aren't changed.
If the option --attachment-description has been used prior to this option then its value is set as the new description for each modified attachment. Otherwise the descriptions aren't changed.
If the option --attachment-uid has been used prior to this option then its value is set as the new UID for each modified attachment. Otherwise the UIDs aren't changed.
--update-attachment selector
The selector can have one of four forms. They're explained below in the section attachment selectors.
If the option --attachment-name has been used prior to this option then its value is set as the new name for each modified attachment. Otherwise the names aren't changed.
If the option --attachment-mime-type has been used prior to this option then its value is set as the new MIME type for each modified attachment. Otherwise the MIME types aren't changed.
If the option --attachment-description has been used prior to this option then its value is set as the new description for each modified attachment. Otherwise the descriptions aren't changed.
If the option --attachment-uid has been used prior to this option then its value is set as the new UID for each modified attachment. Otherwise the UIDs aren't changed.
--delete-attachment selector
The selector can have one of four forms. They're explained below in the section attachment selectors.
Options for attachment actions:
--attachment-name name
--attachment-mime-type mime-type
--attachment-description description
--enable-legacy-font-mime-types
This affects both adding new attachments and replacing existing attachments, but only if the new MIME type isn't specified. Other existing attachments aren't changed.
The affected MIME types are 'font/sfnt', 'font/ttf' and 'font/collection' which are all mapped to 'application/x-truetype-fonts' and 'font/otf' which is mapped to 'application/vnd.ms-opentype'.
Other options:
--disable-language-ietf
This option does not affect changes requested via the 'language-ietf' track header property.
--normalize-language-ietf mode
In the canonical form all subtags for which preferred values exist are replaced by those preferred values. This converts e.g. 'zh-yue-jyutping' to 'yue-jyutping' or 'fr-FX' to 'fr-FR'.
For the extended language subtags form the canonical form is built first. Afterwards all primary languages for which an extended language subtag exists are replaced by that extended language subtag and its prefix. This converts e.g. 'yue-jyutping' back to 'zh-yue-jyutping' but has no effect on 'fr-FR' as 'fr' is not an extended language subtag.
This normalization is only applied to elements that are actually changed:
The best way to normalize all existing language tags in a file is to remux it with mkvmerge(1) and set its '--normalize-language-ietf' option to the desired mode.
--command-line-charset character-set
--output-charset character-set
-r, --redirect-output file-name
--ui-language code
--abort-on-warnings
--debug topic
--engage feature
--gui-mode
-v, --verbose
-h, --help
-V, --version
@options-file.json
EDIT SELECTORS¶
The --edit option sets the Matroska file section (segment information or a certain track's headers) that all following add, set and delete actions operate on. This stays valid until the next --edit option is found. The argument to this option is called the edit selector.
By default mkvpropedit(1) will edit the segment information section.
Segment information¶
The segment information can be selected with one of these three words: 'info', 'segment_info' or 'segmentinfo'. It contains properties like the segment title or the segment UID.
Track headers¶
Track headers can be selected with a slightly more complex selector. All variations start with 'track:'. The track header properties include elements like the language code, 'default track' flag or the track's name.
track:n
Numbering starts at 1.
track:tn
Numbering starts at 1.
track:=uid
track:@number
Notes¶
Due to the nature of the track edit selectors it is possible that several selectors actually match the same track headers. In such cases all actions for those edit selectors will be combined and executed in the order in which they're given on the command line.
ATTACHMENT SELECTORS¶
An attachment selector is used with the two actions --replace-attachment and --delete-attachment. It can have one of the following four forms:
EXAMPLES¶
The following example edits a file called 'movie.mkv'. It sets the segment title and modifies the language code of an audio and a subtitle track. Note that this example can be shortened by leaving out the first --edit option because editing the segment information element is the default for all options found before the first --edit option anyway.
$ mkvpropedit movie.mkv --edit info --set "title=The movie" --edit track:a1 --set language=fre --edit track:a2 --set language=ita
The second example removes the 'default track flag' from the first subtitle track and sets it for the second one. Note that mkvpropedit(1), unlike mkvmerge(1), does not set the 'default track flag' of other tracks to '0' if it is set to '1' for a different track automatically.
$ mkvpropedit movie.mkv --edit track:s1 --set flag-default=0 --edit track:s2 --set flag-default=1
Replacing the tags for the second subtitle track in a file looks like this:
$ mkvpropedit movie.mkv --tags track:s2:new-subtitle-tags.xml
Removing all tags requires leaving out the file name:
$ mkvpropedit movie.mkv --tags all:
Replacing the chapters in a file looks like this:
$ mkvpropedit movie.mkv --chapters new-chapters.xml
Removing all chapters requires leaving out the file name:
$ mkvpropedit movie.mkv --chapters ''
Adding a font file (Arial.ttf) as an attachment:
$ mkvpropedit movie.mkv --add-attachment Arial.ttf
Adding a font file (89719823.ttf) as an attachment and providing some information as it really is just Arial:
$ mkvpropedit movie.mkv --attachment-name Arial.ttf --attachment-description 'The Arial font as a TrueType font' --attachment-mime-type application/x-truetype-font --add-attachment 89719823.ttf
Replacing one attached font (Comic.ttf) file with another one (Arial.ttf):
$ mkvpropedit movie.mkv --attachment-name Arial.ttf --attachment-description 'The Arial font as a TrueType font' --replace-attachment name:Comic.ttf:Arial.ttf
Deleting the second attached file, whatever it may be:
$ mkvpropedit movie.mkv --delete-attachment 2
Deleting all attached fonts by MIME type:
$ mkvpropedit movie.mkv --delete-attachment mime-type:application/x-truetype-font
EXIT CODES¶
mkvpropedit(1) exits with one of three exit codes:
TEXT FILES AND CHARACTER SET CONVERSIONS¶
For an in-depth discussion about how all tools in the MKVToolNix suite handle character set conversions, input/output encoding, command line encoding and console encoding please see the identically-named section in the mkvmerge(1) man page.
ENVIRONMENT VARIABLES¶
mkvpropedit(1) uses the default variables that determine the system's locale (e.g. LANG and the LC_* family). Additional variables:
MKVPROPEDIT_DEBUG, MKVTOOLNIX_DEBUG and its short form MTX_DEBUG
MKVPROPEDIT_ENGAGE, MKVTOOLNIX_ENGAGE and its short form MTX_ENGAGE
SEE ALSO¶
WWW¶
The latest version can always be found at the MKVToolNix homepage[1].
AUTHOR¶
Moritz Bunkus <moritz@bunkus.org>
NOTES¶
- 1.
- the MKVToolNix homepage
2023-02-12 | MKVToolNix 74.0.0 |