Add ImageSequenceReference support to EDL adapter (#804)

* Implemented ImageSequenceReference support in the EDL adapter, including tests.
* Updated feature matrix

Co-authored-by: apetrynet <[email protected]>
Co-authored-by: daniel <[email protected]>

Author: 3 people

docs/tutorials/feature-matrix.rst

@@ -28,7 +28,7 @@ Adapters may or may not support all of the features of OpenTimelineIO or the for
 +-------------------------+------+-------+--------+--------+-------+--------+-------+----------+
 |Color Decision List      |  ✔   |   ✔   |   ✖    |   ✖    |   ✖   |   ✖    |  N/A  |    ✖     |
 +-------------------------+------+-------+--------+--------+-------+--------+-------+----------+
-|Image Sequence Reference |  ✔   |   ✖   |   ✖    |   ✖    |   ✖   |  W-O   |   ✖   |    ✔     |
+|Image Sequence Reference |  ✔   |   ✔   |   ✖    |   ✖    |   ✖   |  W-O   |   ✖   |    ✔     |
 +-------------------------+------+-------+--------+--------+-------+--------+-------+----------+
 
 N/A: Not Applicable

src/py-opentimelineio/opentimelineio/adapters/cmx_3600.py

@@ -360,6 +360,10 @@ def parse_edl(self, edl_string, rate=24):
 
 
 class ClipHandler(object):
+    # /path/filename.[1001-1020].ext
+    image_sequence_pattern = re.compile(
+        r'.*\.(?P<range>\[(?P<start>[0-9]+)-(?P<end>[0-9]+)\])\.\w+$'
+    )
 
     def __init__(self, line, comment_data, rate=24):
         self.clip_num = None
@@ -376,6 +380,33 @@ def __init__(self, line, comment_data, rate=24):
         self.parse(line)
         self.clip = self.make_clip(comment_data)
 
+    def is_image_sequence(self, comment_data):
+        return self.image_sequence_pattern.search(
+            comment_data['media_reference']
+        ) is not None
+
+    def create_imagesequence_reference(self, comment_data):
+        regex_obj = self.image_sequence_pattern.search(
+            comment_data['media_reference']
+        )
+
+        path, basename = os.path.split(comment_data['media_reference'])
+        prefix, suffix = basename.split(regex_obj.group('range'))
+        ref = schema.ImageSequenceReference(
+            target_url_base=path,
+            name_prefix=prefix,
+            name_suffix=suffix,
+            rate=self.edl_rate,
+            start_frame=int(regex_obj.group('start')),
+            frame_zero_padding=len(regex_obj.group('start')),
+            available_range=opentime.range_from_start_end_time(
+                opentime.from_timecode(self.source_tc_in, self.edl_rate),
+                opentime.from_timecode(self.source_tc_out, self.edl_rate)
+            )
+        )
+
+        return ref
+
     def make_clip(self, comment_data):
         clip = schema.Clip()
         clip.name = str(self.clip_num)
@@ -392,10 +423,15 @@ def make_clip(self, comment_data):
             # TODO: Replace with enum, once one exists
             clip.media_reference.generator_kind = 'SMPTEBars'
         elif 'media_reference' in comment_data:
-            clip.media_reference = schema.ExternalReference()
-            clip.media_reference.target_url = comment_data[
-                'media_reference'
-            ]
+            if self.is_image_sequence(comment_data):
+                clip.media_reference = self.create_imagesequence_reference(
+                    comment_data
+                )
+            else:
+                clip.media_reference = schema.ExternalReference()
+                clip.media_reference.target_url = comment_data[
+                    'media_reference'
+                ]
         else:
             clip.media_reference = schema.MissingReference()
 
@@ -413,6 +449,15 @@ def make_clip(self, comment_data):
                 os.path.basename(clip.media_reference.target_url)
             )[0]
 
+        elif (
+            clip.media_reference and
+            hasattr(clip.media_reference, 'target_url_base') and
+            clip.media_reference.target_url_base is not None
+        ):
+            clip.name = os.path.splitext(
+                os.path.basename(_get_image_sequence_url(clip))
+            )[0]
+
         asc_sop = comment_data.get('asc_sop', None)
         asc_sat = comment_data.get('asc_sat', None)
         if asc_sop or asc_sat:
@@ -1295,6 +1340,9 @@ def _generate_comment_lines(
         if hasattr(clip.media_reference, 'target_url'):
             url = clip.media_reference.target_url
 
+        elif hasattr(clip.media_reference, 'abstract_target_url'):
+            url = _get_image_sequence_url(clip)
+
     else:
         url = clip.name
 
@@ -1390,6 +1438,22 @@ def _generate_comment_lines(
     return lines
 
 
+def _get_image_sequence_url(clip):
+    ref = clip.media_reference
+    start_frame, end_frame = ref.frame_range_for_time_range(
+        clip.trimmed_range()
+    )
+
+    frame_range_str = '[{start}-{end}]'.format(
+        start=start_frame,
+        end=end_frame
+    )
+
+    url = clip.media_reference.abstract_target_url(frame_range_str)
+
+    return url
+
+
 def _flip_windows_slashes(path):
     return re.sub(r'\\', '/', path)
 
@@ -1403,10 +1467,18 @@ def _reel_from_clip(clip, reelname_len):
 
     _reel = clip.name or 'AX'
 
-    if isinstance(clip.media_reference, schema.ExternalReference):
-        _reel = clip.media_reference.name or os.path.basename(
-            clip.media_reference.target_url
-        )
+    valid_refs = (schema.ExternalReference, schema.ImageSequenceReference)
+    if isinstance(clip.media_reference, valid_refs):
+        if clip.media_reference.name:
+            _reel = clip.media_reference.name
+
+        elif hasattr(clip.media_reference, 'target_url'):
+            _reel = os.path.basename(
+                clip.media_reference.target_url
+            )
+
+        else:
+            _reel = _get_image_sequence_url(clip)
 
     # Flip Windows slashes
     _reel = os.path.basename(_flip_windows_slashes(_reel))

tests/test_cmx_3600_adapter.py

@@ -212,7 +212,7 @@ def test_reelname_length(self):
 
         self.assertMultiLineEqual(result, expected)
 
-        # Keep full filename (minus extension) as reelname
+        # Make sure reel name is only 12 characters long
         result = otio.adapters.write_to_string(
             tl,
             adapter_name="cmx_3600",
@@ -400,6 +400,113 @@ def test_clip_with_tab_and_space_delimiters(self):
             31
         )
 
+    def test_imagesequence_read(self):
+        trunced_edl1 = '''TITLE: Image Sequence Write
+
+001  myimages V     C        01:00:01:00 01:00:02:12 00:00:00:00 00:00:01:12
+* FROM CLIP NAME:  my_image_sequence
+* FROM CLIP: /media/path/my_image_sequence.[1025-1060].ext
+* OTIO TRUNCATED REEL NAME FROM: my_image_sequence.[1025-1060].ext
+'''
+        rate = 24
+        tl1 = otio.adapters.read_from_string(trunced_edl1, 'cmx_3600', rate=rate)
+        self.assertIsInstance(tl1, otio.schema.Timeline)
+
+        clip1 = tl1.tracks[0][0]
+        media_ref1 = clip1.media_reference
+        self.assertIsInstance(media_ref1, otio.schema.ImageSequenceReference)
+        self.assertEqual(media_ref1.start_frame, 1025)
+        self.assertEqual(media_ref1.end_frame(), 1060)
+        self.assertEqual(
+            clip1.available_range(),
+            otio.opentime.range_from_start_end_time(
+                otio.opentime.from_timecode('01:00:01:00', rate),
+                otio.opentime.from_timecode('01:00:02:12', rate)
+            )
+        )
+
+        # Make sure regex works and uses ExternalReference for non sequences
+        trunced_edl2 = '''TITLE: Image Sequence Write
+
+001  myimages V     C        01:00:01:00 01:00:02:12 00:00:00:00 00:00:01:12
+* FROM CLIP NAME:  my_image_sequence
+* FROM CLIP: /media/path/my_image_file.1025.ext
+* OTIO TRUNCATED REEL NAME FROM: my_image_file.1025.ext
+'''
+
+        tl2 = otio.adapters.read_from_string(trunced_edl2, 'cmx_3600', rate=rate)
+        clip2 = tl2.tracks[0][0]
+        media_ref2 = clip2.media_reference
+        self.assertIsInstance(media_ref2, otio.schema.ExternalReference)
+
+        trunced_edl3 = '''TITLE: Image Sequence Write
+
+001  myimages V     C        01:00:01:00 01:00:02:12 00:00:00:00 00:00:01:12
+* FROM CLIP NAME:  my_image_sequence
+* FROM CLIP: /media/path/my_image_file.[1025].ext
+* OTIO TRUNCATED REEL NAME FROM: my_image_file.[1025].ext
+'''
+        tl3 = otio.adapters.read_from_string(trunced_edl3, 'cmx_3600', rate=rate)
+        clip3 = tl3.tracks[0][0]
+        media_ref3 = clip3.media_reference
+        self.assertIsInstance(media_ref3, otio.schema.ExternalReference)
+
+    def test_imagesequence_write(self):
+        rate = 24
+        tl = otio.schema.Timeline('Image Sequence Write')
+        track = otio.schema.Track('V1')
+        tl.tracks.append(track)
+
+        clip = otio.schema.Clip(
+            name='my_image_sequence',
+            source_range=otio.opentime.range_from_start_end_time(
+                otio.opentime.from_timecode('01:00:01:00', rate),
+                otio.opentime.from_timecode('01:00:02:12', rate)
+            ),
+            media_reference=otio.schema.ImageSequenceReference(
+                target_url_base='/media/path/',
+                name_prefix='my_image_sequence.',
+                name_suffix='.ext',
+                rate=rate,
+                start_frame=1001,
+                frame_zero_padding=4,
+                available_range=otio.opentime.range_from_start_end_time(
+                    otio.opentime.from_timecode('01:00:00:00', rate),
+                    otio.opentime.from_timecode('01:00:03:00', rate)
+                )
+            )
+        )
+        track.append(clip)
+
+        # Default behavior
+        result1 = otio.adapters.write_to_string(tl, 'cmx_3600', rate=rate)
+
+        expected_result1 = '''TITLE: Image Sequence Write
+
+001  myimages V     C        01:00:01:00 01:00:02:12 00:00:00:00 00:00:01:12
+* FROM CLIP NAME:  my_image_sequence
+* FROM CLIP: /media/path/my_image_sequence.[1025-1060].ext
+* OTIO TRUNCATED REEL NAME FROM: my_image_sequence.[1025-1060].ext
+'''
+        self.assertMultiLineEqual(result1, expected_result1)
+
+        # Only trunc extension in reel name
+        result2 = otio.adapters.write_to_string(
+            tl,
+            'cmx_3600',
+            rate=24,
+            reelname_len=None
+        )
+
+        expected_result2 = '''TITLE: Image Sequence Write
+
+001  my_image_sequence.[1025-1060] V     C        \
+01:00:01:00 01:00:02:12 00:00:00:00 00:00:01:12
+* FROM CLIP NAME:  my_image_sequence
+* FROM CLIP: /media/path/my_image_sequence.[1025-1060].ext
+'''
+        self.assertMultiLineEqual(result2, expected_result2)
+
     def test_dissolve_parse(self):
         tl = otio.adapters.read_from_file(DISSOLVE_TEST)
         self.assertEqual(len(tl.tracks[0]), 3)