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