Add ImageSequenceReference schema to OpenTimelineIO #722
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Added ImageSequenceReference MediaReference subclass schema.
* * Added initial support for `ImageSequenceReference` * * Added sample otio file with `ImageSequenceReference` * Added test for creating an rv session file with the sample file above * * Use the `frame_zero_padding` from the `ImageSequenceReference` in stead of `start_frame` for frame substitution base * * renamed _in and _out variables * * lint fix
* * create and delete temp file and file descriptors through `setUp()` and `tearDown()` methods to prevent fd leak * * Close tmp file descriptor in `setUp()` to avoid trouble in Windows * Removed redundant assertions as suggested in PR comments
* Added support for ImageSequenceReference to the example OTIO RV reader plugin * Removed debug print * Switched to using opentime.to_frames to compute rv's in and out frames Co-authored-by: Robyn Rindge <[email protected]>
Codecov Report
@@ Coverage Diff @@
## master #722 +/- ##
==========================================
+ Coverage 81.88% 83.21% +1.33%
==========================================
Files 72 74 +2
Lines 2755 2884 +129
==========================================
+ Hits 2256 2400 +144
+ Misses 499 484 -15
Continue to review full report at Codecov.
|
ssteinbach
requested changes
May 28, 2020
Comment on lines
361
to
367
| *documentation*: | ||
|
|
||
| ``` | ||
| None | ||
| ``` | ||
|
|
||
| parameters: |
There was a problem hiding this comment.
can we get some of the documentation to flow through the python bindings?
There was a problem hiding this comment.
Added docstrings in the bindings. I'd love to have someone give feedback on wether or not it all makes sense. The bulk of the content is forklifted from this PR.
|
I think the build failure is a transient error, the python3.6 build just needs to be re-run. |
palemieux
reviewed
Jun 13, 2020
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This resolves #69
The image sequence is expressed with:
target_url_base- everything leading up to the file name in thetarget_urlname_prefix- everything in the file name leading up to the frame numbername_suffix- everything after the frame number in the file namestart_frame- first frame number used in file namesframe_step- step between frame numbers in file names (every other frame is a step of 2)rate- double frame rate if every frame in the sequence were played back (ignoring skip frames)frame_zero_padding- Number of digits to pad zeros out to (e.x. frame 10 with a pad of 4 would be0010)missing_frame_policy- enumImageSequenceReference.MissingFramePolicy{error,hold,black} allows hinting about how a consuming app should behave if an image for which a url is returned should be handled when missing from diskAn example for 24fps media with a sample provided each frame numbered 1-1000 with a path
/show/sequence/shot/sample_image_sequence.%04d.exrmight be:The same duration sequence but with only every 2nd frame available in the sequence would be:
A target url is generated using the equivalent of the following python format string:
f"{target_url_prefix}{(start_frame + (sample_number * frame_step)):0{value_zero_padding}}{target_url_postfix}"Negative
start_frameis also handled. The above example with astart_frameof-1would yield the first three target urls as:file:///show/sequence/shot/sample_image_sequence.-0001.exrfile:///show/sequence/shot/sample_image_sequence.-0000.exrfile:///show/sequence/shot/sample_image_sequence.0001.exrBenefits of this approach include:
Downsides:
References:
Related PRs:
ImageSequenceReferenceproposalimagesequencebranch, C++ implementation and discussionImageSequenceReferencein RVCo-authored by: @apetrynet