Update to work on U5.5 (#4)

* Replace deprecated methods
clip_if and children_if have been deprecated in latest otio
schema.track was also removed

Signed-off-by: Mark Reid <[email protected]>

* Prevent sending None to load_or_create_level_seq
exception is aready caught in get_sub_sequence_path

Signed-off-by: Mark Reid <[email protected]>

* Only select standard frame rates,
and support for fractional rates like 23.976, 29.97 and 59.94

Signed-off-by: Mark Reid <[email protected]>

* Handle case where sub_seq could be None

Signed-off-by: Mark Reid <[email protected]>

* timeline.find_clip -> timeline.find_clips

Signed-off-by: runegan <[email protected]>

* Remove reference to master track and replace with track

master_track functions are depracted, we should use just track

Signed-off-by: runegan <[email protected]>

* fix time_scale for UE5.5

UE5.5 uses a MovieSceneTimeWarpVariant. We must convert from this or to this when getting/setting

Signed-off-by: runegan <[email protected]>

* Keep track of lock state in writable state

Previously this would always lock all shots.

Signed-off-by: runegan <[email protected]>

* Replace get_marked_frames with get_marked_frames_from_sequence

get_marked_frames is depracted

Signed-off-by: runegan <[email protected]>

* replace Track.Kind with Track.Kind

Signed-off-by: runegan <[email protected]>

---------

Signed-off-by: Mark Reid <[email protected]>
Signed-off-by: runegan <[email protected]>
Co-authored-by: Mark Reid <[email protected]>

Author: runegan

OpenTimelineIOUtilities/Content/Python/otio_unreal/adapter.py

@@ -64,7 +64,7 @@ def import_otio(
     # items (stacks and clips) to sub-sequences.
     run_pre_import_otio_item_hook(timeline.tracks)
 
-    for item in timeline.children_if():
+    for item in timeline.find_children():
         if isinstance(item, (otio.schema.Stack, otio.schema.Clip)):
             run_pre_import_otio_item_hook(item)
 
@@ -127,7 +127,7 @@ def export_otio(filepath, level_seq, dry_run=False):
     # map unreal metadata to rendered outputs.
     timeline = run_post_export_otio_hook(timeline)
 
-    for clip in timeline.clip_if():
+    for clip in timeline.find_clips():
         # Implementation-defined clip update to inject a media reference
         # that maps unreal metadata to a rendered output.
         run_post_export_otio_clip_hook(clip)

OpenTimelineIOUtilities/Content/Python/otio_unreal/level_sequence.py

@@ -47,19 +47,21 @@ def writable(self):
         is_read_only = self.level_seq.is_read_only()
         self.level_seq.set_read_only(False)
 
+        section_status = []
         # Unlock shot tracks
         shot_track = self.get_shot_track()
         if shot_track is not None:
             for section in shot_track.get_sections():
+                section_status.append(section.is_locked())
                 section.set_is_locked(False)
 
         yield
 
         # Lock all shot tracks
         shot_track = self.get_shot_track()
         if shot_track is not None:
-            for section in shot_track.get_sections():
-                section.set_is_locked(True)
+            for section, lock_state in zip(shot_track.get_sections(), section_status):
+                section.set_is_locked(lock_state)
 
         # Restore level sequence read-only state
         self.level_seq.set_read_only(is_read_only)
@@ -73,7 +75,7 @@ def get_shot_track(self):
             unreal.MovieSceneCinematicShotTrack: Shot track, if found,
                 otherwise None.
         """
-        shot_tracks = self.level_seq.find_master_tracks_by_exact_type(
+        shot_tracks = self.level_seq.find_tracks_by_exact_type(
             unreal.MovieSceneCinematicShotTrack
         )
         if shot_tracks:
@@ -91,15 +93,49 @@ def get_frame_rate(self):
 
         return float(display_rate.numerator) / float(display_rate.denominator)
 
+    def get_nearest_rate(self, frame_rate):
+        """Convert a float frame rate to an exact fraction
+        Args:
+            frame_rate (float): Frames per second
+        """
+        # rates are from the sequencer display rate menu
+        rates = ((12,       1),
+                 (15,       1),
+                 (24000, 1001),
+                 (24,       1),
+                 (25,       1),
+                 (30000, 1001),
+                 (30,       1),
+                 (48,       1),
+                 (60000, 1001),
+                 (50,       1),
+                 (60,       1),
+                 (100,      1),
+                 (120,      1),
+                 (240,      1))
+
+        nearest = None
+        min_diff = float('inf')
+        for i, (num, den) in enumerate(rates):
+            valid_rate = float(num)/float(den)
+            if frame_rate == valid_rate:
+                return unreal.FrameRate(numerator=num, denominator=den)
+
+            diff = abs(frame_rate - valid_rate)
+            if (diff >= min_diff):
+                continue
+            min_diff = diff
+            nearest = [num, den]
+
+        return unreal.FrameRate(numerator=nearest[0], denominator=nearest[1])
+
     def set_frame_rate(self, frame_rate):
         """Set frame rate (frames per second).
 
         Args:
             frame_rate (float): Frames per second
         """
-        self.level_seq.set_display_rate(
-            unreal.FrameRate(numerator=frame_rate, denominator=1)
-        )
+        self.level_seq.set_display_rate(self.get_nearest_rate(frame_rate))
 
     def get_ticks_per_frame(self):
         """Calculate ticks per frame.
@@ -280,7 +316,7 @@ def update_markers(self, parent_item):
         if parent_item.markers:
             parent_item.markers.clear()
 
-        for frame_marker in self.level_seq.get_marked_frames():
+        for frame_marker in self.level_seq.get_marked_frames_from_sequence():
             # Convert from frame number at tick resolution
             frame = frame_marker.frame_number.value // self.get_ticks_per_frame()
             marked_range = TimeRange(
@@ -377,7 +413,7 @@ def update_stack(self, parent_stack):
         multi_track = len(row_sections) > 1
 
         for row_idx, sections in sorted(row_sections.items()):
-            video_track = otio.schema.Track(kind=otio.schema.track.TrackKind.Video)
+            video_track = otio.schema.Track(kind=otio.schema.Track.Kind.Video)
 
             # Name track if possible
             if not multi_track:
@@ -489,7 +525,7 @@ def update_from_stack(self, parent_stack):
             shot_track = self.get_shot_track()
 
             if shot_track is None:
-                shot_track = self.level_seq.add_master_track(
+                shot_track = self.level_seq.add_track(
                     unreal.MovieSceneCinematicShotTrack
                 )
 
@@ -509,7 +545,7 @@ def update_from_stack(self, parent_stack):
             # Video tracks are stacked in reverse in a timeline, with the lowest
             # index at the bottom.
             for row_index, track in enumerate(reversed(parent_stack)):
-                if track.kind != otio.schema.track.TrackKind.Video:
+                if track.kind != otio.schema.TrackKind.Video:
                     continue
 
                 # Name track if possible
@@ -525,9 +561,8 @@ def update_from_stack(self, parent_stack):
                         continue
 
                     # Clip or Stack: Update or create section
-                    try:
-                        sub_seq_path = get_sub_sequence_path(item)
-                    except KeyError:
+                    sub_seq_path = get_sub_sequence_path(item)
+                    if not sub_seq_path:
                         continue
 
                     if (
@@ -540,10 +575,15 @@ def update_from_stack(self, parent_stack):
                         sub_seq = section.get_sequence()
                     else:
                         sub_seq = load_or_create_level_seq(sub_seq_path)
+                        if not sub_seq:
+                            continue
 
                         section = shot_track.add_section()
                         section.set_sequence(sub_seq)
 
+                    if not sub_seq:
+                        continue
+
                     section_proxy = ShotSectionProxy(section, self)
                     sub_seq_proxy = LevelSequenceProxy(sub_seq, section_proxy)
 

OpenTimelineIOUtilities/Content/Python/otio_unreal/shot_section.py

@@ -52,7 +52,10 @@ def get_time_scale(self):
         Returns:
             float: Time scalar
         """
-        return self.section.parameters.time_scale
+        time_scale = self.section.parameters.time_scale
+        if hasattr(unreal, 'MovieSceneTimeWarpVariant'):  # UE 5.5+
+            time_scale = time_scale.to_fixed_play_rate()
+        return time_scale
 
     def set_time_scale(self, time_scale):
         """Set this section's time scale, which scales the playback
@@ -61,6 +64,9 @@ def set_time_scale(self, time_scale):
         Args:
             time_scale (float): Time scale value
         """
+        if hasattr(unreal, 'MovieSceneTimeWarpVariant'):
+            time_scale = unreal.MovieSceneTimeWarpVariant(time_scale)
+
         self.section.parameters.time_scale = time_scale
 
     def get_range_in_parent(self):

OpenTimelineIOUtilities/Content/Python/otio_unreal/util.py

@@ -52,7 +52,7 @@ def get_level_seq_references(timeline, level_seq=None):
 
     level_seq_refs = [(root_level_seq_path, timeline)]
 
-    for item in timeline.children_if():
+    for item in timeline.find_children():
         if not isinstance(item, (otio.schema.Stack, otio.schema.Clip)):
             continue
 

tests/test_otio_unreal.py

@@ -427,7 +427,7 @@ def test_roundtrip(self):
         out_timeline.tracks.metadata.clear()
         set_sub_sequence_path(out_timeline.tracks, root_level_seq_path)
 
-        for item in out_timeline.children_if():
+        for item in out_timeline.find_children():
             level_seq_path = get_sub_sequence_path(item)
             if level_seq_path is not None: