NodeMetadata.cpp

/* ***** BEGIN LICENSE BLOCK *****
 * This file is part of Natron <https://natrongithub.github.io/>,
 * (C) 2018-2021 The Natron developers
 * (C) 2013-2018 INRIA and Alexandre Gauthier-Foichat
 *
 * Natron is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * Natron is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with Natron.  If not, see <http://www.gnu.org/licenses/gpl-2.0.html>
 * ***** END LICENSE BLOCK ***** */

// ***** BEGIN PYTHON BLOCK *****
// from <https://docs.python.org/3/c-api/intro.html#include-files>:
// "Since Python may define some pre-processor definitions which affect the standard headers on some systems, you must include Python.h before any standard headers are included."
#include <Python.h>
// ***** END PYTHON BLOCK *****

#include "NodeMetadata.h"
#include "Engine/RectI.h"
#include <cassert>
#include <vector>

NATRON_NAMESPACE_ENTER

struct PerInputData
{
    //Either 1 or 2 components in the case of MotionVectors/Disparity
    double pixelAspectRatio;
    int nComps;
    std::string componentsType;
    ImageBitDepthEnum bitdepth;

    PerInputData()
        : pixelAspectRatio(1.)
        , nComps(0)
        , componentsType()
        , bitdepth(eImageBitDepthFloat)
    {
    }
};

struct NodeMetadataPrivate
{
    //The premult in output of the node
    ImagePremultiplicationEnum outputPremult;

    //The image fielding in output
    ImageFieldingOrderEnum outputFielding;

    //The fps in output
    double frameRate;
    PerInputData outputData;

    //For each input specific datas
    std::vector<PerInputData> inputsData;

    //True if the images can only be sampled continuously (eg: the clip is in fact an animating roto spline and can be rendered anywhen).
    //False if the images can only be sampled at discreet times (eg: the clip is a sequence of frames),
    bool canRenderAtNonframes;

    //True if the effect changes throughout the time
    bool isFrameVarying;

    // The output format in pixel coords
    RectI outputFormat;


    NodeMetadataPrivate()
        : outputPremult(eImagePremultiplicationPremultiplied)
        , outputFielding(eImageFieldingOrderNone)
        , frameRate(24.)
        , outputData()
        , inputsData()
        , canRenderAtNonframes(true)
        , isFrameVarying(false)
        , outputFormat()
    {
    }

    NodeMetadataPrivate(const NodeMetadataPrivate& other)
    {
        *this = other;
    }

    void operator=(const NodeMetadataPrivate& other)
    {
        outputPremult = other.outputPremult;
        outputFielding = other.outputFielding;
        frameRate = other.frameRate;
        outputData = other.outputData;
        inputsData = other.inputsData;
        canRenderAtNonframes = other.canRenderAtNonframes;
        isFrameVarying = other.isFrameVarying;
        outputFormat = other.outputFormat;
    }
};

NodeMetadata::NodeMetadata()
    : _imp( new NodeMetadataPrivate() )
{
}

NodeMetadata::NodeMetadata(const NodeMetadata& other)
    : _imp( new NodeMetadataPrivate(*other._imp) )
{
}

NodeMetadata::~NodeMetadata()
{
}

void
NodeMetadata::clearAndResize(int inputCount)
{
    _imp->inputsData.resize(inputCount);
}

void
NodeMetadata::operator=(const NodeMetadata& other)
{
    *_imp = *other._imp;
}

bool
NodeMetadata::operator==(const NodeMetadata& other) const
{
    if (_imp->outputPremult != other._imp->outputPremult) {
        return false;
    }
    if (_imp->outputFielding != other._imp->outputFielding) {
        return false;
    }
    if (_imp->frameRate != other._imp->frameRate) {
        return false;
    }
    if (_imp->canRenderAtNonframes != other._imp->canRenderAtNonframes) {
        return false;
    }
    if (_imp->isFrameVarying != other._imp->isFrameVarying) {
        return false;
    }
    if (_imp->outputData.bitdepth != other._imp->outputData.bitdepth) {
        return false;
    }
    if (_imp->outputData.pixelAspectRatio != other._imp->outputData.pixelAspectRatio) {
        return false;
    }
    if (_imp->outputData.nComps != other._imp->outputData.nComps) {
        return false;
    }
    if (_imp->outputData.componentsType != other._imp->outputData.componentsType) {
        return false;
    }
    if ( _imp->inputsData.size() != other._imp->inputsData.size() ) {
        return false;
    }
    if (_imp->outputFormat != other._imp->outputFormat) {
        return false;
    }
    for (std::size_t i = 0; i < _imp->inputsData.size(); ++i) {
        if (_imp->inputsData[i].pixelAspectRatio != other._imp->inputsData[i].pixelAspectRatio) {
            return false;
        }
        if (_imp->inputsData[i].bitdepth != other._imp->inputsData[i].bitdepth) {
            return false;
        }
        if (_imp->inputsData[i].componentsType != other._imp->inputsData[i].componentsType) {
            return false;
        }
        if (_imp->inputsData[i].nComps != other._imp->inputsData[i].nComps) {
            return false;
        }
    }

    return true;
}

void
NodeMetadata::setOutputPremult(ImagePremultiplicationEnum premult)
{
    _imp->outputPremult = premult;
}

ImagePremultiplicationEnum
NodeMetadata::getOutputPremult() const
{
    return _imp->outputPremult;
}

void
NodeMetadata::setOutputFrameRate(double fps)
{
    _imp->frameRate = fps;
}

double
NodeMetadata::getOutputFrameRate() const
{
    return _imp->frameRate;
}

void
NodeMetadata::setOutputFielding(ImageFieldingOrderEnum fielding)
{
    _imp->outputFielding = fielding;
}

ImageFieldingOrderEnum
NodeMetadata::getOutputFielding() const
{
    return _imp->outputFielding;
}

void
NodeMetadata::setIsContinuous(bool continuous)
{
    _imp->canRenderAtNonframes = continuous;
}

bool
NodeMetadata::getIsContinuous() const
{
    return _imp->canRenderAtNonframes;
}

void
NodeMetadata::setIsFrameVarying(bool varying)
{
    _imp->isFrameVarying = varying;
}

bool
NodeMetadata::getIsFrameVarying() const
{
    return _imp->isFrameVarying;
}

void
NodeMetadata::setPixelAspectRatio(int inputNb,
                                  double par)
{
    if (inputNb == -1) {
        _imp->outputData.pixelAspectRatio = par;
    } else {
        if ( inputNb < (int)_imp->inputsData.size() ) {
            _imp->inputsData[inputNb].pixelAspectRatio = par;
        }
    }
}

double
NodeMetadata::getPixelAspectRatio(int inputNb) const
{
    if (inputNb == -1) {
        return _imp->outputData.pixelAspectRatio;
    } else {
        if ( inputNb < (int)_imp->inputsData.size() ) {
            return _imp->inputsData[inputNb].pixelAspectRatio;
        } else {
            return 1.;
        }
    }
}

void
NodeMetadata::setBitDepth(int inputNb,
                          ImageBitDepthEnum depth)
{
    if (inputNb == -1) {
        _imp->outputData.bitdepth = depth;
    } else {
        if ( inputNb < (int)_imp->inputsData.size() ) {
            _imp->inputsData[inputNb].bitdepth = depth;
        }
        
    }
}

ImageBitDepthEnum
NodeMetadata::getBitDepth(int inputNb) const
{
    if (inputNb == -1) {
        return _imp->outputData.bitdepth;
    } else {
        if ( inputNb < (int)_imp->inputsData.size() ) {
            return _imp->inputsData[inputNb].bitdepth;
        } else {
            return eImageBitDepthFloat;
        }
    }
}


void
NodeMetadata::setNComps(int inputNb, int nComps)
{
    if (inputNb == -1) {
        _imp->outputData.nComps = nComps;
    } else {
        if ( inputNb < (int)_imp->inputsData.size() ) {
            _imp->inputsData[inputNb].nComps = nComps;
        }
    }
}


int
NodeMetadata::getNComps(int inputNb) const
{
    if (inputNb == -1) {
        return _imp->outputData.nComps;
    } else {
        if ( inputNb < (int)_imp->inputsData.size() ) {
            return _imp->inputsData[inputNb].nComps;
        } else {
            return 4;
        }
    }
}

void
NodeMetadata::setComponentsType(int inputNb,const std::string& componentsType)
{
    if (inputNb == -1) {
        _imp->outputData.componentsType = componentsType;
    } else {
        if ( inputNb < (int)_imp->inputsData.size() ) {
            _imp->inputsData[inputNb].componentsType = componentsType;
        }
    }
}

std::string
NodeMetadata::getComponentsType(int inputNb) const
{
    if (inputNb == -1) {
        return _imp->outputData.componentsType;
    } else {
        if ( inputNb < (int)_imp->inputsData.size() ) {

            return _imp->inputsData[inputNb].componentsType;
        } else {
            return kNatronColorPlaneID;
        }
    }
}

void
NodeMetadata::setOutputFormat(const RectI& format)
{
    _imp->outputFormat = format;
}

const RectI&
NodeMetadata::getOutputFormat() const
{
    return _imp->outputFormat;
}

NATRON_NAMESPACE_EXIT