Class VideoCompressionConfig

examples/codec_ply_sequence.py:187–243

@dataclass
class VideoCompressionConfig(CompressionConfig):
    # Use PLAS sort in compression or not
    use_sort: bool = True
    # Verbose or not
    verbose: bool = True
    # QP configuration - can be either int or dict for different attributes
    qp: Dict[str, Union[int, Dict[str, Any]]] = field(default_factory=default_qp_values)
    # Number of cluster of VQ for shN compression
    n_clusters: int = 32768
    # Maps attribute names to their codec functions
    attribute_codec_registry: Optional[AttributeCodecs] = field(default_factory=lambda: AttributeCodecs())
    # Enable All Intra coding mode
    use_all_intra: bool = False
    # Enable debug mode
    debug: bool = False
    # Indicate which attributes to transform domain before sorting and compression, 
    # e.g. SH: RGB -> YCbCr, Quat: Unit Quaternion -> Euler Angles
    transform_attributes: Dict[str, bool] = field(
        default_factory=lambda: {
            "means": False,
            "scales": False,
            "quats": False,
            "opacities": False,
            "sh0": False,
            "shN": False
        }
    )
    # Chroma subsampling for shN compression
    chroma_subsampling: Dict[str, str] = field(default_factory=lambda: {
        "sh0": "444",
        "shN": "420"
    })
    # Use chroma qp offset for sh0 and shN compression
    use_chroma_qp_offset: Dict[str, bool]= field(default_factory=lambda: {
        "sh0": False,
        "shN": False
    })

    def to_dict(self) -> Dict[str, Any]:
        """
        Convert the CompressionConfig instance to a dictionary.
        If attribute_codec_registry is not None, it will be converted to a dictionary using its to_dict method.
        """
        # Get only attributes defined in VideoCompressionConfig
        video_compression_attrs = [
            "use_sort", "verbose", "qp", "n_clusters", 
            "use_all_intra", "debug", "transform_attributes",
            "chroma_subsampling", "use_chroma_qp_offset"
        ]
        
        result = {attr: getattr(self, attr) for attr in video_compression_attrs}

        # handle attribute_codec_registry
        if self.attribute_codec_registry is not None:
            result["attribute_codec_registry"] = self.attribute_codec_registry.to_dict()

        return result