Class EncoderBase

Test/testlib/encoder.py:43–258

A wrapper around the astcenc binary, abstracting the command line so that the rest of the test suite does not need to worry about changes to the command line interface over versions. This is an abstract base class providing some generic helper functionality used by concrete ins

class EncoderBase:
    '''
    A wrapper around the astcenc binary, abstracting the command line so that
    the rest of the test suite does not need to worry about changes to the
    command line interface over versions.

    This is an abstract base class providing some generic helper functionality
    used by concrete instantiations of subclasses.

    Attributes:
        name: The encoder name to use in reports.
        variant: The encoder SIMD variant being tested.
        binary_path: The encoder binary path.

    Class attributes:
        version: Encoder version or branch.
        remap_color_switches: Dict of color format to profile switches.
        remap_output_types: Dict of color format to output file extensions.
    '''

    # Subclasses override these if they need them
    version = ''
    remap_color_switches: dict[str, str] = {}
    remap_output_types: dict[str, str] = {}

    def __init__(self, name: str, variant: str, binary_path: Path):
        '''
        Create a new encoder instance.

        Args:
            name: The name of the encoder.
            variant: The SIMD variant of the encoder.
            binary: The path to the binary on the file system.
        '''
        self.name = name
        self.variant = variant
        self.binary_path = binary_path

    def build_cli(self, image: TestImage, block_size: str = '6x6',
                  preset: str = '-thorough', keep_output: bool = True,
                  threads: Optional[int] = None) -> list[str]:
        '''
        Build the command line needed for the given test.

        Args:
            image: The test image to compress.
            block_size: The block size to use.
            preset: The quality preset to use.
            keep_output: Should the test preserve output images? This is a hint
                and may be ignored if astcenc version used can't do it.
            threads: The thread count to use.

        Return:
            The command line arguments for this encoder version.
        '''
        # pylint: disable=unused-argument,redundant-returns-doc
        assert False, 'Missing subclass implementation'