Wikipedia

OpenFX (API)

OpenFX (OFX), a.k.a. The OFX Image Effect Plug-in API, is an open standard for 2D visual effects or compositing plug-ins. It allows plug-ins written to the standard to work on any application that supports the standard. The OpenFX standard is owned by The Open Effects Association, and it is released under a 'BSD' open source license. OpenFX was originally designed by Bruno Nicoletti at The Foundry Visionmongers.

Plug-ins are written as dynamic shared objects, and the API specifies a few entry points that must be implemented by the plug-in.

The OpenFX host exposes sets of entry points to the plug-in, called suites. The Property Suite is used to manage attribute-value pairs attached to objects defined by all other suites of the API, the Image Effect Suite is used to fetch film frames from the inputs or the output of the effect, and there are other suites to display informative messages or ask questions to the user, handle multithreading, use OpenGL for processing, etc.

Each plugin is described by a list of parameters and supported inputs and output. The host may execute various actions, for example to signal that a parameter value has changed or that a portion of a film frame has to be rendered.

Optionally, the plug-in may also display graphical information over the current frame using OpenGL, and propose interactions using mouse and keyboard (this is called interacts in the OFX specification).

An OpenFX host is an application capable of loading and executing OpenFX plugins.

History

edit
  • UPDATE: Current version is 1.4 as of June 2017

OpenFX was first announced on Feb 10, 2004 The Foundry Visionmongers.[1]

The OpenFX specification was written so that a plugin supporting the latest version of the API may be implemented to be compatible with a host implementing an earlier version.

  1. OpenFX 1.0[2] was released in 2006.
  2. OpenFX 1.1[3] was released in 2007.
  3. OpenFX 1.2[4] was released in 2010.
  4. OpenFX 1.3[5] was released in 2012.
  5. OpenFX 1.4[6] was released in 2015.

Hosts

edit

Free and open source hosts

edit
  • ButtleOFX (for Linux, open source, LGPL license, alpha status, unmaintained)
  • Kaliscope (scanner controller/batch conversion tool based on OpenFX host and plugins, open source, GPL 3 license)
  • Natron for macOS, Linux, FreeBSD and Windows (open source, GPL license)
  • Ramen compositor (CDDL 1.0 license, never officially released, but source code is available[7])
  • ShuttleOFX (online OpenFX platform, open source, LGPL license)
  • TuttleOFX (command-line OpenFX host and plugins, open source, LGPL license)

Commercial hosts

edit

Discontinued:

OpenFX plug-ins

edit

Free and open source plugins

edit
  • The official OpenFX SDK (BSD license) contain sample plugins, programmed using the standard C API, or a C++ wrapper.
  • openfx-arena is a set of visual effects plugins, mainly based on ImageMagick.
  • openfx-io is a set of plugins for reading or writing image and video files (using OpenImageIO and FFmpeg), and for color management (using OpenColorIO).
  • openfx-misc is a collection of essential plugins, which provide many basic compositing tools, such as filters, geometric transforms, and color transforms. Commercial OpenFX hosts usually provide their own versions of these plugins.
  • TuttleOFX provides many plug-ins, especially for color grading, usable in most OpenFX hosts.
  • INK green/blue screen keyer and ChannelMath by casanico.com
  • TalentTracker by Mut1ny.com

Commercial plug-ins

edit

Extensions

edit

OpenFX' suite-based design enables one to easily introduce new sets of entry points, in order to cover other applications while still relying on the same core dynamic plug-in mechanism. A notable example is OpenMfx, an API based on OpenFX but meant to define procedural effects on 3D meshes rather than 2D images.[10] An host that supports the Image Effects API does not necessarily support the Mesh Effect API, and vice versa, but both support the same core plug-in mechanism and basic suites like the Property Suite or the Parameter Suite. OpenMfx is an initiative independent from The Open Effects Association, led by Élie Michel since 2019.[11]

Documentation

edit

References

edit
  1. ^ "OpenFX Visual Effects Plug-in Support Grows". Digital Video Editing. Retrieved 31 August 2016.
  2. ^ "The OFX Image Effect Plug-in API, 1.0, Programming Reference". OpenFX. Retrieved 10 June 2015.
  3. ^ "The OFX Image Effect Plug-in API, 1.1, Programming Reference". OpenFX. Retrieved 10 June 2015.
  4. ^ "The OFX Image Effect Plug-in API, 1.2, Programming Reference". OpenFX. Retrieved 10 June 2015.
  5. ^ "The OFX Image Effect Plug-in API, 1.3, Programming Reference". OpenFX. Retrieved 10 June 2015.
  6. ^ "The Open Effects Association Releases Version 1.4". OpenFX. Retrieved 28 October 2015.
  7. ^ "Original RamenHDR sourcecode". GitHub. Retrieved 10 June 2015.
  8. ^ "Film Convert home page". Film Convert. Retrieved 13 August 2015.
  9. ^ "Primatte for OFX". Primatte. Retrieved 10 June 2015.
  10. ^ Michel, Élie. "OpenMfx documentation". openmesheffect.org. Retrieved 2021-08-25.
  11. ^ "Initial commit · eliemichel/OpenMfx@ab2eef6". GitHub. Retrieved 2021-08-25.
edit
Retrieved from "https://en.wikipedia.org/w/index.php?title=OpenFX_(API)&oldid=1214556243"