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