OpenTimelineIO
Main web site: http://opentimeline.io/
Documentation: https://opentimelineio.readthedocs.io/
GitHub: https://github.com/PixarAnimationStudios/OpenTimelineIO
Discussion group: https://lists.aswf.io/g/otio-discussion
Slack channel: https://academysoftwarefdn.slack.com/messages/CMQ9J4BQC To join, create an account here first: https://slack.aswf.io/
PUBLIC BETA NOTICE
OpenTimelineIO is currently in Public Beta. That means that it may be missing some essential features and there are large changes planned. During this phase we actively encourage you to provide feedback, requests, comments, and/or contributions.
Overview
OpenTimelineIO is an interchange format and API for editorial cut information. OTIO is not a container format for media, rather it contains information about the order and length of cuts and references to external media.
OTIO includes both a file format and an API for manipulating that format. It also includes a plugin architecture for writing adapters to convert from/to existing editorial timeline formats. It also implements a dependency- less library for dealing strictly with time, opentime.
You can provide adapters for your video editing tool or pipeline as needed. Each adapter allows for import/export between that proprietary tool and the OpenTimelineIO format.
Documentation
Documentation, including quick start, architecture, use cases, API docs, and much more, is available on ReadTheDocs
Supported VFX Platforms
The current release supports:
- VFX platform 2021, 2020, 2019, 2018
- Python 2.7 - 3.9
- Notice that Python 2.7 is deprecated & we plan to drop it in OTIO release 0.15
For more information on our vfxplatform support policy: Contribution Guidelines Documentation Page For more information on the vfxplatform: VFX Platform Homepage
Adapters
OpenTimelineIO supports, or plans to support, conversion adapters for many existing file formats, such as Final Cut Pro XML, AAF, CMX 3600 EDL, etc.
See: https://opentimelineio.readthedocs.io/en/latest/tutorials/adapters.html
Other Plugins
OTIO also supports several other kinds of plugins, for more information see:
- Media Linkers - Generate media references to local media according to your local conventions.
- HookScripts - Scripts that can run at various points during OTIO execution (ie before the media linker)
- SchemaDefs - Define OTIO schemas.
Installing / Quick-Start
The python-wrapped version of OpenTimelineIO is publicly available via pypy. You can install OpenTimelineIO via:
python -m pip install opentimelineio
For detailed installation instructions and notes on how to run the included viewer program, see: https://opentimelineio.readthedocs.io/en/latest/tutorials/quickstart.html
Example Usage
import opentimelineio as otio
timeline = otio.adapters.read_from_file("foo.aaf")
for clip in timeline.each_clip():
print(clip.name, clip.duration())
There are more code examples here: https://github.com/PixarAnimationStudios/OpenTimelineIO/tree/main/examples
Also, looking through the unit tests is a great way to see what OTIO can do: https://github.com/PixarAnimationStudios/OpenTimelineIO/tree/main/tests
OTIO includes a viewer program as well (see the quickstart section for instructions on installing it):
Developing
If you want to contribute to the project, please see: https://opentimelineio.readthedocs.io/en/latest/tutorials/contributing.html
You can get the latest development version via:
git clone [email protected]:PixarAnimationStudios/OpenTimelineIO.git --recursive
You can install development dependencies with python -m pip install .[dev]
You can also install the PySide2 dependency with python -m pip install .[view]
You may need to escape the [ depending on your shell, \[view\] .
Currently the code base is written against python 2.7, 3.7, 3.8 and 3.9, in keeping with the pep8 style. We ask that before developers submit pull request, they:
- run
make test-- to ensure that none of the unit tests were broken - run
make lint-- to ensure that coding conventions conform to pep8 - run
make coverage-- to detect code which isn't covered
PEP8: https://www.python.org/dev/peps/pep-0008/
For advanced developers, arguments can be passed to CMake through the pip commandline by using the CMAKE_ARGS environment variable.
*nix Example:
env CMAKE_ARGS="-DCMAKE_VAR=VALUE1 -DCMAKE_VAR_2=VALUE2" pip install .
Additionaly, to reproduce CI failures regarding the file manifest, run: make manifest locally to run the python check-manifest program.
C++ Coverage Builds
To enable C++ code coverage reporting via gcov/lcov for builds, set the following environment variables:
OTIO_CXX_COVERAGE_BUILD=ONOTIO_CXX_BUILD_TMP_DIR=path/to/build/dir
When building/installing through pip/setup.py, these variables must be set before running the install command (python -m pip install . for example).
License
OpenTimelineIO is open source software. Please see the LICENSE.txt for details.
Nothing in the license file or this project grants any right to use Pixar or any other contributor’s trade names, trademarks, service marks, or product names.
Contact
For more information, please visit http://opentimeline.io/ or https://github.com/PixarAnimationStudios/OpenTimelineIO or join our discussion forum: https://lists.aswf.io/g/otio-discussion
8 Dec 20, 2022
15 Nov 30, 2022
47 Dec 19, 2022
3 Dec 14, 2022
7 Aug 24, 2022
3 Feb 15, 2022
18 Nov 12, 2022
1 Nov 15, 2021
5 Feb 06, 2022
23 Nov 09, 2022
22 Apr 08, 2021
6 Jun 27, 2022
7 Mar 24, 2022
5 Mar 16, 2022
1 Nov 18, 2021
51 Dec 10, 2022
2 Oct 11, 2021
4 Jan 15, 2022
4 Jun 10, 2022
31 Nov 12, 2022