Merging r39717 through r39983 from trunk into soc-2011-tomato
[blender.git] / source / blender / blenkernel / BKE_image.h
1 /*
2  * $Id$ 
3  *
4  * ***** BEGIN GPL LICENSE BLOCK *****
5  *
6  * This program is free software; you can redistribute it and/or
7  * modify it under the terms of the GNU General Public License
8  * as published by the Free Software Foundation; either version 2
9  * of the License, or (at your option) any later version.
10  *
11  * This program is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14  * GNU General Public License for more details.
15  *
16  * You should have received a copy of the GNU General Public License
17  * along with this program; if not, write to the Free Software Foundation,
18  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
19  *
20  * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
21  * All rights reserved.
22  *
23  * The Original Code is: all of this file.
24  *
25  * Contributor(s): none yet.
26  *
27  * ***** END GPL LICENSE BLOCK *****
28  */
29 #ifndef BKE_IMAGE_H
30 #define BKE_IMAGE_H
31
32 /** \file BKE_image.h
33  *  \ingroup bke
34  *  \since March 2001
35  *  \author nzc
36  */
37
38 #ifdef __cplusplus
39 extern "C" {
40 #endif
41
42 struct Image;
43 struct ImBuf;
44 struct Tex;
45 struct anim;
46 struct Scene;
47 struct Object;
48
49 /* call from library */
50 void    free_image(struct Image *me);
51
52 void    BKE_stamp_info(struct Scene *scene, struct Object *camera, struct ImBuf *ibuf);
53 void    BKE_stamp_buf(struct Scene *scene, struct Object *camera, unsigned char *rect, float *rectf, int width, int height, int channels);
54 int             BKE_alphatest_ibuf(struct ImBuf *ibuf);
55 int             BKE_write_ibuf_stamp(struct Scene *scene, struct Object *camera, struct ImBuf *ibuf, const char *name, int imtype, int subimtype, int quality);
56 int             BKE_write_ibuf(struct ImBuf *ibuf, const char *name, int imtype, int subimtype, int quality);
57 void    BKE_makepicstring(char *string, const char *base, int frame, int imtype, const short use_ext, const short use_frames);
58 int             BKE_add_image_extension(char *string, int imtype);
59 int             BKE_ftype_to_imtype(int ftype);
60 int             BKE_imtype_to_ftype(int imtype);
61 int             BKE_imtype_is_movie(int imtype);
62
63 struct anim *openanim(char * name, int flags, int streamindex);
64
65 void    image_de_interlace(struct Image *ima, int odd);
66         
67 void    tag_image_time(struct Image *ima);
68 void    free_old_images(void);
69
70 /* ********************************** NEW IMAGE API *********************** */
71
72 /* ImageUser is in Texture, in Nodes, Background Image, Image Window, .... */
73 /* should be used in conjunction with an ID * to Image. */
74 struct ImageUser;
75 struct RenderPass;
76 struct RenderResult;
77
78 /* ima->source; where image comes from */
79 #define IMA_SRC_CHECK           0
80 #define IMA_SRC_FILE            1
81 #define IMA_SRC_SEQUENCE        2
82 #define IMA_SRC_MOVIE           3
83 #define IMA_SRC_GENERATED       4
84 #define IMA_SRC_VIEWER          5
85
86 /* ima->type, how to handle/generate it */
87 #define IMA_TYPE_IMAGE          0
88 #define IMA_TYPE_MULTILAYER     1
89                 /* generated */
90 #define IMA_TYPE_UV_TEST        2
91                 /* viewers */
92 #define IMA_TYPE_R_RESULT   4
93 #define IMA_TYPE_COMPOSITE      5
94
95 /* ima->ok */
96 #define IMA_OK                          1
97 #define IMA_OK_LOADED           2
98
99 /* signals */
100         /* reload only frees, doesn't read until image_get_ibuf() called */
101 #define IMA_SIGNAL_RELOAD                       0
102 #define IMA_SIGNAL_FREE                         1
103         /* source changes, from image to sequence or movie, etc */
104 #define IMA_SIGNAL_SRC_CHANGE           5
105         /* image-user gets a new image, check settings */
106 #define IMA_SIGNAL_USER_NEW_IMAGE       6
107
108 /* depending Image type, and (optional) ImageUser setting it returns ibuf */
109 /* always call to make signals work */
110 struct ImBuf *BKE_image_get_ibuf(struct Image *ima, struct ImageUser *iuser);
111
112 /* same as above, but can be used to retrieve images being rendered in
113  * a thread safe way, always call both acquire and release */
114 struct ImBuf *BKE_image_acquire_ibuf(struct Image *ima, struct ImageUser *iuser, void **lock_r);
115 void BKE_image_release_ibuf(struct Image *ima, void *lock);
116
117 /* returns existing Image when filename/type is same (frame optional) */
118 struct Image *BKE_add_image_file(const char *name);
119
120 /* adds image, adds ibuf, generates color or pattern */
121 struct Image *BKE_add_image_size(unsigned int width, unsigned int height, const char *name, int depth, int floatbuf, short uvtestgrid, float color[4]);
122 /* adds image from imbuf, owns imbuf */
123 struct Image *BKE_add_image_imbuf(struct ImBuf *ibuf);
124
125 /* for reload, refresh, pack */
126 void BKE_image_signal(struct Image *ima, struct ImageUser *iuser, int signal);
127
128 /* ensures an Image exists for viewing nodes or render */
129 struct Image *BKE_image_verify_viewer(int type, const char *name);
130
131 /* force an ImBuf to become part of Image */
132 void BKE_image_assign_ibuf(struct Image *ima, struct ImBuf *ibuf);
133
134 /* called on frame change or before render */
135 void BKE_image_user_calc_frame(struct ImageUser *iuser, int cfra, int fieldnr);
136 int BKE_image_user_get_frame(const struct ImageUser *iuser, int cfra, int fieldnr);
137
138 /* fix things in ImageUser when new image gets assigned */
139 void BKE_image_user_new_image(struct Image *ima, struct ImageUser *iuser);
140
141 /* sets index offset for multilayer files */
142 struct RenderPass *BKE_image_multilayer_index(struct RenderResult *rr, struct ImageUser *iuser);
143
144 /* for multilayer images as well as for render-viewer */
145 struct RenderResult *BKE_image_acquire_renderresult(struct Scene *scene, struct Image *ima);
146 void BKE_image_release_renderresult(struct Scene *scene, struct Image *ima);
147
148 /* for multiple slot render, call this before render */
149 void BKE_image_backup_render(struct Scene *scene, struct Image *ima);
150         
151 /* goes over all textures that use images */
152 void    BKE_image_free_all_textures(void);
153
154 /* does one image! */
155 void    BKE_image_free_anim_ibufs(struct Image *ima, int except_frame);
156
157 /* does all images with type MOVIE or SEQUENCE */
158 void BKE_image_all_free_anim_ibufs(int except_frame);
159
160 void BKE_image_memorypack(struct Image *ima);
161
162 /* prints memory statistics for images */
163 void BKE_image_print_memlist(void);
164
165 /* empty image block, of similar type and filename */
166 struct Image *copy_image(struct Image *ima);
167
168 /* merge source into dest, and free source */
169 void BKE_image_merge(struct Image *dest, struct Image *source);
170
171 /* image_gen.c */
172 void BKE_image_buf_fill_color(unsigned char *rect, float *rect_float, int width, int height, float color[4]);
173 void BKE_image_buf_fill_checker(unsigned char *rect, float *rect_float, int height, int width);
174 void BKE_image_buf_fill_checker_color(unsigned char *rect, float *rect_float, int height, int width);
175
176 #ifdef __cplusplus
177 }
178 #endif
179
180 #endif
181