Blender V5.3
IMB_filetype.hh
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#pragma once
10
11#include "IMB_imbuf.hh"
12
13namespace blender {
14
15struct ImBuf;
16struct ImFileColorSpace;
17
18/* -------------------------------------------------------------------- */
21
22#define IM_FTYPE_FLOAT 1
23
24struct ImFileType {
26 void (*init)();
28 void (*exit)();
29
35 bool (*is_a)(const unsigned char *buf, size_t size);
36
38 ImBuf *(*load)(const unsigned char *mem,
39 size_t size,
40 ImBufFlags flags,
41 ImFileColorSpace &r_colorspace);
43 ImBuf *(*load_filepath)(const char *filepath, ImBufFlags flags, ImFileColorSpace &r_colorspace);
49 ImBuf *(*load_filepath_thumbnail)(const char *filepath,
50 ImBufFlags flags,
51 size_t max_thumb_size,
52 ImFileColorSpace &r_colorspace,
53 size_t *r_width,
54 size_t *r_height);
56 bool (*save)(ImBuf *ibuf, const char *filepath, ImBufFlags flags);
59
60 int flag;
61
66
68
70 const char *filetype_id;
71
76 const char **file_extensions;
77
79};
80
88
89extern const ImFileType IMB_FILE_TYPES[];
91
93const ImFileType *IMB_file_type_from_ibuf(const ImBuf *ibuf);
94
97
99
100/* Type Specific Functions */
101
102/* -------------------------------------------------------------------- */
105
106extern const char *imb_file_extensions_png[];
107
108bool imb_is_a_png(const unsigned char *mem, size_t size);
109ImBuf *imb_load_png(const unsigned char *mem,
110 size_t size,
111 ImBufFlags flags,
112 ImFileColorSpace &r_colorspace);
113bool imb_save_png(ImBuf *ibuf, const char *filepath, ImBufFlags flags);
115
117
118/* -------------------------------------------------------------------- */
121
122extern const char *imb_file_extensions_tga[];
123
124bool imb_is_a_tga(const unsigned char *mem, size_t size);
125ImBuf *imb_load_tga(const unsigned char *mem,
126 size_t size,
127 ImBufFlags flags,
128 ImFileColorSpace &r_colorspace);
129bool imb_save_tga(ImBuf *ibuf, const char *filepath, ImBufFlags flags);
131
133
134/* -------------------------------------------------------------------- */
137
138extern const char *imb_file_extensions_iris[];
139
140bool imb_is_a_iris(const unsigned char *mem, size_t size);
144ImBuf *imb_loadiris(const unsigned char *mem,
145 size_t size,
146 ImBufFlags flags,
147 ImFileColorSpace &r_colorspace);
148bool imb_saveiris(ImBuf *ibuf, const char *filepath, ImBufFlags flags);
150
152
153/* -------------------------------------------------------------------- */
156
157extern const char *imb_file_extensions_jp2[];
158
159bool imb_is_a_jp2(const unsigned char *buf, size_t size);
160ImBuf *imb_load_jp2(const unsigned char *mem,
161 size_t size,
162 ImBufFlags flags,
163 ImFileColorSpace &r_colorspace);
164bool imb_save_jp2(ImBuf *ibuf, const char *filepath, ImBufFlags flags);
165
167
168/* -------------------------------------------------------------------- */
171
172extern const char *imb_file_extensions_jpeg[];
173
174bool imb_is_a_jpeg(const unsigned char *mem, size_t size);
175bool imb_savejpeg(ImBuf *ibuf, const char *filepath, ImBufFlags flags);
176ImBuf *imb_load_jpeg(const unsigned char *buffer,
177 size_t size,
178 ImBufFlags flags,
179 ImFileColorSpace &r_colorspace);
180ImBuf *imb_thumbnail_jpeg(const char *filepath,
181 ImBufFlags flags,
182 size_t max_thumb_size,
183 ImFileColorSpace &r_colorspace,
184 size_t *r_width,
185 size_t *r_height);
186
188
189/* -------------------------------------------------------------------- */
192
193extern const char *imb_file_extensions_bmp[];
194
195bool imb_is_a_bmp(const unsigned char *mem, size_t size);
196ImBuf *imb_load_bmp(const unsigned char *mem,
197 size_t size,
198 ImBufFlags flags,
199 ImFileColorSpace &r_colorspace);
200bool imb_save_bmp(ImBuf *ibuf, const char *filepath, ImBufFlags flags);
202
204
205/* -------------------------------------------------------------------- */
208
209extern const char *imb_file_extensions_cineon[];
210
211bool imb_is_a_cineon(const unsigned char *mem, size_t size);
212bool imb_save_cineon(ImBuf *buf, const char *filepath, ImBufFlags flags);
213ImBuf *imb_load_cineon(const unsigned char *mem,
214 size_t size,
215 ImBufFlags flags,
216 ImFileColorSpace &r_colorspace);
217
219
220/* -------------------------------------------------------------------- */
223
224extern const char *imb_file_extensions_dpx[];
225
226bool imb_is_a_dpx(const unsigned char *mem, size_t size);
227bool imb_save_dpx(ImBuf *ibuf, const char *filepath, ImBufFlags flags);
229ImBuf *imb_load_dpx(const unsigned char *mem,
230 size_t size,
231 ImBufFlags flags,
232 ImFileColorSpace &r_colorspace);
233
235
236/* -------------------------------------------------------------------- */
239
240extern const char *imb_file_extensions_hdr[];
241
242bool imb_is_a_hdr(const unsigned char *mem, size_t size);
243ImBuf *imb_load_hdr(const unsigned char *mem,
244 size_t size,
245 ImBufFlags flags,
246 ImFileColorSpace &r_colorspace);
247bool imb_save_hdr(ImBuf *ibuf, const char *filepath, ImBufFlags flags);
249
251
252/* -------------------------------------------------------------------- */
255
256extern const char *imb_file_extensions_tiff[];
257
258bool imb_is_a_tiff(const unsigned char *mem, size_t size);
268ImBuf *imb_load_tiff(const unsigned char *mem,
269 size_t size,
270 ImBufFlags flags,
271 ImFileColorSpace &r_colorspace);
286bool imb_save_tiff(ImBuf *ibuf, const char *filepath, ImBufFlags flags);
288
290
291/* -------------------------------------------------------------------- */
294
295extern const char *imb_file_extensions_webp[];
296
297bool imb_is_a_webp(const unsigned char *mem, size_t size);
298ImBuf *imb_loadwebp(const unsigned char *mem,
299 size_t size,
300 ImBufFlags flags,
301 ImFileColorSpace &r_colorspace);
302ImBuf *imb_load_filepath_thumbnail_webp(const char *filepath,
303 const ImBufFlags flags,
304 const size_t max_thumb_size,
305 ImFileColorSpace &r_colorspace,
306 size_t *r_width,
307 size_t *r_height);
308bool imb_savewebp(ImBuf *ibuf, const char *filepath, ImBufFlags flags);
310
312
313/* -------------------------------------------------------------------- */
316
317extern const char *imb_file_extensions_dds[];
318
319void imb_init_dds();
320
321bool imb_is_a_dds(const unsigned char *mem, size_t size);
322
323ImBuf *imb_load_dds(const unsigned char *mem,
324 size_t size,
325 ImBufFlags flags,
326 ImFileColorSpace &r_colorspace);
327
328uint8_t *imb_load_dds_compressed_data(const char *filepath,
329 int width,
330 int height,
331 int &r_mipcount);
332
334
335/* -------------------------------------------------------------------- */
338
339extern const char *imb_file_extensions_psd[];
340
341bool imb_is_a_psd(const unsigned char *mem, size_t size);
342
343ImBuf *imb_load_psd(const unsigned char *mem,
344 size_t size,
345 ImBufFlags flags,
346 ImFileColorSpace &r_colorspace);
347
349
350/* -------------------------------------------------------------------- */
353
354extern const char *imb_file_extensions_avif[];
355
356bool imb_is_a_avif(const unsigned char *mem, size_t size);
357ImBuf *imb_load_avif(const unsigned char *mem,
358 size_t size,
359 ImBufFlags flags,
360 ImFileColorSpace &r_colorspace);
361bool imb_save_avif(ImBuf *ibuf, const char *filepath, ImBufFlags flags);
363
365
366/* -------------------------------------------------------------------- */
369
370ImBuf *imb_load_filepath_thumbnail_svg(const char *filepath,
371 const ImBufFlags flags,
372 const size_t max_thumb_size,
373 ImFileColorSpace &r_colorspace,
374 size_t *r_width,
375 size_t *r_height);
376
378
379} // namespace blender
#define IM_MAX_SPACE
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
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)
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_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 &)
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)
Vector< uint8_t > imb_save_buffer_webp(ImBuf *ibuf, ImBufFlags flags)
bool imb_save_avif(ImBuf *ibuf, const char *filepath, ImBufFlags flags)
Vector< uint8_t > imb_save_buffer_dpx(ImBuf *ibuf, ImBufFlags flags)
uint8_t * imb_load_dds_compressed_data(const char *filepath, int width, int height, int &r_mipcount)
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
unsigned char uint8_t
Definition BKE_text.h:79
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
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
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
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)
char metadata_colorspace[IM_MAX_SPACE]
bool(*) is_a(const unsigned char *buf, size_t size)
eImFileTypeCapability capability_write
const char ** file_extensions
bool(*) save(ImBuf *ibuf, const char *filepath, ImBufFlags flags)
Vector< uint8_t >(*) save_buffer(ImBuf *ibuf, ImBufFlags flags)
eImbFileType filetype
const char * filetype_id
eImFileTypeCapability capability_read