New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

FCP X XML adapter #309

Merged
merged 11 commits into from Oct 1, 2018

Conversation

Projects
None yet
4 participants
@eric-with-a-c
Collaborator

eric-with-a-c commented Aug 14, 2018

This is a basic adapter for working with FCP X XMLs. While this adapter will handle basic FCP X projects, including compound clips, it does not, at present, support markers or video clips that have detached audio.

ffprobe is required to create FCP X XMLs from an otio without errors on import. If ffprobe is not available or is not in the path, then an error will be displayed in FCP X when importing the XML. However, the timeline will still look an function properly in FCP X.

#37

@codecov-io

This comment has been minimized.

Show comment
Hide comment
@codecov-io

codecov-io Aug 14, 2018

Codecov Report

Merging #309 into master will increase coverage by 0.11%.
The diff coverage is 92.47%.

Impacted file tree graph

@@           Coverage Diff            @@
##           master   #309      +/-   ##
========================================
+ Coverage   90.89%    91%   +0.11%     
========================================
  Files          53     55       +2     
  Lines        4512   4890     +378     
========================================
+ Hits         4101   4450     +349     
- Misses        411    440      +29
Impacted Files Coverage Δ
opentimelineio_contrib/adapters/fcpx_xml.py 92.19% <92.19%> (ø)
...lineio_contrib/adapters/tests/test_fcpx_adapter.py 96.15% <96.15%> (ø)
opentimelineio/plugins/manifest.py 90.47% <0%> (-2.03%) ⬇️
...neio_contrib/adapters/advanced_authoring_format.py 91.42% <0%> (+0.34%) ⬆️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 6f15035...4a5efd8. Read the comment docs.

codecov-io commented Aug 14, 2018

Codecov Report

Merging #309 into master will increase coverage by 0.11%.
The diff coverage is 92.47%.

Impacted file tree graph

@@           Coverage Diff            @@
##           master   #309      +/-   ##
========================================
+ Coverage   90.89%    91%   +0.11%     
========================================
  Files          53     55       +2     
  Lines        4512   4890     +378     
========================================
+ Hits         4101   4450     +349     
- Misses        411    440      +29
Impacted Files Coverage Δ
opentimelineio_contrib/adapters/fcpx_xml.py 92.19% <92.19%> (ø)
...lineio_contrib/adapters/tests/test_fcpx_adapter.py 96.15% <96.15%> (ø)
opentimelineio/plugins/manifest.py 90.47% <0%> (-2.03%) ⬇️
...neio_contrib/adapters/advanced_authoring_format.py 91.42% <0%> (+0.34%) ⬆️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 6f15035...4a5efd8. Read the comment docs.

@jminor

This comment has been minimized.

Show comment
Hide comment
@jminor

jminor Aug 14, 2018

Collaborator

Thanks @eric-with-a-c ! This is really helpful. We'll take a closer look when we get back from SIGGRAPH.

Collaborator

jminor commented Aug 14, 2018

Thanks @eric-with-a-c ! This is really helpful. We'll take a closer look when we get back from SIGGRAPH.

@ssteinbach

A few small things. We're also trying to find someone with a bit more FCPX experience to take a look, sorry this has taken a while to get around to.

@ssteinbach ssteinbach added this to the Public Beta 9 milestone Sep 7, 2018

@jminor

This comment has been minimized.

Show comment
Hide comment
@jminor

jminor Sep 29, 2018

Collaborator

So we were able to track down an expert on the FCP X XML format. Here is a summary of their comments & advice:

  • Since an FCP library can contain multiple sequences, the adapter could use a SerializableCollection of Timelines to hold several of them in one file.
  • You might want to keep the event name in some metadata so you can reconstruct the organization if you round trip back to FCP.
  • Using the lane position to build tracks makes sense.

Regarding the format information:

  • It should be possible to include assets without a format, but you need to provide one for a sequence.
  • There is a default of 720p60 for assets without a format.
Collaborator

jminor commented Sep 29, 2018

So we were able to track down an expert on the FCP X XML format. Here is a summary of their comments & advice:

  • Since an FCP library can contain multiple sequences, the adapter could use a SerializableCollection of Timelines to hold several of them in one file.
  • You might want to keep the event name in some metadata so you can reconstruct the organization if you round trip back to FCP.
  • Using the lane position to build tracks makes sense.

Regarding the format information:

  • It should be possible to include assets without a format, but you need to provide one for a sequence.
  • There is a default of 720p60 for assets without a format.
@eric-with-a-c

This comment has been minimized.

Show comment
Hide comment
@eric-with-a-c

eric-with-a-c Sep 30, 2018

Collaborator

Thanks for the feedback!

I added the use of a SerializableCollection of Timelines to account for the possibility of having more than 1 sequence in an event. I also played around with adding another SerializableCollection of SerializableCollections since an FCP X Library can have multiple events, which can have multiple sequences. However, otioview didn't seem to like that level of nesting, so I left it out for now.

Presently the event name is being stored as the SerializableCollection's name and then the SerailizableCollection's name is used to set the event name when round tripping. But I could make it a piece of metadata if that's the preferred way of handling that. Let me know if you'd like it changed.

That's good to know about the formats. Since we still need a format for the sequence, it looks like there's still a dependency on ffprobe.

Let me know if there is anything else that needs to be adjusted before merging.

Thanks again!

Collaborator

eric-with-a-c commented Sep 30, 2018

Thanks for the feedback!

I added the use of a SerializableCollection of Timelines to account for the possibility of having more than 1 sequence in an event. I also played around with adding another SerializableCollection of SerializableCollections since an FCP X Library can have multiple events, which can have multiple sequences. However, otioview didn't seem to like that level of nesting, so I left it out for now.

Presently the event name is being stored as the SerializableCollection's name and then the SerailizableCollection's name is used to set the event name when round tripping. But I could make it a piece of metadata if that's the preferred way of handling that. Let me know if you'd like it changed.

That's good to know about the formats. Since we still need a format for the sequence, it looks like there's still a dependency on ffprobe.

Let me know if there is anything else that needs to be adjusted before merging.

Thanks again!

@jminor

jminor approved these changes Oct 1, 2018

@jminor jminor removed request for reinecke and bashesenaxis Oct 1, 2018

@jminor jminor merged commit 59a60bb into PixarAnimationStudios:master Oct 1, 2018

1 check passed

continuous-integration/travis-ci/pr The Travis CI build passed
Details
@jminor

This comment has been minimized.

Show comment
Hide comment
@jminor

jminor Oct 1, 2018

Collaborator

@eric-with-a-c, thanks for the contribution!

Collaborator

jminor commented Oct 1, 2018

@eric-with-a-c, thanks for the contribution!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment