rna function Image.scale(w, h), useful for utility functions to open/scale/save images.
[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    BKE_image_free(struct Image *me);
50
51 void    BKE_imbuf_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_imbuf_alpha_test(struct ImBuf *ibuf);
54 int     BKE_imbuf_write_stamp(struct Scene *scene, struct Object *camera, struct ImBuf *ibuf, const char *name, struct ImageFormatData *imf);
55 int     BKE_imbuf_write(struct ImBuf *ibuf, const char *name, struct ImageFormatData *imf);
56 int     BKE_imbuf_write_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 void    BKE_imformat_defaults(struct ImageFormatData *im_format);
72
73 struct anim *openanim(const char *name, int flags, int streamindex);
74
75 void    BKE_image_de_interlace(struct Image *ima, int odd);
76
77 void    BKE_image_make_local(struct Image *ima);
78
79 void    BKE_image_tag_time(struct Image *ima);
80 void    free_old_images(void);
81
82 /* ********************************** NEW IMAGE API *********************** */
83
84 /* ImageUser is in Texture, in Nodes, Background Image, Image Window, .... */
85 /* should be used in conjunction with an ID * to Image. */
86 struct ImageUser;
87 struct RenderPass;
88 struct RenderResult;
89
90 /* ima->source; where image comes from */
91 #define IMA_SRC_CHECK       0
92 #define IMA_SRC_FILE        1
93 #define IMA_SRC_SEQUENCE    2
94 #define IMA_SRC_MOVIE       3
95 #define IMA_SRC_GENERATED   4
96 #define IMA_SRC_VIEWER      5
97
98 /* ima->type, how to handle/generate it */
99 #define IMA_TYPE_IMAGE      0
100 #define IMA_TYPE_MULTILAYER 1
101 /* generated */
102 #define IMA_TYPE_UV_TEST    2
103 /* viewers */
104 #define IMA_TYPE_R_RESULT   4
105 #define IMA_TYPE_COMPOSITE  5
106
107 /* ima->ok */
108 #define IMA_OK              1
109 #define IMA_OK_LOADED       2
110
111 /* signals */
112 /* reload only frees, doesn't read until image_get_ibuf() called */
113 #define IMA_SIGNAL_RELOAD           0
114 #define IMA_SIGNAL_FREE             1
115 /* source changes, from image to sequence or movie, etc */
116 #define IMA_SIGNAL_SRC_CHANGE       5
117 /* image-user gets a new image, check settings */
118 #define IMA_SIGNAL_USER_NEW_IMAGE   6
119
120 #define IMA_CHAN_FLAG_BW    1
121 #define IMA_CHAN_FLAG_RGB   2
122 #define IMA_CHAN_FLAG_ALPHA 4
123
124 /* depending Image type, and (optional) ImageUser setting it returns ibuf */
125 /* always call to make signals work */
126 struct ImBuf *BKE_image_get_ibuf(struct Image *ima, struct ImageUser *iuser);
127
128 /* same as above, but can be used to retrieve images being rendered in
129  * a thread safe way, always call both acquire and release */
130 struct ImBuf *BKE_image_acquire_ibuf(struct Image *ima, struct ImageUser *iuser, void **lock_r);
131 void BKE_image_release_ibuf(struct Image *ima, void *lock);
132
133 /* returns a new image or NULL if it can't load */
134 struct Image *BKE_image_load(const char *filepath);
135 /* returns existing Image when filename/type is same (frame optional) */
136 struct Image *BKE_image_load_exists(const char *filepath);
137
138 /* adds image, adds ibuf, generates color or pattern */
139 struct Image *BKE_image_add_generated(unsigned int width, unsigned int height, const char *name, int depth, int floatbuf, short uvtestgrid, float color[4]);
140 /* adds image from imbuf, owns imbuf */
141 struct Image *BKE_image_add_from_imbuf(struct ImBuf *ibuf);
142
143 /* for reload, refresh, pack */
144 void BKE_image_signal(struct Image *ima, struct ImageUser *iuser, int signal);
145
146 /* ensures an Image exists for viewing nodes or render */
147 struct Image *BKE_image_verify_viewer(int type, const char *name);
148
149 /* force an ImBuf to become part of Image */
150 void BKE_image_assign_ibuf(struct Image *ima, struct ImBuf *ibuf);
151
152 /* called on frame change or before render */
153 void BKE_image_user_frame_calc(struct ImageUser *iuser, int cfra, int fieldnr);
154 int  BKE_image_user_frame_get(const struct ImageUser *iuser, int cfra, int fieldnr);
155
156 /* sets index offset for multilayer files */
157 struct RenderPass *BKE_image_multilayer_index(struct RenderResult *rr, struct ImageUser *iuser);
158
159 /* for multilayer images as well as for render-viewer */
160 struct RenderResult *BKE_image_acquire_renderresult(struct Scene *scene, struct Image *ima);
161 void BKE_image_release_renderresult(struct Scene *scene, struct Image *ima);
162
163 /* for multiple slot render, call this before render */
164 void BKE_image_backup_render(struct Scene *scene, struct Image *ima);
165         
166 /* goes over all textures that use images */
167 void    BKE_image_free_all_textures(void);
168
169 /* does one image! */
170 void    BKE_image_free_anim_ibufs(struct Image *ima, int except_frame);
171
172 /* does all images with type MOVIE or SEQUENCE */
173 void BKE_image_all_free_anim_ibufs(int except_frame);
174
175 void BKE_image_memorypack(struct Image *ima);
176
177 /* prints memory statistics for images */
178 void BKE_image_print_memlist(void);
179
180 /* empty image block, of similar type and filename */
181 struct Image *BKE_image_copy(struct Image *ima);
182
183 /* merge source into dest, and free source */
184 void BKE_image_merge(struct Image *dest, struct Image *source);
185
186 /* scale the image */
187 void BKE_image_scale(struct Image *image, int width, int height);
188
189 /* check if texture has alpha (depth=32) */
190 int BKE_image_has_alpha(struct Image *image);
191
192 /* image_gen.c */
193 void BKE_image_buf_fill_color(unsigned char *rect, float *rect_float, int width, int height, const float color[4]);
194 void BKE_image_buf_fill_checker(unsigned char *rect, float *rect_float, int height, int width);
195 void BKE_image_buf_fill_checker_color(unsigned char *rect, float *rect_float, int height, int width);
196
197 #ifdef __cplusplus
198 }
199 #endif
200
201 #endif
202