Add ability to specify custom fields to be saved from render result
[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 ImbFormatOptions;
43 struct anim;
44 struct Scene;
45 struct Object;
46 struct ImageFormatData;
47 struct ImagePool;
48 struct Main;
49 struct ReportList;
50 struct RenderResult;
51 struct StampData;
52
53 #define IMA_MAX_SPACE       64
54
55 void   BKE_images_init(void);
56 void   BKE_images_exit(void);
57
58 void    BKE_image_free_packedfiles(struct Image *image);
59 void    BKE_image_free_views(struct Image *image);
60 void    BKE_image_free_buffers(struct Image *image);
61 void    BKE_image_free_buffers_ex(struct Image *image, bool do_lock);
62 /* call from library */
63 void    BKE_image_free(struct Image *image);
64
65 void    BKE_image_init(struct Image *image);
66
67 typedef void (StampCallback)(void *data, const char *propname, char *propvalue, int len);
68
69 void    BKE_render_result_stamp_info(struct Scene *scene, struct Object *camera, struct RenderResult *rr, bool allocate_only);
70 void    BKE_imbuf_stamp_info(struct RenderResult *rr, struct ImBuf *ibuf);
71 void    BKE_stamp_info_from_imbuf(struct RenderResult *rr, struct ImBuf *ibuf);
72 void    BKE_stamp_info_callback(void *data, struct StampData *stamp_data, StampCallback callback, bool noskip);
73 void    BKE_render_result_stamp_data(struct RenderResult *rr, const char *key, const char *value);
74 void    BKE_stamp_data_free(struct StampData *stamp_data);
75 void    BKE_image_stamp_buf(
76         struct Scene *scene, struct Object *camera, const struct StampData *stamp_data_template,
77         unsigned char *rect, float *rectf, int width, int height, int channels);
78 bool    BKE_imbuf_alpha_test(struct ImBuf *ibuf);
79 int     BKE_imbuf_write_stamp(
80         struct Scene *scene, struct RenderResult *rr, struct ImBuf *ibuf, const char *name,
81         const struct ImageFormatData *imf);
82 void    BKE_imbuf_write_prepare(struct ImBuf *ibuf, const struct ImageFormatData *imf);
83 int     BKE_imbuf_write(struct ImBuf *ibuf, const char *name, const struct ImageFormatData *imf);
84 int     BKE_imbuf_write_as(struct ImBuf *ibuf, const char *name, struct ImageFormatData *imf, const bool is_copy);
85 void    BKE_image_path_from_imformat(
86         char *string, const char *base, const char *relbase, int frame,
87         const struct ImageFormatData *im_format, const bool use_ext, const bool use_frames, const char *suffix);
88 void    BKE_image_path_from_imtype(
89         char *string, const char *base, const char *relbase, int frame,
90         const char imtype, const bool use_ext, const bool use_frames, const char *suffix);
91 int     BKE_image_path_ensure_ext_from_imformat(char *string, const struct ImageFormatData *im_format);
92 int     BKE_image_path_ensure_ext_from_imtype(char *string, const char imtype);
93 char    BKE_image_ftype_to_imtype(const int ftype, const struct ImbFormatOptions *options);
94 int     BKE_image_imtype_to_ftype(const char imtype, struct ImbFormatOptions *r_options);
95
96 bool    BKE_imtype_is_movie(const char imtype);
97 int     BKE_imtype_supports_zbuf(const char imtype);
98 int     BKE_imtype_supports_compress(const char imtype);
99 int     BKE_imtype_supports_quality(const char imtype);
100 int     BKE_imtype_requires_linear_float(const char imtype);
101 char    BKE_imtype_valid_channels(const char imtype, bool write_file);
102 char    BKE_imtype_valid_depths(const char imtype);
103
104 char    BKE_imtype_from_arg(const char *arg);
105
106 void    BKE_imformat_defaults(struct ImageFormatData *im_format);
107 void    BKE_imbuf_to_image_format(struct ImageFormatData *im_format, const struct ImBuf *imbuf);
108
109 struct anim *openanim(const char *name, int flags, int streamindex, char colorspace[IMA_MAX_SPACE]);
110 struct anim *openanim_noload(const char *name, int flags, int streamindex, char colorspace[IMA_MAX_SPACE]);
111
112 void    BKE_image_de_interlace(struct Image *ima, int odd);
113
114 void    BKE_image_make_local(struct Main *bmain, struct Image *ima, const bool lib_local);
115
116 void    BKE_image_tag_time(struct Image *ima);
117
118 /* ********************************** NEW IMAGE API *********************** */
119
120 /* ImageUser is in Texture, in Nodes, Background Image, Image Window, .... */
121 /* should be used in conjunction with an ID * to Image. */
122 struct ImageUser;
123 struct RenderData;
124 struct RenderPass;
125 struct RenderResult;
126
127 /* ima->source; where image comes from */
128 #define IMA_SRC_CHECK       0
129 #define IMA_SRC_FILE        1
130 #define IMA_SRC_SEQUENCE    2
131 #define IMA_SRC_MOVIE       3
132 #define IMA_SRC_GENERATED   4
133 #define IMA_SRC_VIEWER      5
134
135 /* ima->type, how to handle/generate it */
136 #define IMA_TYPE_IMAGE      0
137 #define IMA_TYPE_MULTILAYER 1
138 /* generated */
139 #define IMA_TYPE_UV_TEST    2
140 /* viewers */
141 #define IMA_TYPE_R_RESULT   4
142 #define IMA_TYPE_COMPOSITE  5
143
144 enum {
145         IMA_GENTYPE_BLANK = 0,
146         IMA_GENTYPE_GRID = 1,
147         IMA_GENTYPE_GRID_COLOR = 2
148 };
149
150 /* ima->ok */
151 #define IMA_OK              1
152 #define IMA_OK_LOADED       2
153
154 /* signals */
155 /* reload only frees, doesn't read until image_get_ibuf() called */
156 #define IMA_SIGNAL_RELOAD           0
157 #define IMA_SIGNAL_FREE             1
158 /* source changes, from image to sequence or movie, etc */
159 #define IMA_SIGNAL_SRC_CHANGE       5
160 /* image-user gets a new image, check settings */
161 #define IMA_SIGNAL_USER_NEW_IMAGE   6
162 #define IMA_SIGNAL_COLORMANAGE      7
163
164 #define IMA_CHAN_FLAG_BW    1
165 #define IMA_CHAN_FLAG_RGB   2
166 #define IMA_CHAN_FLAG_ALPHA 4
167
168 /* checks whether there's an image buffer for given image and user */
169 bool BKE_image_has_ibuf(struct Image *ima, struct ImageUser *iuser);
170
171 /* same as above, but can be used to retrieve images being rendered in
172  * a thread safe way, always call both acquire and release */
173 struct ImBuf *BKE_image_acquire_ibuf(struct Image *ima, struct ImageUser *iuser, void **r_lock);
174 void BKE_image_release_ibuf(struct Image *ima, struct ImBuf *ibuf, void *lock);
175
176 struct ImagePool *BKE_image_pool_new(void);
177 void BKE_image_pool_free(struct ImagePool *pool);
178 struct ImBuf *BKE_image_pool_acquire_ibuf(struct Image *ima, struct ImageUser *iuser, struct ImagePool *pool);
179 void BKE_image_pool_release_ibuf(struct Image *ima, struct ImBuf *ibuf, struct ImagePool *pool);
180
181 /* set an alpha mode based on file extension */
182 char  BKE_image_alpha_mode_from_extension_ex(const char *filepath);
183 void BKE_image_alpha_mode_from_extension(struct Image *image);
184
185 /* returns a new image or NULL if it can't load */
186 struct Image *BKE_image_load(struct Main *bmain, const char *filepath);
187 /* returns existing Image when filename/type is same (frame optional) */
188 struct Image *BKE_image_load_exists_ex(const char *filepath, bool *r_exists);
189 struct Image *BKE_image_load_exists(const char *filepath);
190
191 /* adds image, adds ibuf, generates color or pattern */
192 struct Image *BKE_image_add_generated(
193         struct Main *bmain, unsigned int width, unsigned int height, const char *name,
194         int depth, int floatbuf, short gen_type, const float color[4], const bool stereo3d);
195 /* adds image from imbuf, owns imbuf */
196 struct Image *BKE_image_add_from_imbuf(struct ImBuf *ibuf, const char *name);
197
198 /* for reload, refresh, pack */
199 void BKE_image_init_imageuser(struct Image *ima, struct ImageUser *iuser);
200 void BKE_image_signal(struct Image *ima, struct ImageUser *iuser, int signal);
201
202 void BKE_image_walk_all_users(const struct Main *mainp, void *customdata,
203                               void callback(struct Image *ima, struct ImageUser *iuser, void *customdata));
204
205 /* ensures an Image exists for viewing nodes or render */
206 struct Image *BKE_image_verify_viewer(int type, const char *name);
207 /* ensures the view node cache is compatible with the scene views */
208 void BKE_image_verify_viewer_views(const struct RenderData *rd, struct Image *ima, struct ImageUser *iuser);
209
210 /* called on frame change or before render */
211 void BKE_image_user_frame_calc(struct ImageUser *iuser, int cfra, int fieldnr);
212 void BKE_image_user_check_frame_calc(struct ImageUser *iuser, int cfra, int fieldnr);
213 int  BKE_image_user_frame_get(const struct ImageUser *iuser, int cfra, int fieldnr, bool *r_is_in_range);
214 void BKE_image_user_file_path(struct ImageUser *iuser, struct Image *ima, char *path); 
215 void BKE_image_update_frame(const struct Main *bmain, int cfra);
216
217 /* sets index offset for multilayer files */
218 struct RenderPass *BKE_image_multilayer_index(struct RenderResult *rr, struct ImageUser *iuser);
219
220 /* sets index offset for multiview files */
221 void BKE_image_multiview_index(struct Image *ima, struct ImageUser *iuser);
222
223 /* for multilayer images as well as for render-viewer */
224 bool BKE_image_is_multilayer(struct Image *ima);
225 bool BKE_image_is_multiview(struct Image *ima);
226 bool BKE_image_is_stereo(struct Image *ima);
227 struct RenderResult *BKE_image_acquire_renderresult(struct Scene *scene, struct Image *ima);
228 void BKE_image_release_renderresult(struct Scene *scene, struct Image *ima);
229
230 /* for multilayer images as well as for singlelayer */
231 bool BKE_image_is_openexr(struct Image *ima);
232
233 /* for multiple slot render, call this before render */
234 void BKE_image_backup_render(struct Scene *scene, struct Image *ima, bool free_current_slot);
235
236 /* for singlelayer openexr saving */
237 bool BKE_image_save_openexr_multiview(struct Image *ima, struct ImBuf *ibuf, const char *filepath, const int flags);
238
239 /* goes over all textures that use images */
240 void    BKE_image_free_all_textures(void);
241
242 /* does one image! */
243 void    BKE_image_free_anim_ibufs(struct Image *ima, int except_frame);
244
245 /* does all images with type MOVIE or SEQUENCE */
246 void BKE_image_all_free_anim_ibufs(int except_frame);
247
248 void BKE_image_memorypack(struct Image *ima);
249 void BKE_image_packfiles(struct ReportList *reports, struct Image *ima, const char *basepath);
250 void BKE_image_packfiles_from_mem(struct ReportList *reports, struct Image *ima, char *data, const size_t data_len);
251
252 /* prints memory statistics for images */
253 void BKE_image_print_memlist(void);
254
255 /* empty image block, of similar type and filename */
256 void BKE_image_copy_data(struct Main *bmain, struct Image *ima_dst, const struct Image *ima_src, const int flag);
257 struct Image *BKE_image_copy(struct Main *bmain, const struct Image *ima);
258
259 /* merge source into dest, and free source */
260 void BKE_image_merge(struct Image *dest, struct Image *source);
261
262 /* scale the image */
263 bool BKE_image_scale(struct Image *image, int width, int height);
264
265 /* check if texture has alpha (depth=32) */
266 bool BKE_image_has_alpha(struct Image *image);
267
268 /* check if texture has gpu texture code */
269 bool BKE_image_has_bindcode(struct Image *ima);
270
271 void BKE_image_get_size(struct Image *image, struct ImageUser *iuser, int *width, int *height);
272 void BKE_image_get_size_fl(struct Image *image, struct ImageUser *iuser, float size[2]);
273 void BKE_image_get_aspect(struct Image *image, float *aspx, float *aspy);
274
275 /* image_gen.c */
276 void BKE_image_buf_fill_color(unsigned char *rect, float *rect_float, int width, int height, const float color[4]);
277 void BKE_image_buf_fill_checker(unsigned char *rect, float *rect_float, int height, int width);
278 void BKE_image_buf_fill_checker_color(unsigned char *rect, float *rect_float, int height, int width);
279
280 /* Cycles hookup */
281 unsigned char *BKE_image_get_pixels_for_frame(struct Image *image, int frame);
282 float *BKE_image_get_float_pixels_for_frame(struct Image *image, int frame);
283
284 /* Guess offset for the first frame in the sequence */
285 int BKE_image_sequence_guess_offset(struct Image *image);
286 bool BKE_image_has_anim(struct Image *image);
287 bool BKE_image_has_packedfile(struct Image *image);
288 bool BKE_image_is_animated(struct Image *image);
289 bool BKE_image_is_dirty(struct Image *image);
290 void BKE_image_file_format_set(struct Image *image, int ftype, const struct ImbFormatOptions *options);
291 bool BKE_image_has_loaded_ibuf(struct Image *image);
292 struct ImBuf *BKE_image_get_ibuf_with_name(struct Image *image, const char *name);
293 struct ImBuf *BKE_image_get_first_ibuf(struct Image *image);
294 #ifdef __cplusplus
295 }
296 #endif
297
298 #endif
299