Getting Started

• Download the Video Effects Microservice Reference Client in the following way:

  1. Select CLI Command to copy the download command.

  2. Ensure you have installed the NGC CLI tool.

  3. After you install the tool, to start the download, paste the copied command in a Command Prompt window.

Prerequisites

Ensure the following prerequisites are available:

• This client uses bazel for build. Please ensure you install bazel before building the client. Instructions for installing bazel can be found here. Note: This code build is validated with bazel version 4.2.2. Please use sudo apt-get update && sudo apt-get install bazel=4.2.2 at step:3 of this section.

• Deployed microservice must be accessible to client host system.

• The video input for Video Effects Microservice need to be in v4l2 .h264 stream format.

About Video Effects Microservice Reference Client

• This is sample client for Video Effects Microservice. src/video_effects_sample_client.cpp contains the code for this reference application. It provides below features:

  • Accepts v4l2 .h264 video input stream.

    • command to convert .mp4 video to .h264:

    gst-launch-1.0 filesrc location=video_effects_sample_input_video.mp4 ! decodebin ! nvvideoconvert ! nvv4l2h264enc profile=Main ! h264parse config-interval=-1 ! filesink location=video_effects_sample_input_video.h264
    

    • Deepstream container can be used to run above gst-launch-1.0 commands.

  • Invokes Video Effects Microservice gRPC bi-directional RPC to run video effects inference. It sends configuration packet over gRPC channel and uses same gRPC channel for data streaming. Please set video effects config parameters in SendVideoEffectsConfig function here: src/video_effects_sample_client.cpp

  • Stores processed output as .h264 video stream. You can use VLC/ffplay media player to check impact of video effects feature.

Build and launch sample client

Build:

On downloading the resource, a directory is created containing the components of the resource. cd into this directory and then build the client as follows

    bazel build src:video_effects_sample_client

Launch:

    ./bazel-bin/src/video_effects_sample_client \
    --video_effects_service_uri="127.0.0.1:50061" \
    --input_video_file=samples/video_effects_sample_input_video.h264 \
    --output_video_file=video_effects_out.h264

parameters:

• --video_effects_service_uri: URI of deployed Video Effects Microservice.
• --input_video_file: Input v4l2 h264 video stream. follow instructions given here to convert .mp4 to .h264 stream (file)
• --enable_composite: If set to true Background replacement effect is enabled, If set to false Background Blur effect is enabled (defult=false)
• --input_background_file: Input H264 Background image used for Background replacement (applicable only if enable_composite=true)
• --output_video_file: The .h264 file where output video stream to be stored. You can use VLC/ffplay media player to play this file.

Suggested Reading

Please refer Video Effects User Guide (Under Resources) for a more detailed documentation.

License

By pulling and using Video Effects software, you accept the terms and conditions of the corresponding license.