Command line tools

This section lists and describes command line tools which are included in the OpenVIP distribution.

In case you have installed OpenVIP Windows binary package you can run the tools from the installation directory.

If you have compiled OpenVIP from source files you will find the tools in the bin directory after compilation.

cli (command line interpreter)

The command line interpreter is used to process an OpenVIP network XML file. See the text about networks for more information.

You can obtain a detailed report about network processing by setting the enviroment variable OPENVIP_TRACE_SCHEDULER to 1. This can be useful for debugging purposes.

fileinfo

The Python script fileinfo.py displays information about a given multimedia file. You can use it to check whether OpenVIP is able to decode that file.

Example 3.1. fileinfo - example of use

c:\openvip\bin>python fileinfo.py input.mpg
Multimedia file: input.mpg
    video stream "video0"
        width:        256
        height:       192
        fps:          24.000000
        aspect ratio: 1.333333
        length:       911 frames (38.0 sec)
    audio stream "audio0"
        sample rate:  44100 Hz
        channels:     1
        length:       1677312 samples (38.0 sec)

list_plugins

The Python script list_plugins.py displays a list of all available plugins, i.e. video and audio filters, video and audio transitions, input and output plugins. It shows plugin names as well as their identificators which you use in OpenVIP network files.

thumbnail

The Python script thumbnail.py creates a bitmap file with thumbnails of the given multimedia file. The syntax is

python thumbnail.py <input_file> <output_file> <bitmap_height> <frames count>

For example, the command

c:\openvip\bin>python thumbnail.py input.avi thumb.png 50 10

extracts 10 thumbnail images from input.avi, pastes them together and saves the bitmap as thumb.png. Each thumbnail will be 50 pixels high (width is computed to preserve the original width to height ratio). The script creates thumbnails for video as well as for audio tracks.

This script requires the Python Imaging Library (PIL) to be installed.

timeline2network

The Python script timeline2network.py is used to convert a timeline XML file to an OpenVIP network XML file. See the text about timeline format for more information.

visualize

The Python script visualize.py is helpful in visualizing OpenVIP networks. It creates a file which can be processed by the dot program from the Graphviz package to get a bitmap depicting the network (have a look at the text about networks to see an example). The syntax is

python visualize.py [--brief|--very-brief] <network_file> <dot_file>

For example, the command

c:\openvip\bin\python visualize.py input.openvip output.dot

takes a XML network description stored in input.openvip and creates the file output.dot which you can pass to the dot program.

Use the --brief and --very-brief switches to omit some information such as module identificators or connector names.