Skip to content

Commit

Permalink
Merge pull request #9 from OpenTimelineIO/doc_update
Browse files Browse the repository at this point in the history
Documentation updates
  • Loading branch information
darbyjohnston authored Nov 9, 2024
2 parents 37d86a3 + c083ae6 commit 0b3c379
Show file tree
Hide file tree
Showing 9 changed files with 11 additions and 382 deletions.
21 changes: 11 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,14 +4,23 @@

Toucan
======
Toucan is an experimental project for rendering OpenTimelineIO files. The
project currently consists of:
Toucan is a software renderer for OpenTimelineIO files. Toucan can render an
OpenTimelineIO file with multiple tracks, clips, transitions, and effects
into an image sequence or movie file.

The project currently consists of:
* C++ library for rendering timelines
* Collection of OpenFX image effect plugins
* Command line renderer
* Interactive viewer
* Example .otio files

Current limitations:
* Audio is not yet supported
* Nested timelines are not yet supported
* Outputting movie files currently relies on the FFmpeg command line program
(see below: FFmpeg Encoding)

Toucan relies on the following libraries:
* [OpenTimelineIO](https://github.com/PixarAnimationStudios/OpenTimelineIO)
* [OpenFX](https://github.com/AcademySoftwareFoundation/openfx)
Expand All @@ -38,8 +47,6 @@ Compositing multiple tracks:

![CompositeTracks](images/CompositeTracks.png)

![Composite Tracks Graph](images/CompositeTracksGraph.svg)

Filter effects; color map, invert, power, saturate, blur, and unsharp mask:

![Filters](images/Filter.png)
Expand All @@ -64,14 +71,10 @@ Dissolve transition:

![Transition](images/Transition.png)

![Transition Graph](images/TransitionGraph.svg)

Dissolve transition with an invert effect on the clips:

![Transition 2](images/Transition2.png)

![Transition 2 Graph](images/Transition2Graph.svg)

Wipe transitions:

![Transition Wipe](images/TransitionWipe.png)
Expand All @@ -88,8 +91,6 @@ Multiple effects on clips, tracks, and stacks:

![Track Effects](images/MultipleEffects.png)

![Multiple Effects Graph](images/MultipleEffectsGraph.svg)

FFmpeg Encoding
===============
Toucan can output rendered images directly to FFmpeg for encoding. The
Expand Down
12 changes: 0 additions & 12 deletions images/CompositeTracksGraph.dot

This file was deleted.

67 changes: 0 additions & 67 deletions images/CompositeTracksGraph.svg

This file was deleted.

16 changes: 0 additions & 16 deletions images/MultipleEffectsGraph.dot

This file was deleted.

91 changes: 0 additions & 91 deletions images/MultipleEffectsGraph.svg

This file was deleted.

16 changes: 0 additions & 16 deletions images/Transition2Graph.dot

This file was deleted.

91 changes: 0 additions & 91 deletions images/Transition2Graph.svg

This file was deleted.

12 changes: 0 additions & 12 deletions images/TransitionGraph.dot

This file was deleted.

Loading

0 comments on commit 0b3c379

Please sign in to comment.