📦 Improve: Expose Timeline.findClips

Author: mikemahony

Sources/objc/include/opentimelineio.h

@@ -202,6 +202,8 @@ CxxTimeRange timeline_range_of_child(CxxRetainer* self, CxxRetainer* child, CxxE
 NSArray* timeline_audio_tracks(CxxRetainer* self);
 NSArray* timeline_video_tracks(CxxRetainer* self);
 
+NSArray* timeline_find_clips(CxxRetainer* self, CxxErrorStruct* cxxErr);
+
 // MARK: - Track
 NSString* track_get_kind(CxxRetainer* self);
 void track_set_kind(CxxRetainer* self, NSString*);

Sources/objc/opentimelineio.mm

@@ -717,6 +717,15 @@ CxxTimeRange timeline_range_of_child(CxxRetainer* self, CxxRetainer* child, CxxE
     return array;
 }
 
+NSArray* timeline_find_clips(CxxRetainer* self, CxxErrorStruct* cxxErr) {
+    auto array = [NSMutableArray new];
+    _AutoErrorHandler aeh(cxxErr);
+    for (auto t: SO_cast<otio::Timeline>(self)->find_clips(&aeh.error_status)) {
+        [array addObject: [NSValue valueWithPointer: t]];
+    }
+    return array;
+}
+
 // MARK: - Track
 NSString* track_get_kind(CxxRetainer* self) {
     return make_nsstring(SO_cast<otio::Track>(self)->kind());

Sources/swift/Timeline.swift

@@ -77,6 +77,17 @@ public class Timeline : SerializableObjectWithMetadata {
         return try OTIOError.returnOrThrow { TimeRange(timeline_range_of_child(self, child, &$0)) }
     }
 
+    public func findClips() throws -> [Clip] {
+        let children_array = try OTIOError.returnOrThrow { timeline_find_clips(self, &$0) }
+        var result = [Clip]()
+        for child in children_array {
+            if let nsptr = child as? NSValue, let cxxPtr = nsptr.pointerValue {
+                result.append(SerializableObject.findOrCreate(cxxPtr: cxxPtr) as! Clip)
+            }
+        }
+        return result
+    }
+
     override internal init(_ cxxPtr: CxxSerializableObjectPtr) {
         super.init(cxxPtr)
     }

Tests/OpenTimelineIOTests/testTimeline.swift

@@ -10,6 +10,10 @@ import XCTest
 import Foundation
 
 final class testTimeline: XCTestCase {
+    enum Error: Swift.Error {
+        case SetupFailed(String)
+    }
+
     override func setUpWithError() throws {
     }
 
@@ -78,5 +82,46 @@ final class testTimeline: XCTestCase {
             XCTFail("Cannot read OTIO file `\(timelineInputPath)`: \(error)")
         }
     }
+
+    func testTimelineFindClips() throws {
+        // SETUP
+        let timeline = try timeline(from: "data/nested_example.otio")
+
+        // EXERCISE
+        let clips = try timeline.findClips()
+
+        // VERIFY
+        XCTAssertEqual(
+            clips.map(\.name), 
+            [
+                "Normal Clip 1",
+                "Clip Inside A Stack 1",
+                "Normal Clip 2", 
+                "Clip Inside A Stack 2", 
+                "Normal Clip 3", 
+                "Clip Inside A Track", 
+                "Normal Clip 4"
+            ]
+        )
+    }
+
+    func timeline(from inputFilePath: String) throws -> Timeline {
+        guard let timelineInputPath = Bundle.module.path(forResource: inputFilePath, ofType: "") else {
+            throw Error.SetupFailed("Missing test data `\(inputFilePath)`")
+        }
+
+        do {
+            let otio = try SerializableObject.fromJSON(filename: timelineInputPath)
+
+            guard let timeline = otio as? Timeline else {
+                throw Error.SetupFailed("Could not create Timeline object from \(timelineInputPath)")
+            }
+
+            return timeline
+
+        } catch let error {
+            throw Error.SetupFailed("Cannot read OTIO file `\(timelineInputPath)`: \(error)")
+        }
+    }
 
 }