pycmx 1.3.0__tar.gz → 1.5.0__tar.gz

{pycmx-1.3.0 → pycmx-1.5.0}/PKG-INFO

@@ -1,31 +1,34 @@
-Metadata-Version: 2.3
+Metadata-Version: 2.4
 Name: pycmx
-Version: 1.3.0
+Version: 1.5.0
 Summary: Python CMX 3600 Edit Decision List Parser
-Home-page: https://github.com/iluvcapra/pycmx
-License: MIT
 Keywords: parser,film,broadcast
 Author: Jamie Hardt
-Author-email: jamiehardt@me.com
-Requires-Python: >=3.8,<4.0
+Author-email: Jamie Hardt <jamiehardt@me.com>
+License-File: LICENSE
 Classifier: Development Status :: 5 - Production/Stable
 Classifier: License :: OSI Approved :: MIT License
-Classifier: Programming Language :: Python :: 3
+Classifier: Topic :: Multimedia
+Classifier: Topic :: Multimedia :: Video
+Classifier: Topic :: Text Processing
 Classifier: Programming Language :: Python :: 3.8
 Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
 Classifier: Programming Language :: Python :: 3.13
-Classifier: Topic :: Multimedia
-Classifier: Topic :: Multimedia :: Video
-Classifier: Topic :: Text Processing
-Provides-Extra: doc
-Requires-Dist: sphinx (>=5.3.0) ; extra == "doc"
-Requires-Dist: sphinx_rtd_theme (>=1.1.1) ; extra == "doc"
+Classifier: Programming Language :: Python :: 3.14
+Requires-Dist: pytest ; extra == 'dev'
+Requires-Dist: ruff>=0.14.10 ; extra == 'dev'
+Requires-Dist: sphinx>=5.3.0 ; extra == 'doc'
+Requires-Dist: sphinx-rtd-theme>=1.1.1 ; extra == 'doc'
+Requires-Python: >3.8
+Project-URL: Homepage, https://github.com/iluvcapra/pycmx
 Project-URL: Documentation, https://pycmx.readthedocs.io/
 Project-URL: Repository, https://github.com/iluvcapra/pycmx.git
 Project-URL: Tracker, https://github.com/iluvcapra/pycmx/issues
+Provides-Extra: dev
+Provides-Extra: doc
 Description-Content-Type: text/markdown
 
 [![Documentation Status](https://readthedocs.org/projects/pycmx/badge/?version=latest)](https://pycmx.readthedocs.io/en/latest/?badge=latest) ![](https://img.shields.io/github/license/iluvcapra/pycmx.svg) ![](https://img.shields.io/pypi/pyversions/pycmx.svg) [![](https://img.shields.io/pypi/v/pycmx.svg)](https://pypi.org/project/pycmx/) ![](https://img.shields.io/pypi/wheel/pycmx.svg)
@@ -35,17 +38,22 @@ Description-Content-Type: text/markdown
 
 # pycmx
 
-The `pycmx` package provides a basic interface for parsing a CMX 3600 EDL and 
-its most most common variations.
+The `pycmx` package parses a CMX 3600 EDL and its most most common variations.
 
 ## Features
 
-* The major variations of the CMX 3600: the standard, "File32", "File128" and 
+* The major variations of the CMX 3600: the standard, "File32", "File128" and
   long Adobe Premiere event numbers are automatically detected and properly
-  read.
+  read. Event number field and source name field sizes are determined
+  dynamically for each statement for a high level of compliance at the expense
+  of strictness.
+* A more relaxed "tolerant" mode allows parsing of an EDL file where columns
+  use non-standard widths.
 * Preserves relationship between events and individual edits/clips.
 * Remark or comment fields with common recognized forms are read and 
   available to the client, including clip name and source file data.
+* [ASC CDL][asc] and FRMC/VFX framecount statements are parsed and
+  decoded.
 * Symbolically decodes transitions and audio channels.
 * Does not parse or validate timecodes, does not enforce framerates, does not
   parameterize timecode or framerates in any way. This makes the parser more
@@ -55,12 +63,14 @@ its most most common variations.
   list and give the client the ability to extend the package with their own
   parsing code.
 
+[asc]: https://en.wikipedia.org/wiki/ASC_CDL
+
 ## Usage
 
 ### Opening and Parsing EDL Files
 ```
 >>> import pycmx
->>> with open("tests/edls/TEST.edl") as f
+>>> with open("tests/edls/TEST.edl") as f:
 ... 	edl = pycmx.parse_cmx3600(f)
 ...
 >>> edl.title
@@ -115,4 +125,3 @@ Audio channel 7 is present
 >>> events[2].edits[0].channels.video
 False
 ```
-

{pycmx-1.3.0 → pycmx-1.5.0}/README.md

@@ -5,17 +5,22 @@
 
 # pycmx
 
-The `pycmx` package provides a basic interface for parsing a CMX 3600 EDL and 
-its most most common variations.
+The `pycmx` package parses a CMX 3600 EDL and its most most common variations.
 
 ## Features
 
-* The major variations of the CMX 3600: the standard, "File32", "File128" and 
+* The major variations of the CMX 3600: the standard, "File32", "File128" and
   long Adobe Premiere event numbers are automatically detected and properly
-  read.
+  read. Event number field and source name field sizes are determined
+  dynamically for each statement for a high level of compliance at the expense
+  of strictness.
+* A more relaxed "tolerant" mode allows parsing of an EDL file where columns
+  use non-standard widths.
 * Preserves relationship between events and individual edits/clips.
 * Remark or comment fields with common recognized forms are read and 
   available to the client, including clip name and source file data.
+* [ASC CDL][asc] and FRMC/VFX framecount statements are parsed and
+  decoded.
 * Symbolically decodes transitions and audio channels.
 * Does not parse or validate timecodes, does not enforce framerates, does not
   parameterize timecode or framerates in any way. This makes the parser more
@@ -25,12 +30,14 @@ its most most common variations.
   list and give the client the ability to extend the package with their own
   parsing code.
 
+[asc]: https://en.wikipedia.org/wiki/ASC_CDL
+
 ## Usage
 
 ### Opening and Parsing EDL Files
 ```
 >>> import pycmx
->>> with open("tests/edls/TEST.edl") as f
+>>> with open("tests/edls/TEST.edl") as f:
 ... 	edl = pycmx.parse_cmx3600(f)
 ...
 >>> edl.title

pycmx-1.5.0/pyproject.toml

@@ -0,0 +1,80 @@
+[project]
+name = "pycmx"
+version = "1.5.0"
+description = "Python CMX 3600 Edit Decision List Parser"
+authors = [{name = "Jamie Hardt", email= "jamiehardt@me.com"}]
+license-files = ["LICENSE"]
+readme = "README.md"
+keywords = [
+  'parser',
+  'film', 
+  'broadcast' 
+]
+requires-python = '>3.8'
+classifiers = [
+  'Development Status :: 5 - Production/Stable',
+  'License :: OSI Approved :: MIT License',
+  'Topic :: Multimedia',
+  'Topic :: Multimedia :: Video',
+  'Topic :: Text Processing',
+  'Programming Language :: Python :: 3.8',
+  'Programming Language :: Python :: 3.9',
+  'Programming Language :: Python :: 3.10',
+  'Programming Language :: Python :: 3.11',
+  'Programming Language :: Python :: 3.12',
+  'Programming Language :: Python :: 3.13',
+  'Programming Language :: Python :: 3.14'
+]
+
+[project.optional-dependencies]
+doc = [
+  'sphinx >= 5.3.0',
+  'sphinx_rtd_theme >= 1.1.1',
+]
+dev = [
+  'pytest',
+  'ruff>=0.14.10'
+]
+
+[project.urls]
+Homepage = "https://github.com/iluvcapra/pycmx"
+Documentation = "https://pycmx.readthedocs.io/"
+Repository = "https://github.com/iluvcapra/pycmx.git"
+Tracker = "https://github.com/iluvcapra/pycmx/issues" 
+
+[dependency-groups]
+dev = ['ruff', 'pytest']
+doc = ['sphinx', 'sphinx_rtd_theme']
+
+
+[tool.pyright]
+typeCheckingMode = "basic"
+
+[tool.ruff]
+line-length = 88
+indent-width = 4
+
+[tool.ruff.lint]
+select = ["E", "F", "W"]
+
+[tool.ruff.format]
+docstring-code-line-length = 88
+
+# [tool.pylint]
+# max-line-length = 88
+# disable = [
+#     "C0103", # (invalid-name)
+#     "C0114", # (missing-module-docstring)
+#     "C0115", # (missing-class-docstring)
+#     "C0116", # (missing-function-docstring)
+#     "R0903", # (too-few-public-methods)
+#     "R0913", # (too-many-arguments)
+#     "W0105", # (pointless-string-statement)
+# ]
+#
+
+
+
+[build-system]
+requires = ["uv_build>=0.9.18,<0.10.0"]
+build-backend = "uv_build"

{pycmx-1.3.0 → pycmx-1.5.0/src}/pycmx/__init__.py

@@ -11,3 +11,5 @@ from .parse_cmx_events import parse_cmx3600
 from .transition import Transition
 from .event import Event
 from .edit import Edit
+
+__all__ = ("parse_cmx3600", "Transition", "Event", "Edit")

pycmx-1.5.0/src/pycmx/cdl.py

@@ -0,0 +1,48 @@
+# pycmx
+# (c) 2025 Jamie Hardt
+
+from dataclasses import dataclass
+from typing import Generic, NamedTuple, TypeVar
+
+T = TypeVar('T')
+
+
+@dataclass
+class Rgb(Generic[T]):
+    """
+    A tuple of three `T`s, where each is the respective red, green and blue
+    values of interest.
+    """
+
+    red: T  # : Red component
+    green: T  # : Green component
+    blue: T  # : Blue component
+
+
+@dataclass
+class AscSopComponents(Generic[T]):
+    """
+    Fields in an ASC SOP (Slope-Offset-Power) color transfer function
+    statement.
+
+    The ASC SOP is a transfer function of the form:
+
+    :math:`y_{color} = (ax_{color} + b)^p`
+
+    for each color component the source, where the `slope` is `a`, `offset`
+    is `b` and `power` is `p`.
+    """
+
+    slope: Rgb[T]  # : The linear/slope component `a`
+    offset: Rgb[T]  # : The constant/offset component `b`
+    power: Rgb[T]  # : The exponential/power component `p`
+
+
+class FramecountTriple(NamedTuple):
+    """
+    Fields in an FRMC statement
+    """
+
+    start: int
+    end: int
+    duration: int

{pycmx-1.3.0 → pycmx-1.5.0/src}/pycmx/channel_map.py

@@ -1,5 +1,5 @@
 # pycmx
-# (c) 2018 Jamie Hardt
+# (c) 2018-2025 Jamie Hardt
 
 from re import (compile, match)
 from typing import Dict, Tuple, Generator

pycmx-1.5.0/src/pycmx/edit.py

@@ -0,0 +1,213 @@
+# pycmx
+# (c) 2018-2025 Jamie Hardt
+
+from .cdl import AscSopComponents, FramecountTriple
+from .statements import (
+    StmtCdlSat,
+    StmtCdlSop,
+    StmtFrmc,
+    StmtEvent,
+    StmtAudioExt,
+    StmtClipName,
+    StmtSourceFile,
+    StmtEffectsName,
+)
+from .transition import Transition
+from .channel_map import ChannelMap
+
+from typing import Optional
+
+
+class Edit:
+    """
+    An individual source-to-record operation, with a source roll, source and
+    recorder timecode in and out, a transition and channels.
+    """
+
+    def __init__(
+        self,
+        edit_statement: StmtEvent,
+        audio_ext_statement: Optional[StmtAudioExt],
+        clip_name_statement: Optional[StmtClipName],
+        source_file_statement: Optional[StmtSourceFile],
+        trans_name_statement: Optional[StmtEffectsName] = None,
+        asc_sop_statement: Optional[StmtCdlSop] = None,
+        asc_sat_statement: Optional[StmtCdlSat] = None,
+        frmc_statement: Optional[StmtFrmc] = None,
+    ) -> None:
+        self._edit_statement: StmtEvent = edit_statement
+        self._audio_ext: Optional[StmtAudioExt] = audio_ext_statement
+        self._clip_name_statement: Optional[StmtClipName] = clip_name_statement
+        self._source_file_statement: Optional[StmtSourceFile] = \
+            source_file_statement
+        self._trans_name_statement: Optional[StmtEffectsName] = \
+            trans_name_statement
+        self._asc_sop_statement: Optional[StmtCdlSop] = asc_sop_statement
+        self._asc_sat_statement: Optional[StmtCdlSat] = asc_sat_statement
+        self._frmc_statement: Optional[StmtFrmc] = frmc_statement
+
+    @property
+    def line_number(self) -> int:
+        """
+        Get the line number for the "standard form" statement associated with
+        this edit. Line numbers a zero-indexed, such that the "TITLE:" record
+        is line zero.
+        """
+        return self._edit_statement.line_number
+
+    @property
+    def channels(self) -> ChannelMap:
+        """
+        Get the :obj:`ChannelMap` object associated with this Edit.
+        """
+        cm = ChannelMap()
+        cm._append_event(self._edit_statement.channels)
+        if self._audio_ext is not None:
+            cm._append_ext(self._audio_ext)
+        return cm
+
+    @property
+    def transition(self) -> Transition:
+        """
+        Get the :obj:`Transition` that initiates this edit.
+        """
+        if self._trans_name_statement:
+            return Transition(
+                self._edit_statement.trans,
+                self._edit_statement.trans_op,
+                self._trans_name_statement.name,
+            )
+        else:
+            return Transition(
+                self._edit_statement.trans, self._edit_statement.trans_op, None
+            )
+
+    @property
+    def source_in(self) -> str:
+        """
+        Get the source in timecode.
+        """
+        return self._edit_statement.source_in
+
+    @property
+    def source_out(self) -> str:
+        """
+        Get the source out timecode.
+        """
+
+        return self._edit_statement.source_out
+
+    @property
+    def record_in(self) -> str:
+        """
+        Get the record in timecode.
+        """
+
+        return self._edit_statement.record_in
+
+    @property
+    def record_out(self) -> str:
+        """
+        Get the record out timecode.
+        """
+
+        return self._edit_statement.record_out
+
+    @property
+    def source(self) -> str:
+        """
+        Get the source column. This is the 8, 32 or 128-character string on the
+        event record line, this usually references the tape name of the source.
+        """
+        return self._edit_statement.source
+
+    @property
+    def black(self) -> bool:
+        """
+        The source field for thie edit was "BL". Black video or silence should
+        be used as the source for this event.
+        """
+        return self.source == "BL"
+
+    @property
+    def aux_source(self) -> bool:
+        """
+        The source field for this edit was "AX". An auxiliary source is the
+        source for this event.
+        """
+        return self.source == "AX"
+
+    @property
+    def source_file(self) -> Optional[str]:
+        """
+        Get the source file, as attested by a "* SOURCE FILE" remark on the
+        EDL. This will return None if the information is not present.
+        """
+        if self._source_file_statement is None:
+            return None
+        else:
+            return self._source_file_statement.filename
+
+    @property
+    def clip_name(self) -> Optional[str]:
+        """
+        Get the clip name, as attested by a "* FROM CLIP NAME" or "* TO CLIP
+        NAME" remark on the EDL. This will return None if the information is
+        not present.
+        """
+        if self._clip_name_statement is None:
+            return None
+        else:
+            return self._clip_name_statement.name
+
+    @property
+    def asc_sop(self) -> Optional[AscSopComponents[float]]:
+        """
+        Get ASC CDL Slope-Offset-Power color transfer function for the edit,
+        if present. The ASC SOP is a transfer function of the form:
+
+        :math:`y = (ax + b)^p`
+
+        for each color component the source, where the `slope` is `a`, `offset`
+        is `b` and `power` is `p`.
+        """
+        if self._asc_sop_statement is None:
+            return None
+
+        return self._asc_sop_statement.cdl_sop
+
+    @property
+    def asc_sop_raw(self) -> Optional[str]:
+        """
+        ASC CDL Slope-Offset-Power statement raw line.
+        """
+        if self._asc_sop_statement is None:
+            return None
+
+        return self._asc_sop_statement.line
+
+    @property
+    def asc_sat(self) -> Optional[float]:
+        """
+        Get ASC CDL saturation value for clip, if present.
+        """
+        if self._asc_sat_statement is None:
+            return None
+
+        return self._asc_sat_statement.value
+
+    @property
+    def framecounts(self) -> Optional[FramecountTriple]:
+        """
+        Get frame count offset data, if it exists. If an FRMC statement exists
+        in the EDL for the event it will give an integer frame count for the
+        edit's source in and out times.
+        """
+        if not self._frmc_statement:
+            return None
+
+        return FramecountTriple(
+            start=self._frmc_statement.start,
+            end=self._frmc_statement.end,
+            duration=self._frmc_statement.duration,
+        )

{pycmx-1.3.0 → pycmx-1.5.0/src}/pycmx/edit_list.py

@@ -1,22 +1,22 @@
 # pycmx
-# (c) 2018 Jamie Hardt
+# (c) 2018-2025 Jamie Hardt
 
-from .parse_cmx_statements import (
-    StmtUnrecognized, StmtEvent, StmtSourceUMID)
+from .statements import (StmtCorruptRemark, StmtTitle, StmtEvent,
+                         StmtUnrecognized, StmtSourceUMID)
 from .event import Event
 from .channel_map import ChannelMap
 
-from typing import Generator
+from typing import Any, Generator
 
 
 class EditList:
     """
     Represents an entire edit decision list as returned by
-    :func:`~pycmx.parse_cmx3600()`.
+    :func:`~pycmx.parse_cmx_events.parse_cmx3600()`.
     """
 
-    def __init__(self, statements):
-        self.title_statement = statements[0]
+    def __init__(self, statements: list):
+        self.title_statement: StmtTitle = statements[0]
         self.event_statements = statements[1:]
 
     @property
@@ -31,11 +31,11 @@ class EditList:
             (s for s in self.event_statements if type(s) is StmtEvent), None)
 
         if first_event:
-            if first_event.format == 8:
+            if first_event.source_field_size == 8:
                 return '3600'
-            elif first_event.format == 32:
+            elif first_event.source_field_size == 32:
                 return 'File32'
-            elif first_event.format == 128:
+            elif first_event.source_field_size == 128:
                 return 'File128'
             else:
                 return 'unknown'
@@ -63,13 +63,16 @@ class EditList:
         return self.title_statement.title
 
     @property
-    def unrecognized_statements(self) -> Generator[StmtUnrecognized,
-                                                   None, None]:
+    def unrecognized_statements(self) -> Generator[Any, None, None]:
         """
-        A generator for all the unrecognized statements in the list.
+        A generator for all the unrecognized statements and
+        corrupt remarks in the list.
+
+        :yields: either a :class:`StmtUnrecognized` or
+            :class:`StmtCorruptRemark`
         """
         for s in self.event_statements:
-            if type(s) is StmtUnrecognized:
+            if type(s) is StmtUnrecognized or type(s) in StmtCorruptRemark:
                 yield s
 
     @property
@@ -90,8 +93,6 @@ class EditList:
                     else:
                         event_statements.append(stmt)
 
-            elif type(stmt) is StmtSourceUMID:
-                break
             else:
                 event_statements.append(stmt)
 

{pycmx-1.3.0 → pycmx-1.5.0/src}/pycmx/event.py

@@ -1,9 +1,9 @@
 # pycmx
-# (c) 2023 Jamie Hardt
+# (c) 2023-2025 Jamie Hardt
 
-from .parse_cmx_statements import (
-    StmtEvent, StmtClipName, StmtSourceFile, StmtAudioExt, StmtUnrecognized,
-    StmtEffectsName)
+from .statements import (StmtFrmc, StmtEvent, StmtClipName, StmtSourceFile,
+                         StmtAudioExt, StmtUnrecognized, StmtEffectsName,
+                         StmtCdlSop, StmtCdlSat)
 from .edit import Edit
 
 from typing import List, Generator, Optional, Tuple, Any
@@ -31,12 +31,27 @@ class Event:
         will have multiple edits when a dissolve, wipe or key transition needs
         to be performed.
         """
+
+        # FTR this is a totall bonkers way of doing this, I wrote this when
+        # I was still learning Python and I'm sure there's easier ways to do
+        # it. The job is complicated because multiple edits can occur in one
+        # event and then other statements can modify the event in different
+        # ways.
+
         edits_audio = list(self._statements_with_audio_ext())
         clip_names = self._clip_name_statements()
         source_files = self._source_file_statements()
 
+        # We first get the edit events combined with their extra audio
+        # channel statements, if any.
+
+        # The list the_zip contains one element for each initialization
+        # parameter in Edit()
         the_zip: List[List[Any]] = [edits_audio]
 
+        # If there are two Clip Name statements and two edits, we look for
+        # "FROM" and "TO" clip name lines. Otherwise we just look for on
+        # each per edit.
         if len(edits_audio) == 2:
             start_name: Optional[StmtClipName] = None
             end_name: Optional[StmtClipName] = None
@@ -54,6 +69,10 @@ class Event:
             else:
                 the_zip.append([None] * len(edits_audio))
 
+        # if there's one source file statemnent per clip, we allocate them to
+        # each edit in order. Otherwise if there's only one, we assign the one
+        # to all the edits. If there's no source_file statements, we provide
+        # None.
         if len(edits_audio) == len(source_files):
             the_zip.append(source_files)
         elif len(source_files) == 1:
@@ -61,7 +80,7 @@ class Event:
         else:
             the_zip.append([None] * len(edits_audio))
 
-        # attach trans name to last event
+        # attach effects name to last event
         try:
             trans_statement = self._trans_name_statements()[0]
             trans_names: List[Optional[Any]] = [None] * (len(edits_audio) - 1)
@@ -74,7 +93,10 @@ class Event:
                      audio_ext_statement=e1[1],
                      clip_name_statement=n1,
                      source_file_statement=s1,
-                     trans_name_statement=u1)
+                     trans_name_statement=u1,
+                     asc_sop_statement=self._asc_sop_statement(),
+                     asc_sat_statement=self._asc_sat_statement(),
+                     frmc_statement=self._frmc_statement())
                 for (e1, n1, s1, u1) in zip(*the_zip)]
 
     @property
@@ -101,8 +123,24 @@ class Event:
 
     def _statements_with_audio_ext(self) -> Generator[
             Tuple[StmtEvent, Optional[StmtAudioExt]], None, None]:
-        for (s1, s2) in zip(self.statements, self.statements[1:]):
-            if type(s1) is StmtEvent and type(s2) is StmtAudioExt:
-                yield (s1, s2)
-            elif type(s1) is StmtEvent:
-                yield (s1, None)
+
+        if len(self.statements) == 1 and type(self.statements[0]) is StmtEvent:
+            yield (self.statements[0], None)
+
+        else:
+            for (s1, s2) in zip(self.statements, self.statements[1:]):
+                if type(s1) is StmtEvent and type(s2) is StmtAudioExt:
+                    yield (s1, s2)
+                elif type(s1) is StmtEvent:
+                    yield (s1, None)
+
+    def _asc_sop_statement(self) -> Optional[StmtCdlSop]:
+        return next((s for s in self.statements if type(s) is StmtCdlSop),
+                    None)
+
+    def _asc_sat_statement(self) -> Optional[StmtCdlSat]:
+        return next((s for s in self.statements if type(s) is StmtCdlSat),
+                    None)
+
+    def _frmc_statement(self) -> Optional[StmtFrmc]:
+        return next((s for s in self.statements if type(s) is StmtFrmc), None)