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