[KBA-00053] Installing and using the Omnicast™ DirectShow Filter - Omnicast™ 4.0 - 4.8

series
Omnicast™ 4.0 - 4.8
revised_modified
2013-11-18

[KBA-00053] Installing and using the Omnicast™ DirectShow Filter

This article explains how to install and use the Omnicast™ DirectShow filter.

Summary

The Omnicast™ DirectShow Filter (DSF) is typically used when sending video to third-party image recognition applications. Using the DSF, you can access the uncompressed video coming from an Omnicast™ server. Uncompressed video is often needed for applications like video analytics.

Video streams will be uncompressed on the local machine where the DSF is installed. The video streams travelling the network between the Omnicast™ server and the DSF machine are compressed (MPEG4, MJPEG, or H.264) to minimize the bandwidth usage.

More Information

The Omnicast™ DSF is part of the Omnicast™ SDK. To display video using the DSF, you must first install the SDK distributable package on the computer that will receive the video.

The SDK package must be the same version as the Omnicast™ server. You must also ensure that your server license supports the Uncompressed Video Filters option. The total number of Uncompressed Video Filters must be equal to the total number of video connections.

To receive the uncompressed video, the following URL must be used with the following parameters:
omnp://username:password@server:port/?cam=X
  • omnp: The Genetec custom protocol that will load the GxSourceFilter COM component when this URL is specified from a DirectShow compatible application.
  • username: Uusername that can be used to connect to Omnicast™. The user must be part of the administrators group in Omnicast™, or the video will not be forwarded.
  • password (Optional): The password normally used with the specified username in Omnicast™. If the password is blank, you can either specify omnp://username:@server or omnp://username@server.
    IMPORTANT: The password should not contain "@".
  • server: The name or IP address of the Omnicast™ Gateway server that is used to establish the connection. The DSF is considered a client station that connects to the Omnicast™ Gateway to receive the video.
  • port (Optional): The port number used to connect to the Omnicast™ Gateway. If not specified, the default port 5001 is used.
  • cam=X: The camera that will be streamed to the filter. The argument 'X' is the logical ID of the camera, which is defined in Config Tool.
The following parameters are optional and can be added using the '&' sign at the end of the URL:
omnp://username:password@server:port/?cam=X&cx=320&cy=240&fps=15&vsu=0
  • seq=X: The camera sequence that will be streamed to the filter. The argument 'X' is the logical ID of the sequence, which is defined in Config Tool.
  • cx=X: The picture width as displayed by the source filter. Default is 320.
  • cy=X: The picture height as displayed by the source filter. Default is 240.
  • di=on/off: The DeInterlacing mode. Set the argument to 'on' if you want to enable the DeInterlacing mode, 'off' otherwise. Default is 'off'.
  • db=on/off: The DeBlocking mode. Set the argument to 'on' if you want to enable the DeBlocking mode, 'off' otherwise. Default is 'off'.
  • yuv=on/off: Set the argument to 'on' if you want to enable YV12,YUY2 and UYVY output formats in the filter. Enabling this option does not resize the stream if the source resolution does not match the filter output resolution, which is controlled by (cx, cy). When this argument is 'off', the filter only supports RG32, RGB24, RGB565, or RGB555, and the stream is resized to always fit the output resolution (cx,cy). Default is 'off'.
  • fps=X: Sets a constant output frame rate independent from the encoder frame rate, which varies based on the video content and bit rate limitations. X must be a number between 1 and 30. Default is '30'.
  • vsu=X: The stream usage for the specified camera. The 'X' argument can take the following values: 0 (live stream), 1 (recording stream), 2 (remote stream), 3 (low resolution stream), 4 (high resolution stream). Default is 0.
To test the DirectShow Filter:
  1. Open Windows Media Player.
  2. From the file menu, select Open URL..., and input the URL with the parameters you specified.
    Example: To view the recording stream of camera number 15 with username admin and password 12345 on server 10.0.19.22, use the following URL:
    omnp://admin:12345@10.0.19.22/?cam=15&vsu=1

    If the URL is specified correctly, the video starts playing.