Merging r44227 through r45619 from trunk into soc-2011-tomato
[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
48 /* call from library */
49 void    free_image(struct Image *me);
50
51 void    BKE_stamp_info(struct Scene *scene, struct Object *camera, struct ImBuf *ibuf);
52 void    BKE_stamp_buf(struct Scene *scene, struct Object *camera, unsigned char *rect, float *rectf, int width, int height, int channels);
53 int             BKE_alphatest_ibuf(struct ImBuf *ibuf);
54 int             BKE_write_ibuf_stamp(struct Scene *scene, struct Object *camera, struct ImBuf *ibuf, const char *name, struct ImageFormatData *imf);
55 int             BKE_write_ibuf(struct ImBuf *ibuf, const char *name, struct ImageFormatData *imf);
56 int     BKE_write_ibuf_as(struct ImBuf *ibuf, const char *name, struct ImageFormatData *imf, const short is_copy);
57 void    BKE_makepicstring(char *string, const char *base, const char *relbase, int frame, const char imtype, const short use_ext, const short use_frames);
58 int             BKE_add_image_extension(char *string, const char imtype);
59 char    BKE_ftype_to_imtype(const int ftype);
60 int             BKE_imtype_to_ftype(const char imtype);
61
62 int             BKE_imtype_is_movie(const char imtype);
63 int             BKE_imtype_supports_zbuf(const char imtype);
64 int             BKE_imtype_supports_compress(const char imtype);
65 int             BKE_imtype_supports_quality(const char imtype);
66 char    BKE_imtype_valid_channels(const char imtype);
67 char    BKE_imtype_valid_depths(const char imtype);
68
69 char    BKE_imtype_from_arg(const char *arg);
70
71 struct anim *openanim(const char *name, int flags, int streamindex);
72
73 void    image_de_interlace(struct Image *ima, int odd);
74
75 void    make_local_image(struct Image *ima);
76
77 void    tag_image_time(struct Image *ima);
78 void    free_old_images(void);
79
80 /* ********************************** NEW IMAGE API *********************** */
81
82 /* ImageUser is in Texture, in Nodes, Background Image, Image Window, .... */
83 /* should be used in conjunction with an ID * to Image. */
84 struct ImageUser;
85 struct RenderPass;
86 struct RenderResult;
87
88 /* ima->source; where image comes from */
89 #define IMA_SRC_CHECK           0
90 #define IMA_SRC_FILE            1
91 #define IMA_SRC_SEQUENCE        2
92 #define IMA_SRC_MOVIE           3
93 #define IMA_SRC_GENERATED       4
94 #define IMA_SRC_VIEWER          5
95
96 /* ima->type, how to handle/generate it */
97 #define IMA_TYPE_IMAGE          0
98 #define IMA_TYPE_MULTILAYER     1
99                 /* generated */
100 #define IMA_TYPE_UV_TEST        2
101                 /* viewers */
102 #define IMA_TYPE_R_RESULT   4
103 #define IMA_TYPE_COMPOSITE      5
104
105 /* ima->ok */
106 #define IMA_OK                          1
107 #define IMA_OK_LOADED           2
108
109 /* signals */
110         /* reload only frees, doesn't read until image_get_ibuf() called */
111 #define IMA_SIGNAL_RELOAD                       0
112 #define IMA_SIGNAL_FREE                         1
113         /* source changes, from image to sequence or movie, etc */
114 #define IMA_SIGNAL_SRC_CHANGE           5
115         /* image-user gets a new image, check settings */
116 #define IMA_SIGNAL_USER_NEW_IMAGE       6
117
118 #define IMA_CHAN_FLAG_BW    1
119 #define IMA_CHAN_FLAG_RGB   2
120 #define IMA_CHAN_FLAG_ALPHA 4
121
122 /* depending Image type, and (optional) ImageUser setting it returns ibuf */
123 /* always call to make signals work */
124 struct ImBuf *BKE_image_get_ibuf(struct Image *ima, struct ImageUser *iuser);
125
126 /* same as above, but can be used to retrieve images being rendered in
127  * a thread safe way, always call both acquire and release */
128 struct ImBuf *BKE_image_acquire_ibuf(struct Image *ima, struct ImageUser *iuser, void **lock_r);
129 void BKE_image_release_ibuf(struct Image *ima, void *lock);
130
131 /* returns existing Image when filename/type is same (frame optional) */
132 struct Image *BKE_add_image_file(const char *name);
133
134 /* adds image, adds ibuf, generates color or pattern */
135 struct Image *BKE_add_image_size(unsigned int width, unsigned int height, const char *name, int depth, int floatbuf, short uvtestgrid, float color[4]);
136 /* adds image from imbuf, owns imbuf */
137 struct Image *BKE_add_image_imbuf(struct ImBuf *ibuf);
138
139 /* for reload, refresh, pack */
140 void BKE_image_signal(struct Image *ima, struct ImageUser *iuser, int signal);
141
142 /* ensures an Image exists for viewing nodes or render */
143 struct Image *BKE_image_verify_viewer(int type, const char *name);
144
145 /* force an ImBuf to become part of Image */
146 void BKE_image_assign_ibuf(struct Image *ima, struct ImBuf *ibuf);
147
148 /* called on frame change or before render */
149 void BKE_image_user_calc_frame(struct ImageUser *iuser, int cfra, int fieldnr);
150 int BKE_image_user_get_frame(const struct ImageUser *iuser, int cfra, int fieldnr);
151
152 /* sets index offset for multilayer files */
153 struct RenderPass *BKE_image_multilayer_index(struct RenderResult *rr, struct ImageUser *iuser);
154
155 /* for multilayer images as well as for render-viewer */
156 struct RenderResult *BKE_image_acquire_renderresult(struct Scene *scene, struct Image *ima);
157 void BKE_image_release_renderresult(struct Scene *scene, struct Image *ima);
158
159 /* for multiple slot render, call this before render */
160 void BKE_image_backup_render(struct Scene *scene, struct Image *ima);
161         
162 /* goes over all textures that use images */
163 void    BKE_image_free_all_textures(void);
164
165 /* does one image! */
166 void    BKE_image_free_anim_ibufs(struct Image *ima, int except_frame);
167
168 /* does all images with type MOVIE or SEQUENCE */
169 void BKE_image_all_free_anim_ibufs(int except_frame);
170
171 void BKE_image_memorypack(struct Image *ima);
172
173 /* prints memory statistics for images */
174 void BKE_image_print_memlist(void);
175
176 /* empty image block, of similar type and filename */
177 struct Image *copy_image(struct Image *ima);
178
179 /* merge source into dest, and free source */
180 void BKE_image_merge(struct Image *dest, struct Image *source);
181
182 /* check if texture has alpha (depth=32) */
183 int BKE_image_has_alpha(struct Image *image);
184
185 /* image_gen.c */
186 void BKE_image_buf_fill_color(unsigned char *rect, float *rect_float, int width, int height, const float color[4]);
187 void BKE_image_buf_fill_checker(unsigned char *rect, float *rect_float, int height, int width);
188 void BKE_image_buf_fill_checker_color(unsigned char *rect, float *rect_float, int height, int width);
189
190 #ifdef __cplusplus
191 }
192 #endif
193
194 #endif
195