Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ Committee provides general project oversight.
There are several ways to connect with the OpenFX project:

* The [openfx-discussion](https://lists.aswf.io/g/openfx-discussion)
mail list: This is our primary mailing list, intended for techical
mail list: This is our primary mailing list, intended for technical
discussion and help implementing and using OpenFX.

* [GitHub Issues](https://github.com/ofxa/openfx/issues): GitHub
Expand Down
2 changes: 1 addition & 1 deletion Documentation/sourceforge/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ <h3>Programming Reference </h3>

<h3>Doxygen Documentation </h3>
<para>
The doxygen documentation extracted from the header files is a useful adjunct to the programmming reference. It is available in two forms...
The doxygen documentation extracted from the header files is a useful adjunct to the programming reference. It is available in two forms...
<ul>
<li><a href="Doxygen/index.html">A set of HTML files, one per section,</a></li>
<li><a href="ofxDoxygenDocs_1.3.tgz">A tarball of the set of HTML files (229K).</a></li>
Expand Down
6 changes: 3 additions & 3 deletions Documentation/sources/Guide/Code/Example1/basics.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -86,7 +86,7 @@ namespace {
int gNumInstancesLiving = 0;

////////////////////////////////////////////////////////////////////////////////
// The first _action_ called after the binary is loaded (three boot strapper functions will be howeever)
// The first _action_ called after the binary is loaded (three boot strapper functions will be however)
OfxStatus LoadAction(void)
{
ERROR_ABORT_IF(gHost == NULL, "The OfxHost pointer has not been set, it should have been set in 'setHostFunc' before any action is called.");
Expand Down Expand Up @@ -152,7 +152,7 @@ namespace {
char *context;
gPropertySuite->propGetString(inArgs, kOfxImageEffectPropContext, 0, &context);

ERROR_IF(strcmp(context, kOfxImageEffectContextFilter) != 0, "DescribeInContextAction called on unsupported contex %s", context);
ERROR_IF(strcmp(context, kOfxImageEffectContextFilter) != 0, "DescribeInContextAction called on unsupported context %s", context);

OfxPropertySetHandle props;
// define the mandated single output clip
Expand Down Expand Up @@ -300,7 +300,7 @@ namespace {
static OfxPlugin effectPluginStruct =
{
kOfxImageEffectPluginApi, // The API this plugin satisfies.
1, // The version of the API it satisifes.
1, // The version of the API it satisfies.
"org.openeffects:BasicsExamplePlugin", // The unique ID of this plugin.
1, // The major version number of this plugin.
0, // The minor version number of this plugin.
Expand Down
4 changes: 2 additions & 2 deletions Documentation/sources/Guide/Code/Example2/invert.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -73,7 +73,7 @@ namespace {
OfxImageEffectSuiteV1 *gImageEffectSuite = 0;

////////////////////////////////////////////////////////////////////////////////
// The first _action_ called after the binary is loaded (three boot strapper functions will be howeever)
// The first _action_ called after the binary is loaded (three boot strapper functions will be however)
OfxStatus LoadAction(void)
{
/// now fetch a suite out of the host via it's fetch suite function.
Expand Down Expand Up @@ -426,7 +426,7 @@ namespace {
static OfxPlugin effectPluginStruct =
{
kOfxImageEffectPluginApi, // The API this plugin satisfies.
1, // The version of the API it satisifes.
1, // The version of the API it satisfies.
"org.openeffects:InvertExamplePlugin", // The unique ID of this plugin.
1, // The major version number of this plugin.
0, // The minor version number of this plugin.
Expand Down
4 changes: 2 additions & 2 deletions Documentation/sources/Guide/Code/Example3/gain.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -131,7 +131,7 @@ namespace {
}

////////////////////////////////////////////////////////////////////////////////
// The first _action_ called after the binary is loaded (three boot strapper functions will be howeever)
// The first _action_ called after the binary is loaded (three boot strapper functions will be however)
OfxStatus LoadAction(void)
{
// fetch our three suites
Expand Down Expand Up @@ -648,7 +648,7 @@ namespace {
static OfxPlugin effectPluginStruct =
{
kOfxImageEffectPluginApi, // The API this plugin satisfies.
1, // The version of the API it satisifes.
1, // The version of the API it satisfies.
"org.openeffects:GainExamplePlugin", // The unique ID of this plugin.
1, // The major version number of this plugin.
0, // The minor version number of this plugin.
Expand Down
4 changes: 2 additions & 2 deletions Documentation/sources/Guide/Code/Example4/saturation.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -287,7 +287,7 @@ namespace {
}

////////////////////////////////////////////////////////////////////////////////
// The first _action_ called after the binary is loaded (three boot strapper functions will be howeever)
// The first _action_ called after the binary is loaded (three boot strapper functions will be however)
OfxStatus LoadAction(void)
{
// fetch our three suites
Expand Down Expand Up @@ -779,7 +779,7 @@ namespace {
static OfxPlugin effectPluginStruct =
{
kOfxImageEffectPluginApi, // The API this plugin satisfies.
1, // The version of the API it satisifes.
1, // The version of the API it satisfies.
"org.openeffects:SaturationExamplePlugin", // The unique ID of this plugin.
1, // The major version number of this plugin.
0, // The minor version number of this plugin.
Expand Down
4 changes: 2 additions & 2 deletions Documentation/sources/Guide/Code/Example5/circle.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -318,7 +318,7 @@ namespace {
}

////////////////////////////////////////////////////////////////////////////////
// The first _action_ called after the binary is loaded (three boot strapper functions will be howeever)
// The first _action_ called after the binary is loaded (three boot strapper functions will be however)
OfxStatus LoadAction(void)
{
// fetch our three suites
Expand Down Expand Up @@ -978,7 +978,7 @@ namespace {
static OfxPlugin effectPluginStruct =
{
kOfxImageEffectPluginApi, // The API this plugin satisfies.
1, // The version of the API it satisifes.
1, // The version of the API it satisfies.
"org.openeffects:CircleExamplePlugin", // The unique ID of this plugin.
1, // The major version number of this plugin.
0, // The minor version number of this plugin.
Expand Down
4 changes: 2 additions & 2 deletions Documentation/sources/Guide/ofxExample1_Basics.rst
Original file line number Diff line number Diff line change
Expand Up @@ -550,7 +550,7 @@ in context action…
char *context;
gPropertySuite->propGetString(inArgs, kOfxImageEffectPropContext, 0, &context);
ERROR_IF(strcmp(context, kOfxImageEffectContextFilter) != 0, "DescribeInContextAction called on unsupported contex %s", context);
ERROR_IF(strcmp(context, kOfxImageEffectContextFilter) != 0, "DescribeInContextAction called on unsupported context %s", context);

OfxPropertySetHandle props;
// define the mandated single output clip
Expand Down Expand Up @@ -737,7 +737,7 @@ should clearly specify the calling sequence. Failure to call them in the
right sequence will lead to all sorts of undefined behaviour.

Assuming the host has done nothing apart from load the dynamic library
that contains plugins and has found the two :ref:`boostrapping
that contains plugins and has found the two :ref:`bootstrapping
symbols <bootstrapperFunctions>` in the plugin, the host
should then...

Expand Down
4 changes: 2 additions & 2 deletions Documentation/sources/Guide/ofxExample4_Saturation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ be used in more than one context, as well as how to make a multi-input
effect. Its source can be found in the C++ file
`saturation.cpp <https://github.com/ofxa/openfx/blob/master/Guide/Code/Example4/saturation.cpp>`_.
This plugin takes an RGB or RGBA
image and increases or descreases the saturation by a parameter. It can
image and increases or decreases the saturation by a parameter. It can
be used in two contexts, firstly as a simple filter, secondly as a
general effect, where it has an optional second input clip which is used
to control where the effect is applied.
Expand Down Expand Up @@ -158,7 +158,7 @@ space.

Here we have the describe in context action. This will now be called
once for each context that a host application wants to support. You know
which contex you are being described in by the
which context you are being described in by the
:c:macro:`kOfxImageEffectPropContext` property on inArgs.

Regardless of the context, it describes two clips, "Source" and
Expand Down
2 changes: 1 addition & 1 deletion Documentation/sources/Guide/ofxExample5_Circle.rst
Original file line number Diff line number Diff line change
Expand Up @@ -132,7 +132,7 @@ Here is the source for the load action…
.. code:: c++

////////////////////////////////////////////////////////////////////////////////
// The first _action_ called after the binary is loaded (three boot strapper functions will be howeever)
// The first _action_ called after the binary is loaded (three boot strapper functions will be however)
OfxStatus LoadAction(void)
{
// fetch our three suites
Expand Down
2 changes: 1 addition & 1 deletion Documentation/sources/Guide/ofxExamples.rst
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ OFX is actually several things. At the lowest level OFX is a generic
``C`` based plug-in architecture that can be used to define any kind of
plug-in API. You could use this low level architecture to implement any
API, however it was originally designed to host our visual effects image
processing API. The basic architecture could be re-used to create other
processing API. The basic architecture could be reused to create other
higher level APIs such as a sound effects API, a 3D API and more.

This guide describes the basic OFX plug-in architecture and the visual
Expand Down
2 changes: 1 addition & 1 deletion Documentation/sources/Reference/apiChanges_1_2_Chapter.rst
Original file line number Diff line number Diff line change
Expand Up @@ -125,7 +125,7 @@ example, if you want to set something to be explicitly '20', there is no
way of doing that. The main problem stems from normalised params
conflating two separate issues, flagging to the host that a parameter
was spatial, and being able to specify defaults in a normalised
co-ordinate system.
coordinate system.

With 1.2 new :ref:`spatial double
parameter <ParameterPropertiesDoubleTypesSpatial>` types are defined.
Expand Down
2 changes: 1 addition & 1 deletion Documentation/sources/Reference/ofxClipPreferences.rst
Original file line number Diff line number Diff line change
Expand Up @@ -210,7 +210,7 @@ The default value of the output clip's fielding is host dependent, but
in general,

- if any of the input clips are fielded, so will the output clip
- the output clip may be fielded irregardless of the input clips (for
- the output clip may be fielded regardless of the input clips (for
example, in a fielded project).

If the host allows a plugin to specify the fielding of the output clip,
Expand Down
2 changes: 1 addition & 1 deletion Documentation/sources/Reference/ofxCoordSystem.rst
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ Pixel Coordinates

*Real* images, where we have to deal with addressable pixels in memory,
are in a coordinate system of non-square proxy scaled integer values. So
a PAL D1 image, being renderred as a half resolution proxy would be
a PAL D1 image, being rendered as a half resolution proxy would be
(0,0) to (360, 288), which takes into account both the pixel aspect
ratio of 1.067 and a scale factor of 0.5f. We call this the **Pixel
Coordinate System**.
Expand Down
2 changes: 1 addition & 1 deletion Documentation/sources/Reference/ofxImageClip.rst
Original file line number Diff line number Diff line change
Expand Up @@ -110,7 +110,7 @@ describe in context call are...
for more details on field and field rendering
- :c:macro:`kOfxImageEffectPropTemporalClipAccess`
whether the effect wants to access images from the clip at times
other that the frame being renderred.
other that the frame being rendered.

Plugins *must* indicate which pixel depths they can process by setting
the
Expand Down
4 changes: 2 additions & 2 deletions Documentation/sources/Reference/ofxImageEffectContexts.rst
Original file line number Diff line number Diff line change
Expand Up @@ -90,7 +90,7 @@ During the :c:macro:`kOfxImageEffectActionDescribeInContext` action, an effect
must describe all clips and parameters that it intends to use. This
includes the mandated clips and parameters for that context.

A plugin instance is created in a specific contex which will not changed
A plugin instance is created in a specific context which will not changed
over the lifetime of that instance. The context can be retrieved from
the instance via the
:c:macro:`kOfxImageEffectPropContext`
Expand Down Expand Up @@ -238,7 +238,7 @@ The Retimer Context
-------------------

The retimer context is for effects that change the length of a clip by
interpolating frames from the source clip to create an inbetween output
interpolating frames from the source clip to create an in between output
frame.

In this context, a plugin has the following mandated objects...
Expand Down
6 changes: 3 additions & 3 deletions Documentation/sources/Reference/ofxParameter.rst
Original file line number Diff line number Diff line change
Expand Up @@ -180,7 +180,7 @@ for example

gPropHost->propSetString(myChoiceParam, kOfxParamPropChoiceOption, 0, "1st Choice");
gPropHost->propSetString(myChoiceParam, kOfxParamPropChoiceOption, 1, "2nd Choice");
gPropHost->propSetString(myChoiceParam, kOfxParamPropChoiceOption, 2, "3nd Choice");
gPropHost->propSetString(myChoiceParam, kOfxParamPropChoiceOption, 2, "3rd Choice");
...
gPropHost->propSetString(myChoiceParam, kOfxParamPropChoiceOption, n, "nth Choice");

Expand Down Expand Up @@ -281,7 +281,7 @@ for example

gPropHost->propSetString(myChoiceParam, kOfxParamPropChoiceOption, 0, "1st Choice");
gPropHost->propSetString(myChoiceParam, kOfxParamPropChoiceOption, 1, "2nd Choice");
gPropHost->propSetString(myChoiceParam, kOfxParamPropChoiceOption, 2, "3nd Choice");
gPropHost->propSetString(myChoiceParam, kOfxParamPropChoiceOption, 2, "3rd Choice");
...
// enums: string values to be returned as param value, and stored by the host in the project
gPropHost->propSetString(myChoiceParam, kOfxParamPropChoiceEnum, 0, "choice-1");
Expand Down Expand Up @@ -944,7 +944,7 @@ require their own set of functions to manage and manipulate them. The
new :cpp:class:`OfxParametricParameterSuiteV1`
is there to do that.

All the defines and suite definitions for parameteric parameters are
All the defines and suite definitions for parametric parameters are
defined in the file `ofxParametricParam.h <https://github.com/AcademySoftwareFoundation/openfx/blob/master/include/ofxParametricParam.h>`__

Parametric parameters are in effect *functions* a plug-in can ask a host
Expand Down
2 changes: 1 addition & 1 deletion Documentation/sources/Reference/ofxProcessingArch.rst
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,7 @@ infinite RoD is flagged by setting the minimums to be:

.. doxygendefine:: kOfxFlagInfiniteMin

and the maxmimums to be:
and the maximums to be:

.. doxygendefine:: kOfxFlagInfiniteMax

Expand Down
4 changes: 2 additions & 2 deletions Documentation/sources/Reference/ofxPropertiesByObject.rst
Original file line number Diff line number Diff line change
Expand Up @@ -19,13 +19,13 @@ Properties on the Image Effect Host
- kOfxPropName
- (read only) the globally unique name of the application, eg: "com.acmesofware.funkyCompositor"
- kOfxPropLabel
- (read only) the user visible name of the appliaction,
- (read only) the user visible name of the application,
- kOfxPropVersion
- (read only) the version number of the host
- kOfxPropVersionLabel
- (read only) a user readable version label
- kOfxImageEffectHostPropIsBackground
- (read only) is the application a background renderrer
- (read only) is the application a background renderer
- kOfxImageEffectPropSupportsOverlays
- (read only) does the application support overlay interactive GUIs
- kOfxImageEffectPropSupportsMultiResolution
Expand Down
8 changes: 4 additions & 4 deletions Documentation/sources/Reference/ofxRendering.rst
Original file line number Diff line number Diff line change
Expand Up @@ -167,11 +167,11 @@ For plug-ins this can be one of three values...

For hosts, this property takes three values...

- 0, which indicates thet the host can never guarantee sequential
- 0, which indicates that the host can never guarantee sequential
rendering,
- 1, which indicates thet the host can guarantee sequential rendering
- 1, which indicates that the host can guarantee sequential rendering
for plugins that request it,
- 2, which indicates thet the host can sometimes perform sequential
- 2, which indicates that the host can sometimes perform sequential
rendering.

When rendering, a host will set the in args property on
Expand Down Expand Up @@ -272,7 +272,7 @@ tells the effect which field it should render, this can be one of...
- :c:macro:`kOfxImageFieldNone`
- there are no fields to deal with, the image is full frame
- :c:macro:`kOfxImageFieldBoth`
- the imagery is fielded and both scan lines should be renderred
- the imagery is fielded and both scan lines should be rendered
- :c:macro:`kOfxImageFieldLower`
- the lower field is being rendered (lines 0,2,4...)
- :c:macro:`kOfxImageFieldUpper`
Expand Down
2 changes: 1 addition & 1 deletion Documentation/sources/Reference/ofxStructure.rst
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,7 @@ API, however many are actually quite generic and could be reused by
other APIs. The property suite definitely has to be used by all other
APIs, while the memory allocation suite, the parameter suite and several
others would probably be useful for all other APIs. For example the
parameter suite could be re-used to specify user visible parameters to
parameter suite could be reused to specify user visible parameters to
the other APIs.

Several types are common to all OFX APIs, and as such are defined in
Expand Down
Loading