PallyCon DRM CLI Packager Guide

Overview

This document describes the basic concepts and how to use the command line interface (CLI) based content packaging tool used for the PallyCon multi-DRM cloud service.

There are five types of content packaging:

1. DASH: A method of applying PlayReady and Widevine Modular DRM by packaging streaming contents with MPEG-DASH CENC standard.
2. HLS: A method of applying FPS (FairPlay Streaming) DRM by packaging HLS-AES streaming contents.
3. CMAF: Applying PlayReady, Widevine, and FairPlay DRM by packaging contents with CMAF(Common Media Application Format) type.
4. NCG: Content encryption by Inka Entworks' proprietary NCG (Netsync Content Guard) DRM for downloading or progressive download scenario.
5. HLS-NCG: HLS content packaging with SAMPLE-AES clear key protected by NCG DRM.

This guide is based on the 4.0.0 version of CLI packager. You can download the latest CLI packager from the Github repository.

Tutorial Video

This is a tutorial video about explaining the PallyCon DRM CLI Packager and how to use it in Windows OS.

Integration architecture and supported environments

PallyCon DRM CLI Packager works in conjunction with PallyCon Multi DRM Cloud Server. PallyCon cloud server manages the content key information for each service site, and when a client requests DRM license information, it finds the key (CEK) information associated with the CID and issues a license.

• Supported OS: Support 64 bit Windows, Linux (Ubuntu, CentOS), macOS (Intel, Apple Silicon)
• For Linux environment, gcc and g ++ library version 9.0 or later must be installed.
• macOS environment is supported by running Ubuntu builds using Docker.
• Available disk space should be at least twice the size of the contents for packaging.
• Only alphanumeric characters are allowed for input / output filenames.

PallyCon DRM CLI Packager is based on Google’s Shaka Packager. Please refer to Github page for details, documentation and source code of Shaka Packager.

Running CLI Packager on Linux

In Linux environments, specific versions of libraries may be required depending on the OS distribution and version.

Ubuntu environment

For Ubuntu 18.04 and earlier, because it requires a higher version of the glibc library, install gcc/g++ version 9 as below:

$ sudo apt install software-properties-common
$ sudo add-apt-repository ppa:ubuntu-toolchain-r/test
$ sudo apt update
$ sudo apt install gcc-9 g++-9
$ sudo update-alternatives --install /usr/bin/gcc gcc /usr/bin/gcc-7 700 --slave /usr/bin/g++ g++ /usr/bin/g++-7
$ sudo update-alternatives --install /usr/bin/gcc gcc /usr/bin/gcc-9 900 --slave /usr/bin/g++ g++ /usr/bin/g++-9

For Ubuntu version 22.04 or later, because only OpenSSL version 3.x is installed by default, install version 1.1.x as below:

$ sudo apt-get update
$ sudo apt-get install -y gcc make perl wget
$ wget https://www.openssl.org/source/openssl-1.1.1o.tar.gz
$ sudo tar -zxvf openssl-1.1.1o.tar.gz
$ cd openssl-1.1.1o
$ ./config && make
$ export LD_LIBRARY_PATH=<installed_directory_path>:$LD_LIBRARY_PATH

CentOS environment

Install the c-ares library with version 1.16.0 or later as below:

$ sudo yum c -y "Development Tools"
$ wget https://c-ares.haxx.se/download/c-ares-1.16.1.tar.gz
$ sudo tar -zxvf c-ares-1.16.1.tar.gz
$ cd c-ares-1.16.1
$ ./configure && make
$ sudo make install
$ sudo ldconfig
$ export LD_LIBRARY_PATH=/usr/local/lib:$LD_LIBRARY_PATH

Running CLI Packager on macOS

DRM CLI Packager v3.9.0 or later supports macOS environment in the following ways.

1. Create Dockerfile: Create Dockerfile with the following script.

FROM ubuntu:20.04

RUN apt update
RUN apt-get update -y && apt-get upgrade -y
RUN apt-get install -y git

RUN git clone https://github.com/inka-pallycon/pallycon-drm-cli-packager.git
RUN chmod 755 /pallycon-drm-cli-packager/bin/Ubuntu/aarch64/PallyConPackager

ENTRYPOINT ["/pallycon-drm-cli-packager/bin/Ubuntu/aarch64/PallyConPackager"]

2. Build Ubuntu Image: Build an Ubuntu image using the Dockerfile you created.

docker build -t <user-name>/ubuntu-packager .

3. Run packager command: Run the packager with the following example command in the Ubuntu container.

docker run \
	-v /Users/my/workspace/contents:/contents \
	-v /Users/my/workspace/packaging-output:/packaging-output \
	-it \
	--rm \
	<user-name>/ubuntu-packager \
	-o /packaging-output -i /contents/sintel/Sintel.2010.480P.mp4 --disable_encryption --dash

Packager execution parameters

You can use additional Shaka Packager commands in the command format below.

Basic command format

./PallyConPackager --enc_token value --content_id value -i value -o value (--dash || --hls || --cmaf || --ncg || --hls_ncg)

Command parameters

Options for using external keys

This option is used when packaging with a key that is managed separately by the service site, without using the encryption key generated by PallyCon key server.

When using external keys, parameters such as --enc_token, --site_id, and --access_key are not used because it does not require communication with the PallyCon key server.

Error code

Result format

<?xml version="1.0" encoding="UTF-8"?> 
<PallyconPackager>
    <RESULT>0</RESULT>
</PallyconPackager>

RESULT: ‘0’ if succeeded. Error code if failed.

Error codes

Example

DASH packaging

PlayReady, Widevine DRM-protected DASH stream packaging. Usually run with HLS packaging. (type --dash --hls)

./PallyConPackager --enc_token YOUR-KMS-TOKEN-VALUE --content_id test-content-1 --dash -i ./input/test-content-1.mp4 -o ./output/test-content-1

HLS packaging

FairPlay Streaming DRM-protected HLS stream packaging. Usually run with DASH packaging. (type --dash --hls)

./PallyConPackager --enc_token YOUR-KMS-TOKEN-VALUE --content_id test-content-1 --hls -i ./input/test-content-1.mp4 -o ./output/test-content-1

CMAF packaging

PlayReady, Widevine, FPS DRM-protected CMAF stream packaging.

./PallyConPackager --enc_token YOUR-KMS-TOKEN-VALUE --content_id test-content-1 --cmaf -i ./input/test-content-1.mp4 -o ./output/test-content-1

HLS-NCG packaging

HLS stream packaging that protects clear keys of SAMPLE-AES with NCG DRM. This cannot be done along with other types of packaging such as DASH or HLS(FPS).

./PallyConPackager --enc_token YOUR-KMS-TOKEN-VALUE --content_id test-content-1 --hls_ncg -i ./input/test-content-1.mp4 -o ./output/test-content-1

NCG packaging

NCG DRM-encoded MP4 file packaging used for download or progressive download scenarios. (creates .ncg extension file)

./PallyConPackager --enc_token YOUR-KMS-TOKEN-VALUE --content_id test-content-1 --ncg -i ./input/test-content-1.mp4 -o ./output/test-content-1

Adaptive-Streaming packaging

For DASH or HLS packaging, you can enter content with multiple resolutions and package it for adaptive streaming.

./PallyConPackager --enc_token YOUR-KMS-TOKEN-VALUE --content_id test-content-1 --dash --hls -i ./input/test-content-1-480p.mp4 ./input/test-content-1-720p.mp4 ./input/test-content-1-1080p.mp4 -o ./output/test-content-1

Using external key (DASH, HLS)

This is a method of multi DRM packaging using the key managed by the service site instead of the encryption key generated by PallyCon key server.

./PallyConPackager --content_id test-content-1 --dash --hls --enable_raw_key_encryption --keys label=:key_id=f3c5e0361e6654b28f8049c778b23946:key=a4631a153a443df9eed0593043db7519 -i ./input/test-content-1.mp4 -o ./output/test-content-1

Using external key (NCG, HLS-NCG)

This is a method of packaging NCG DRM using the key managed by the service site instead of the encryption key generated by PallyCon key server.

./PallyConPackager --site_id SITE --content_id test-content-1 --enable_raw_key_encryption --ncg_cek a4631a153a443df9eed0593043db7519f3c5e0361e6654b28f8049c778b23946 --ncg --hls_ncg -i ./input/test-content-1.mp4 -o ./output/test-content-1

Using configuration file

It is a method to save fixed setting values among input parameters as a separate config file.

./PallyConPackager --config_file ./config.txt --content_id test-content-1 -i ./input/test-content-1.mp4 -o ./output/test-content-1

Example of config file

• config.txt (Default = Json)

  {
      "--site_id": "SITE",
      "--access_key": "DgBluIlxajZpPPjSIuqS6NcknqqG7RCt"
  }
  

• config.xml

  <?xml version="1.0" encoding="UTF-8"?>
  <config> 
  <--site_id>SITE</--site_id> 
  <--access_key>DgBluIlxajZpPPjSIuqS6NcknqqG7RCt</--access_key>
  </config>
  

Packaging subtitles

Supports external subtitles in VTT format only.

./PallyConPackager --enc_token YOUR-KMS-TOKEN-VALUE --content_id test-content-1 -i ./input/test-content-1.mp4 -o ./output/test-content-1 --dash --hls --subtitle ./input/test-content-1-en.vtt:lang=en:name=English ./input/test-content-1-ko.vtt:lang=ko:name=Korean ./input/test-content-1-fr.vtt:lang=fr:name=French ... 

Multi-key Packaging

./PallyConPackager --enc_token YOUR-KMS-TOKEN-VALUE --content_id test-content-1 -i ./input/test-content-1-720p.mp4 ./input/test-content-1-1080p.mp4 -o ./output/test-content-1 --dash --multi_key

Multi-key Packaging with external keys

./PallyConPackager --content_id test-content-1 --dash --enable_raw_key_encryption --keys label=SD:key_id=f3c5e0361e6654b28f8049c778b23946:key=a4631a153a443df9eed0593043db7519, label=HD:key_id=8f8049c778b23946f3c5e0361e6654b2:key=eed0593043db7519a4631a153a443df9, label=AUDIO:key_id=e0361e6654b28f80f3c549c778b23946:key=1a153a443df9eed0a463593043db7519 -i ./input/test-content-1-480p.mp4 ./input/test-content-1-720p.mp4 ./input/test-content-1-audio.m4a -o ./output/test-content-1

Multiple manifests for allowed track types

./PallyConPackager --site_id <site id> --access_key <access key> --content_id <content id> -o <output directory> --dash --multi_key -i <input file1> <input file2> ... --generate_tracktype_manifests