pycmx 1.2.3__tar.gz → 1.4.0__tar.gz

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

@@ -1,9 +1,9 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.4
 Name: pycmx
-Version: 1.2.3
+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,15 +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" and "File128" 
-  formats are automatically detected and properly read.
+* The major variations of the CMX 3600: the standard, "File32", "File128" and
+  long Adobe Premiere event numbers are automatically detected and properly
+  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
@@ -53,6 +60,8 @@ The `pycmx` package provides a basic interface for parsing a CMX 3600 EDL and it
   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
@@ -114,5 +123,3 @@ Audio channel 7 is present
 False
 ```
 
-
-

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

@@ -5,15 +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" and "File128" 
-  formats are automatically detected and properly read.
+* The major variations of the CMX 3600: the standard, "File32", "File128" and
+  long Adobe Premiere event numbers are automatically detected and properly
+  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
@@ -23,6 +28,8 @@ The `pycmx` package provides a basic interface for parsing a CMX 3600 EDL and it
   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
@@ -83,5 +90,3 @@ Audio channel 7 is present
 >>> events[2].edits[0].channels.video
 False
 ```
-
-

{pycmx-1.2.3 → pycmx-1.4.0}/pycmx/__init__.py

@@ -2,13 +2,11 @@
 """
 pycmx is a parser for CMX 3600-style EDLs.
 
-This module (c) 2023 Jamie Hardt. For more information on your rights to
+This module (c) 2025 Jamie Hardt. For more information on your rights to
 copy and reuse this software, refer to the LICENSE file included with the
 distribution.
 """
 
-__version__ = '1.2.2'
-
 from .parse_cmx_events import parse_cmx3600
 from .transition import Transition
 from .event import Event

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.2.3 → pycmx-1.4.0}/pycmx/channel_map.py

@@ -1,26 +1,27 @@
 # pycmx
-# (c) 2018 Jamie Hardt
+# (c) 2018-2025 Jamie Hardt
 
 from re import (compile, match)
 from typing import Dict, Tuple, Generator
 
+
 class ChannelMap:
     """
     Represents a set of all the channels to which an event applies.
     """
 
-    _chan_map : Dict[str, Tuple] = {     
-                "V" :    (True,   False,   False),
-                "A" :    (False,  True,    False),
-                "A2" :   (False,  False,   True),
-                "AA" :   (False,  True,    True),
-                "B" :    (True,   True,    False),
-                "AA/V" : (True,   True,    True),
-                "A2/V" : (True,   False,   True)
-        }
+    _chan_map: Dict[str, Tuple] = {
+        "V":    (True,   False,   False),
+        "A":    (False,  True,    False),
+        "A2":   (False,  False,   True),
+        "AA":   (False,  True,    True),
+        "B":    (True,   True,    False),
+        "AA/V": (True,   True,    True),
+        "A2/V": (True,   False,   True)
+    }
 
     def __init__(self, v=False, audio_channels=set()):
-        self._audio_channel_set = audio_channels 
+        self._audio_channel_set = audio_channels
         self.v = v
 
     @property
@@ -46,7 +47,7 @@ class ChannelMap:
 
     @a1.setter
     def a1(self, val: bool):
-        self.set_audio_channel(1,val)
+        self.set_audio_channel(1, val)
 
     @property
     def a2(self) -> bool:
@@ -55,7 +56,7 @@ class ChannelMap:
 
     @a2.setter
     def a2(self, val: bool):
-        self.set_audio_channel(2,val)
+        self.set_audio_channel(2, val)
 
     @property
     def a3(self) -> bool:
@@ -64,28 +65,28 @@ class ChannelMap:
 
     @a3.setter
     def a3(self, val: bool):
-        self.set_audio_channel(3,val)
-    
+        self.set_audio_channel(3, val)
+
     @property
     def a4(self) -> bool:
         """True if A4 is included"""
         return self.get_audio_channel(4)
 
     @a4.setter
-    def a4(self,val: bool):
-        self.set_audio_channel(4,val)
+    def a4(self, val: bool):
+        self.set_audio_channel(4, val)
 
     def get_audio_channel(self, chan_num) -> bool:
         """True if chan_num is included"""
         return (chan_num in self._audio_channel_set)
 
-    def set_audio_channel(self,chan_num, enabled: bool):
+    def set_audio_channel(self, chan_num, enabled: bool):
         """If enabled is true, chan_num will be included"""
         if enabled:
             self._audio_channel_set.add(chan_num)
         elif self.get_audio_channel(chan_num):
             self._audio_channel_set.remove(chan_num)
-    
+
     def _append_event(self, event_str):
         alt_channel_re = compile(r'^A(\d+)')
         if event_str in self._chan_map:
@@ -96,7 +97,7 @@ class ChannelMap:
         else:
             matchresult = match(alt_channel_re, event_str)
             if matchresult:
-                self.set_audio_channel(int( matchresult.group(1)), True )
+                self.set_audio_channel(int(matchresult.group(1)), True)
 
     def _append_ext(self, audio_ext):
         self.a3 = audio_ext.audio3
@@ -109,5 +110,4 @@ class ChannelMap:
         out_v = self.video | other.video
         out_a = self._audio_channel_set | other._audio_channel_set
 
-        return ChannelMap(v=out_v,audio_channels = out_a)
-
+        return ChannelMap(v=out_v, audio_channels=out_a)

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.2.3 → pycmx-1.4.0}/pycmx/edit_list.py

@@ -1,18 +1,22 @@
 # pycmx
-# (c) 2018 Jamie Hardt
+# (c) 2018-2025 Jamie Hardt
 
-from .parse_cmx_statements import (StmtUnrecognized, StmtFCM, 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()`.
+    Represents an entire edit decision list as returned by
+    :func:`~pycmx.parse_cmx3600()`.
     """
+
     def __init__(self, statements):
-        self.title_statement = statements[0]
+        self.title_statement: StmtTitle = statements[0]
         self.event_statements = statements[1:]
 
     @property
@@ -20,21 +24,23 @@ class EditList:
         """
         The detected format of the EDL. Possible values are: "3600", "File32",
         "File128", and "unknown".
+
+        Adobe EDLs with more than 999 events will be reported as "3600".
         """
-        first_event = next( (s for s in self.event_statements if type(s) is StmtEvent), None)
+        first_event = next(
+            (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'
         else:
             return 'unknown'
-        
 
     @property
     def channels(self) -> ChannelMap:
@@ -48,7 +54,6 @@ class EditList:
                 retval = retval | edit.channels
 
         return retval
-        
 
     @property
     def title(self) -> str:
@@ -57,27 +62,26 @@ 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
     def events(self) -> Generator[Event, None, None]:
         'A generator for all the events in the edit list'
-        is_drop = None
         current_event_num = None
         event_statements = []
         for stmt in self.event_statements:
-            if type(stmt) is StmtFCM:
-                is_drop = stmt.drop
-            elif type(stmt) is StmtEvent:
+            if type(stmt) is StmtEvent:
                 if current_event_num is None:
                     current_event_num = stmt.event
                     event_statements.append(stmt)
@@ -89,8 +93,6 @@ class EditList:
                     else:
                         event_statements.append(stmt)
 
-            elif type(stmt) is StmtSourceUMID:
-                break
             else:
                 event_statements.append(stmt)
 
@@ -101,9 +103,7 @@ class EditList:
         """
         A generator for all of the sources in the list
         """
-        
+
         for stmt in self.event_statements:
             if type(stmt) is StmtSourceUMID:
                 yield stmt
-
-