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