void
GenericOCIO::describeInContextOutput(OFX::ImageEffectDescriptor &desc, OFX::ContextEnum /*context*/, OFX::PageParamDescriptor *page, const char* outputSpaceNameDefault, const char* outputSpaceLabel)
{
#ifdef OFX_IO_USING_OCIO
gHostIsNatron = (OFX::getImageEffectHostDescription()->isNatron);
char* file = std::getenv("OCIO");
OCIO::ConstConfigRcPtr config;
if (file != NULL) {
//Add choices
try {
config = OCIO::Config::CreateFromFile(file);
gWasOCIOEnvVarFound = true;
} catch (OCIO::Exception &e) {
}
}
std::string outputSpaceName;
if (config) {
outputSpaceName = canonicalizeColorSpace(config, colorSpaceName(config, outputSpaceNameDefault));
}
///////////Output Color-space
{
OFX::StringParamDescriptor* param = desc.defineStringParam(kOCIOParamOutputSpace);
param->setLabel(outputSpaceLabel);
param->setHint(kOCIOParamOutputSpaceHint);
param->setAnimates(true);
if (config) {
param->setDefault(outputSpaceName);
} else {
param->setEnabled(false);
}
page->addChild(*param);
}
#ifdef OFX_OCIO_CHOICE
{
OFX::ChoiceParamDescriptor* param = desc.defineChoiceParam(kOCIOParamOutputSpaceChoice);
param->setLabel(outputSpaceLabel);
param->setHint(kOCIOParamOutputSpaceHint);
param->setCascading(OFX::getImageEffectHostDescription()->supportsCascadingChoices);
if (config) {
buildChoiceMenu(config, param, OFX::getImageEffectHostDescription()->supportsCascadingChoices, outputSpaceName);
} else {
param->setEnabled(false);
//param->setIsSecret(true); // done in the plugin constructor
}
param->setAnimates(true);
param->setEvaluateOnChange(false); // evaluate only when the StringParam is changed
param->setIsPersistant(false); // don't save/serialize
page->addChild(*param);
}
#endif
#endif
}
void
GenericOCIO::describeInContextContext(OFX::ImageEffectDescriptor &desc, OFX::ContextEnum /*context*/, OFX::PageParamDescriptor *page)
{
#ifdef OFX_IO_USING_OCIO
OFX::GroupParamDescriptor* group = desc.defineGroupParam(kOCIOParamContext);
group->setHint(kOCIOParamContextHint);
group->setOpen(false);
{
OFX::StringParamDescriptor* param = desc.defineStringParam(kOCIOParamContextKey1);
param->setHint(kOCIOParamContextHint);
param->setAnimates(true);
param->setParent(*group);
param->setLayoutHint(OFX::eLayoutHintNoNewLine);
page->addChild(*param);
}
{
OFX::StringParamDescriptor* param = desc.defineStringParam(kOCIOParamContextValue1);
param->setHint(kOCIOParamContextHint);
param->setAnimates(true);
param->setParent(*group);
page->addChild(*param);
}
{
OFX::StringParamDescriptor* param = desc.defineStringParam(kOCIOParamContextKey2);
param->setHint(kOCIOParamContextHint);
param->setAnimates(true);
param->setParent(*group);
param->setLayoutHint(OFX::eLayoutHintNoNewLine);
page->addChild(*param);
}
{
OFX::StringParamDescriptor* param = desc.defineStringParam(kOCIOParamContextValue2);
param->setHint(kOCIOParamContextHint);
param->setAnimates(true);
param->setParent(*group);
page->addChild(*param);
}
{
OFX::StringParamDescriptor* param = desc.defineStringParam(kOCIOParamContextKey3);
param->setHint(kOCIOParamContextHint);
param->setAnimates(true);
param->setParent(*group);
param->setLayoutHint(OFX::eLayoutHintNoNewLine);
page->addChild(*param);
}
{
OFX::StringParamDescriptor* param = desc.defineStringParam(kOCIOParamContextValue3);
param->setHint(kOCIOParamContextHint);
param->setAnimates(true);
param->setParent(*group);
page->addChild(*param);
}
{
OFX::StringParamDescriptor* param = desc.defineStringParam(kOCIOParamContextKey4);
param->setHint(kOCIOParamContextHint);
param->setAnimates(true);
param->setParent(*group);
param->setLayoutHint(OFX::eLayoutHintNoNewLine);
page->addChild(*param);
}
{
OFX::StringParamDescriptor* param = desc.defineStringParam(kOCIOParamContextValue4);
param->setHint(kOCIOParamContextHint);
param->setAnimates(true);
param->setParent(*group);
page->addChild(*param);
}
page->addChild(*group);
#endif
}
void
GenericOCIO::describeInContextInput(OFX::ImageEffectDescriptor &desc, OFX::ContextEnum /*context*/, OFX::PageParamDescriptor *page, const char* inputSpaceNameDefault, const char* inputSpaceLabel)
{
#ifdef OFX_IO_USING_OCIO
gHostIsNatron = (OFX::getImageEffectHostDescription()->isNatron);
char* file = std::getenv("OCIO");
OCIO::ConstConfigRcPtr config;
if (file != NULL) {
//Add choices
try {
config = OCIO::Config::CreateFromFile(file);
gWasOCIOEnvVarFound = true;
} catch (OCIO::Exception &e) {
}
}
std::string inputSpaceName, outputSpaceName;
if (config) {
inputSpaceName = canonicalizeColorSpace(config, colorSpaceName(config, inputSpaceNameDefault));
}
////////// OCIO config file
{
OFX::StringParamDescriptor* param = desc.defineStringParam(kOCIOParamConfigFile);
param->setLabel(kOCIOParamConfigFileLabel);
param->setHint(kOCIOParamConfigFileHint);
param->setStringType(OFX::eStringTypeFilePath);
param->setFilePathExists(true);
param->setAnimates(false);
desc.addClipPreferencesSlaveParam(*param);
// the OCIO config can only be set in a portable fashion using the environment variable.
// Nuke, for example, doesn't support changing the entries in a ChoiceParam outside of describeInContext.
// disable it, and set the default from the env variable.
assert(OFX::getImageEffectHostDescription());
param->setEnabled(true);
if (file == NULL) {
param->setDefault("WARNING: Open an OCIO config file, or set the OCIO environnement variable");
} else if (config) {
param->setDefault(file);
} else {
std::string s("ERROR: Invalid OCIO configuration '");
s += file;
s += '\'';
param->setDefault(s);
}
page->addChild(*param);
}
///////////Input Color-space
{
OFX::StringParamDescriptor* param = desc.defineStringParam(kOCIOParamInputSpace);
param->setLabel(inputSpaceLabel);
param->setHint(kOCIOParamInputSpaceHint);
param->setAnimates(true);
if (config) {
param->setDefault(inputSpaceName);
} else {
param->setEnabled(false);
}
page->addChild(*param);
}
#ifdef OFX_OCIO_CHOICE
{
OFX::ChoiceParamDescriptor* param = desc.defineChoiceParam(kOCIOParamInputSpaceChoice);
param->setLabel(inputSpaceLabel);
param->setHint(kOCIOParamInputSpaceHint);
param->setCascading(OFX::getImageEffectHostDescription()->supportsCascadingChoices);
if (config) {
buildChoiceMenu(config, param, OFX::getImageEffectHostDescription()->supportsCascadingChoices, inputSpaceName);
} else {
param->setEnabled(false);
//param->setIsSecret(true); // done in the plugin constructor
}
param->setAnimates(true);
param->setEvaluateOnChange(false); // evaluate only when the StringParam is changed
param->setIsPersistant(false); // don't save/serialize
page->addChild(*param);
}
#endif
#endif
}
/**
* @brief Override this to describe in context the writer.
* You should call the base-class version at the end like this:
* GenericWriterPluginFactory<YOUR_FACTORY>::describeInContext(desc,context);
**/
PageParamDescriptor*
GenericWriterDescribeInContextBegin(OFX::ImageEffectDescriptor &desc, OFX::ContextEnum context, bool isVideoStreamPlugin, bool supportsRGBA, bool supportsRGB, bool supportsAlpha, const char* inputSpaceNameDefault, const char* outputSpaceNameDefault)
{
// create the mandated source clip
ClipDescriptor *srcClip = desc.defineClip(kOfxImageEffectSimpleSourceClipName);
if (supportsRGBA) {
srcClip->addSupportedComponent(ePixelComponentRGBA);
}
if (supportsRGB) {
srcClip->addSupportedComponent(ePixelComponentRGB);
}
if (supportsAlpha) {
srcClip->addSupportedComponent(ePixelComponentAlpha);
}
srcClip->setSupportsTiles(false);
// create the mandated output clip
ClipDescriptor *dstClip = desc.defineClip(kOfxImageEffectOutputClipName);
if (supportsRGBA) {
dstClip->addSupportedComponent(ePixelComponentRGBA);
}
if (supportsRGB) {
dstClip->addSupportedComponent(ePixelComponentRGB);
}
if (supportsAlpha) {
dstClip->addSupportedComponent(ePixelComponentAlpha);
}
dstClip->setSupportsTiles(false);//< we don't support tiles in output!
// make some pages and to things in
PageParamDescriptor *page = desc.definePageParam("Controls");
//////////Output file
OFX::StringParamDescriptor* fileParam = desc.defineStringParam(kWriterFileParamName);
fileParam->setLabels(kWriterFileParamLabel, kWriterFileParamLabel, kWriterFileParamLabel);
fileParam->setStringType(OFX::eStringTypeFilePath);
fileParam->setFilePathExists(false);
fileParam->setHint(kWriterFileParamHint);
// in the Writer context, the script name should be "filename", for consistency with the reader nodes @see kOfxImageEffectContextReader
fileParam->setScriptName(kWriterFileParamName);
fileParam->setAnimates(!isVideoStreamPlugin);
desc.addClipPreferencesSlaveParam(*fileParam);
page->addChild(*fileParam);
// insert OCIO parameters
GenericOCIO::describeInContext(desc, context, page, inputSpaceNameDefault, outputSpaceNameDefault);
///////////Frame range choosal
OFX::ChoiceParamDescriptor* frameRangeChoiceParam = desc.defineChoiceParam(kWriterFrameRangeChoiceParamName);
frameRangeChoiceParam->setLabels(kWriterFrameRangeChoiceParamLabel, kWriterFrameRangeChoiceParamLabel, kWriterFrameRangeChoiceParamLabel);
frameRangeChoiceParam->setHint(kWriterFrameRangeChoiceParamHint);
frameRangeChoiceParam->appendOption(kWriterFrameRangeChoiceParamOptionUnion, kWriterFrameRangeChoiceParamOptionUnionHint);
frameRangeChoiceParam->appendOption(kWriterFrameRangeChoiceParamOptionBounds, kWriterFrameRangeChoiceParamOptionBoundsHint);
frameRangeChoiceParam->appendOption(kWriterFrameRangeChoiceParamOptionManual, kWriterFrameRangeChoiceParamOptionManualHint);
frameRangeChoiceParam->setAnimates(true);
frameRangeChoiceParam->setDefault(0);
page->addChild(*frameRangeChoiceParam);
/////////////First frame
OFX::IntParamDescriptor* firstFrameParam = desc.defineIntParam(kWriterFirstFrameParamName);
firstFrameParam->setLabels(kWriterFirstFrameParamLabel, kWriterFirstFrameParamLabel, kWriterFirstFrameParamLabel);
firstFrameParam->setIsSecret(true);
firstFrameParam->setAnimates(true);
page->addChild(*firstFrameParam);
////////////Last frame
OFX::IntParamDescriptor* lastFrameParam = desc.defineIntParam(kWriterLastFrameParamName);
lastFrameParam->setLabels(kWriterLastFrameParamLabel, kWriterLastFrameParamLabel, kWriterLastFrameParamLabel);
lastFrameParam->setIsSecret(true);
lastFrameParam->setAnimates(true);
page->addChild(*lastFrameParam);
return page;
}
