MovieLabs Digital Distribution Framework MDDF

1 What's New

2 Overview

3 Status

4 Software Organization & Roadmap

1. mddf-lib
2. mddf-tools
3. Versioning

5 Using mddf-lib

6 Installing and Running mddf-tools

1. Java
2. Native Executables 1.Downloading 2.OS-X 3. Windows 4. Linux

7 Release History

1) What's New

• 2023-Aug-1: v2.0.7 released [See Note-7]

NOTE-1: Starting with v1.5.1, releases of mddf-lib are available via the Maven Central Repository. Refer to the mddf-lib README for information on adding dependancy information to pom files.

NOTE-2: Beginning with Release 1.5, pre-built executables for Windows, OS-X, and Linux will no longer be supported. The executable Java jar will still be supported. See "Installing and Running" for details.

NOTE-3: Release v1.8 contains an update to the Ratings DB with several broken URI. Release v1.8.0.1 was issued 2 days latter to correct this problem and should be used instead of v1.8.

NOTE-4: This fixes a bug that only occurs when running in the non-interactive mode.

NOTE-5: The v1.9.0.1 release is a patch providing support for Avails 2.5.2

NOTE-6: Release 2.0 addresses major security issues associated with the use of the Apache log4j library. USE OF EARLIER VERSIONS IS NOT RECOMMENDED.

NOTE-7: Release 2.0.1 addresses major security issues associated with the use of the Apache log4j library and other dependency libraries. USE OF EARLIER VERSIONS IS NOT RECOMMENDED.

2) Overview:

This repository contains Java software supporting the creation and usage of MDDF files including

• Avails
• Common Media Manifest (CMM)
• Media Manifest Core (MMC)
• Media Entertainment Core (MEC)
• Asset Order and Delivery (AOD)

Information on the MovieLabs Digital Distribution Framework and the various MDDF standards is available at http://www.movielabs.com/md/

3) Status and Relationship to Other MovieLabs Github Repositories:

The software in this repository is intended to replace that contained in the following MovieLabs repositories:

• availslib
• availstool
• cpe-preprocessing

4) Software Organization & Roadmap:

There are two projects within this repository: mddf-lib and mddf-tools.

4.1) mddf-lib

mddf-lib implements all core (i.e., non-UI) functionality that can be used to generate, validate, or transform MDDF files.

4.2) mddf-tools

This project implements a standalone application for performing MDDF-related tasks. The application, called the Tool Launcher, is implemented on top of mddf-lib and any developers intending to develop their own mddf support applications are encouraged to do the same.

The Tool Launcher may be used in either an interactive or batch (i.e., scripted) mode. Using the tool Launcher provides access to the following MDDF tools:

• Avails Validator Tool: may be used to

  • validate an Avails file specified as either XML or XLSX
  • validate an Offer Status file
  • translate an XLSX-formatted Avails to the equivalent XML
  • translate an XML-formatted Avails to the equivalent XLSX

• Manifest Validator: validates that a CMM, MMC, or MEC file conforms with:

  • the CMM schema
  • recommended 'Best Practices'
  • a specific profile

• AOD Validator: validates that a Asset Availability, Asset Order, or Product Status file conforms with:

  • the CMM schema
  • recommended 'Best Practices'

Releases of the mddf-tools are available as an executable Java jar which supports the processing of all MDDF files. In addition to an interactive mode, the jar provides a command line interface (CLI) that may be used either from a terminal window or in conjunction with scheduled jobs (e.g., via crontab). [NOTE: Releases prior to v1.1.3 did not include pre-built executable jars.]

Prior to v1.5, releases included Native Executables for Windows, OS-X, and Linux systems. Each executable is specific to the processing of either Avails or Manifest files.

Refer to ChangeLog.md for a list of specific enhancements and bug fixes for any given release.

4.3) Versioning:

4.3.1) mddf-lib and Java jars:

Stable releases of the mddf-lib will have a two-part version or a three-part version ID. Interim development and evaluation (i.e., BETA) releases will include an "rcN" suffix.

Examples:

• v1.3 or v2.0 identify stable releases
• v2.0.1.rc2 is a Beta release of v2.0.1

Executable jars are created for both stable and BETA releases and track the version number of the underlying mddf-lib.

Example: mddf-tool-v3.1.jar would based on, and compatible with, v3.1 of mddf-lib.

4.3.2) Native Executables:

As of v1.5, support for pre-built native executables has been dropped.

Beginning with the release of v1.3 of mddf-lib, native executables were assigned versions that append a letter to the the underlying mddf-lib version.

Examples:

• an Avails Validator with a version of v1.3.a is based on v1.3 of the mddf-lib.
• a Manifest Validator with a version of v1.3.2.c is based on v1.3.2 of the mddf-lib.

Prior to July 2017 and the release of v1.3 of the mddf-lib, the native executables were assigned a version ID independent of the mddf-lib version.

5) Using mddf-lib:

The mddf-tools described in the next section are implemented on top of mddf-lib. Starting with v1.5.1, releases of mddf-lib are available via the Maven Central Repository. Developers wishing to use mddf-lib in their own software therefore have two options: building from the source or adding a dependency to their build scripts, e.g.:

	<dependency>
		<groupId>com.movielabs</groupId>
		<artifactId>mddf-lib</artifactId>
		<version>${mddf.lib.version}</version>
	</dependency>

6) Installing and Running mddf-tools:

6.1) Java Executable Jar:

The mddf-tool jar may be used on any machine that supports Java 1.8 or a more recent jvm. A single jar file provides support for both the Avails and Manifest Validators. This is in contrast to the OS-specific executables in which there is a separate executable for each validation tool.

Once the jar file has been downloaded, it may be run using the standard Java command:

java -jar ./{path-to-directory}/mddf-tool-v{version}.jar -i

The -i argument indicates the toolkit should be started in interactive mode. A Tool Launcherdialog will appear that allows the user to select the MDDF tool they wish to use (e.g., the Avails Validator). To see all supported arguments, use -h

6.2) Native Executables (DEPRECATED):

Prior to v1.5 native executables for OS-X, Windows, and Linux were also provided. While these older executables are still available for download, usage is not recommended as they will lack support for the latest MDDF formats and standards. Also note that the executable Java jar provides support for both the Avails and Manifest Validators, in contrast to the OS-specific executables in which there is a separate executable for each validation tool

Downloading:

The native executables may be downloaded from one of two sources:

• Manifest Validator: http://movielabs.com/md/manifest/validator/
• Avails Validator: http://movielabs.com/md/avails/validator/

OS-X:

Due to issues with Apple's Gatekeeper security mechanism and JavaFX applications, OS-X executables are provided in the form of zip files. Unlike with the Java jars, a separate file must be downloaded and installed for each MDDF tool.

1. unzip the downloaded file(s) to the desired location (e.g. /Applications)
2. make the applications executable. Open a terminal and enter the following:

  cd {install-directory}
  chmod -R a+x ./AvailsValidator.app
  chmod -R a+x ./ManifestValidator.app

The application may now be launched via the Finder. An error message that the application cant be opened indicates Step #2 was not performed correctly.

Windows:

Executables for Windows environments are provided in the form of standard .exe files and require no special steps to install or run. The .msi formatted distro is not supported.

Linux:

Linux executables are provided in bothrpm and deb distro formats.

7) Release History:

• 2023-Aug-1: mddf-tool v2.0.7 released

• 2023-Apr-19: mddf-tool v2.0.6 released

• 2022-Sep-1: mddf-tool v2.0.5 released

• 2022-Apr-27: mddf-tool v2.0.4 released

• 2022-Feb-07: mddf-tool v2.0.1 released.

• 2021-Dec-21: mddf-tool v2.0 released.

• 2020-Dec-21: mddf-tool v1.9 released.

• 2020-Apr-21: mddf-tool v1.8.0.2 released.

• 2020-Mar-01: mddf-tool v1.8.0.1 released.

• 2020-Feb-28: mddf-tool v1.8 released.

• 2019-Nov-06: mddf-tool v1.7 released.

• 2019-Aug-27: mddf-tool v1.6 released.

• 2019-June-24: mddf-tool v1.5.3 released.

• 2019-May-24: mddf-tool v1.5.2 released.

• 2019-May-07: mddf-tool v1.5.2_rc1 released for testing and evaluation.

• 2019-Mar-15: mddf-tool v1.5.1 released.

• 2018-Nov-15: mddf-tool v1.5 released.

• 2018-Aug-08: mddf-tool v1.4 released.

• 2018-Jul-27: mddf-tool v1.4_rc2 released as an executable jar for testing and evaluation.

• 2018-Jul-05: mddf-tool v1.4_rc1 released as an executable jar for testing and evaluation.

• 2018-Mar-22: mddf-tool v1.3.2 released.

• 2017-Dec-18: mddf-tool v1.3.1 released.

• 2017-Nov-13: mddf-tool v1.3 released.

• 2017-Oct-13: mddf-tool v1.3.rc4 released for testing and evaluation.

• 2017-Sep-21: mddf-tool v1.3.rc3 released for testing and evaluation.

• 2017-May-09: mddf-tool v1.2 released.

• 2017-May-01: mddf-tool v1.1.3.rc8 released as an executable jar for testing and evaluation.

• 2017-Apr-21: mddf-tool v1.1.3.rc6 released as an executable jar for testing and evaluation.

• 2017-Apr-18: mddf-tool v1.1.3.rc4 released as an executable jar for testing and evaluation.

• 2017-Mar-29: mddf-tool released as an executable jar. Processing of either Avails or Manifest files is supported.

• 2017-Mar-02: mddf-lib v1.1.2 released.

• 2017-Feb-13: mddf-lib v1.1.1 released. This provides several fixes relating to the translation of Avails from XLSX to XML.

• 2017-Jan-30: mddf-lib v1.1 released.