Skip to content

Launching FaceStream#

FaceStream Modes#

You can run FaceStream on OS Linux in normal or server mode. The examples of launching are given in "Launching on Linux Example" and "Launching on Windows Example" sections.

Use the "FaceStream" file to launch FaceStream in the server mode. You can only run FaceStream on OS Windows in normal mode. Use the "FaceStreamStatic" file to launch FaceStream in this mode.

You can create new configuration files based on the existing configuration files (fs3Config.conf, input.json) and specify them when launching FaceStream (in the Src and Cp keys). This enables you to create several configuration files for different purposes without changing default files.

Never use configuration files from other FaceStream versions! FaceStream will not start, or the processing results will differ from the expected.

Launching on Linux Example#

Normal mode#

To start FaceStream on Linux CentOS in normal mode, go to the directory with the executable file and run it:

cd ./bin

./FaceStreamStatic --source-path "./data/input.json"

When running in normal mode, you should specify -Src (--source-path) key with a path to the "input.json" file, where video-stream sources are specified.*

Detailed information about video-stream sources configuration is given in "Video-Stream Sources" section.

Server mode#

To start FaceStream on Linux CentOS in server mode, go to the directory with the executable file.

  • Launch using address and port on which FaceStream will listen requests.
cd ./bin

./FaceStream --http-address "http://<FS_server_IP>:34569"

You should specify the address that FaceStream will listen using -A (--http_address). Server mode allows to send data about video-stream sources to FaceStream using API.

<FS_server_IP> - you should specify FaceStream server external IP.

More details about FaceStream server mode and description of cameras management for developers can be found in "./docs/FaceStreamApi.html document".

Launch FaceStream with GPU#

You can launch FaceStream and utilize GPU for processing. You can specify one video card only so you need to set the number of the video card used.

  • Check that your device has an available video card and its architecture meets the requirements.
  • Check that you have CUDA 10.1 installed.

  • Set the "enable-gpu-processing" parameter to "true".

  • Go to the directory with the executable file:

cd ./bin
  • Specify the used video card number in the CUDA_VISIBLE_DEVICES parameter before the FaceStream launch command.

Launching in normal mode

CUDA_VISIBLE_DEVICES=0 ./FaceStreamStatic --source-path "./data/input.json"

​ Launching in server mode

CUDA_VISIBLE_DEVICES=0 ./FaceStream --http-address "http://127.0.0.1:34569"

​ Launching using Configurator

CUDA_VISIBLE_DEVICES=0 ./FaceStream --http-address "http://127.0.0.1:34569" --configurator-address "http://127.0.0.1:5070"

Launching on Windows Example#

To start FaceStream in normal mode on Windows, go to the directory with the executable file and run it:

cd ./bin

FaceStreamStatic.exe --source-path "./data/input.json"

Launching Keys#

To get help on working with FaceStream launching keys, run the executable file with "help" key.

cd ./bin

./FaceStreamStatic --help

The following keys are available:

  • --source-path (-Src) – the path to the configuration file of

    video-stream sources. When using RabbitMQ, you should specify the path to "web_tasks.conf" file.

Otherwise, specify the path to "input.json" file here.

  • --data-dir(-Dd) – a path to the directory with detectors and settings data. It is set as "./data" by default (relative to the directory with the application);
  • --config-path(-Cp) – a full path to the configuration file of the application fs3Config.cfg. It is set as "\<config-path>/fs3Config". If this parameter is defined, the path to data is ignored when searching for the configuration file.
  • --log-dir(-Ld) – directory to record logging files. It is set as "./log" by default (relative to the data directory).

Launching keys for server mode only#

Use the following commands to show all the launch keys for the server mode. 

cd ./bin

./FaceStream --help

  • --http_address(-A) - http address to listen by FaceStream. Its format is \<address:port> (required only when FaceStream is in http server mode). The user will send requests to this address.

    You should specify FaceStream server external IP.

    For Linux, default address is set to "http://0.0.0.0:34569".

Back to top