1080 codec-specific encoder params (#1082)

* implemented codec-specific encoder params
* updated docs

Author: bwsw

benchmarks/benchmark.py

@@ -17,8 +17,8 @@
     draw_rect,
     nvds_to_gpu_mat,
 )
-from savant.deepstream.utils.surface import get_nvds_buf_surface
 from savant.deepstream.utils.iterator import nvds_frame_meta_iterator
+from savant.deepstream.utils.surface import get_nvds_buf_surface
 
 sys.path.append('../../')
 

docs/source/gh_script.py

@@ -2,15 +2,15 @@
 """Downloads and unpacks documentation for all published releases.
 Usage: gh_script.py GH_OWNER/GH_REPO GH_TOKEN DST_PATH
 """
-import sys
-from urllib.error import HTTPError
-from urllib.request import Request, urlopen
-from pathlib import Path
 import json
 import shutil
+import sys
 import tarfile
-import jinja2
+from pathlib import Path
+from urllib.error import HTTPError
+from urllib.request import Request, urlopen
 
+import jinja2
 
 ASSET_NAME = 'docs.tar'
 

docs/source/savant_101/12_video_processing.rst

@@ -255,7 +255,7 @@ You can choose hardware or software encoder by setting ``encoder`` parameter to
 
 When ``encoder`` parameter is specified and the framework doesn't find a suitable encoder, it will end with an error. When ``encoder`` parameter is omitted, the framework will try to use hardware encoder. When it fails, it will fall back to software encoder.
 
-Every codec has its own configuration parameters related to a corresponding GStreamer plugin. Those parameters are defined in ``output_frame.encoder_params``:
+Every codec has its own configuration parameters related to a corresponding GStreamer plugin. Those parameters are defined in ``output_frame.encoder_params`` or ``output_frame.{codec_name}_encoder_params`` if the pipeline can be launched with various codecs:
 
 .. code-block:: yaml
 
@@ -267,10 +267,32 @@ Every codec has its own configuration parameters related to a corresponding GStr
           iframeinterval: 10
           profile: High
 
+or
+
+.. code-block:: yaml
+
+    parameters:
+      output_frame:
+        codec: ${oc.env:CODEC, 'h264'}
+        h264_encoder_params:
+          profile: Baseline
+          bitrate: 8000000
+        hevc_encoder_params:
+          profile: Main
+          bitrate: 8000000
+        jpeg_encoder_params:
+          quality: 99
+
+
+.. tip::
+
+    The pipeline first tries to apply ``output_frame.{codec_name}_encoder_params`` and later ``output_frame.encoder_params`` if the specific configuration is absent.
+
 
 .. tip::
     Find out more on the `software H264 encoder <https://blog.savant-ai.io/savant-explained-software-video-encoder-543ed147f9f?source=friends_link&sk=155e038056bbbca6d43793297e4afdda>`_ on Medium.
 
+
 Encoder Properties
 ------------------
 

samples/license_plate_recognition/module.yml

@@ -3,8 +3,14 @@ name: license_plate_recognition
 parameters:
   output_frame:
     codec: ${oc.env:CODEC, 'h264'}
-    encoder_params:
+    h264_encoder_params:
+      profile: Baseline
       bitrate: 8000000
+    hevc_encoder_params:
+      profile: Main
+      bitrate: 8000000
+    jpeg_encoder_params:
+      quality: 99
   frame:
     width: ${oc.decode:${oc.env:FRAME_WIDTH, 1920}}
     height: ${oc.decode:${oc.env:FRAME_HEIGHT, 1080}}

samples/uridecodebin/src/egress_frame_filter.py

@@ -1,10 +1,12 @@
-from savant.base.frame_filter import BaseFrameFilter
 from savant_rs.primitives import VideoFrame
 
+from savant.base.frame_filter import BaseFrameFilter
+
+
 class EgressFilter(BaseFrameFilter):
     """Default ingress filter, filters out frames with no video data."""
 
-    def __init__(self, source_id: str,*args, **kwargs):
+    def __init__(self, source_id: str, *args, **kwargs):
         super().__init__(*args, **kwargs)
         self.logger.info(f'Egress filter initialized for source {source_id}')
         self.source_id = source_id

savant/deepstream/encoding.py

@@ -52,6 +52,13 @@ def check_encoder_is_available(
         parser_props = {'config-interval': -1}
     else:
         parser_props = {}
+
+    # check if {codec}_encoder_params are available
+    encoder_params_key_name = f'{codec.value.name.lower()}_encoder_params'
+    encoder_params = codec_params.get(encoder_params_key_name, {})
+    if not encoder_params:
+        encoder_params = codec_params.get('encoder_params', {})
+
     elements = [
         PipelineElement(
             'videotestsrc',
@@ -64,7 +71,7 @@ def check_encoder_is_available(
         PipelineElement('nvvideoconvert'),
         PipelineElement(
             encoder,
-            properties=codec_params.get('encoder_params', {}),
+            properties=encoder_params,
         ),
         PipelineElement(
             codec.value.parser,

savant/deepstream/source_output.py

@@ -421,7 +421,14 @@ def __init__(
         )
         self._output_frame = output_frame
         self._encoder = self._codec.encoder(output_frame.get('encoder'))
-        self._params = output_frame.get('encoder_params') or {}
+
+        # check if {codec}_encoder_params are available
+        encoder_params_key_name = f'{self._codec.name.lower()}_encoder_params'
+        encoder_params = output_frame.get(encoder_params_key_name, {})
+        if not encoder_params:
+            encoder_params = output_frame.get('encoder_params', {})
+
+        self._params = encoder_params
 
     @property
     def encoder(self) -> str: