Jeroen Bakker
957e292c58
This change will try to add meta data when using a multilayered open exr file output node in the compositor. It adds the current scene meta data and converts existing cryptomatte keys so it follows the naming that is configured in the file output node. This change supports the basic use-case where the compositor is used to output cryptomatte layers with a different naming scheme to support external compositors. In this case the Multilayered OpenEXR files are used and the meta data is read from the render result. Meta data is found when render layer node is connected with the file output node without any other nodes in between. Redirects and empty node groups are allowed. The patch has been verified to work with external compositors. See https://devtalk.blender.org/t/making-sense-of-cryptomatte-usage-in-third-party-programs/16576/17 See patch for example files. Reviewed By: Sergey Sharybin Differential Revision: https://developer.blender.org/D10016
57 lines
2.3 KiB
C++
57 lines
2.3 KiB
C++
/*
|
|
* This program 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.
|
|
*
|
|
* This program 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 this program; if not, write to the Free Software Foundation,
|
|
* Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
|
|
*
|
|
* Copyright 2021, Blender Foundation.
|
|
*/
|
|
|
|
#pragma once
|
|
|
|
#include <string>
|
|
|
|
#include "BLI_map.hh"
|
|
|
|
#include "MEM_guardedalloc.h"
|
|
|
|
/* Forward declarations. */
|
|
struct StampData;
|
|
struct RenderResult;
|
|
|
|
/* Cryptomatte includes hash in its meta data keys. The hash is generated from the render
|
|
* layer/pass name. Compositing happens without the knowledge of the original layer and pass. The
|
|
* next keys are used to transfer the cryptomatte meta data in a neutral way. The file output node
|
|
* will generate a hash based on the layer name configured by the user.
|
|
*
|
|
* The `{hash}` has no special meaning except to make sure that the meta data stays unique. */
|
|
constexpr blender::StringRef META_DATA_KEY_CRYPTOMATTE_HASH("cryptomatte/{hash}/hash");
|
|
constexpr blender::StringRef META_DATA_KEY_CRYPTOMATTE_CONVERSION("cryptomatte/{hash}/conversion");
|
|
constexpr blender::StringRef META_DATA_KEY_CRYPTOMATTE_MANIFEST("cryptomatte/{hash}/manifest");
|
|
constexpr blender::StringRef META_DATA_KEY_CRYPTOMATTE_NAME("cryptomatte/{hash}/name");
|
|
|
|
class MetaData {
|
|
private:
|
|
blender::Map<std::string, std::string> entries_;
|
|
void addCryptomatteEntry(const blender::StringRef layer_name,
|
|
const blender::StringRefNull key,
|
|
const blender::StringRef value);
|
|
|
|
public:
|
|
void add(const blender::StringRef key, const blender::StringRef value);
|
|
void replaceHashNeutralCryptomatteKeys(const blender::StringRef layer_name);
|
|
void addToRenderResult(RenderResult *render_result) const;
|
|
#ifdef WITH_CXX_GUARDEDALLOC
|
|
MEM_CXX_CLASS_ALLOC_FUNCS("COM:MetaData")
|
|
#endif
|
|
};
|