683 lines
19 KiB
C++
683 lines
19 KiB
C++
/* SPDX-FileCopyrightText: 2023 Blender Authors
|
|
*
|
|
* SPDX-License-Identifier: GPL-2.0-or-later */
|
|
|
|
/** \file
|
|
* \ingroup pygen
|
|
*
|
|
* This file defines the 'imbuf' image manipulation module.
|
|
*/
|
|
|
|
#include <Python.h>
|
|
|
|
#include "BLI_rect.h"
|
|
#include "BLI_string.h"
|
|
#include "BLI_utildefines.h"
|
|
|
|
#include "py_capi_utils.h"
|
|
|
|
#include "python_compat.h"
|
|
#include "python_utildefines.h"
|
|
|
|
#include "imbuf_py_api.h" /* own include */
|
|
|
|
#include "../../imbuf/IMB_imbuf.h"
|
|
#include "../../imbuf/IMB_imbuf_types.h"
|
|
|
|
/* File IO */
|
|
#include "BLI_fileops.h"
|
|
#include <cerrno>
|
|
#include <fcntl.h>
|
|
|
|
static PyObject *BPyInit_imbuf_types(void);
|
|
|
|
static PyObject *Py_ImBuf_CreatePyObject(ImBuf *ibuf);
|
|
|
|
/* -------------------------------------------------------------------- */
|
|
/** \name Type & Utilities
|
|
* \{ */
|
|
|
|
struct Py_ImBuf {
|
|
PyObject_VAR_HEAD
|
|
/* can be nullptr */
|
|
ImBuf *ibuf;
|
|
};
|
|
|
|
static int py_imbuf_valid_check(Py_ImBuf *self)
|
|
{
|
|
if (LIKELY(self->ibuf)) {
|
|
return 0;
|
|
}
|
|
|
|
PyErr_Format(
|
|
PyExc_ReferenceError, "ImBuf data of type %.200s has been freed", Py_TYPE(self)->tp_name);
|
|
return -1;
|
|
}
|
|
|
|
#define PY_IMBUF_CHECK_OBJ(obj) \
|
|
if (UNLIKELY(py_imbuf_valid_check(obj) == -1)) { \
|
|
return nullptr; \
|
|
} \
|
|
((void)0)
|
|
#define PY_IMBUF_CHECK_INT(obj) \
|
|
if (UNLIKELY(py_imbuf_valid_check(obj) == -1)) { \
|
|
return -1; \
|
|
} \
|
|
((void)0)
|
|
|
|
/** \} */
|
|
|
|
/* -------------------------------------------------------------------- */
|
|
/** \name Methods
|
|
* \{ */
|
|
|
|
PyDoc_STRVAR(py_imbuf_resize_doc,
|
|
".. method:: resize(size, method='FAST')\n"
|
|
"\n"
|
|
" Resize the image.\n"
|
|
"\n"
|
|
" :arg size: New size.\n"
|
|
" :type size: pair of ints\n"
|
|
" :arg method: Method of resizing ('FAST', 'BILINEAR')\n"
|
|
" :type method: str\n");
|
|
static PyObject *py_imbuf_resize(Py_ImBuf *self, PyObject *args, PyObject *kw)
|
|
{
|
|
PY_IMBUF_CHECK_OBJ(self);
|
|
|
|
int size[2];
|
|
|
|
enum { FAST, BILINEAR };
|
|
const PyC_StringEnumItems method_items[] = {
|
|
{FAST, "FAST"},
|
|
{BILINEAR, "BILINEAR"},
|
|
{0, nullptr},
|
|
};
|
|
PyC_StringEnum method = {method_items, FAST};
|
|
|
|
static const char *_keywords[] = {"size", "method", nullptr};
|
|
static _PyArg_Parser _parser = {
|
|
PY_ARG_PARSER_HEAD_COMPAT()
|
|
"(ii)" /* `size` */
|
|
"|$" /* Optional keyword only arguments. */
|
|
"O&" /* `method` */
|
|
":resize",
|
|
_keywords,
|
|
nullptr,
|
|
};
|
|
if (!_PyArg_ParseTupleAndKeywordsFast(
|
|
args, kw, &_parser, &size[0], &size[1], PyC_ParseStringEnum, &method))
|
|
{
|
|
return nullptr;
|
|
}
|
|
if (size[0] <= 0 || size[1] <= 0) {
|
|
PyErr_Format(PyExc_ValueError, "resize: Image size cannot be below 1 (%d, %d)", UNPACK2(size));
|
|
return nullptr;
|
|
}
|
|
|
|
if (method.value_found == FAST) {
|
|
IMB_scalefastImBuf(self->ibuf, UNPACK2(size));
|
|
}
|
|
else if (method.value_found == BILINEAR) {
|
|
IMB_scaleImBuf(self->ibuf, UNPACK2(size));
|
|
}
|
|
else {
|
|
BLI_assert_unreachable();
|
|
}
|
|
Py_RETURN_NONE;
|
|
}
|
|
|
|
PyDoc_STRVAR(py_imbuf_crop_doc,
|
|
".. method:: crop(min, max)\n"
|
|
"\n"
|
|
" Crop the image.\n"
|
|
"\n"
|
|
" :arg min: X, Y minimum.\n"
|
|
" :type min: pair of ints\n"
|
|
" :arg max: X, Y maximum.\n"
|
|
" :type max: pair of ints\n");
|
|
static PyObject *py_imbuf_crop(Py_ImBuf *self, PyObject *args, PyObject *kw)
|
|
{
|
|
PY_IMBUF_CHECK_OBJ(self);
|
|
|
|
rcti crop;
|
|
|
|
static const char *_keywords[] = {"min", "max", nullptr};
|
|
static _PyArg_Parser _parser = {
|
|
PY_ARG_PARSER_HEAD_COMPAT()
|
|
"(II)" /* `min` */
|
|
"(II)" /* `max` */
|
|
":crop",
|
|
_keywords,
|
|
nullptr,
|
|
};
|
|
if (!_PyArg_ParseTupleAndKeywordsFast(
|
|
args, kw, &_parser, &crop.xmin, &crop.ymin, &crop.xmax, &crop.ymax))
|
|
{
|
|
return nullptr;
|
|
}
|
|
|
|
if (/* X range. */
|
|
!(crop.xmin >= 0 && crop.xmax < self->ibuf->x) ||
|
|
/* Y range. */
|
|
!(crop.ymin >= 0 && crop.ymax < self->ibuf->y) ||
|
|
/* X order. */
|
|
!(crop.xmin <= crop.xmax) ||
|
|
/* Y order. */
|
|
!(crop.ymin <= crop.ymax))
|
|
{
|
|
PyErr_SetString(PyExc_ValueError, "ImBuf crop min/max not in range");
|
|
return nullptr;
|
|
}
|
|
IMB_rect_crop(self->ibuf, &crop);
|
|
Py_RETURN_NONE;
|
|
}
|
|
|
|
PyDoc_STRVAR(py_imbuf_copy_doc,
|
|
".. method:: copy()\n"
|
|
"\n"
|
|
" :return: A copy of the image.\n"
|
|
" :rtype: :class:`ImBuf`\n");
|
|
static PyObject *py_imbuf_copy(Py_ImBuf *self)
|
|
{
|
|
PY_IMBUF_CHECK_OBJ(self);
|
|
ImBuf *ibuf_copy = IMB_dupImBuf(self->ibuf);
|
|
|
|
if (UNLIKELY(ibuf_copy == nullptr)) {
|
|
PyErr_SetString(PyExc_MemoryError,
|
|
"ImBuf.copy(): "
|
|
"failed to allocate memory");
|
|
return nullptr;
|
|
}
|
|
return Py_ImBuf_CreatePyObject(ibuf_copy);
|
|
}
|
|
|
|
static PyObject *py_imbuf_deepcopy(Py_ImBuf *self, PyObject *args)
|
|
{
|
|
if (!PyC_CheckArgs_DeepCopy(args)) {
|
|
return nullptr;
|
|
}
|
|
return py_imbuf_copy(self);
|
|
}
|
|
|
|
PyDoc_STRVAR(py_imbuf_free_doc,
|
|
".. method:: free()\n"
|
|
"\n"
|
|
" Clear image data immediately (causing an error on re-use).\n");
|
|
static PyObject *py_imbuf_free(Py_ImBuf *self)
|
|
{
|
|
if (self->ibuf) {
|
|
IMB_freeImBuf(self->ibuf);
|
|
self->ibuf = nullptr;
|
|
}
|
|
Py_RETURN_NONE;
|
|
}
|
|
|
|
#if (defined(__GNUC__) && !defined(__clang__))
|
|
# pragma GCC diagnostic push
|
|
# pragma GCC diagnostic ignored "-Wcast-function-type"
|
|
#endif
|
|
|
|
static PyMethodDef Py_ImBuf_methods[] = {
|
|
{"resize", (PyCFunction)py_imbuf_resize, METH_VARARGS | METH_KEYWORDS, py_imbuf_resize_doc},
|
|
{"crop", (PyCFunction)py_imbuf_crop, METH_VARARGS | METH_KEYWORDS, (char *)py_imbuf_crop_doc},
|
|
{"free", (PyCFunction)py_imbuf_free, METH_NOARGS, py_imbuf_free_doc},
|
|
{"copy", (PyCFunction)py_imbuf_copy, METH_NOARGS, py_imbuf_copy_doc},
|
|
{"__copy__", (PyCFunction)py_imbuf_copy, METH_NOARGS, py_imbuf_copy_doc},
|
|
{"__deepcopy__", (PyCFunction)py_imbuf_deepcopy, METH_VARARGS, py_imbuf_copy_doc},
|
|
{nullptr, nullptr, 0, nullptr},
|
|
};
|
|
|
|
#if (defined(__GNUC__) && !defined(__clang__))
|
|
# pragma GCC diagnostic pop
|
|
#endif
|
|
|
|
/** \} */
|
|
|
|
/* -------------------------------------------------------------------- */
|
|
/** \name Attributes
|
|
* \{ */
|
|
|
|
PyDoc_STRVAR(py_imbuf_size_doc, "size of the image in pixels.\n\n:type: pair of ints");
|
|
static PyObject *py_imbuf_size_get(Py_ImBuf *self, void * /*closure*/)
|
|
{
|
|
PY_IMBUF_CHECK_OBJ(self);
|
|
ImBuf *ibuf = self->ibuf;
|
|
return PyC_Tuple_Pack_I32({ibuf->x, ibuf->y});
|
|
}
|
|
|
|
PyDoc_STRVAR(py_imbuf_ppm_doc, "pixels per meter.\n\n:type: pair of floats");
|
|
static PyObject *py_imbuf_ppm_get(Py_ImBuf *self, void * /*closure*/)
|
|
{
|
|
PY_IMBUF_CHECK_OBJ(self);
|
|
ImBuf *ibuf = self->ibuf;
|
|
return PyC_Tuple_Pack_F64({ibuf->ppm[0], ibuf->ppm[1]});
|
|
}
|
|
|
|
static int py_imbuf_ppm_set(Py_ImBuf *self, PyObject *value, void * /*closure*/)
|
|
{
|
|
PY_IMBUF_CHECK_INT(self);
|
|
double ppm[2];
|
|
|
|
if (PyC_AsArray(ppm, sizeof(*ppm), value, 2, &PyFloat_Type, "ppm") == -1) {
|
|
return -1;
|
|
}
|
|
|
|
if (ppm[0] <= 0.0 || ppm[1] <= 0.0) {
|
|
PyErr_SetString(PyExc_ValueError, "invalid ppm value");
|
|
return -1;
|
|
}
|
|
|
|
ImBuf *ibuf = self->ibuf;
|
|
ibuf->ppm[0] = ppm[0];
|
|
ibuf->ppm[1] = ppm[1];
|
|
return 0;
|
|
}
|
|
|
|
PyDoc_STRVAR(py_imbuf_filepath_doc, "filepath associated with this image.\n\n:type: string");
|
|
static PyObject *py_imbuf_filepath_get(Py_ImBuf *self, void * /*closure*/)
|
|
{
|
|
PY_IMBUF_CHECK_OBJ(self);
|
|
ImBuf *ibuf = self->ibuf;
|
|
return PyC_UnicodeFromBytes(ibuf->filepath);
|
|
}
|
|
|
|
static int py_imbuf_filepath_set(Py_ImBuf *self, PyObject *value, void * /*closure*/)
|
|
{
|
|
PY_IMBUF_CHECK_INT(self);
|
|
|
|
if (!PyUnicode_Check(value)) {
|
|
PyErr_SetString(PyExc_TypeError, "expected a string!");
|
|
return -1;
|
|
}
|
|
|
|
ImBuf *ibuf = self->ibuf;
|
|
const Py_ssize_t value_str_len_max = sizeof(ibuf->filepath);
|
|
Py_ssize_t value_str_len;
|
|
const char *value_str = PyUnicode_AsUTF8AndSize(value, &value_str_len);
|
|
if (value_str_len >= value_str_len_max) {
|
|
PyErr_Format(PyExc_TypeError, "filepath length over %zd", value_str_len_max - 1);
|
|
return -1;
|
|
}
|
|
memcpy(ibuf->filepath, value_str, value_str_len + 1);
|
|
return 0;
|
|
}
|
|
|
|
PyDoc_STRVAR(py_imbuf_planes_doc, "Number of bits associated with this image.\n\n:type: int");
|
|
static PyObject *py_imbuf_planes_get(Py_ImBuf *self, void * /*closure*/)
|
|
{
|
|
PY_IMBUF_CHECK_OBJ(self);
|
|
ImBuf *imbuf = self->ibuf;
|
|
return PyLong_FromLong(imbuf->planes);
|
|
}
|
|
|
|
PyDoc_STRVAR(py_imbuf_channels_doc, "Number of bit-planes.\n\n:type: int");
|
|
static PyObject *py_imbuf_channels_get(Py_ImBuf *self, void * /*closure*/)
|
|
{
|
|
PY_IMBUF_CHECK_OBJ(self);
|
|
ImBuf *imbuf = self->ibuf;
|
|
return PyLong_FromLong(imbuf->channels);
|
|
}
|
|
|
|
static PyGetSetDef Py_ImBuf_getseters[] = {
|
|
{"size", (getter)py_imbuf_size_get, (setter) nullptr, py_imbuf_size_doc, nullptr},
|
|
{"ppm", (getter)py_imbuf_ppm_get, (setter)py_imbuf_ppm_set, py_imbuf_ppm_doc, nullptr},
|
|
{"filepath",
|
|
(getter)py_imbuf_filepath_get,
|
|
(setter)py_imbuf_filepath_set,
|
|
py_imbuf_filepath_doc,
|
|
nullptr},
|
|
{"planes", (getter)py_imbuf_planes_get, nullptr, py_imbuf_planes_doc, nullptr},
|
|
{"channels", (getter)py_imbuf_channels_get, nullptr, py_imbuf_channels_doc, nullptr},
|
|
{nullptr, nullptr, nullptr, nullptr, nullptr} /* Sentinel */
|
|
};
|
|
|
|
/** \} */
|
|
|
|
/* -------------------------------------------------------------------- */
|
|
/** \name Type & Implementation
|
|
* \{ */
|
|
|
|
static void py_imbuf_dealloc(Py_ImBuf *self)
|
|
{
|
|
ImBuf *ibuf = self->ibuf;
|
|
if (ibuf != nullptr) {
|
|
IMB_freeImBuf(self->ibuf);
|
|
self->ibuf = nullptr;
|
|
}
|
|
PyObject_DEL(self);
|
|
}
|
|
|
|
static PyObject *py_imbuf_repr(Py_ImBuf *self)
|
|
{
|
|
const ImBuf *ibuf = self->ibuf;
|
|
if (ibuf != nullptr) {
|
|
return PyUnicode_FromFormat("<imbuf: address=%p, filepath='%s', size=(%d, %d)>",
|
|
ibuf,
|
|
ibuf->filepath,
|
|
ibuf->x,
|
|
ibuf->y);
|
|
}
|
|
|
|
return PyUnicode_FromString("<imbuf: address=0x0>");
|
|
}
|
|
|
|
static Py_hash_t py_imbuf_hash(Py_ImBuf *self)
|
|
{
|
|
return _Py_HashPointer(self->ibuf);
|
|
}
|
|
|
|
PyTypeObject Py_ImBuf_Type = {
|
|
/*ob_base*/ PyVarObject_HEAD_INIT(nullptr, 0)
|
|
/*tp_name*/ "ImBuf",
|
|
/*tp_basicsize*/ sizeof(Py_ImBuf),
|
|
/*tp_itemsize*/ 0,
|
|
/*tp_dealloc*/ (destructor)py_imbuf_dealloc,
|
|
/*tp_vectorcall_offset*/ 0,
|
|
/*tp_getattr*/ nullptr,
|
|
/*tp_setattr*/ nullptr,
|
|
/*tp_as_async*/ nullptr,
|
|
/*tp_repr*/ (reprfunc)py_imbuf_repr,
|
|
/*tp_as_number*/ nullptr,
|
|
/*tp_as_sequence*/ nullptr,
|
|
/*tp_as_mapping*/ nullptr,
|
|
/*tp_hash*/ (hashfunc)py_imbuf_hash,
|
|
/*tp_call*/ nullptr,
|
|
/*tp_str*/ nullptr,
|
|
/*tp_getattro*/ nullptr,
|
|
/*tp_setattro*/ nullptr,
|
|
/*tp_as_buffer*/ nullptr,
|
|
/*tp_flags*/ Py_TPFLAGS_DEFAULT,
|
|
/*tp_doc*/ nullptr,
|
|
/*tp_traverse*/ nullptr,
|
|
/*tp_clear*/ nullptr,
|
|
/*tp_richcompare*/ nullptr,
|
|
/*tp_weaklistoffset*/ 0,
|
|
/*tp_iter*/ nullptr,
|
|
/*tp_iternext*/ nullptr,
|
|
/*tp_methods*/ Py_ImBuf_methods,
|
|
/*tp_members*/ nullptr,
|
|
/*tp_getset*/ Py_ImBuf_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*/ nullptr,
|
|
/*tp_free*/ nullptr,
|
|
/*tp_is_gc*/ nullptr,
|
|
/*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*/ nullptr,
|
|
};
|
|
|
|
static PyObject *Py_ImBuf_CreatePyObject(ImBuf *ibuf)
|
|
{
|
|
Py_ImBuf *self = PyObject_New(Py_ImBuf, &Py_ImBuf_Type);
|
|
self->ibuf = ibuf;
|
|
return (PyObject *)self;
|
|
}
|
|
|
|
/** \} */
|
|
|
|
/* -------------------------------------------------------------------- */
|
|
/** \name Module Functions
|
|
* \{ */
|
|
|
|
PyDoc_STRVAR(M_imbuf_new_doc,
|
|
".. function:: new(size)\n"
|
|
"\n"
|
|
" Load a new image.\n"
|
|
"\n"
|
|
" :arg size: The size of the image in pixels.\n"
|
|
" :type size: pair of ints\n"
|
|
" :return: the newly loaded image.\n"
|
|
" :rtype: :class:`ImBuf`\n");
|
|
static PyObject *M_imbuf_new(PyObject * /*self*/, PyObject *args, PyObject *kw)
|
|
{
|
|
int size[2];
|
|
static const char *_keywords[] = {"size", nullptr};
|
|
static _PyArg_Parser _parser = {
|
|
PY_ARG_PARSER_HEAD_COMPAT()
|
|
"(ii)" /* `size` */
|
|
":new",
|
|
_keywords,
|
|
nullptr,
|
|
};
|
|
if (!_PyArg_ParseTupleAndKeywordsFast(args, kw, &_parser, &size[0], &size[1])) {
|
|
return nullptr;
|
|
}
|
|
if (size[0] <= 0 || size[1] <= 0) {
|
|
PyErr_Format(PyExc_ValueError, "new: Image size cannot be below 1 (%d, %d)", UNPACK2(size));
|
|
return nullptr;
|
|
}
|
|
|
|
/* TODO: make options. */
|
|
const uchar planes = 4;
|
|
const uint flags = IB_rect;
|
|
|
|
ImBuf *ibuf = IMB_allocImBuf(UNPACK2(size), planes, flags);
|
|
if (ibuf == nullptr) {
|
|
PyErr_Format(PyExc_ValueError, "new: Unable to create image (%d, %d)", UNPACK2(size));
|
|
return nullptr;
|
|
}
|
|
return Py_ImBuf_CreatePyObject(ibuf);
|
|
}
|
|
|
|
static PyObject *imbuf_load_impl(const char *filepath)
|
|
{
|
|
const int file = BLI_open(filepath, O_BINARY | O_RDONLY, 0);
|
|
if (file == -1) {
|
|
PyErr_Format(PyExc_IOError, "load: %s, failed to open file '%s'", strerror(errno), filepath);
|
|
return nullptr;
|
|
}
|
|
|
|
ImBuf *ibuf = IMB_loadifffile(file, IB_rect, nullptr, filepath);
|
|
|
|
close(file);
|
|
|
|
if (ibuf == nullptr) {
|
|
PyErr_Format(
|
|
PyExc_ValueError, "load: Unable to recognize image format for file '%s'", filepath);
|
|
return nullptr;
|
|
}
|
|
|
|
STRNCPY(ibuf->filepath, filepath);
|
|
|
|
return Py_ImBuf_CreatePyObject(ibuf);
|
|
}
|
|
|
|
PyDoc_STRVAR(M_imbuf_load_doc,
|
|
".. function:: load(filepath)\n"
|
|
"\n"
|
|
" Load an image from a file.\n"
|
|
"\n"
|
|
" :arg filepath: the filepath of the image.\n"
|
|
" :type filepath: string or bytes\n"
|
|
" :return: the newly loaded image.\n"
|
|
" :rtype: :class:`ImBuf`\n");
|
|
static PyObject *M_imbuf_load(PyObject * /*self*/, PyObject *args, PyObject *kw)
|
|
{
|
|
PyC_UnicodeAsBytesAndSize_Data filepath_data = {nullptr};
|
|
|
|
static const char *_keywords[] = {"filepath", nullptr};
|
|
static _PyArg_Parser _parser = {
|
|
PY_ARG_PARSER_HEAD_COMPAT()
|
|
"O&" /* `filepath` */
|
|
":load",
|
|
_keywords,
|
|
nullptr,
|
|
};
|
|
if (!_PyArg_ParseTupleAndKeywordsFast(
|
|
args, kw, &_parser, PyC_ParseUnicodeAsBytesAndSize, &filepath_data))
|
|
{
|
|
return nullptr;
|
|
}
|
|
|
|
PyObject *result = imbuf_load_impl(filepath_data.value);
|
|
Py_XDECREF(filepath_data.value_coerce);
|
|
return result;
|
|
}
|
|
|
|
static PyObject *imbuf_write_impl(ImBuf *ibuf, const char *filepath)
|
|
{
|
|
const bool ok = IMB_saveiff(ibuf, filepath, IB_rect);
|
|
if (ok == false) {
|
|
PyErr_Format(
|
|
PyExc_IOError, "write: Unable to write image file (%s) '%s'", strerror(errno), filepath);
|
|
return nullptr;
|
|
}
|
|
Py_RETURN_NONE;
|
|
}
|
|
|
|
PyDoc_STRVAR(
|
|
M_imbuf_write_doc,
|
|
".. function:: write(image, filepath=image.filepath)\n"
|
|
"\n"
|
|
" Write an image.\n"
|
|
"\n"
|
|
" :arg image: the image to write.\n"
|
|
" :type image: :class:`ImBuf`\n"
|
|
" :arg filepath: Optional filepath of the image (fallback to the images file path).\n"
|
|
" :type filepath: string, bytes or NoneType\n");
|
|
static PyObject *M_imbuf_write(PyObject * /*self*/, PyObject *args, PyObject *kw)
|
|
{
|
|
Py_ImBuf *py_imb;
|
|
PyC_UnicodeAsBytesAndSize_Data filepath_data = {nullptr};
|
|
|
|
static const char *_keywords[] = {"image", "filepath", nullptr};
|
|
static _PyArg_Parser _parser = {
|
|
PY_ARG_PARSER_HEAD_COMPAT()
|
|
"O!" /* `image` */
|
|
"|$" /* Optional keyword only arguments. */
|
|
"O&" /* `filepath` */
|
|
":write",
|
|
_keywords,
|
|
nullptr,
|
|
};
|
|
if (!_PyArg_ParseTupleAndKeywordsFast(args,
|
|
kw,
|
|
&_parser,
|
|
&Py_ImBuf_Type,
|
|
&py_imb,
|
|
PyC_ParseUnicodeAsBytesAndSize_OrNone,
|
|
&filepath_data))
|
|
{
|
|
return nullptr;
|
|
}
|
|
|
|
const char *filepath = filepath_data.value;
|
|
if (filepath == nullptr) {
|
|
/* Argument omitted, use images path. */
|
|
filepath = py_imb->ibuf->filepath;
|
|
}
|
|
PyObject *result = imbuf_write_impl(py_imb->ibuf, filepath);
|
|
Py_XDECREF(filepath_data.value_coerce);
|
|
return result;
|
|
}
|
|
|
|
/** \} */
|
|
|
|
/* -------------------------------------------------------------------- */
|
|
/** \name Module Definition (`imbuf`)
|
|
* \{ */
|
|
|
|
#if (defined(__GNUC__) && !defined(__clang__))
|
|
# pragma GCC diagnostic push
|
|
# pragma GCC diagnostic ignored "-Wcast-function-type"
|
|
#endif
|
|
|
|
static PyMethodDef IMB_methods[] = {
|
|
{"new", (PyCFunction)M_imbuf_new, METH_VARARGS | METH_KEYWORDS, M_imbuf_new_doc},
|
|
{"load", (PyCFunction)M_imbuf_load, METH_VARARGS | METH_KEYWORDS, M_imbuf_load_doc},
|
|
{"write", (PyCFunction)M_imbuf_write, METH_VARARGS | METH_KEYWORDS, M_imbuf_write_doc},
|
|
{nullptr, nullptr, 0, nullptr},
|
|
};
|
|
|
|
#if (defined(__GNUC__) && !defined(__clang__))
|
|
# pragma GCC diagnostic pop
|
|
#endif
|
|
|
|
PyDoc_STRVAR(IMB_doc,
|
|
"This module provides access to Blender's image manipulation API.\n"
|
|
"\n"
|
|
"It provides access to image buffers outside of Blender's\n"
|
|
":class:`bpy.types.Image` data-block context.\n");
|
|
static PyModuleDef IMB_module_def = {
|
|
/*m_base*/ PyModuleDef_HEAD_INIT,
|
|
/*m_name*/ "imbuf",
|
|
/*m_doc*/ IMB_doc,
|
|
/*m_size*/ 0,
|
|
/*m_methods*/ IMB_methods,
|
|
/*m_slots*/ nullptr,
|
|
/*m_traverse*/ nullptr,
|
|
/*m_clear*/ nullptr,
|
|
/*m_free*/ nullptr,
|
|
};
|
|
|
|
PyObject *BPyInit_imbuf()
|
|
{
|
|
PyObject *mod;
|
|
PyObject *submodule;
|
|
PyObject *sys_modules = PyImport_GetModuleDict();
|
|
|
|
mod = PyModule_Create(&IMB_module_def);
|
|
|
|
/* `imbuf.types` */
|
|
PyModule_AddObject(mod, "types", (submodule = BPyInit_imbuf_types()));
|
|
PyDict_SetItem(sys_modules, PyModule_GetNameObject(submodule), submodule);
|
|
|
|
return mod;
|
|
}
|
|
|
|
/** \} */
|
|
|
|
/* -------------------------------------------------------------------- */
|
|
/** \name Module Definition (`imbuf.types`)
|
|
*
|
|
* `imbuf.types` module, only include this to expose access to `imbuf.types.ImBuf`
|
|
* for docs and the ability to use with built-ins such as `isinstance`, `issubclass`.
|
|
* \{ */
|
|
|
|
PyDoc_STRVAR(IMB_types_doc,
|
|
"This module provides access to image buffer types.\n"
|
|
"\n"
|
|
".. note::\n"
|
|
"\n"
|
|
" Image buffer is also the structure used by :class:`bpy.types.Image`\n"
|
|
" ID type to store and manipulate image data at runtime.\n");
|
|
|
|
static PyModuleDef IMB_types_module_def = {
|
|
/*m_base*/ PyModuleDef_HEAD_INIT,
|
|
/*m_name*/ "imbuf.types",
|
|
/*m_doc*/ IMB_types_doc,
|
|
/*m_size*/ 0,
|
|
/*m_methods*/ nullptr,
|
|
/*m_slots*/ nullptr,
|
|
/*m_traverse*/ nullptr,
|
|
/*m_clear*/ nullptr,
|
|
/*m_free*/ nullptr,
|
|
};
|
|
|
|
PyObject *BPyInit_imbuf_types()
|
|
{
|
|
PyObject *submodule = PyModule_Create(&IMB_types_module_def);
|
|
|
|
if (PyType_Ready(&Py_ImBuf_Type) < 0) {
|
|
return nullptr;
|
|
}
|
|
|
|
PyModule_AddType(submodule, &Py_ImBuf_Type);
|
|
|
|
return submodule;
|
|
}
|
|
|
|
/** \} */
|