OfxhImageEffectNode.cpp

Go to the documentation of this file.

/*
 * Software License :
 *
 * Copyright (c) 2007-2009, The Open Effects Association Ltd. All rights reserved.
 *
 * 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.
 */

// ofx host
#include "OfxhBinary.hpp"
#include "OfxhMemory.hpp"
#include "OfxhImageEffectNode.hpp"
#include "OfxhPluginAPICache.hpp"
#include "OfxhPluginCache.hpp"
#include "OfxhHost.hpp"
#include "OfxhImageEffectPlugin.hpp"
#include "OfxhUtilities.hpp"
#include "attribute/OfxhClip.hpp"
#include "attribute/OfxhParam.hpp"
#include "attribute/OfxhParamGroup.hpp"
#include "attribute/OfxhParamDouble.hpp"
#include "property/OfxhSet.hpp"

#include <tuttle/host/Core.hpp>

// ofx
#include <ofxCore.h>
#include <ofxImageEffect.h>

#include <cstring>
#include <cstdarg>
#include <cmath>

namespace tuttle {
namespace host {
namespace ofx {
namespace imageEffect {

static const property::OfxhPropSpec effectInstanceStuff[] = {
        /* name                                 type                   dim.   r/o    default value */
        { kOfxPropType, property::ePropTypeString, 1, true, kOfxTypeImageEffectInstance },
        { kOfxPropName, property::ePropTypeString, 1, false, "UNIQUE_NAME_NOT_SET" },
        { kOfxImageEffectPropContext, property::ePropTypeString, 1, true, "" },
        { kOfxPropInstanceData, property::ePropTypePointer, 1, false, NULL },
        { kOfxImageEffectPropPluginHandle, property::ePropTypePointer, 1, false, NULL },
        { kOfxImageEffectPropProjectSize, property::ePropTypeDouble, 2, true, "0" },
        { kOfxImageEffectPropProjectOffset, property::ePropTypeDouble, 2, true, "0" },
        { kOfxImageEffectPropProjectExtent, property::ePropTypeDouble, 2, true, "0" },
        { kOfxImageEffectPropProjectPixelAspectRatio, property::ePropTypeDouble, 1, true, "0" },
        { kOfxImageEffectInstancePropEffectDuration, property::ePropTypeDouble, 1, true, "0" },
        { kOfxImageEffectInstancePropSequentialRender, property::ePropTypeInt, 1, false, "0" },
        { kOfxImageEffectPropFrameRate, property::ePropTypeDouble, 1, true, "0" },
        { kOfxPropIsInteractive, property::ePropTypeInt, 1, true, "0" },
        { 0 }
};

OfxhImageEffectNode::OfxhImageEffectNode( const OfxhImageEffectPlugin&         plugin,
                                          const OfxhImageEffectNodeDescriptor& descriptor,
                                          const std::string&                   context,
                                          bool                                 interactive )
        : OfxhImageEffectNodeBase( effectInstanceStuff )
        , _plugin( plugin )
        , _context( context )
        , _descriptor( descriptor )
        , _interactive( interactive )
        , _created( false )
        , _continuousSamples( false )
        , _frameVarying( false )
        , _outputFrameRate( 0 )
{
        _properties.setChainedSet( &descriptor.getProperties() );

        _properties.setPointerProperty( kOfxImageEffectPropPluginHandle, const_cast<OfxPlugin*>( _plugin.getPluginHandle()->getOfxPlugin() ) );

        _properties.setStringProperty( kOfxImageEffectPropContext, context );
        _properties.setIntProperty( kOfxPropIsInteractive, interactive );

        // copy is sequential over
        bool sequential = descriptor.getProperties().getIntProperty( kOfxImageEffectInstancePropSequentialRender ) != 0;
        _properties.setIntProperty( kOfxImageEffectInstancePropSequentialRender, sequential );

        initHook();
}

void OfxhImageEffectNode::initHook()
{
        int i = 0;
        
        while( effectInstanceStuff[i].name )
        {
                // don't set hooks for context or isinteractive
                if( strcmp( effectInstanceStuff[i].name, kOfxImageEffectPropContext ) &&
                    strcmp( effectInstanceStuff[i].name, kOfxPropIsInteractive ) &&
                    strcmp( effectInstanceStuff[i].name, kOfxImageEffectInstancePropSequentialRender ) )
                {
                        const property::OfxhPropSpec& spec = effectInstanceStuff[i];

                        switch( spec.type )
                        {
                                case property::ePropTypeDouble:
                                        _properties.setGetHook( spec.name, this );
                                        break;
                                default:
                                        break;
                        }
                }
                ++i;
        }
}

OfxhImageEffectNode::OfxhImageEffectNode( const OfxhImageEffectNode& other )
        : OfxhImageEffectNodeBase( other.getProperties() )
        //, attribute::OfxhParamSet( other ) // done in populate function
        //, attribute::OfxhClipImageSet( other ) // done in populate function
        , _plugin( other.getPlugin() )
        , _context( other.getContext() )
        , _descriptor( other.getDescriptor() )
        , _interactive( other._interactive )
        , _created( false )
        , _continuousSamples( other._continuousSamples )
        , _frameVarying( other._frameVarying )
        , _outputFrameRate( other._outputFrameRate )
{
        _properties.setChainedSet( &_descriptor.getProperties() );
        initHook();
}

/**
 * called after construction to populate clips and params
 */
void OfxhImageEffectNode::populate()
{
        populateClips( _descriptor );
        populateParams( _descriptor );
}

/**
 * @todo tuttle: move this in ParamSet !
 */
void OfxhImageEffectNode::populateParams( const imageEffect::OfxhImageEffectNodeDescriptor& descriptor )
{
        const attribute::OfxhParamSetDescriptor::ParamDescriptorList& paramDescriptors = _descriptor.getParamList();

        std::map<std::string, attribute::OfxhParam*> parameters;

        this->reserveParameters( paramDescriptors.size() );

        // Create parameters on their own groups
        for( attribute::OfxhParamSetDescriptor::ParamDescriptorList::const_iterator it = paramDescriptors.begin(), itEnd = paramDescriptors.end();
             it != itEnd;
             ++it )
        {
//              attribute::OfxhParamSet* setInstance = this;
                // SetInstance where the childrens param instances will be added
                const attribute::OfxhParamDescriptor& descriptor = *it;

                // name and parentName of the parameter
                std::string name       = descriptor.getName();
//              std::string parentName = descriptor.getParentName();
//
//              if( parentName != "" )
//              {
//                      attribute::OfxhParamGroup* parentGroup = dynamic_cast<attribute::OfxhParamGroup*>( parameters[parentName] );
//                      if( parentGroup )
//                      {
//                              setInstance = parentGroup->getChildrens();
//                      }
//              }
//              else
//                      setInstance = this;

                // get a param instance from a param descriptor. Param::Instance is automatically added into the setInstance provided.
                attribute::OfxhParam* instance = newParam( descriptor );
                /// @todo tuttle set the groups of the ParamInstance !!!
                parameters[name] = instance;
        }
}

/**
 * @todo tuttle check clip ? check hash ? etc.
 */
bool OfxhImageEffectNode::operator==( const OfxhImageEffectNode& other ) const
{
        if( OfxhImageEffectNodeBase::operator!=( other ) )
                return false;
        if( attribute::OfxhParamSet::operator!=( other ) )
                return false;
        if( attribute::OfxhClipImageSet::operator!=( other ) )
                return false;
        return true;
}

/**
 * implemented for Param::SetDescriptor
 */
property::OfxhSet& OfxhImageEffectNode::getParamSetProps()
{
        return _properties;
}

// do nothing
size_t OfxhImageEffectNode::getDimension( const std::string& name ) const OFX_EXCEPTION_SPEC
{
        TUTTLE_LOG_ERROR( "failing in " << __PRETTY_FUNCTION__ << " with name=" << name );
        BOOST_THROW_EXCEPTION( OfxhException( kOfxStatErrMissingHostFeature ) );
        return 0;
}

size_t OfxhImageEffectNode::upperGetDimension( const std::string& name )
{
        return _properties.getDimension( name );
}

void OfxhImageEffectNode::notify( const std::string& name, bool singleValue, int indexOrN ) OFX_EXCEPTION_SPEC
{
        TUTTLE_LOG_ERROR( "failing in " << __PRETTY_FUNCTION__ );
}

/**
 * don't know what to do
 */
void OfxhImageEffectNode::reset( const std::string& name ) OFX_EXCEPTION_SPEC
{
        TUTTLE_LOG_ERROR( "failing in " << __PRETTY_FUNCTION__ );
        BOOST_THROW_EXCEPTION( OfxhException( kOfxStatErrMissingHostFeature ) );
}

/**
 * get the virtuals for viewport size, pixel scale, background colour
 */
double OfxhImageEffectNode::getDoubleProperty( const std::string& name, int index ) const OFX_EXCEPTION_SPEC
{
        if( name == kOfxImageEffectPropProjectSize )
        {
                if( index >= 2 )
                        BOOST_THROW_EXCEPTION( OfxhException( kOfxStatErrBadIndex ) );
                double values[2];
                getProjectSize( values[0], values[1] );
                return values[index];
        }
        else if( name == kOfxImageEffectPropProjectOffset )
        {
                if( index >= 2 )
                        BOOST_THROW_EXCEPTION( OfxhException( kOfxStatErrBadIndex ) );
                double values[2];
                getProjectOffset( values[0], values[1] );
                return values[index];
        }
        else if( name == kOfxImageEffectPropProjectExtent )
        {
                if( index >= 2 )
                        BOOST_THROW_EXCEPTION( OfxhException( kOfxStatErrBadIndex ) );
                double values[2];
                getProjectExtent( values[0], values[1] );
                return values[index];
        }
        else if( name == kOfxImageEffectPropProjectPixelAspectRatio )
        {
                if( index >= 1 )
                        BOOST_THROW_EXCEPTION( OfxhException( kOfxStatErrBadIndex ) );
                return getOutputPixelAspectRatio();
        }
        else if( name == kOfxImageEffectInstancePropEffectDuration )
        {
                if( index >= 1 )
                        BOOST_THROW_EXCEPTION( OfxhException( kOfxStatErrBadIndex ) );
                return getEffectDuration();
        }
        else if( name == kOfxImageEffectPropFrameRate )
        {
                if( index >= 1 )
                        BOOST_THROW_EXCEPTION( OfxhException( kOfxStatErrBadIndex ) );
                return getOutputFrameRate();
        }
        BOOST_THROW_EXCEPTION( OfxhException( kOfxStatErrUnknown ) );
        return 0.0;
}

void OfxhImageEffectNode::getDoublePropertyN( const std::string& name, double* first, int n ) const OFX_EXCEPTION_SPEC
{
        if( name == kOfxImageEffectPropProjectSize )
        {
                if( n > 2 )
                        BOOST_THROW_EXCEPTION( OfxhException( kOfxStatErrBadIndex ) );
                getProjectSize( first[0], first[1] );
        }
        else if( name == kOfxImageEffectPropProjectOffset )
        {
                if( n > 2 )
                        BOOST_THROW_EXCEPTION( OfxhException( kOfxStatErrBadIndex ) );
                getProjectOffset( first[0], first[1] );
        }
        else if( name == kOfxImageEffectPropProjectExtent )
        {
                if( n > 2 )
                        BOOST_THROW_EXCEPTION( OfxhException( kOfxStatErrBadIndex ) );
                getProjectExtent( first[0], first[1] );
        }
        else if( name == kOfxImageEffectPropProjectPixelAspectRatio )
        {
                if( n > 1 )
                        BOOST_THROW_EXCEPTION( OfxhException( kOfxStatErrBadIndex ) );
                *first = getOutputPixelAspectRatio();
        }
        else if( name == kOfxImageEffectInstancePropEffectDuration )
        {
                if( n > 1 )
                        BOOST_THROW_EXCEPTION( OfxhException( kOfxStatErrBadIndex ) );
                *first = getEffectDuration();
        }
        else if( name == kOfxImageEffectPropFrameRate )
        {
                if( n > 1 )
                        BOOST_THROW_EXCEPTION( OfxhException( kOfxStatErrBadIndex ) );
                *first = getOutputFrameRate();
        }
        else
                BOOST_THROW_EXCEPTION( OfxhException( kOfxStatErrUnknown ) );
}

OfxhImageEffectNode::~OfxhImageEffectNode()
{
        // destroy the instance, only if succesfully created
        if( _created )
        {
                mainEntry( kOfxActionDestroyInstance, this->getHandle(), 0, 0 );
        }
}

/**
 * this is used to populate with any extra action in arguments that may be needed
 */
void OfxhImageEffectNode::setCustomInArgs( const std::string& action, property::OfxhSet& inArgs ) const {}

/**
 * this is used to populate with any extra action out arguments that may be needed
 */
void OfxhImageEffectNode::setCustomOutArgs( const std::string& action, property::OfxhSet& outArgs ) const {}

/**
 * this is used to populate with any extra action out arguments that may be needed
 */
void OfxhImageEffectNode::examineOutArgs( const std::string& action, OfxStatus, const property::OfxhSet& outArgs ) const {}

/**
 * check for connection
 */
bool OfxhImageEffectNode::checkClipConnectionStatus() const
{
        std::map<std::string, attribute::OfxhClipImage*>::const_iterator i;
        for( i = _clipImages.begin(); i != _clipImages.end(); ++i )
        {
                if( !i->second->isOptional() && !i->second->isConnected() )
                {
                        return false;
                }
        }
        return true;
}

/**
 * override this to make processing abort, return 1 to abort processing
 *
   int OfxhImageEffectNode::abort()
   {
    return 0;
   }
 */

/**
 * override this to use your own memory instance - must inherrit from memory::instance
 *
   OfxhMemory* OfxhImageEffectNode::newMemoryInstance( size_t nBytes )
   {
    OfxhMemory* instance = new OfxhMemory();
    instance->alloc( nBytes );
    return instance;
   }
 */

/**
 * @return an memory::instance calls makeMemoryInstance that can be overriden
 */
OfxhMemory* OfxhImageEffectNode::imageMemoryAlloc( size_t nBytes )
{
        return newMemoryInstance( nBytes );
}

/**
 * call the effect entry point
 */
OfxStatus OfxhImageEffectNode::mainEntry( const char*        action,
                                          const void*        handle,
                                          property::OfxhSet* inArgs,
                                          property::OfxhSet* outArgs ) const
{
        const OfxhPluginHandle* pHandle = _plugin.getPluginHandle();

        if( !pHandle )
                return kOfxStatFailed;

        const OfxPlugin* ofxPlugin = pHandle->getOfxPlugin();
        if( !ofxPlugin )
                return kOfxStatFailed;

        OfxPropertySetHandle inHandle = 0;
        if( inArgs )
        {
                setCustomInArgs( action, *inArgs );
                inHandle = inArgs->getHandle();
        }

        OfxPropertySetHandle outHandle = 0;
        if( outArgs )
        {
                setCustomOutArgs( action, *outArgs );
                outHandle = outArgs->getHandle();
        }

        OfxStatus stat = ofxPlugin->mainEntry( action, handle, inHandle, outHandle );

        if( outArgs )
                examineOutArgs( action, stat, *outArgs );

        return stat;
}

/**
 * create a clip instance
 */
void OfxhImageEffectNode::createInstanceAction() OFX_EXCEPTION_SPEC
{
        /// we need to init the clips before we call create instance incase
        /// they try and fetch something in create instance, which they are allowed
        setDefaultClipPreferences();

        // now tell the plug-in to create instance
        OfxStatus status = mainEntry( kOfxActionCreateInstance, this->getHandle(), 0, 0 );

        if( status != kOfxStatOK && status != kOfxStatReplyDefault )
                BOOST_THROW_EXCEPTION( OfxhException( status, "Create action failed on plugin " + getName() ) );

        _created = true;
}

/**
 * begin/change/end instance changed
 */
void OfxhImageEffectNode::beginInstanceChangedAction( const std::string& why ) OFX_EXCEPTION_SPEC
{
        property::OfxhPropSpec stuff[] = {
                { kOfxPropChangeReason, property::ePropTypeString, 1, true, why.c_str() },
                { 0 }
        };

        property::OfxhSet inArgs( stuff );

        OfxStatus status = mainEntry( kOfxActionBeginInstanceChanged, this->getHandle(), &inArgs, 0 );

        if( status != kOfxStatOK && status != kOfxStatReplyDefault )
                BOOST_THROW_EXCEPTION( OfxhException( status ) );
}

void OfxhImageEffectNode::paramInstanceChangedAction( const std::string& paramName,
                                                      const std::string& why,
                                                      OfxTime            time,
                                                      OfxPointD          renderScale ) OFX_EXCEPTION_SPEC
{
        if( getParamsByName()[paramName]->changedActionInProgress() )
        {
                return;
        }
        getParamsByName()[paramName]->changedActionBegin();
        /*attribute::OfxhParam& param = */ getParam( paramName );

        if( isClipPreferencesSlaveParam( paramName ) )
                _clipPrefsDirty = true;

        property::OfxhPropSpec stuff[] = {
                { kOfxPropType, property::ePropTypeString, 1, true, kOfxTypeParameter },
                { kOfxPropName, property::ePropTypeString, 1, true, paramName.c_str() },
                { kOfxPropChangeReason, property::ePropTypeString, 1, true, why.c_str() },
                { kOfxPropTime, property::ePropTypeDouble, 1, true, "0" },
                { kOfxImageEffectPropRenderScale, property::ePropTypeDouble, 2, true, "0" },
                { 0 }
        };

        property::OfxhSet inArgs( stuff );

        // add the second dimension of the render scale
        inArgs.setDoubleProperty( kOfxPropTime, time );

        inArgs.setDoublePropertyN( kOfxImageEffectPropRenderScale, &renderScale.x, 2 );

        OfxStatus status = mainEntry( kOfxActionInstanceChanged, this->getHandle(), &inArgs, 0 );

        if( status != kOfxStatOK && status != kOfxStatReplyDefault )
                BOOST_THROW_EXCEPTION( OfxhException( status ) );

        getParamsByName()[paramName]->changedActionEnd();

}

void OfxhImageEffectNode::clipInstanceChangedAction( const std::string& clipName,
                                                     const std::string& why,
                                                     OfxTime            time,
                                                     OfxPointD          renderScale ) OFX_EXCEPTION_SPEC
{
        _clipPrefsDirty = true;
        ClipImageMap::iterator it = _clipImages.find( clipName );
        if( it == _clipImages.end() )
                BOOST_THROW_EXCEPTION( OfxhException( kOfxStatFailed ) );

        property::OfxhPropSpec stuff[] = {
                { kOfxPropType, property::ePropTypeString, 1, true, kOfxTypeClip },
                { kOfxPropName, property::ePropTypeString, 1, true, it->second->getName().c_str() },
                { kOfxPropChangeReason, property::ePropTypeString, 1, true, why.c_str() },
                { kOfxPropTime, property::ePropTypeDouble, 1, true, "0" },
                { kOfxImageEffectPropRenderScale, property::ePropTypeDouble, 2, true, "0" },
                { 0 }
        };

        property::OfxhSet inArgs( stuff );

        // add the second dimension of the render scale
        inArgs.setDoubleProperty( kOfxPropTime, time );
        inArgs.setDoublePropertyN( kOfxImageEffectPropRenderScale, &renderScale.x, 2 );

        OfxStatus status = mainEntry( kOfxActionInstanceChanged, getHandle(), &inArgs, 0 );

        if( status != kOfxStatOK && status != kOfxStatReplyDefault )
                BOOST_THROW_EXCEPTION( OfxhException( status ) );
}

void OfxhImageEffectNode::endInstanceChangedAction( const std::string& why ) OFX_EXCEPTION_SPEC
{
        property::OfxhPropSpec whyStuff[] = {
                { kOfxPropChangeReason, property::ePropTypeString, 1, true, why.c_str() },
                { 0 }
        };

        property::OfxhSet inArgs( whyStuff );

        OfxStatus status = mainEntry( kOfxActionEndInstanceChanged, this->getHandle(), &inArgs, 0 );

        if( status != kOfxStatOK && status != kOfxStatReplyDefault )
                BOOST_THROW_EXCEPTION( OfxhException( status ) );
}

/**
 * purge plugin caches
 */
void OfxhImageEffectNode::purgeCachesAction() OFX_EXCEPTION_SPEC
{
        OfxStatus status = mainEntry( kOfxActionPurgeCaches, this->getHandle(), 0, 0 );

        if( status != kOfxStatOK && status != kOfxStatReplyDefault )
                BOOST_THROW_EXCEPTION( OfxhException( status ) );
}

/**
 * sync plugin private data
 */
void OfxhImageEffectNode::syncPrivateDataAction() OFX_EXCEPTION_SPEC
{
        OfxStatus status = mainEntry( kOfxActionSyncPrivateData, this->getHandle(), 0, 0 );

        if( status != kOfxStatOK && status != kOfxStatReplyDefault )
                BOOST_THROW_EXCEPTION( OfxhException( status ) );
}

/**
 * end edit instance
 */
void OfxhImageEffectNode::beginInstanceEditAction() OFX_EXCEPTION_SPEC
{
        OfxStatus status = mainEntry( kOfxActionBeginInstanceEdit, this->getHandle(), 0, 0 );

        if( status != kOfxStatOK && status != kOfxStatReplyDefault )
                BOOST_THROW_EXCEPTION( OfxhException( status ) );
}

/**
 * end edit instance
 */
void OfxhImageEffectNode::endInstanceEditAction() OFX_EXCEPTION_SPEC
{
        OfxStatus status = mainEntry( kOfxActionEndInstanceEdit, this->getHandle(), 0, 0 );

        if( status != kOfxStatOK && status != kOfxStatReplyDefault )
                BOOST_THROW_EXCEPTION( OfxhException( status ) );
}

void OfxhImageEffectNode::beginSequenceRenderAction( OfxTime   startFrame,
                                             OfxTime   endFrame,
                                             OfxTime   step,
                                             bool      interactive,
                                             OfxPointD renderScale ) OFX_EXCEPTION_SPEC
{
        property::OfxhPropSpec stuff[] = {
                { kOfxImageEffectPropFrameRange, property::ePropTypeDouble, 2, true, "0" },
                { kOfxImageEffectPropFrameStep, property::ePropTypeDouble, 1, true, "0" },
                { kOfxPropIsInteractive, property::ePropTypeInt, 1, true, "0" },
                { kOfxImageEffectPropRenderScale, property::ePropTypeDouble, 2, true, "0" },
                { 0 }
        };

        property::OfxhSet inArgs( stuff );

        // set up second dimension for frame range and render scale
        inArgs.setDoubleProperty( kOfxImageEffectPropFrameRange, startFrame, 0 );
        inArgs.setDoubleProperty( kOfxImageEffectPropFrameRange, endFrame, 1 );

        inArgs.setDoubleProperty( kOfxImageEffectPropFrameStep, step );

        inArgs.setIntProperty( kOfxPropIsInteractive, interactive );

        inArgs.setDoublePropertyN( kOfxImageEffectPropRenderScale, &renderScale.x, 2 );

        OfxStatus status = mainEntry( kOfxImageEffectActionBeginSequenceRender, this->getHandle(), &inArgs, 0 );

        if( status != kOfxStatOK && status != kOfxStatReplyDefault )
                BOOST_THROW_EXCEPTION( OfxhException( status ) );
}

void OfxhImageEffectNode::renderAction( OfxTime            time,
                                        const std::string& field,
                                        const OfxRectI&    renderWindow,
                                        OfxPointD          renderScale ) OFX_EXCEPTION_SPEC
{
        static const property::OfxhPropSpec stuff[] = {
                { kOfxPropTime, property::ePropTypeDouble, 1, true, "0" },
                { kOfxImageEffectPropFieldToRender, property::ePropTypeString, 1, true, "" },
                { kOfxImageEffectPropRenderWindow, property::ePropTypeInt, 4, true, "0" },
                { kOfxImageEffectPropRenderScale, property::ePropTypeDouble, 2, true, "0" },
                { 0 }
        };

        property::OfxhSet inArgs( stuff );

        inArgs.setDoubleProperty( kOfxPropTime, time );
        inArgs.setStringProperty( kOfxImageEffectPropFieldToRender, field );
        inArgs.setIntPropertyN( kOfxImageEffectPropRenderWindow, &renderWindow.x1, 4 );
        inArgs.setDoublePropertyN( kOfxImageEffectPropRenderScale, &renderScale.x, 2 );

        //TUTTLE_TLOG( TUTTLE_INFO, "OfxhImageEffect::renderAction inArgs=" << inArgs );

        OfxStatus status = mainEntry( kOfxImageEffectActionRender, this->getHandle(), &inArgs, 0 );

        if( status != kOfxStatOK && status != kOfxStatReplyDefault )
                BOOST_THROW_EXCEPTION( OfxhException( status, "Error in ActionRender on node \"" + this->getName() + "\" at time " + boost::lexical_cast<std::string>( time ) + "." ) );
}

void OfxhImageEffectNode::endSequenceRenderAction( OfxTime   startFrame,
                                           OfxTime   endFrame,
                                           OfxTime   step,
                                           bool      interactive,
                                           OfxPointD renderScale ) OFX_EXCEPTION_SPEC
{
        property::OfxhPropSpec stuff[] = {
                { kOfxImageEffectPropFrameRange, property::ePropTypeDouble, 2, true, "0" },
                { kOfxImageEffectPropFrameStep, property::ePropTypeDouble, 1, true, "0" },
                { kOfxPropIsInteractive, property::ePropTypeInt, 1, true, "0" },
                { kOfxImageEffectPropRenderScale, property::ePropTypeDouble, 2, true, "0" },
                { 0 }
        };

        property::OfxhSet inArgs( stuff );

        inArgs.setDoubleProperty( kOfxImageEffectPropFrameStep, step );

        inArgs.setDoubleProperty( kOfxImageEffectPropFrameRange, startFrame, 0 );
        inArgs.setDoubleProperty( kOfxImageEffectPropFrameRange, endFrame, 1 );
        inArgs.setIntProperty( kOfxPropIsInteractive, interactive );
        inArgs.setDoublePropertyN( kOfxImageEffectPropRenderScale, &renderScale.x, 2 );

        OfxStatus status = mainEntry( kOfxImageEffectActionEndSequenceRender, this->getHandle(), &inArgs, 0 );

        if( status != kOfxStatOK && status != kOfxStatReplyDefault )
                BOOST_THROW_EXCEPTION( OfxhException( status ) );
}

OfxRectD OfxhImageEffectNode::computeClipRodUnionAtTimes( const attribute::OfxhClipImage& clip, const TimesSet& timesSet ) const
{       
        OfxRectD rod = { 0, 0, 0, 0 };
        bool gotOne = false;
        BOOST_FOREACH( const TimesSet::value_type& inTime, timesSet )
        {
                const OfxRectD localRod = clip.fetchRegionOfDefinition( inTime );
                if( !gotOne )
                {
                        rod = localRod;
                        gotOne = true;
                }
                else
                {
                        rod = rectUnion( rod, localRod );
                }
        }
        return rod;
}


/**
 * calculate the default rod for this effect instance
 */
OfxRectD OfxhImageEffectNode::calcDefaultRegionOfDefinition( OfxTime   time,
                                                             OfxPointD renderScale ) const
{
        ClipTimesSetMap timesSetMap = getFramesNeeded( time ); /// @todo: do not recompute this here
        
//      TUTTLE_TLOG( TUTTLE_INFO, "calcDefaultRegionOfDefinition" );
//      TUTTLE_TLOG_VAR( TUTTLE_INFO, _context );
        OfxRectD rod = { 0, 0, 0, 0 };
        try
        {
                // figure out the default contexts
                if( _context == kOfxImageEffectContextGenerator ||
                        _context == kOfxImageEffectContextReader )
                {
                        // generator is the extent
                        rod.x1 = rod.y1 = 0;
                        getProjectExtent( rod.x2, rod.y2 );
                        const attribute::OfxhClipImage& clip = getClip( kOfxImageEffectOutputClipName );
                        rod = clip.fetchRegionOfDefinition( time );
                        /// @todo tuttle: maybe RoD problems with Generator and Read here... to check !
                }
                else if( _context == kOfxImageEffectContextFilter ||
                        _context == kOfxImageEffectContextPaint  ||
                        _context == kOfxImageEffectContextWriter )
                {
                        // filter and paint default to the input clip
                        const attribute::OfxhClipImage& clip = getClip( kOfxImageEffectSimpleSourceClipName );

                        // depending on framesNeeded
                        rod = computeClipRodUnionAtTimes( clip, timesSetMap[clip.getName()] );
                }
                else if( _context == kOfxImageEffectContextTransition )
                {
                        // transition is the union of the two clips
                        const attribute::OfxhClipImage& clipFrom = getClip( kOfxImageEffectTransitionSourceFromClipName );
                        const attribute::OfxhClipImage& clipTo   = getClip( kOfxImageEffectTransitionSourceToClipName );

                        rod = computeClipRodUnionAtTimes( clipFrom, timesSetMap[clipFrom.getName()] );
                        rod = rectUnion( rod, computeClipRodUnionAtTimes( clipTo, timesSetMap[clipTo.getName()] ) );
                }
                else if( _context == kOfxImageEffectContextGeneral )
                {
                        // general context is the union of all the non optional clips
                        bool gotOne = false;
                        BOOST_FOREACH( const ClipImageMap::value_type& clipPair, _clipImages )
                        {
                                attribute::OfxhClipImage* clip = clipPair.second;
                                if( ! clip->isOutput() && clip->isConnected() )
                                {
                                        // depending on framesNeeded
                                        const TimesSet& timesSet = timesSetMap[clip->getName()];
                                        if( timesSet.size() == 0 )
                                                continue; // the plugin don't use this input (is it allowed by the standard?)
                                        BOOST_FOREACH( const TimesSet::value_type& inTime, timesSet )
                                        {
                                                const OfxRectD localRod = clip->fetchRegionOfDefinition( inTime );
                                                if( !gotOne )
                                                {
                                                        rod = localRod;
                                                        gotOne = true;
                                                }
                                                else
                                                {
                                                        rod = rectUnion( rod, localRod );
                                                }
                                        }
                                }
                        }

                        if( !gotOne )
                        {
                                // no non optionals? then be the extent
                                rod.x1 = rod.y1 = 0;
                                getProjectExtent( rod.x2, rod.y2 );
                        }

                }
                else if( _context == kOfxImageEffectContextRetimer )
                {
                        // retimer
                        const attribute::OfxhClipImage& clip = getClip( kOfxImageEffectSimpleSourceClipName );
                        /*attribute::ParamDoubleInstance& retimerParam = */ dynamic_cast<const attribute::OfxhParamDouble&>( getParam( kOfxImageEffectRetimerParamName ) );
                        rod = computeClipRodUnionAtTimes( clip, timesSetMap[clip.getName()] );
                }
        }
        catch( boost::exception& e )
        {
                if( ! boost::get_error_info<exception::dev>( e ) )
                        e << exception::dev() + "Error while computing the default ROD.";
                e << exception::ofxContext( _context );
                e << exception::pluginIdentifier( getPlugin().getIdentifier() );
                throw;
        }
        return rod;
}

/**
 * RoD call
 */
void OfxhImageEffectNode::getRegionOfDefinitionAction( OfxTime   time,
                                                       OfxPointD renderScale,
                                                       OfxRectD& rod ) const OFX_EXCEPTION_SPEC
{
        property::OfxhPropSpec inStuff[] = {
                { kOfxPropTime, property::ePropTypeDouble, 1, true, "0" },
                { kOfxImageEffectPropRenderScale, property::ePropTypeDouble, 2, true, "0" },
                { 0 }
        };

        property::OfxhPropSpec outStuff[] = {
                { kOfxImageEffectPropRegionOfDefinition, property::ePropTypeDouble, 4, false, "0" },
                { 0 }
        };

        property::OfxhSet inArgs( inStuff );
        property::OfxhSet outArgs( outStuff );

        inArgs.setDoubleProperty( kOfxPropTime, time );

        inArgs.setDoublePropertyN( kOfxImageEffectPropRenderScale, &renderScale.x, 2 );

        OfxStatus stat = mainEntry( kOfxImageEffectActionGetRegionOfDefinition,
                                    this->getHandle(),
                                    &inArgs,
                                    &outArgs );

        if( stat == kOfxStatOK )
        {
                outArgs.getDoublePropertyN( kOfxImageEffectPropRegionOfDefinition, &rod.x1, 4 );
        }
        else if( stat == kOfxStatReplyDefault )
        {
                rod = calcDefaultRegionOfDefinition( time, renderScale );
        }
        else
        {
                // defined to process sequences with hole
                // find a best way to do this ??
                if( _context == kOfxImageEffectContextReader )
                        BOOST_THROW_EXCEPTION( tuttle::exception::FileInSequenceNotExist() );
                
                BOOST_THROW_EXCEPTION( OfxhException( stat, "getRegionOfDefinitionAction error." ) );
        }
}

/**
 * get the region of interest for each input and return it in the given std::map
 */
void OfxhImageEffectNode::getRegionOfInterestAction( OfxTime time,
                                                     OfxPointD renderScale,
                                                     const OfxRectD& roi,
                                                     std::map<attribute::OfxhClipImage*, OfxRectD>& rois ) const OFX_EXCEPTION_SPEC
{
        // reset the map
        rois.clear();

        ClipTimesSetMap timesSetMap = getFramesNeeded( time );
        
        if( !supportsTiles() )
        {
                /// No tiling support on the effect at all. So set the roi of each input clip to be the RoD of that clip.
                BOOST_FOREACH( const ClipImageMap::value_type& clip, _clipImages )
                {
                        if( ! clip.second->isOutput() ||
                            getContext() == kOfxImageEffectContextGenerator ||
                            getContext() == kOfxImageEffectContextReader )
                        {
                                if( clip.second->isOutput() || clip.second->isConnected() ) // needed to be able to fetch the RoD
                                {
                                        /// @todo tuttle: how to support size on generators... check if this is correct in all cases.
                                        OfxRectD roi = clip.second->fetchRegionOfDefinition( time );
                                        rois[clip.second] = roi;
                                }
                        }
                }
        }
        else
        {
                /// set up the in args
                static property::OfxhPropSpec inStuff[] = {
                        { kOfxPropTime, property::ePropTypeDouble, 1, true, "0" },
                        { kOfxImageEffectPropRenderScale, property::ePropTypeDouble, 2, true, "0" },
                        { kOfxImageEffectPropRegionOfInterest, property::ePropTypeDouble, 4, true, 0 },
                        { 0 }
                };
                property::OfxhSet inArgs( inStuff );

                inArgs.setDoublePropertyN( kOfxImageEffectPropRenderScale, &renderScale.x, 2 );
                inArgs.setDoubleProperty( kOfxPropTime, time );
                inArgs.setDoublePropertyN( kOfxImageEffectPropRegionOfInterest, &roi.x1, 4 );

                property::OfxhSet outArgs;
                std::list<std::string> keepPropNamesOwnership;
                
                BOOST_FOREACH( const ClipImageMap::value_type& clip, _clipImages )
                {
                        if( ! clip.second->isOutput() ||
                            getContext() == kOfxImageEffectContextGenerator ||
                            getContext() == kOfxImageEffectContextReader )
                        {
                                keepPropNamesOwnership.push_back( "OfxImageClipPropRoI_" + clip.first );
                                const std::string& name = keepPropNamesOwnership.back();

                                property::OfxhPropSpec s;
                                s.name         = name.c_str();
                                s.type         = property::ePropTypeDouble;
                                s.dimension    = 4;
                                s.readonly     = false;
                                s.defaultValue = "";
                                outArgs.createProperty( s );

                                /// initialise to the default
                                outArgs.setDoublePropertyN( s.name, &roi.x1, 4 );
                        }
                }

                /// call the action
                const OfxStatus status = mainEntry( kOfxImageEffectActionGetRegionsOfInterest,
                                              this->getHandle(),
                                              &inArgs,
                                              &outArgs );

                if( status != kOfxStatOK && status != kOfxStatReplyDefault )
                        BOOST_THROW_EXCEPTION( OfxhException( status ) );

                /// set the thing up
                BOOST_FOREACH( const ClipImageMap::value_type& clip, _clipImages )
                {
                        if( ! clip.second->isOutput() ||
                            getContext() == kOfxImageEffectContextGenerator ||
                            getContext() == kOfxImageEffectContextReader )
                        {
                                if( clip.second->isOutput() || clip.second->isConnected() ) // needed to be able to fetch the RoD
                                {
                                        // depending on framesNeeded !
                                        const TimesSet& timesSet = timesSetMap[clip.second->getName()];
                                        if( timesSet.size() == 0 )
                                                continue; // the plugin don't use this input (is it allowed by the standard?)
                                        // use intersection?
                                        OfxRectD inputsRodIntersection = clip.second->fetchRegionOfDefinition( *(timesSet.begin()) );
                                        BOOST_FOREACH( const TimesSet::value_type& inTime, timesSet )
                                        {
                                                const OfxRectD timeRod = clip.second->fetchRegionOfDefinition( inTime );
                                                inputsRodIntersection = clamp( timeRod, inputsRodIntersection );
                                        }
                                        if( clip.second->supportsTiles() )
                                        {
                                                const std::string name = "OfxImageClipPropRoI_" + clip.first;
                                                OfxRectD thisRoi;
                                                thisRoi.x1 = outArgs.getDoubleProperty( name, 0 );
                                                thisRoi.y1 = outArgs.getDoubleProperty( name, 1 );
                                                thisRoi.x2 = outArgs.getDoubleProperty( name, 2 );
                                                thisRoi.y2 = outArgs.getDoubleProperty( name, 3 );

                                                // clamp it to the clip's rod
                                                thisRoi          = clamp( thisRoi, inputsRodIntersection );
                                                rois[clip.second] = thisRoi;
                                        }
                                        else
                                        {
                                                /// not supporting tiles on this input, so set it to the rod
                                                rois[clip.second] = inputsRodIntersection;
                                        }
                                }
                        }
                }
        }
}

/**
 * see how many frames are needed from each clip to render the indicated frame
 */
void OfxhImageEffectNode::getFramesNeededAction( OfxTime   time,
                                                ClipRangeMap& rangeMap ) const OFX_EXCEPTION_SPEC
{
        OfxStatus status = kOfxStatReplyDefault;
        property::OfxhSet outArgs;
        std::list<std::string> keepPropNamesOwnership;

        if( temporalAccess() )
        {
                property::OfxhPropSpec inStuff[] = {
                        { kOfxPropTime, property::ePropTypeDouble, 1, true, "0" },
                        { 0 }
                };
                property::OfxhSet inArgs( inStuff );
                inArgs.setDoubleProperty( kOfxPropTime, time );

                for( ClipImageMap::const_iterator it = _clipImages.begin(), itEnd = _clipImages.end();
                     it != itEnd;
                     ++it )
                {
                        if( !it->second->isOutput() )
                        {
                                keepPropNamesOwnership.push_back( "OfxImageClipPropFrameRange_" + it->first );
                                const std::string& name = keepPropNamesOwnership.back();

                                property::OfxhPropSpec s;
                                s.name         = name.c_str();
                                s.type         = property::ePropTypeDouble;
                                s.dimension    = 0;
                                s.readonly     = false;
                                s.defaultValue = "";
                                outArgs.createProperty( s );
                                /// intialise it to the current frame
                                outArgs.setDoubleProperty( name, time, 0 );
                                outArgs.setDoubleProperty( name, time, 1 );
                        }
                }

                status = mainEntry( kOfxImageEffectActionGetFramesNeeded,
                                    this->getHandle(),
                                    &inArgs,
                                    &outArgs );

                if( status != kOfxStatOK && status != kOfxStatReplyDefault )
                        BOOST_THROW_EXCEPTION( OfxhException( status ) );
        }

        OfxRangeD defaultRange;
        defaultRange.min = defaultRange.max = time;

        for( ClipImageMap::const_iterator it = _clipImages.begin(), itEnd = _clipImages.end();
             it != itEnd;
             ++it )
        {
                attribute::OfxhClipImage* clip = it->second;

                if( !clip->isOutput() )
                {
                        if( status == kOfxStatReplyDefault )
                        {
                                rangeMap[clip].push_back( defaultRange );
                        }
                        else
                        {
                                const std::string name = "OfxImageClipPropFrameRange_" + it->first;

                                int nRanges = outArgs.getDimension( name );
                                if( nRanges % 2 != 0 )
                                        BOOST_THROW_EXCEPTION( OfxhException( kOfxStatErrValue, "Frame range needs to be divisible by 2." ) );

                                if( nRanges == 0 )
                                {
                                        rangeMap[clip].push_back( defaultRange );
                                }
                                else
                                {
                                        for( int r = 0; r < nRanges; )
                                        {
                                                double min = outArgs.getDoubleProperty( name, r );
                                                double max = outArgs.getDoubleProperty( name, r + 1 );
                                                r += 2;

                                                OfxRangeD range;
                                                range.min = min;
                                                range.max = max;
                                                rangeMap[clip].push_back( range );
                                        }
                                }
                        }
                }
        }
}

OfxhImageEffectNode::ClipTimesSetMap OfxhImageEffectNode::getFramesNeeded( const OfxTime time ) const
{
        const bool temporalClipAccess = this->getProperties().fetchIntProperty( kOfxImageEffectPropTemporalClipAccess ).getValue();
        ClipTimesSetMap result;
        if( temporalClipAccess )
        {
                ClipRangeMap clipMap;
                getFramesNeededAction( time, clipMap );
                BOOST_FOREACH( const ClipRangeMap::value_type& v, clipMap )
                {
                        BOOST_FOREACH( const ClipRangeMap::value_type::second_type::value_type& range, v.second )
                        {
                                for( OfxTime t = range.min; t <= range.max; t += 1.0 )
                                {
                                        result[ v.first->getName() ].insert(t);
                                }
                        }
                }
        }
        else
        {
                BOOST_FOREACH( ClipImageVector::const_reference v, _clipsByOrder )
                {
                        result[v.getName()].insert(time);
                }
        }
        return result;
}

bool OfxhImageEffectNode::isIdentityAction( OfxTime&           time,
                                            const std::string& field,
                                            const OfxRectI&    renderWindow,
                                            OfxPointD          renderScale,
                                            std::string&       clip ) const OFX_EXCEPTION_SPEC
{
        static property::OfxhPropSpec inStuff[] = {
                { kOfxPropTime, property::ePropTypeDouble, 1, true, "0" },
                { kOfxImageEffectPropFieldToRender, property::ePropTypeString, 1, true, "" },
                { kOfxImageEffectPropRenderWindow, property::ePropTypeInt, 4, true, "0" },
                { kOfxImageEffectPropRenderScale, property::ePropTypeDouble, 2, true, "0" },
                { 0 }
        };

        static property::OfxhPropSpec outStuff[] = {
                { kOfxPropTime, property::ePropTypeDouble, 1, false, "0.0" },
                { kOfxPropName, property::ePropTypeString, 1, false, "" },
                { 0 }
        };

        property::OfxhSet inArgs( inStuff );

        inArgs.setStringProperty( kOfxImageEffectPropFieldToRender, field );
        inArgs.setDoubleProperty( kOfxPropTime, time );
        inArgs.setIntPropertyN( kOfxImageEffectPropRenderWindow, &renderWindow.x1, 4 );
        inArgs.setDoublePropertyN( kOfxImageEffectPropRenderScale, &renderScale.x, 2 );

        property::OfxhSet outArgs( outStuff );

        outArgs.setDoubleProperty( kOfxPropTime, time );

        OfxStatus status = mainEntry( kOfxImageEffectActionIsIdentity,
                                      this->getHandle(),
                                      &inArgs,
                                      &outArgs );

        if( status != kOfxStatOK && status != kOfxStatReplyDefault )
                BOOST_THROW_EXCEPTION( OfxhException( status ) );

        time = outArgs.getDoubleProperty( kOfxPropTime );
        clip = outArgs.getStringProperty( kOfxPropName );

        return status == kOfxStatOK;
}

/**
 * Get whether the component is a supported 'chromatic' component (RGBA or alpha) in
 * the base API.
 * Override this if you have extended your chromatic colour types (eg RGB) and want
 * the clip preferences logic to still work
 */
bool OfxhImageEffectNode::isChromaticComponent( const std::string& str ) const
{
        if( str == kOfxImageComponentRGBA )
                return true;
        if( str == kOfxImageComponentRGB )
                return true;
        if( str == kOfxImageComponentAlpha )
                return true;
        return false;
}

/**
 * function to check for multiple bit depth support
 * The answer will depend on host, plugin and context
 */
bool OfxhImageEffectNode::canCurrentlyHandleMultipleClipDepths() const
{
        /// does the host support 'em
        bool hostSupports = tuttle::host::core().getHost().getProperties().getIntProperty( kOfxImageEffectPropSupportsMultipleClipDepths ) != 0;

        /// does the plug-in support 'em
        bool pluginSupports = supportsMultipleClipDepths();

        /// no support, so no
        if( !hostSupports || !pluginSupports )
                return false;

        // in the standard, it's written that only general context can handle multiple clip depth...
        // but we remove this restriction for filters and generators (to allow input bitdepth != output bitdepth)
        //      if( _context == kOfxImageEffectContextFilter || _context == kOfxImageEffectContextGenerator )
        //              return false;
        if(
            _context == kOfxImageEffectContextTransition ||
            _context == kOfxImageEffectContextPaint ||
            _context == kOfxImageEffectContextRetimer )
                return false;

        return true;
}

/**
 * Setup the default clip preferences on the clips
 */
void OfxhImageEffectNode::setDefaultClipPreferences()
{
        /// is there multiple bit depth support? Depends on host, plugin and context
        bool multiBitDepth = canCurrentlyHandleMultipleClipDepths();

        /// OK find the deepest chromatic component on our input clips and the one with the
        /// most components
        std::string deepestBitDepth = kOfxBitDepthNone;
        std::string mostComponents  = kOfxImageComponentNone;
        double frameRate            = 0.0;
        double defaultPixelAspectRatio = 0.0;
        std::string premult         = kOfxImageOpaque;

        for( std::map<std::string, attribute::OfxhClipImage*>::iterator it = _clipImages.begin();
             it != _clipImages.end();
             it++ )
        {
                attribute::OfxhClipImage* clip = it->second;

                // If input clip
                if( !clip->isOutput() )
                {
                        if( clip->isConnected() )
                        {
                                frameRate = maximum( frameRate, clip->getFrameRate() );
                        }
                        defaultPixelAspectRatio = std::max( defaultPixelAspectRatio, clip->getPixelAspectRatio() );

                        std::string rawComp = clip->getUnmappedComponents();
                        rawComp = clip->findSupportedComp( rawComp ); // turn that into a comp the plugin expects on that clip

                        const std::string& rawDepth   = clip->getUnmappedBitDepth();
                        const std::string& rawPreMult = clip->getPremult();

                        if( isChromaticComponent( rawComp ) )
                        {
                                if( rawPreMult == kOfxImagePreMultiplied )
                                        premult = kOfxImagePreMultiplied;
                                else if( rawPreMult == kOfxImageUnPreMultiplied && premult != kOfxImagePreMultiplied )
                                        premult = kOfxImageUnPreMultiplied;
                                deepestBitDepth = findDeepestBitDepth( deepestBitDepth, rawDepth );
                                mostComponents  = findMostChromaticComponents( mostComponents, rawComp );
                        }
                }
        }

        // default value if the generator don't set the framerate
        if( frameRate == 0.0 )
                frameRate = 25.0;
        if( defaultPixelAspectRatio == 0.0 )
                defaultPixelAspectRatio = 1.0;
        
        /// set some stuff up
        _outputFrameRate         = frameRate;
        _outputFielding          = getDefaultOutputFielding();
        _outputPreMultiplication = premult;
        _continuousSamples       = false;
        _frameVarying            = false;
        getOutputOfxhClip().setPixelAspectRatio( defaultPixelAspectRatio, property::eModifiedByHost );

        /// now find the best depth that the plugin supports
        deepestBitDepth = bestSupportedBitDepth( deepestBitDepth );

        /// now add the clip gubbins to the out args
        for( std::map<std::string, attribute::OfxhClipImage*>::iterator it = _clipImages.begin();
             it != _clipImages.end();
             ++it )
        {
                attribute::OfxhClipImage* clip = it->second;

                std::string rawComp = clip->getUnmappedComponents();
                rawComp = clip->findSupportedComp( rawComp ); // turn that into a comp the plugin expects on that clip
                const std::string& rawDepth = clip->getUnmappedBitDepth();
                if( isChromaticComponent( rawComp ) )
                {
                        if( clip->isOutput() )
                        {
                                std::string depth = deepestBitDepth;
                                std::string comp  = clip->findSupportedComp( mostComponents );
                                clip->setBitDepthString( depth );
                                clip->setComponentsString( comp );
                        }
                        else
                        {
                                std::string comp  = rawComp;
                                std::string depth = multiBitDepth ? bestSupportedBitDepth( rawDepth ) : deepestBitDepth;

                                clip->setBitDepthString( depth );
                                clip->setComponentsString( comp );
                        }
                }
                else
                {
                        /// hmm custom component type, don't touch it and pass it through
                        clip->setBitDepthString( rawDepth );
                        clip->setComponentsString( rawComp );
                }
        }
}

/**
 * Initialise the clip preferences arguments, override this to do
 * stuff with wierd components etc...
 */
void OfxhImageEffectNode::setupClipPreferencesArgs( property::OfxhSet& outArgs, std::list<std::string>& outKeepPropNamesOwnership )
{
        // http://openfx.sourceforge.net/Documentation/1.3/ofxProgrammingReference.html#ImageEffectClipPreferences
        
        /// reset all the clip prefs stuff to their defaults
        setDefaultClipPreferences();

        static property::OfxhPropSpec clipPrefsStuffs [] = {
                { kOfxImageEffectPropFrameRate, property::ePropTypeDouble, 1, false, "1" },
                { kOfxImageEffectPropPreMultiplication, property::ePropTypeString, 1, false, "" },
                { kOfxImageClipPropFieldOrder, property::ePropTypeString, 1, false, "" },
                { kOfxImageClipPropContinuousSamples, property::ePropTypeInt, 1, false, "0" },
                { kOfxImageEffectFrameVarying, property::ePropTypeInt, 1, false, "0" },
                { 0 }
        };

        outArgs.addProperties( clipPrefsStuffs );

        /// set the default for those

        /// is there multiple bit depth support? Depends on host, plugin and context
        bool multiBitDepth = canCurrentlyHandleMultipleClipDepths();

        outArgs.setStringProperty( kOfxImageClipPropFieldOrder, _outputFielding );
        outArgs.setStringProperty( kOfxImageEffectPropPreMultiplication, _outputPreMultiplication );
        outArgs.setDoubleProperty( kOfxImageEffectPropFrameRate, _outputFrameRate );

        /// now add the clip gubbins to the out args
        for( std::map<std::string, attribute::OfxhClipImage*>::iterator it = _clipImages.begin();
             it != _clipImages.end();
             ++it )
        {
                attribute::OfxhClipImage* clip = it->second;

                outKeepPropNamesOwnership.push_back( "OfxImageClipPropComponents_" + it->first );
                const std::string& componentParamName = outKeepPropNamesOwnership.back();
                property::OfxhPropSpec specComp = { componentParamName.c_str(), property::ePropTypeString, 0, false, "" }; // note the support for multi-planar clips
                outArgs.createProperty( specComp );
                // as it is variable dimension, there is no default value, so we have to set it explicitly
                outArgs.setStringProperty( componentParamName, clip->getComponentsString() );

                outKeepPropNamesOwnership.push_back( "OfxImageClipPropDepth_" + it->first );
                const std::string& depthParamName = outKeepPropNamesOwnership.back();
                property::OfxhPropSpec specDep = { depthParamName.c_str(), property::ePropTypeString, 1, !multiBitDepth, clip->getBitDepthString().c_str() };
                outArgs.createProperty( specDep );
                outArgs.setStringProperty( depthParamName, clip->getBitDepthString() );

                outKeepPropNamesOwnership.push_back( "OfxImageClipPropPAR_" + it->first );
                const std::string& parParamName = outKeepPropNamesOwnership.back();
                property::OfxhPropSpec specPAR = { parParamName.c_str(), property::ePropTypeDouble, 1, false, "1" };
                outArgs.createProperty( specPAR );
                outArgs.setDoubleProperty( parParamName, clip->getPixelAspectRatio() );
        }
}

bool OfxhImageEffectNode::isLeafNode() const
{
        for( ClipImageMap::const_iterator it = _clipImages.begin();
             it != _clipImages.end();
             ++it )
        {
                attribute::OfxhClipImage* clip = it->second;

                if( ! clip->isOutput() && clip->isConnected() )
                        return false;
        }
        return true;
}

void OfxhImageEffectNode::setupClipInstancePreferences( property::OfxhSet& outArgs )
{
        const bool isLeaf = isLeafNode();

        for( ClipImageMap::iterator it = _clipImages.begin();
             it != _clipImages.end();
             ++it )
        {
                attribute::OfxhClipImage* clip = it->second;

                // Properties setup
                const std::string componentParamName = "OfxImageClipPropComponents_" + it->first;
                const std::string depthParamName     = "OfxImageClipPropDepth_" + it->first;
                const std::string parParamName       = "OfxImageClipPropPAR_" + it->first;

                const property::String& propPixelDepth = outArgs.fetchStringProperty( depthParamName );
                clip->setBitDepthString( propPixelDepth.getValue(), propPixelDepth.getModifiedBy() );

                const property::String& propComponent = outArgs.fetchStringProperty( componentParamName );
                clip->setComponentsString( propComponent.getValue(), propComponent.getModifiedBy() );

                const property::Double& propPixelAspectRatio = outArgs.fetchDoubleProperty( parParamName );
                clip->setPixelAspectRatio( propPixelAspectRatio.getValue(), propPixelAspectRatio.getModifiedBy() );

                if( isLeaf &&
                        it->first == kOfxImageEffectOutputClipName &&
                        propPixelDepth.getModifiedBy() != property::eModifiedByPlugin &&
                        propPixelDepth.getValue() == kOfxBitDepthNone
                  )
                {
                        // If a generator node (even if declared in the general context) don't set the
                        // bitdepth... we set an arbitrary default value.
                        clip->setBitDepthString( kOfxBitDepthFloat, property::eModifiedByHost );
                }
        }
        
        _outputFrameRate         = outArgs.getDoubleProperty( kOfxImageEffectPropFrameRate );
        _outputFielding          = outArgs.getStringProperty( kOfxImageClipPropFieldOrder );
        _outputPreMultiplication = outArgs.getStringProperty( kOfxImageEffectPropPreMultiplication );
        _continuousSamples       = outArgs.getIntProperty( kOfxImageClipPropContinuousSamples ) != 0;
        _frameVarying            = outArgs.getIntProperty( kOfxImageEffectFrameVarying ) != 0;
}

/**
 * the idea here is the clip prefs live as active props on the effect
 * and are set up by clip preferences. The action manages the clip
 * preferences bits. We also monitor clip and param changes and
 * flag when clip prefs is dirty.
 * call the clip preferences action
 */
void OfxhImageEffectNode::getClipPreferencesAction() OFX_EXCEPTION_SPEC
{
        /// create the out args with the stuff that does not depend on individual clips
        property::OfxhSet outArgs;
        std::list<std::string> keepPropNamesOwnership;

        
        setupClipPreferencesArgs( outArgs, keepPropNamesOwnership );

        const OfxStatus status = mainEntry( kOfxImageEffectActionGetClipPreferences,
                                      this->getHandle(),
                                      0,
                                      &outArgs );

        if( status != kOfxStatOK &&
            status != kOfxStatReplyDefault )
        {
                BOOST_THROW_EXCEPTION( OfxhException( status ) );
        }
        
        // Setup members data from loaded properties
        setupClipInstancePreferences( outArgs );

        _clipPrefsDirty = false;
}

/**
 * find the most chromatic components out of the two. Override this if you define
 * more chromatic components
 */
const std::string& OfxhImageEffectNode::findMostChromaticComponents( const std::string& a, const std::string& b ) const
{
        if( a == kOfxImageComponentNone )
                return b;
        if( a == kOfxImageComponentRGBA )
                return a;
        if( b == kOfxImageComponentRGBA )
                return b;
        if( a == kOfxImageComponentRGB )
                return a;
        if( b == kOfxImageComponentRGB )
                return b;
        return a;
}

/**
 * given the bit depth, find the best match for it.
 */
const std::string& OfxhImageEffectNode::bestSupportedBitDepth( const std::string& depth ) const
{
        static const std::string none( kOfxBitDepthNone );
        static const std::string bytes( kOfxBitDepthByte );
        static const std::string shorts( kOfxBitDepthShort );
        static const std::string floats( kOfxBitDepthFloat );

        if( depth == none )
                return none;

        if( isBitDepthSupported( depth ) )
                return depth;

        if( depth == floats )
        {
                if( isBitDepthSupported( shorts ) )
                        return shorts;
                if( isBitDepthSupported( bytes ) )
                        return bytes;
        }

        if( depth == shorts )
        {
                if( isBitDepthSupported( floats ) )
                        return floats;
                if( isBitDepthSupported( bytes ) )
                        return bytes;
        }

        if( depth == bytes )
        {
                if( isBitDepthSupported( shorts ) )
                        return shorts;
                if( isBitDepthSupported( floats ) )
                        return floats;
        }

        /// Something wrong here
        return none;
}

bool OfxhImageEffectNode::getTimeDomainAction( OfxRangeD& range ) const OFX_EXCEPTION_SPEC
{
        property::OfxhPropSpec outStuff[] = {
                { kOfxImageEffectPropFrameRange, property::ePropTypeDouble, 2, false, "0.0" },
                { 0 }
        };

        property::OfxhSet outArgs( outStuff );
        outArgs.setDoubleProperty( kOfxImageEffectPropFrameRange, range.min, 0 );
        outArgs.setDoubleProperty( kOfxImageEffectPropFrameRange, range.max, 1 );

        OfxStatus status = mainEntry( kOfxImageEffectActionGetTimeDomain,
                                      this->getHandle(),
                                      0,
                                      &outArgs );

        if( status != kOfxStatOK && status != kOfxStatReplyDefault )
                BOOST_THROW_EXCEPTION( OfxhException( status ) );

        range.min = outArgs.getDoubleProperty( kOfxImageEffectPropFrameRange, 0 );
        range.max = outArgs.getDoubleProperty( kOfxImageEffectPropFrameRange, 1 );

        if( status == kOfxStatOK )
                return true;

        return false;
}

/**
 * implemented for Param::SetInstance
 */
void OfxhImageEffectNode::paramChanged( const attribute::OfxhParam& param, const attribute::EChange change )
{
        if( change == attribute::eChangeNone )
                return;

        const std::string changeStr = attribute::mapChangeEnumToString( change );
        const double frame          = getFrameRecursive();
        OfxPointD renderScale;

        getRenderScaleRecursive( renderScale.x, renderScale.y );

        beginInstanceChangedAction( changeStr );
        paramInstanceChangedAction( param.getName(), changeStr, frame, renderScale );
        endInstanceChangedAction( changeStr );
}

}
}
}
}