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