Blender V5.3
filetype.cc
Go to the documentation of this file.
1/* SPDX-FileCopyrightText: 2023 Blender Authors
2 *
3 * SPDX-License-Identifier: GPL-2.0-or-later */
4
8
9#include <cstddef>
10
11#include "BLI_utildefines.hh"
12
14#include "IMB_filetype.hh"
15#include "IMB_imbuf.hh"
16#include "IMB_imbuf_types.hh"
17
19
20#include "openexr/openexr_api.h"
21
22namespace blender {
23
25 {
26 /*init*/ nullptr,
27 /*exit*/ nullptr,
28 /*is_a*/ imb_is_a_jpeg,
29 /*load*/ imb_load_jpeg,
30 /*load_filepath*/ nullptr,
31 /*load_filepath_thumbnail*/ imb_thumbnail_jpeg,
32 /*save*/ imb_savejpeg,
33 /*save_buffer*/ nullptr,
34 /*flag*/ 0,
36 /*capability_write*/ eImFileTypeCapability::File,
37 /*filetype*/ IMB_FTYPE_JPG,
38 /*filetype_id*/ "JPEG",
39 /*file_extensions*/ imb_file_extensions_jpeg,
40 /*default_save_role*/ COLOR_ROLE_DEFAULT_BYTE,
41 },
42 {
43 /*init*/ nullptr,
44 /*exit*/ nullptr,
45 /*is_a*/ imb_is_a_png,
46 /*load*/ imb_load_png,
47 /*load_filepath*/ nullptr,
48 /*load_filepath_thumbnail*/ nullptr,
49 /*save*/ imb_save_png,
50 /*save_buffer*/ imb_save_buffer_png,
51 /*flag*/ 0,
54 /*filetype*/ IMB_FTYPE_PNG,
55 /*filetype_id*/ "PNG",
56 /*file_extensions*/ imb_file_extensions_png,
57 /*default_save_role*/ COLOR_ROLE_DEFAULT_BYTE,
58 },
59 {
60 /*init*/ nullptr,
61 /*exit*/ nullptr,
62 /*is_a*/ imb_is_a_bmp,
63 /*load*/ imb_load_bmp,
64 /*load_filepath*/ nullptr,
65 /*load_filepath_thumbnail*/ nullptr,
66 /*save*/ imb_save_bmp,
67 /*save_buffer*/ imb_save_buffer_bmp,
68 /*flag*/ 0,
71 /*filetype*/ IMB_FTYPE_BMP,
72 /*filetype_id*/ "BMP",
73 /*file_extensions*/ imb_file_extensions_bmp,
74 /*default_save_role*/ COLOR_ROLE_DEFAULT_BYTE,
75 },
76 {
77 /*init*/ nullptr,
78 /*exit*/ nullptr,
79 /*is_a*/ imb_is_a_tga,
80 /*load*/ imb_load_tga,
81 /*load_filepath*/ nullptr,
82 /*load_filepath_thumbnail*/ nullptr,
83 /*save*/ imb_save_tga,
84 /*save_buffer*/ imb_save_buffer_tga,
85 /*flag*/ 0,
88 /*filetype*/ IMB_FTYPE_TGA,
89 /*filetype_id*/ "TGA",
90 /*file_extensions*/ imb_file_extensions_tga,
91 /*default_save_role*/ COLOR_ROLE_DEFAULT_BYTE,
92 },
93 {
94 /*init*/ nullptr,
95 /*exit*/ nullptr,
96 /*is_a*/ imb_is_a_iris,
97 /*load*/ imb_loadiris,
98 /*load_filepath*/ nullptr,
99 /*load_filepath_thumbnail*/ nullptr,
100 /*save*/ imb_saveiris,
101 /*save_buffer*/ imb_save_buffer_iris,
102 /*flag*/ 0,
105 /*filetype*/ IMB_FTYPE_IRIS,
106 /*filetype_id*/ "IRIS",
107 /*file_extensions*/ imb_file_extensions_iris,
108 /*default_save_role*/ COLOR_ROLE_DEFAULT_BYTE,
109 },
110#ifdef WITH_IMAGE_CINEON
111 {
112 /*init*/ nullptr,
113 /*exit*/ nullptr,
114 /*is_a*/ imb_is_a_dpx,
115 /*load*/ imb_load_dpx,
116 /*load_filepath*/ nullptr,
117 /*load_filepath_thumbnail*/ nullptr,
118 /*save*/ imb_save_dpx,
119 /*save_buffer*/ imb_save_buffer_dpx,
120 /*flag*/ IM_FTYPE_FLOAT,
123 /*filetype*/ IMB_FTYPE_DPX,
124 /*filetype_id*/ "DPX",
125 /*file_extensions*/ imb_file_extensions_dpx,
126 /*default_save_role*/ COLOR_ROLE_DEFAULT_FLOAT,
127 },
128 {
129 /*init*/ nullptr,
130 /*exit*/ nullptr,
131 /*is_a*/ imb_is_a_cineon,
132 /*load*/ imb_load_cineon,
133 /*load_filepath*/ nullptr,
134 /*load_filepath_thumbnail*/ nullptr,
135 /*save*/ imb_save_cineon,
136 /*save_buffer*/ nullptr,
137 /*flag*/ IM_FTYPE_FLOAT,
139 /*capability_write*/ eImFileTypeCapability::File,
140 /*filetype*/ IMB_FTYPE_CINEON,
141 /*filetype_id*/ "CINEON",
142 /*file_extensions*/ imb_file_extensions_cineon,
143 /*default_save_role*/ COLOR_ROLE_DEFAULT_FLOAT,
144 },
145#endif
146 {
147 /*init*/ nullptr,
148 /*exit*/ nullptr,
149 /*is_a*/ imb_is_a_tiff,
150 /*load*/ imb_load_tiff,
151 /*load_filepath*/ nullptr,
152 /*load_filepath_thumbnail*/ nullptr,
153 /*save*/ imb_save_tiff,
154 /*save_buffer*/ imb_save_buffer_tiff,
155 /*flag*/ 0,
158 /*filetype*/ IMB_FTYPE_TIF,
159 /*filetype_id*/ "TIFF",
160 /*file_extensions*/ imb_file_extensions_tiff,
161 /*default_save_role*/ COLOR_ROLE_DEFAULT_BYTE,
162 },
163 {
164 /*init*/ nullptr,
165 /*exit*/ nullptr,
166 /*is_a*/ imb_is_a_hdr,
167 /*load*/ imb_load_hdr,
168 /*load_filepath*/ nullptr,
169 /*load_filepath_thumbnail*/ nullptr,
170 /*save*/ imb_save_hdr,
171 /*save_buffer*/ imb_save_buffer_hdr,
172 /*flag*/ IM_FTYPE_FLOAT,
175 /*filetype*/ IMB_FTYPE_RADHDR,
176 /*filetype_id*/ "HDR",
177 /*file_extensions*/ imb_file_extensions_hdr,
178 /*default_save_role*/ COLOR_ROLE_DEFAULT_FLOAT,
179 },
180 {
181 /*init*/ imb_initopenexr,
182 /*exit*/ imb_exitopenexr,
183 /*is_a*/ imb_is_a_openexr,
184 /*load*/ imb_load_openexr,
185 /*load_filepath*/ nullptr,
186 /*load_filepath_thumbnail*/ imb_load_filepath_thumbnail_openexr,
187 /*save*/ imb_save_openexr,
188 /*save_buffer*/ imb_save_buffer_openexr,
189 /*flag*/ IM_FTYPE_FLOAT,
192 /*filetype*/ IMB_FTYPE_OPENEXR,
193 /*filetype_id*/ "OPEN_EXR",
194 /*file_extensions*/ imb_file_extensions_openexr,
195 /*default_save_role*/ COLOR_ROLE_DEFAULT_FLOAT,
196 },
197#ifdef WITH_IMAGE_OPENJPEG
198 {
199 /*init*/ nullptr,
200 /*exit*/ nullptr,
201 /*is_a*/ imb_is_a_jp2,
202 /*load*/ imb_load_jp2,
203 /*load_filepath*/ nullptr,
204 /*load_filepath_thumbnail*/ nullptr,
205 /*save*/ imb_save_jp2,
206 /*save_buffer*/ nullptr,
207 /*flag*/ IM_FTYPE_FLOAT,
209 /*capability_write*/ eImFileTypeCapability::File,
210 /*filetype*/ IMB_FTYPE_JP2,
211 /*filetype_id*/ "JPEG2000",
212 /*file_extensions*/ imb_file_extensions_jp2,
213 /*default_save_role*/ COLOR_ROLE_DEFAULT_BYTE,
214 },
215#endif
216 {
217 /*init*/ imb_init_dds,
218 /*exit*/ nullptr,
219 /*is_a*/ imb_is_a_dds,
220 /*load*/ imb_load_dds,
221 /*load_filepath*/ nullptr,
222 /*load_filepath_thumbnail*/ nullptr,
223 /*save*/ nullptr,
224 /*save_buffer*/ nullptr,
225 /*flag*/ 0,
227 /*capability_write*/ eImFileTypeCapability::Zero,
228 /*filetype*/ IMB_FTYPE_DDS,
229 /*filetype_id*/ "DDS",
230 /*file_extensions*/ imb_file_extensions_dds,
231 /*default_save_role*/ COLOR_ROLE_DEFAULT_BYTE,
232 },
233 {
234 /*init*/ nullptr,
235 /*exit*/ nullptr,
236 /*is_a*/ imb_is_a_psd,
237 /*load*/ imb_load_psd,
238 /*load_filepath*/ nullptr,
239 /*load_filepath_thumbnail*/ nullptr,
240 /*save*/ nullptr,
241 /*save_buffer*/ nullptr,
242 /*flag*/ IM_FTYPE_FLOAT,
244 /*capability_write*/ eImFileTypeCapability::Zero,
245 /*filetype*/ IMB_FTYPE_PSD,
246 /*filetype_id*/ "PSD",
247 /*file_extensions*/ imb_file_extensions_psd,
248 /*default_save_role*/ COLOR_ROLE_DEFAULT_FLOAT,
249 },
250#ifdef WITH_IMAGE_WEBP
251 {
252 /*init*/ nullptr,
253 /*exit*/ nullptr,
254 /*is_a*/ imb_is_a_webp,
255 /*load*/ imb_loadwebp,
256 /*load_filepath*/ nullptr,
257 /*load_filepath_thumbnail*/ imb_load_filepath_thumbnail_webp,
258 /*save*/ imb_savewebp,
259 /*save_buffer*/ imb_save_buffer_webp,
260 /*flag*/ 0,
263 /*filetype*/ IMB_FTYPE_WEBP,
264 /*filetype_id*/ "WEBP",
265 /*file_extensions*/ imb_file_extensions_webp,
266 /*default_save_role*/ COLOR_ROLE_DEFAULT_BYTE,
267 },
268#endif
269 {
270 /*init*/ nullptr,
271 /*exit*/ nullptr,
272 /*is_a*/ imb_is_a_avif,
273 /*load*/ imb_load_avif,
274 /*load_filepath*/ nullptr,
275 /*load_filepath_thumbnail*/ nullptr,
276 /*save*/ imb_save_avif,
277 /*save_buffer*/ imb_save_buffer_avif,
278 /*flag*/ IM_FTYPE_FLOAT,
281 /*filetype*/ IMB_FTYPE_AVIF,
282 /*filetype_id*/ "AVIF",
283 /*file_extensions*/ imb_file_extensions_avif,
284 /*default_save_role*/ COLOR_ROLE_DEFAULT_BYTE,
285 },
286 {
287 /* Only implementing thumbnailing for SVG file type to support specialized importers.
288 * General file loading, if wanted, would require a better library and would have to
289 * support features like user-specified resolution. */
290
291 /*init*/ nullptr,
292 /*exit*/ nullptr,
293 /*is_a*/ nullptr,
294 /*load*/ nullptr,
295 /*load_filepath*/ nullptr,
296 /*load_filepath_thumbnail*/ imb_load_filepath_thumbnail_svg,
297 /*save*/ nullptr,
298 /*save_buffer*/ nullptr,
299 /*flag*/ 0,
300 /*capability_read*/ eImFileTypeCapability::Zero,
301 /*capability_write*/ eImFileTypeCapability::Zero,
302 /*filetype*/ IMB_FTYPE_NONE,
303 /*filetype_id*/ nullptr,
304 /*file_extensions*/ nullptr,
305 /*default_save_role*/ COLOR_ROLE_DEFAULT_BYTE,
306 },
307 {
308 nullptr,
309 nullptr,
310 nullptr,
311 nullptr,
312 nullptr,
313 nullptr,
314 nullptr,
315 /*save_buffer*/ nullptr,
316 0,
320 nullptr,
321 nullptr,
322 0,
323 },
324};
325
327
329{
330 for (const ImFileType *type = IMB_FILE_TYPES; type < IMB_FILE_TYPES_LAST; type++) {
331 if (ftype == type->filetype) {
332 return type;
333 }
334 }
335 return nullptr;
336}
337
339{
340 return IMB_file_type_from_ftype(ibuf->ftype);
341}
342
344{
345 return IMB_file_type_from_ftype(ftype) != nullptr;
346}
347
349{
350 const ImFileType *type = IMB_file_type_from_ftype(ftype);
351 return type ? type->filetype_id : nullptr;
352}
353
355{
356 for (const ImFileType *type = IMB_FILE_TYPES; type < IMB_FILE_TYPES_LAST; type++) {
357 if (type->filetype_id && STREQ(id, type->filetype_id)) {
358 return type->filetype;
359 }
360 }
361 return IMB_FTYPE_NONE;
362}
363
365{
366 const ImFileType *type = IMB_file_type_from_ftype(ftype);
367 return type ? type->file_extensions : nullptr;
368}
369
375
381
383{
384 const ImFileType *type;
385
386 OIIO_init();
387
388 for (type = IMB_FILE_TYPES; type < IMB_FILE_TYPES_LAST; type++) {
389 if (type->init) {
390 type->init();
391 }
392 }
393}
394
396{
397 const ImFileType *type;
398
399 for (type = IMB_FILE_TYPES; type < IMB_FILE_TYPES_LAST; type++) {
400 if (type->exit) {
401 type->exit();
402 }
403 }
404}
405
406} // namespace blender
#define IM_FTYPE_FLOAT
#define STREQ(a, b)
BMesh Iterators.
const char * imb_file_extensions_jp2[]
Definition format_jp2.cc:29
const char * imb_file_extensions_webp[]
bool imb_is_a_psd(const uchar *mem, size_t size)
Definition format_psd.cc:22
ImBuf * imb_load_jp2(const uchar *mem, size_t size, ImBufFlags flags, ImFileColorSpace &r_colorspace)
ImBuf * imb_load_psd(const uchar *mem, size_t size, ImBufFlags flags, ImFileColorSpace &r_colorspace)
Definition format_psd.cc:27
eImbFileType IMB_ftype_from_id(const char *id)
Definition filetype.cc:354
Vector< uint8_t > imb_save_buffer_openexr(ImBuf *ibuf, ImBufFlags)
const char ** IMB_ftype_file_extensions(eImbFileType ftype)
Definition filetype.cc:364
const char * imb_file_extensions_hdr[]
Definition format_hdr.cc:16
bool imb_save_jp2(ImBuf *ibuf, const char *filepath, ImBufFlags flags)
const char * imb_file_extensions_tga[]
const char * imb_file_extensions_tiff[]
const ImFileType * IMB_file_type_from_ibuf(const ImBuf *ibuf)
Definition filetype.cc:338
Vector< uint8_t > imb_save_buffer_tga(ImBuf *ibuf, ImBufFlags flags)
bool imb_is_a_iris(const uchar *mem, size_t size)
const char * IMB_ftype_to_id(eImbFileType ftype)
Definition filetype.cc:348
bool imb_save_tga(ImBuf *ibuf, const char *filepath, ImBufFlags flags)
const ImFileType * IMB_file_type_from_ftype(eImbFileType ftype)
Definition filetype.cc:328
const char * imb_file_extensions_iris[]
ImBuf * imb_load_avif(const uchar *mem, size_t size, ImBufFlags flags, ImFileColorSpace &r_colorspace)
bool imb_is_a_png(const uchar *mem, size_t size)
Definition format_png.cc:22
bool imb_save_tiff(ImBuf *ibuf, const char *filepath, ImBufFlags flags)
bool imb_save_openexr(ImBuf *ibuf, const char *filepath, ImBufFlags)
bool imb_is_a_avif(const uchar *mem, size_t size)
void imb_filetypes_exit()
Definition filetype.cc:395
bool imb_is_a_jpeg(const uchar *mem, const size_t size)
bool imb_is_a_tga(const uchar *mem, size_t size)
ImBuf * imb_load_jpeg(const uchar *buffer, size_t size, ImBufFlags flags, ImFileColorSpace &)
ImBuf * imb_load_openexr(const uchar *mem, size_t size, ImBufFlags flags, ImFileColorSpace &r_colorspace)
void imb_init_dds()
Definition format_dds.cc:40
bool imb_is_a_dpx(const uchar *mem, size_t size)
Definition format_dpx.cc:23
ImBuf * imb_load_dds(const uchar *mem, size_t size, ImBufFlags flags, ImFileColorSpace &r_colorspace)
Definition format_dds.cc:58
const char * imb_file_extensions_avif[]
void imb_filetypes_init()
Definition filetype.cc:382
Vector< uint8_t > imb_save_buffer_hdr(ImBuf *ibuf, ImBufFlags flags)
Definition format_hdr.cc:66
const char * imb_file_extensions_dpx[]
Definition format_dpx.cc:17
ImBuf * imb_load_cineon(const uchar *mem, size_t size, ImBufFlags flags, ImFileColorSpace &r_colorspace)
ImBuf * imb_loadwebp(const uchar *mem, size_t size, ImBufFlags flags, ImFileColorSpace &r_colorspace)
bool imb_saveiris(ImBuf *ibuf, const char *filepath, ImBufFlags flags)
void imb_initopenexr()
const char * imb_file_extensions_openexr[]
Vector< uint8_t > imb_save_buffer_webp(ImBuf *ibuf, ImBufFlags flags)
OIIO_NAMESPACE_USING void OIIO_init()
bool imb_save_avif(ImBuf *ibuf, const char *filepath, ImBufFlags flags)
Vector< uint8_t > imb_save_buffer_dpx(ImBuf *ibuf, ImBufFlags flags)
bool imb_is_a_bmp(const uchar *mem, size_t size)
Definition format_bmp.cc:21
const char * imb_file_extensions_jpeg[]
const ImFileType IMB_FILE_TYPES[]
Definition filetype.cc:24
ImBuf * imb_load_filepath_thumbnail_webp(const char *filepath, const ImBufFlags, const size_t max_thumb_size, ImFileColorSpace &, size_t *r_width, size_t *r_height)
bool imb_savewebp(ImBuf *ibuf, const char *filepath, ImBufFlags flags)
bool imb_is_a_hdr(const uchar *mem, size_t size)
Definition format_hdr.cc:21
eImFileTypeCapability IMB_ftype_capability_read(eImbFileType ftype)
Definition filetype.cc:370
constexpr size_t ARRAY_SIZE(const T(&arg)[N]) noexcept
ImBuf * imb_load_tiff(const uchar *mem, size_t size, ImBufFlags flags, ImFileColorSpace &r_colorspace)
ImBuf * imb_load_hdr(const uchar *mem, size_t size, ImBufFlags flags, ImFileColorSpace &r_colorspace)
Definition format_hdr.cc:26
bool imb_savejpeg(ImBuf *ibuf, const char *filepath, ImBufFlags flags)
const char * imb_file_extensions_dds[]
Definition format_dds.cc:35
eImFileTypeCapability IMB_ftype_capability_write(eImbFileType ftype)
Definition filetype.cc:376
bool IMB_ftype_is_supported(eImbFileType ftype)
Definition filetype.cc:343
Vector< uint8_t > imb_save_buffer_tiff(ImBuf *ibuf, ImBufFlags flags)
ImBuf * imb_load_dpx(const uchar *mem, size_t size, ImBufFlags flags, ImFileColorSpace &r_colorspace)
Definition format_dpx.cc:28
bool imb_save_dpx(ImBuf *ibuf, const char *filepath, ImBufFlags flags)
Definition format_dpx.cc:95
Vector< uint8_t > imb_save_buffer_avif(ImBuf *ibuf, ImBufFlags flags)
const char * imb_file_extensions_cineon[]
Definition format_dpx.cc:18
ImBuf * imb_loadiris(const uchar *mem, size_t size, ImBufFlags flags, ImFileColorSpace &r_colorspace)
bool imb_is_a_jp2(const uchar *buf, size_t size)
Definition format_jp2.cc:82
bool imb_is_a_cineon(const uchar *mem, size_t size)
bool imb_is_a_dds(const uchar *mem, size_t size)
Definition format_dds.cc:53
const char * imb_file_extensions_png[]
Definition format_png.cc:17
Vector< uint8_t > imb_save_buffer_bmp(ImBuf *ibuf, ImBufFlags flags)
Definition format_bmp.cc:59
bool imb_is_a_openexr(const uchar *mem, const size_t size)
ImBuf * imb_load_filepath_thumbnail_openexr(const char *filepath, const ImBufFlags, const size_t max_thumb_size, ImFileColorSpace &r_colorspace, size_t *r_width, size_t *r_height)
Vector< uint8_t > imb_save_buffer_png(ImBuf *ibuf, ImBufFlags flags)
Definition format_png.cc:79
bool imb_is_a_tiff(const uchar *mem, size_t size)
const char * imb_file_extensions_psd[]
Definition format_psd.cc:17
void imb_exitopenexr()
bool imb_save_cineon(ImBuf *buf, const char *filepath, ImBufFlags)
Vector< uint8_t > imb_save_buffer_iris(ImBuf *ibuf, ImBufFlags flags)
bool imb_save_png(ImBuf *ibuf, const char *filepath, ImBufFlags flags)
Definition format_png.cc:73
bool imb_is_a_webp(const uchar *mem, size_t size)
ImBuf * imb_thumbnail_jpeg(const char *filepath, const ImBufFlags flags, const size_t max_thumb_size, ImFileColorSpace &r_colorspace, size_t *r_width, size_t *r_height)
bool imb_save_bmp(ImBuf *ibuf, const char *filepath, ImBufFlags flags)
Definition format_bmp.cc:53
bool imb_save_hdr(ImBuf *ibuf, const char *filepath, ImBufFlags flags)
Definition format_hdr.cc:60
ImBuf * imb_load_bmp(const uchar *mem, size_t size, ImBufFlags flags, ImFileColorSpace &r_colorspace)
Definition format_bmp.cc:26
ImBuf * imb_load_filepath_thumbnail_svg(const char *filepath, const ImBufFlags, const size_t max_thumb_size, ImFileColorSpace &, size_t *r_width, size_t *r_height)
Definition format_svg.cc:21
const char * imb_file_extensions_bmp[]
Definition format_bmp.cc:16
const ImFileType * IMB_FILE_TYPES_LAST
Definition filetype.cc:326
ImBuf * imb_load_png(const uchar *mem, size_t size, ImBufFlags flags, ImFileColorSpace &r_colorspace)
Definition format_png.cc:27
ImBuf * imb_load_tga(const uchar *mem, size_t size, ImBufFlags flags, ImFileColorSpace &r_colorspace)
eImbFileType ftype
eImFileTypeCapability capability_write
const char ** file_extensions
const char * filetype_id
eImFileTypeCapability capability_read