Merge branch 'blender-v2.82-release'
[blender.git] / source / blender / imbuf / IMB_thumbs.h
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) 2007 Blender Foundation
17  * All rights reserved.
18  */
19
20 /** \file
21  * \ingroup imbuf
22  */
23
24 #ifndef __IMB_THUMBS_H__
25 #define __IMB_THUMBS_H__
26
27 #ifdef __cplusplus
28 extern "C" {
29 #endif
30
31 struct ImBuf;
32
33 /**
34  * Thumbnail creation and retrieval according to the 'Thumbnail Management Standard'
35  * supported by Gimp, Gnome (Nautilus), KDE etc.
36  * Reference: http://jens.triq.net/thumbnail-spec/index.html
37  */
38
39 typedef enum ThumbSize {
40   THB_NORMAL,
41   THB_LARGE,
42   THB_FAIL,
43 } ThumbSize;
44
45 typedef enum ThumbSource {
46   THB_SOURCE_IMAGE,
47   THB_SOURCE_MOVIE,
48   THB_SOURCE_BLEND,
49   THB_SOURCE_FONT,
50 } ThumbSource;
51
52 /* don't generate thumbs for images bigger then this (100mb) */
53 #define THUMB_SIZE_MAX (100 * 1024 * 1024)
54
55 #define PREVIEW_RENDER_DEFAULT_HEIGHT 128
56
57 /* Note this can also be used as versioning system,
58  * to force refreshing all thumbnails if e.g. we change some thumb generating code or so.
59  * Only used by fonts so far. */
60 #define THUMB_DEFAULT_HASH "00000000000000000000000000000000"
61
62 /* create thumbnail for file and returns new imbuf for thumbnail */
63 struct ImBuf *IMB_thumb_create(const char *path,
64                                ThumbSize size,
65                                ThumbSource source,
66                                struct ImBuf *ibuf);
67
68 /* read thumbnail for file and returns new imbuf for thumbnail */
69 struct ImBuf *IMB_thumb_read(const char *path, ThumbSize size);
70
71 /* delete all thumbs for the file */
72 void IMB_thumb_delete(const char *path, ThumbSize size);
73
74 /* return the state of the thumb, needed to determine how to manage the thumb */
75 struct ImBuf *IMB_thumb_manage(const char *path, ThumbSize size, ThumbSource source);
76
77 /* create the necessary dirs to store the thumbnails */
78 void IMB_thumb_makedirs(void);
79
80 /* special function for loading a thumbnail embedded into a blend file */
81 struct ImBuf *IMB_thumb_load_blend(const char *blen_path,
82                                    const char *blen_group,
83                                    const char *blen_id);
84 void IMB_thumb_overlay_blend(unsigned int *thumb, int width, int height, float aspect);
85
86 /* special function for previewing fonts */
87 struct ImBuf *IMB_thumb_load_font(const char *filename, unsigned int x, unsigned int y);
88 bool IMB_thumb_load_font_get_hash(char *r_hash);
89 void IMB_thumb_clear_translations(void);
90 void IMB_thumb_ensure_translations(void);
91
92 /* Threading */
93 void IMB_thumb_locks_acquire(void);
94 void IMB_thumb_locks_release(void);
95 void IMB_thumb_path_lock(const char *path);
96 void IMB_thumb_path_unlock(const char *path);
97
98 #ifdef __cplusplus
99 }
100 #endif /* __cplusplus */
101
102 #endif /* __IMB_THUMBS_H__ */