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