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