New stuff & fixes in Blender OSA filtering.
[blender.git] / source / blender / imbuf / IMB_imbuf.h
1 /**
2  * @file IMB_imbuf.h
3  * @brief IMage Buffer module.
4  *
5  * This module offers import/export of several graphical file formats.
6  * \ref IMB
7  * @ingroup imbuf
8  * @ingroup undoc
9  *
10  * @page IMB - Imbuf module external interface
11  *
12  *
13  * @section about About the IMB module
14  *
15  * External interface of the IMage Buffer module. This module offers
16  * import/export of several graphical file formats. It offers the
17  * ImBuf type as a common structure to refer to different graphical
18  * file formats, and to enable a uniform way of handling them.
19  *
20  * @section issues Known issues with IMB
21  *
22  * - imbuf is written in C.
23  * - Endianness issues are dealt with internally.
24  * - File I/O must be done externally. The module uses FILE*'s to
25  *   direct input/output.
26  * - Platform dependency is limited. Some minor patches for
27  *   amiga and Irix are present. A 'posix-compliancy-patch'
28  *   provides the interface to windows.
29  *
30  * @section dependencies Dependencies
31  *
32  * IMB needs:
33  * - SDNA module
34  *     The listbase types are used for handling the memory
35  *     management.
36  * - blenlib module
37  *     blenlib handles guarded memory management in blender-style.
38  *     BLI_winstuff.h makes a few windows specific behaviours
39  *     posix-compliant.
40  * - avi
41  *     avi defines import/export to the avi format. Only anim.c
42  *     needs this. It uses the following functions:
43  *       - avi_close
44  *       - avi_is_avi
45  *       - avi_print_error
46  *       - avi_open_movie
47  *       - avi_read_frame
48  *       - avi_get_stream
49  *     Additionally, it needs the types from the avi module.
50  * - external jpeg library
51  *     The jpeg lib defines import/export to the jpeg format.
52  *     only jpeg.c needs these. Used functions are:
53  *       - jpeg_destroy
54  *       - jpeg_resync_to_restart
55  *       - jpeg_set_marker_processor
56  *       - jpeg_read_header
57  *       - jpeg_start_decompress
58  *       - jpeg_abort_decompress
59  *       - jpeg_read_scanlines
60  *       - jpeg_finish_decompress
61  *       - jpeg_std_error
62  *       - jpeg_create_decompress
63  *       - jpeg_stdio_src
64  *       - jpeg_start_compress
65  *       - jpeg_write_marker
66  *       - jpeg_write_scanlines
67  *       - jpeg_finish_compress
68  *       - jpeg_create_compress
69  *       - jpeg_stdio_dest
70  *       - jpeg_set_defaults
71  *       - jpeg_set_quality
72  *       - jpeg_destroy_compress
73  *     Additionally, it needs the types from the jpeg lib.
74  */
75 /*
76  * $Id$ 
77  *
78  * ***** BEGIN GPL/BL DUAL LICENSE BLOCK *****
79  *
80  * This program is free software; you can redistribute it and/or
81  * modify it under the terms of the GNU General Public License
82  * as published by the Free Software Foundation; either version 2
83  * of the License, or (at your option) any later version. The Blender
84  * Foundation also sells licenses for use in proprietary software under
85  * the Blender License.  See http://www.blender.org/BL/ for information
86  * about this.
87  *
88  * This program is distributed in the hope that it will be useful,
89  * but WITHOUT ANY WARRANTY; without even the implied warranty of
90  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
91  * GNU General Public License for more details.
92  *
93  * You should have received a copy of the GNU General Public License
94  * along with this program; if not, write to the Free Software Foundation,
95  * Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
96  *
97  * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
98  * All rights reserved.
99  *
100  * The Original Code is: all of this file.
101  *
102  * Contributor(s): none yet.
103  *
104  * ***** END GPL/BL DUAL LICENSE BLOCK *****
105  */
106 #ifndef IMB_IMBUF_H
107 #define IMB_IMBUF_H
108
109 /**
110  *
111  * @attention defined in ???
112  */
113 struct ImBuf;
114
115 /**
116  *
117  * @attention defined in ???
118  */
119 struct anim;
120
121 /**
122  *
123  * @attention Defined in cmap.c
124  */
125 void IMB_freeImBufdata(void);
126
127 /**
128  *
129  * @attention Defined in cmap.c
130  */
131 void IMB_applycmap(struct ImBuf *ibuf);
132
133 /**
134  *
135  * @attention Defined in cmap.c
136  */
137 short IMB_converttocmap(struct ImBuf *ibuf);
138
139 /**
140  *
141  * @attention Defined in cmap.c
142  */
143 int IMB_alpha_to_col0(int value);
144
145 /**
146  *
147  * @attention Defined in readimage.c
148  */
149 struct ImBuf *IMB_ibImageFromMemory(int *mem, int size, int flags);
150
151 /**
152  *
153  * @attention Defined in readimage.c
154  */
155 struct ImBuf *IMB_testiffname(char *naam,int flags);
156
157 /**
158  *
159  * @attention Defined in readimage.c
160  */
161 struct ImBuf *IMB_loadiffname(char *naam, int flags);
162
163 /**
164  *
165  * @attention Defined in allocimbuf.c
166  */
167 void IMB_freeImBuf(struct ImBuf * ibuf);
168
169 /**
170  *
171  * @attention Defined in allocimbuf.c
172  */
173 struct ImBuf *IMB_allocImBuf(short x, short y,
174                                                  unsigned char d, unsigned int flags,
175                                                  unsigned char bitmap);
176
177 /**
178  *
179  * @attention Defined in allocimbuf.c
180  */
181 struct ImBuf *IMB_dupImBuf(struct ImBuf *ibuf1);
182
183 /**
184  *
185  * @attention Defined in allocimbuf.c
186  */
187 short addzbufImBuf(struct ImBuf * ibuf);
188
189 /**
190  *
191  * @attention Defined in allocimbuf.c
192  */
193 void IMB_freecmapImBuf(struct ImBuf * ibuf);
194
195 /**
196  *
197  * @attention Defined in rectop.c
198  */
199 void IMB_rectop(struct ImBuf *dbuf,
200                         struct ImBuf *sbuf,
201                         int destx,
202                         int desty,
203                         int srcx,
204                         int srcy,
205                         int width,
206                         int height,
207                         void (*operation)(unsigned int *, unsigned int*, int, int),
208                         int value);
209
210 /**
211  *
212  * @attention Defined in rectop.c
213  */
214 void IMB_rectoptot(struct ImBuf *dbuf,
215                            struct ImBuf *sbuf,
216                            void (*operation)(unsigned int *, unsigned int*, int, int),
217                            int value);
218
219 /**
220  *
221  * @attention Defined in rectop.c
222  */
223 void IMB_rectcpy(unsigned int *drect, unsigned int *srect, int x, int dummy);
224
225 /**
226  * Return the length (in frames) of the given @a anim.
227  */
228 int IMB_anim_get_duration(struct anim *anim);
229
230 /**
231  *
232  * @attention Defined in anim.c
233  */
234 struct anim * IMB_open_anim(char * name, int ib_flags);
235 void IMB_close_anim(struct anim * anim);
236
237 /**
238  *
239  * @attention Defined in anim.c
240  */
241
242 int ismovie(char *name);
243
244 /**
245  *
246  * @attention Defined in anim.c
247  */
248
249 struct ImBuf * IMB_anim_absolute(struct anim * anim, int position);
250
251 /**
252  *
253  * @attention Defined in anim.c
254  */
255 void IMB_free_anim_ibuf(struct anim * anim);
256
257 /**
258  *
259  * @attention Defined in anim.c
260  */
261 void IMB_free_anim(struct anim * anim);
262
263 /**
264  *
265  * @attention Defined in anim.c
266  */
267 struct ImBuf * IMB_anim_nextpic(struct anim * anim);     
268
269
270 /**
271  *
272  * @attention Defined in antialias.c
273  */
274 void IMB_clever_double (struct ImBuf * ibuf);
275
276 /**
277  *
278  * @attention Defined in antialias.c
279  */
280 void IMB_antialias(struct ImBuf * ibuf);
281
282 /**
283  *
284  * @attention Defined in filter.c
285  */
286 void IMB_filter(struct ImBuf *ibuf);
287
288 /**
289  *
290  * @attention Defined in filter.c
291  */
292 void IMB_filtery(struct ImBuf *ibuf);
293
294 /**
295  *
296  * @attention Defined in scaling.c
297  */
298 struct ImBuf *IMB_onehalf(struct ImBuf *ibuf1);
299
300 /**
301  *
302  * @attention Defined in scaling.c
303  */
304 struct ImBuf *IMB_scaleImBuf(struct ImBuf * ibuf, short newx, short newy);
305
306 /**
307  *
308  * @attention Defined in scaling.c
309  */
310 struct ImBuf *IMB_scalefieldImBuf(struct ImBuf *ibuf, short newx, short newy);
311
312 /**
313  *
314  * @attention Defined in scaling.c
315  */
316 struct ImBuf *IMB_scalefastImBuf(struct ImBuf *ibuf, short newx, short newy);
317
318 /**
319  *
320  * @attention Defined in writeimage.c
321  */
322 short IMB_saveiff(struct ImBuf *ibuf,char *naam,int flags);
323
324 /**
325  * Encodes a png image from an ImBuf
326  *
327  * @attention Defined in png_encode.c
328  */
329 short IMB_png_encode(struct ImBuf *ibuf, int file, int flags);
330
331 /**
332  *
333  * @attention Defined in util.c
334  */
335 int IMB_ispic(char *name);
336
337 /**
338  *
339  * @attention Defined in util.c
340  */
341 int IMB_isanim(char * name);
342
343 /**
344  *
345  * @attention Defined in util.c
346  */
347 int imb_get_anim_type(char * name);
348
349 /**
350  *
351  * @attention Defined in divers.c
352  */
353 void IMB_de_interlace(struct ImBuf *ibuf);
354 void IMB_interlace(struct ImBuf *ibuf);
355 void IMB_gamwarp(struct ImBuf *ibuf, double gamma);
356
357 /**
358  * Change the ordering of the colour bytes pointed to by rect from
359  * rgba to abgr. size * 4 colour bytes are reordered.
360  *
361  * @attention Defined in imageprocess.c
362  */
363 void IMB_convert_rgba_to_abgr(int size, unsigned int *rect);
364
365 /**
366  * Change the ordering of the colour bytes pointed to by rect from
367  * rgba to abgr. size * 4 colour bytes are reordered.
368  *
369  * @attention Defined in imageprocess.c
370  */
371 void IMB_convert_bgra_to_rgba(int size, unsigned int *rect);
372
373 /**
374  *
375  * @attention defined in scaling.c
376  */
377 struct ImBuf *IMB_scalefastfieldImBuf(struct ImBuf *ibuf,
378                                                                           short newx,
379                                                                           short newy);
380
381 /**
382  *
383  * @attention defined in readimage.c
384  * @deprecated Only here for backwards compatibility of the
385  * @deprecated plugin system.
386  */
387 struct ImBuf *IMB_loadiffmem(int *mem, int flags);
388
389 /**
390  *
391  * @attention defined in readimage.c
392  * @deprecated Only here for backwards compatibility of the
393  * @deprecated plugin system.
394  */  
395 struct ImBuf *IMB_loadifffile(int file, int flags);
396
397 /**
398  *
399  * @attention defined in scaling.c
400  */
401 struct ImBuf *IMB_half_x(struct ImBuf *ibuf1);
402
403 /**
404  *
405  * @attention defined in scaling.c
406  */
407 struct ImBuf *IMB_double_fast_x(struct ImBuf *ibuf1);
408
409 /**
410  *
411  * @attention defined in scaling.c
412  */
413 struct ImBuf *IMB_double_x(struct ImBuf *ibuf1);
414
415 /**
416  *
417  * @attention defined in scaling.c
418  */
419 struct ImBuf *IMB_half_y(struct ImBuf *ibuf1);
420
421 /**
422  *
423  * @attention defined in scaling.c
424  */
425 struct ImBuf *IMB_double_fast_y(struct ImBuf *ibuf1);
426
427 /**
428  *
429  * @attention defined in scaling.c
430  */
431 struct ImBuf *IMB_double_y(struct ImBuf *ibuf1);
432
433 /**
434  *
435  * @attention defined in scaling.c
436  */
437 struct ImBuf *IMB_onethird(struct ImBuf *ibuf1);
438
439 /**
440  *
441  * @attention defined in scaling.c
442  */
443 struct ImBuf *IMB_halflace(struct ImBuf *ibuf1);
444
445 /**
446  *
447  * @attention defined in dither.c
448  */
449 void IMB_dit2(struct ImBuf * ibuf, short ofs, short bits);
450
451 /**
452  *
453  * @attention defined in dither.c
454  */
455 void IMB_dit0(struct ImBuf * ibuf, short ofs, short bits);
456
457 /** Externally used vars: fortunately they do not use funny types */
458
459 /**
460  * boolean toggle that tells whether or not to
461  * scale the colour map in the y-direction.
462  *
463  * @attention declared in hamx.c
464  */
465 extern int scalecmapY;
466
467 /**
468  * This 'matrix' defines the transformation from rgb to bw colour
469  * maps. You need to do a sort of dot-product for that. It is a matrix
470  * with fixed coefficients, extracted from some book.
471  *
472  * @attention Defined in matrix.h, only included in hamx.c
473  */
474 extern float rgb_to_bw[4][4]; 
475
476 /**
477  *
478  * @attention Defined in rotate.c
479  */
480 void IMB_flipy(struct ImBuf * ibuf);
481
482 /**
483  *
484  * @attention Defined in cspace.c
485  */
486 void IMB_cspace(struct ImBuf *ibuf, float mat[][4]);
487
488 /**
489  *
490  * @attention Defined in allocimbuf.c
491  */
492 void IMB_freezbufImBuf(struct ImBuf * ibuf);
493
494 /**
495  *
496  * @attention Defined in rectop.c
497  */
498 void IMB_rectfill(unsigned int *drect, unsigned int *srect, int x, int value);
499
500
501 #ifdef WITH_QUICKTIME
502 /**
503  *
504  * @attention Defined in quicktime_import.c
505  */
506 void quicktime_init(void);
507
508 /**
509  *
510  * @attention Defined in quicktime_import.c
511  */
512 void quicktime_exit(void);
513
514 #endif //WITH_QUICKTIME
515
516 /* radhdr: Temporary routine to save directly from render floatbuffer.
517    Defined in radiance_hdr.c
518    Called by schrijfplaatje() in toets.c */
519 short imb_savehdr_fromfloat(float *fbuf, char *name, int width, int height);
520
521 /* intern/dynlibtiff.c */
522 void libtiff_exit(void);
523
524 #endif