Cleanup: style, use braces for blenkernel
[blender.git] / source / blender / blenkernel / intern / icons.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  * The Original Code is Copyright (C) 2006-2007 Blender Foundation.
17  * All rights reserved.
18  */
19
20 /** \file
21  * \ingroup bke
22  */
23
24 #include <math.h>
25 #include <stdlib.h>
26 #include <string.h>
27
28 #include "CLG_log.h"
29
30 #include "MEM_guardedalloc.h"
31
32 #include "DNA_brush_types.h"
33 #include "DNA_collection_types.h"
34 #include "DNA_gpencil_types.h"
35 #include "DNA_light_types.h"
36 #include "DNA_material_types.h"
37 #include "DNA_object_types.h"
38 #include "DNA_scene_types.h"
39 #include "DNA_screen_types.h"
40 #include "DNA_texture_types.h"
41 #include "DNA_world_types.h"
42
43 #include "BLI_utildefines.h"
44 #include "BLI_ghash.h"
45 #include "BLI_linklist_lockfree.h"
46 #include "BLI_string.h"
47 #include "BLI_fileops.h"
48 #include "BLI_threads.h"
49
50 #include "BKE_icons.h"
51 #include "BKE_global.h" /* only for G.background test */
52 #include "BKE_studiolight.h"
53
54 #include "BLI_sys_types.h"  // for intptr_t support
55
56 #include "GPU_texture.h"
57
58 #include "IMB_imbuf.h"
59 #include "IMB_imbuf_types.h"
60 #include "IMB_thumbs.h"
61
62 /**
63  * Only allow non-managed icons to be removed (by Python for eg).
64  * Previews & ID's have their own functions to remove icons.
65  */
66 enum {
67   ICON_FLAG_MANAGED = (1 << 0),
68 };
69
70 /* GLOBALS */
71
72 static CLG_LogRef LOG = {"bke.icons"};
73
74 static GHash *gIcons = NULL;
75
76 static int gNextIconId = 1;
77
78 static int gFirstIconId = 1;
79
80 static GHash *gCachedPreviews = NULL;
81
82 /* Queue of icons for deferred deletion. */
83 typedef struct DeferredIconDeleteNode {
84   struct DeferredIconDeleteNode *next;
85   int icon_id;
86 } DeferredIconDeleteNode;
87 static LockfreeLinkList g_icon_delete_queue;
88
89 static void icon_free(void *val)
90 {
91   Icon *icon = val;
92
93   if (icon) {
94     if (icon->obj_type == ICON_DATA_GEOM) {
95       struct Icon_Geom *obj = icon->obj;
96       if (obj->mem) {
97         /* coords & colors are part of this memory. */
98         MEM_freeN((void *)obj->mem);
99       }
100       else {
101         MEM_freeN((void *)obj->coords);
102         MEM_freeN((void *)obj->colors);
103       }
104       MEM_freeN(icon->obj);
105     }
106
107     if (icon->drawinfo_free) {
108       icon->drawinfo_free(icon->drawinfo);
109     }
110     else if (icon->drawinfo) {
111       MEM_freeN(icon->drawinfo);
112     }
113     MEM_freeN(icon);
114   }
115 }
116
117 static void icon_free_data(int icon_id, Icon *icon)
118 {
119   if (icon->obj_type == ICON_DATA_ID) {
120     ((ID *)(icon->obj))->icon_id = 0;
121   }
122   else if (icon->obj_type == ICON_DATA_PREVIEW) {
123     ((PreviewImage *)(icon->obj))->icon_id = 0;
124   }
125   else if (icon->obj_type == ICON_DATA_GPLAYER) {
126     ((bGPDlayer *)(icon->obj))->runtime.icon_id = 0;
127   }
128   else if (icon->obj_type == ICON_DATA_GEOM) {
129     ((struct Icon_Geom *)(icon->obj))->icon_id = 0;
130   }
131   else if (icon->obj_type == ICON_DATA_STUDIOLIGHT) {
132     StudioLight *sl = icon->obj;
133     if (sl != NULL) {
134       BKE_studiolight_unset_icon_id(sl, icon_id);
135     }
136   }
137   else {
138     BLI_assert(0);
139   }
140 }
141
142 /* create an id for a new icon and make sure that ids from deleted icons get reused
143  * after the integer number range is used up */
144 static int get_next_free_id(void)
145 {
146   BLI_assert(BLI_thread_is_main());
147   int startId = gFirstIconId;
148
149   /* if we haven't used up the int number range, we just return the next int */
150   if (gNextIconId >= gFirstIconId) {
151     return gNextIconId++;
152   }
153
154   /* now we try to find the smallest icon id not stored in the gIcons hash */
155   while (BLI_ghash_lookup(gIcons, POINTER_FROM_INT(startId)) && startId >= gFirstIconId) {
156     startId++;
157   }
158
159   /* if we found a suitable one that isn't used yet, return it */
160   if (startId >= gFirstIconId) {
161     return startId;
162   }
163
164   /* fail */
165   return 0;
166 }
167
168 void BKE_icons_init(int first_dyn_id)
169 {
170   BLI_assert(BLI_thread_is_main());
171
172   gNextIconId = first_dyn_id;
173   gFirstIconId = first_dyn_id;
174
175   if (!gIcons) {
176     gIcons = BLI_ghash_int_new(__func__);
177     BLI_linklist_lockfree_init(&g_icon_delete_queue);
178   }
179
180   if (!gCachedPreviews) {
181     gCachedPreviews = BLI_ghash_str_new(__func__);
182   }
183 }
184
185 void BKE_icons_free(void)
186 {
187   BLI_assert(BLI_thread_is_main());
188
189   if (gIcons) {
190     BLI_ghash_free(gIcons, NULL, icon_free);
191     gIcons = NULL;
192   }
193
194   if (gCachedPreviews) {
195     BLI_ghash_free(gCachedPreviews, MEM_freeN, BKE_previewimg_freefunc);
196     gCachedPreviews = NULL;
197   }
198
199   BLI_linklist_lockfree_free(&g_icon_delete_queue, MEM_freeN);
200 }
201
202 void BKE_icons_deferred_free(void)
203 {
204   BLI_assert(BLI_thread_is_main());
205
206   for (DeferredIconDeleteNode *node =
207            (DeferredIconDeleteNode *)BLI_linklist_lockfree_begin(&g_icon_delete_queue);
208        node != NULL;
209        node = node->next) {
210     BLI_ghash_remove(gIcons, POINTER_FROM_INT(node->icon_id), NULL, icon_free);
211   }
212   BLI_linklist_lockfree_clear(&g_icon_delete_queue, MEM_freeN);
213 }
214
215 static PreviewImage *previewimg_create_ex(size_t deferred_data_size)
216 {
217   PreviewImage *prv_img = NULL;
218   int i;
219
220   prv_img = MEM_mallocN(sizeof(PreviewImage) + deferred_data_size, "img_prv");
221   memset(prv_img, 0, sizeof(*prv_img)); /* leave deferred data dirty */
222
223   if (deferred_data_size) {
224     prv_img->tag |= PRV_TAG_DEFFERED;
225   }
226
227   for (i = 0; i < NUM_ICON_SIZES; ++i) {
228     prv_img->flag[i] |= PRV_CHANGED;
229     prv_img->changed_timestamp[i] = 0;
230   }
231   return prv_img;
232 }
233
234 PreviewImage *BKE_previewimg_create(void)
235 {
236   return previewimg_create_ex(0);
237 }
238
239 void BKE_previewimg_freefunc(void *link)
240 {
241   PreviewImage *prv = (PreviewImage *)link;
242   if (prv) {
243     int i;
244
245     for (i = 0; i < NUM_ICON_SIZES; ++i) {
246       if (prv->rect[i]) {
247         MEM_freeN(prv->rect[i]);
248       }
249       if (prv->gputexture[i]) {
250         GPU_texture_free(prv->gputexture[i]);
251       }
252     }
253
254     MEM_freeN(prv);
255   }
256 }
257
258 void BKE_previewimg_free(PreviewImage **prv)
259 {
260   if (prv && (*prv)) {
261     BKE_previewimg_freefunc(*prv);
262     *prv = NULL;
263   }
264 }
265
266 void BKE_previewimg_clear_single(struct PreviewImage *prv, enum eIconSizes size)
267 {
268   MEM_SAFE_FREE(prv->rect[size]);
269   if (prv->gputexture[size]) {
270     GPU_texture_free(prv->gputexture[size]);
271   }
272   prv->h[size] = prv->w[size] = 0;
273   prv->flag[size] |= PRV_CHANGED;
274   prv->flag[size] &= ~PRV_USER_EDITED;
275   prv->changed_timestamp[size] = 0;
276 }
277
278 void BKE_previewimg_clear(struct PreviewImage *prv)
279 {
280   int i;
281   for (i = 0; i < NUM_ICON_SIZES; ++i) {
282     BKE_previewimg_clear_single(prv, i);
283   }
284 }
285
286 PreviewImage *BKE_previewimg_copy(const PreviewImage *prv)
287 {
288   PreviewImage *prv_img = NULL;
289   int i;
290
291   if (prv) {
292     prv_img = MEM_dupallocN(prv);
293     for (i = 0; i < NUM_ICON_SIZES; ++i) {
294       if (prv->rect[i]) {
295         prv_img->rect[i] = MEM_dupallocN(prv->rect[i]);
296       }
297       prv_img->gputexture[i] = NULL;
298     }
299   }
300   return prv_img;
301 }
302
303 /** Duplicate preview image from \a id and clear icon_id, to be used by datablock copy functions. */
304 void BKE_previewimg_id_copy(ID *new_id, const ID *old_id)
305 {
306   PreviewImage **old_prv_p = BKE_previewimg_id_get_p(old_id);
307   PreviewImage **new_prv_p = BKE_previewimg_id_get_p(new_id);
308
309   if (old_prv_p && *old_prv_p) {
310     BLI_assert(new_prv_p != NULL && ELEM(*new_prv_p, NULL, *old_prv_p));
311     //      const int new_icon_id = get_next_free_id();
312
313     //      if (new_icon_id == 0) {
314     //          return;  /* Failure. */
315     //      }
316     *new_prv_p = BKE_previewimg_copy(*old_prv_p);
317     new_id->icon_id = (*new_prv_p)->icon_id = 0;
318   }
319 }
320
321 PreviewImage **BKE_previewimg_id_get_p(const ID *id)
322 {
323   switch (GS(id->name)) {
324 #define ID_PRV_CASE(id_code, id_struct) \
325   case id_code: { \
326     return &((id_struct *)id)->preview; \
327   } \
328     ((void)0)
329     ID_PRV_CASE(ID_MA, Material);
330     ID_PRV_CASE(ID_TE, Tex);
331     ID_PRV_CASE(ID_WO, World);
332     ID_PRV_CASE(ID_LA, Light);
333     ID_PRV_CASE(ID_IM, Image);
334     ID_PRV_CASE(ID_BR, Brush);
335     ID_PRV_CASE(ID_OB, Object);
336     ID_PRV_CASE(ID_GR, Collection);
337     ID_PRV_CASE(ID_SCE, Scene);
338     ID_PRV_CASE(ID_SCR, bScreen);
339 #undef ID_PRV_CASE
340     default:
341       break;
342   }
343
344   return NULL;
345 }
346
347 void BKE_previewimg_id_free(ID *id)
348 {
349   PreviewImage **prv_p = BKE_previewimg_id_get_p(id);
350   if (prv_p) {
351     BKE_previewimg_free(prv_p);
352   }
353 }
354
355 PreviewImage *BKE_previewimg_id_ensure(ID *id)
356 {
357   PreviewImage **prv_p = BKE_previewimg_id_get_p(id);
358
359   if (prv_p) {
360     if (*prv_p == NULL) {
361       *prv_p = BKE_previewimg_create();
362     }
363     return *prv_p;
364   }
365
366   return NULL;
367 }
368
369 PreviewImage *BKE_previewimg_cached_get(const char *name)
370 {
371   return BLI_ghash_lookup(gCachedPreviews, name);
372 }
373
374 /**
375  * Generate an empty PreviewImage, if not yet existing.
376  */
377 PreviewImage *BKE_previewimg_cached_ensure(const char *name)
378 {
379   PreviewImage *prv = NULL;
380   void **key_p, **prv_p;
381
382   if (!BLI_ghash_ensure_p_ex(gCachedPreviews, name, &key_p, &prv_p)) {
383     *key_p = BLI_strdup(name);
384     *prv_p = BKE_previewimg_create();
385   }
386   prv = *prv_p;
387   BLI_assert(prv);
388
389   return prv;
390 }
391
392 /**
393  * Generate a PreviewImage from given file path, using thumbnails management, if not yet existing.
394  */
395 PreviewImage *BKE_previewimg_cached_thumbnail_read(const char *name,
396                                                    const char *path,
397                                                    const int source,
398                                                    bool force_update)
399 {
400   PreviewImage *prv = NULL;
401   void **prv_p;
402
403   prv_p = BLI_ghash_lookup_p(gCachedPreviews, name);
404
405   if (prv_p) {
406     prv = *prv_p;
407     BLI_assert(prv);
408   }
409
410   if (prv && force_update) {
411     const char *prv_deferred_data = PRV_DEFERRED_DATA(prv);
412     if (((int)prv_deferred_data[0] == source) && STREQ(&prv_deferred_data[1], path)) {
413       /* If same path, no need to re-allocate preview, just clear it up. */
414       BKE_previewimg_clear(prv);
415     }
416     else {
417       BKE_previewimg_free(&prv);
418     }
419   }
420
421   if (!prv) {
422     /* We pack needed data for lazy loading (source type, in a single char, and path). */
423     const size_t deferred_data_size = strlen(path) + 2;
424     char *deferred_data;
425
426     prv = previewimg_create_ex(deferred_data_size);
427     deferred_data = PRV_DEFERRED_DATA(prv);
428     deferred_data[0] = source;
429     memcpy(&deferred_data[1], path, deferred_data_size - 1);
430
431     force_update = true;
432   }
433
434   if (force_update) {
435     if (prv_p) {
436       *prv_p = prv;
437     }
438     else {
439       BLI_ghash_insert(gCachedPreviews, BLI_strdup(name), prv);
440     }
441   }
442
443   return prv;
444 }
445
446 void BKE_previewimg_cached_release_pointer(PreviewImage *prv)
447 {
448   if (prv) {
449     if (prv->tag & PRV_TAG_DEFFERED_RENDERING) {
450       /* We cannot delete the preview while it is being loaded in another thread... */
451       prv->tag |= PRV_TAG_DEFFERED_DELETE;
452       return;
453     }
454     if (prv->icon_id) {
455       BKE_icon_delete(prv->icon_id);
456     }
457     BKE_previewimg_freefunc(prv);
458   }
459 }
460
461 void BKE_previewimg_cached_release(const char *name)
462 {
463   PreviewImage *prv = BLI_ghash_popkey(gCachedPreviews, name, MEM_freeN);
464
465   BKE_previewimg_cached_release_pointer(prv);
466 }
467
468 /** Handle deferred (lazy) loading/generation of preview image, if needed.
469  * For now, only used with file thumbnails. */
470 void BKE_previewimg_ensure(PreviewImage *prv, const int size)
471 {
472   if ((prv->tag & PRV_TAG_DEFFERED) != 0) {
473     const bool do_icon = ((size == ICON_SIZE_ICON) && !prv->rect[ICON_SIZE_ICON]);
474     const bool do_preview = ((size == ICON_SIZE_PREVIEW) && !prv->rect[ICON_SIZE_PREVIEW]);
475
476     if (do_icon || do_preview) {
477       ImBuf *thumb;
478       char *prv_deferred_data = PRV_DEFERRED_DATA(prv);
479       int source = prv_deferred_data[0];
480       char *path = &prv_deferred_data[1];
481       int icon_w, icon_h;
482
483       thumb = IMB_thumb_manage(path, THB_LARGE, source);
484
485       if (thumb) {
486         /* PreviewImage assumes premultiplied alhpa... */
487         IMB_premultiply_alpha(thumb);
488
489         if (do_preview) {
490           prv->w[ICON_SIZE_PREVIEW] = thumb->x;
491           prv->h[ICON_SIZE_PREVIEW] = thumb->y;
492           prv->rect[ICON_SIZE_PREVIEW] = MEM_dupallocN(thumb->rect);
493           prv->flag[ICON_SIZE_PREVIEW] &= ~(PRV_CHANGED | PRV_USER_EDITED);
494         }
495         if (do_icon) {
496           if (thumb->x > thumb->y) {
497             icon_w = ICON_RENDER_DEFAULT_HEIGHT;
498             icon_h = (thumb->y * icon_w) / thumb->x + 1;
499           }
500           else if (thumb->x < thumb->y) {
501             icon_h = ICON_RENDER_DEFAULT_HEIGHT;
502             icon_w = (thumb->x * icon_h) / thumb->y + 1;
503           }
504           else {
505             icon_w = icon_h = ICON_RENDER_DEFAULT_HEIGHT;
506           }
507
508           IMB_scaleImBuf(thumb, icon_w, icon_h);
509           prv->w[ICON_SIZE_ICON] = icon_w;
510           prv->h[ICON_SIZE_ICON] = icon_h;
511           prv->rect[ICON_SIZE_ICON] = MEM_dupallocN(thumb->rect);
512           prv->flag[ICON_SIZE_ICON] &= ~(PRV_CHANGED | PRV_USER_EDITED);
513         }
514         IMB_freeImBuf(thumb);
515       }
516     }
517   }
518 }
519
520 void BKE_icon_changed(const int icon_id)
521 {
522   BLI_assert(BLI_thread_is_main());
523
524   Icon *icon = NULL;
525
526   if (!icon_id || G.background) {
527     return;
528   }
529
530   icon = BLI_ghash_lookup(gIcons, POINTER_FROM_INT(icon_id));
531
532   if (icon) {
533     /* We *only* expect ID-tied icons here, not non-ID icon/preview! */
534     BLI_assert(icon->id_type != 0);
535     BLI_assert(icon->obj_type == ICON_DATA_ID);
536
537     /* Do not enforce creation of previews for valid ID types using BKE_previewimg_id_ensure() here ,
538      * we only want to ensure *existing* preview images are properly tagged as changed/invalid, that's all. */
539     PreviewImage **p_prv = BKE_previewimg_id_get_p((ID *)icon->obj);
540
541     /* If we have previews, they all are now invalid changed. */
542     if (p_prv && *p_prv) {
543       int i;
544       for (i = 0; i < NUM_ICON_SIZES; ++i) {
545         (*p_prv)->flag[i] |= PRV_CHANGED;
546         (*p_prv)->changed_timestamp[i]++;
547       }
548     }
549   }
550 }
551
552 static Icon *icon_create(int icon_id, int obj_type, void *obj)
553 {
554   Icon *new_icon = MEM_mallocN(sizeof(Icon), __func__);
555
556   new_icon->obj_type = obj_type;
557   new_icon->obj = obj;
558   new_icon->id_type = 0;
559   new_icon->flag = 0;
560
561   /* next two lines make sure image gets created */
562   new_icon->drawinfo = NULL;
563   new_icon->drawinfo_free = NULL;
564
565   BLI_ghash_insert(gIcons, POINTER_FROM_INT(icon_id), new_icon);
566
567   return new_icon;
568 }
569
570 static int icon_id_ensure_create_icon(struct ID *id)
571 {
572   BLI_assert(BLI_thread_is_main());
573
574   Icon *icon = icon_create(id->icon_id, ICON_DATA_ID, id);
575   icon->id_type = GS(id->name);
576   icon->flag = ICON_FLAG_MANAGED;
577
578   return id->icon_id;
579 }
580
581 int BKE_icon_id_ensure(struct ID *id)
582 {
583   /* Never handle icons in non-main thread! */
584   BLI_assert(BLI_thread_is_main());
585
586   if (!id || G.background) {
587     return 0;
588   }
589
590   if (id->icon_id) {
591     return id->icon_id;
592   }
593
594   id->icon_id = get_next_free_id();
595
596   if (!id->icon_id) {
597     CLOG_ERROR(&LOG, "not enough IDs");
598     return 0;
599   }
600
601   /* Ensure we synchronize ID icon_id with its previewimage if it has one. */
602   PreviewImage **p_prv = BKE_previewimg_id_get_p(id);
603   if (p_prv && *p_prv) {
604     BLI_assert(ELEM((*p_prv)->icon_id, 0, id->icon_id));
605     (*p_prv)->icon_id = id->icon_id;
606   }
607
608   return icon_id_ensure_create_icon(id);
609 }
610
611 static int icon_gplayer_color_ensure_create_icon(bGPDlayer *gpl)
612 {
613   BLI_assert(BLI_thread_is_main());
614
615   /* NOTE: The color previews for GP Layers don't really need
616    * to be "rendered" to image per se (as it will just be a plain
617    * colored rectangle), we need to define icon data here so that
618    * we can store a pointer to the layer data in icon->obj.
619    */
620   Icon *icon = icon_create(gpl->runtime.icon_id, ICON_DATA_GPLAYER, gpl);
621   icon->flag = ICON_FLAG_MANAGED;
622
623   return gpl->runtime.icon_id;
624 }
625
626 int BKE_icon_gplayer_color_ensure(bGPDlayer *gpl)
627 {
628   /* Never handle icons in non-main thread! */
629   BLI_assert(BLI_thread_is_main());
630
631   if (!gpl || G.background) {
632     return 0;
633   }
634
635   if (gpl->runtime.icon_id) {
636     return gpl->runtime.icon_id;
637   }
638
639   gpl->runtime.icon_id = get_next_free_id();
640
641   if (!gpl->runtime.icon_id) {
642     CLOG_ERROR(&LOG, "not enough IDs");
643     return 0;
644   }
645
646   return icon_gplayer_color_ensure_create_icon(gpl);
647 }
648
649 /**
650  * Return icon id of given preview, or create new icon if not found.
651  */
652 int BKE_icon_preview_ensure(ID *id, PreviewImage *preview)
653 {
654   if (!preview || G.background) {
655     return 0;
656   }
657
658   if (id) {
659     BLI_assert(BKE_previewimg_id_ensure(id) == preview);
660   }
661
662   if (preview->icon_id) {
663     BLI_assert(!id || !id->icon_id || id->icon_id == preview->icon_id);
664     return preview->icon_id;
665   }
666
667   if (id && id->icon_id) {
668     preview->icon_id = id->icon_id;
669     return preview->icon_id;
670   }
671
672   preview->icon_id = get_next_free_id();
673
674   if (!preview->icon_id) {
675     CLOG_ERROR(&LOG, "not enough IDs");
676     return 0;
677   }
678
679   /* Ensure we synchronize ID icon_id with its previewimage if available, and generate suitable 'ID' icon. */
680   if (id) {
681     id->icon_id = preview->icon_id;
682     return icon_id_ensure_create_icon(id);
683   }
684
685   Icon *icon = icon_create(preview->icon_id, ICON_DATA_PREVIEW, preview);
686   icon->flag = ICON_FLAG_MANAGED;
687
688   return preview->icon_id;
689 }
690
691 Icon *BKE_icon_get(const int icon_id)
692 {
693   BLI_assert(BLI_thread_is_main());
694
695   Icon *icon = NULL;
696
697   icon = BLI_ghash_lookup(gIcons, POINTER_FROM_INT(icon_id));
698
699   if (!icon) {
700     CLOG_ERROR(&LOG, "no icon for icon ID: %d", icon_id);
701     return NULL;
702   }
703
704   return icon;
705 }
706
707 void BKE_icon_set(const int icon_id, struct Icon *icon)
708 {
709   BLI_assert(BLI_thread_is_main());
710
711   void **val_p;
712
713   if (BLI_ghash_ensure_p(gIcons, POINTER_FROM_INT(icon_id), &val_p)) {
714     CLOG_ERROR(&LOG, "icon already set: %d", icon_id);
715     return;
716   }
717
718   *val_p = icon;
719 }
720
721 static void icon_add_to_deferred_delete_queue(int icon_id)
722 {
723   DeferredIconDeleteNode *node = MEM_mallocN(sizeof(DeferredIconDeleteNode), __func__);
724   node->icon_id = icon_id;
725   BLI_linklist_lockfree_insert(&g_icon_delete_queue, (LockfreeLinkNode *)node);
726 }
727
728 void BKE_icon_id_delete(struct ID *id)
729 {
730   const int icon_id = id->icon_id;
731   if (!icon_id) {
732     return; /* no icon defined for library object */
733   }
734   id->icon_id = 0;
735
736   if (!BLI_thread_is_main()) {
737     icon_add_to_deferred_delete_queue(icon_id);
738     return;
739   }
740
741   BKE_icons_deferred_free();
742   BLI_ghash_remove(gIcons, POINTER_FROM_INT(icon_id), NULL, icon_free);
743 }
744
745 /**
746  * Remove icon and free data.
747  */
748 bool BKE_icon_delete(const int icon_id)
749 {
750   if (icon_id == 0) {
751     /* no icon defined for library object */
752     return false;
753   }
754
755   Icon *icon = BLI_ghash_popkey(gIcons, POINTER_FROM_INT(icon_id), NULL);
756   if (icon) {
757     icon_free_data(icon_id, icon);
758     icon_free(icon);
759     return true;
760   }
761   else {
762     return false;
763   }
764 }
765
766 bool BKE_icon_delete_unmanaged(const int icon_id)
767 {
768   if (icon_id == 0) {
769     /* no icon defined for library object */
770     return false;
771   }
772
773   Icon *icon = BLI_ghash_popkey(gIcons, POINTER_FROM_INT(icon_id), NULL);
774   if (icon) {
775     if (UNLIKELY(icon->flag & ICON_FLAG_MANAGED)) {
776       BLI_ghash_insert(gIcons, POINTER_FROM_INT(icon_id), icon);
777       return false;
778     }
779     else {
780       icon_free_data(icon_id, icon);
781       icon_free(icon);
782       return true;
783     }
784   }
785   else {
786     return false;
787   }
788 }
789
790 /* -------------------------------------------------------------------- */
791 /** \name Geometry Icon
792  * \{ */
793
794 int BKE_icon_geom_ensure(struct Icon_Geom *geom)
795 {
796   BLI_assert(BLI_thread_is_main());
797
798   if (geom->icon_id) {
799     return geom->icon_id;
800   }
801
802   geom->icon_id = get_next_free_id();
803
804   icon_create(geom->icon_id, ICON_DATA_GEOM, geom);
805   /* Not managed for now, we may want this to be configurable per icon). */
806
807   return geom->icon_id;
808 }
809
810 struct Icon_Geom *BKE_icon_geom_from_memory(const uchar *data, size_t data_len)
811 {
812   BLI_assert(BLI_thread_is_main());
813   if (data_len <= 8) {
814     goto fail;
815   }
816   /* Skip the header. */
817   data_len -= 8;
818   const int div = 3 * 2 * 3;
819   const int coords_len = data_len / div;
820   if (coords_len * div != data_len) {
821     goto fail;
822   }
823
824   const uchar header[4] = {'V', 'C', 'O', 0};
825   const uchar *p = data;
826   if (memcmp(p, header, ARRAY_SIZE(header)) != 0) {
827     goto fail;
828   }
829   p += 4;
830
831   struct Icon_Geom *geom = MEM_mallocN(sizeof(*geom), __func__);
832   geom->coords_range[0] = (int)*p++;
833   geom->coords_range[1] = (int)*p++;
834   /* x, y ignored for now */
835   p += 2;
836
837   geom->coords_len = coords_len;
838   geom->coords = (const void *)p;
839   geom->colors = (const void *)(p + (data_len / 3));
840   geom->icon_id = 0;
841   geom->mem = data;
842   return geom;
843
844 fail:
845   MEM_freeN((void *)data);
846   return NULL;
847 }
848
849 struct Icon_Geom *BKE_icon_geom_from_file(const char *filename)
850 {
851   BLI_assert(BLI_thread_is_main());
852   size_t data_len;
853   uchar *data = BLI_file_read_binary_as_mem(filename, 0, &data_len);
854   if (data == NULL) {
855     return NULL;
856   }
857   return BKE_icon_geom_from_memory(data, data_len);
858 }
859
860 /** \} */
861
862 /** \name Studio Light Icon
863  * \{ */
864 int BKE_icon_ensure_studio_light(struct StudioLight *sl, int id_type)
865 {
866   int icon_id = get_next_free_id();
867   Icon *icon = icon_create(icon_id, ICON_DATA_STUDIOLIGHT, sl);
868   icon->id_type = id_type;
869   return icon_id;
870 }
871 /** \} */