PM Xpress 1 0 1 0 UserGuide RevA 0
PM Xpress 1 0 1 0 UserGuide RevA 0
Rev A
Disclaimer
Harmonic reserves the right to alter the equipment specifications and descriptions in this publication without prior notice. No part of
this publication shall be deemed to be part of any contract or warranty unless specifically incorporated by reference into such
contract or warranty. The information contained herein is merely descriptive in nature, and does not constitute a binding offer for
sale of the product described herein. Harmonic assumes no responsibility or liability arising from the use of the products described
herein, except as expressly agreed to in writing by Harmonic. The use and purchase of this product do not convey a license under
any patent rights, copyrights, trademark rights, or any intellectual property rights of Harmonic. Nothing hereunder constitutes a
representation or warranty that using any products in the manner described herein will not infringe any patents of third parties.
Trademark Acknowledgments
Harmonic and all Harmonic product names are trademarks of Harmonic Inc. All other trademarks are the property of their respective
owners.
The software described in this document is furnished under a license agreement or nondisclosure agreement. The software may be
used or copied only in accordance with the terms of those agreements.
CAUTION: The Caution symbol calls your attention to information that, if ignored, can adversely affect
the performance of your Harmonic product, or that can make a procedure needlessly difficult.
NOTE: The Note symbol calls your attention to additional information that you will benefit from
heeding. It may be used to call attention to an especially important piece of information you need, or it
may provide additional information that applies in only some carefully delineated circumstances.
TIP: The Tip symbol calls your attention to parenthetical information that is not necessary for performing
a given procedure, but which, if followed, might make the procedure or its subsequent steps easier,
smoother, or more efficient.
In addition to these symbols, this manual uses the following text conventions:
Convention Explanation
Typed Command Indicates the text that you type in at the keyboard
prompt.
LCD Screen Output The text that is displayed on an LCD console output.
NOTE: You require Adobe Reader or Adobe Acrobat version 6.0 or later to open the PDF files. You can
download Adobe Reader free of charge from www.adobe.com.
Table of Contents
Chapter 1 Preface
1.1 Organization of this guide . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
Chapter 2 Introduction
2.1 ProMedia Xpress Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6
■ Chapter 3, Configuring Xpress and Package Presets, describes the procedures on how to
configure the Xpress and Package presets.
■ Chapter 4, Creating Workflow Templates for Xpress & Package Presets, describes the
procedures on how to create workflow templates for the Xpress and Package presets.
Click to add
3.1.1 Input
Specify Program Number Selection
If enabled, you can specify the Program Number selected for transcoding of MPTS
source.
Audio Selection Mode
Determine which audio streams at the input will be selected.
❑ All. Select all audio streams.
❑ AAC. Select the AAC audio streams.
❑ AC3. Select the AC3 audio streams.
❑ MPEG1-Layer II. Select the MPEG1-Layer II audio streams.
Audio Selection by descriptor
If enabled, you can specify string descriptors for audio filtering (e.g. Eng, Spa, Fre).
Multiple Audio Descriptor entries are supported.
Profile. WFS achieves logo pictures according to the URLs specified in each Bitrate
Profile.
Enable. Click to enable/disable Logo Insertion.
File Path. The FTP/HTTP download path of the logo picture. The supported graphics file
format is PNG.
NOTE: If you desire to have a new logo picture in place of the old picture, you must change and adopt a
new FTP/HTTP download path.
❑ Uncopyrighted Original
❑ Copyrighted Copy
❑ Copyrighted Original
Enable ABR
ABR (Average Bit Rate) encoding uses the average bit rate per IDR interval (CBR over an
integration period of the IDR interval), rather than the typical CBR over an integration
period of 40 ms. This setting leads to significant video quality improvement for a given bit
rate, with no additional overhead on the HTTP network.
With ABR encoding enabled, users measuring the transport stream output rate with
traditional MPEG analyzers will see more NULL packets than expected, and a VBR video
PID peaking a bit rates higher than the configured rate. HTTP clients which use the IDR
integration period in their analysis will continue to see the configured bit rate.
VBV Delay
If Default is selected, WFS will output the standard video quality. If Reduced is selected,
the processing time needed to decode is reduced relative to the Default option.
IDR Period (s)
The time interval (expressed in seconds) between IDR (Intra Decoder Refresh) frames that
are inserted into the stream. The range must be between 1 and 10.
AC-3 Decoding Mode
Specify whether to add 11 dB for AC-3 decoding. Choose from:
❑ RF
If RF mode is selected, it is used for portable devices which will produce a louder
audio volume (i.e. fix gain of 11 dB) at the transcoded output.
❑ Line
If Line mode is selected, it is targeted for IPTV (i.e. set-top box) environment for
better audio dynamic range. There will be no fix gain of 11 dB added to the audio.
Video Profile
Select a video encoding profile. The options are:
Codec Profile
Video Level
This is the data depth for the given codec and profile. The level specifies the data
constraints for settings such as frame rate, or maximum Width and Height. The options
are:
Codec Level
H.264 1, 1.1, 1.2, 1.3, 2, 2.1, 2.2, 3, 3.1, 3.2, 4, 4.1, 4.2, 5, 5.1
Bitrate (kbps)
The video encoding bitrate, expressed in kbps.
Width
The width of the output frame size.
Height
The height of the output frame size.
Frame Rate
Select the desired output frame rate.
GOP Structure
Select the desired GOP structure to set the number of B picture between I picture and P
picture. If Auto is enabled, WFS determines the appropriate number of B picture set
between I picture and P picture.
Audio Codec
Select the desired codec that is used to encode/transcode the input audio stream.
Output Codecs
Adobe HTTP Dynamic Streaming AAC-LC
HE-AAC v1
HE-AAC v2
Mode
ProMedia Xpress supports Downmix 5.1 and stereo as input and, output to Stereo or
Mono.
Codec Mode
HE-AAC v2 Stereo
5.1
Resampling Choices
Bitrate (kbps)
This is the bitrate for encoding audio. This impacts the output audio elementary stream
but not the subsequent encapsulation process.
Gain (dB)
This is the audio gain value, in decibels. The range of input is -20dB to +20dB. The
default value is 0 dB.
3.1.5 Output
Output File Base Name
Output File Base Name. The following special patterns are supported:
❑ %SourceName%: the file name of the source.
❑ %Index%: the index of the output files.
❑ %BitRate%: the video bitrate of the output files.
Directory for Entire Asset
Create a sub-directory in the WFS task output directory for all output files.
Asset Directory Base Name
Define the directory name for all output files. The following special pattern is supported:
1. In the WFS Manager GUI, navigate to Tools > Package Preset Editor.
❑ %CommonSourceName%
❑ %SourceFileName%
❑ %PID%
❑ %BitRate%
❑ %Language%
Text Stream Base Name
The Text Stream Base Name allows you to define the base filename for TTML files. The
following special patterns are supported:
❑ %CommonSourceName%
❑ %SourceFileName%
❑ %Language%
❑ %TrackName%
Text Stream Extension
The Text Stream Extension allows you to define the file extension for TTML files.
3.2.1.4 General
Fragment Duration [second]
The duration of each fragment (expressed in seconds) within the F4F files.
Segment Duration [second]
The duration of the media segment files (expressed in seconds) for each F4F file. Each
segment can contain one or more fragments. Use 0 to create a single F4F file for each
layer.
3.2.1.5 Audio
Audio Language Descriptors
The drop-down menu allows you to insert or replace the language descriptor (according
to ISO639, part 2) for each of the input streams for the output package.
Audio Types
The drop-down menu allows you to insert or replace the audio type (according to 13818-
1, section 2.6.19) for each of the input streams for the output package.
1. In the WFS Manager GUI, navigate to Tools > Package Preset Editor.
❑ %Language%
Index File Base Name
Specify the file name of the index file for each variant stream. The following special
patterns are supported:
❑ %CommonSourceName%
❑ %SourceFileName%
❑ %Index%
❑ %PID%
❑ %Bitrate%
%Language%
Segment File Base Name
The file name prefix of the media segment files. The following special patterns are
supported:
❑ %CommonSourceName%
❑ %SourceFileName%
❑ %Index%
❑ %PID%
❑ %Bitrate%
❑ %Language%
Create Directory For Each Segment
Create a sub-directory for each segment output files under the entire asset directory by
using Index File Base Name or Segment Directory Base Name.
3.2.2.4 General
Segment Length
The max. length for TS Segments (expressed in seconds).
Order of URL In Variant Playlist
Select from the drop-down menu to specify how the playlist URLs are arranged in the
variant playlist.
Enable CODECS Attribute In Variant Playlist
Select this check box to specify the CODECS attribute in EXT-X-STREAM-INF in the
variant playlist.
Enable Data Streams Pass-through
Select this check box to allow pre-encrypted private streams (e.g. DVB Subtitle, Teletext,
SCTE-35, AC3) pass-through to HLS package output.
Multiple Packages Per Audio
If selected, WFS allows multiple packages for each audio found in the source file (HLS
v2).
Create an Audio Only Variant Stream
If this check box is enabled, audio-only streams will be created and added to the playlist
to provide a low-bandwidth alternate stream which are used to conform with the Apple
requirements. These requirements apply to iOS apps submitted for distribution in the App
Store for use on Apple products. Uncheck the check box only if the downstream vendor
doesn’t support audio-only streams.
Use separate streams for video and audio
If this check box is enabled, audio and video streams are delivered separately. (This
option is available only when HLS Version 4 and HLS Version 5 are selected.)
Use Byte Range Media Segments
If this check box is enabled, the Byte Range tags (i.e. #EXT-X-BYTERANGE) are used in
the playlist to consolidate media segments into larger files, which can reduce the number
of files to be managed. (This option is available only when HLS Version 5 is selected.)
3.2.2.7 Audio
Audio Language Descriptors
The drop-down menu allows users to insert or replace the language descriptor
(according to ISO639, part 2) for each of the input streams for the output package.
Audio Types
The drop-down menu allows users to insert or replace the audio type (according to
13818-1, section 2.6.19) for each of the input streams for the output package.
3.2.2.10 Encryption
Encryption Type
Select either Harmonic Key Management Server/Internal Key Generation/Adobe Flash
Access from the drop-down menu.
If Internal Key Generation is enabled, the Packager generates keys internally for
encryption.
If Adobe Flash Access is enabled, the generated HLS output is encrypted and protected
using Adobe Flash Access.
Resource ID Generate Mode
This is the identifier used to identify the resource. Select the mode to generate the
resource ID for KMS operation. The Resource ID can be generated automatically or
based on the Output File Name.
Encryption Method for HLS
Select the following encryption methods for HLS publishing:
❑ Native
If Native is selected, WFS encrypts the content using native way defined by Apple as
the original encryption method.
❑ Native (Sample Based Encryption)
If Native is selected, WFS encrypts the content using Sample Based Encryption
method which is compliance with HTTP Live Streaming spec defined by Apple.
❑ AuthenTec PlayReady
If AuthenTec PlayReady is selected, WFS encrypts the content according to
AuthenTec's proposal for HLS encryption.
❑ Discretix PlayReady
If Discretix PlayReady is selected, WFS encrypts the content according to Discretix's
proposal for HLS encryption.
❑ Irdeto PlayReady
If Irdeto PlayReady is selected, WFS encrypts the content according to Irdeto's
proposal for HLS encryption.
Enable Key Rotation
Select this check box to enable key rotation for retrieving a new encryption key.
Key Rotation Period (sec)
This is the period of time the system will wait until it retrieves a new encryption key. A
value of 0 means that only one key is used.
Content ID Generate Mode
This is the content identifier used to identify the service. The license server can use this
identifier to decide which license should be granted to clients. The Content ID can be
generated automatically or based on the Output File Name.
1. In the WFS Manager GUI, navigate to Tools > Package Preset Editor.
❑ %PID%
❑ %BitRate%
❑ %Language%
Text Stream Base Name
The Text Stream Base Name allows users to define the base filename for ISMA files. The
following special patterns are supported:
❑ %CommonSourceName%
❑ %SourceFileName%
❑ %PID%
❑ %Language%
3.2.3.4 General
Video Chunk Length [second]
The duration of the video chunk files (expressed in seconds).
Audio Chunk Length [second]
The duration of the audio chunk files (expressed in seconds).
A unique ID or name to identify the machine that found the SCTE-35 signal.
3.2.3.6 Audio
Audio Language Descriptors
The drop-down menu allows users to insert or replace the language descriptor
(according to ISO639, part 2) for each of the input streams for the output package.
Audio Types
The drop-down menu allows users to insert or replace the audio type (according to
13818-1, section 2.6.19) for each of the input streams for the output package.
3.2.3.9 Encryption
Resource ID Generate Mode
This is the identifier used to identify the resource. Select the mode to generate the
resource ID for KMS operation. The Resource ID can be generated automatically or
based on the Output File Name.
CAUTION: Workflow templates must be created and pre-configured for Watch Folders and File Queuer
in order to process the input and output media files.
4. Specify the parameters on the Tasks panel that includes three main stages:
❑ Pre-Transform Tasks
❑ Transform Tasks
❑ Job End Tasks
Parameter Description
Node Assignment
Parameter Description
Node Assignment
Parameter Description
Web URL
Web Service URL The URL of the web service to be called.
HTTP Request
URL/Message Arguments
Node Assignment
Parameter Description
Parameter Description
Remote Connection
Options
Delete Output File Select this option to delete the local source files after
after Transfer successful transfer.
Node Assignments
■ FTP
Parameter Description
Server Connection
Select this check box to specify any port other than the default
FTP Port Specified for the FTP server. The default port is 21. Specify the port
number in the text box.
Parameter Description
The folder on the FTP server where the target files will be
Selected Folder
transferred.
Options
Delete Output File Select this option to delete the local source files after
after Transfer successful transfer.
Node Assignment
Parameter Description
Remote Connection
Parameter Description
Options
Delete Source File Select this option to delete the source files after successful
after Transfer transfer.
Node Assignments
■ FTP
Parameter Description
Server Connection
Select this check box to specify any port other than the default
FTP Port Specified for the FTP server. The default port is 21. Specify the port
number in the text box.
Parameter Description
The folder on the FTP server where the target files will be
Selected Folder
transferred.
Options
Delete Source File Select this option to delete the source files after successful
after Transfer transfer.
Node Assignment
4.2.6 Report
A Report task can be used to generate the detailed XML report of job and its tasks
information.
Parameter Description
The output location for the report XML file. Click Browse to
Output Path
select a path.
If a file with the same name already exists at the Output Path,
the following options are available:
If File Exists ■ Overwrite Existing
■ Create New File
Parameter Description
Node Assignment
4.2.7 Package
The Package task can be used to package the "Transport Stream Input Files" on the
successful stage of a task.
Preset
This specifies the Xpress Preset used for transcoding. Click Browse to select the preset.
Output Path
This specifies the output path location path for delivering the transcoded outputs. Click
Browse to select the location.
TaskParams Mapping ID
Mapping ID is an optional field that ties Xpress parameters from the TemplateEx XML file
to a specific Xpress task in the workflow. It is a string value that can be set by the user in
the workflow and TemplateEx XML file for mapping purpose. If no Mapping ID is present,
all Xpress parameters from TemplateEx XML file are passed to all Xpress tasks in the
workflow.
Mapping ID is useful in scenarios where there are more than one Xpress tasks in the
workflow and custom Xpress parameters like output path, preset parameters need to be
passed to each task through TemplateEx XML file.
Enable
Select this check box to enable the Node Assignment.
Machine Group
Select the Machine Groups to which you want to assign the tasks, if Node Assignment is
enabled.
5. Click Apply after configuration, if desired.
■ Command Line Process (Refer to 4.2.2 Command Line Process for details)
Preset
This specifies the Package Preset used for packaging Transport Stream Input Files" into
one of HLS, Smooth Streaming, or HDS format. Click Browse to select the preset.
Output Path
This specifies the output path location path for delivering the packaged outputs. Click
Browse to select the location.
Enable Encryption
If Enable Encryption is selected, the Encryption Settings area appears for encryption
configuration.
Select Server Definition
This is the KMS and AdobeAccess server selection drop down list which lists the
appropriate KMS and AdobeAccess from the configured registry depending on the
Source Type.
Output Resource/Content ID XML
This is an optional setting to enable the output of Resource/Content ID XML. This file
contains metadata about the encryption task including the Resource/Content ID used
and the main pre and post encryption file references.
Use Same Output Path as Encryption Target
Specifies whether to use the same output path for Resource/Content ID XML file as the
encryption target path.
Output Path
This specifies the output path location for the Resource/Content ID XML file if different
■ Command Line Process (Refer to 4.2.2 Command Line Process for details)
■ Output File Transfer (Refer to 4.2.4 Output File Transfer for details)
■ Command Line Process (Refer to 4.2.2 Command Line Process for details)
4.5.2 On Failure
Select the On Failure stage to add tasks that need to be performed if at least there is one
failed task from the previous stages.
To configure a Job End Task, proceed with the following steps:
1. In the WFS Manager GUI, navigate to Tools > Workflow Editor.
2. Navigate to Job End Tasks as follows.
3. Right-click on the On Failure entry.
4. The tasks available to be performed are:
❑ Email Notification (Refer to 4.2.1 Email Notification for details)
❑ Command Line Process (Refer to 4.2.2 Command Line Process for details)
❑ Web Notification (Refer to 4.2.3 Web Notification for details)
❑ Source File Transfer (Refer to 4.2.5 Source File Transfer for details)
❑ Report (Refer to 4.2.6 Report for details)
5. Click Apply after configuration, if desired.
www.harmonicinc.com
© Copyright 2013 Harmonic Inc. All rights reserved.