Tag Archives: MKVToolNix

MKVToolNix v56.1.0 released

Hello again,

unfortunately the release I’ve done only four days ago contains a nasty bug in the HEVC/H.265 code, and people are hitting it in droves. Therefore I’m releasing a fix for that today

You can download the source code or one of the binaries. The Windows and macOS binaries as well as the Linux AppImage are available already. The other Linux binaries are stil being built and will be available over the course of the next couple of hours.

Here are the NEWS since the previous release:

New features and enhancements

  • mkvmerge: AAC: added support for LOAS/LATM files with channel configuration indexes 9–21 (e.g. channel count 22.2 for index 13) according to Rec. ITU-R BS.1196-7 & ISO/IEC 23008-3:2019. Fixes #3081.

Bug fixes

  • mkvmerge: HEVC/H.265 parser: fixed invalid memory access that could happen when reading certain types of HEVC data (e.g. with changing parameter sets mid-stream) from certain containers (e.g. Matroska). This bug was introduced in release 56.0.0. Fixes #3083.
  • mkvextract: AAC: mkvextract will now abort with an useful error message when the user tries to extract a track whose ‘audio-specific config’ element in CodecPrivate signals a number of channels of 7 or greater than 8 as that isn’t supported by the ADTS format.

Build system changes

  • configure: the --enable-ubsan option hasn’t actually enabled anything since release 39.0.0.

Have fun 😎

MKVToolNix v56.0.0 released

Heyo everyone,

time for the April release of MKVToolNix. It’s mostly a bug fix release focussing on improving a lot of fundamental functionality such as chapters & tags.

The most notable thing to have happened, though, is that the Windows version of MKVToolNix is now available from the Microsoft Store. It isn’t free there, though, as it is meant to be a way for you to actively support the development of MKVToolNix (you get automatic updates in return). Please note that this is purely optional and will forever remain optional: completely free variants for Windows will always be available from the home page, just like in the past. See this FAQ entry for more information.

You can download the source code or one of the binaries. The Windows and macOS binaries as well as the Linux AppImage are available already. The other Linux binaries are stil being built and will be available over the course of the next couple of hours.

Here are the NEWS since the previous release:

New features and enhancements

  • mkvmerge, mkvpropedit: tags: the programs will no longer write tag elements that are mandatory and set to their default value (e.g. “tag language” set to und = undetermined).
  • mkvmerge, mkvpropedit, MKVToolNix GUI chapter editor: chapters: the programs will no longer write chapter elements that are mandatory and set to their default value (e.g. “chapter language” set to eng = English or “Chapter flag enabled” = 1).
  • mkvextract: chapters: mkvextract will no longer add a ChapterLanguage element set to eng to the generated XML content if the source file doesn’t contain such an element.
  • MKVToolNix GUI: multiplexer: when using the “tab widget below the files & tracks” layout option for the track properties the elements in the “general options” tab will use six rows à four columns instead of twelve rows à two columns, greatly reducing the required height. Implements #3062.

Bug fixes

  • mkvmerge: AAC reader: fixed mkvmerge aborting to read AAC files bigger than 2 GB with a message about not being able to allocate memory. Fixes #3059.
  • mkvmerge: chapters: ChapLanguageIETF elements were still created when the option --disable-language-ietf was given after an option leading to the creation of chapters. Now the position doesn’t matter anymore. Part of the fix of #3069.
  • mkvmerge: chapters: when the option --disable-language-ietf is used, ChapLanguageIETF elements won’t be written even when sources are read (Matroska files or XML chapters files) that do contain those elements. Part of the fix of #3069.
  • mkvmerge: tags: when the option --disable-language-ietf is used, TagLanguageIETF elements won’t be written. Fixes #3070.
  • mkvmerge: tags: mkvmerge will no longer write language elements for the track statistics tags it creates, making the effective language “undetermined” due to und being the default value for the legacy tag language element. Fixes #3073.
  • mkvmerge: tags: the XML tag parser will now validate all <Simple> children of <Tag> elements, not just the first for each <Tag>. Part of the fix of #3071.
  • mkvmerge: tags: the XML tag parser now uses the spec-compliant und (“undetermined”) as the default language for <Simple> tags instead of eng. Part of the fix of #3071.
  • mkvmerge, mkvpropedit: tags: mkvmerge will no longer set the “target type” for track statistics tags (earlier it used MOVIE). The “target type value” will still be set to 50. Fixes #3074.
  • mkvmerge, mkvextract: HEVC/H.265: both programs will now normalize the placement of VPS, SPS and PPS NALUs. Each key frame is prefixed with exactly one copy of the currently active parameter sets. This fixes certain classes of bugs related to splitting/appending. Fixes #3034.
  • mkvinfo: when compiled with newer versions of the fmt library, certain numbers were not output correctly (e.g. a track’s audio sampling frequency of 48000 might be output as 48).
  • MKVToolNix GUI: multiplexer: deriving the track language from the file name will match languages case insensitively again (like versions prior to v55). Fixes #3068.
  • MKVToolNix GUI: multiplexer: under certain circumstances keyboard shortcuts such as Ctrl+W for closing the active tab or Ctrl+R for starting to multiplex ceased to work until the user did certain other things (such as switching to a different tool & back to the multiplexer or opening the multiplexer menu). This started with v54. Fixes #3051.
  • MKVToolNix GUI: chapter editor: the editor will no longer create empty ChapterCountry elements when adding a chapter name with no default country selected in the preferences. Fixes #3072.

Build system changes

  • The bundled fmt library was updated to v7.1.3.

Have fun 😊

MKVToolNix v55.0.0 released

Heya everyone,

wait! We’ve just had a release of MKVToolNix. What’s up with doing another one so soon? Well, thing is, that previous release is buggy. Quite a bit. It included three major changes to its internals: the change from boost::filesystem to std::filesystem, the extension of languages to include ISO 639-3 codes and a complete rewrite how file identification works in the GUI.

The first of those rewrites caused a lot of pain for users on Windows. First of all UNC paths such as \\server\share\directory\file.mkv didn’t work at all: the GUI might hang, not remember the most recently used directory, refuse to create missing directories, things like that. Second, there were several situations in which non-ASCII characters (think German Umlauts, Asian characters, Emojis) were mangled. Users are constantly opening new issues in my bug tracker which is always a good indicator that quick bug fix release is warranted.

The other two rewrites also caused bugs that, while not as severe, were annoying, too. This release includes fixes for them, too.

There have been no changes concerning package maintainers.

You can download the source code or one of the binaries. The Windows and macOS binaries as well as the Linux AppImage are available already. The other Linux binaries are stil being built and will be available over the course of the next couple of hours.

Here are the NEWS since the previous release:

Bug fixes

  • all programs, only on Windows: fixed checking existence of & creating directories with UNC paths such as \\server\share\folder\file.mkv. Fixes #3041.
  • all programs, only on Windows: implemented several workarounds for bugs in std::filesystem wrt. UNC paths. The effect of those bugs was that Blu-rays and DVDs couldn’t be added from UNC paths. Fixes #3037.
  • mkvmerge, only on Windows: fixed non-ASCII characters getting mangled in the destination file name when splitting is active.
  • MKVToolNix GUI, only on Windows: fixed the GUI hanging when trying to browse for files on drives that don’t actually exist. Fixes #3046.
  • MKVToolNix GUI, only on Windows: the GUI did not remember UNC paths as the “most recently used source directory” properly.
  • MKVToolNix GUI: only on Windows: when dragging & dropping files from other applications to MKVToolNix GUI the GUI will force the drop action to be a copy action, no matter which keys were pressed by the users. This prevents Windows Explorer from deleting the dragged file when the user presses shift while dropping the file onto MKVToolNix GUI.
  • MKVToolNix GUI, only on Windows: when using the file dialog for selecting a file name to save to (e.g. when browsing for the destination file name in the multiplexer or saving an attachment in the header editor) non-ASCII characters in the default file name were mangled. Fixes #3049.
  • MKVToolNix GUI: multiplexer: the user can now configure what to do when using the “Add source files” button independently of the setting for what happens when files are dragged & dropped onto the GUI. The same options are available, but they’re distinct settings, allowing for different use cases. Fixes #3035.
  • MKVToolNix GUI: multiplexer: deriving the track language from file names doesn’t use one big regular expression of all enabled languages anymore. Instead, the file name is split into parts on a list of characters (such as . or ( and ); configurable in the preferences). This prevents the regular expression becoming too big for the regular expression library to handle when many languages are enabled. Fixes #3048.
  • MKVToolNix GUI: preferences: the language lists for “deriving track languages” and “enabling items by language” always included all the ISO 639-3 languages, even if those weren’t enabled in the “often-used languages” pane. Fixes #3047.

Other changes

  • mkvmerge, MKVToolNix GUI multiplexer: the functionality for changing the length of the NALU “size” field for AVC/H.264 and HEVC/H.265 tracks has been removed. The corresponding command-line option will continue to be recognized by mkvmerge as not to break existing third-party applications, but it won’t actually do anything.

Have fun 😊

Converting a C++ code base from boost::filesystem to std::filesystem

My project MKVToolNix has used the boost::filesystem library for a long time. It allows for easy path manipulation (e.g. “what’s the parent directory”, “does the named entry exist & is a file” or “create all directories for this path that don’t exist yet”). The central class of the library is boost::filesystem::path which encodes an absolute or relative part of an entry in the file system and offers various functions for modifying, querying or formatting it. All utility functions such as the aforementioned “create all directories” take path instances as arguments.

All of this worked mostly fine.

After release v53 of MKVToolNix a user reported an issue with using Emojis in file names. Turns out this wasn’t trivial to debug and is likely a bug in boost::filesystem or in the way I handled character encoding (more on that later).

This motivated me to look into converting MKVToolNix from boost::filesystem to std::filesystem which had been added to the C++ Standard Library with C++17. Its design is based heavily on boost::filesystem: a lot of the classes & functions are named identically within the two namespaces and most of their semantics match. As I’m eager to reduce the number of third-party libraries by using C++ standard libraries where it makes sense, converting my code base seemed the obvious step.

I mean, how hard could it be? Right?

Easy changes

A lot of changes were trivial: simply replacing boost::filesystem:: with std::filesystem:: got me pretty far.

Another easy change was to replace deprecated function names with the current ones, e.g. branch_path() with parent_path(): look up the deprecated function name in for boost::filesystem, take its replacement & swap the namespace — done.

Encodings & character set conversions

The most glaring difference in my opinion between the two libraries is how they handle encodings/character set conversions for the path classes. In both libraries the path class offer constructors for instances of std::string and std::wstring. Internally the classes use either std::string or std::wstring for storage depending on the operating system they’re compiled for: wide strings (std::wstring) for Windows and narrow ones (std::string) everywhere else.

This means that the constructors taking the string type that doesn’t match the storage type (std::string on Windows, std::wstring everywhere else) must do character set conversion, either from narrow to wide (Windows) or wide to narrow (Linux). This is where things get really dicey.

boost::filesystem solves this by letting the user imbue the whole boost::filesystem::path class with a C++ locale object. That locale object is used for the conversion. The programmer has to set this up once per program invocation, and that’s it. Easy.

MKVToolNix’s internal string handling uses UTF-8 encoded narrow strings everywhere. For file names, too[1]Yes, I know that’s bad as file systems on Unix aren’t guaranteed to have any type of encoding; file names might contain something that isn’t valid according to any encoding etc. etc.. Therefore the logical choice was to imbue boost::filesystem::path with an UTF-8 character set conversion locale. It would convert between UTF-8 encoded narrow strings and wide strings.

std::filesystem does not do it that way. At all. For the constructor taking char-based narrow strings (pointer-to-char or std::string) conversion from the native narrow encoding is done. On POSIX systems this means no conversion which matches how MKVToolNix is coded: std::filesystem::path receives a UTF-8 encoded narrow string & stores it as-is internally.

On Windows, though, this means that conversion is done from a character set such as Windows-1252 on a German Windows. Oooh boy, this is bad, as that isn’t at all how MKVToolNix encodes narrow strings. So what happens when an UTF-8 encoded narrow string containing non-ASCII characters is passed to std::filesystem::path? Mangled non-ASCII characters, of course. German Umlaute, French accents, Asian characters, Emojis — doesn’t matter. Encodings don’t match, conversion does bad things, file names are messed up.

In effect this means that I must never, ever use the narrow string constructor of std::filesystem::path on Windows except for when I know the narrow string only contains ASCII characters.

Implicit conversion

This thing wouldn’t be so bad for me if the constructors std::filesystem::path were explicit. They’re not, though, meaning string-to-path can hide in various places and are hard to spot. For example:

void do_stuff(const std::filesystem::path &p) {
  // do something with p
}

void chunky_bacon(const std::string &file_name) {
  // do chunky things
  do_stuff(file_name);
  // do bacon things
}

Here’s one of those conversions that absolutely must not happen on Windows, due to the implicit constructor.

Another example:

std::filesystem::path dir;
// set dir somehow
auto full_file_name = dir / sub_dir / "index.txt";

Is this OK? Well, depends on the type of sub_dir, actually. If it is a path already, it’s OK; if it’s a wide string, it’s OK, too, but all narrow string types (char arrays, std::string)? Not so much. And this is really hard to spot or grep for.[2]The "index.txt" argument is fine. Even though it’s a narrow string, it solely consists of ASCII characters that’ll convert properly to wide strings no matter what Windows’ native … Continue reading

I’d really appreciate if my compiler was able to help me out here. Having the constructors explicit would mean neither of these examples would compile and I’d need to add an explicit conversion myself. But the C++ committee didn’t make them explicit, probably for a reason.

Solutions

My solution was to ban the use of the constructors[3]C++20 will improve this situation with the introduction of char8_t. The constructor taking a char8_t-based narrow string will always convert from UTF-8, avoiding this mess.. Instead I introduced helper functions to_path() that take both narrow & wide strings & assume narrow strings are UTF-8 encoded. These helper functions work differently depending on whether I’m compiling for Windows or other systems.

Let’s take the second example from above. I’d convert it as follows:

auto full_file_name = dir / mtx::fs::to_path(sub_dir) / "index.txt";

Ugly as sin.

Bugs in the C++ Standard Library

std::filesystem is rather new, being added in C++17. I was prepared for bugs to rear their ugly heads. But I wasn’t prepared for how broken certain parts of the gcc standard C++ library are on Windows wrt. to UNC paths[4]I use a gcc/mingw cross-compiler from the MXE project for cross-compiling from Linux to Windows. The same issues would happen compiling with mingw on Windows itself.. A UNC path might look like this: \\server\share\sub_dir\file.txt Without any particular order, here are a couple of issues I ran into (this is with gcc 10.2.0, the latest release at the time of writing):

  1. On Windows the std::filesystem::file_size function was implemented by calling 32-bit functions that use signed 32-bit variables for storing the file size. Needless to say, this doesn’t work too well with files larger than 2 GB. The corresponding gcc bug 95749 has already been fixed upstream, but it isn’t part of a release yet. My workaround: I cherry-picked the commit fixing the issue into my own copy of gcc I’m using for building MKVToolNix.
  2. std::filesystem::exists doesn’t work correctly with all UNC paths. It works with e.g. \\server\share\sub_dir\file.txt but not the share \\server\share itself. I’ve reported this as gcc bug 99311. My workaround: I don’t use std::filesystem::exists; instead I test for the type I expect (e.g. std::filesystem::is_directory or std::filesystem::is_regular_file) as those functions do work correctly. Even with UNC paths.
  3. As a consequence std::filesystem::create_directories doesn’t work with UNC paths either. It thinks that neither \\server nor \\server\share exist and tries to create them. That fails, obviously, and create_directories aborts at the first failure. My workaround: I NIH’ed my own create_directories function that uses std::filesystem::is_directory for testing for existence. Only on Windows, of course. Reported in the same bug as the one above.
  4. std::filesystem::absolute and std::filesystem::path::is_absolute don’t work on UNC paths. They think those paths aren’t absolute and will do funky things such as return C:\server\share\file.txt when asked for the absolute path to \\server\share\file.txt. Of course I reported this, too; it’s gcc bug 99333 where I was told that it was actually a bug in the std::filesystem::path::has_root_name function. My workaround: I NIH’ed some more functions that treat paths starting with \\ or // as absolute.
  5. UNC paths using forward slashes are only supported if the program is compiled with the cygwin gcc compiler. My workaround: in my NIH’ed functions I normalize forward slashes to backslashes.
  6. UNC device paths starting with \\?\… such as \\?\C:\Path\File.mkv or \\?\UNC\server\share\file.opus don’t work at all. Functions such as std::filesystem::exists() don’t work, and even my workaround from above (using std::filesystem::is_directory() or std::filesystem::is_regular_file()) doesn’t work with these paths. I’ve filed gcc bug 99430 for this. My workaround: at the moment I haven’t implemented one. I might replace \\?\… with \\.\… in my conversion functions as those seem to fare better.

As I wrote above, this is gcc 10.2.0. Your compiler might fare better, of course. I suspect that Microsoft’s Visual C++ has fewer of those Windows-specific issues, simply due to the amount of experience its developers have with Windows’s peculiarities.

Bugs in MKVToolNix

Most bugs that were actually bugs in MKVToolNix instead of the standard C++ library turned out to be due to using the implicit conversion of narrow strings to path objects that I’ve talked about in length above.

There was one bug that was due to changed semantics between the two libraries: what happens if your path is at the root already (e.g. C:\ on Windows) and you call parent_path() on it? boost::filesystem will return an empty path object whereas std::filesystem will return the same path again. This means that loops checking the file system from a point to root have to have their conditions changed. Instead of e.g. while (!path.empty()) you’ll have to do something like while (path.parent_path() != path). It gets even nastier wrt. to UNC paths; see this chart for details. I definitely forgot to fix a couple of these cases leading to endless loops.

macOS woes & older Linux versions

One problem on macOS is that different macOS versions have different levels of support for C++17. Until this change I used to build for macOS 10.14 “Mojave” and newer, as those supported all C++17 features I used. However, std::filesystem, while being a C++17 feature, is only supported on macOS 10.15 “Catalina” and the current 11.0 “Big Sur”. One of the drawbacks of using current technology.

This is a bit different to older Linux distributions. Let’s take CentOS 7, a rather old distribution. I can still compile current MKVToolNix releases there by installing the latest developer toolset which comes with a current gcc & libc++. For macOS the compiler version doesn’t suffice, though: even if I install a recent XCode version on macOS 10.14, I cannot build code using std::filesystem for it as the standard C++ library on macOS 10.14 doesn’t contain that functionality. I haven’t bothered investigating if it’s possible to include a newer standard C++ library itself in the MKVToolNix disk image.

And on Linux? Was it worth it?

Well… I haven’t had a single issue with so far with the conversion on Linux.

And as to the question whether or not it was worth it: hmm… meh. I really like to reduce my number of external dependencies. That is a tangible gain. It simplifies the build process & reduces build times in various situations where Boost isn’t available as I’m now down to solely using header-only libraries from Boost. And I actively take part in improving the gcc standard C++ library implementation. This is still Open Source, after all; you’re expected to give back & help out. This is how all of our projects grow.

Footnotes

1 Yes, I know that’s bad as file systems on Unix aren’t guaranteed to have any type of encoding; file names might contain something that isn’t valid according to any encoding etc. etc.
2 The "index.txt" argument is fine. Even though it’s a narrow string, it solely consists of ASCII characters that’ll convert properly to wide strings no matter what Windows’ native narrow encoding is. I hope.
3 C++20 will improve this situation with the introduction of char8_t. The constructor taking a char8_t-based narrow string will always convert from UTF-8, avoiding this mess.
4 I use a gcc/mingw cross-compiler from the MXE project for cross-compiling from Linux to Windows. The same issues would happen compiling with mingw on Windows itself.