Fix multilayer OpenEXR not supporting metadata.
[blender.git] / source / blender / blenkernel / BKE_image.h
1 /*
2  * ***** BEGIN GPL LICENSE BLOCK *****
3  *
4  * This program is free software; you can redistribute it and/or
5  * modify it under the terms of the GNU General Public License
6  * as published by the Free Software Foundation; either version 2
7  * of the License, or (at your option) any later version.
8  *
9  * This program is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12  * GNU General Public License for more details.
13  *
14  * You should have received a copy of the GNU General Public License
15  * along with this program; if not, write to the Free Software Foundation,
16  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
17  *
18  * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
19  * All rights reserved.
20  *
21  * The Original Code is: all of this file.
22  *
23  * Contributor(s): none yet.
24  *
25  * ***** END GPL LICENSE BLOCK *****
26  */
27 #ifndef __BKE_IMAGE_H__
28 #define __BKE_IMAGE_H__
29
30 /** \file BKE_image.h
31  *  \ingroup bke
32  *  \since March 2001
33  *  \author nzc
34  */
35
36 #ifdef __cplusplus
37 extern "C" {
38 #endif
39
40 struct Image;
41 struct ImBuf;
42 struct anim;
43 struct Scene;
44 struct Object;
45 struct ImageFormatData;
46 struct ImagePool;
47 struct Main;
48 struct ReportList;
49 struct RenderResult;
50 struct StampData;
51
52 #define IMA_MAX_SPACE       64
53
54 void   BKE_images_init(void);
55 void   BKE_images_exit(void);
56
57 void    BKE_image_free_packedfiles(struct Image *image);
58 void    BKE_image_free_views(struct Image *image);
59 void    BKE_image_free_buffers(struct Image *image);
60 /* call from library */
61 void    BKE_image_free(struct Image *image);
62
63 typedef void (StampCallback)(void *data, const char *propname, const char *propvalue);
64
65 void    BKE_render_result_stamp_info(struct Scene *scene, struct Object *camera, struct RenderResult *rr);
66 void    BKE_imbuf_stamp_info(struct RenderResult *rr, struct ImBuf *ibuf);
67 void    BKE_stamp_info_callback(void *data, struct StampData *stamp_data, StampCallback callback);
68 void    BKE_image_stamp_buf(struct Scene *scene, struct Object *camera, unsigned char *rect, float *rectf, int width, int height, int channels);
69 bool    BKE_imbuf_alpha_test(struct ImBuf *ibuf);
70 int     BKE_imbuf_write_stamp(struct Scene *scene, struct RenderResult *rr, struct ImBuf *ibuf, const char *name, struct ImageFormatData *imf);
71 void    BKE_imbuf_write_prepare(struct ImBuf *ibuf, struct ImageFormatData *imf);
72 int     BKE_imbuf_write(struct ImBuf *ibuf, const char *name, struct ImageFormatData *imf);
73 int     BKE_imbuf_write_as(struct ImBuf *ibuf, const char *name, struct ImageFormatData *imf, const bool is_copy);
74 void    BKE_image_path_from_imformat(
75         char *string, const char *base, const char *relbase, int frame,
76         const struct ImageFormatData *im_format, const bool use_ext, const bool use_frames, const char *suffix);
77 void    BKE_image_path_from_imtype(
78         char *string, const char *base, const char *relbase, int frame,
79         const char imtype, const bool use_ext, const bool use_frames, const char *suffix);
80 int     BKE_image_path_ensure_ext_from_imformat(char *string, const struct ImageFormatData *im_format);
81 int     BKE_image_path_ensure_ext_from_imtype(char *string, const char imtype);
82 char    BKE_image_ftype_to_imtype(const int ftype);
83 int     BKE_image_imtype_to_ftype(const char imtype);
84
85 bool    BKE_imtype_is_movie(const char imtype);
86 int     BKE_imtype_supports_zbuf(const char imtype);
87 int     BKE_imtype_supports_compress(const char imtype);
88 int     BKE_imtype_supports_quality(const char imtype);
89 int     BKE_imtype_requires_linear_float(const char imtype);
90 char    BKE_imtype_valid_channels(const char imtype, bool write_file);
91 char    BKE_imtype_valid_depths(const char imtype);
92
93 char    BKE_imtype_from_arg(const char *arg);
94
95 void    BKE_imformat_defaults(struct ImageFormatData *im_format);
96 void    BKE_imbuf_to_image_format(struct ImageFormatData *im_format, const struct ImBuf *imbuf);
97
98 struct anim *openanim(const char *name, int flags, int streamindex, char colorspace[IMA_MAX_SPACE]);
99 struct anim *openanim_noload(const char *name, int flags, int streamindex, char colorspace[IMA_MAX_SPACE]);
100
101 void    BKE_image_de_interlace(struct Image *ima, int odd);
102
103 void    BKE_image_make_local(struct Image *ima);
104
105 void    BKE_image_tag_time(struct Image *ima);
106
107 /* ********************************** NEW IMAGE API *********************** */
108
109 /* ImageUser is in Texture, in Nodes, Background Image, Image Window, .... */
110 /* should be used in conjunction with an ID * to Image. */
111 struct ImageUser;
112 struct RenderData;
113 struct RenderPass;
114 struct RenderResult;
115
116 /* ima->source; where image comes from */
117 #define IMA_SRC_CHECK       0
118 #define IMA_SRC_FILE        1
119 #define IMA_SRC_SEQUENCE    2
120 #define IMA_SRC_MOVIE       3
121 #define IMA_SRC_GENERATED   4
122 #define IMA_SRC_VIEWER      5
123
124 /* ima->type, how to handle/generate it */
125 #define IMA_TYPE_IMAGE      0
126 #define IMA_TYPE_MULTILAYER 1
127 /* generated */
128 #define IMA_TYPE_UV_TEST    2
129 /* viewers */
130 #define IMA_TYPE_R_RESULT   4
131 #define IMA_TYPE_COMPOSITE  5
132
133 enum {
134         IMA_GENTYPE_BLANK = 0,
135         IMA_GENTYPE_GRID = 1,
136         IMA_GENTYPE_GRID_COLOR = 2
137 };
138
139 /* ima->ok */
140 #define IMA_OK              1
141 #define IMA_OK_LOADED       2
142
143 /* signals */
144 /* reload only frees, doesn't read until image_get_ibuf() called */
145 #define IMA_SIGNAL_RELOAD           0
146 #define IMA_SIGNAL_FREE             1
147 /* source changes, from image to sequence or movie, etc */
148 #define IMA_SIGNAL_SRC_CHANGE       5
149 /* image-user gets a new image, check settings */
150 #define IMA_SIGNAL_USER_NEW_IMAGE   6
151 #define IMA_SIGNAL_COLORMANAGE      7
152
153 #define IMA_CHAN_FLAG_BW    1
154 #define IMA_CHAN_FLAG_RGB   2
155 #define IMA_CHAN_FLAG_ALPHA 4
156
157 /* checks whether there's an image buffer for given image and user */
158 bool BKE_image_has_ibuf(struct Image *ima, struct ImageUser *iuser);
159
160 /* same as above, but can be used to retrieve images being rendered in
161  * a thread safe way, always call both acquire and release */
162 struct ImBuf *BKE_image_acquire_ibuf(struct Image *ima, struct ImageUser *iuser, void **r_lock);
163 void BKE_image_release_ibuf(struct Image *ima, struct ImBuf *ibuf, void *lock);
164
165 struct ImagePool *BKE_image_pool_new(void);
166 void BKE_image_pool_free(struct ImagePool *pool);
167 struct ImBuf *BKE_image_pool_acquire_ibuf(struct Image *ima, struct ImageUser *iuser, struct ImagePool *pool);
168 void BKE_image_pool_release_ibuf(struct Image *ima, struct ImBuf *ibuf, struct ImagePool *pool);
169
170 /* set an alpha mode based on file extension */
171 char  BKE_image_alpha_mode_from_extension_ex(const char *filepath);
172 void BKE_image_alpha_mode_from_extension(struct Image *image);
173
174 /* returns a new image or NULL if it can't load */
175 struct Image *BKE_image_load(struct Main *bmain, const char *filepath);
176 /* returns existing Image when filename/type is same (frame optional) */
177 struct Image *BKE_image_load_exists_ex(const char *filepath, bool *r_exists);
178 struct Image *BKE_image_load_exists(const char *filepath);
179
180 /* adds image, adds ibuf, generates color or pattern */
181 struct Image *BKE_image_add_generated(
182         struct Main *bmain, unsigned int width, unsigned int height, const char *name, int depth, int floatbuf, short gen_type, const float color[4], const bool stereo3d);
183 /* adds image from imbuf, owns imbuf */
184 struct Image *BKE_image_add_from_imbuf(struct ImBuf *ibuf, const char *name);
185
186 /* for reload, refresh, pack */
187 void BKE_image_init_imageuser(struct Image *ima, struct ImageUser *iuser);
188 void BKE_image_signal(struct Image *ima, struct ImageUser *iuser, int signal);
189
190 void BKE_image_walk_all_users(const struct Main *mainp, void *customdata,
191                               void callback(struct Image *ima, struct ImageUser *iuser, void *customdata));
192
193 /* ensures an Image exists for viewing nodes or render */
194 struct Image *BKE_image_verify_viewer(int type, const char *name);
195 /* ensures the view node cache is compatible with the scene views */
196 void BKE_image_verify_viewer_views(const struct RenderData *rd, struct Image *ima, struct ImageUser *iuser);
197
198 /* called on frame change or before render */
199 void BKE_image_user_frame_calc(struct ImageUser *iuser, int cfra, int fieldnr);
200 void BKE_image_user_check_frame_calc(struct ImageUser *iuser, int cfra, int fieldnr);
201 int  BKE_image_user_frame_get(const struct ImageUser *iuser, int cfra, int fieldnr, bool *r_is_in_range);
202 void BKE_image_user_file_path(struct ImageUser *iuser, struct Image *ima, char *path); 
203 void BKE_image_update_frame(const struct Main *bmain, int cfra);
204
205 /* sets index offset for multilayer files */
206 struct RenderPass *BKE_image_multilayer_index(struct RenderResult *rr, struct ImageUser *iuser);
207
208 /* sets index offset for multiview files */
209 void BKE_image_multiview_index(struct Image *ima, struct ImageUser *iuser);
210
211 /* for multilayer images as well as for render-viewer */
212 bool BKE_image_is_multilayer(struct Image *ima);
213 struct RenderResult *BKE_image_acquire_renderresult(struct Scene *scene, struct Image *ima);
214 void BKE_image_release_renderresult(struct Scene *scene, struct Image *ima);
215
216 /* for multilayer images as well as for singlelayer */
217 bool BKE_image_is_openexr(struct Image *ima);
218
219 /* for multiple slot render, call this before render */
220 void BKE_image_backup_render(struct Scene *scene, struct Image *ima);
221
222 /* for singlelayer openexr saving */
223 bool BKE_image_save_openexr_multiview(struct Image *ima, struct ImBuf *ibuf, const char *filepath, const int flags);
224
225 /* goes over all textures that use images */
226 void    BKE_image_free_all_textures(void);
227
228 /* does one image! */
229 void    BKE_image_free_anim_ibufs(struct Image *ima, int except_frame);
230
231 /* does all images with type MOVIE or SEQUENCE */
232 void BKE_image_all_free_anim_ibufs(int except_frame);
233
234 void BKE_image_memorypack(struct Image *ima);
235 void BKE_image_packfiles(struct ReportList *reports, struct Image *ima, const char *basepath);
236 void BKE_image_packfiles_from_mem(struct ReportList *reports, struct Image *ima, char *data, const size_t data_len);
237
238 /* prints memory statistics for images */
239 void BKE_image_print_memlist(void);
240
241 /* empty image block, of similar type and filename */
242 struct Image *BKE_image_copy(struct Main *bmain, struct Image *ima);
243
244 /* merge source into dest, and free source */
245 void BKE_image_merge(struct Image *dest, struct Image *source);
246
247 /* scale the image */
248 bool BKE_image_scale(struct Image *image, int width, int height);
249
250 /* check if texture has alpha (depth=32) */
251 bool BKE_image_has_alpha(struct Image *image);
252
253 void BKE_image_get_size(struct Image *image, struct ImageUser *iuser, int *width, int *height);
254 void BKE_image_get_size_fl(struct Image *image, struct ImageUser *iuser, float size[2]);
255 void BKE_image_get_aspect(struct Image *image, float *aspx, float *aspy);
256
257 /* image_gen.c */
258 void BKE_image_buf_fill_color(unsigned char *rect, float *rect_float, int width, int height, const float color[4]);
259 void BKE_image_buf_fill_checker(unsigned char *rect, float *rect_float, int height, int width);
260 void BKE_image_buf_fill_checker_color(unsigned char *rect, float *rect_float, int height, int width);
261
262 /* Cycles hookup */
263 unsigned char *BKE_image_get_pixels_for_frame(struct Image *image, int frame);
264 float *BKE_image_get_float_pixels_for_frame(struct Image *image, int frame);
265
266 /* Guess offset for the first frame in the sequence */
267 int BKE_image_sequence_guess_offset(struct Image *image);
268 bool BKE_image_has_anim(struct Image *image);
269 bool BKE_image_has_packedfile(struct Image *image);
270 bool BKE_image_is_animated(struct Image *image);
271 bool BKE_image_is_dirty(struct Image *image);
272 void BKE_image_file_format_set(struct Image *image, int ftype);
273 bool BKE_image_has_loaded_ibuf(struct Image *image);
274 struct ImBuf *BKE_image_get_ibuf_with_name(struct Image *image, const char *name);
275 struct ImBuf *BKE_image_get_first_ibuf(struct Image *image);
276 #ifdef __cplusplus
277 }
278 #endif
279
280 #endif
281