Expose PreviewImage & custom icons to py API.

This commit mainly:

* Exposes PreviewImage struct in RNA, including ways for user to set images data.
* Adds a new kind of PreviewImage, using a file path and IMB_thumb to get image.
* Adds a new kind of custom icon using PreviewImage, unrelated to ID previews system.
* Adds a python API (utils.previews) to allow python scripts to access those custom previews/icons.

Note that loading image from files' thumbnails is done when needed (deferred loading), not
when defining the custom preview/icon.

WARNING: for release addons who would want to use this, please keep it to a strict minimum, really needed level.
We do not want our UI to explode under hundreds of different flashy icons!

For more info, see also the release notes of Blender 2.75 (http://wiki.blender.org/index.php/Dev:Ref/Release_Notes/2.75/Addons)
and the example/templates featured with Blender.

Patch by Campbell (ideasman42), Inês (brita) and Bastien (mont29).

Differential Revision: https://developer.blender.org/D1255

source/blender/python/intern/CMakeLists.txt

@@ -31,6 +31,7 @@ set(INC
 	../../blenloader
 	../../editors/include
 	../../gpu
+	../../imbuf
 	../../makesdna
 	../../makesrna
 	../../windowmanager
@@ -69,6 +70,7 @@ set(SRC
 	bpy_rna_callback.c
 	bpy_traceback.c
 	bpy_util.c
+	bpy_utils_previews.c
 	bpy_utils_units.c
 	stubs.c
 
@@ -94,6 +96,7 @@ set(SRC
 	bpy_rna_callback.h
 	bpy_traceback.h
 	bpy_util.h
+	bpy_utils_previews.h
 	bpy_utils_units.h
 	../BPY_extern.h
 )

source/blender/python/intern/bpy.c

@@ -48,6 +48,7 @@
 #include "bpy_props.h"
 #include "bpy_library.h"
 #include "bpy_operator.h"
+#include "bpy_utils_previews.h"
 #include "bpy_utils_units.h"
 
 #include "../generic/py_capi_utils.h"
@@ -330,6 +331,7 @@ void BPy_init_modules(void)
 	PyModule_AddObject(mod, "ops", BPY_operator_module());
 	PyModule_AddObject(mod, "app", BPY_app_struct());
 	PyModule_AddObject(mod, "_utils_units", BPY_utils_units());
+	PyModule_AddObject(mod, "_utils_previews", BPY_utils_previews_module());
 
 	/* bpy context */
 	RNA_pointer_create(NULL, &RNA_Context, (void *)BPy_GetContext(), &ctx_ptr);

source/blender/python/intern/bpy_utils_previews.c

@@ -0,0 +1,188 @@
+/*
+ * ***** 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): Bastien Montagne
+ *
+ * ***** END GPL LICENSE BLOCK *****
+ */
+
+/** \file blender/python/intern/bpy_utils_previews.c
+ *  \ingroup pythonintern
+ *
+ * This file defines a singleton py object accessed via 'bpy.utils.previews',
+ * which exposes low-level API for custom previews/icons.
+ * It is replaced in final API by an higher-level python wrapper, that handles previews by addon,
+ * and automatically release them on deletion.
+ */
+
+#include <Python.h>
+#include <structmember.h>
+
+#include "BLI_utildefines.h"
+
+#include "RNA_types.h"
+#include "RNA_access.h"
+
+#include "BPY_extern.h"
+#include "bpy_utils_previews.h"
+#include "bpy_rna.h"
+
+#include "MEM_guardedalloc.h"
+
+#include "IMB_imbuf.h"
+#include "IMB_imbuf_types.h"
+#include "IMB_thumbs.h"
+
+#include "BKE_icons.h"
+
+#include "DNA_ID.h"
+
+#include "../generic/python_utildefines.h"
+
+#define STR_SOURCE_TYPES "'IMAGE', 'MOVIE', 'BLEND', 'FONT'"
+
+PyDoc_STRVAR(bpy_utils_previews_new_doc,
+".. method:: new(name)\n"
+"\n"
+"   Generate a new empty preview, or return existing one matching ``name``.\n"
+"\n"
+"   :arg name: The name (unique id) identifying the preview.\n"
+"   :type name: string\n"
+"   :return: The Preview matching given name, or a new empty one.\n"
+"   :rtype: :class:`bpy.types.ImagePreview`\n"
+);
+static PyObject *bpy_utils_previews_new(PyObject *UNUSED(self), PyObject *args)
+{
+	char *name;
+	PreviewImage *prv;
+	PointerRNA ptr;
+
+	if (!PyArg_ParseTuple(args, "s:new", &name)) {
+		return NULL;
+	}
+
+	prv = BKE_previewimg_cached_ensure(name);
+	RNA_pointer_create(NULL, &RNA_ImagePreview, prv, &ptr);
+
+	return pyrna_struct_CreatePyObject(&ptr);
+}
+
+PyDoc_STRVAR(bpy_utils_previews_load_doc,
+".. method:: load(name, path, path_type, force_reload)\n"
+"\n"
+"   Generate a new preview from given file path, or return existing one matching ``name``.\n"
+"\n"
+"   :arg name: The name (unique id) identifying the preview.\n"
+"   :type name: string\n"
+"   :arg path: The file path to generate the preview from.\n"
+"   :type path: string\n"
+"   :arg path_type: The type of file, needed to generate the preview in [" STR_SOURCE_TYPES "].\n"
+"   :type path_type: string\n"
+"   :arg force_reload: If True, force running thumbnail manager even if preview already exists in cache.\n"
+"   :type force_reload: bool\n"
+"   :return: The Preview matching given name, or a new empty one.\n"
+"   :rtype: :class:`bpy.types.ImagePreview`\n"
+);
+static PyObject *bpy_utils_previews_load(PyObject *UNUSED(self), PyObject *args)
+{
+	char *name, *path, *path_type_s;
+	int path_type, force_reload = false;
+
+	PreviewImage *prv;
+	PointerRNA ptr;
+
+	if (!PyArg_ParseTuple( args, "sss|p:load", &name, &path, &path_type_s, &force_reload)) {
+		return NULL;
+	}
+
+	if (STREQ(path_type_s, "IMAGE")) {
+		path_type = THB_SOURCE_IMAGE;
+	}
+	else if (STREQ(path_type_s, "MOVIE")) {
+		path_type = THB_SOURCE_MOVIE;
+	}
+	else if (STREQ(path_type_s, "BLEND")) {
+		path_type = THB_SOURCE_BLEND;
+	}
+	else if (STREQ(path_type_s, "FONT")) {
+		path_type = THB_SOURCE_FONT;
+	}
+	else {
+		PyErr_Format(PyExc_ValueError,
+		             "load: invalid '%' path type, only [" STR_SOURCE_TYPES "] "
+		             "are supported", path_type_s);
+		return NULL;
+	}
+
+	prv = BKE_previewimg_cached_thumbnail_read(name, path, path_type, force_reload);
+	RNA_pointer_create(NULL, &RNA_ImagePreview, prv, &ptr);
+
+	return pyrna_struct_CreatePyObject(&ptr);
+}
+
+PyDoc_STRVAR(bpy_utils_previews_release_doc,
+".. method:: release(name)\n"
+"\n"
+"   Release (free) a previously created preview.\n"
+"\n"
+"\n"
+"   :arg name: The name (unique id) identifying the preview.\n"
+"   :type name: string\n"
+);
+static PyObject *bpy_utils_previews_release(PyObject *UNUSED(self), PyObject *args)
+{
+	char *name;
+
+	if (!PyArg_ParseTuple(args, "s:release", &name)) {
+		return NULL;
+	}
+
+	BKE_previewimg_cached_release(name);
+
+	Py_RETURN_NONE;
+}
+
+static struct PyMethodDef bpy_utils_previews_methods[] = {
+	/* Can't use METH_KEYWORDS alone, see http://bugs.python.org/issue11587 */
+	{"new", (PyCFunction)bpy_utils_previews_new, METH_VARARGS, bpy_utils_previews_new_doc},
+	{"load", (PyCFunction)bpy_utils_previews_load, METH_VARARGS, bpy_utils_previews_load_doc},
+	{"release", (PyCFunction)bpy_utils_previews_release, METH_VARARGS, bpy_utils_previews_release_doc},
+	{NULL, NULL, 0, NULL}
+};
+
+PyDoc_STRVAR(bpy_utils_previews_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 struct PyModuleDef bpy_utils_previews_module = {
+	PyModuleDef_HEAD_INIT,
+	"bpy._utils_previews",
+	bpy_utils_previews_doc,
+	0,
+	bpy_utils_previews_methods,
+	NULL, NULL, NULL, NULL
+};
+
+
+PyObject *BPY_utils_previews_module(void)
+{
+	PyObject *submodule;
+
+	submodule = PyModule_Create(&bpy_utils_previews_module);
+
+	return submodule;
+}

source/blender/python/intern/bpy_utils_previews.h

@@ -0,0 +1,32 @@
+/*
+ * ***** 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): Bastien Montagne
+ *
+ * ***** END GPL LICENSE BLOCK *****
+ */
+
+/** \file blender/python/intern/bpy_utils_previews.h
+ *  \ingroup pythonintern
+ */
+
+#ifndef __BPY_UTILS_PREVIEWS_H__
+#define __BPY_UTILS_PREVIEWS_H__
+
+PyObject *BPY_utils_previews_module(void);
+
+#endif /* __BPY_UTILS_PREVIEWS_H__ */