Camera tracking integration
[blender.git] / source / blender / imbuf / IMB_imbuf.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
30 /** \file blender/imbuf/IMB_imbuf.h
31  *  \ingroup imbuf
32  */
33
34 /**
35  * @file IMB_imbuf.h
36  * @brief IMage Buffer module.
37  *
38  * This module offers import/export of several graphical file formats.
39  * @ingroup imbuf
40  *
41  * @page IMB Imbuf module external interface
42  *
43  *
44  * @section about About the IMB module
45  *
46  * External interface of the IMage Buffer module. This module offers
47  * import/export of several graphical file formats. It offers the
48  * ImBuf type as a common structure to refer to different graphical
49  * file formats, and to enable a uniform way of handling them.
50  *
51  * @section issues Known issues with IMB
52  *
53  * - imbuf is written in C.
54  * - Endianness issues are dealt with internally.
55  * - File I/O must be done externally. The module uses FILE*'s to
56  *   direct input/output.
57  * - Platform dependency is limited. Some minor patches for
58  *   amiga and Irix are present. A 'posix-compliancy-patch'
59  *   provides the interface to windows.
60  *
61  * @section dependencies Dependencies
62  *
63  * IMB needs:
64  * - \ref DNA module
65  *     The listbase types are used for handling the memory
66  *     management.
67  * - \ref blenlib module
68  *     blenlib handles guarded memory management in blender-style.
69  *     BLI_winstuff.h makes a few windows specific behaviours
70  *     posix-compliant.
71  */
72
73 #ifndef IMB_IMBUF_H
74 #define IMB_IMBUF_H
75
76 /**
77  *
78  * @attention defined in ???
79  */
80 struct ImBuf;
81
82 /**
83  *
84  * @attention defined in ???
85  */
86 struct anim;
87
88 /**
89  *
90  * @attention Defined in allocimbuf.c
91  */
92 void IMB_init(void);
93 void IMB_exit(void);
94
95 /**
96  *
97  * @attention Defined in readimage.c
98  */
99 struct ImBuf *IMB_ibImageFromMemory(unsigned char *mem, size_t size, int flags);
100
101 /**
102  *
103  * @attention Defined in readimage.c
104  */
105 struct ImBuf *IMB_testiffname(char *naam,int flags);
106
107 /**
108  *
109  * @attention Defined in readimage.c
110  */
111 struct ImBuf *IMB_loadiffname(const char *naam, int flags);
112
113 /**
114  *
115  * @attention Defined in allocimbuf.c
116  */
117 void IMB_freeImBuf(struct ImBuf *ibuf);
118
119 /**
120  *
121  * @attention Defined in allocimbuf.c
122  */
123 struct ImBuf *IMB_allocImBuf(unsigned int x, unsigned int y,
124                                                  unsigned char d, unsigned int flags);
125
126 /**
127  *
128  * Increase reference count to imbuf
129  * (to delete an imbuf you have to call freeImBuf as many times as it
130  * is referenced)
131  *
132  * @attention Defined in allocimbuf.c
133  */
134
135 void IMB_refImBuf(struct ImBuf *ibuf);
136 struct ImBuf * IMB_makeSingleUser(struct ImBuf *ibuf);
137
138 /**
139  *
140  * @attention Defined in allocimbuf.c
141  */
142 void IMB_cache_limiter_insert(struct ImBuf *i);
143 void IMB_cache_limiter_unmanage(struct ImBuf *i);
144 void IMB_cache_limiter_touch(struct ImBuf *i);
145 void IMB_cache_limiter_ref(struct ImBuf *i);
146 void IMB_cache_limiter_unref(struct ImBuf *i);
147 int IMB_cache_limiter_get_refcount(struct ImBuf *i);
148
149 void IMB_free_cache_limiter(void);
150
151 /**
152  *
153  * @attention Defined in allocimbuf.c
154  */
155 struct ImBuf *IMB_dupImBuf(struct ImBuf *ibuf1);
156
157 /**
158  *
159  * @attention Defined in allocimbuf.c
160  */
161 short addzbufImBuf(struct ImBuf *ibuf);
162 short addzbuffloatImBuf(struct ImBuf *ibuf);
163
164 /**
165  *
166  * @attention Defined in rectop.c
167  */
168
169 typedef enum IMB_BlendMode {
170         IMB_BLEND_MIX = 0,
171         IMB_BLEND_ADD = 1,
172         IMB_BLEND_SUB = 2,
173         IMB_BLEND_MUL = 3,
174         IMB_BLEND_LIGHTEN = 4,
175         IMB_BLEND_DARKEN = 5,
176         IMB_BLEND_ERASE_ALPHA = 6,
177         IMB_BLEND_ADD_ALPHA = 7,
178
179         IMB_BLEND_COPY = 1000,
180         IMB_BLEND_COPY_RGB = 1001,
181         IMB_BLEND_COPY_ALPHA = 1002
182 } IMB_BlendMode;
183
184 unsigned int IMB_blend_color(unsigned int src1, unsigned int src2, int fac,
185         IMB_BlendMode mode);
186 void IMB_blend_color_float(float *dst, float *src1, float *src2, float fac,
187         IMB_BlendMode mode);
188
189 void IMB_rectclip(struct ImBuf *dbuf, struct ImBuf *sbuf, int *destx, 
190         int *desty, int *srcx, int *srcy, int *width, int *height);
191 void IMB_rectcpy(struct ImBuf *drect, struct ImBuf *srect, int destx,
192         int desty, int srcx, int srcy, int width, int height);
193 void IMB_rectblend(struct ImBuf *dbuf, struct ImBuf *sbuf, int destx, 
194         int desty, int srcx, int srcy, int width, int height, IMB_BlendMode mode);
195
196 /**
197  *
198  * @attention Defined in indexer.c
199  */
200
201 typedef enum IMB_Timecode_Type {
202         IMB_TC_NONE       = 0, /* don't use timecode files at all */
203         IMB_TC_RECORD_RUN = 1, /* use images in the order as they are recorded 
204                                   (currently, this is the only one implemented
205                                   and is a sane default)
206                                */
207         IMB_TC_FREE_RUN   = 2, /* use global timestamp written by recording
208                                   device (prosumer camcorders e.g. can do
209                                   that) */
210         IMB_TC_INTERPOLATED_REC_DATE_FREE_RUN = 4, 
211                                /* interpolate a global timestamp using the
212                                   record date and time written by recording
213                                   device (*every* consumer camcorder can do
214                                   that :) )*/
215         IMB_TC_MAX_SLOT   = 3
216 } IMB_Timecode_Type;
217
218 typedef enum IMB_Proxy_Size {
219         IMB_PROXY_NONE = 0,
220         IMB_PROXY_25 = 1,
221         IMB_PROXY_50 = 2,
222         IMB_PROXY_75 = 4,
223         IMB_PROXY_MAX_SLOT = 3
224 } IMB_Proxy_Size;
225
226 /* defaults to BL_proxy within the directory of the animation */
227 void IMB_anim_set_index_dir(struct anim * anim, const char * dir);
228
229 int IMB_anim_index_get_frame_index(struct anim * anim, IMB_Timecode_Type tc,
230                                    int position);
231
232 /* will rebuild all used indices and proxies at once */
233 void IMB_anim_index_rebuild(struct anim * anim, 
234                             IMB_Timecode_Type build_tcs,
235                             IMB_Proxy_Size build_preview_sizes, 
236                             int build_quality,
237                             short *stop, short *do_update, float *progress);
238
239 /**
240  * Return the length (in frames) of the given @a anim.
241  */
242 int IMB_anim_get_duration(struct anim *anim, IMB_Timecode_Type tc);
243
244
245 /**
246  * Return the fps contained in movie files (function rval is FALSE,
247  * and frs_sec and frs_sec_base untouched if none available!)
248  */
249 int IMB_anim_get_fps(struct anim * anim, 
250                      short * frs_sec, float * frs_sec_base);
251
252 /**
253  *
254  * @attention Defined in anim.c
255  */
256 struct anim *IMB_open_anim(const char *name, int ib_flags);
257 void IMB_close_anim(struct anim *anim);
258
259
260 /**
261  *
262  * @attention Defined in anim.c
263  */
264
265 int ismovie(const char *name);
266 void IMB_anim_set_preseek(struct anim *anim, int preseek);
267 int IMB_anim_get_preseek(struct anim *anim);
268
269 /**
270  *
271  * @attention Defined in anim.c
272  */
273
274 struct ImBuf *IMB_anim_absolute(
275         struct anim *anim, int position,
276         IMB_Timecode_Type tc        /* = 1 = IMB_TC_RECORD_RUN */, 
277         IMB_Proxy_Size preview_size /* = 0 = IMB_PROXY_NONE */);
278
279 /**
280  *
281  * @attention Defined in anim.c
282  * fetches a define previewframe, usually half way into the movie
283  */
284 struct ImBuf *IMB_anim_previewframe(struct anim *anim);
285
286 /**
287  *
288  * @attention Defined in anim.c
289  */
290 void IMB_free_anim(struct anim *anim);
291
292 /**
293  *
294  * @attention Defined in filter.c
295  */
296
297 #define FILTER_MASK_NULL                0
298 #define FILTER_MASK_MARGIN              1
299 #define FILTER_MASK_USED                2
300
301 void IMB_filter(struct ImBuf *ibuf);
302 void IMB_filterN(struct ImBuf *out, struct ImBuf *in);
303 void IMB_mask_filter_extend(char *mask, int width, int height);
304 void IMB_mask_clear(struct ImBuf *ibuf, char *mask, int val);
305 void IMB_filter_extend(struct ImBuf *ibuf, char *mask, int filter);
306 void IMB_makemipmap(struct ImBuf *ibuf, int use_filter);
307 void IMB_remakemipmap(struct ImBuf *ibuf, int use_filter);
308 struct ImBuf *IMB_getmipmap(struct ImBuf *ibuf, int level);
309
310 /**
311  *
312  * @attention Defined in cache.c
313  */
314
315 void IMB_tile_cache_params(int totthread, int maxmem);
316 unsigned int *IMB_gettile(struct ImBuf *ibuf, int tx, int ty, int thread);
317 void IMB_tiles_to_rect(struct ImBuf *ibuf);
318
319 /**
320  *
321  * @attention Defined in filter.c
322  */
323 void IMB_filtery(struct ImBuf *ibuf);
324
325 /**
326  *
327  * @attention Defined in scaling.c
328  */
329 struct ImBuf *IMB_onehalf(struct ImBuf *ibuf1);
330
331 /**
332  *
333  * @attention Defined in scaling.c
334  */
335 struct ImBuf *IMB_scaleImBuf(struct ImBuf *ibuf, unsigned int newx, unsigned int newy);
336
337 /**
338  *
339  * @attention Defined in scaling.c
340  */
341 struct ImBuf *IMB_scalefastImBuf(struct ImBuf *ibuf, unsigned int newx, unsigned int newy);
342
343 /**
344  *
345  * @attention Defined in writeimage.c
346  */
347 short IMB_saveiff(struct ImBuf *ibuf, const char *filepath, int flags);
348
349 /**
350  * Encodes a png image from an ImBuf
351  *
352  * @attention Defined in png_encode.c
353  */
354 short IMB_png_encode(struct ImBuf *ibuf, int file, int flags);
355
356 /**
357  *
358  * @attention Defined in util.c
359  */
360 int IMB_ispic(const char *name);
361
362 /**
363  *
364  * @attention Defined in util.c
365  */
366 int IMB_isanim(const char *name);
367
368 /**
369  *
370  * @attention Defined in util.c
371  */
372 int imb_get_anim_type(const char *name);
373
374 /**
375  *
376  * @attention Defined in divers.c
377  */
378 void IMB_de_interlace(struct ImBuf *ibuf);
379 void IMB_interlace(struct ImBuf *ibuf);
380
381 /* create char buffer, color corrected if necessary, for ImBufs that lack one */ 
382 void IMB_rect_from_float(struct ImBuf *ibuf);
383 /* create char buffer for part of the image, color corrected if necessary,
384    Changed part will be stored in buffer. This is expected to be used for texture painting updates */ 
385 void IMB_partial_rect_from_float(struct ImBuf *ibuf, float *buffer, int x, int y, int w, int h);
386 void IMB_float_from_rect(struct ImBuf *ibuf);
387 void IMB_float_from_rect_simple(struct ImBuf *ibuf); /* no profile conversion */
388 /* note, check that the conversion exists, only some are supported */
389 void IMB_convert_profile(struct ImBuf *ibuf, int profile);
390 float *IMB_float_profile_ensure(struct ImBuf *ibuf, int profile, int *alloc);
391 void IMB_color_to_bw(struct ImBuf *ibuf);
392
393 /**
394  * Change the ordering of the color bytes pointed to by rect from
395  * rgba to abgr. size * 4 color bytes are reordered.
396  *
397  * @attention Defined in imageprocess.c
398  */
399 void IMB_convert_rgba_to_abgr(struct ImBuf *ibuf);
400
401 /**
402  * Change the ordering of the color bytes pointed to by rect from
403  * rgba to abgr. size * 4 color bytes are reordered.
404  *
405  * @attention Defined in imageprocess.c
406  */
407 void IMB_convert_bgra_to_rgba(int size, unsigned int *rect);
408
409 /**
410  *
411  * @attention defined in imageprocess.c
412  */
413 void bicubic_interpolation(struct ImBuf *in, struct ImBuf *out, float u, float v, int xout, int yout);
414 void neareast_interpolation(struct ImBuf *in, struct ImBuf *out, float u, float v, int xout, int yout);
415 void bilinear_interpolation(struct ImBuf *in, struct ImBuf *out, float u, float v, int xout, int yout);
416
417 void bicubic_interpolation_color(struct ImBuf *in, unsigned char *col, float *col_float, float u, float v);
418 void neareast_interpolation_color(struct ImBuf *in, unsigned char *col, float *col_float, float u, float v);
419 void bilinear_interpolation_color(struct ImBuf *in, unsigned char *col, float *col_float, float u, float v);
420 void bilinear_interpolation_color_wrap(struct ImBuf *in, unsigned char *col, float *col_float, float u, float v);
421
422 /**
423  *
424  * @attention defined in readimage.c
425  * @deprecated Only here for backwards compatibility of the
426  * @deprecated plugin system.
427  */
428 struct ImBuf *IMB_loadiffmem(int *mem, int flags);
429
430 /**
431  *
432  * @attention defined in readimage.c
433  * @deprecated Only here for backwards compatibility of the
434  * @deprecated plugin system.
435  */  
436 struct ImBuf *IMB_loadifffile(int file, int flags);
437
438 /**
439  *
440  * @attention defined in scaling.c
441  */
442 struct ImBuf *IMB_half_x(struct ImBuf *ibuf1);
443
444 /**
445  *
446  * @attention defined in scaling.c
447  */
448 struct ImBuf *IMB_double_fast_x(struct ImBuf *ibuf1);
449
450 /**
451  *
452  * @attention defined in scaling.c
453  */
454 struct ImBuf *IMB_double_x(struct ImBuf *ibuf1);
455
456 /**
457  *
458  * @attention defined in scaling.c
459  */
460 struct ImBuf *IMB_half_y(struct ImBuf *ibuf1);
461
462 /**
463  *
464  * @attention defined in scaling.c
465  */
466 struct ImBuf *IMB_double_fast_y(struct ImBuf *ibuf1);
467
468 /**
469  *
470  * @attention defined in scaling.c
471  */
472 struct ImBuf *IMB_double_y(struct ImBuf *ibuf1);
473
474 /**
475  *
476  * @attention Defined in rotate.c
477  */
478 void IMB_flipx(struct ImBuf *ibuf);
479 void IMB_flipy(struct ImBuf *ibuf);
480
481 /* Premultiply alpha */
482
483 void IMB_premultiply_alpha(struct ImBuf *ibuf);
484
485 /**
486  *
487  * @attention Defined in allocimbuf.c
488  */
489 void IMB_freezbufImBuf(struct ImBuf *ibuf);
490 void IMB_freezbuffloatImBuf(struct ImBuf *ibuf);
491
492 /**
493  *
494  * @attention Defined in rectop.c
495  */
496 void IMB_rectfill(struct ImBuf *drect, const float col[4]);
497 void IMB_rectfill_area(struct ImBuf *ibuf, float *col, int x1, int y1, int x2, int y2);
498 void IMB_rectfill_alpha(struct ImBuf *ibuf, const float value);
499
500 /* this should not be here, really, we needed it for operating on render data, IMB_rectfill_area calls it */
501 void buf_rectfill_area(unsigned char *rect, float *rectf, int width, int height, float *col, int x1, int y1, int x2, int y2);
502
503 /* defined in metadata.c */
504 int IMB_metadata_change_field(struct ImBuf *img, const char *key, const char *field);
505
506 /* exported for image tools in blender, to quickly allocate 32 bits rect */
507 short imb_addrectImBuf(struct ImBuf *ibuf);
508 void imb_freerectImBuf(struct ImBuf *ibuf);
509
510 short imb_addrectfloatImBuf(struct ImBuf *ibuf);
511 void imb_freerectfloatImBuf(struct ImBuf *ibuf);
512 void imb_freemipmapImBuf(struct ImBuf *ibuf);
513
514 short imb_addtilesImBuf(struct ImBuf *ibuf);
515 void imb_freetilesImBuf(struct ImBuf *ibuf);
516
517 #endif
518