added otiodiff description and example to otiotool description, fixed typo in inspect example, and updated otiodiff function call from main to diff

Author: cato-o

src/py-opentimelineio/opentimelineio/console/otiotool.py

@@ -116,21 +116,22 @@ def main():
         for timeline in timelines:
             copy_media_to_folder(timeline, args.copy_media_to_folder)
 
-    # TODO: Update help text and numbering
+    # TODO: Update numbering
     # ===== NEW Phase 5.5: Diff otio files ======
 
     if args.diff:
-        # TODO: check there's exactly 2 timelines, complain if not
-        # error if less than 2, if more than 2
         # TODO? stack, concat, diff make mutually exclusive
 
         # print("comparing:", timelines[0].name, timelines[1].name)
+        assert len(timelines) >= 2, "Less than 2 timelines given. 2 timelines are required to perform a diff"
 
-        # function that serves as wrapper to call actual getDiff main
-        timelines = [diff_otio(timelines[0], timelines[1])]
-
-        # TODO: warning? if timeline empty (no output)
-        # TODO: test for empty timeline inputs
+        # TODO: test for empty timeline inputs, currently checks for existence of timeline but not of tracks in timeline
+        if len(timelines) == 2:    
+            timelines = [diff_otio(timelines[0], timelines[1])]
+            if len(timelines) == 0:
+                print("no output timeline generated by diff")
+        else:
+            print("Warning: more than 2 timelines provided as input. Only the first two timelines will be diffed.")
 
     # Phase 6: Remove/Redaction
 
@@ -227,6 +228,11 @@ def parse_arguments():
     If specified, the --redact option, will remove ALL metadata and rename all
     objects in the OTIO with generic names (e.g. "Track 1", "Clip 17", etc.)
 
+5.5 Diff
+    The --diff option allows you to compare two OTIO files. It generates an
+    OTIO file annotated with the differences as well as a in console text
+    summary report. --diff can't be used concurrently with --stack or --concat
+
 6. Inspect
     Options such as --stats, --list-clips, --list-tracks, --list-media,
     --verify-media, --list-markers, --verify-ranges, and --inspect
@@ -251,13 +257,14 @@ def parse_arguments():
 otiotool -i playlist.otio --verify-media
 
 Inspect specific audio clips in detail:
-otiotool -i playlist.otio --only-audio --list-tracks --inspect "Interview"
+otiotool -i playlist.otio --audio-only --list-tracks --inspect "Interview"
+
+Diff fileB against fileA (ordering matters where fileA is the file fileB compares against):
+otiotool -i fileA.otio fileB.otio --diff --o display.otio
 """,
         formatter_class=argparse.RawDescriptionHelpFormatter
     )
 
-# TODO: add ex for otiodiff above^
-
     # Input...
     parser.add_argument(
         "--input",
@@ -514,7 +521,7 @@ def read_inputs(input_paths):
 # ======= NEW =======
 
 def diff_otio(tlA, tlB):
-    return getDiff.main(tlA, tlB)
+    return getDiff.diff(tlA, tlB)
 
 # ===================