diff --git a/scripts/modules/bpy/utils/images.py b/scripts/modules/bpy/utils/images.py new file mode 100644 index 00000000000..b4bd02b395c --- /dev/null +++ b/scripts/modules/bpy/utils/images.py @@ -0,0 +1,49 @@ +# SPDX-FileCopyrightText: 2015-2023 Blender Authors +# +# SPDX-License-Identifier: GPL-2.0-or-later + +""" +This module contains utility functions to handle custom images. +""" + +__all__ = ( + "load", + "release" + "list", +) + +from _bpy import _utils_images + + +list = [] + + +def load(name, path): + r = _utils_images.load(name, path) + if r != None: + data = {'id' : r , 'name' : name, 'path' : path} + list.append(data) + return data; + else: + return None; + +load.__doc__ = _utils_images.load.__doc__; + +def release(image_id): + r = _utils_images.release(image_id) + if r == True: + for data in list: + if data.get('id') == image_id: + list.remove(data) + + return r; +release.__doc__ = _utils_images.release.__doc__ + +import atexit + +def exit_clear(): + while len(list): + release(list[0].get('id')) + +atexit.register(exit_clear) +del atexit, exit_clear diff --git a/source/blender/python/BPY_extern.h b/source/blender/python/BPY_extern.h index db70947b683..3a00f2767f2 100644 --- a/source/blender/python/BPY_extern.h +++ b/source/blender/python/BPY_extern.h @@ -133,6 +133,8 @@ bool BPY_string_is_keyword(const char *str); void BPY_callback_screen_free(struct ARegionType *art); void BPY_callback_wm_free(struct wmWindowManager *wm); +void* BPY_utils_images_get(int image_id); + /* I18n for addons */ #ifdef WITH_INTERNATIONAL const char *BPY_app_translations_py_pgettext(const char *msgctxt, const char *msgid); diff --git a/source/blender/python/intern/CMakeLists.txt b/source/blender/python/intern/CMakeLists.txt index 84b16de91a4..21368b0c77e 100644 --- a/source/blender/python/intern/CMakeLists.txt +++ b/source/blender/python/intern/CMakeLists.txt @@ -68,6 +68,7 @@ set(SRC bpy_rna_ui.cc bpy_traceback.cc bpy_utils_previews.cc + bpy_utils_images.cc bpy_utils_units.cc stubs.cc @@ -110,6 +111,7 @@ set(SRC bpy_rna_ui.h bpy_traceback.h bpy_utils_previews.h + bpy_utils_images.h bpy_utils_units.h ../BPY_extern.h ../BPY_extern_clog.h diff --git a/source/blender/python/intern/bpy.cc b/source/blender/python/intern/bpy.cc index 30568703cc3..9ba51867d28 100644 --- a/source/blender/python/intern/bpy.cc +++ b/source/blender/python/intern/bpy.cc @@ -46,6 +46,7 @@ #include "bpy_rna_id_collection.h" #include "bpy_rna_types_capi.h" #include "bpy_utils_previews.h" +#include "bpy_utils_images.h" #include "bpy_utils_units.h" #include "../generic/py_capi_utils.h" @@ -686,6 +687,7 @@ void BPy_init_modules(bContext *C) PyModule_AddObject(mod, "app", BPY_app_struct()); PyModule_AddObject(mod, "_utils_units", BPY_utils_units()); PyModule_AddObject(mod, "_utils_previews", BPY_utils_previews_module()); + PyModule_AddObject(mod, "_utils_images", BPY_utils_images_module()); PyModule_AddObject(mod, "msgbus", BPY_msgbus_module()); PointerRNA ctx_ptr = RNA_pointer_create(nullptr, &RNA_Context, C); diff --git a/source/blender/python/intern/bpy_utils_images.cc b/source/blender/python/intern/bpy_utils_images.cc new file mode 100644 index 00000000000..6d92bb4d132 --- /dev/null +++ b/source/blender/python/intern/bpy_utils_images.cc @@ -0,0 +1,173 @@ +/* SPDX-FileCopyrightText: 2023 Blender Authors + * + * SPDX-License-Identifier: GPL-2.0-or-later */ + +/** \file + * \ingroup pythonintern + * + * This file defines a singleton py object accessed via 'bpy.utils.images', + */ + +#include +#include + +#include + +#include "BLI_utildefines.h" +#include "BLI_listbase.h" +#include "BLI_string.h" + +#include "RNA_access.hh" +#include "RNA_prototypes.h" +#include "RNA_types.hh" + +#include "BPY_extern.h" +#include "bpy_rna.h" +#include "bpy_utils_images.h" + +#include "../generic/py_capi_utils.h" + +#include "MEM_guardedalloc.h" + +#include "IMB_imbuf.hh" + +#include "../generic/python_utildefines.h" + + +struct bpy_image_data{ + bpy_image_data *prev; + bpy_image_data *next; + + int id; + ImBuf *ibuf; + std::string name; + std::string path; +}; + +int bpy_images_last_id = 0; +ListBase bpy_images_list; + + +bpy_image_data* BPY_utils_images_get_data(int image_id) { + return (bpy_image_data *)BLI_listbase_bytes_find( + &bpy_images_list, &image_id, sizeof(int), sizeof(bpy_image_data *) * 2); +} + +void* BPY_utils_images_get(int image_id) +{ + bpy_image_data *el = BPY_utils_images_get_data(image_id); + return (el != nullptr) ? el->ibuf : nullptr; +} + +PyDoc_STRVAR(bpy_utils_images_load_doc, + ".. method:: load(name, filepath)\n" + "\n" + " Generate a new preview from given file path.\n" + "\n" + " :arg name: The name identifying the image.\n" + " :type name: string\n" + " :arg filepath: The file path to the image.\n" + " :type filepath: string or bytes\n" + " :return: image id.\n" + " :rtype: long`\n"); +static PyObject *bpy_utils_images_load(PyObject * /*self*/, PyObject *args) +{ + char *name = NULL; + PyC_UnicodeAsBytesAndSize_Data filepath_data = {nullptr}; + + if (!PyArg_ParseTuple(args, + "s" /* `name` */ + "O&" /* `filepath` */ + ":load", + &name, + PyC_ParseUnicodeAsBytesAndSize, + &filepath_data, + 0)) + { + return nullptr; + } + + if (!filepath_data.value || !name) { + Py_RETURN_NONE; + } + + ImBuf *ibuf = IMB_loadiffname(filepath_data.value, 0, nullptr); + + if (ibuf) { + bpy_image_data *data = MEM_new(__func__); + data->id = ++bpy_images_last_id; + data->ibuf = ibuf; + data->name = name; + data->path = filepath_data.value; + + BLI_addtail(&bpy_images_list, data); + + return PyLong_FromLong(data->id); + } + else { + Py_RETURN_NONE; + } +} + +PyDoc_STRVAR(bpy_utils_images_release_doc, + ".. method:: release(image_id)\n" + "\n" + " Release (free) a previously added image.\n" + "\n" + "\n" + " :arg image_id: The id identifying the image.\n" + " :type name: long\n" + " :return: true if release.\n" + " :rtype: bool`\n"); +static PyObject *bpy_utils_images_release(PyObject * /*self*/, PyObject *args) +{ + int image_id = -1; + + if (!PyArg_ParseTuple(args, "i:release", &image_id)) { + return nullptr; + } + + bpy_image_data *el = BPY_utils_images_get_data(image_id); + + if (el != nullptr) { + BLI_remlink(&bpy_images_list, el); + IMB_freeImBuf(el->ibuf); + MEM_freeN(el); + Py_RETURN_TRUE; + } + else { + Py_RETURN_FALSE; + } +} + +static PyMethodDef bpy_utils_images_methods[] = { + /* Can't use METH_KEYWORDS alone, see http://bugs.python.org/issue11587 */ + {"load", (PyCFunction)bpy_utils_images_load, METH_VARARGS, bpy_utils_images_load_doc}, + {"release",(PyCFunction)bpy_utils_images_release,METH_VARARGS, bpy_utils_images_release_doc}, + {nullptr, nullptr, 0, nullptr}, +}; + +PyDoc_STRVAR( + bpy_utils_images_doc, + "This object contains basic static methods to handle cached (non-ID) previews in Blender\n" + "(low-level API, not exposed to final users)."); +static PyModuleDef bpy_utils_images_module = { + /*m_base*/ PyModuleDef_HEAD_INIT, + /*m_name*/ "bpy._utils_images", + /*m_doc*/ bpy_utils_images_doc, + /*m_size*/ 0, + /*m_methods*/ bpy_utils_images_methods, + /*m_slots*/ nullptr, + /*m_traverse*/ nullptr, + /*m_clear*/ nullptr, + /*m_free*/ nullptr, +}; + +PyObject *BPY_utils_images_module() +{ + PyObject *submodule; + + submodule = PyModule_Create(&bpy_utils_images_module); + + return submodule; +} diff --git a/source/blender/python/intern/bpy_utils_images.h b/source/blender/python/intern/bpy_utils_images.h new file mode 100644 index 00000000000..6e27babe26a --- /dev/null +++ b/source/blender/python/intern/bpy_utils_images.h @@ -0,0 +1,19 @@ +/* SPDX-FileCopyrightText: 2023 Blender Authors + * + * SPDX-License-Identifier: GPL-2.0-or-later */ + +/** \file + * \ingroup pythonintern + */ + +#pragma once + +#ifdef __cplusplus +extern "C" { +#endif + +PyObject *BPY_utils_images_module(void); + +#ifdef __cplusplus +} +#endif diff --git a/source/blender/tornavis/patches/MB_0014.h b/source/blender/tornavis/patches/MB_0014.h new file mode 100644 index 00000000000..ddf2a41c228 --- /dev/null +++ b/source/blender/tornavis/patches/MB_0014.h @@ -0,0 +1 @@ +/* Empty File */