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