API Reference

The class structure of cdl_convert mirrors the element structure of the XML schema for ccc, cdl and cc files as defined by the ASC. The XML schemas represent the most complicated and structured variant of the format, and therefore it behooves the project to mimic their structure.

However, where similar elements exist as entirely separate entities in the XML schema, they might have been combined here.

Core Classes

• Classes
  • ColorCorrection
  • ColorCollection
  • ColorDecision
  • ColorCorrectionRef
  • MediaRef
  • SopNode
  • SatNode
  • Base Classes
• Configuration
  • Overview
  • Global Configuration Instance
  • CDLFormat Enum
  • Config Class
  • Usage Examples
  • Migration from Legacy Configuration
• Parse Functions
  • parse_file
  • parse_ale
  • parse_cc
  • parse_ccc
  • parse_cdl
  • parse_cmx
  • parse_flex
  • parse_nk
  • parse_otio
  • parse_rnh_cdl
• Write Functions
  • write_cc
  • write_ccc
  • write_cdl
  • write_nk
  • write_rnh_cdl
• Utility Functions
  • reset_all
  • sanity_check
  • to_decimal

Quick Reference

Main Classes

• ColorCorrection - The backbone class representing a single CDL

• ColorCollection - Container for multiple CDLs

• ColorDecision - Decision with correction and media reference

• SopNode - Slope, Offset, Power values

• SatNode - Saturation value

Parse Functions

• parse_file() - Auto-detect and parse any supported format

• parse_cc() - Parse XML Color Correction

• parse_ccc() - Parse Color Correction Collection

• parse_cdl() - Parse Color Decision List

• parse_ale() - Parse Avid Log Exchange

• parse_cmx() - Parse CMX EDL

Write Functions

• write_cc() - Write XML Color Correction

• write_ccc() - Write Color Correction Collection

• write_cdl() - Write Color Decision List

• write_rnh_cdl() - Write Rhythm & Hues CDL

Configuration

• Config - Global configuration dataclass

• CDLFormat - Format type enum

• config - Global configuration instance