diff --git a/Documentation/build.sh b/Documentation/build.sh index 9c05d3711..087406928 100755 --- a/Documentation/build.sh +++ b/Documentation/build.sh @@ -22,37 +22,44 @@ if [ ! -f genPropertiesReference.py ] ; then exit 1 fi -if ! command -v sphinx-build > /dev/null 2>&1 ; then - echo "Python can't import required modules; did you set up the prereqs?" - echo "Check the README.md." - exit 1 +if command -v uvx > /dev/null 2>&1; then + USE_UV=1 + SPHINX_BUILD="uv run --with-requirements pipreq.txt sphinx-build" + UV_RUN="uv run" +else + USE_UV= + SPHINX_BUILD="sphinx-build" + UV_RUN="" fi rm -rf build # Generate references EXPECTED_ERRS="unable to resolve reference|explicit link request|found in multiple" -python genPropertiesReference.py \ +$UV_RUN python genPropertiesReference.py \ -i ../include -o sources/Reference/ofxPropertiesReference.rst -r \ > /tmp/ofx-doc-build.out 2>&1 -egrep -v "$EXPECTED_ERRS" /tmp/ofx-doc-build.out || true +grep -v -E "$EXPECTED_ERRS" /tmp/ofx-doc-build.out || true # Build the Doxygen docs EXPECTED_ERRS="malformed hyperlink target|Duplicate explicit|Definition list ends|unable to resolve|could not be resolved" cd ../include doxygen ofx.doxy > /tmp/ofx-doc-build.out 2>&1 -egrep -v "$EXPECTED_ERRS" /tmp/ofx-doc-build.out || true +grep -v -E "$EXPECTED_ERRS" /tmp/ofx-doc-build.out || true cd - # Use breathe.apidoc to collect the Doxygen API docs rm -rf sources/Reference/api -python -m breathe.apidoc -p 'ofx_reference' -m --force -g class,interface,struct,union,file,namespace,group -o sources/Reference/api doxygen_build/xml - +if [[ $USE_UV ]]; then + $UV_RUN --with breathe python -m breathe.apidoc -p 'ofx_reference' -m --force -g class,interface,struct,union,file,namespace,group -o sources/Reference/api doxygen_build/xml +else + python -m breathe.apidoc -p 'ofx_reference' -m --force -g class,interface,struct,union,file,namespace,group -o sources/Reference/api doxygen_build/xml +fi # Build the Sphinx docs EXPECTED_ERRS='Explicit markup ends without|Duplicate C.*declaration|Declaration is|cpp:func targets a member|undefined label' -sphinx-build -b html sources build > /tmp/ofx-doc-build.out 2>&1 -egrep -v "$EXPECTED_ERRS" /tmp/ofx-doc-build.out || true +$SPHINX_BUILD -b html sources build > /tmp/ofx-doc-build.out 2>&1 +grep -v -E "$EXPECTED_ERRS" /tmp/ofx-doc-build.out || true echo "Documentation build complete." echo "Open file:///$PWD/build/index.html in your browser" diff --git a/Documentation/genPropertiesReference.py b/Documentation/genPropertiesReference.py index 01075e10d..7c1dce055 100755 --- a/Documentation/genPropertiesReference.py +++ b/Documentation/genPropertiesReference.py @@ -1,6 +1,6 @@ # SPDX-License-Identifier: BSD-3-Clause -import os,sys, getopt,re +import os,sys,getopt badlyNamedProperties = ["kOfxImageEffectFrameVarying", "kOfxImageEffectPluginRenderThreadSafety"] diff --git a/Documentation/sources/Reference/ofxPropertiesReference.rst b/Documentation/sources/Reference/ofxPropertiesReference.rst index c3ce86cdb..cbd93af1e 100644 --- a/Documentation/sources/Reference/ofxPropertiesReference.rst +++ b/Documentation/sources/Reference/ofxPropertiesReference.rst @@ -47,17 +47,7 @@ Properties Reference .. doxygendefine:: kOfxImageEffectPropColourManagementAvailableConfigs -.. doxygendefine:: kOfxImageEffectColourManagementBasic - -.. doxygendefine:: kOfxImageEffectColourManagementConfig - -.. doxygendefine:: kOfxImageEffectColourManagementCore - -.. doxygendefine:: kOfxImageEffectColourManagementFull - -.. doxygendefine:: kOfxImageEffectColourManagementNone - -.. doxygendefine:: kOfxImageEffectColourManagementOCIO +.. doxygendefine:: kOfxImageEffectPropColourManagementConfig .. doxygendefine:: kOfxImageEffectPropColourManagementStyle @@ -93,6 +83,8 @@ Properties Reference .. doxygendefine:: kOfxImageEffectPropMetalRenderSupported +.. doxygendefine:: kOfxImageEffectPropNoSpatialAwareness + .. doxygendefine:: kOfxImageEffectPropOCIOConfig .. doxygendefine:: kOfxImageEffectPropOCIODisplay diff --git a/Documentation/sources/conf.py b/Documentation/sources/conf.py index d37a40048..93cce72c5 100755 --- a/Documentation/sources/conf.py +++ b/Documentation/sources/conf.py @@ -11,9 +11,10 @@ import subprocess, os, shutil project = 'OpenFX' -copyright = '2024, Contributors to the OpenFX Project' +copyright = '''2025, OpenFX a Series of LF Projects, LLC. +For web site terms of use, trademark policy and other project policies please see https://lfprojects.org/''' author = 'Contributors to the OpenFX Project' -release = '1.4' +release = '1.5' read_the_docs_build = os.environ.get('READTHEDOCS', None) == 'True' # -- General configuration --------------------------------------------------- diff --git a/Examples/ColourSpace/colourspace.cpp b/Examples/ColourSpace/colourspace.cpp index aa2aa4cba..b99f1f048 100644 --- a/Examples/ColourSpace/colourspace.cpp +++ b/Examples/ColourSpace/colourspace.cpp @@ -543,7 +543,7 @@ getClipPreferences( OfxImageEffectHandle effect, OfxPropertySetHandle /*inArgs*/ OfxPropertySetHandle effectProps; gEffectHost->getPropertySet(effect, &effectProps); - // retieve the colour management style that the host has decided we shall use + // retrieve the colour management style that the host has decided we shall use ColourManagementStyle active_style = ColourManagementStyle::None; char * style; if(gPropHost->propGetString(effectProps, kOfxImageEffectPropColourManagementStyle, 0, &style) == kOfxStatOK) { @@ -606,7 +606,7 @@ getOutputColourspace( OfxImageEffectHandle effect, OfxPropertySetHandle /*inAr OfxPropertySetHandle effectProps; gEffectHost->getPropertySet(effect, &effectProps); - // retieve the colour management style that the host has decided we shall use + // retrieve the colour management style that the host has decided we shall use ColourManagementStyle active_style = ColourManagementStyle::None; char * style; if(gPropHost->propGetString(effectProps, kOfxImageEffectPropColourManagementStyle, 0, &style) == kOfxStatOK) { diff --git a/HostSupport/examples/cacheDemo.cpp b/HostSupport/examples/cacheDemo.cpp index 1dc0cc007..cf4250479 100644 --- a/HostSupport/examples/cacheDemo.cpp +++ b/HostSupport/examples/cacheDemo.cpp @@ -85,7 +85,7 @@ public : printf("\n"); if(isQuestion) { - /// cant do this properly inour example, as we need to raise a dialogue to ask a question, so just return yes + /// can't do this properly in our example, as we need to raise a dialogue to ask a question, so just return yes return kOfxStatReplyYes; } else { diff --git a/HostSupport/examples/hostDemoClipInstance.cpp b/HostSupport/examples/hostDemoClipInstance.cpp index b8fa4cc05..c067816b4 100644 --- a/HostSupport/examples/hostDemoClipInstance.cpp +++ b/HostSupport/examples/hostDemoClipInstance.cpp @@ -261,8 +261,8 @@ namespace MyHost { /// Field Order - Which spatial field occurs temporally first in a frame. /// \returns /// - kOfxImageFieldNone - the clip material is unfielded - /// - kOfxImageFieldLower - the clip material is fielded, with image rows 0,2,4.... occuring first in a frame - /// - kOfxImageFieldUpper - the clip material is fielded, with image rows line 1,3,5.... occuring first in a frame + /// - kOfxImageFieldLower - the clip material is fielded, with image rows 0,2,4.... occurring first in a frame + /// - kOfxImageFieldUpper - the clip material is fielded, with image rows line 1,3,5.... occurring first in a frame const std::string &MyClipInstance::getFieldOrder() const { /// our clip is pretending to be progressive PAL SD, so return kOfxImageFieldNone @@ -300,8 +300,8 @@ namespace MyHost { // Continuous Samples - // - // 0 if the images can only be sampled at discreet times (eg: the clip is a sequence of frames), - // 1 if the images can only be sampled continuously (eg: the clip is infact an animating roto spline and can be rendered anywhen). + // 0 if the images can only be sampled at discrete times (eg: the clip is a sequence of frames), + // 1 if the images can only be sampled continuously (eg: the clip is in fact an animating roto spline and can be rendered anywhen). bool MyClipInstance::getContinuousSamples() const { return false; diff --git a/HostSupport/examples/hostDemoClipInstance.h b/HostSupport/examples/hostDemoClipInstance.h index ba0468181..4fa244e3c 100755 --- a/HostSupport/examples/hostDemoClipInstance.h +++ b/HostSupport/examples/hostDemoClipInstance.h @@ -8,7 +8,7 @@ namespace MyHost { - // foward + // forward class MyClipInstance; /// make an image up @@ -77,8 +77,8 @@ namespace MyHost { /// Field Order - Which spatial field occurs temporally first in a frame. /// \returns /// - kOfxImageFieldNone - the clip material is unfielded - /// - kOfxImageFieldLower - the clip material is fielded, with image rows 0,2,4.... occuring first in a frame - /// - kOfxImageFieldUpper - the clip material is fielded, with image rows line 1,3,5.... occuring first in a frame + /// - kOfxImageFieldLower - the clip material is fielded, with image rows 0,2,4.... occurring first in a frame + /// - kOfxImageFieldUpper - the clip material is fielded, with image rows line 1,3,5.... occurring first in a frame virtual const std::string &getFieldOrder() const; // Connected - @@ -98,8 +98,8 @@ namespace MyHost { // Continuous Samples - // - // 0 if the images can only be sampled at discreet times (eg: the clip is a sequence of frames), - // 1 if the images can only be sampled continuously (eg: the clip is infact an animating roto spline and can be rendered anywhen). + // 0 if the images can only be sampled at discrete times (eg: the clip is a sequence of frames), + // 1 if the images can only be sampled continuously (eg: the clip is in fact an animating roto spline and can be rendered anywhen). virtual bool getContinuousSamples() const; /// override this to fill in the image at the given time. diff --git a/HostSupport/examples/hostDemoEffectInstance.h b/HostSupport/examples/hostDemoEffectInstance.h index ba8333337..c231bdb8a 100755 --- a/HostSupport/examples/hostDemoEffectInstance.h +++ b/HostSupport/examples/hostDemoEffectInstance.h @@ -58,7 +58,7 @@ namespace MyHost { // The extent of the current project in canonical coordinates. // The extent is the size of the 'output' for the current project. See ProjectCoordinateSystems - // for more infomation on the project extent. The extent is in canonical coordinates and only + // for more information on the project extent. The extent is in canonical coordinates and only // returns the top right position, as the extent is always rooted at 0,0. For example a PAL SD // project would have an extent of 768, 576. virtual void getProjectExtent(double& xSize, double& ySize) const; diff --git a/HostSupport/examples/hostDemoHostDescriptor.cpp b/HostSupport/examples/hostDemoHostDescriptor.cpp index b9945a577..7b5cbe8ac 100755 --- a/HostSupport/examples/hostDemoHostDescriptor.cpp +++ b/HostSupport/examples/hostDemoHostDescriptor.cpp @@ -122,7 +122,7 @@ namespace MyHost printf("\n"); if(isQuestion) { - /// cant do this properly inour example, as we need to raise a dialogue to ask a question, so just return yes + /// can't do this properly in our example, as we need to raise a dialogue to ask a question, so just return yes return kOfxStatReplyYes; } else { diff --git a/HostSupport/include/ofxhClip.h b/HostSupport/include/ofxhClip.h index da437e099..fdc63cee4 100755 --- a/HostSupport/include/ofxhClip.h +++ b/HostSupport/include/ofxhClip.h @@ -33,7 +33,7 @@ namespace OFX { virtual ~ClipBase() { } - /// ctor, when copy constructing an instance from a descripto + /// ctor, when copy constructing an instance from a descriptor explicit ClipBase(const ClipBase &other); /// name of the clip @@ -106,8 +106,8 @@ namespace OFX { protected: ImageEffect::Instance* _effectInstance; ///< image effect instance bool _isOutput; ///< are we the output clip - std::string _pixelDepth; ///< what is the bit depth we is at. Set during the clip prefernces action. - std::string _components; ///< what components do we have. Set during the clip prefernces action. + std::string _pixelDepth; ///< what is the bit depth we is at. Set during the clip preferences action. + std::string _components; ///< what components do we have. Set during the clip preferences action. public: ClipInstance(ImageEffect::Instance* effectInstance, ClipDescriptor& desc); @@ -224,8 +224,8 @@ namespace OFX { /// Field Order - Which spatial field occurs temporally first in a frame. /// \returns /// - kOfxImageFieldNone - the clip material is unfielded - /// - kOfxImageFieldLower - the clip material is fielded, with image rows 0,2,4.... occuring first in a frame - /// - kOfxImageFieldUpper - the clip material is fielded, with image rows line 1,3,5.... occuring first in a frame + /// - kOfxImageFieldLower - the clip material is fielded, with image rows 0,2,4.... occurring first in a frame + /// - kOfxImageFieldUpper - the clip material is fielded, with image rows line 1,3,5.... occurring first in a frame virtual const std::string &getFieldOrder() const = 0; // Connected - @@ -245,8 +245,8 @@ namespace OFX { // Continuous Samples - // - // 0 if the images can only be sampled at discreet times (eg: the clip is a sequence of frames), - // 1 if the images can only be sampled continuously (eg: the clip is infact an animating roto spline and can be rendered anywhen). + // 0 if the images can only be sampled at discrete times (eg: the clip is a sequence of frames), + // 1 if the images can only be sampled continuously (eg: the clip is in fact an animating roto spline and can be rendered anywhen). virtual bool getContinuousSamples() const = 0; /// override this to fill in the image at the given time. @@ -271,7 +271,7 @@ namespace OFX { virtual OfxRectD getRegionOfDefinition(OfxTime time) const = 0; /// given the colour component, find the nearest set of supported colour components - /// override this for extra wierd custom component depths + /// override this for extra weird custom component depths virtual const std::string &findSupportedComp(const std::string &s) const; }; @@ -291,7 +291,7 @@ namespace OFX { ImageBase(); /// construct from a clip instance, but leave the - /// filling it to the calling code via the propery set + /// filling it to the calling code via the property set explicit ImageBase(ClipInstance& instance); // Render Scale (renderScaleX,renderScaleY) - @@ -365,7 +365,7 @@ namespace OFX { Image(); /// construct from a clip instance, but leave the - /// filling it to the calling code via the propery set + /// filling it to the calling code via the property set explicit Image(ClipInstance& instance); // Render Scale (renderScaleX,renderScaleY) - @@ -430,7 +430,7 @@ namespace OFX { Texture(); /// construct from a clip instance, but leave the - /// filling it to the calling code via the propery set + /// filling it to the calling code via the property set explicit Texture(ClipInstance& instance); // Render Scale (renderScaleX,renderScaleY) - diff --git a/HostSupport/include/ofxhImageEffect.h b/HostSupport/include/ofxhImageEffect.h index f0d4e7541..fdd9241e1 100755 --- a/HostSupport/include/ofxhImageEffect.h +++ b/HostSupport/include/ofxhImageEffect.h @@ -124,10 +124,10 @@ namespace OFX { virtual OfxStatus flushOpenGLResources() const = 0; # endif - /// override this to use your own memory instance - must inherrit from memory::instance + /// override this to use your own memory instance - must inherit from memory::instance virtual Memory::Instance* newMemoryInstance(size_t nBytes); - // return an memory::instance calls makeMemoryInstance that can be overriden + // return an memory::instance calls makeMemoryInstance that can be overridden Memory::Instance* imageMemoryAlloc(size_t nBytes); }; @@ -335,7 +335,7 @@ namespace OFX { /// get output fielding as set in the clip preferences action. const std::string &getOutputPreMultiplication() const {return _outputPreMultiplication; } - /// get the output frame rate, as set in the clip prefences action. + /// get the output frame rate, as set in the clip preferences action. double getOutputFrameRate() const {return _outputFrameRate;} @@ -368,16 +368,16 @@ namespace OFX { /// params and input images are exactly the same. eg: random noise generator bool isFrameVarying() const {return _frameVarying;} - /// pure virtuals that must be overriden + /// pure virtuals that must be overridden virtual ClipInstance* getClip(const std::string& name) const; /// override this to make processing abort, return 1 to abort processing virtual int abort(); - /// override this to use your own memory instance - must inherrit from memory::instance + /// override this to use your own memory instance - must inherit from memory::instance virtual Memory::Instance* newMemoryInstance(size_t nBytes); - // return an memory::instance calls makeMemoryInstance that can be overriden + // return an memory::instance calls makeMemoryInstance that can be overridden Memory::Instance* imageMemoryAlloc(size_t nBytes); /// make a clip @@ -410,10 +410,10 @@ namespace OFX { /// overridden from Property::Notify virtual void notify(const std::string &name, bool singleValue, int indexOrN); - /// overridden from gethook, get the virutals for viewport size, pixel scale, background colour + /// overridden from gethook, get the virtuals for viewport size, pixel scale, background colour virtual double getDoubleProperty(const std::string &name, int index) const; - /// overridden from gethook, get the virutals for viewport size, pixel scale, background colour + /// overridden from gethook, get the virtuals for viewport size, pixel scale, background colour virtual void getDoublePropertyN(const std::string &name, double *values, int count) const; /// overridden from gethook, don't know what to do @@ -441,7 +441,7 @@ namespace OFX { // The extent of the current project in canonical coordinates. // The extent is the size of the 'output' for the current project. See ProjectCoordinateSystems - // for more infomation on the project extent. The extent is in canonical coordinates and only + // for more information on the project extent. The extent is in canonical coordinates and only // returns the top right position, as the extent is always rooted at 0,0. For example a PAL SD // project would have an extent of 768, 576. virtual void getProjectExtent(double& xSize, double& ySize) const = 0; @@ -611,7 +611,7 @@ namespace OFX { virtual void setDefaultClipPreferences(); /// Initialise the clip preferences arguments, override this to do - /// stuff with wierd components etc... Calls setDefaultClipPreferences + /// stuff with weird components etc... Calls setDefaultClipPreferences virtual void setupClipPreferencesArgs(Property::Set &args); /// Run the clip preferences action from the effect. diff --git a/HostSupport/include/ofxhInteract.h b/HostSupport/include/ofxhInteract.h index b48463535..661d39815 100755 --- a/HostSupport/include/ofxhInteract.h +++ b/HostSupport/include/ofxhInteract.h @@ -76,7 +76,7 @@ namespace OFX { }; /// a generic interact, it doesn't belong to anything in particular - /// we need to generify this slighty more and remove the renderscale args + /// we need to generify this further and remove the renderscale args /// into a derived class, as they only belong to image effect plugins class Instance : public Base, protected Property::GetHook { protected: @@ -148,7 +148,7 @@ namespace OFX { // don't know what to do virtual void reset(const std::string &name); - /// the gethook virutals for pixel scale, background colour + /// the gethook virtuals for pixel scale, background colour virtual double getDoubleProperty(const std::string &name, int index) const; /// for pixel scale and background colour @@ -161,7 +161,7 @@ namespace OFX { // // Params - // - // time - the effect time at which changed occured + // time - the effect time at which changed occurred // renderScale - the render scale virtual OfxStatus drawAction(OfxTime time, const OfxPointD &renderScale); @@ -169,11 +169,11 @@ namespace OFX { // // Params - // - // time - the effect time at which changed occured + // time - the effect time at which changed occurred // renderScale - the render scale // penX - the X position // penY - the Y position - // pressure - the pen pressue 0 to 1 + // pressure - the pen pressure 0 to 1 virtual OfxStatus penMotionAction(OfxTime time, const OfxPointD &renderScale, const OfxPointD &penPos, @@ -184,11 +184,11 @@ namespace OFX { // // Params - // - // time - the effect time at which changed occured + // time - the effect time at which changed occurred // renderScale - the render scale // penX - the X position // penY - the Y position - // pressure - the pen pressue 0 to 1 + // pressure - the pen pressure 0 to 1 virtual OfxStatus penUpAction(OfxTime time, const OfxPointD &renderScale, const OfxPointD &penPos, @@ -199,11 +199,11 @@ namespace OFX { // // Params - // - // time - the effect time at which changed occured + // time - the effect time at which changed occurred // renderScale - the render scale // penX - the X position // penY - the Y position - // pressure - the pen pressue 0 to 1 + // pressure - the pen pressure 0 to 1 virtual OfxStatus penDownAction(OfxTime time, const OfxPointD &renderScale, const OfxPointD &penPos, @@ -214,7 +214,7 @@ namespace OFX { // // Params - // - // time - the effect time at which changed occured + // time - the effect time at which changed occurred // renderScale - the render scale // key - the pressed key // keyString - the pressed key string @@ -227,7 +227,7 @@ namespace OFX { // // Params - // - // time - the effect time at which changed occured + // time - the effect time at which changed occurred // renderScale - the render scale // key - the pressed key // keyString - the pressed key string @@ -240,7 +240,7 @@ namespace OFX { // // Params - // - // time - the effect time at which changed occured + // time - the effect time at which changed occurred // renderScale - the render scale // key - the pressed key // keyString - the pressed key string @@ -253,7 +253,7 @@ namespace OFX { // // Params - // - // time - the effect time at which changed occured + // time - the effect time at which changed occurred // renderScale - the render scale virtual OfxStatus gainFocusAction(OfxTime time, const OfxPointD &renderScale); @@ -262,7 +262,7 @@ namespace OFX { // // Params - // - // time - the effect time at which changed occured + // time - the effect time at which changed occurred // renderScale - the render scale virtual OfxStatus loseFocusAction(OfxTime time, const OfxPointD &renderScale); diff --git a/HostSupport/include/ofxhParam.h b/HostSupport/include/ofxhParam.h index d5b51dc3d..714abbb58 100755 --- a/HostSupport/include/ofxhParam.h +++ b/HostSupport/include/ofxhParam.h @@ -208,7 +208,7 @@ namespace OFX { // va list calls below turn the var args (oh what a mistake) // suite functions into virtual function calls on instances - // they are not to be overridden by host implementors by + // they are not to be overridden by host implementers by // by the various typeed param instances so that they can // deconstruct the var args lists @@ -268,7 +268,7 @@ namespace OFX { public: IntegerInstance(Descriptor& descriptor, Param::SetInstance* instance = 0) : Instance(descriptor,instance) {} - // Deriving implementatation needs to overide these + // Deriving implementation needs to override these virtual OfxStatus get(int&) = 0; virtual OfxStatus get(OfxTime time, int&) = 0; virtual OfxStatus set(int) = 0; @@ -304,7 +304,7 @@ namespace OFX { // callback which should set option as appropriate virtual void setOption(int num); - // Deriving implementatation needs to overide these + // Deriving implementation needs to override these virtual OfxStatus get(int&) = 0; virtual OfxStatus get(OfxTime time, int&) = 0; virtual OfxStatus set(int) = 0; @@ -330,7 +330,7 @@ namespace OFX { public: DoubleInstance(Descriptor& descriptor, Param::SetInstance* instance = 0) : Instance(descriptor,instance) {} - // Deriving implementatation needs to overide these + // Deriving implementation needs to override these virtual OfxStatus get(double&) = 0; virtual OfxStatus get(OfxTime time, double&) = 0; virtual OfxStatus set(double) = 0; @@ -361,7 +361,7 @@ namespace OFX { public: BooleanInstance(Descriptor& descriptor, Param::SetInstance* instance = 0) : Instance(descriptor,instance) {} - // Deriving implementatation needs to overide these + // Deriving implementation needs to override these virtual OfxStatus get(bool&) = 0; virtual OfxStatus get(OfxTime time, bool&) = 0; virtual OfxStatus set(bool) = 0; @@ -384,7 +384,7 @@ namespace OFX { public: RGBAInstance(Descriptor& descriptor, Param::SetInstance* instance = 0) : Instance(descriptor,instance) {} - // Deriving implementatation needs to overide these + // Deriving implementation needs to override these virtual OfxStatus get(double&,double&,double&,double&) = 0; virtual OfxStatus get(OfxTime time, double&,double&,double&,double&) = 0; virtual OfxStatus set(double,double,double,double) = 0; @@ -417,7 +417,7 @@ namespace OFX { public: RGBInstance(Descriptor& descriptor, Param::SetInstance* instance = 0) : Instance(descriptor,instance) {} - // Deriving implementatation needs to overide these + // Deriving implementation needs to override these virtual OfxStatus get(double&,double&,double&) = 0; virtual OfxStatus get(OfxTime time, double&,double&,double&) = 0; virtual OfxStatus set(double,double,double) = 0; @@ -450,7 +450,7 @@ namespace OFX { public: Double2DInstance(Descriptor& descriptor, Param::SetInstance* instance = 0) : Instance(descriptor,instance) {} - // Deriving implementatation needs to overide these + // Deriving implementation needs to override these virtual OfxStatus get(double&,double&) = 0; virtual OfxStatus get(OfxTime time, double&,double&) = 0; virtual OfxStatus set(double,double) = 0; @@ -483,7 +483,7 @@ namespace OFX { public: Integer2DInstance(Descriptor& descriptor, Param::SetInstance* instance = 0) : Instance(descriptor,instance) {} - // Deriving implementatation needs to overide these + // Deriving implementation needs to override these virtual OfxStatus get(int&,int&) = 0; virtual OfxStatus get(OfxTime time, int&,int&) = 0; virtual OfxStatus set(int,int) = 0; @@ -516,7 +516,7 @@ namespace OFX { public: Double3DInstance(Descriptor& descriptor, Param::SetInstance* instance = 0) : Instance(descriptor,instance) {} - // Deriving implementatation needs to overide these + // Deriving implementation needs to override these virtual OfxStatus get(double&,double&,double&) = 0; virtual OfxStatus get(OfxTime time, double&,double&,double&) = 0; virtual OfxStatus set(double,double,double) = 0; @@ -627,7 +627,7 @@ namespace OFX { public : /// ctor /// - /// The propery set being passed in belongs to the owning + /// The property set being passed in belongs to the owning /// plugin instance. explicit SetInstance(); diff --git a/HostSupport/include/ofxhPluginCache.h b/HostSupport/include/ofxhPluginCache.h index dda1bd53f..086993ecc 100644 --- a/HostSupport/include/ofxhPluginCache.h +++ b/HostSupport/include/ofxhPluginCache.h @@ -25,7 +25,7 @@ namespace OFX { class Host; - // forward delcarations + // forward declarations class PluginDesc; class Plugin; class PluginBinary; @@ -186,7 +186,7 @@ namespace OFX { friend class PluginHandle; protected : - Binary _binary; ///< our binary object, abstracted layer ontop of OS calls, defined in ofxhBinary.h + Binary _binary; ///< our binary object, abstracted layer on top of OS calls, defined in ofxhBinary.h std::string _filePath; ///< full path to the file std::string _bundlePath; ///< path to the .bundle directory std::vector _plugins; ///< my plugins @@ -379,7 +379,7 @@ namespace OFX { } } - /// specify which subdirectory of /usr/OFX or equivilant + /// specify which subdirectory of /usr/OFX or equivalent /// (as well as 'Plugins') to look in for plugins. void setPluginHostPath(const std::string &hostId); diff --git a/HostSupport/include/ofxhPropertySuite.h b/HostSupport/include/ofxhPropertySuite.h index 1a1031e28..6c53ba12b 100644 --- a/HostSupport/include/ofxhPropertySuite.h +++ b/HostSupport/include/ofxhPropertySuite.h @@ -70,7 +70,7 @@ namespace OFX { struct IntValue { typedef int APIType; ///< C type of the property that is passed across the raw API typedef int APITypeConstless; ///< C type of the property that is passed across the raw API, without any const it - typedef int Type; ///< Type we actually hold and deal with the propery in everything by the raw API + typedef int Type; ///< Type we actually hold and deal with the property in everything by the raw API typedef int ReturnType; ///< type to return from a function call static const TypeEnum typeCode = eInt; static int kEmpty; @@ -438,7 +438,7 @@ namespace OFX { /// specialised versions of this. void addNotifyHook(const std::string &name, NotifyHook *hook) const; - /// Fetchs a pointer to a property of the given name, following the property chain if the + /// Fetches a pointer to a property of the given name, following the property chain if the /// 'followChain' arg is not false. Property *fetchProperty(const std::string &name, bool followChain = false) const; diff --git a/HostSupport/include/ofxhUtilities.h b/HostSupport/include/ofxhUtilities.h index 5720a06bd..7c0cb6d69 100644 --- a/HostSupport/include/ofxhUtilities.h +++ b/HostSupport/include/ofxhUtilities.h @@ -16,7 +16,7 @@ if (host) { \ try { \ (host)->message(kOfxMessageError, "", \ - "%s: Memory allocation error occured in plugin %s (%s)", \ + "%s: Memory allocation error occurred in plugin %s (%s)", \ (msg), (plugin)->pluginIdentifier, ba.what()); \ } catch (...) { \ } \ @@ -26,7 +26,7 @@ if (host) { \ try { \ (host)->message(kOfxMessageError, "", \ - "%s: Exception occured in plugin %s (%s)", \ + "%s: Exception occurred in plugin %s (%s)", \ (msg), (plugin)->pluginIdentifier, e.what()); \ } catch (...) { \ } \ @@ -36,7 +36,7 @@ if (host) { \ try { \ (host)->message(kOfxMessageError, "", \ - "%s:Exception occured in plugin %s", \ + "%s:Exception occurred in plugin %s", \ (msg), (plugin)->pluginIdentifier); \ } catch (...) { \ } \ diff --git a/HostSupport/src/ofxhClip.cpp b/HostSupport/src/ofxhClip.cpp index 0dcce3273..a51111ae0 100755 --- a/HostSupport/src/ofxhClip.cpp +++ b/HostSupport/src/ofxhClip.cpp @@ -21,7 +21,7 @@ namespace OFX { namespace ImageEffect { - /// properties common to the desciptor and instance + /// properties common to the descriptor and instance /// the desc and set them, the instance cannot static const Property::PropSpec clipDescriptorStuffs[] = { { kOfxPropType, Property::eString, 1, true, kOfxTypeClip }, @@ -239,7 +239,7 @@ namespace OFX { _components = s; } - // get the virutals for viewport size, pixel scale, background colour + // get the virtuals for viewport size, pixel scale, background colour void ClipInstance::getDoublePropertyN(const std::string &name, double *values, int n) const { if(name==kOfxImagePropPixelAspectRatio){ @@ -266,7 +266,7 @@ namespace OFX { throw Property::Exception(kOfxStatErrValue); } - // get the virutals for viewport size, pixel scale, background colour + // get the virtuals for viewport size, pixel scale, background colour double ClipInstance::getDoubleProperty(const std::string &name, int n) const { if(name==kOfxImagePropPixelAspectRatio){ @@ -297,7 +297,7 @@ namespace OFX { throw Property::Exception(kOfxStatErrValue); } - // get the virutals for viewport size, pixel scale, background colour + // get the virtuals for viewport size, pixel scale, background colour int ClipInstance::getIntProperty(const std::string &name, int n) const { if(n!=0) throw Property::Exception(kOfxStatErrValue); @@ -311,14 +311,14 @@ namespace OFX { throw Property::Exception(kOfxStatErrValue); } - // get the virutals for viewport size, pixel scale, background colour + // get the virtuals for viewport size, pixel scale, background colour void ClipInstance::getIntPropertyN(const std::string &name, int *values, int n) const { if(n!=0) throw Property::Exception(kOfxStatErrValue); *values = getIntProperty(name, 0); } - // get the virutals for viewport size, pixel scale, background colour + // get the virtuals for viewport size, pixel scale, background colour const std::string &ClipInstance::getStringProperty(const std::string &name, int n) const { if(n!=0) throw Property::Exception(kOfxStatErrValue); @@ -442,7 +442,7 @@ namespace OFX { return rgb; } - /// wierd, must be some custom bit , if only one, choose that, otherwise no idea + /// weird, must be some custom bit , if only one, choose that, otherwise no idea /// how to map, you need to derive to do so. const std::vector &supportedComps = getSupportedComponents(); if(supportedComps.size() == 1) diff --git a/HostSupport/src/ofxhHost.cpp b/HostSupport/src/ofxhHost.cpp index 96f602b90..e5c850624 100644 --- a/HostSupport/src/ofxhHost.cpp +++ b/HostSupport/src/ofxhHost.cpp @@ -83,7 +83,7 @@ namespace OFX { _host.host = _properties.getHandle(); _host.fetchSuite = OFX::Host::fetchSuite; - // record the host descriptor in the propert set + // record the host descriptor in the property set _properties.setPointerProperty(kOfxHostSupportHostPointer,this); } diff --git a/HostSupport/src/ofxhImageEffect.cpp b/HostSupport/src/ofxhImageEffect.cpp index 042e44491..a3eb22795 100644 --- a/HostSupport/src/ofxhImageEffect.cpp +++ b/HostSupport/src/ofxhImageEffect.cpp @@ -476,7 +476,7 @@ namespace OFX { throw Property::Exception(kOfxStatErrMissingHostFeature); } - // get the virutals for viewport size, pixel scale, background colour + // get the virtuals for viewport size, pixel scale, background colour double Instance::getDoubleProperty(const std::string &name, int index) const { if(name==kOfxImageEffectPropProjectSize){ @@ -544,7 +544,7 @@ namespace OFX { } Instance::~Instance(){ - // destroy the instance, only if succesfully created + // destroy the instance, only if successfully created if (_created) { # ifdef OFX_DEBUG_ACTIONS std::cout << "OFX: "<<(void*)this<<"->"<; template class PropertyTemplate; template class PropertyTemplate; diff --git a/Support/Library/ofxsImageEffect.cpp b/Support/Library/ofxsImageEffect.cpp index 67baa1e6c..21872abad 100644 --- a/Support/Library/ofxsImageEffect.cpp +++ b/Support/Library/ofxsImageEffect.cpp @@ -1152,7 +1152,7 @@ namespace OFX { return v; } - /** @brief get the RoD for this clip in the cannonical coordinate system */ + /** @brief get the RoD for this clip in the canonical coordinate system */ OfxRectD Clip::getRegionOfDefinition(double t) { OfxRectD bounds; @@ -1178,7 +1178,7 @@ namespace OFX { return new Image(imageHandle); } - /** @brief fetch an image, with a specific region in cannonical coordinates */ + /** @brief fetch an image, with a specific region in canonical coordinates */ Image *Clip::fetchImage(double t, const OfxRectD &bounds) { OfxPropertySetHandle imageHandle; @@ -1310,13 +1310,13 @@ namespace OFX { return _effectProps.propGetInt(kOfxPropIsInteractive) != 0; } - /** @brief set the instance to be sequentially renderred, this should have been part of clip preferences! */ + /** @brief set the instance to be sequentially rendered, this should have been part of clip preferences! */ void ImageEffect::setSequentialRender(bool v) { _effectProps.propSetInt(kOfxImageEffectInstancePropSequentialRender, int(v)); } - /** @brief Have we informed the host we want to be seqentially renderred ? */ + /** @brief Have we informed the host we want to be seqentially rendered ? */ bool ImageEffect::getSequentialRender(void) const { return _effectProps.propGetInt(kOfxImageEffectInstancePropSequentialRender) != 0; @@ -1351,7 +1351,7 @@ namespace OFX { } #endif - /** @brief notify host that the internal data structures need syncing back to parameters for persistance and so on. This is reset by the host after calling SyncPrivateData. */ + /** @brief notify host that the internal data structures need syncing back to parameters for persistence and so on. This is reset by the host after calling SyncPrivateData. */ void ImageEffect::setParamSetNeedsSyncing() { _effectProps.propSetInt(kOfxPropParamSetNeedsSyncing, 1, false); // introduced in OFX 1.2 @@ -1506,7 +1506,7 @@ namespace OFX { // fa niente } - /** @brief The sync private data action, called when the effect needs to sync any private data to persistant parameters */ + /** @brief The sync private data action, called when the effect needs to sync any private data to persistent parameters */ void ImageEffect::syncPrivateData(void) { // fa niente @@ -1747,7 +1747,7 @@ namespace OFX { } } - /** @brief Set whether the effect can be continously sampled. */ + /** @brief Set whether the effect can be continuously sampled. */ void ClipPreferencesSetter::setOutputHasContinousSamples(bool v) { doneSomething_ = true; diff --git a/Support/Library/ofxsInteract.cpp b/Support/Library/ofxsInteract.cpp index ecd8464c4..d1180b03a 100644 --- a/Support/Library/ofxsInteract.cpp +++ b/Support/Library/ofxsInteract.cpp @@ -66,7 +66,7 @@ namespace OFX { throwSuiteStatusException(stat); _interactProperties.propSetHandle(propHandle); - // set othe instance data on the property handle to point to this interact + // set other instance data on the property handle to point to this interact _interactProperties.propSetPointer(kOfxPropInstanceData, (void *)this); // get the effect handle from this handle @@ -92,7 +92,7 @@ namespace OFX { return _interactProperties.propGetInt(kOfxInteractPropHasAlpha) != 0; } - /** @brief Returns the size of a real screen pixel under the interact's cannonical projection */ + /** @brief Returns the size of a real screen pixel under the interact's canonical projection */ OfxPointD Interact::getPixelScale(void) const { @@ -130,7 +130,7 @@ namespace OFX { throwSuiteStatusException(stat); } - /** @brief Swap a buffer in the case of a double bufferred interact, this is possibly a silly one */ + /** @brief Swap a buffer in the case of a double buffered interact, this is possibly a silly one */ void Interact::swapBuffers(void) const { diff --git a/Support/Library/ofxsLog.cpp b/Support/Library/ofxsLog.cpp index 8e4e0d194..50f290860 100644 --- a/Support/Library/ofxsLog.cpp +++ b/Support/Library/ofxsLog.cpp @@ -36,7 +36,7 @@ namespace OFX { gLogFileName = value; } - /** @brief Opens the log file, returns whether this was sucessful or not. */ + /** @brief Opens the log file, returns whether this was successful or not. */ bool open(void) { #ifdef DEBUG diff --git a/Support/Library/ofxsParams.cpp b/Support/Library/ofxsParams.cpp index 45fada146..4d3c48602 100644 --- a/Support/Library/ofxsParams.cpp +++ b/Support/Library/ofxsParams.cpp @@ -101,7 +101,7 @@ namespace OFX { , _paramType(type) , _paramProps(props) { - // validate the properities on this descriptor + // validate the properties on this descriptor if(type != eDummyParam) OFX::Validation::validateParameterProperties(type, props, true); } @@ -201,7 +201,7 @@ namespace OFX { _paramProps.propSetInt(kOfxParamPropAnimates, v); } - /** @brief set whether the param is persistant, defaults to true */ + /** @brief set whether the param is persistent, defaults to true */ void ValueParamDescriptor::setIsPersistant(bool v) { _paramProps.propSetInt(kOfxParamPropPersistant, v); @@ -1050,7 +1050,7 @@ namespace OFX { } } - /** @brief estabilishes the order of page params. Do it by calling it in turn for each page */ + /** @brief establishes the order of page params. Do it by calling it in turn for each page */ void ParamSetDescriptor::setPageParamOrder(PageParamDescriptor &p) { @@ -1391,21 +1391,21 @@ namespace OFX { return _paramProps.propGetInt(kOfxParamPropIsAutoKeying) != 0; } - /** @brief is the param persistant */ + /** @brief is the param persistent */ bool ValueParam::getIsPersistant(void) const { return _paramProps.propGetInt(kOfxParamPropPersistant) != 0; } - /** @brief Get's whether the value of the param is significant (ie: affects the rendered image) */ + /** @brief Gets whether the value of the param is significant (ie: affects the rendered image) */ bool ValueParam::getEvaluateOnChange(void) const { return _paramProps.propGetInt(kOfxParamPropEvaluateOnChange) != 0; } - /** @brief Get's whether the value of the param is significant (ie: affects the rendered image) */ + /** @brief Gets whether the value of the param is significant (ie: affects the rendered image) */ CacheInvalidationEnum ValueParam::getCacheInvalidation(void) const { @@ -2775,7 +2775,7 @@ namespace OFX { @returns - ::kOfxStatOK - all was fine - - ::kOfxStatErrBadHandle - if the paramter handle was invalid + - ::kOfxStatErrBadHandle - if the parameter handle was invalid - ::kOfxStatErrUnknown - if the type is unknown This modifies an existing control point. Note that by changing key, the order of the diff --git a/Support/Library/ofxsProperty.cpp b/Support/Library/ofxsProperty.cpp index ed46b2a47..ccf1e6b00 100644 --- a/Support/Library/ofxsProperty.cpp +++ b/Support/Library/ofxsProperty.cpp @@ -21,7 +21,7 @@ namespace OFX { break; case kOfxStatErrUnknown : - case kOfxStatErrUnsupported : // unsupported implies unknow here + case kOfxStatErrUnsupported : // unsupported implies unknown here if(OFX::PropertySet::getThrowOnUnsupportedProperties()) // are we suppressing this? throw OFX::Exception::PropertyUnknownToHost(propName.c_str()); break; @@ -72,7 +72,7 @@ namespace OFX { { assert(_propHandle != 0); OfxStatus stat = gPropSuite->propReset(_propHandle, property); - Log::error(stat != kOfxStatOK, "Failed on reseting property %s to its defaults, host returned status %s.", property, mapStatusToString(stat)); + Log::error(stat != kOfxStatOK, "Failed on resetting property %s to its defaults, host returned status %s.", property, mapStatusToString(stat)); throwPropertyException(stat, property); if(_gPropLogging > 0) Log::print("Reset property %s.", property); diff --git a/Support/Library/ofxsPropertyValidation.cpp b/Support/Library/ofxsPropertyValidation.cpp index 7daf7bdb7..5479ddb20 100644 --- a/Support/Library/ofxsPropertyValidation.cpp +++ b/Support/Library/ofxsPropertyValidation.cpp @@ -294,7 +294,7 @@ namespace OFX { PropertyDescription(kOfxImageEffectPropSupportedComponents, OFX::eString, -1, eDescFinished), PropertyDescription(kOfxImageEffectPropSupportedContexts, OFX::eString, -1, eDescFinished), - // multi dimensional int properities + // multi dimensional int properties PropertyDescription(kOfxParamHostPropPageRowColumnCount, OFX::eInt, 2, eDescFinished), }; diff --git a/Support/OSXStaticLoader/pluginLoader.cpp b/Support/OSXStaticLoader/pluginLoader.cpp index 2ae787c21..fd139fcc9 100644 --- a/Support/OSXStaticLoader/pluginLoader.cpp +++ b/Support/OSXStaticLoader/pluginLoader.cpp @@ -43,7 +43,7 @@ main(int argc, char *argv[]) int nP = nPluginsFunc(); - printf("Sucessfully loaded '%s', containing %d %s\n", argv[1], nP, (nP == 1 ? "plugin" : "plugins")); + printf("Successfully loaded '%s', containing %d %s\n", argv[1], nP, (nP == 1 ? "plugin" : "plugins")); for(int i = 0; i < nP; i++) { // get a plugin diff --git a/Support/Plugins/Basic/basic.cpp b/Support/Plugins/Basic/basic.cpp index 9d8b0da32..83ce9d066 100644 --- a/Support/Plugins/Basic/basic.cpp +++ b/Support/Plugins/Basic/basic.cpp @@ -419,7 +419,7 @@ BasicPlugin:: isIdentity(const OFX::IsIdentityArguments &args, OFX::Clip * &iden return true; } - // nope, idenity we is + // nope, identity we is return false; } @@ -427,7 +427,7 @@ BasicPlugin:: isIdentity(const OFX::IsIdentityArguments &args, OFX::Clip * &iden void BasicPlugin::setEnabledness(void) { - // the componet enabledness depends on the clip being RGBA and the param being true + // the component enabledness depends on the clip being RGBA and the param being true bool v = componentScalesEnabled_->getValue() && srcClip_->getPixelComponents() == OFX::ePixelComponentRGBA; // enable them @@ -502,11 +502,11 @@ bool BasicInteract::draw(const OFX::DrawArgs &args) bool BasicInteract::penMotion(const OFX::PenArgs &args) { - // figure the size of the box in cannonical coords + // figure the size of the box in canonical coords float dx = (float)(kBoxSize.x * args.pixelScale.x); float dy = (float)(kBoxSize.y * args.pixelScale.y); - // pen position is in cannonical coords + // pen position is in canonical coords OfxPointD penPos = args.penPosition; switch(_state) { @@ -564,7 +564,7 @@ BasicInteract::penDown(const OFX::PenArgs &args) // move our position _position = args.penPosition; - // and request a redraw just incase + // and request a redraw just in case _effect->redrawOverlays(); } diff --git a/Support/Plugins/ChoiceParams/choiceparams.cpp b/Support/Plugins/ChoiceParams/choiceparams.cpp index b92cc7d93..c0a1fafd4 100644 --- a/Support/Plugins/ChoiceParams/choiceparams.cpp +++ b/Support/Plugins/ChoiceParams/choiceparams.cpp @@ -481,11 +481,11 @@ bool ChoiceParamsInteract::draw(const OFX::DrawArgs &args) bool ChoiceParamsInteract::penMotion(const OFX::PenArgs &args) { - // figure the size of the box in cannonical coords + // figure the size of the box in canonical coords float dx = (float)(kBoxSize.x * args.pixelScale.x); float dy = (float)(kBoxSize.y * args.pixelScale.y); - // pen position is in cannonical coords + // pen position is in canonical coords OfxPointD penPos = args.penPosition; switch(_state) { @@ -543,7 +543,7 @@ ChoiceParamsInteract::penDown(const OFX::PenArgs &args) // move our position _position = args.penPosition; - // and request a redraw just incase + // and request a redraw just in case _effect->redrawOverlays(); } diff --git a/Support/Plugins/Retimer/retimer.cpp b/Support/Plugins/Retimer/retimer.cpp index 9474db150..59f113dd5 100644 --- a/Support/Plugins/Retimer/retimer.cpp +++ b/Support/Plugins/Retimer/retimer.cpp @@ -280,7 +280,7 @@ namespace OFX void RetimerExamplePluginFactory::load() { - // we can't be used on hosts that don't perfrom temporal clip access + // we can't be used on hosts that don't perform temporal clip access if(!gHostDescription.temporalClipAccess) { throw OFX::Exception::HostInadequate("Need random temporal image access to work"); } @@ -331,7 +331,7 @@ void RetimerExamplePluginFactory::describeInContext(OFX::ImageEffectDescriptor & dstClip->setFieldExtraction(eFieldExtractDoubled); // which is the default anyway dstClip->setSupportsTiles(true); - // what param we have is dependant on the host + // what param we have is dependent on the host if(context == OFX::eContextRetimer) { // Define the mandated kOfxImageEffectRetimerParamName param, note that we don't do anything with this other than. // describe it. It is not a true param but how the host indicates to the plug-in which frame diff --git a/Support/Plugins/Tester/Tester.cpp b/Support/Plugins/Tester/Tester.cpp index 9ede6917f..1cf901dc2 100644 --- a/Support/Plugins/Tester/Tester.cpp +++ b/Support/Plugins/Tester/Tester.cpp @@ -109,13 +109,13 @@ bool PositionInteract::draw(const OFX::DrawArgs &args) // overridden functions from OFX::Interact to do things bool PositionInteract::penMotion(const OFX::PenArgs &args) { - // figure the size of the box in cannonical coords + // figure the size of the box in canonical coords float dx = (float)(kBoxSize.x / args.pixelScale.x); float dy = (float)(kBoxSize.y / args.pixelScale.y); OfxPointD pos = getCanonicalPosition(args.time); - // pen position is in cannonical coords + // pen position is in canonical coords OfxPointD penPos = args.penPosition; switch(_state) diff --git a/Support/Plugins/Transition/crossFade.cpp b/Support/Plugins/Transition/crossFade.cpp index 3f9ed452d..5ccb30aa7 100644 --- a/Support/Plugins/Transition/crossFade.cpp +++ b/Support/Plugins/Transition/crossFade.cpp @@ -181,7 +181,7 @@ CrossFadePlugin::isIdentity(const OFX::IsIdentityArguments &args, OFX::Clip * &i return true; } - // nope, identity we isnt + // nope, identity we isn't return false; } diff --git a/Support/README b/Support/README index 31c8a766b..751c7fbb1 100644 --- a/Support/README +++ b/Support/README @@ -56,7 +56,7 @@ Release Notes Still to be done, decent set of exceptions and exception specifiers on each function, skin the parameter custom interact, - parameter integration and differentiation functions needed on 2D and 3D doubles and the colour classses, + parameter integration and differentiation functions needed on 2D and 3D doubles and the colour classes, parameters should return their values in a struct, as well as by a reference arg (some do already), write examples showing custom param and param animation, write an example showing use of external resource files, @@ -66,7 +66,7 @@ Release Notes Implemented most of the basic classes, need to do more work on clip instances and image effect instances. Library builds fine on OSX 10.3, not fully tested yet. - No where near finsihed yet, + No where near finished yet, Need to finish off the actions. Need to do a cleaner set of exception classes. Need to test somewhat more (hey they do compile though!). diff --git a/Support/include/ofxsCore.h b/Support/include/ofxsCore.h index 61fd23a10..96c39f77e 100755 --- a/Support/include/ofxsCore.h +++ b/Support/include/ofxsCore.h @@ -114,8 +114,8 @@ namespace OFX { /** @brief Enumerates the reasons a plug-in instance may have had one of its values changed */ enum InstanceChangeReason { - eChangeUserEdit, /**< @brief A user actively editted something in the plugin, eg: changed the value of an integer param on an interface */ - eChangePluginEdit, /**< @brief The plugin's own code changed something in the instance, eg: a callback on on param settting the value of another */ + eChangeUserEdit, /**< @brief A user actively edited something in the plugin, eg: changed the value of an integer param on an interface */ + eChangePluginEdit, /**< @brief The plugin's own code changed something in the instance, eg: a callback on on param setting the value of another */ eChangeTime /**< @brief The current value of a parameter has changed because the param animates and the current time has changed */ }; diff --git a/Support/include/ofxsImageEffect.h b/Support/include/ofxsImageEffect.h index 8a1b3dba0..c43e42719 100644 --- a/Support/include/ofxsImageEffect.h +++ b/Support/include/ofxsImageEffect.h @@ -707,7 +707,7 @@ namespace OFX { /** @brief return the range of frames over which this clip has images, before any clip preferences have been applied */ OfxRangeD getUnmappedFrameRange(void) const; - /** @brief get the RoD for this clip in the cannonical coordinate system */ + /** @brief get the RoD for this clip in the canonical coordinate system */ OfxRectD getRegionOfDefinition(double t); /** @brief fetch an image @@ -718,7 +718,7 @@ namespace OFX { */ Image *fetchImage(double t); - /** @brief fetch an image, with a specific region in cannonical coordinates + /** @brief fetch an image, with a specific region in canonical coordinates When finished with, the client code must delete the image. @@ -726,7 +726,7 @@ namespace OFX { */ Image *fetchImage(double t, const OfxRectD &bounds); - /** @brief fetch an image, with a specific region in cannonical coordinates + /** @brief fetch an image, with a specific region in canonical coordinates When finished with, the client code must delete the image. @@ -932,7 +932,7 @@ namespace OFX { */ void setOutputPremultiplication(PreMultiplicationEnum v); - /** @brief Set whether the effect can be continously sampled. + /** @brief Set whether the effect can be continuously sampled. Defaults to false. */ @@ -1039,10 +1039,10 @@ namespace OFX { /** @brief is the instance currently being interacted with */ bool isInteractive(void) const; - /** @brief set the instance to be sequentially renderred, this should have been part of clip preferences! */ + /** @brief set the instance to be sequentially rendered, this should have been part of clip preferences! */ void setSequentialRender(bool v); - /** @brief Have we informed the host we want to be seqentially renderred ? */ + /** @brief Have we informed the host we want to be seqentially rendered ? */ bool getSequentialRender(void) const; /** @brief Does the plugin support image tiling ? Can only be called from changedParam or changedClip. */ @@ -1059,7 +1059,7 @@ namespace OFX { void setNeedsOpenGLRender(bool v); #endif - /** @brief notify host that the internal data structures need syncing back to parameters for persistance and so on. This is reset by the host after calling SyncPrivateData. */ + /** @brief notify host that the internal data structures need syncing back to parameters for persistence and so on. This is reset by the host after calling SyncPrivateData. */ void setParamSetNeedsSyncing(); OFX::Message::MessageReplyEnum sendMessage(OFX::Message::MessageTypeEnum type, const std::string& id, const std::string& msg); @@ -1095,7 +1095,7 @@ namespace OFX { /** @brief The purge caches action, a request for an instance to free up as much memory as possible in low memory situations */ virtual void purgeCaches(void); - /** @brief The sync private data action, called when the effect needs to sync any private data to persistant parameters */ + /** @brief The sync private data action, called when the effect needs to sync any private data to persistent parameters */ virtual void syncPrivateData(void); /** @brief client render function, this is one of the few that must be overridden */ @@ -1120,7 +1120,7 @@ namespace OFX { If the effect wants change the rod from the default value (which is the union of RoD's of all input clips) it should set the \em rod argument and return true. - This is all in cannonical coordinates. + This is all in canonical coordinates. */ virtual bool getRegionOfDefinition(const RegionOfDefinitionArguments &args, OfxRectD &rod); @@ -1129,13 +1129,13 @@ namespace OFX { If the effect wants change its region of interest on any input clip from the default values (which is the same as the RoI in the arguments) it should do so by calling the OFX::RegionOfInterestSetter::setRegionOfInterest function on the \em rois argument. - Note, everything is in \em cannonical \em coordinates. + Note, everything is in \em canonical \em coordinates. */ virtual void getRegionsOfInterest(const RegionsOfInterestArguments &args, RegionOfInterestSetter &rois); /** @brief the get frames needed action - If the effect wants change the frames needed on an input clip from the default values (which is the same as the frame to be renderred) + If the effect wants change the frames needed on an input clip from the default values (which is the same as the frame to be rendered) it should do so by calling the OFX::FramesNeededSetter::setFramesNeeded function on the \em frames argument. */ virtual void getFramesNeeded(const FramesNeededArguments &args, FramesNeededSetter &frames); diff --git a/Support/include/ofxsInteract.h b/Support/include/ofxsInteract.h index 463083b72..f2a13bed9 100644 --- a/Support/include/ofxsInteract.h +++ b/Support/include/ofxsInteract.h @@ -24,7 +24,7 @@ namespace OFX { /** @brief forward declaration */ class ImageEffect; - /// all image effect interacts have these argumens + /// all image effect interacts have these arguments struct InteractArgs { /// ctor InteractArgs(const PropertySet &props); @@ -104,7 +104,7 @@ namespace OFX { /** @brief Does the openGL frame buffer have an alpha */ bool hasAlpha(void) const; - /** @brief Returns the size of a real screen pixel under the interact's cannonical projection */ + /** @brief Returns the size of a real screen pixel under the interact's canonical projection */ OfxPointD getPixelScale(void) const; /** @brief The suggested colour to draw a widget in an interact. Returns false if there is no suggestion. */ @@ -122,7 +122,7 @@ namespace OFX { /** @brief Request a redraw */ void requestRedraw(void) const; - /** @brief Swap a buffer in the case of a double bufferred interact, this is possibly a silly one */ + /** @brief Swap a buffer in the case of a double buffered interact, this is possibly a silly one */ void swapBuffers(void) const; //////////////////////////////////////////////////////////////////////////////// diff --git a/Support/include/ofxsLog.h b/Support/include/ofxsLog.h index 0b5315221..b669395a4 100644 --- a/Support/include/ofxsLog.h +++ b/Support/include/ofxsLog.h @@ -21,7 +21,7 @@ namespace OFX { /** @brief Sets the name of the log file. */ void setFileName(const std::string &value); - /** @brief Opens the log file, returns whether this was sucessful or not. */ + /** @brief Opens the log file, returns whether this was successful or not. */ bool open(void); /** @brief Closes the log file. */ diff --git a/Support/include/ofxsMemory.h b/Support/include/ofxsMemory.h index ad238a310..648ba69b6 100644 --- a/Support/include/ofxsMemory.h +++ b/Support/include/ofxsMemory.h @@ -21,7 +21,7 @@ namespace OFX { /** @brief Allocate memory. \arg \e nBytes - the number of bytes to allocate - \arg \e handle - effect instance to assosciate with this memory allocation, or NULL + \arg \e handle - effect instance to associate with this memory allocation, or NULL This function has the host allocate memory using it's own memory resources and returns that to the plugin. This memory is distinct to any image memory allocation. diff --git a/Support/include/ofxsParam.h b/Support/include/ofxsParam.h index 0e0f80301..cdc73fc0c 100644 --- a/Support/include/ofxsParam.h +++ b/Support/include/ofxsParam.h @@ -120,8 +120,8 @@ namespace OFX { /** @brief Enumerates the differing types of double params */ enum DoubleTypeEnum { eDoubleTypePlain, //!< parameter has no special interpretation - eDoubleTypeAngle, //!< parameter is to be interpretted as an angle - eDoubleTypeScale, //!< parameter is to be interpretted as a scale factor + eDoubleTypeAngle, //!< parameter is to be interpreted as an angle + eDoubleTypeScale, //!< parameter is to be interpreted as a scale factor eDoubleTypeTime, //!< parameter represents a time value (1D only) eDoubleTypeAbsoluteTime, //!< parameter represents an absolute time value (1D only), eDoubleTypeX, //!< a size in the X dimension dimension (1D only), new for 1.2 @@ -241,7 +241,7 @@ namespace OFX { /** @brief set whether the param can animate, defaults to true in most cases */ void setAnimates(bool v); - /** @brief set whether the param is persistant, defaults to true */ + /** @brief set whether the param is persistent, defaults to true */ void setIsPersistant(bool v); /** @brief Set's whether the value of the param is significant (ie: affects the rendered image), defaults to true */ @@ -276,7 +276,7 @@ namespace OFX { /** @brief sets the kind of the string param, defaults to eStringSingleLine */ void setStringType(StringTypeEnum v); - /** @brief if the string param is a file path, say that we are picking an existing file, rather than posibly specifying a new one, defaults to true */ + /** @brief if the string param is a file path, say that we are picking an existing file, rather than possibly specifying a new one, defaults to true */ void setFilePathExists(bool v); }; @@ -804,7 +804,7 @@ namespace OFX { /** @brief tries to fetch a ParamDescriptor, returns 0 if it isn't there*/ ParamDescriptor* getParamDescriptor(const std::string& name) const; - /** @brief estabilishes the order of page params. Do it by calling it in turn for each page */ + /** @brief establishes the order of page params. Do it by calling it in turn for each page */ void setPageParamOrder(PageParamDescriptor &p); /** @brief Define an integer param */ @@ -965,10 +965,10 @@ namespace OFX { /** @brief is the param animating */ bool getIsPersistant(void) const; - /** @brief Get's whether the value of the param is significant (ie: affects the rendered image) */ + /** @brief Gets whether the value of the param is significant (ie: affects the rendered image) */ bool getEvaluateOnChange(void) const; - /** @brief Get's whether the value of the param is significant (ie: affects the rendered image) */ + /** @brief Gets whether the value of the param is significant (ie: affects the rendered image) */ CacheInvalidationEnum getCacheInvalidation(void) const; /** @brief if the param is animating, the number of keys in it, otherwise 0 */ diff --git a/Support/include/ofxsProcessing.h b/Support/include/ofxsProcessing.h index 1e56f9f82..68b400a68 100644 --- a/Support/include/ofxsProcessing.h +++ b/Support/include/ofxsProcessing.h @@ -3,37 +3,9 @@ /* OFX Support Library, a library that skins the OFX plug-in API with C++ classes. - Copyright (C) 2005 The Open Effects Association Ltd + Copyright OpenFX and contributors to the OpenFX project. + SPDX-License-Identifier: BSD-3-Clause Author Bruno Nicoletti bruno@thefoundry.co.uk - -Redistribution and use in source and binary forms, with or without -modification, are permitted provided that the following conditions are met: - - * Redistributions of source code must retain the above copyright notice, - this list of conditions and the following disclaimer. - * Redistributions in binary form must reproduce the above copyright notice, - this list of conditions and the following disclaimer in the documentation - and/or other materials provided with the distribution. - * Neither the name The Open Effects Association Ltd, nor the names of its - contributors may be used to endorse or promote products derived from this - software without specific prior written permission. - -THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND -ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED -WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE -DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR -ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES -(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; -LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON -ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT -(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS -SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. - -The Open Effects Association Ltd -1 Wardour St -London W1D 6PA -England - */ #include diff --git a/Support/include/osxDeploy.sh b/Support/include/osxDeploy.sh index 92a8fcccd..e690637dc 100755 --- a/Support/include/osxDeploy.sh +++ b/Support/include/osxDeploy.sh @@ -79,7 +79,7 @@ if otool -L "$binary" | fgrep libMagick > /dev/null; then IMAGEMAGICKMAJ=${IMAGEMAGICKVER%.*.*} IMAGEMAGICKLIB=`pkg-config --variable=libdir ImageMagick` IMAGEMAGICKSHARE=`pkg-config --variable=prefix ImageMagick`/share - # if I get this right, sed substitutes in the exe the occurences of IMAGEMAGICKVER + # if I get this right, sed substitutes in the exe the occurrences of IMAGEMAGICKVER # into the actual value retrieved from the package. # We don't need this because we use MAGICKCORE_PACKAGE_VERSION declared in the # sed -e "s,IMAGEMAGICKVER,$IMAGEMAGICKVER,g" -i "" $pkgbin/DisparityKillerM diff --git a/Support/support.doxy b/Support/support.doxy index 5aad5f2b5..e5ac6e1f2 100644 --- a/Support/support.doxy +++ b/Support/support.doxy @@ -182,7 +182,7 @@ SHOW_INCLUDE_FILES = YES # will interpret the first line (until the first dot) of a JavaDoc-style # comment as the brief description. If set to NO, the JavaDoc # comments will behave just like the Qt-style comments (thus requiring an -# explict @brief command for a brief description. +# explicit @brief command for a brief description. JAVADOC_AUTOBRIEF = NO @@ -711,7 +711,7 @@ COMPACT_RTF = NO RTF_HYPERLINKS = NO # Load stylesheet definitions from file. Syntax is similar to doxygen's -# config file, i.e. a series of assigments. You only have to provide +# config file, i.e. a series of assignments. You only have to provide # replacements, missing definitions are set to their default value. RTF_STYLESHEET_FILE = @@ -889,7 +889,7 @@ EXPAND_AS_DEFINED = SKIP_FUNCTION_MACROS = YES #--------------------------------------------------------------------------- -# Configuration::addtions related to external references +# Configuration::additions related to external references #--------------------------------------------------------------------------- # The TAGFILES option can be used to specify one or more tagfiles. @@ -971,7 +971,7 @@ CLASS_GRAPH = YES COLLABORATION_GRAPH = YES # If the UML_LOOK tag is set to YES doxygen will generate inheritance and -# collaboration diagrams in a style similiar to the OMG's Unified Modeling +# collaboration diagrams in a style similar to the OMG's Unified Modeling # Language. UML_LOOK = NO @@ -1065,7 +1065,7 @@ GENERATE_LEGEND = YES DOT_CLEANUP = YES #--------------------------------------------------------------------------- -# Configuration::addtions related to the search engine +# Configuration::additions related to the search engine #--------------------------------------------------------------------------- # The SEARCHENGINE tag specifies whether or not a search engine should be diff --git a/include/DocSrc/footer.html b/include/DocSrc/footer.html deleted file mode 100644 index 06385dfc0..000000000 --- a/include/DocSrc/footer.html +++ /dev/null @@ -1,17 +0,0 @@ -
- -Copyright OpenFX and contributors to the OpenFX project. -SPDX-License-Identifier: BSD-3-Clause - -Copying and redistribution with or without -modification, is permitted provided that the following conditions are met: -
    -
  1. Redistributions of the document must retain the above copyright notice - and this list of conditions.
    2. -
  2. Neither the name of The Open Effects Association Ltd nor names of its - contributors may be used to - endorse or promote products derived from this software without specific - prior written permission.
    3. -
-Automatic documentation generated by Doxygen.
- diff --git a/include/DocSrc/ofx_footer.html b/include/DocSrc/ofx_footer.html index f86524fac..b1ef766f4 100644 --- a/include/DocSrc/ofx_footer.html +++ b/include/DocSrc/ofx_footer.html @@ -1,4 +1,5 @@ +