feat: add TestVector optional decoder parameters

fluster/decoder.py

@@ -18,7 +18,7 @@
 from abc import ABC, abstractmethod
 from functools import lru_cache
 from shutil import which
-from typing import List, Optional, Type
+from typing import Any, Dict, List, Optional, Type
 
 from fluster.codec import Codec, OutputFormat
 from fluster.utils import normalize_binary_cmd
@@ -47,6 +47,7 @@ def decode(
         timeout: int,
         verbose: bool,
         keep_files: bool,
+        optional_params: Optional[Dict[str, Any]] = None,
     ) -> str:
         """Decodes input_filepath in output_filepath"""
         raise Exception("Not implemented")

fluster/decoders/av1_aom.py

@@ -14,6 +14,7 @@
 #
 # You should have received a copy of the GNU Lesser General Public
 # License along with this library. If not, see <https://www.gnu.org/licenses/>.
+from typing import Any, Dict, Optional
 
 from fluster.codec import Codec, OutputFormat
 from fluster.decoder import Decoder, register_decoder
@@ -38,6 +39,7 @@ def decode(
         timeout: int,
         verbose: bool,
         keep_files: bool,
+        optional_params: Optional[Dict[str, Any]] = None,
     ) -> str:
         """Decodes input_filepath in output_filepath"""
         fmt = "--rawvideo"

fluster/decoders/av1_dav1d.py

@@ -14,6 +14,7 @@
 #
 # You should have received a copy of the GNU Lesser General Public
 # License along with this library. If not, see <https://www.gnu.org/licenses/>.
+from typing import Any, Dict, Optional
 
 from fluster.codec import Codec, OutputFormat
 from fluster.decoder import Decoder, register_decoder
@@ -37,6 +38,7 @@ def decode(
         timeout: int,
         verbose: bool,
         keep_files: bool,
+        optional_params: Optional[Dict[str, Any]] = None,
     ) -> str:
         """Decodes input_filepath in output_filepath"""
         fmt = "yuv"

fluster/decoders/chromium.py

@@ -16,6 +16,7 @@
 # License along with this library. If not, see <https://www.gnu.org/licenses/>.
 
 from functools import lru_cache
+from typing import Any, Dict, Optional
 
 from fluster.codec import Codec, OutputFormat
 from fluster.decoder import Decoder, register_decoder
@@ -50,6 +51,7 @@ def decode(
         timeout: int,
         verbose: bool,
         keep_files: bool,
+        optional_params: Optional[Dict[str, Any]] = None,
     ) -> str:
         return str(main(input_filepath))
 

fluster/decoders/cros_codecs.py

@@ -14,6 +14,7 @@
 #
 # You should have received a copy of the GNU Lesser General Public
 # License along with this library. If not, see <https://www.gnu.org/licenses/>.
+from typing import Any, Dict, Optional
 
 from fluster.codec import Codec, OutputFormat
 from fluster.decoder import Decoder, register_decoder
@@ -38,6 +39,7 @@ def decode(
         timeout: int,
         verbose: bool,
         keep_files: bool,
+        optional_params: Optional[Dict[str, Any]] = None,
     ) -> str:
         """Decodes input_filepath in output_filepath"""
 

fluster/decoders/dummy.py

@@ -14,6 +14,7 @@
 #
 # You should have received a copy of the GNU Lesser General Public
 # License along with this library. If not, see <https://www.gnu.org/licenses/>.
+from typing import Any, Dict, Optional
 
 from fluster.codec import Codec, OutputFormat
 from fluster.decoder import Decoder, register_decoder
@@ -36,5 +37,6 @@ def decode(
         timeout: int,
         verbose: bool,
         keep_files: bool,
+        optional_params: Optional[Dict[str, Any]] = None,
     ) -> str:
         return file_checksum(input_filepath)

fluster/decoders/ffmpeg.py

@@ -19,7 +19,7 @@
 import re
 import subprocess
 from functools import lru_cache
-from typing import Dict, Optional, Tuple
+from typing import Any, Dict, Optional, Tuple
 
 from fluster.codec import Codec, OutputFormat
 from fluster.decoder import Decoder, register_decoder
@@ -70,6 +70,7 @@ def decode(
         timeout: int,
         verbose: bool,
         keep_files: bool,
+        optional_params: Optional[Dict[str, Any]] = None,
     ) -> str:
         """Decodes input_filepath in output_filepath"""
         command = [self.binary, "-hide_banner", "-nostdin"]
@@ -99,6 +100,11 @@ def decode(
         elif self.ffmpeg_codec:
             command.extend(["-codec", self.ffmpeg_codec])
 
+        # Optional decoder parameters
+        if optional_params:
+            for key, value in optional_params.items():
+                command.extend([key, str(value)])
+
         # Input file
         command.extend(["-i", input_filepath])
 

fluster/decoders/gstreamer.py

@@ -21,7 +21,7 @@
 import shlex
 import subprocess
 from functools import lru_cache
-from typing import List, Optional
+from typing import Any, Dict, List, Optional
 
 from fluster.codec import Codec, OutputFormat
 from fluster.decoder import Decoder, register_decoder
@@ -109,14 +109,21 @@ def gen_pipeline(
         input_filepath: str,
         output_filepath: Optional[str],
         output_format: OutputFormat,
+        optional_params: Optional[Dict[str, Any]] = None,
     ) -> str:
         """Generate the GStreamer pipeline used to decode the test vector"""
         output = f"location={output_filepath}" if output_filepath else ""
+
+        decoder_params = ""
+        if optional_params:
+            for key, value in optional_params.items():
+                decoder_params += f" {key}={value} "
+
         return PIPELINE_TPL.format(
             self.cmd,
             input_filepath,
             self.parser if self.parser else "parsebin",
-            self.decoder_bin,
+            self.decoder_bin + decoder_params,
             self.caps,
             self.sink,
             output,
@@ -149,6 +156,7 @@ def decode(
         timeout: int,
         verbose: bool,
         keep_files: bool,
+        optional_params: Optional[Dict[str, Any]] = None,
     ) -> str:
         """Decode the test vector and do the checksum"""
         # When using videocodectestsink we can avoid writing files to disk
@@ -162,7 +170,7 @@ def decode(
             data = run_command_with_output(command, timeout=timeout, verbose=verbose).splitlines()
             return self.parse_videocodectestsink_md5sum(data)
 
-        pipeline = self.gen_pipeline(input_filepath, output_filepath, output_format)
+        pipeline = self.gen_pipeline(input_filepath, output_filepath, output_format, optional_params)
         run_command(shlex.split(pipeline), timeout=timeout, verbose=verbose)
         return file_checksum(output_filepath)
 
@@ -193,6 +201,7 @@ def gen_pipeline(
         input_filepath: str,
         output_filepath: Optional[str],
         output_format: OutputFormat,
+        optional_params: Optional[Dict[str, Any]] = None,
     ) -> str:
         raw_caps = "video/x-raw"
         try:
@@ -785,6 +794,7 @@ def gen_pipeline(
         input_filepath: str,
         output_filepath: Optional[str],
         output_format: OutputFormat,
+        optional_params: Optional[Dict[str, Any]] = None,
     ) -> str:
         caps = f"{self.caps} ! videoconvert dither=none ! video/x-raw,format={output_format_to_gst(output_format)}"
         output = f"location={output_filepath}" if output_filepath else ""

fluster/decoders/h264_jct_vt.py

@@ -15,6 +15,7 @@
 #
 # You should have received a copy of the GNU Lesser General Public
 # License along with this library. If not, see <https://www.gnu.org/licenses/>.
+from typing import Any, Dict, Optional
 
 from fluster.codec import Codec, OutputFormat
 from fluster.decoder import Decoder, register_decoder
@@ -38,6 +39,7 @@ def decode(
         timeout: int,
         verbose: bool,
         keep_files: bool,
+        optional_params: Optional[Dict[str, Any]] = None,
     ) -> str:
         """Decodes input_filepath in output_filepath"""
         run_command(

fluster/decoders/h265_jct_vt.py

@@ -15,6 +15,7 @@
 #
 # You should have received a copy of the GNU Lesser General Public
 # License along with this library. If not, see <https://www.gnu.org/licenses/>.
+from typing import Any, Dict, Optional
 
 from fluster.codec import Codec, OutputFormat
 from fluster.decoder import Decoder, register_decoder
@@ -38,6 +39,7 @@ def decode(
         timeout: int,
         verbose: bool,
         keep_files: bool,
+        optional_params: Optional[Dict[str, Any]] = None,
     ) -> str:
         """Decodes input_filepath in output_filepath"""
         run_command(

fluster/decoders/h266_vvc_vtm.py

@@ -14,6 +14,7 @@
 #
 # You should have received a copy of the GNU Lesser General Public
 # License along with this library. If not, see <https://www.gnu.org/licenses/>.
+from typing import Any, Dict, Optional
 
 from fluster.codec import Codec, OutputFormat
 from fluster.decoder import Decoder, register_decoder
@@ -37,6 +38,7 @@ def decode(
         timeout: int,
         verbose: bool,
         keep_files: bool,
+        optional_params: Optional[Dict[str, Any]] = None,
     ) -> str:
         """Decodes input_filepath in output_filepath"""
         # pylint: disable=unused-argument

fluster/decoders/h266_vvdec.py

@@ -14,6 +14,7 @@
 #
 # You should have received a copy of the GNU Lesser General Public
 # License along with this library. If not, see <https://www.gnu.org/licenses/>.
+from typing import Any, Dict, Optional
 
 from fluster.codec import Codec, OutputFormat
 from fluster.decoder import Decoder, register_decoder
@@ -37,6 +38,7 @@ def decode(
         timeout: int,
         verbose: bool,
         keep_files: bool,
+        optional_params: Optional[Dict[str, Any]] = None,
     ) -> str:
         """Decodes input_filepath in output_filepath"""
         run_command(

fluster/decoders/iso_mpeg2_aac.py

@@ -16,6 +16,7 @@
 # License along with this library. If not, see <https://www.gnu.org/licenses/>.
 import glob
 import os
+from typing import Any, Dict, Optional
 
 from fluster.codec import Codec, OutputFormat
 from fluster.decoder import Decoder, register_decoder
@@ -40,6 +41,7 @@ def decode(
         timeout: int,
         verbose: bool,
         keep_files: bool,
+        optional_params: Optional[Dict[str, Any]] = None,
     ) -> str:
         """Decodes input_filepath in output_filepath"""
         # Addition of .pcm as extension is a must. If it is something else, e.g. ".out" the decoder will output a

fluster/decoders/iso_mpeg2_video.py

@@ -17,6 +17,7 @@
 import glob
 import os
 import tempfile
+from typing import Any, Dict, Optional
 
 from fluster.codec import Codec, OutputFormat
 from fluster.decoder import Decoder, register_decoder
@@ -41,6 +42,7 @@ def decode(
         timeout: int,
         verbose: bool,
         keep_files: bool,
+        optional_params: Optional[Dict[str, Any]] = None,
     ) -> str:
         """Decodes input_filepath in output_filepath"""
         with tempfile.TemporaryDirectory() as temp_dir:

fluster/decoders/iso_mpeg4_aac.py

@@ -16,6 +16,7 @@
 # License along with this library. If not, see <https://www.gnu.org/licenses/>.
 
 import glob
+from typing import Any, Dict, Optional
 
 from fluster.codec import Codec, OutputFormat
 from fluster.decoder import Decoder, register_decoder
@@ -40,6 +41,7 @@ def decode(
         timeout: int,
         verbose: bool,
         keep_files: bool,
+        optional_params: Optional[Dict[str, Any]] = None,
     ) -> str:
         """Decodes input_filepath in output_filepath"""
         # Addition of .pcm as extension is a must. If it is something else, e.g. ".out" the decoder will output a

fluster/decoders/iso_mpeg4_aac_er.py

@@ -16,6 +16,7 @@
 # License along with this library. If not, see <https://www.gnu.org/licenses/>.
 
 import glob
+from typing import Any, Dict, Optional
 
 from fluster.codec import Codec, OutputFormat
 from fluster.decoder import Decoder, register_decoder
@@ -40,6 +41,7 @@ def decode(
         timeout: int,
         verbose: bool,
         keep_files: bool,
+        optional_params: Optional[Dict[str, Any]] = None,
     ) -> str:
         """Decodes input_filepath in output_filepath"""
         output_filepath += ".raw"

fluster/decoders/iso_mpeg4_video.py

@@ -16,7 +16,7 @@
 # License along with this library. If not, see <https://www.gnu.org/licenses/>.
 import os
 import subprocess
-from typing import Tuple
+from typing import Any, Dict, Optional, Tuple
 
 from fluster.codec import Codec, OutputFormat
 from fluster.decoder import Decoder, register_decoder
@@ -41,6 +41,7 @@ def decode(
         timeout: int,
         verbose: bool,
         keep_files: bool,
+        optional_params: Optional[Dict[str, Any]] = None,
     ) -> str:
         """Decodes input_filepath to output_filepath"""
         width, height = self._get_video_resolution(input_filepath, verbose)

fluster/decoders/libvpx.py

@@ -15,6 +15,7 @@
 #
 # You should have received a copy of the GNU Lesser General Public
 # License along with this library. If not, see <https://www.gnu.org/licenses/>.
+from typing import Any, Dict, Optional
 
 from fluster.codec import Codec, OutputFormat
 from fluster.decoder import Decoder, register_decoder
@@ -42,6 +43,7 @@ def decode(
         timeout: int,
         verbose: bool,
         keep_files: bool,
+        optional_params: Optional[Dict[str, Any]] = None,
     ) -> str:
         """Decodes input_filepath in output_filepath"""
         fmt = None

fluster/decoders/vk_video_decoder.py

@@ -14,6 +14,7 @@
 #
 # You should have received a copy of the GNU Lesser General Public
 # License along with this library. If not, see <https://www.gnu.org/licenses/>.
+from typing import Any, Dict, Optional
 
 from fluster.codec import Codec, OutputFormat
 from fluster.decoder import Decoder, register_decoder
@@ -38,6 +39,7 @@ def decode(
         timeout: int,
         verbose: bool,
         keep_files: bool,
+        optional_params: Optional[Dict[str, Any]] = None,
     ) -> str:
         """Decodes input_filepath in output_filepath"""
         codec_mapping = {

fluster/test.py

@@ -86,6 +86,7 @@ def _execute_decode(self) -> str:
             self.timeout,
             self.verbose,
             keep_files_for_decode,
+            self.test_vector.optional_params,
         )
 
     def _cleanup_if_needed(self) -> None: