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