Skip to content

Commit 4981dc4

Browse files
authored
Update README.md
Add RTSP Server info
1 parent a7c43da commit 4981dc4

File tree

1 file changed

+38
-7
lines changed

1 file changed

+38
-7
lines changed

README.md

Lines changed: 38 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,8 @@
99
<a href="#build">Build</a> •
1010
<a href="#plugins-parameters">Plugins parameters</a> •
1111
<a href="#metadata">Metadata</a> •
12-
<a href="#example-pipelines">Example pipelines</a> •
12+
<a href="#pipeline-examples">Example pipelines</a> •
13+
<a href="#pipeline-examples">RTSP Server</a> •
1314
<a href="#related">Related</a> •
1415
<a href="#license">License</a>
1516
</p>
@@ -18,13 +19,14 @@
1819
# Key Features
1920
GStreamer plugin package for ZED Cameras. The package is composed of several plugins:
2021

21-
* `zedsrc`: acquires camera color image and depth map and pushes them in a GStreamer pipeline.
22-
* `zedmeta`: GStreamer library to define and handle the ZED metadata (Positional Tracking data, Sensors data, Detected Object data, Detected Skeletons data).
23-
* `zeddemux`: receives a composite `zedsrc` stream (`color left + color right` data or `color left + depth map` + metadata),
22+
* [`zedsrc`](./gst-zed-src): acquires camera color image and depth map and pushes them in a GStreamer pipeline.
23+
* [`zedmeta`](./gst-zed-meta): GStreamer library to define and handle the ZED metadata (Positional Tracking data, Sensors data, Detected Object data, Detected Skeletons data).
24+
* [`zeddemux`](./gst-zed-demux): receives a composite `zedsrc` stream (`color left + color right` data or `color left + depth map` + metadata),
2425
processes the eventual depth data and pushes them in two separated new streams named `src_left` and `src_aux`. A third source pad is created for metadata to be externally processed.
25-
* `zeddatamux`: receive a video stream compatible with ZED caps and a ZED Data Stream generated by the `zeddemux` and adds metadata to the video stream. This is useful if metadata are removed by a filter that does not automatically propagate metadata
26-
* `zeddatacsvsink`: example sink plugin that receives ZED metadata, extracts the Positional Tracking and the Sensors Data and save them in a CSV file.
27-
* `zedodoverlay`: example transform filter plugin that receives ZED combined stream with metadata, extracts Object Detection information and draws the overlays on the oncoming filter
26+
* [`zeddatamux`](./gst-zed-data-mux): receive a video stream compatible with ZED caps and a ZED Data Stream generated by the `zeddemux` and adds metadata to the video stream. This is useful if metadata are removed by a filter that does not automatically propagate metadata
27+
* [`zeddatacsvsink`](./gst-zed-data-csv-sink): example sink plugin that receives ZED metadata, extracts the Positional Tracking and the Sensors Data and save them in a CSV file.
28+
* [`zedodoverlay`](./gst-zed-od-overlay): example transform filter plugin that receives ZED combined stream with metadata, extracts Object Detection information and draws the overlays on the oncoming filter
29+
* [`RTSP Server`](./gst-zed-rtsp-server): application for Linux that instantiates an RTSP server from a text launch pipeline "gst-launch" like.
2830

2931
## Build
3032

@@ -295,6 +297,35 @@ More details about the sub-structures are available in the [`gstzedmeta.h` file]
295297
autovideoconvert ! fpsdisplaysink
296298
```
297299
300+
## RTSP Server
301+
302+
*Available only for Linux*
303+
304+
An application to start an RTSP server from a text pipeline (using the same sintax of the CLI command [`gst-launch-1.0`](https://gstreamer.freedesktop.org/documentation/tools/gst-launch.html)) is provided.
305+
306+
Usage:
307+
308+
```
309+
gst-zed-rtsp-launch [OPTION?] PIPELINE-DESCRIPTION
310+
```
311+
312+
Help Options:
313+
* `-h`, `--help` -> Show help options.
314+
* `--help-all` -> Show all help options.
315+
* `--help-gst` -> Show GStreamer Options.
316+
317+
Application Options:
318+
* `-p`, `--port=PORT` -> Port to listen on (default: 8554).
319+
* `-a`, `--address=HOST` -> Host address (default: 127.0.0.1).
320+
321+
Example:
322+
323+
```
324+
gst-zed-rtsp-server zedsrc ! videoconvert ! 'video/x-raw, format=(string)I420' ! x264enc ! rtph264pay pt=96 name=pay0
325+
```
326+
327+
It is mandatory to define at least one payload named `pay0`; it is possible to define multiple payloads using an increasing index (i.e. `pay1`, `pay2`, ...).
328+
298329
## Ready-To-Use scripts
299330
300331
Ready to use scripts are available in the scripts/ folder for windows and linux.

0 commit comments

Comments
 (0)