Sisyphus Matroska

This Python module wraps mkvinfo, mkvmerge and mkvextract commands and adds some enhancements to mkvinfo and mkvextract that allows for the search of tracks via language and track type.

New Features

• 1.0.0: Tracks are not automatically copied over from source files. To copy all tracks to the resulting Matroska file, you can use the following options:

  • _copy-video-tracks: Copy all video tracks for a given source.
  • _copy-audio-tracks: Copy all audio tracks for a given source.
  • _copy-subtitle-tracks: Copy all subtitle tracks for a given source.

• 1.0.3: You can add an attachment directory. This will parse all of the files in that directory and add them as attachments to the Matroska file during multiplexing. If the MIME-type cannot be automatically determined, the file will be skipped.

• 1.0.3: MIME-types are automatically determined if no MIME-type is provided with an attachment via the mimetypes Python library.

• 1.0.4: MIME-types are now automatically determined by mkvmerge and no longer rely on the Python library.

Pythonic Version

from pathlib import Path

from mkvmerge import MkvMerge, MkvAttachment, MkvSource, MkvSourceTrack

m = MkvMerge()

# Set the output file for all of the muxing
m.output = Path('output.mkv')

# Add the sources. Tracks are zero-indexed based on their order in the CLI
# as well as here.
m.add_source(
    MkvSource(
        filename='test1.mkv',
        options={
            "_copy-video-tracks": None,
            "no-chapters": None
        }
    )
)
m.add_source(MkvSource(filename='test2.mkv'))

# Add tracks 0 and 2 to the first source (source 0)
m.sources[0].add_track(
    MkvSourceTrack(
        track=0,
        options={
            "language": "und",
            "default-track": "yes",
            "title": "Awesome Newly Muxed Video"
        }
    )
)
m.sources[0].add_track(
    MkvSourceTrack(
        track=2,
        options={
            "language": "eng",
            "default-track": "no"
        }
    )
)

# Add tracks 1 and 3 to the second source (source 1)
m.sources[1].add_track(
    MkvSourceTrack(
        track=1,
        options={
            "language": "jpn",
            "default-track": "yes"
        }
    )
)
m.sources[1].add_track(
    MkvSourceTrack(
        track=3,
        options={
            "language": "eng",
            "default-track": "yes",
            "track-name": "Cool Audio Track"
        }
    )
)

# Set the global options to pass to `mkvmerge`.
m.global_options = {
    "no-global-tags": None,
    "no-track-tags": None,
    "title": "Awesome Newly Muxed Video"
}

# Attach two fonts to the output Matroska file.
m.add_attachment(
    MkvAttachment(
        filename="test.otf"
    )
)
m.add_attachment(
    MkvAttachment(
        filename="test.ttf"
    )
)

# Add an entire directory of fonts as attachments.
m.add_attachment_directory("./fonts")

# Set the final track order for the Matroska file.  The order of this
# puts the video track first (0:0), then the Japanese audio track (1:1),
# then the English audio track (0:2), then the English subtitles (1:3).
#
# When loading from JSON, this is automatically generated from the order
# of the tracks in the JSON file.
m.track_order_override = ["0:0", "1:1", "0:2", "1:3"]

# Mux the track.
m.mux()

Passing a JSON file into the module

from mkvmerge import MkvMerge

m = MkvMerge()

# Load the configuration from the JSON file.  The track order in the JSON
# file is based on the order that the tracks appear in the file.
m.load_from_file('test.json')

# Mux the track.
m.mux()

The contents of the test.json file are below.

{
  "sources": [
    {
      "filename": "test1.mkv",
      "options": {
        "_copy-video-tracks": null,
        "no-chapters": null
      }
    },
    {
      "filename": "test2.mkv"
    }
  ],
  "tracks": [
    {
      "source": 0,
      "track": 0,
      "options": {
        "language": "und",
        "default-track": "yes",
        "title": "Awesome Newly Muxed Video"
      }
    },
    {
      "source": 1,
      "track": 1,
      "options": {
        "language": "jpn",
        "default-track": "yes"
      }
    },
    {
      "source": 0,
      "track": 2,
      "options": {
        "language": "eng",
        "default-track": "no"
      }
    },
    {
      "source": 1,
      "track": 3,
      "options": {
        "language": "eng",
        "default-track": "yes",
        "track-name": "THISISATEST"
      }
    }
  ],
  "output_file": "awesome_newly_muxed_video.mkv",
  "options": {
    "no-global-tags": null,
    "no-track-tags": null,
    "title": "Awesome Newly Muxed Video"
  },
  "attachments": [
    {
      "filename": "test.otf"
    },
    {
      "filename": "test.ttf"
    }
  ],
  "attachment_directories": [
    "./fonts"
  ]
}