mathutils_Color.cc

Go to the documentation of this file.

/* SPDX-FileCopyrightText: 2023 Blender Authors
 *
 * SPDX-License-Identifier: GPL-2.0-or-later */

 
#include <algorithm>
 
#include <Python.h>
 
#include "mathutils.hh"
 
#include "BLI_utildefines.h"
 
#include "../generic/py_capi_utils.hh"
#include "../generic/python_utildefines.hh"
 
#ifndef MATH_STANDALONE
#  include "IMB_colormanagement.hh"
#endif
 
#ifndef MATH_STANDALONE
#  include "BLI_dynstr.h"
#endif
 
#define COLOR_SIZE 3
 
/* -------------------------------------------------------------------- */

static PyObject *Color_to_tuple_ex(ColorObject *self, int ndigits)
{
  PyObject *ret;
  int i;
 
  ret = PyTuple_New(COLOR_SIZE);
 
  if (ndigits >= 0) {
    for (i = 0; i < COLOR_SIZE; i++) {
      PyTuple_SET_ITEM(ret, i, PyFloat_FromDouble(double_round(double(self->col[i]), ndigits)));
    }
  }
  else {
    for (i = 0; i < COLOR_SIZE; i++) {
      PyTuple_SET_ITEM(ret, i, PyFloat_FromDouble(self->col[i]));
    }
  }
 
  return ret;
}

 
/* -------------------------------------------------------------------- */
 
static PyObject *Color_vectorcall(PyObject *type,
                                  PyObject *const *args,
                                  const size_t nargsf,
                                  PyObject *kwnames)
{
  if (UNLIKELY(kwnames && PyTuple_GET_SIZE(kwnames))) {
    PyErr_SetString(PyExc_TypeError,
                    "mathutils.Color(): "
                    "takes no keyword args");
    return nullptr;
  }
 
  float col[3] = {0.0f, 0.0f, 0.0f};
 
  const size_t nargs = PyVectorcall_NARGS(nargsf);
  switch (nargs) {
    case 0: {
      break;
    }
    case 1: {
      if (mathutils_array_parse(col, COLOR_SIZE, COLOR_SIZE, args[0], "mathutils.Color()") == -1) {
        return nullptr;
      }
      break;
    }
    default: {
      PyErr_Format(PyExc_TypeError,
                   "mathutils.Color(): "
                   "takes at most 1 argument (%zd given)",
                   nargs);
      return nullptr;
    }
  }
  return Color_CreatePyObject(col, (PyTypeObject *)type);
}
 
static PyObject *Color_new(PyTypeObject *type, PyObject *args, PyObject *kwds)
{
  /* Only called on sub-classes. */
  if (UNLIKELY(kwds && PyDict_GET_SIZE(kwds))) {
    PyErr_SetString(PyExc_TypeError,
                    "mathutils.Color(): "
                    "takes no keyword args");
    return nullptr;
  }
  PyObject *const *args_array = &PyTuple_GET_ITEM(args, 0);
  const size_t args_array_num = PyTuple_GET_SIZE(args);
  return Color_vectorcall(reinterpret_cast<PyObject *>(type), args_array, args_array_num, nullptr);
}

 
/* -------------------------------------------------------------------- */
 
#ifndef MATH_STANDALONE
 
PyDoc_STRVAR(
    /* Wrap. */
    Color_from_scene_linear_to_srgb_doc,
    ".. function:: from_scene_linear_to_srgb()\n"
    "\n"
    "   Convert from scene linear to sRGB color space.\n"
    "\n"
    "   :return: A color in sRGB color space.\n"
    "   :rtype: :class:`Color`\n");
static PyObject *Color_from_scene_linear_to_srgb(ColorObject *self)
{
  float col[3];
  IMB_colormanagement_scene_linear_to_srgb_v3(col, self->col);
  return Color_CreatePyObject(col, Py_TYPE(self));
}
 
PyDoc_STRVAR(
    /* Wrap. */
    Color_from_srgb_to_scene_linear_doc,
    ".. function:: from_srgb_to_scene_linear()\n"
    "\n"
    "   Convert from sRGB to scene linear color space.\n"
    "\n"
    "   :return: A color in scene linear color space.\n"
    "   :rtype: :class:`Color`\n");
static PyObject *Color_from_srgb_to_scene_linear(ColorObject *self)
{
  float col[3];
  IMB_colormanagement_srgb_to_scene_linear_v3(col, self->col);
  return Color_CreatePyObject(col, Py_TYPE(self));
}
 
PyDoc_STRVAR(
    /* Wrap. */
    Color_from_scene_linear_to_xyz_d65_doc,
    ".. function:: from_scene_linear_to_xyz_d65()\n"
    "\n"
    "   Convert from scene linear to CIE XYZ (Illuminant D65) color space.\n"
    "\n"
    "   :return: A color in XYZ color space.\n"
    "   :rtype: :class:`Color`\n");
static PyObject *Color_from_scene_linear_to_xyz_d65(ColorObject *self)
{
  float col[3];
  IMB_colormanagement_scene_linear_to_xyz(col, self->col);
  return Color_CreatePyObject(col, Py_TYPE(self));
}
 
PyDoc_STRVAR(
    /* Wrap. */
    Color_from_xyz_d65_to_scene_linear_doc,
    ".. function:: from_xyz_d65_to_scene_linear()\n"
    "\n"
    "   Convert from CIE XYZ (Illuminant D65) to scene linear color space.\n"
    "\n"
    "   :return: A color in scene linear color space.\n"
    "   :rtype: :class:`Color`\n");
static PyObject *Color_from_xyz_d65_to_scene_linear(ColorObject *self)
{
  float col[3];
  IMB_colormanagement_xyz_to_scene_linear(col, self->col);
  return Color_CreatePyObject(col, Py_TYPE(self));
}
 
PyDoc_STRVAR(
    /* Wrap. */
    Color_from_scene_linear_to_aces_doc,
    ".. function:: from_scene_linear_to_aces()\n"
    "\n"
    "   Convert from scene linear to ACES2065-1 linear color space.\n"
    "\n"
    "   :return: A color in ACES2065-1 linear color space.\n"
    "   :rtype: :class:`Color`\n");
static PyObject *Color_from_scene_linear_to_aces(ColorObject *self)
{
  float col[3];
  IMB_colormanagement_scene_linear_to_aces(col, self->col);
  return Color_CreatePyObject(col, Py_TYPE(self));
}
 
PyDoc_STRVAR(
    /* Wrap. */
    Color_from_aces_to_scene_linear_doc,
    ".. function:: from_aces_to_scene_linear()\n"
    "\n"
    "   Convert from ACES2065-1 linear to scene linear color space.\n"
    "\n"
    "   :return: A color in scene linear color space.\n"
    "   :rtype: :class:`Color`\n");
static PyObject *Color_from_aces_to_scene_linear(ColorObject *self)
{
  float col[3];
  IMB_colormanagement_aces_to_scene_linear(col, self->col);
  return Color_CreatePyObject(col, Py_TYPE(self));
}
 
PyDoc_STRVAR(
    /* Wrap. */
    Color_from_scene_linear_to_acescg_doc,
    ".. function:: from_scene_linear_to_acescg()\n"
    "\n"
    "   Convert from scene linear to ACEScg linear color space.\n"
    "\n"
    "   :return: A color in ACEScg linear color space.\n"
    "   :rtype: :class:`Color`\n");
static PyObject *Color_from_scene_linear_to_acescg(ColorObject *self)
{
  float col[3];
  IMB_colormanagement_scene_linear_to_acescg(col, self->col);
  return Color_CreatePyObject(col, Py_TYPE(self));
}
 
PyDoc_STRVAR(
    /* Wrap. */
    Color_from_acescg_to_scene_linear_doc,
    ".. function:: from_acescg_to_scene_linear()\n"
    "\n"
    "   Convert from ACEScg linear to scene linear color space.\n"
    "\n"
    "   :return: A color in scene linear color space.\n"
    "   :rtype: :class:`Color`\n");
static PyObject *Color_from_acescg_to_scene_linear(ColorObject *self)
{
  float col[3];
  IMB_colormanagement_acescg_to_scene_linear(col, self->col);
  return Color_CreatePyObject(col, Py_TYPE(self));
}
 
PyDoc_STRVAR(
    /* Wrap. */
    Color_from_scene_linear_to_rec709_linear_doc,
    ".. function:: from_scene_linear_to_rec709_linear()\n"
    "\n"
    "   Convert from scene linear to Rec.709 linear color space.\n"
    "\n"
    "   :return: A color in Rec.709 linear color space.\n"
    "   :rtype: :class:`Color`\n");
static PyObject *Color_from_scene_linear_to_rec709_linear(ColorObject *self)
{
  float col[3];
  IMB_colormanagement_scene_linear_to_rec709(col, self->col);
  return Color_CreatePyObject(col, Py_TYPE(self));
}
 
PyDoc_STRVAR(
    /* Wrap. */
    Color_from_rec709_linear_to_scene_linear_doc,
    ".. function:: from_rec709_linear_to_scene_linear()\n"
    "\n"
    "   Convert from Rec.709 linear color space to scene linear color space.\n"
    "\n"
    "   :return: A color in scene linear color space.\n"
    "   :rtype: :class:`Color`\n");
static PyObject *Color_from_rec709_linear_to_scene_linear(ColorObject *self)
{
  float col[3];
  IMB_colormanagement_rec709_to_scene_linear(col, self->col);
  return Color_CreatePyObject(col, Py_TYPE(self));
}
 
PyDoc_STRVAR(
    /* Wrap. */
    Color_from_scene_linear_to_rec2020_linear_doc,
    ".. function:: from_scene_linear_to_rec2020_linear()\n"
    "\n"
    "   Convert from scene linear to Rec.2020 linear color space.\n"
    "\n"
    "   :return: A color in Rec.2020 linear color space.\n"
    "   :rtype: :class:`Color`\n");
static PyObject *Color_from_scene_linear_to_rec2020_linear(ColorObject *self)
{
  float col[3];
  IMB_colormanagement_scene_linear_to_rec2020(col, self->col);
  return Color_CreatePyObject(col, Py_TYPE(self));
}
 
PyDoc_STRVAR(
    /* Wrap. */
    Color_from_rec2020_linear_to_scene_linear_doc,
    ".. function:: from_rec2020_linear_to_scene_linear()\n"
    "\n"
    "   Convert from Rec.2020 linear color space to scene linear color space.\n"
    "\n"
    "   :return: A color in scene linear color space.\n"
    "   :rtype: :class:`Color`\n");
static PyObject *Color_from_rec2020_linear_to_scene_linear(ColorObject *self)
{
  float col[3];
  IMB_colormanagement_rec2020_to_scene_linear(col, self->col);
  return Color_CreatePyObject(col, Py_TYPE(self));
}
 
#endif /* !MATH_STANDALONE */

 
/* -------------------------------------------------------------------- */
 
PyDoc_STRVAR(
    /* Wrap. */
    Color_copy_doc,
    ".. function:: copy()\n"
    "\n"
    "   Returns a copy of this color.\n"
    "\n"
    "   :return: A copy of the color.\n"
    "   :rtype: :class:`Color`\n"
    "\n"
    "   .. note:: use this to get a copy of a wrapped color with\n"
    "      no reference to the original data.\n");
static PyObject *Color_copy(ColorObject *self)
{
  if (BaseMath_ReadCallback(self) == -1) {
    return nullptr;
  }
 
  return Color_CreatePyObject(self->col, Py_TYPE(self));
}
static PyObject *Color_deepcopy(ColorObject *self, PyObject *args)
{
  if (!PyC_CheckArgs_DeepCopy(args)) {
    return nullptr;
  }
  return Color_copy(self);
}

 
/* -------------------------------------------------------------------- */
 
static PyObject *Color_repr(ColorObject *self)
{
  PyObject *ret, *tuple;
 
  if (BaseMath_ReadCallback(self) == -1) {
    return nullptr;
  }
 
  tuple = Color_to_tuple_ex(self, -1);
 
  ret = PyUnicode_FromFormat("Color(%R)", tuple);
 
  Py_DECREF(tuple);
  return ret;
}
 
#ifndef MATH_STANDALONE
static PyObject *Color_str(ColorObject *self)
{
  DynStr *ds;
 
  if (BaseMath_ReadCallback(self) == -1) {
    return nullptr;
  }
 
  ds = BLI_dynstr_new();
 
  BLI_dynstr_appendf(
      ds, "<Color (r=%.4f, g=%.4f, b=%.4f)>", self->col[0], self->col[1], self->col[2]);
 
  return mathutils_dynstr_to_py(ds); /* frees ds */
}
#endif

 
/* -------------------------------------------------------------------- */
 
static int Color_getbuffer(PyObject *obj, Py_buffer *view, int flags)
{
  ColorObject *self = (ColorObject *)obj;
  if (UNLIKELY(BaseMath_Prepare_ForBufferAccess(self, view, flags) == -1)) {
    return -1;
  }
  if (UNLIKELY(BaseMath_ReadCallback(self) == -1)) {
    return -1;
  }
 
  memset(view, 0, sizeof(*view));
 
  view->obj = (PyObject *)self;
  view->buf = (void *)self->col;
  view->len = Py_ssize_t(COLOR_SIZE * sizeof(float));
  view->itemsize = sizeof(float);
  view->ndim = 1;
  if ((flags & PyBUF_WRITABLE) == 0) {
    view->readonly = 1;
  }
  if (flags & PyBUF_FORMAT) {
    view->format = (char *)"f";
  }
 
  self->flag |= BASE_MATH_FLAG_HAS_BUFFER_VIEW;
 
  Py_INCREF(self);
  return 0;
}
 
static void Color_releasebuffer(PyObject * /*exporter*/, Py_buffer *view)
{
  ColorObject *self = (ColorObject *)view->obj;
  self->flag &= ~BASE_MATH_FLAG_HAS_BUFFER_VIEW;
 
  if (view->readonly == 0) {
    if (UNLIKELY(BaseMath_WriteCallback(self) == -1)) {
      PyErr_Print();
    }
  }
}
 
static PyBufferProcs Color_as_buffer = {
    (getbufferproc)Color_getbuffer,
    (releasebufferproc)Color_releasebuffer,
};

 
/* -------------------------------------------------------------------- */
 
static PyObject *Color_richcmpr(PyObject *a, PyObject *b, int op)
{
  PyObject *res;
  int ok = -1; /* zero is true */
 
  if (ColorObject_Check(a) && ColorObject_Check(b)) {
    ColorObject *colA = (ColorObject *)a;
    ColorObject *colB = (ColorObject *)b;
 
    if (BaseMath_ReadCallback(colA) == -1 || BaseMath_ReadCallback(colB) == -1) {
      return nullptr;
    }
 
    ok = EXPP_VectorsAreEqual(colA->col, colB->col, COLOR_SIZE, 1) ? 0 : -1;
  }
 
  switch (op) {
    case Py_NE: {
      ok = !ok;
      ATTR_FALLTHROUGH;
    }
    case Py_EQ: {
      res = ok ? Py_False : Py_True;
      break;
    }
    case Py_LT:
    case Py_LE:
    case Py_GT:
    case Py_GE: {
      res = Py_NotImplemented;
      break;
    }
    default: {
      PyErr_BadArgument();
      return nullptr;
    }
  }
 
  return Py_NewRef(res);
}

 
/* -------------------------------------------------------------------- */
 
static Py_hash_t Color_hash(ColorObject *self)
{
  if (BaseMath_ReadCallback(self) == -1) {
    return -1;
  }
 
  if (BaseMathObject_Prepare_ForHash(self) == -1) {
    return -1;
  }
 
  return mathutils_array_hash(self->col, COLOR_SIZE);
}

 
/* -------------------------------------------------------------------- */

static Py_ssize_t Color_len(ColorObject * /*self*/)
{
  return COLOR_SIZE;
}

static PyObject *Color_item(ColorObject *self, Py_ssize_t i)
{
  if (i < 0) {
    i = COLOR_SIZE - i;
  }
 
  if (i < 0 || i >= COLOR_SIZE) {
    PyErr_SetString(PyExc_IndexError,
                    "color[item]: "
                    "array index out of range");
    return nullptr;
  }
 
  if (BaseMath_ReadIndexCallback(self, i) == -1) {
    return nullptr;
  }
 
  return PyFloat_FromDouble(self->col[i]);
}

static int Color_ass_item(ColorObject *self, Py_ssize_t i, PyObject *value)
{
  float f;
 
  if (BaseMath_Prepare_ForWrite(self) == -1) {
    return -1;
  }
 
  f = PyFloat_AsDouble(value);
  if (f == -1 && PyErr_Occurred()) { /* parsed item not a number */
    PyErr_SetString(PyExc_TypeError,
                    "color[item] = x: "
                    "assigned value not a number");
    return -1;
  }
 
  if (i < 0) {
    i = COLOR_SIZE - i;
  }
 
  if (i < 0 || i >= COLOR_SIZE) {
    PyErr_SetString(PyExc_IndexError,
                    "color[item] = x: "
                    "array assignment index out of range");
    return -1;
  }
 
  self->col[i] = f;
 
  if (BaseMath_WriteIndexCallback(self, i) == -1) {
    return -1;
  }
 
  return 0;
}

static PyObject *Color_slice(ColorObject *self, int begin, int end)
{
  PyObject *tuple;
  int count;
 
  if (BaseMath_ReadCallback(self) == -1) {
    return nullptr;
  }
 
  CLAMP(begin, 0, COLOR_SIZE);
  if (end < 0) {
    end = (COLOR_SIZE + 1) + end;
  }
  CLAMP(end, 0, COLOR_SIZE);
  begin = std::min(begin, end);
 
  tuple = PyTuple_New(end - begin);
  for (count = begin; count < end; count++) {
    PyTuple_SET_ITEM(tuple, count - begin, PyFloat_FromDouble(self->col[count]));
  }
 
  return tuple;
}

static int Color_ass_slice(ColorObject *self, int begin, int end, PyObject *seq)
{
  int i, size;
  float col[COLOR_SIZE];
 
  if (BaseMath_ReadCallback_ForWrite(self) == -1) {
    return -1;
  }
 
  CLAMP(begin, 0, COLOR_SIZE);
  if (end < 0) {
    end = (COLOR_SIZE + 1) + end;
  }
  CLAMP(end, 0, COLOR_SIZE);
  begin = std::min(begin, end);
 
  if ((size = mathutils_array_parse(col, 0, COLOR_SIZE, seq, "mathutils.Color[begin:end] = []")) ==
      -1)
  {
    return -1;
  }
 
  if (size != (end - begin)) {
    PyErr_SetString(PyExc_ValueError,
                    "color[begin:end] = []: "
                    "size mismatch in slice assignment");
    return -1;
  }
 
  for (i = 0; i < COLOR_SIZE; i++) {
    self->col[begin + i] = col[i];
  }
 
  (void)BaseMath_WriteCallback(self);
  return 0;
}

static PyObject *Color_subscript(ColorObject *self, PyObject *item)
{
  if (PyIndex_Check(item)) {
    Py_ssize_t i;
    i = PyNumber_AsSsize_t(item, PyExc_IndexError);
    if (i == -1 && PyErr_Occurred()) {
      return nullptr;
    }
    if (i < 0) {
      i += COLOR_SIZE;
    }
    return Color_item(self, i);
  }
  if (PySlice_Check(item)) {
    Py_ssize_t start, stop, step, slicelength;
 
    if (PySlice_GetIndicesEx(item, COLOR_SIZE, &start, &stop, &step, &slicelength) < 0) {
      return nullptr;
    }
 
    if (slicelength <= 0) {
      return PyTuple_New(0);
    }
    if (step == 1) {
      return Color_slice(self, start, stop);
    }
 
    PyErr_SetString(PyExc_IndexError, "slice steps not supported with color");
    return nullptr;
  }
 
  PyErr_Format(
      PyExc_TypeError, "color indices must be integers, not %.200s", Py_TYPE(item)->tp_name);
  return nullptr;
}

static int Color_ass_subscript(ColorObject *self, PyObject *item, PyObject *value)
{
  if (PyIndex_Check(item)) {
    Py_ssize_t i = PyNumber_AsSsize_t(item, PyExc_IndexError);
    if (i == -1 && PyErr_Occurred()) {
      return -1;
    }
    if (i < 0) {
      i += COLOR_SIZE;
    }
    return Color_ass_item(self, i, value);
  }
  if (PySlice_Check(item)) {
    Py_ssize_t start, stop, step, slicelength;
 
    if (PySlice_GetIndicesEx(item, COLOR_SIZE, &start, &stop, &step, &slicelength) < 0) {
      return -1;
    }
 
    if (step == 1) {
      return Color_ass_slice(self, start, stop, value);
    }
 
    PyErr_SetString(PyExc_IndexError, "slice steps not supported with color");
    return -1;
  }
 
  PyErr_Format(
      PyExc_TypeError, "color indices must be integers, not %.200s", Py_TYPE(item)->tp_name);
  return -1;
}

 
/* -------------------------------------------------------------------- */

static PyObject *Color_add(PyObject *v1, PyObject *v2)
{
  ColorObject *color1 = nullptr, *color2 = nullptr;
  float col[COLOR_SIZE];
 
  if (!ColorObject_Check(v1) || !ColorObject_Check(v2)) {
    PyErr_Format(PyExc_TypeError,
                 "Color addition: (%s + %s) "
                 "invalid type for this operation",
                 Py_TYPE(v1)->tp_name,
                 Py_TYPE(v2)->tp_name);
    return nullptr;
  }
  color1 = (ColorObject *)v1;
  color2 = (ColorObject *)v2;
 
  if (BaseMath_ReadCallback(color1) == -1 || BaseMath_ReadCallback(color2) == -1) {
    return nullptr;
  }
 
  add_vn_vnvn(col, color1->col, color2->col, COLOR_SIZE);
 
  return Color_CreatePyObject(col, Py_TYPE(v1));
}

static PyObject *Color_iadd(PyObject *v1, PyObject *v2)
{
  ColorObject *color1 = nullptr, *color2 = nullptr;
 
  if (!ColorObject_Check(v1) || !ColorObject_Check(v2)) {
    PyErr_Format(PyExc_TypeError,
                 "Color addition: (%s += %s) "
                 "invalid type for this operation",
                 Py_TYPE(v1)->tp_name,
                 Py_TYPE(v2)->tp_name);
    return nullptr;
  }
  color1 = (ColorObject *)v1;
  color2 = (ColorObject *)v2;
 
  if (BaseMath_ReadCallback_ForWrite(color1) == -1 || BaseMath_ReadCallback(color2) == -1) {
    return nullptr;
  }
 
  add_vn_vn(color1->col, color2->col, COLOR_SIZE);
 
  (void)BaseMath_WriteCallback(color1);
  Py_INCREF(v1);
  return v1;
}

static PyObject *Color_sub(PyObject *v1, PyObject *v2)
{
  ColorObject *color1 = nullptr, *color2 = nullptr;
  float col[COLOR_SIZE];
 
  if (!ColorObject_Check(v1) || !ColorObject_Check(v2)) {
    PyErr_Format(PyExc_TypeError,
                 "Color subtraction: (%s - %s) "
                 "invalid type for this operation",
                 Py_TYPE(v1)->tp_name,
                 Py_TYPE(v2)->tp_name);
    return nullptr;
  }
  color1 = (ColorObject *)v1;
  color2 = (ColorObject *)v2;
 
  if (BaseMath_ReadCallback(color1) == -1 || BaseMath_ReadCallback(color2) == -1) {
    return nullptr;
  }
 
  sub_vn_vnvn(col, color1->col, color2->col, COLOR_SIZE);
 
  return Color_CreatePyObject(col, Py_TYPE(v1));
}

static PyObject *Color_isub(PyObject *v1, PyObject *v2)
{
  ColorObject *color1 = nullptr, *color2 = nullptr;
 
  if (!ColorObject_Check(v1) || !ColorObject_Check(v2)) {
    PyErr_Format(PyExc_TypeError,
                 "Color subtraction: (%s -= %s) "
                 "invalid type for this operation",
                 Py_TYPE(v1)->tp_name,
                 Py_TYPE(v2)->tp_name);
    return nullptr;
  }
  color1 = (ColorObject *)v1;
  color2 = (ColorObject *)v2;
 
  if (BaseMath_ReadCallback_ForWrite(color1) == -1 || BaseMath_ReadCallback(color2) == -1) {
    return nullptr;
  }
 
  sub_vn_vn(color1->col, color2->col, COLOR_SIZE);
 
  (void)BaseMath_WriteCallback(color1);
  Py_INCREF(v1);
  return v1;
}
 
static PyObject *color_mul_float(ColorObject *color, const float scalar)
{
  float tcol[COLOR_SIZE];
  mul_vn_vn_fl(tcol, color->col, COLOR_SIZE, scalar);
  return Color_CreatePyObject(tcol, Py_TYPE(color));
}

static PyObject *Color_mul(PyObject *v1, PyObject *v2)
{
  ColorObject *color1 = nullptr, *color2 = nullptr;
  float scalar;
 
  if (ColorObject_Check(v1)) {
    color1 = (ColorObject *)v1;
    if (BaseMath_ReadCallback(color1) == -1) {
      return nullptr;
    }
  }
  if (ColorObject_Check(v2)) {
    color2 = (ColorObject *)v2;
    if (BaseMath_ReadCallback(color2) == -1) {
      return nullptr;
    }
  }
 
  /* make sure v1 is always the vector */
  if (color1 && color2) {
    /* col * col, don't support yet! */
  }
  else if (color1) {
    if (((scalar = PyFloat_AsDouble(v2)) == -1.0f && PyErr_Occurred()) == 0) { /* COLOR * FLOAT */
      return color_mul_float(color1, scalar);
    }
  }
  else if (color2) {
    if (((scalar = PyFloat_AsDouble(v1)) == -1.0f && PyErr_Occurred()) == 0) { /* FLOAT * COLOR */
      return color_mul_float(color2, scalar);
    }
  }
  else {
    BLI_assert_msg(0, "internal error");
  }
 
  PyErr_Format(PyExc_TypeError,
               "Color multiplication: not supported between "
               "'%.200s' and '%.200s' types",
               Py_TYPE(v1)->tp_name,
               Py_TYPE(v2)->tp_name);
  return nullptr;
}

static PyObject *Color_div(PyObject *v1, PyObject *v2)
{
  ColorObject *color1 = nullptr;
  float scalar;
 
  if (ColorObject_Check(v1)) {
    color1 = (ColorObject *)v1;
    if (BaseMath_ReadCallback(color1) == -1) {
      return nullptr;
    }
  }
  else {
    PyErr_SetString(PyExc_TypeError, "Color division not supported in this order");
    return nullptr;
  }
 
  /* make sure v1 is always the vector */
  if (((scalar = PyFloat_AsDouble(v2)) == -1.0f && PyErr_Occurred()) == 0) { /* COLOR * FLOAT */
    if (scalar == 0.0f) {
      PyErr_SetString(PyExc_ZeroDivisionError, "Color division: divide by zero error");
      return nullptr;
    }
    return color_mul_float(color1, 1.0f / scalar);
  }
 
  PyErr_Format(PyExc_TypeError,
               "Color multiplication: not supported between "
               "'%.200s' and '%.200s' types",
               Py_TYPE(v1)->tp_name,
               Py_TYPE(v2)->tp_name);
  return nullptr;
}

static PyObject *Color_imul(PyObject *v1, PyObject *v2)
{
  ColorObject *color = (ColorObject *)v1;
  float scalar;
 
  if (BaseMath_ReadCallback_ForWrite(color) == -1) {
    return nullptr;
  }
 
  /* only support color *= float */
  if (((scalar = PyFloat_AsDouble(v2)) == -1.0f && PyErr_Occurred()) == 0) { /* COLOR *= FLOAT */
    mul_vn_fl(color->col, COLOR_SIZE, scalar);
  }
  else {
    PyErr_Format(PyExc_TypeError,
                 "Color multiplication: (%s *= %s) "
                 "invalid type for this operation",
                 Py_TYPE(v1)->tp_name,
                 Py_TYPE(v2)->tp_name);
    return nullptr;
  }
 
  (void)BaseMath_WriteCallback(color);
  Py_INCREF(v1);
  return v1;
}

static PyObject *Color_idiv(PyObject *v1, PyObject *v2)
{
  ColorObject *color = (ColorObject *)v1;
  float scalar;
 
  if (BaseMath_ReadCallback_ForWrite(color) == -1) {
    return nullptr;
  }
 
  /* only support color /= float */
  if (((scalar = PyFloat_AsDouble(v2)) == -1.0f && PyErr_Occurred()) == 0) { /* COLOR /= FLOAT */
    if (scalar == 0.0f) {
      PyErr_SetString(PyExc_ZeroDivisionError, "Color division: divide by zero error");
      return nullptr;
    }
 
    mul_vn_fl(color->col, COLOR_SIZE, 1.0f / scalar);
  }
  else {
    PyErr_Format(PyExc_TypeError,
                 "Color division: (%s /= %s) "
                 "invalid type for this operation",
                 Py_TYPE(v1)->tp_name,
                 Py_TYPE(v2)->tp_name);
    return nullptr;
  }
 
  (void)BaseMath_WriteCallback(color);
  Py_INCREF(v1);
  return v1;
}

static PyObject *Color_neg(ColorObject *self)
{
  float tcol[COLOR_SIZE];
 
  if (BaseMath_ReadCallback(self) == -1) {
    return nullptr;
  }
 
  negate_vn_vn(tcol, self->col, COLOR_SIZE);
  return Color_CreatePyObject(tcol, Py_TYPE(self));
}

 
/* -------------------------------------------------------------------- */
 
static PySequenceMethods Color_SeqMethods = {
    /*sq_length*/ (lenfunc)Color_len,
    /*sq_concat*/ nullptr,
    /*sq_repeat*/ nullptr,
    /*sq_item*/ (ssizeargfunc)Color_item,
    /*was_sq_slice*/ nullptr, /* DEPRECATED. */
    /*sq_ass_item*/ (ssizeobjargproc)Color_ass_item,
    /*was_sq_ass_slice*/ nullptr, /* DEPRECATED. */
    /*sq_contains*/ nullptr,
    /*sq_inplace_concat*/ nullptr,
    /*sq_inplace_repeat*/ nullptr,
};
 
static PyMappingMethods Color_AsMapping = {
    /*mp_length*/ (lenfunc)Color_len,
    /*mp_subscript*/ (binaryfunc)Color_subscript,
    /*mp_ass_subscript*/ (objobjargproc)Color_ass_subscript,
};
 
static PyNumberMethods Color_NumMethods = {
    /*nb_add*/ (binaryfunc)Color_add,
    /*nb_subtract*/ (binaryfunc)Color_sub,
    /*nb_multiply*/ (binaryfunc)Color_mul,
    /*nb_remainder*/ nullptr,
    /*nb_divmod*/ nullptr,
    /*nb_power*/ nullptr,
    /*nb_negative*/ (unaryfunc)Color_neg,
    /*nb_positive*/ (unaryfunc)Color_copy,
    /*nb_absolute*/ nullptr,
    /*nb_bool*/ nullptr,
    /*nb_invert*/ nullptr,
    /*nb_lshift*/ nullptr,
    /*nb_rshift*/ nullptr,
    /*nb_and*/ nullptr,
    /*nb_xor*/ nullptr,
    /*nb_or*/ nullptr,
    /*nb_int*/ nullptr,
    /*nb_reserved*/ nullptr,
    /*nb_float*/ nullptr,
    /*nb_inplace_add*/ Color_iadd,
    /*nb_inplace_subtract*/ Color_isub,
    /*nb_inplace_multiply*/ Color_imul,
    /*nb_inplace_remainder*/ nullptr,
    /*nb_inplace_power*/ nullptr,
    /*nb_inplace_lshift*/ nullptr,
    /*nb_inplace_rshift*/ nullptr,
    /*nb_inplace_and*/ nullptr,
    /*nb_inplace_xor*/ nullptr,
    /*nb_inplace_or*/ nullptr,
    /*nb_floor_divide*/ nullptr,
    /*nb_true_divide*/ Color_div,
    /*nb_inplace_floor_divide*/ nullptr,
    /*nb_inplace_true_divide*/ Color_idiv,
    /*nb_index*/ nullptr,
    /*nb_matrix_multiply*/ nullptr,
    /*nb_inplace_matrix_multiply*/ nullptr,
};

 
/* -------------------------------------------------------------------- */
 
/* Color channel (RGB): `color.r/g/b`. */
 
PyDoc_STRVAR(
    /* Wrap. */
    Color_channel_r_doc,
    "Red color channel.\n"
    "\n"
    ":type: float\n");
PyDoc_STRVAR(
    /* Wrap. */
    Color_channel_g_doc,
    "Green color channel.\n"
    "\n"
    ":type: float\n");
PyDoc_STRVAR(
    /* Wrap. */
    Color_channel_b_doc,
    "Blue color channel.\n"
    "\n"
    ":type: float\n");
 
static PyObject *Color_channel_get(ColorObject *self, void *type)
{
  return Color_item(self, POINTER_AS_INT(type));
}
 
static int Color_channel_set(ColorObject *self, PyObject *value, void *type)
{
  return Color_ass_item(self, POINTER_AS_INT(type), value);
}
 
/* Color channel (HSV): `color.h/s/v`. */
 
PyDoc_STRVAR(
    /* Wrap. */
    Color_channel_hsv_h_doc,
    "HSV Hue component in [0, 1].\n"
    "\n"
    ":type: float\n");
PyDoc_STRVAR(
    /* Wrap. */
    Color_channel_hsv_s_doc,
    "HSV Saturation component in [0, 1].\n"
    "\n"
    ":type: float\n");
PyDoc_STRVAR(
    /* Wrap. */
    Color_channel_hsv_v_doc,
    "HSV Value component in [0, 1].\n"
    "\n"
    ":type: float\n");
 
static PyObject *Color_channel_hsv_get(ColorObject *self, void *type)
{
  float hsv[3];
  const int i = POINTER_AS_INT(type);
 
  if (BaseMath_ReadCallback(self) == -1) {
    return nullptr;
  }
 
  rgb_to_hsv(self->col[0], self->col[1], self->col[2], &(hsv[0]), &(hsv[1]), &(hsv[2]));
 
  return PyFloat_FromDouble(hsv[i]);
}
 
static int Color_channel_hsv_set(ColorObject *self, PyObject *value, void *type)
{
  float hsv[3];
  const int i = POINTER_AS_INT(type);
  float f = PyFloat_AsDouble(value);
 
  if (f == -1 && PyErr_Occurred()) {
    PyErr_SetString(PyExc_TypeError,
                    "color.h/s/v = value: "
                    "assigned value not a number");
    return -1;
  }
 
  if (BaseMath_ReadCallback_ForWrite(self) == -1) {
    return -1;
  }
 
  rgb_to_hsv_v(self->col, hsv);
  CLAMP(f, 0.0f, 1.0f);
  hsv[i] = f;
  hsv_to_rgb_v(hsv, self->col);
 
  if (BaseMath_WriteCallback(self) == -1) {
    return -1;
  }
 
  return 0;
}
 
PyDoc_STRVAR(
    /* Wrap. */
    Color_hsv_doc,
    "HSV Values in [0, 1].\n"
    "\n"
    ":type: tuple[float, float, float]\n");
static PyObject *Color_hsv_get(ColorObject *self, void * /*closure*/)
{
  float hsv[3];
  PyObject *ret;
 
  if (BaseMath_ReadCallback(self) == -1) {
    return nullptr;
  }
 
  rgb_to_hsv(self->col[0], self->col[1], self->col[2], &(hsv[0]), &(hsv[1]), &(hsv[2]));
 
  ret = PyTuple_New(3);
  PyTuple_SET_ITEMS(
      ret, PyFloat_FromDouble(hsv[0]), PyFloat_FromDouble(hsv[1]), PyFloat_FromDouble(hsv[2]));
  return ret;
}

static int Color_hsv_set(ColorObject *self, PyObject *value, void * /*closure*/)
{
  float hsv[3];
 
  if (mathutils_array_parse(hsv, 3, 3, value, "mathutils.Color.hsv = value") == -1) {
    return -1;
  }
 
  if (BaseMath_Prepare_ForWrite(self) == -1) {
    return -1;
  }
 
  clamp_v3(hsv, 0.0f, 1.0f);
  hsv_to_rgb_v(hsv, self->col);
 
  if (BaseMath_WriteCallback(self) == -1) {
    return -1;
  }
 
  return 0;
}

 
/* -------------------------------------------------------------------- */
 
static PyGetSetDef Color_getseters[] = {
    {"r",
     (getter)Color_channel_get,
     (setter)Color_channel_set,
     Color_channel_r_doc,
     POINTER_FROM_INT(0)},
    {"g",
     (getter)Color_channel_get,
     (setter)Color_channel_set,
     Color_channel_g_doc,
     POINTER_FROM_INT(1)},
    {"b",
     (getter)Color_channel_get,
     (setter)Color_channel_set,
     Color_channel_b_doc,
     POINTER_FROM_INT(2)},
 
    {"h",
     (getter)Color_channel_hsv_get,
     (setter)Color_channel_hsv_set,
     Color_channel_hsv_h_doc,
     POINTER_FROM_INT(0)},
    {"s",
     (getter)Color_channel_hsv_get,
     (setter)Color_channel_hsv_set,
     Color_channel_hsv_s_doc,
     POINTER_FROM_INT(1)},
    {"v",
     (getter)Color_channel_hsv_get,
     (setter)Color_channel_hsv_set,
     Color_channel_hsv_v_doc,
     POINTER_FROM_INT(2)},
 
    {"hsv", (getter)Color_hsv_get, (setter)Color_hsv_set, Color_hsv_doc, nullptr},
 
    {"is_wrapped",
     (getter)BaseMathObject_is_wrapped_get,
     (setter) nullptr,
     BaseMathObject_is_wrapped_doc,
     nullptr},
    {"is_frozen",
     (getter)BaseMathObject_is_frozen_get,
     (setter) nullptr,
     BaseMathObject_is_frozen_doc,
     nullptr},
    {"is_valid",
     (getter)BaseMathObject_is_valid_get,
     (setter) nullptr,
     BaseMathObject_is_valid_doc,
     nullptr},
    {"owner",
     (getter)BaseMathObject_owner_get,
     (setter) nullptr,
     BaseMathObject_owner_doc,
     nullptr},
    {nullptr, nullptr, nullptr, nullptr, nullptr} /* Sentinel */
};

 
/* -------------------------------------------------------------------- */
 
#ifdef __GNUC__
#  ifdef __clang__
#    pragma clang diagnostic push
#    pragma clang diagnostic ignored "-Wcast-function-type"
#  else
#    pragma GCC diagnostic push
#    pragma GCC diagnostic ignored "-Wcast-function-type"
#  endif
#endif
 
static PyMethodDef Color_methods[] = {
    {"copy", (PyCFunction)Color_copy, METH_NOARGS, Color_copy_doc},
    {"__copy__", (PyCFunction)Color_copy, METH_NOARGS, Color_copy_doc},
    {"__deepcopy__", (PyCFunction)Color_deepcopy, METH_VARARGS, Color_copy_doc},
 
    /* base-math methods */
    {"freeze", (PyCFunction)BaseMathObject_freeze, METH_NOARGS, BaseMathObject_freeze_doc},
 
/* Color-space methods. */
#ifndef MATH_STANDALONE
    {"from_scene_linear_to_srgb",
     (PyCFunction)Color_from_scene_linear_to_srgb,
     METH_NOARGS,
     Color_from_scene_linear_to_srgb_doc},
    {"from_srgb_to_scene_linear",
     (PyCFunction)Color_from_srgb_to_scene_linear,
     METH_NOARGS,
     Color_from_srgb_to_scene_linear_doc},
    {"from_scene_linear_to_xyz_d65",
     (PyCFunction)Color_from_scene_linear_to_xyz_d65,
     METH_NOARGS,
     Color_from_scene_linear_to_xyz_d65_doc},
    {"from_xyz_d65_to_scene_linear",
     (PyCFunction)Color_from_xyz_d65_to_scene_linear,
     METH_NOARGS,
     Color_from_xyz_d65_to_scene_linear_doc},
    {"from_scene_linear_to_aces",
     (PyCFunction)Color_from_scene_linear_to_aces,
     METH_NOARGS,
     Color_from_scene_linear_to_aces_doc},
    {"from_aces_to_scene_linear",
     (PyCFunction)Color_from_aces_to_scene_linear,
     METH_NOARGS,
     Color_from_aces_to_scene_linear_doc},
    {"from_scene_linear_to_acescg",
     (PyCFunction)Color_from_scene_linear_to_acescg,
     METH_NOARGS,
     Color_from_scene_linear_to_acescg_doc},
    {"from_acescg_to_scene_linear",
     (PyCFunction)Color_from_acescg_to_scene_linear,
     METH_NOARGS,
     Color_from_acescg_to_scene_linear_doc},
    {"from_scene_linear_to_rec709_linear",
     (PyCFunction)Color_from_scene_linear_to_rec709_linear,
     METH_NOARGS,
     Color_from_scene_linear_to_rec709_linear_doc},
    {"from_rec709_linear_to_scene_linear",
     (PyCFunction)Color_from_rec709_linear_to_scene_linear,
     METH_NOARGS,
     Color_from_rec709_linear_to_scene_linear_doc},
    {"from_scene_linear_to_rec2020_linear",
     (PyCFunction)Color_from_scene_linear_to_rec2020_linear,
     METH_NOARGS,
     Color_from_scene_linear_to_rec2020_linear_doc},
    {"from_rec2020_linear_to_scene_linear",
     (PyCFunction)Color_from_rec2020_linear_to_scene_linear,
     METH_NOARGS,
     Color_from_rec2020_linear_to_scene_linear_doc},
#endif /* !MATH_STANDALONE */
 
    {nullptr, nullptr, 0, nullptr},
};
 
#ifdef __GNUC__
#  ifdef __clang__
#    pragma clang diagnostic pop
#  else
#    pragma GCC diagnostic pop
#  endif
#endif

 
/* -------------------------------------------------------------------- */
 
#ifdef MATH_STANDALONE
#  define Color_str nullptr
#endif
 
PyDoc_STRVAR(
    /* Wrap. */
    color_doc,
    ".. class:: Color(rgb=(0.0, 0.0, 0.0), /)\n"
    "\n"
    "   This object gives access to Colors in Blender.\n"
    "\n"
    "   Most colors returned by Blender APIs are in scene linear color space, as defined by "
    "   the OpenColorIO configuration. The notable exception is user interface theming colors, "
    "   which are in sRGB color space.\n"
    "\n"
    "   :arg rgb: (red, green, blue) color values where (0, 0, 0) is black & (1, 1, 1) is white.\n"
    "   :type rgb: Sequence[float]\n");
PyTypeObject color_Type = {
    /*ob_base*/ PyVarObject_HEAD_INIT(nullptr, 0)
    /*tp_name*/ "Color",
    /*tp_basicsize*/ sizeof(ColorObject),
    /*tp_itemsize*/ 0,
    /*tp_dealloc*/ (destructor)BaseMathObject_dealloc,
    /*tp_vectorcall_offset*/ 0,
    /*tp_getattr*/ nullptr,
    /*tp_setattr*/ nullptr,
    /*tp_as_async*/ nullptr,
    /*tp_repr*/ (reprfunc)Color_repr,
    /*tp_as_number*/ &Color_NumMethods,
    /*tp_as_sequence*/ &Color_SeqMethods,
    /*tp_as_mapping*/ &Color_AsMapping,
    /*tp_hash*/ (hashfunc)Color_hash,
    /*tp_call*/ nullptr,
    /*tp_str*/ (reprfunc)Color_str,
    /*tp_getattro*/ nullptr,
    /*tp_setattro*/ nullptr,
    /*tp_as_buffer*/ &Color_as_buffer,
    /*tp_flags*/ Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE | Py_TPFLAGS_HAVE_GC,
    /*tp_doc*/ color_doc,
    /*tp_traverse*/ (traverseproc)BaseMathObject_traverse,
    /*tp_clear*/ (inquiry)BaseMathObject_clear,
    /*tp_richcompare*/ (richcmpfunc)Color_richcmpr,
    /*tp_weaklistoffset*/ 0,
    /*tp_iter*/ nullptr,
    /*tp_iternext*/ nullptr,
    /*tp_methods*/ Color_methods,
    /*tp_members*/ nullptr,
    /*tp_getset*/ Color_getseters,
    /*tp_base*/ nullptr,
    /*tp_dict*/ nullptr,
    /*tp_descr_get*/ nullptr,
    /*tp_descr_set*/ nullptr,
    /*tp_dictoffset*/ 0,
    /*tp_init*/ nullptr,
    /*tp_alloc*/ nullptr,
    /*tp_new*/ Color_new,
    /*tp_free*/ nullptr,
    /*tp_is_gc*/ (inquiry)BaseMathObject_is_gc,
    /*tp_bases*/ nullptr,
    /*tp_mro*/ nullptr,
    /*tp_cache*/ nullptr,
    /*tp_subclasses*/ nullptr,
    /*tp_weaklist*/ nullptr,
    /*tp_del*/ nullptr,
    /*tp_version_tag*/ 0,
    /*tp_finalize*/ nullptr,
    /*tp_vectorcall*/ Color_vectorcall,
};
 
#ifdef MATH_STANDALONE
#  define Color_str
#endif

 
/* -------------------------------------------------------------------- */
 
PyObject *Color_CreatePyObject(const float col[3], PyTypeObject *base_type)
{
  ColorObject *self;
  float *col_alloc;
 
  col_alloc = static_cast<float *>(PyMem_Malloc(COLOR_SIZE * sizeof(float)));
  if (UNLIKELY(col_alloc == nullptr)) {
    PyErr_SetString(PyExc_MemoryError,
                    "Color(): "
                    "problem allocating data");
    return nullptr;
  }
 
  self = BASE_MATH_NEW(ColorObject, color_Type, base_type);
  if (self) {
    self->col = col_alloc;
 
    /* init callbacks as nullptr */
    self->cb_user = nullptr;
    self->cb_type = self->cb_subtype = 0;
 
    /* NEW */
    if (col) {
      copy_v3_v3(self->col, col);
    }
    else {
      zero_v3(self->col);
    }
 
    self->flag = BASE_MATH_FLAG_DEFAULT;
  }
  else {
    PyMem_Free(col_alloc);
  }
 
  return (PyObject *)self;
}
 
PyObject *Color_CreatePyObject_wrap(float col[3], PyTypeObject *base_type)
{
  ColorObject *self;
 
  self = BASE_MATH_NEW(ColorObject, color_Type, base_type);
  if (self) {
    /* init callbacks as nullptr */
    self->cb_user = nullptr;
    self->cb_type = self->cb_subtype = 0;
 
    /* WRAP */
    self->col = col;
    self->flag = BASE_MATH_FLAG_DEFAULT | BASE_MATH_FLAG_IS_WRAP;
  }
 
  return (PyObject *)self;
}
 
PyObject *Color_CreatePyObject_cb(PyObject *cb_user, uchar cb_type, uchar cb_subtype)
{
  ColorObject *self = (ColorObject *)Color_CreatePyObject(nullptr, nullptr);
  if (self) {
    Py_INCREF(cb_user);
    self->cb_user = cb_user;
    self->cb_type = cb_type;
    self->cb_subtype = cb_subtype;
    BLI_assert(!PyObject_GC_IsTracked((PyObject *)self));
    PyObject_GC_Track(self);
  }
 
  return (PyObject *)self;
}