Compositor: Cryptomatte compositing node.

This patch adds a new matte node that implements the Cryptomatte specification.
It also incluces a custom eye dropper that works outside of a color picker.
Cryptomatte export for the Cycles render engine will be in a separate patch.

Reviewers: brecht

Reviewed By: brecht

Subscribers: brecht

Tags: #compositing

Differential Revision: https://developer.blender.org/D3531

6 files changed, 282 insertions, 0 deletions

diff --git a/source/blender/compositor/CMakeLists.txt b/source/blender/compositor/CMakeLists.txt
index 3e1dd83112a..0ad53d3ab80 100644
--- a/source/blender/compositor/CMakeLists.txt
+++ b/source/blender/compositor/CMakeLists.txt
@@ -182,6 +182,11 @@ set(SRC
 	operations/COM_SunBeamsOperation.cpp
 	operations/COM_SunBeamsOperation.h
 
+	nodes/COM_CryptomatteNode.cpp
+	nodes/COM_CryptomatteNode.h
+	operations/COM_CryptomatteOperation.cpp
+	operations/COM_CryptomatteOperation.h
+
 	nodes/COM_CornerPinNode.cpp
 	nodes/COM_CornerPinNode.h
 	nodes/COM_PlaneTrackDeformNode.cpp
diff --git a/source/blender/compositor/intern/COM_Converter.cpp b/source/blender/compositor/intern/COM_Converter.cpp
index 58e0da04e5e..c9181905908 100644
--- a/source/blender/compositor/intern/COM_Converter.cpp
+++ b/source/blender/compositor/intern/COM_Converter.cpp
@@ -55,6 +55,7 @@ extern "C" {
 #include "COM_Converter.h"
 #include "COM_CornerPinNode.h"
 #include "COM_CropNode.h"
+#include "COM_CryptomatteNode.h"
 #include "COM_DefocusNode.h"
 #include "COM_DespeckleNode.h"
 #include "COM_DifferenceMatteNode.h"
@@ -406,6 +407,9 @@ Node *Converter::convert(bNode *b_node)
 		case CMP_NODE_SUNBEAMS:
 			node = new SunBeamsNode(b_node);
 			break;
+		case CMP_NODE_CRYPTOMATTE:
+			node = new CryptomatteNode(b_node);
+			break;
 	}
 	return node;
 }
diff --git a/source/blender/compositor/nodes/COM_CryptomatteNode.cpp b/source/blender/compositor/nodes/COM_CryptomatteNode.cpp
new file mode 100644
index 00000000000..c8134068543
--- /dev/null
+++ b/source/blender/compositor/nodes/COM_CryptomatteNode.cpp
@@ -0,0 +1,120 @@
+/*
+ * Copyright 2018, Blender Foundation.
+ *
+ * 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.
+ *
+ * Contributor:
+ *              Lukas Stockner
+ *              Stefan Werner
+ */
+
+#include "COM_CryptomatteNode.h"
+#include "COM_CryptomatteOperation.h"
+#include "COM_SetAlphaOperation.h"
+#include "COM_ConvertOperation.h"
+#include "BLI_string.h"
+#include "BLI_hash_mm3.h"
+#include "BLI_assert.h"
+#include <iterator>
+
+CryptomatteNode::CryptomatteNode(bNode *editorNode) : Node(editorNode)
+{
+	/* pass */
+}
+
+/* This is taken from the Cryptomatte specification 1.0. */
+static inline float hash_to_float(uint32_t hash) {
+	uint32_t mantissa = hash & (( 1 << 23) - 1);
+	uint32_t exponent = (hash >> 23) & ((1 << 8) - 1);
+	exponent = max(exponent, (uint32_t) 1);
+	exponent = min(exponent, (uint32_t) 254);
+	exponent = exponent << 23;
+	uint32_t sign = (hash >> 31);
+	sign = sign << 31;
+	uint32_t float_bits = sign | exponent | mantissa;
+	float f;
+	/* Bit casting relies on equal size for both types. */
+	BLI_STATIC_ASSERT(sizeof(float) == sizeof(uint32_t), "float and uint32_t are not the same size")
+	::memcpy(&f, &float_bits, sizeof(float));
+	return f;
+}
+
+void CryptomatteNode::convertToOperations(NodeConverter &converter, const CompositorContext &/*context*/) const
+{
+	NodeInput *inputSocketImage = this->getInputSocket(0);
+	NodeOutput *outputSocketImage = this->getOutputSocket(0);
+	NodeOutput *outputSocketMatte = this->getOutputSocket(1);
+	NodeOutput *outputSocketPick = this->getOutputSocket(2);
+
+	bNode *node = this->getbNode();
+	NodeCryptomatte *cryptoMatteSettings = (NodeCryptomatte *)node->storage;
+
+	CryptomatteOperation *operation = new CryptomatteOperation(getNumberOfInputSockets()-1);
+	if (cryptoMatteSettings) {
+		if (cryptoMatteSettings->matte_id) {
+			/* Split the string by commas, ignoring white space. */
+			std::string input = cryptoMatteSettings->matte_id;
+			std::istringstream ss(input);
+			while (ss.good()) {
+				std::string token;
+				getline(ss, token, ',');
+				/* Ignore empty tokens. */
+				if (token.length() > 0) {
+					size_t first = token.find_first_not_of(' ');
+					size_t last = token.find_last_not_of(' ');
+					if (first == std::string::npos || last == std::string::npos) {
+						break;
+					}
+					token = token.substr(first, (last - first + 1));
+					if (*token.begin() == '<' && *(--token.end()) == '>') {
+						operation->addObjectIndex(atof(token.substr(1, token.length() - 2).c_str()));
+					}
+					else {
+						uint32_t hash = BLI_hash_mm3((const unsigned char*)token.c_str(), token.length(), 0);
+						operation->addObjectIndex(hash_to_float(hash));
+					}
+				}
+			}
+		}
+	}
+
+	converter.addOperation(operation);
+
+	for (int i = 0; i < getNumberOfInputSockets()-1; ++i) {
+		converter.mapInputSocket(this->getInputSocket(i + 1), operation->getInputSocket(i));
+	}
+	
+	SeparateChannelOperation *separateOperation = new SeparateChannelOperation;
+	separateOperation->setChannel(3);
+	converter.addOperation(separateOperation);
+	
+	SetAlphaOperation *operationAlpha = new SetAlphaOperation();
+	converter.addOperation(operationAlpha);
+
+	converter.addLink(operation->getOutputSocket(0), separateOperation->getInputSocket(0));
+	converter.addLink(separateOperation->getOutputSocket(0), operationAlpha->getInputSocket(1));
+
+	SetAlphaOperation *clearAlphaOperation = new SetAlphaOperation();
+	converter.addOperation(clearAlphaOperation);
+	converter.addInputValue(clearAlphaOperation->getInputSocket(1), 1.0f);
+
+	converter.addLink(operation->getOutputSocket(0), clearAlphaOperation->getInputSocket(0));
+
+	converter.mapInputSocket(inputSocketImage, operationAlpha->getInputSocket(0));
+	converter.mapOutputSocket(outputSocketMatte, separateOperation->getOutputSocket(0));
+	converter.mapOutputSocket(outputSocketImage, operationAlpha->getOutputSocket(0));
+	converter.mapOutputSocket(outputSocketPick, clearAlphaOperation->getOutputSocket(0));
+	
+}
diff --git a/source/blender/compositor/nodes/COM_CryptomatteNode.h b/source/blender/compositor/nodes/COM_CryptomatteNode.h
new file mode 100644
index 00000000000..5251b57d8af
--- /dev/null
+++ b/source/blender/compositor/nodes/COM_CryptomatteNode.h
@@ -0,0 +1,38 @@
+/*
+ * Copyright 2018, Blender Foundation.
+ *
+ * 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.
+ *
+ * Contributor:
+ *              Lukas Stockner
+ */
+
+#ifndef _COM_CryptomatteNode_h_
+#define _COM_CryptomatteNode_h_
+
+#include "COM_Node.h"
+
+/**
+ * @brief CryptomatteNode
+ * @ingroup Node
+ */
+class CryptomatteNode : public Node {
+public:
+	CryptomatteNode(bNode *editorNode);
+	void convertToOperations(NodeConverter &converter, const CompositorContext &context) const;
+};
+
+#endif
+
diff --git a/source/blender/compositor/operations/COM_CryptomatteOperation.cpp b/source/blender/compositor/operations/COM_CryptomatteOperation.cpp
new file mode 100644
index 00000000000..9dd36863d37
--- /dev/null
+++ b/source/blender/compositor/operations/COM_CryptomatteOperation.cpp
@@ -0,0 +1,75 @@
+/*
+ * Copyright 2018, Blender Foundation.
+ *
+ * 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.
+ *
+ * Contributor: Lukas Stockner, Stefan Werner
+ */
+
+#include "COM_CryptomatteOperation.h"
+
+CryptomatteOperation::CryptomatteOperation(size_t num_inputs) : NodeOperation()
+{
+	for(size_t i = 0; i < num_inputs; i++) {
+		this->addInputSocket(COM_DT_COLOR);
+	}
+	inputs.resize(num_inputs);
+	this->addOutputSocket(COM_DT_COLOR);
+	this->setComplex(true);
+}
+
+void CryptomatteOperation::initExecution()
+{
+	for (size_t i = 0; i < inputs.size(); i++) {
+		inputs[i] = this->getInputSocketReader(i);
+	}
+}
+
+void CryptomatteOperation::addObjectIndex(float objectIndex)
+{
+	if (objectIndex != 0.0f) {
+		m_objectIndex.push_back(objectIndex);
+	}
+}
+
+void CryptomatteOperation::executePixel(float output[4],
+                                   int x,
+                                   int y,
+                                   void *data)
+{
+	float input[4];
+	output[0] = output[1] = output[2] = output[3] = 0.0f;
+	for (size_t i = 0; i < inputs.size(); i++) {
+		inputs[i]->read(input, x, y, data);
+		if (i == 0) {
+			/* Write the frontmost object as false color for picking. */
+			output[0] = input[0];
+			uint32_t m3hash;
+			::memcpy(&m3hash, &input[0], sizeof(uint32_t));
+			/* Since the red channel is likely to be out of display range,
+			 * setting green and blue gives more meaningful images. */
+			output[1] = ((float) ((m3hash << 8)) / (float) UINT32_MAX);
+			output[2] = ((float) ((m3hash << 16)) / (float) UINT32_MAX);
+		}
+		for(size_t i = 0; i < m_objectIndex.size(); i++) {
+			if (m_objectIndex[i] == input[0]) {
+				output[3] += input[1];
+			}
+			if (m_objectIndex[i] == input[2]) {
+				output[3] += input[3];
+			}
+		}
+	}
+}
diff --git a/source/blender/compositor/operations/COM_CryptomatteOperation.h b/source/blender/compositor/operations/COM_CryptomatteOperation.h
new file mode 100644
index 00000000000..9ce02c048b3
--- /dev/null
+++ b/source/blender/compositor/operations/COM_CryptomatteOperation.h
@@ -0,0 +1,40 @@
+/*
+ * Copyright 2018, Blender Foundation.
+ *
+ * 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.
+ *
+ * Contributor: Lukas Stockner, Stefan Werner
+ */
+
+#ifndef _COM_CryptomatteOperation_h
+#define _COM_CryptomatteOperation_h
+#include "COM_NodeOperation.h"
+
+
+class CryptomatteOperation : public NodeOperation {
+private:
+	std::vector<float> m_objectIndex;
+public:
+	std::vector<SocketReader *> inputs;
+
+	CryptomatteOperation(size_t num_inputs = 6);
+
+	void initExecution();
+	void executePixel(float output[4], int x, int y, void *data);
+
+	void addObjectIndex(float objectIndex);
+
+};
+#endif