11.. _pub_edgeai_configuration :
22
3- ========================
3+ ########################
44Configuring applications
5- ========================
5+ ########################
66
77The demo config file uses YAML format to define input sources, models, outputs
88and finally the flows which defines how everything is connected. Config files
@@ -19,8 +19,9 @@ Config file is divided in 4 sections:
1919#. Outputs
2020#. Flows
2121
22+ ******
2223Inputs
23- ======
24+ ******
2425
2526The input section defines a list of supported inputs like camera, video files etc.
2627Their properties like shown below.
@@ -55,7 +56,7 @@ Below are the details of most commonly used inputs.
5556.. _pub_edgeai_camera_sources :
5657
5758Camera sources (v4l2)
58- ---------------------
59+ =====================
5960
6061**v4l2src ** GStreamer element is used to capture frames from camera sources
6162which are exposed as v4l2 devices. In Linux, there are many devices which are
@@ -80,8 +81,8 @@ and prints the detail like below in the console:
8081 script can also be run manually later to get the camera details.
8182
8283From the above log we can determine that 1 USB camera is connected
83- (:file: `/dev/video-usb-cam0 `), and 1 CSI camera is connected (:file: `/dev/video-imx219-cam0 `) which is IMX219 raw
84- sensor and needs ISP.
84+ (:file: `/dev/video-usb-cam0 `), and 1 CSI camera is connected (:file: `/dev/video-imx219-cam0 `),
85+ which is IMX219 raw sensor and needs ISP.
8586
8687Using this method, you can configure correct device for camera capture in the
8788input section of config file.
@@ -109,10 +110,10 @@ camera to allow GStreamer to negotiate the format. ``rggb`` for sensor
109110that needs ISP.
110111
111112Video sources
112- -------------
113+ =============
113114
114115H.264 and H.265 encoded videos can be provided as input sources to the demos.
115- Sample video files are provided under :file: `/opt/edgeai-test-data/videos/ `
116+ The :file: `/opt/edgeai-test-data/videos/ ` directory contains sample video files.
116117
117118.. code-block :: yaml
118119
@@ -135,12 +136,11 @@ By default the format is set to ``auto`` which will then use the GStreamer
135136bin ``decodebin `` instead.
136137
137138Image sources
138- -------------
139+ =============
139140
140- JPEG compressed images can be provided as inputs to the demos. A sample set of
141- images are provided under :file: `/opt/edgeai-test-data/images `. The names of the
142- files are numbered sequentially and incrementally and the demo plays the files
143- at the fps specified by the user.
141+ JPEG compressed images can be provided as inputs to the demos. The :file: `/opt/edgeai-test-data/images `
142+ directory contains sample images. The names of the files are numbered sequentially and incrementally
143+ and the demo plays the files at the fps specified by the user.
144144
145145.. code-block :: yaml
146146
@@ -152,7 +152,7 @@ at the fps specified by the user.
152152 framerate : 1
153153
154154 RTSP sources
155- ------------
155+ ============
156156
157157H.264 encoded video streams either coming from a RTSP compliant IP camera or
158158via RTSP server running on a remote PC can be provided as inputs to the demo.
@@ -165,8 +165,9 @@ via RTSP server running on a remote PC can be provided as inputs to the demo.
165165 height : 720
166166 framerate : 30
167167
168+ ******
168169Models
169- ======
170+ ******
170171
171172The model section defines a list of models that are used in the demo. Path to
172173the model directory is a required argument for each model and rest are optional
@@ -200,9 +201,9 @@ Below are some of the use case specific properties:
200201The content of the model directory and its structure is discussed in detail in
201202:ref: `pub_edgeai_import_custom_models `
202203
203-
204+ *******
204205Outputs
205- =======
206+ *******
206207
207208The output section defines a list of supported outputs.
208209
@@ -239,7 +240,7 @@ All supported outputs are listed in template config file.
239240Below are the details of most commonly used outputs
240241
241242Display sink (kmssink)
242- ----------------------
243+ ======================
243244
244245When you have only one display connected to the SK, kmssink will try to use
245246it for displaying the output buffers. In case you have connected multiple
@@ -261,7 +262,7 @@ Following command finds out the connected displays available to use.
261262 Configure the required connector ID in the output section of the config file.
262263
263264Video sinks
264- -----------
265+ ===========
265266The post-processed outputs can be encoded in H.264 format and stored on disk.
266267Please specify the location of the video file in the configuration file.
267268
@@ -273,7 +274,7 @@ Please specify the location of the video file in the configuration file.
273274 height : 1080
274275
275276 Image sinks
276- -----------
277+ ===========
277278The post-processed outputs can be stored as JPEG compressed images.
278279Please specify the location of the image files in the configuration file.
279280The images will be named sequentially and incrementally as shown.
@@ -286,7 +287,7 @@ The images will be named sequentially and incrementally as shown.
286287 height : 1080
287288
288289 Remote sinks
289- ------------
290+ ============
290291Post-processed frames can be encoded as jpeg or h264 frames and send as udp packets
291292to a port. Please specify the sink as remote in the configuration file. The udp port and
292293host to send packets to can be defined. If not, default port is 8081 and host
@@ -310,9 +311,9 @@ on localhost (127.0.0.1) and can be used to view the frames remotely.
310311
311312 /opt/edgeai-gst-apps# node scripts/remote_streaming/server.js
312313
313-
314+ *****
314315Flows
315- =====
316+ *****
316317
317318The flows section defines how inputs, models and outputs are connected.
318319Multiple flows can be defined to achieve multi input, multi inference as shown
@@ -338,7 +339,6 @@ for optimization. Along with input, models and outputs it is required to define
338339plane. This is needed because multiple inference outputs can be rendered to same
339340output (Ex: Display).
340341
341-
342342GStreamer plugins
343343=================
344344
0 commit comments