ID: 5719

Vantage Media Converter

With Zoom 5.8 and above, Vantage can be used to generate previews of video files using Zoom media converter.

What you need to start:

  1. Working Zoom and Preview Server.
  2. Running Vantage Node.
  3. Zoom should be installed on the machine where vantage scripts needs to be executed.
  4. A shared location between Vantage node and Preview server.
    1. This shared location has to have preview server cache on it
    2. If Zoom indexer is used to ingest the assets, then this shared location must have original assets for each proxy asset in Zoom.
  5. Vantage converters are written Perl language. So, system must have perl installed.
  6. Install all dependent Perl modules from here: Zoom Perl SDK Setup.
  7. Get the Zoom vantage converter module from Zoom Support Team.

 

Process Overview 

Vantage Converter Flow

 Getting Started

  1. Check if Perl is installed or not.
    1. On Linux console/terminal type command: perl –version. To see if perl is installed and of version 5.XX. We recommended using Perl version 5 or higher.
  2. Install/Copy Vantage module in the home directory of Zoom/Evolphin user.
    1. We recommend using username “evolphin” with home directory in “/home/evolphin”
    2. Copy the vantage scripts in /home/evolphin/zoom-deploy
  3. Directory structure of vantage converter module:
    1. /home/evolphin/zoom-deploy
      1. vanConvert
        1. conf
          1. config.ini <= Configuration file for Vantage converter
          2. log4perl.conf <= Configure vantage converter logging.
        2. lib
          1. Contains perl modules (dot pm files).
        3. vanConvert.pl <= Main vantage Perl file.
        4. vanConvert.sh <= Vantage converter launcher.
  4. Create new vantage workflow with some relevant name.
    In this article we would be using vantage workflow name as “zoomproxy” and will be using it in examples and configuration.
    1. Create a new vantage workflow with named “zoomproxy”.
    2. We will pass the input file to this workflow using vantage API.
    3. Previews need to be generated in FLV format from vantage and output has to be stored in a file path passed inside a variable “outFileVar”. This variable is passed from vantage converter in vantage workflow.
  5. Open “config.ini” from vanConverter module. File is present in “~/zoom-deploy/vanConvert/config” directory.
  6. Update the values under section “[ENVIRONMENT]“ and “[ZOOMSERVER]“. These sections are self-explanatory and explained below in vantage config ini section.
  7. Updating “[VANTAGE]“ section. This section can go wrong very easily and a few trial runs might be required to come up be correct values.
    1. Before we proceed, lets assume that, preview server cache is present on a network drive “/media/nas-store” inside directory “zoom-store”. For e.g: Preview cache location = /media/nas-store/zoom-store/preview-cache.
    2. The same nas-store is accessible on vantage machine as “Z:” driveAnd preview cache can be accessed on windows vantage box at path: “Z:\zoom-store\preview-cache”.
    3. Preview server uses this cache location to store the rendered previews and it might checkout the original or proxy asset to generate the previews.
    4. So, the path prefix which vantage converter has to change is: “/media/nas-store”  — to –> “Z:”.  So that, the path passed to vantage is accessible on windows. For e.g: if preview cached files is: “/media/nas-store/zoom-store/preview-cache/0/1/9″, then it will translate to path “Z:\zoom-store\preview-cache\0\1\9″. 
    5. Conversion from linux mount path to windows drive letter or UNC path is governed by properties:  “inPathPrefix” and “outPathMount”.
      1. For our example: inPathPrefix would be “/mnt/nas-store” and “outPathPrefix” would be “Z:\”.
      2. Instead of using drive letter, it is possible to directly use UNC path. For e.g. instead of “Z:” drive, use of UNC path: “\\192.168.0.100″ is permitted.
        Vantage can work with UNC paths, but before using UNC paths, ask your IT/Network admins to allow vantage to read and write on UNC path.
    6. Vantage converter looks for “ZPIG_Proxy” metadata property to detect the proxy asset. If this property is found to be true, vantage converter looks for “ZPIG_Native File Path” property and fetch the native file path of the asset. Each native file path value is prefixed with string “TPM:” aka “Third Party Mount”.
    7. It is possible to construct the original native asset file path from propertyZPIG_Native File Path”  value, by just substituting the “TPM:” prefix with another string/path. This substitution is controlled by the value of properly “inPathSub” under section “[VANTAGE]“.
    8. This gives us a new feature, where previews can be generated directly from original assets, which could be huge in size and residing on some archive location i.e. outside of Zoom. On Zoom server they just proxy small size asset representing the actual original asset.
    9. So, if asset is a proxy asset, its original path can be construction by replacing the prefix “TMP:” with the value mentioned in variable: “inPathSub”.
    10. Variable: “outFileVar” andoutDirVar” denotes the properties under which output file path and out directories are passed to vantage box. Vantage reads these variables to find out where to store the generate preview. Please correlate the values of these two variables present in vantage workflow and in config.ini.
  8. Once config.ini is setup. Go to Zoom webmin portal. Open: http://<zoom-server>:8443 in browser.
  9. To go section: “Media Converter”. And create a new media converter to launch Zoom vantage converter.
    1. In new media converter window provide path to vanConverter.sh file i.e. /home/evolphin/zoom-deploy/vanConvert/vanConvert.sh.
    2. Add new argument of type input file.
    3. Add new argument of type output file.
    4. Add new argument  named: “vwfn <vantage workflow name>”. For e.g. “vwfn zoomproxy”. Here “zoomproxy” is the vantage workflow name where preview generation job has to be submitted.
    5. See this attached screenshot for more details.  
      Vantage Converter
  10.  Save the media converter.
  11. Go to section “Default Format“.
  12. Set new default format/converter for video file formats like MOV, MP4 etc. to “Vantage Converter”, which we created above.
  13. Goto asset browser and try to preview the video files.

 

 

Vantage Config INI Explained

Below we have explained the sample config.ini for Vantage perl script.

[ENVIRONMENT]
#path to the zm command. Point zmPath to correct installed Zoom path.
zmPath = /home/evolphin/zoom/bin/zm

[ZOOMSERVER]

#Point this to Zoom server url.
serverURL = http://<zoom-server>:8880

#Point this to webmin server
webminURL = http://<zoom-server>:8443

#Username which exist on Zoom to run vantage scripts
serverUsername = <username>

#Password of above mentioned Zoom user
serverPassword = <password>

[VANTAGE]
#URL to working vantage box.
vantageServerURL=http://<vantage server>:8676

#Path prefix which has to be changed by outPathMount, so that Vantage can access the file
inPathPrefix=/mnt/data
#Replace above inPathPrefix with this.
outPathMount=X:\
#Key  which will send to vantage which contains the output path
outFileVar=zoomvoutfile
#Output dir where vantage generates the output file.
outDirVar=zoomvoutpath
#If asset on Zoom is proxy asset and contains "ZPIG_Proxy=true", then prefix "TPM:" in native file path is replaced by below given value
inPathSub=/mnt/data/san

#Time to wait before checking job status in seconds 
jobStatusTime = 10