Image Stamping patch by Diego (and peach request)- stamps image info into metadata...
[blender.git] / source / blender / blenkernel / BKE_image.h
1 /**
2  * blenlib/BKE_image.h (mar-2001 nzc)
3  *      
4  * $Id$ 
5  *
6  * ***** BEGIN GPL/BL DUAL LICENSE BLOCK *****
7  *
8  * This program is free software; you can redistribute it and/or
9  * modify it under the terms of the GNU General Public License
10  * as published by the Free Software Foundation; either version 2
11  * of the License, or (at your option) any later version. The Blender
12  * Foundation also sells licenses for use in proprietary software under
13  * the Blender License.  See http://www.blender.org/BL/ for information
14  * about this.
15  *
16  * This program is distributed in the hope that it will be useful,
17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
19  * GNU General Public License for more details.
20  *
21  * You should have received a copy of the GNU General Public License
22  * along with this program; if not, write to the Free Software Foundation,
23  * Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
24  *
25  * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
26  * All rights reserved.
27  *
28  * The Original Code is: all of this file.
29  *
30  * Contributor(s): none yet.
31  *
32  * ***** END GPL/BL DUAL LICENSE BLOCK *****
33  */
34 #ifndef BKE_IMAGE_H
35 #define BKE_IMAGE_H
36
37 #ifdef __cplusplus
38 extern "C" {
39 #endif
40
41 struct Image;
42 struct ImBuf;
43 struct Tex;
44 struct anim;
45
46 /* call from library */
47 void    free_image(struct Image *me);
48
49 void    BKE_stamp(struct ImBuf *ibuf);
50 int             BKE_write_ibuf(struct ImBuf *ibuf, char *name, int imtype, int subimtype, int quality);
51 void    BKE_makepicstring(char *string, char *base, int frame, int imtype);
52 void    BKE_add_image_extension(char *string, int imtype);
53 int             BKE_ftype_to_imtype(int ftype);
54 int             BKE_imtype_to_ftype(int imtype);
55 int             BKE_imtype_is_movie(int imtype);
56
57 struct anim *openanim(char * name, int flags);
58
59 void    converttopremul(struct ImBuf *ibuf);
60 void    image_de_interlace(struct Image *ima, int odd);
61         
62 void    tag_image_time(struct Image *ima);
63 void    free_old_images(void);
64
65 /* ********************************** NEW IMAGE API *********************** */
66
67 /* ImageUser is in Texture, in Nodes, Background Image, Image Window, .... */
68 /* should be used in conjunction with an ID * to Image. */
69 struct ImageUser;
70 struct RenderPass;
71 struct RenderResult;
72
73 /* ima->source; where image comes from */
74 #define IMA_SRC_CHECK           0
75 #define IMA_SRC_FILE            1
76 #define IMA_SRC_SEQUENCE        2
77 #define IMA_SRC_MOVIE           3
78 #define IMA_SRC_GENERATED       4
79 #define IMA_SRC_VIEWER          5
80
81 /* ima->type, how to handle/generate it */
82 #define IMA_TYPE_IMAGE          0
83 #define IMA_TYPE_MULTILAYER     1
84                 /* generated */
85 #define IMA_TYPE_UV_TEST        2
86 #define IMA_TYPE_VERSE          3
87                 /* viewers */
88 #define IMA_TYPE_R_RESULT   4
89 #define IMA_TYPE_COMPOSITE      5
90
91 /* ima->ok */
92 #define IMA_OK                          1
93 #define IMA_OK_LOADED           2
94
95 /* signals */
96         /* reload only frees, doesn't read until image_get_ibuf() called */
97 #define IMA_SIGNAL_RELOAD                       0
98 #define IMA_SIGNAL_FREE                         1
99         /* pack signals are executed */
100 #define IMA_SIGNAL_PACK                         2
101 #define IMA_SIGNAL_REPACK                       3
102 #define IMA_SIGNAL_UNPACK                       4
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 /* returns existing Image when filename/type is same */
113 struct Image *BKE_add_image_file(const char *name);
114
115 /* adds image, adds ibuf, generates color or pattern */
116 struct Image *BKE_add_image_size(int width, int height, char *name, short uvtestgrid, float color[4]);
117
118 /* for reload, refresh, pack */
119 void BKE_image_signal(struct Image *ima, struct ImageUser *iuser, int signal);
120
121 /* ensures an Image exists for viewing nodes or render */
122 struct Image *BKE_image_verify_viewer(int type, const char *name);
123
124 /* force an ImBuf to become part of Image */
125 void BKE_image_assign_ibuf(struct Image *ima, struct ImBuf *ibuf);
126
127 /* called on frame change or before render */
128 void BKE_image_user_calc_imanr(struct ImageUser *iuser, int cfra, int fieldnr);
129
130 /* fix things in ImageUser when new image gets assigned */
131 void BKE_image_user_new_image(struct Image *ima, struct ImageUser *iuser);
132
133 /* sets index offset for multilayer files */
134 struct RenderPass *BKE_image_multilayer_index(struct RenderResult *rr, struct ImageUser *iuser);
135
136 /* for multilayer images as well as for render-viewer */
137 struct RenderResult *BKE_image_get_renderresult(struct Image *ima);
138
139 /* goes over all textures that use images */
140 void    BKE_image_free_all_textures(void);
141
142 /* does one image! */
143 void    BKE_image_free_anim_ibufs(struct Image *ima, int except_frame);
144
145 /* does all images with type MOVIE or SEQUENCE */
146 void BKE_image_all_free_anim_ibufs(int except_frame);
147
148 void BKE_image_memorypack(struct Image *ima);
149
150 #ifdef __cplusplus
151 }
152 #endif
153
154 #endif
155