[Bf-blender-cvs] [409cfba1a3c] master: Python API: Initial 'imbuf' API
Campbell Barton
noreply at git.blender.org
Thu Jun 7 08:00:44 CEST 2018
Commit: 409cfba1a3cdec228c7f93aa8c1fbc912a6d6525
Author: Campbell Barton
Date: Thu Jun 7 07:41:49 2018 +0200
Branches: master
https://developer.blender.org/rB409cfba1a3cdec228c7f93aa8c1fbc912a6d6525
Python API: Initial 'imbuf' API
Support only basic operations new/load/write & resize.
Add now so we can extend as needed & more easily accept patches.
===================================================================
M source/blender/python/generic/CMakeLists.txt
A source/blender/python/generic/imbuf_py_api.c
A source/blender/python/generic/imbuf_py_api.h
M source/blender/python/intern/bpy_interface.c
===================================================================
diff --git a/source/blender/python/generic/CMakeLists.txt b/source/blender/python/generic/CMakeLists.txt
index 77214322b88..9a5a3fddff0 100644
--- a/source/blender/python/generic/CMakeLists.txt
+++ b/source/blender/python/generic/CMakeLists.txt
@@ -39,12 +39,14 @@ set(SRC
bpy_internal_import.c
bpy_threads.c
idprop_py_api.c
+ imbuf_py_api.c
py_capi_utils.c
bgl.h
blf_py_api.h
bpy_internal_import.h
idprop_py_api.h
+ imbuf_py_api.h
py_capi_utils.h
# header-only
diff --git a/source/blender/python/generic/imbuf_py_api.c b/source/blender/python/generic/imbuf_py_api.c
new file mode 100644
index 00000000000..2e32829bf6c
--- /dev/null
+++ b/source/blender/python/generic/imbuf_py_api.c
@@ -0,0 +1,447 @@
+/*
+ * ***** BEGIN GPL LICENSE BLOCK *****
+ *
+ * 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(s): Campbell Barton
+ *
+ * ***** END GPL LICENSE BLOCK *****
+ */
+
+/** \file blender/python/generic/imbuf_py_api.c
+ * \ingroup pygen
+ *
+ * This file defines the 'imbuf' image manipulation module.
+ */
+
+#include <Python.h>
+
+#include "BLI_utildefines.h"
+#include "BLI_string.h"
+
+#include "py_capi_utils.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 <fcntl.h>
+#include <errno.h>
+#include "BLI_fileops.h"
+
+/* -------------------------------------------------------------------- */
+/** \name Type & Utilities
+ * \{ */
+
+typedef struct Py_ImBuf {
+ PyObject_VAR_HEAD
+ /* can be NULL */
+ ImBuf *ibuf;
+} Py_ImBuf;
+
+static int py_imbuf_valid_check(Py_ImBuf *self)
+{
+ if (LIKELY(self->ibuf)) {
+ return 0;
+ }
+ else {
+ 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 NULL; } ((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 (TODO)\n"
+" :type method: str\n"
+);
+static PyObject *py_imbuf_resize(Py_ImBuf *self, PyObject *args, PyObject *kw)
+{
+ PY_IMBUF_CHECK_OBJ(self);
+
+ uint size[2];
+ char *method = NULL;
+
+ static const char *_keywords[] = {"size", "method", NULL};
+ static _PyArg_Parser _parser = {"(II)|s:resize", _keywords, 0};
+ if (!_PyArg_ParseTupleAndKeywordsFast(
+ args, kw, &_parser,
+ &size[0], &size[1],
+ &method))
+ {
+ return NULL;
+ }
+ IMB_scaleImBuf(self->ibuf, UNPACK2(size));
+ Py_RETURN_NONE;
+}
+
+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 = NULL;
+ }
+ Py_RETURN_NONE;
+}
+
+static struct PyMethodDef Py_ImBuf_methods[] = {
+ {"resize", (PyCFunction)py_imbuf_resize, METH_VARARGS | METH_KEYWORDS, (char *)py_imbuf_resize_doc},
+ {"free", (PyCFunction)py_imbuf_free, METH_NOARGS, (char *)py_imbuf_free_doc},
+ {NULL, NULL, 0, NULL}
+};
+
+/** \} */
+
+/* -------------------------------------------------------------------- */
+/** \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 *UNUSED(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 *UNUSED(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 *UNUSED(closure))
+{
+ PY_IMBUF_CHECK_INT(self);
+ double ppm[2];
+
+ if (PyC_AsArray(ppm, value, 2, &PyFloat_Type, true, "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;
+}
+
+static PyGetSetDef Py_ImBuf_getseters[] = {
+ {(char *)"size", (getter)py_imbuf_size_get, (setter)NULL, (char *)py_imbuf_size_doc, NULL},
+ {(char *)"ppm", (getter)py_imbuf_ppm_get, (setter)py_imbuf_ppm_set, (char *)py_imbuf_ppm_doc, NULL},
+ {NULL, NULL, NULL, NULL, NULL} /* Sentinel */
+};
+
+/** \} */
+
+/* -------------------------------------------------------------------- */
+/** \name Type & Implementation
+ * \{ */
+
+static void py_imbuf_dealloc(Py_ImBuf *self)
+{
+ ImBuf *ibuf = self->ibuf;
+ if (ibuf != NULL) {
+ IMB_freeImBuf(self->ibuf);
+ self->ibuf = NULL;
+ }
+ PyObject_DEL(self);
+}
+
+static PyObject *py_imbuf_repr(Py_ImBuf *self)
+{
+ const ImBuf *ibuf = self->ibuf;
+ if (ibuf != NULL) {
+ return PyUnicode_FromFormat(
+ "<imbuf: address=%p, filename='%s', size=(%d, %d)>",
+ ibuf, ibuf->name, ibuf->x, ibuf->y);
+ }
+ else {
+ 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 = {
+ PyVarObject_HEAD_INIT(NULL, 0)
+ /* For printing, in format "<module>.<name>" */
+ "ImBuf", /* tp_name */
+ sizeof(Py_ImBuf), /* int tp_basicsize; */
+ 0, /* tp_itemsize; For allocation */
+
+ /* Methods to implement standard operations */
+
+ (destructor)py_imbuf_dealloc, /* destructor tp_dealloc; */
+ NULL, /* printfunc tp_print; */
+ NULL, /* getattrfunc tp_getattr; */
+ NULL, /* setattrfunc tp_setattr; */
+ NULL, /* cmpfunc tp_compare; */
+ (reprfunc)py_imbuf_repr, /* reprfunc tp_repr; */
+
+ /* Method suites for standard classes */
+
+ NULL, /* PyNumberMethods *tp_as_number; */
+ NULL, /* PySequenceMethods *tp_as_sequence; */
+ NULL, /* PyMappingMethods *tp_as_mapping; */
+
+ /* More standard operations (here for binary compatibility) */
+
+ (hashfunc)py_imbuf_hash, /* hashfunc tp_hash; */
+ NULL, /* ternaryfunc tp_call; */
+ NULL, /* reprfunc tp_str; */
+ NULL, /* getattrofunc tp_getattro; */
+ NULL, /* setattrofunc tp_setattro; */
+
+ /* Functions to access object as input/output buffer */
+ NULL, /* PyBufferProcs *tp_as_buffer; */
+
+ /*** Flags to define presence of optional/expanded features ***/
+ Py_TPFLAGS_DEFAULT, /* long tp_flags; */
+
+ NULL, /* char *tp_doc; Documentation string */
+ /*** Assigned meaning in release 2.0 ***/
+ /* call function for all accessible objects */
+ NULL, /* traverseproc tp_traverse; */
+
+ /* delete references to contained objects */
+ NULL, /* inquiry tp_clear; */
+
+ /*** Assigned meaning in release 2.1 ***/
+ /*** rich comparisons ***/
+ NULL, /* richcmpfunc tp_richcompare; */
+
+ /*** weak reference enabler ***/
+ 0, /* long tp_weaklistoffset; */
+
+ /*** Added in release 2.2 ***/
+ /* Iterators */
+ NULL, /* getiterfunc tp_iter; */
+ NULL, /* iternextfunc tp_iternext; */
+ /*** Attribute descriptor and subclassing stuff ***/
+ Py_ImBuf_methods, /* struct PyMethodDef *tp_methods; */
+ NULL, /* struct PyMemberDef *tp_members; */
+ Py_ImBuf_getseters, /* struct PyGetSetDef *tp_getset; */
+};
+
+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 *UNUSED(self), PyObject *args, PyObject *kw)
+{
+ int size[2];
+ static const char *_keywords[] = {"size", NULL};
+ static _PyArg_Parser _parser = {"(ii)|i:new", _keywords, 0};
+ if (!_PyArg_ParseTupleAndKeywordsFast(
+ args, kw, &_parser,
+ &size[0], &size[1]))
+ {
+ return NULL;
+ }
+
+ /* TODO, make options */
+ uchar planes = 4;
+ uint flags = IB_rect;
+
+ ImBuf *ibuf = IMB_allocImBuf(UNPACK2(size), planes, flags);
+ if (ibuf == NULL) {
+ PyErr_Format(PyExc_ValueError, "new: Unable to create image (%d, %d)", UNPACK2(size));
+ return NULL;
+ }
+ return Py_ImBuf_CreatePyObject(ibuf);
+}
+
+PyDoc_STRVAR(M_imbuf_load_doc,
+".. function:: load(filename)\n"
+"\n"
+" Load an image from a file.\n"
+"\n"
+" :arg file
@@ Diff output truncated at 10240 characters. @@
More information about the Bf-blender-cvs
mailing list