pycmx 1.3.0__tar.gz → 1.4.0__tar.gz

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

@@ -1,9 +1,9 @@
-Metadata-Version: 2.3
+Metadata-Version: 2.4
 Name: pycmx
-Version: 1.3.0
+Version: 1.4.0
 Summary: Python CMX 3600 Edit Decision List Parser
-Home-page: https://github.com/iluvcapra/pycmx
 License: MIT
+License-File: LICENSE
 Keywords: parser,film,broadcast
 Author: Jamie Hardt
 Author-email: jamiehardt@me.com
@@ -17,6 +17,7 @@ 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: Programming Language :: Python :: 3.14
 Classifier: Topic :: Multimedia
 Classifier: Topic :: Multimedia :: Video
 Classifier: Topic :: Text Processing
@@ -24,6 +25,7 @@ Provides-Extra: doc
 Requires-Dist: sphinx (>=5.3.0) ; extra == "doc"
 Requires-Dist: sphinx_rtd_theme (>=1.1.1) ; extra == "doc"
 Project-URL: Documentation, https://pycmx.readthedocs.io/
+Project-URL: Homepage, https://github.com/iluvcapra/pycmx
 Project-URL: Repository, https://github.com/iluvcapra/pycmx.git
 Project-URL: Tracker, https://github.com/iluvcapra/pycmx/issues
 Description-Content-Type: text/markdown
@@ -35,17 +37,20 @@ 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.
 * 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,6 +60,8 @@ 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

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

@@ -5,17 +5,20 @@
 
 # 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.
 * 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,6 +28,8 @@ 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

pycmx-1.4.0/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.4.0}/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.4.0/pycmx/edit.py

@@ -0,0 +1,214 @@
+# 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:
+        # Assigning types for the attributes explicitly
+        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.4.0}/pycmx/edit_list.py

@@ -1,12 +1,12 @@
 # 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:
@@ -16,7 +16,7 @@ class EditList:
     """
 
     def __init__(self, statements):
-        self.title_statement = statements[0]
+        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.4.0}/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
@@ -74,7 +74,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
@@ -106,3 +109,14 @@ class Event:
                 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)

{pycmx-1.3.0 → pycmx-1.4.0}/pycmx/parse_cmx_events.py

@@ -1,13 +1,11 @@
 # pycmx
-# (c) 2018 Jamie Hardt
+# (c) 2018-2025 Jamie Hardt
 
-# from collections import namedtuple
+from typing import TextIO
 
 from .parse_cmx_statements import (parse_cmx3600_statements)
 from .edit_list import EditList
 
-from typing import TextIO
-
 
 def parse_cmx3600(f: TextIO) -> EditList:
     """

pycmx-1.4.0/pycmx/parse_cmx_statements.py

@@ -0,0 +1,223 @@
+# pycmx
+# (c) 2018-2025 Jamie Hardt
+
+import re
+from typing import TextIO, List
+
+from .cdl import AscSopComponents, Rgb
+
+from .statements import (StmtCdlSat, StmtCdlSop, StmtCorruptRemark, StmtFrmc,
+                         StmtRemark, StmtTitle, StmtUnrecognized, StmtFCM,
+                         StmtAudioExt, StmtClipName, StmtEffectsName,
+                         StmtEvent, StmtSourceFile, StmtSplitEdit)
+from .util import collimate
+
+
+def parse_cmx3600_statements(file: TextIO) -> List[object]:
+    """
+    Return a list of every statement in the file argument.
+    """
+    lines = file.readlines()
+    return [_parse_cmx3600_line(line.strip(), line_number)
+            for (line_number, line) in enumerate(lines)]
+
+
+def _edl_column_widths(event_field_length, source_field_length) -> List[int]:
+    return [event_field_length, 2, source_field_length, 1,
+            4, 2,  # chans
+            4, 1,  # trans
+            3, 1,  # trans op
+            11, 1,
+            11, 1,
+            11, 1,
+            11]
+
+# def _edl_m2_column_widths():
+#     return [2, # "M2"
+#             3,3, #
+#             8,8,1,4,2,1,4,13,3,1,1]
+
+
+def _parse_cmx3600_line(line: str, line_number: int) -> object:
+    """
+    Parses a single CMX EDL line.
+
+    :param line: A single EDL line.
+    :param line_number: The index of this line in the file.
+    """
+    event_num_p = re.compile(r"^(\d+)  ")
+    line_matcher = event_num_p.match(line)
+
+    if line.startswith("TITLE:"):
+        return _parse_title(line, line_number)
+    if line.startswith("FCM:"):
+        return _parse_fcm(line, line_number)
+    if line_matcher is not None:
+        event_field_len = len(line_matcher.group(1))
+        source_field_len = len(line) - (event_field_len + 65)
+        return _parse_columns_for_standard_form(line, event_field_len,
+                                                source_field_len, line_number)
+    if line.startswith("AUD"):
+        return _parse_extended_audio_channels(line, line_number)
+    if line.startswith("*"):
+        return _parse_remark(line[1:].strip(), line_number)
+    if line.startswith(">>> SOURCE"):
+        return _parse_source_umid_statement(line, line_number)
+    if line.startswith("EFFECTS NAME IS"):
+        return _parse_effects_name(line, line_number)
+    if line.startswith("SPLIT:"):
+        return _parse_split(line, line_number)
+    if line.startswith("M2"):
+        pass
+        # return _parse_motion_memory(line, line_number)
+
+    return _parse_unrecognized(line, line_number)
+
+
+def _parse_title(line, line_num) -> StmtTitle:
+    title = line[6:].strip()
+    return StmtTitle(title=title, line_number=line_num)
+
+
+def _parse_fcm(line, line_num) -> StmtFCM:
+    val = line[4:].strip()
+    if val == "DROP FRAME":
+        return StmtFCM(drop=True, line_number=line_num)
+
+    return StmtFCM(drop=False, line_number=line_num)
+
+
+def _parse_extended_audio_channels(line, line_number):
+    content = line.strip()
+    audio3 = "3" in content
+    audio4 = "4" in content
+
+    if audio3 or audio4:
+        return StmtAudioExt(audio3, audio4, line_number)
+    else:
+        return StmtUnrecognized(line, line_number)
+
+
+def _parse_remark(line, line_number) -> object:
+    if line.startswith("FROM CLIP NAME:"):
+        return StmtClipName(name=line[15:].strip(), affect="from",
+                            line_number=line_number)
+    elif line.startswith("TO CLIP NAME:"):
+        return StmtClipName(name=line[13:].strip(), affect="to",
+                            line_number=line_number)
+    elif line.startswith("SOURCE FILE:"):
+        return StmtSourceFile(filename=line[12:].strip(),
+                              line_number=line_number)
+    elif line.startswith("ASC_SOP"):
+        group_patterns: list[str] = re.findall(r'\((.*?)\)', line)
+
+        v1: list[list[tuple[str, str]]] = \
+                [re.findall(r'(-?\d+(\.\d+)?)', a) for a in group_patterns]
+
+        v: list[list[str]] = [[a[0] for a in b] for b in v1]
+
+        if len(v) != 3 or any([len(a) != 3 for a in v]):
+            return StmtRemark(line, line_number)
+
+        else:
+            try:
+                return StmtCdlSop(line=line,
+                                  cdl_sop=AscSopComponents(
+                                      slope=Rgb(red=float(v[0][0]),
+                                                green=float(v[0][1]),
+                                                blue=float(v[0][2])),
+                                      offset=Rgb(red=float(v[1][0]),
+                                                 green=float(v[1][1]),
+                                                 blue=float(v[1][2])),
+                                      power=Rgb(red=float(v[2][0]),
+                                                green=float(v[2][1]),
+                                                blue=float(v[2][2]))
+                                  ),
+                                  line_number=line_number)
+
+            except ValueError as e:
+                return StmtCorruptRemark('ASC_SOP', e, line_number)
+
+    elif line.startswith("ASC_SAT"):
+        value = re.findall(r'(-?\d+(\.\d+)?)', line)
+
+        if len(value) != 1:
+            return StmtRemark(line, line_number)
+
+        else:
+            try:
+                return StmtCdlSat(value=float(value[0][0]),
+                                  line_number=line_number)
+
+            except ValueError as e:
+                return StmtCorruptRemark('ASC_SAT', e, line_number)
+
+    elif line.startswith("FRMC"):
+        match = re.match(r'^FRMC START:\s*(\d+)\s+FRMC END:\s*(\d+)'
+                         r'\s+FRMC DURATION:\s*(\d+)', line, re.IGNORECASE)
+
+        if match is None:
+            return StmtCorruptRemark('FRMC', None, line_number)
+
+        else:
+            try:
+                return StmtFrmc(start=int(match.group(1)),
+                                end=int(match.group(2)),
+                                duration=int(match.group(3)),
+                                line_number=line_number)
+            except ValueError as e:
+                return StmtCorruptRemark('FRMC', e, line_number)
+
+    else:
+        return StmtRemark(text=line, line_number=line_number)
+
+
+def _parse_effects_name(line, line_number) -> StmtEffectsName:
+    name = line[16:].strip()
+    return StmtEffectsName(name=name, line_number=line_number)
+
+
+def _parse_split(line: str, line_number):
+    split_type = line[10:21]
+    is_video = split_type.startswith("VIDEO")
+
+    split_delay = line[24:35]
+    return StmtSplitEdit(video=is_video, delay=split_delay,
+                         line_number=line_number)
+
+
+# def _parse_motion_memory(line, line_number):
+#     return StmtMotionMemory(source="", fps="")
+#
+
+def _parse_unrecognized(line, line_number):
+    return StmtUnrecognized(content=line, line_number=line_number)
+
+
+def _parse_columns_for_standard_form(line: str, event_field_length: int,
+                                     source_field_length: int,
+                                     line_number: int):
+    col_widths = _edl_column_widths(event_field_length, source_field_length)
+
+    if sum(col_widths) > len(line):
+        return StmtUnrecognized(content=line, line_number=line_number)
+
+    column_strings = collimate(line, col_widths)
+
+    return StmtEvent(event=column_strings[0],
+                     source=column_strings[2].strip(),
+                     channels=column_strings[4].strip(),
+                     trans=column_strings[6].strip(),
+                     trans_op=column_strings[8].strip(),
+                     source_in=column_strings[10].strip(),
+                     source_out=column_strings[12].strip(),
+                     record_in=column_strings[14].strip(),
+                     record_out=column_strings[16].strip(),
+                     line_number=line_number,
+                     source_field_size=source_field_length)
+
+
+def _parse_source_umid_statement(line, line_number):
+    # trimmed = line[3:].strip()
+    # return StmtSourceUMID(name=None, umid=None, line_number=line_number)
+    ...

pycmx-1.4.0/pycmx/statements.py

@@ -0,0 +1,104 @@
+# pycmx
+# (c) 2025 Jamie Hardt
+
+from typing import Any, NamedTuple
+
+from .cdl import AscSopComponents
+
+# type str = str
+
+
+class StmtTitle(NamedTuple):
+    title: str
+    line_number: int
+
+
+class StmtFCM(NamedTuple):
+    drop: bool
+    line_number: int
+
+
+class StmtEvent(NamedTuple):
+    event: int
+    source: str
+    channels: str
+    trans: str
+    trans_op: str
+    source_in: str
+    source_out: str
+    record_in: str
+    record_out: str
+    source_field_size: int
+    line_number: int
+
+
+class StmtAudioExt(NamedTuple):
+    audio3: bool
+    audio4: bool
+    line_number: int
+
+
+class StmtClipName(NamedTuple):
+    name: str
+    affect: str
+    line_number: int
+
+
+class StmtSourceFile(NamedTuple):
+    filename: str
+    line_number: int
+
+
+class StmtCdlSop(NamedTuple):
+    line: str
+    cdl_sop: AscSopComponents[float]
+    line_number: int
+
+
+class StmtCdlSat(NamedTuple):
+    value: float
+    line_number: int
+
+
+class StmtFrmc(NamedTuple):
+    start: int
+    end: int
+    duration: int
+    line_number: int
+
+
+class StmtRemark(NamedTuple):
+    text: str
+    line_number: int
+
+
+class StmtEffectsName(NamedTuple):
+    name: str
+    line_number: int
+
+
+class StmtSourceUMID(NamedTuple):
+    name: str
+    umid: str
+    line_number: int
+
+
+class StmtSplitEdit(NamedTuple):
+    video: bool
+    delay: str
+    line_number: int
+
+
+class StmtUnrecognized(NamedTuple):
+    content: str
+    line_number: int
+
+
+class StmtCorruptRemark(NamedTuple):
+    selector: str
+    exception: Any
+    line_number: int
+
+
+# StmtMotionMemory = namedtuple(
+#     "MotionMemory", ["source", "fps"])  # FIXME needs more fields

{pycmx-1.3.0 → pycmx-1.4.0}/pycmx/util.py

@@ -1,5 +1,5 @@
 # pycmx
-# (c) 2018 Jamie Hardt
+# (c) 2018-2025 Jamie Hardt
 
 # Utility functions
 

{pycmx-1.3.0 → pycmx-1.4.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "pycmx"
-version = "1.3.0"
+version = "1.4.0"
 description = "Python CMX 3600 Edit Decision List Parser"
 authors = ["Jamie Hardt <jamiehardt@me.com>"]
 license = "MIT"

pycmx-1.3.0/pycmx/edit.py

@@ -1,133 +0,0 @@
-# pycmx
-# (c) 2018 Jamie Hardt
-
-from .transition import Transition
-from .channel_map import ChannelMap
-# from .parse_cmx_statements import StmtEffectsName
-
-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, audio_ext_statement,
-                 clip_name_statement, source_file_statement,
-                 trans_name_statement=None):
-        self.edit_statement = edit_statement
-        self.audio_ext = audio_ext_statement
-        self.clip_name_statement = clip_name_statement
-        self.source_file_statement = source_file_statement
-        self.trans_name_statement = trans_name_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` object associated with 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:
-        """
-        Black video or silence should be used as the source for this event.
-        """
-        return self.source == "BL"
-
-    @property
-    def aux_source(self) -> bool:
-        """
-        An auxiliary source is the source of 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

pycmx-1.3.0/pycmx/parse_cmx_statements.py

@@ -1,193 +0,0 @@
-# pycmx
-# (c) 2018 Jamie Hardt
-
-import re
-from collections import namedtuple
-from typing import TextIO, List
-
-
-from .util import collimate
-
-StmtTitle = namedtuple("Title", ["title", "line_number"])
-StmtFCM = namedtuple("FCM", ["drop", "line_number"])
-StmtEvent = namedtuple("Event", ["event", "source", "channels", "trans",
-                                 "trans_op", "source_in", "source_out",
-                                 "record_in", "record_out", "format",
-                                 "line_number"])
-StmtAudioExt = namedtuple("AudioExt", ["audio3", "audio4", "line_number"])
-StmtClipName = namedtuple("ClipName", ["name", "affect", "line_number"])
-StmtSourceFile = namedtuple("SourceFile", ["filename", "line_number"])
-StmtRemark = namedtuple("Remark", ["text", "line_number"])
-StmtEffectsName = namedtuple("EffectsName", ["name", "line_number"])
-StmtSourceUMID = namedtuple("Source", ["name", "umid", "line_number"])
-StmtSplitEdit = namedtuple("SplitEdit", ["video", "magnitude", "line_number"])
-StmtMotionMemory = namedtuple(
-    "MotionMemory", ["source", "fps"])  # FIXME needs more fields
-StmtUnrecognized = namedtuple("Unrecognized", ["content", "line_number"])
-
-
-def parse_cmx3600_statements(file: TextIO) -> List[object]:
-    """
-    Return a list of every statement in the file argument.
-    """
-    lines = file.readlines()
-    return [_parse_cmx3600_line(line.strip(), line_number)
-            for (line_number, line) in enumerate(lines)]
-
-
-def _edl_column_widths(event_field_length, source_field_length) -> List[int]:
-    return [event_field_length, 2, source_field_length, 1,
-            4, 2,  # chans
-            4, 1,  # trans
-            3, 1,  # trans op
-            11, 1,
-            11, 1,
-            11, 1,
-            11]
-
-# def _edl_m2_column_widths():
-#     return [2, # "M2"
-#             3,3, #
-#             8,8,1,4,2,1,4,13,3,1,1]
-
-
-def _parse_cmx3600_line(line: str, line_number: int) -> object:
-    """
-    Parses a single CMX EDL line.
-
-    :param line: A single EDL line.
-    :param line_number: The index of this line in the file.
-    """
-    long_event_num_p = re.compile("^[0-9]{6} ")
-    short_event_num_p = re.compile("^[0-9]{3} ")
-    x_event_form_p = re.compile("^([0-9]{4,5}) ")
-
-    if line.startswith("TITLE:"):
-        return _parse_title(line, line_number)
-    elif line.startswith("FCM:"):
-        return _parse_fcm(line, line_number)
-    elif long_event_num_p.match(line) is not None:
-        length_file_128 = sum(_edl_column_widths(6, 128))
-        if len(line) < length_file_128:
-            return _parse_long_standard_form(line, 32, line_number)
-        else:
-            return _parse_long_standard_form(line, 128, line_number)
-    elif (m := x_event_form_p.match(line)) is not None:
-        assert m is not None
-        event_field_length = len(m[1])
-        return _parse_columns_for_standard_form(line, event_field_length,
-                                                8, line_number)
-    elif short_event_num_p.match(line) is not None:
-        return _parse_standard_form(line, line_number)
-    elif line.startswith("AUD"):
-        return _parse_extended_audio_channels(line, line_number)
-    elif line.startswith("*"):
-        return _parse_remark(line[1:].strip(), line_number)
-    elif line.startswith(">>> SOURCE"):
-        return _parse_source_umid_statement(line, line_number)
-    elif line.startswith("EFFECTS NAME IS"):
-        return _parse_effects_name(line, line_number)
-    elif line.startswith("SPLIT:"):
-        return _parse_split(line, line_number)
-    elif line.startswith("M2"):
-        return _parse_motion_memory(line, line_number)
-    else:
-        return _parse_unrecognized(line, line_number)
-
-
-def _parse_title(line, line_num) -> StmtTitle:
-    title = line[6:].strip()
-    return StmtTitle(title=title, line_number=line_num)
-
-
-def _parse_fcm(line, line_num) -> StmtFCM:
-    val = line[4:].strip()
-    if val == "DROP FRAME":
-        return StmtFCM(drop=True, line_number=line_num)
-    else:
-        return StmtFCM(drop=False, line_number=line_num)
-
-
-def _parse_long_standard_form(line, source_field_length, line_number):
-    return _parse_columns_for_standard_form(line, 6, source_field_length,
-                                            line_number)
-
-
-def _parse_standard_form(line, line_number):
-    return _parse_columns_for_standard_form(line, 3, 8, line_number)
-
-
-def _parse_extended_audio_channels(line, line_number):
-    content = line.strip()
-    if content == "AUD   3":
-        return StmtAudioExt(audio3=True, audio4=False, line_number=line_number)
-    elif content == "AUD   4":
-        return StmtAudioExt(audio3=False, audio4=True, line_number=line_number)
-    elif content == "AUD   3     4":
-        return StmtAudioExt(audio3=True, audio4=True, line_number=line_number)
-    else:
-        return StmtUnrecognized(content=line, line_number=line_number)
-
-
-def _parse_remark(line, line_number) -> object:
-    if line.startswith("FROM CLIP NAME:"):
-        return StmtClipName(name=line[15:].strip(), affect="from",
-                            line_number=line_number)
-    elif line.startswith("TO CLIP NAME:"):
-        return StmtClipName(name=line[13:].strip(), affect="to",
-                            line_number=line_number)
-    elif line.startswith("SOURCE FILE:"):
-        return StmtSourceFile(filename=line[12:].strip(),
-                              line_number=line_number)
-    else:
-        return StmtRemark(text=line, line_number=line_number)
-
-
-def _parse_effects_name(line, line_number) -> StmtEffectsName:
-    name = line[16:].strip()
-    return StmtEffectsName(name=name, line_number=line_number)
-
-
-def _parse_split(line, line_number):
-    split_type = line[10:21]
-    is_video = False
-    if split_type.startswith("VIDEO"):
-        is_video = True
-
-    split_mag = line[24:35]
-    return StmtSplitEdit(video=is_video, magnitude=split_mag,
-                         line_number=line_number)
-
-
-def _parse_motion_memory(line, line_number):
-    return StmtMotionMemory(source="", fps="")
-
-
-def _parse_unrecognized(line, line_number):
-    return StmtUnrecognized(content=line, line_number=line_number)
-
-
-def _parse_columns_for_standard_form(line, event_field_length,
-                                     source_field_length, line_number):
-    col_widths = _edl_column_widths(event_field_length, source_field_length)
-
-    if sum(col_widths) > len(line):
-        return StmtUnrecognized(content=line, line_number=line_number)
-
-    column_strings = collimate(line, col_widths)
-
-    return StmtEvent(event=column_strings[0],
-                     source=column_strings[2].strip(),
-                     channels=column_strings[4].strip(),
-                     trans=column_strings[6].strip(),
-                     trans_op=column_strings[8].strip(),
-                     source_in=column_strings[10].strip(),
-                     source_out=column_strings[12].strip(),
-                     record_in=column_strings[14].strip(),
-                     record_out=column_strings[16].strip(),
-                     line_number=line_number, format=source_field_length)
-
-
-def _parse_source_umid_statement(line, line_number):
-    # trimmed = line[3:].strip()
-    return StmtSourceUMID(name=None, umid=None, line_number=line_number)