• Stars
    star
    1,440
  • Rank 32,467 (Top 0.7 %)
  • Language
    Python
  • License
    Apache License 2.0
  • Created about 8 years ago
  • Updated about 2 months ago

Reviews

There are no reviews yet. Be the first to send feedback to the community and the maintainers!

Repository Details

Open Source API and interchange format for editorial timeline information.

OpenTimelineIO

OpenTimelineIO

Supported VFX Platform Versions Supported Versions Build Status codecov docs CII Best Practices

Links

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 contains information about the order and length of cuts and references to external media. It is not however, a container format for media.

For integration with applications, the core OTIO library is implemented in C++ and provides an in-memory data model, as well as library functions for interpreting, manipulating, and serializing that data model. Within the core is a dependency-less library for dealing strictly with time, opentime.

The project also supports an official python binding, which is intended to be an idiomatic and ergonomic binding for python developers. The python binding includes a plugin system which supports a number of different types of plugins, most notably adapters, which can be used to read and write legacy formats into the OTIO data model.

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 2023, 2022, 2021, 2020
  • Python 3.7 - 3.10

For more information on our vfxplatform support policy: Contribution Guidelines Documentation Page For more information on the vfxplatform: VFX Platform Homepage

Adapter Plugins

To provide interoperability with other file formats or applications lacking a native integration, the opentimelineio community has built a number of python adapter plugins. This includes Final Cut Pro XML, AAF, CMX 3600 EDL, and more.

For more information about this, including supported formats, see: https://opentimelineio.readthedocs.io/en/latest/tutorials/adapters.html

Other Plugins

The OTIO python bindings also support 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 PyPI. 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

C++:

#include <iostream>

#include "opentimelineio/timeline.h"

namespace otio = opentimelineio::OPENTIMELINEIO_VERSION;

void
main()
{
    otio::ErrorStatus err;
    otio::SerializableObject::Retainer<otio::Timeline> tl(
            dynamic_cast<otio::Timeline*>(
                otio::Timeline::from_json_file("taco.otio", &err)
        )
    );
    const std::vector<otio::SerializableObject::Retainer<otio::Clip>> clips = (
            tl->find_clips()
    );
    for (const auto& cl : clips)
    {
        otio::RationalTime dur = cl->duration();
        std::cout << "Name: " << cl->name() << " [";
        std::cout << dur.value() << "/" << dur.rate() << "]" << std::endl;
    }
}

Python:

import opentimelineio as otio

timeline = otio.adapters.read_from_file("foo.aaf")
for clip in timeline.find_clips():
  print(clip.name, clip.duration())

There are more code examples here: https://github.com/AcademySoftwareFoundation/OpenTimelineIO/tree/main/examples

Also, looking through the unit tests is a great way to see what OTIO can do: https://github.com/AcademySoftwareFoundation/OpenTimelineIO/tree/main/tests

OTIO includes a viewer program as well (see the quickstart section for instructions on installing it):

OTIO View Screenshot

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]:AcademySoftwareFoundation/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 3.7, 3.8, 3.9, 3.10 and 3.11, 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=ON
  • OTIO_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/AcademySoftwareFoundation/OpenTimelineIO or join our discussion forum: https://lists.aswf.io/g/otio-discussion

More Repositories

1

openvdb

OpenVDB - Sparse volume data structure and tools
C++
2,475
star
2

OpenShadingLanguage

Advanced shading language for production GI renderers
C++
2,078
star
3

OpenImageIO

Reading, writing, and processing images in a wide variety of file formats, using a format-agnostic API, aimed at VFX applications.
C++
1,952
star
4

MaterialX

MaterialX is an open standard for the exchange of rich material and look-development content across applications and renderers.
C++
1,830
star
5

OpenColorIO

A color management framework for visual effects and animation.
C++
1,763
star
6

openexr

The OpenEXR project provides the specification and reference implementation of the EXR file format, the professional-grade image storage format of the motion picture industry.
C
1,607
star
7

rez

An integrated package configuration, build and deployment system for software
Python
939
star
8

OpenCue

A render management system you can deploy for visual effects and animation productions.
Python
824
star
9

xstudio

xSTUDIO is a modern, high performance and feature rich playback and review application designed for organisations and individuals in the post production, VFX and Animation industries.
C++
628
star
10

OpenRV

Open source version of RV, the Sci-Tech award-winning media review and playback software.
C++
548
star
11

OpenPBR

Specification and reference implementation for the OpenPBR Surface shading model
CSS
430
star
12

openfx

OpenFX effects API
C++
406
star
13

Imath

Imath is a C++ and python library of 2D and 3D vector, matrix, and math operations for computer graphics
C++
373
star
14

OpenColorIO-Config-ACES

Python
263
star
15

aswf-docker

Common container configuration
Python
149
star
16

rawtoaces

RAW to ACES Utility
C++
141
star
17

aswf-landscape

🌄Landscape for popular open source projects used in the motion picture industry. This interactive landscape similar to that of the CNCF Landscape (https://l.cncf.io/) that sorts through popular open source projects used for visual effects, animation, and image creation, and shows details including GitHub stars, funding or market cap, first and last commits, contributor count and many more.
121
star
18

openexr-images

Collection of images associated with the OpenEXR distribution
98
star
19

tac

Materials and meeting notes for the ASWF Technical Advisory Council (TAC)
HTML
93
star
20

wg-usd

USD Working Group collaboration and resources
61
star
21

OpenImageIO-images

OpenImageIO test images
Shell
37
star
22

EncodingGuidelines

This site provides guidelines for encoding frames to movie files for review.
Dockerfile
32
star
23

foundation

Academy Software Foundation foundation level resources, such as the charter, FAQ about the project, and other public assets
Python
17
star
24

archived-ci-management

Archived -- April 29, 2020 -- Jenkins job and cloud configuration
Shell
16
star
25

opencue.io

Source for OpenCue website
HTML
15
star
26

aswf-sample-project

ASWF Sample Project
CMake
13
star
27

openvdb-website

The source code behind https://www.openvdb.org
JavaScript
13
star
28

wg-python3

Python 3 Working Group
12
star
29

ori-shared-platform

Python
12
star
30

artwork

🎨ASWF related logos and artwork
HTML
8
star
31

dpel-website

Website for the Digital Production Example Library
Astro
7
star
32

wg-ci

ASWF Continuous Integration Working Group
7
star
33

ColorInterop

Color Interop Forum
7
star
34

openexr-examples

Example code using the OpenEXR library
C++
6
star
35

wg-review-approval

Review and Approval WG
4
star
36

materialx-website

Source files for www.materialx.org
HTML
3
star
37

aswf-sample-wg

Repository template for a working group
3
star
38

openreviewinitiative-test

Test for CLAs for Open Review Initiative
2
star
39

rez-test

2
star
40

openexr-website

The OpenEXR website
1
star
41

Imath-website

The Imath website
1
star
42

wg-assets

Asset Repository WG
1
star