ImageKey.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 "ImageKey.h"

#include <cassert>
#include <stdexcept>

#include "Engine/ViewIdx.h"

NATRON_NAMESPACE_ENTER

ImageKey::ImageKey()
    : KeyHelper<U64>()
    , _nodeHashKey(0)
    , _time(0)
//, _mipMapLevel(0)
    , _pixelAspect(1)
    , _view(0)
    , _draftMode(false)
    , _frameVaryingOrAnimated(false)
    , _fullScaleWithDownscaleInputs(false)
{
}

ImageKey::ImageKey(const CacheEntryHolder* holder,
                   U64 nodeHashKey,
                   bool frameVaryingOrAnimated,
                   double time,
                   //unsigned int mipMapLevel, //< Store different mipmapLevels under the same key
                   ViewIdx view,
                   double pixelAspect,
                   bool draftMode,
                   bool fullScaleWithDownscaleInputs)
    : KeyHelper<U64>(holder)
    , _nodeHashKey(nodeHashKey)
    , _time(time)
    , _pixelAspect(pixelAspect)
    , _view(view)
    , _draftMode(draftMode)
    , _frameVaryingOrAnimated(frameVaryingOrAnimated)
    , _fullScaleWithDownscaleInputs(fullScaleWithDownscaleInputs)
{
}

void
ImageKey::fillHash(Hash64* hash) const
{
    hash->append(_nodeHashKey);
    if (_frameVaryingOrAnimated) {
        hash->append(_time);
    }
    hash->append(_view);
    hash->append(_pixelAspect);
    hash->append(_draftMode);
    hash->append(_fullScaleWithDownscaleInputs);
}

bool
ImageKey::operator==(const ImageKey & other) const
{
    if (_frameVaryingOrAnimated) {
        return _nodeHashKey == other._nodeHashKey &&
               _time == other._time &&
               _view == other._view &&
               _pixelAspect == other._pixelAspect &&
               _draftMode == other._draftMode &&
               _fullScaleWithDownscaleInputs == other._fullScaleWithDownscaleInputs;
    } else {
        return _nodeHashKey == other._nodeHashKey &&
               _view == other._view &&
               _pixelAspect == other._pixelAspect &&
               _draftMode == other._draftMode &&
               _fullScaleWithDownscaleInputs == other._fullScaleWithDownscaleInputs;
    }
}

NATRON_NAMESPACE_EXIT