Merge branch 'blender2.7'
[blender.git] / source / blender / python / gpu / gpu_py_vertex_buffer.c
1 /*
2  * This program is free software; you can redistribute it and/or
3  * modify it under the terms of the GNU General Public License
4  * as published by the Free Software Foundation; either version 2
5  * of the License, or (at your option) any later version.
6  *
7  * This program is distributed in the hope that it will be useful,
8  * but WITHOUT ANY WARRANTY; without even the implied warranty of
9  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
10  * GNU General Public License for more details.
11  *
12  * You should have received a copy of the GNU General Public License
13  * along with this program; if not, write to the Free Software Foundation,
14  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
15  */
16
17 /** \file
18  * \ingroup bpygpu
19  *
20  * - Use ``bpygpu_`` for local API.
21  * - Use ``BPyGPU`` for public API.
22  */
23
24 #include <Python.h>
25
26 #include "GPU_vertex_buffer.h"
27
28 #include "BLI_math.h"
29
30 #include "MEM_guardedalloc.h"
31
32 #include "../generic/py_capi_utils.h"
33 #include "../generic/python_utildefines.h"
34
35 #include "gpu_py_vertex_format.h"
36 #include "gpu_py_vertex_buffer.h" /* own include */
37
38 /* -------------------------------------------------------------------- */
39 /** \name Utility Functions
40  * \{ */
41
42 #define PY_AS_NATIVE_SWITCH(attr) \
43   switch (attr->comp_type) { \
44     case GPU_COMP_I8: { \
45       PY_AS_NATIVE(int8_t, PyC_Long_AsI8); \
46       break; \
47     } \
48     case GPU_COMP_U8: { \
49       PY_AS_NATIVE(uint8_t, PyC_Long_AsU8); \
50       break; \
51     } \
52     case GPU_COMP_I16: { \
53       PY_AS_NATIVE(int16_t, PyC_Long_AsI16); \
54       break; \
55     } \
56     case GPU_COMP_U16: { \
57       PY_AS_NATIVE(uint16_t, PyC_Long_AsU16); \
58       break; \
59     } \
60     case GPU_COMP_I32: { \
61       PY_AS_NATIVE(int32_t, PyC_Long_AsI32); \
62       break; \
63     } \
64     case GPU_COMP_U32: { \
65       PY_AS_NATIVE(uint32_t, PyC_Long_AsU32); \
66       break; \
67     } \
68     case GPU_COMP_F32: { \
69       PY_AS_NATIVE(float, PyFloat_AsDouble); \
70       break; \
71     } \
72     default: \
73       BLI_assert(0); \
74   } \
75   ((void)0)
76
77 /* No error checking, callers must run PyErr_Occurred */
78 static void fill_format_elem(void *data_dst_void, PyObject *py_src, const GPUVertAttr *attr)
79 {
80 #define PY_AS_NATIVE(ty_dst, py_as_native) \
81   { \
82     ty_dst *data_dst = data_dst_void; \
83     *data_dst = py_as_native(py_src); \
84   } \
85   ((void)0)
86
87   PY_AS_NATIVE_SWITCH(attr);
88
89 #undef PY_AS_NATIVE
90 }
91
92 /* No error checking, callers must run PyErr_Occurred */
93 static void fill_format_sequence(void *data_dst_void,
94                                  PyObject *py_seq_fast,
95                                  const GPUVertAttr *attr)
96 {
97   const uint len = attr->comp_len;
98   PyObject **value_fast_items = PySequence_Fast_ITEMS(py_seq_fast);
99
100 /**
101  * Args are constants, so range checks will be optimized out if they're nop's.
102  */
103 #define PY_AS_NATIVE(ty_dst, py_as_native) \
104   ty_dst *data_dst = data_dst_void; \
105   for (uint i = 0; i < len; i++) { \
106     data_dst[i] = py_as_native(value_fast_items[i]); \
107   } \
108   ((void)0)
109
110   PY_AS_NATIVE_SWITCH(attr);
111
112 #undef PY_AS_NATIVE
113 }
114
115 #undef PY_AS_NATIVE_SWITCH
116 #undef WARN_TYPE_LIMIT_PUSH
117 #undef WARN_TYPE_LIMIT_POP
118
119 static bool bpygpu_vertbuf_fill_impl(GPUVertBuf *vbo,
120                                      uint data_id,
121                                      PyObject *seq,
122                                      const char *error_prefix)
123 {
124   const char *exc_str_size_mismatch = "Expected a %s of size %d, got %u";
125
126   bool ok = true;
127   const GPUVertAttr *attr = &vbo->format.attrs[data_id];
128
129   if (PyObject_CheckBuffer(seq)) {
130     Py_buffer pybuffer;
131
132     if (PyObject_GetBuffer(seq, &pybuffer, PyBUF_STRIDES | PyBUF_ND) == -1) {
133       /* PyObject_GetBuffer raise a PyExc_BufferError */
134       return false;
135     }
136
137     uint comp_len = pybuffer.ndim == 1 ? 1 : (uint)pybuffer.shape[1];
138
139     if (pybuffer.shape[0] != vbo->vertex_len) {
140       PyErr_Format(
141           PyExc_ValueError, exc_str_size_mismatch, "sequence", vbo->vertex_len, pybuffer.shape[0]);
142       ok = false;
143     }
144     else if (comp_len != attr->comp_len) {
145       PyErr_Format(PyExc_ValueError, exc_str_size_mismatch, "component", attr->comp_len, comp_len);
146       ok = false;
147     }
148     else {
149       GPU_vertbuf_attr_fill_stride(vbo, data_id, pybuffer.strides[0], pybuffer.buf);
150     }
151
152     PyBuffer_Release(&pybuffer);
153   }
154   else {
155     GPUVertBufRaw data_step;
156     GPU_vertbuf_attr_get_raw_data(vbo, data_id, &data_step);
157
158     PyObject *seq_fast = PySequence_Fast(seq, "Vertex buffer fill");
159     if (seq_fast == NULL) {
160       return false;
161     }
162
163     const uint seq_len = PySequence_Fast_GET_SIZE(seq_fast);
164
165     if (seq_len != vbo->vertex_len) {
166       PyErr_Format(PyExc_ValueError, exc_str_size_mismatch, "sequence", vbo->vertex_len, seq_len);
167     }
168
169     PyObject **seq_items = PySequence_Fast_ITEMS(seq_fast);
170
171     if (attr->comp_len == 1) {
172       for (uint i = 0; i < seq_len; i++) {
173         uchar *data = (uchar *)GPU_vertbuf_raw_step(&data_step);
174         PyObject *item = seq_items[i];
175         fill_format_elem(data, item, attr);
176       }
177     }
178     else {
179       for (uint i = 0; i < seq_len; i++) {
180         uchar *data = (uchar *)GPU_vertbuf_raw_step(&data_step);
181         PyObject *seq_fast_item = PySequence_Fast(seq_items[i], error_prefix);
182
183         if (seq_fast_item == NULL) {
184           ok = false;
185           goto finally;
186         }
187         if (PySequence_Fast_GET_SIZE(seq_fast_item) != attr->comp_len) {
188           PyErr_Format(PyExc_ValueError,
189                        exc_str_size_mismatch,
190                        "sequence",
191                        attr->comp_len,
192                        PySequence_Fast_GET_SIZE(seq_fast_item));
193           ok = false;
194           Py_DECREF(seq_fast_item);
195           goto finally;
196         }
197
198         /* May trigger error, check below */
199         fill_format_sequence(data, seq_fast_item, attr);
200         Py_DECREF(seq_fast_item);
201       }
202     }
203
204     if (PyErr_Occurred()) {
205       ok = false;
206     }
207
208   finally:
209
210     Py_DECREF(seq_fast);
211   }
212   return ok;
213 }
214
215 static int bpygpu_attr_fill(GPUVertBuf *buf,
216                             int id,
217                             PyObject *py_seq_data,
218                             const char *error_prefix)
219 {
220   if (id < 0 || id >= buf->format.attr_len) {
221     PyErr_Format(PyExc_ValueError, "Format id %d out of range", id);
222     return 0;
223   }
224
225   if (buf->data == NULL) {
226     PyErr_SetString(PyExc_ValueError, "Can't fill, static buffer already in use");
227     return 0;
228   }
229
230   if (!bpygpu_vertbuf_fill_impl(buf, (uint)id, py_seq_data, error_prefix)) {
231     return 0;
232   }
233
234   return 1;
235 }
236
237 /** \} */
238
239 /* -------------------------------------------------------------------- */
240 /** \name VertBuf Type
241  * \{ */
242
243 static PyObject *bpygpu_VertBuf_new(PyTypeObject *UNUSED(type), PyObject *args, PyObject *kwds)
244 {
245   struct {
246     PyObject *py_fmt;
247     uint len;
248   } params;
249
250   static const char *_keywords[] = {"format", "len", NULL};
251   static _PyArg_Parser _parser = {"O!I:GPUVertBuf.__new__", _keywords, 0};
252   if (!_PyArg_ParseTupleAndKeywordsFast(
253           args, kwds, &_parser, &BPyGPUVertFormat_Type, &params.py_fmt, &params.len)) {
254     return NULL;
255   }
256
257   const GPUVertFormat *fmt = &((BPyGPUVertFormat *)params.py_fmt)->fmt;
258   GPUVertBuf *vbo = GPU_vertbuf_create_with_format(fmt);
259
260   GPU_vertbuf_data_alloc(vbo, params.len);
261
262   return BPyGPUVertBuf_CreatePyObject(vbo);
263 }
264
265 PyDoc_STRVAR(bpygpu_VertBuf_attr_fill_doc,
266              ".. method:: attr_fill(id, data)\n"
267              "\n"
268              "   Insert data into the buffer for a single attribute.\n"
269              "\n"
270              "   :param id: Either the name or the id of the attribute.\n"
271              "   :type id: int or str\n"
272              "   :param data: Sequence of data that should be stored in the buffer\n"
273              "   :type data: sequence of values or tuples\n");
274 static PyObject *bpygpu_VertBuf_attr_fill(BPyGPUVertBuf *self, PyObject *args, PyObject *kwds)
275 {
276   PyObject *data;
277   PyObject *identifier;
278
279   static const char *_keywords[] = {"id", "data", NULL};
280   static _PyArg_Parser _parser = {"OO:attr_fill", _keywords, 0};
281   if (!_PyArg_ParseTupleAndKeywordsFast(args, kwds, &_parser, &identifier, &data)) {
282     return NULL;
283   }
284
285   int id;
286
287   if (PyLong_Check(identifier)) {
288     id = PyLong_AsLong(identifier);
289   }
290   else if (PyUnicode_Check(identifier)) {
291     const char *name = PyUnicode_AsUTF8(identifier);
292     id = GPU_vertformat_attr_id_get(&self->buf->format, name);
293     if (id == -1) {
294       PyErr_SetString(PyExc_ValueError, "Unknown attribute name");
295       return NULL;
296     }
297   }
298   else {
299     PyErr_SetString(PyExc_TypeError, "expected int or str type as identifier");
300     return NULL;
301   }
302
303   if (!bpygpu_attr_fill(self->buf, id, data, "GPUVertBuf.attr_fill")) {
304     return NULL;
305   }
306
307   Py_RETURN_NONE;
308 }
309
310 static struct PyMethodDef bpygpu_VertBuf_methods[] = {
311     {"attr_fill",
312      (PyCFunction)bpygpu_VertBuf_attr_fill,
313      METH_VARARGS | METH_KEYWORDS,
314      bpygpu_VertBuf_attr_fill_doc},
315     {NULL, NULL, 0, NULL},
316 };
317
318 static void bpygpu_VertBuf_dealloc(BPyGPUVertBuf *self)
319 {
320   GPU_vertbuf_discard(self->buf);
321   Py_TYPE(self)->tp_free(self);
322 }
323
324 PyDoc_STRVAR(py_gpu_vertex_buffer_doc,
325              ".. class:: GPUVertBuf(len, format)\n"
326              "\n"
327              "   Contains a VBO.\n"
328              "\n"
329              "   :param len: Amount of vertices that will fit into this buffer.\n"
330              "   :type type: `int`\n"
331              "   :param format: Vertex format.\n"
332              "   :type buf: :class:`gpu.types.GPUVertFormat`\n");
333 PyTypeObject BPyGPUVertBuf_Type = {
334     PyVarObject_HEAD_INIT(NULL, 0).tp_name = "GPUVertBuf",
335     .tp_basicsize = sizeof(BPyGPUVertBuf),
336     .tp_dealloc = (destructor)bpygpu_VertBuf_dealloc,
337     .tp_flags = Py_TPFLAGS_DEFAULT,
338     .tp_doc = py_gpu_vertex_buffer_doc,
339     .tp_methods = bpygpu_VertBuf_methods,
340     .tp_new = bpygpu_VertBuf_new,
341 };
342
343 /** \} */
344
345 /* -------------------------------------------------------------------- */
346 /** \name Public API
347  * \{ */
348
349 PyObject *BPyGPUVertBuf_CreatePyObject(GPUVertBuf *buf)
350 {
351   BPyGPUVertBuf *self;
352
353   self = PyObject_New(BPyGPUVertBuf, &BPyGPUVertBuf_Type);
354   self->buf = buf;
355
356   return (PyObject *)self;
357 }
358
359 /** \} */