Orange: more exr & imbuf cleanup
[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_rectcpy(struct ImBuf *drect, struct ImBuf *srect, int destx,
200         int desty, int srcx, int srcy, int width, int height);
201
202 /**
203  * Return the length (in frames) of the given @a anim.
204  */
205 int IMB_anim_get_duration(struct anim *anim);
206
207 /**
208  *
209  * @attention Defined in anim.c
210  */
211 struct anim * IMB_open_anim(char * name, int ib_flags);
212 void IMB_close_anim(struct anim * anim);
213
214 /**
215  *
216  * @attention Defined in anim.c
217  */
218
219 int ismovie(char *name);
220
221 /**
222  *
223  * @attention Defined in anim.c
224  */
225
226 struct ImBuf * IMB_anim_absolute(struct anim * anim, int position);
227
228 /**
229  *
230  * @attention Defined in anim.c
231  */
232 void IMB_free_anim_ibuf(struct anim * anim);
233
234 /**
235  *
236  * @attention Defined in anim.c
237  */
238 void IMB_free_anim(struct anim * anim);
239
240 /**
241  *
242  * @attention Defined in anim.c
243  */
244 struct ImBuf * IMB_anim_nextpic(struct anim * anim);     
245
246
247 /**
248  *
249  * @attention Defined in antialias.c
250  */
251 void IMB_clever_double (struct ImBuf * ibuf);
252
253 /**
254  *
255  * @attention Defined in antialias.c
256  */
257 void IMB_antialias(struct ImBuf * ibuf);
258
259 /**
260  *
261  * @attention Defined in filter.c
262  */
263 void IMB_filter(struct ImBuf *ibuf);
264
265 /**
266  *
267  * @attention Defined in filter.c
268  */
269 void IMB_filtery(struct ImBuf *ibuf);
270
271 /**
272  *
273  * @attention Defined in scaling.c
274  */
275 struct ImBuf *IMB_onehalf(struct ImBuf *ibuf1);
276
277 /**
278  *
279  * @attention Defined in scaling.c
280  */
281 struct ImBuf *IMB_scaleImBuf(struct ImBuf * ibuf, short newx, short newy);
282
283 /**
284  *
285  * @attention Defined in scaling.c
286  */
287 struct ImBuf *IMB_scalefieldImBuf(struct ImBuf *ibuf, short newx, short newy);
288
289 /**
290  *
291  * @attention Defined in scaling.c
292  */
293 struct ImBuf *IMB_scalefastImBuf(struct ImBuf *ibuf, short newx, short newy);
294
295 /**
296  *
297  * @attention Defined in writeimage.c
298  */
299 short IMB_saveiff(struct ImBuf *ibuf,char *naam,int flags);
300
301 /**
302  * Encodes a png image from an ImBuf
303  *
304  * @attention Defined in png_encode.c
305  */
306 short IMB_png_encode(struct ImBuf *ibuf, int file, int flags);
307
308 /**
309  *
310  * @attention Defined in util.c
311  */
312 int IMB_ispic(char *name);
313
314 /**
315  *
316  * @attention Defined in util.c
317  */
318 int IMB_isanim(char * name);
319
320 /**
321  *
322  * @attention Defined in util.c
323  */
324 int imb_get_anim_type(char * name);
325
326 /**
327  *
328  * @attention Defined in divers.c
329  */
330 void IMB_de_interlace(struct ImBuf *ibuf);
331 void IMB_interlace(struct ImBuf *ibuf);
332 void IMB_gamwarp(struct ImBuf *ibuf, double gamma);
333 void IMB_rect_from_float(struct ImBuf *ibuf);
334
335 /**
336  * Change the ordering of the colour bytes pointed to by rect from
337  * rgba to abgr. size * 4 colour bytes are reordered.
338  *
339  * @attention Defined in imageprocess.c
340  */
341 void IMB_convert_rgba_to_abgr(struct ImBuf *ibuf);
342
343 /**
344  * Change the ordering of the colour bytes pointed to by rect from
345  * rgba to abgr. size * 4 colour bytes are reordered.
346  *
347  * @attention Defined in imageprocess.c
348  */
349 void IMB_convert_bgra_to_rgba(int size, unsigned int *rect);
350
351 /**
352  *
353  * @attention defined in scaling.c
354  */
355 struct ImBuf *IMB_scalefastfieldImBuf(struct ImBuf *ibuf,
356                                                                           short newx,
357                                                                           short newy);
358
359 /**
360  *
361  * @attention defined in readimage.c
362  * @deprecated Only here for backwards compatibility of the
363  * @deprecated plugin system.
364  */
365 struct ImBuf *IMB_loadiffmem(int *mem, int flags);
366
367 /**
368  *
369  * @attention defined in readimage.c
370  * @deprecated Only here for backwards compatibility of the
371  * @deprecated plugin system.
372  */  
373 struct ImBuf *IMB_loadifffile(int file, int flags);
374
375 /**
376  *
377  * @attention defined in scaling.c
378  */
379 struct ImBuf *IMB_half_x(struct ImBuf *ibuf1);
380
381 /**
382  *
383  * @attention defined in scaling.c
384  */
385 struct ImBuf *IMB_double_fast_x(struct ImBuf *ibuf1);
386
387 /**
388  *
389  * @attention defined in scaling.c
390  */
391 struct ImBuf *IMB_double_x(struct ImBuf *ibuf1);
392
393 /**
394  *
395  * @attention defined in scaling.c
396  */
397 struct ImBuf *IMB_half_y(struct ImBuf *ibuf1);
398
399 /**
400  *
401  * @attention defined in scaling.c
402  */
403 struct ImBuf *IMB_double_fast_y(struct ImBuf *ibuf1);
404
405 /**
406  *
407  * @attention defined in scaling.c
408  */
409 struct ImBuf *IMB_double_y(struct ImBuf *ibuf1);
410
411 /**
412  *
413  * @attention defined in scaling.c
414  */
415 struct ImBuf *IMB_onethird(struct ImBuf *ibuf1);
416
417 /**
418  *
419  * @attention defined in scaling.c
420  */
421 struct ImBuf *IMB_halflace(struct ImBuf *ibuf1);
422
423 /**
424  *
425  * @attention defined in dither.c
426  */
427 void IMB_dit2(struct ImBuf * ibuf, short ofs, short bits);
428
429 /**
430  *
431  * @attention defined in dither.c
432  */
433 void IMB_dit0(struct ImBuf * ibuf, short ofs, short bits);
434
435 /** Externally used vars: fortunately they do not use funny types */
436
437 /**
438  * boolean toggle that tells whether or not to
439  * scale the colour map in the y-direction.
440  *
441  * @attention declared in hamx.c
442  */
443 extern int scalecmapY;
444
445 /**
446  * This 'matrix' defines the transformation from rgb to bw colour
447  * maps. You need to do a sort of dot-product for that. It is a matrix
448  * with fixed coefficients, extracted from some book.
449  *
450  * @attention Defined in matrix.h, only included in hamx.c
451  */
452 extern float rgb_to_bw[4][4]; 
453
454 /**
455  *
456  * @attention Defined in rotate.c
457  */
458 void IMB_flipy(struct ImBuf * ibuf);
459
460 /**
461  *
462  * @attention Defined in cspace.c
463  */
464 void IMB_cspace(struct ImBuf *ibuf, float mat[][4]);
465
466 /**
467  *
468  * @attention Defined in allocimbuf.c
469  */
470 void IMB_freezbufImBuf(struct ImBuf * ibuf);
471
472 /**
473  *
474  * @attention Defined in rectop.c
475  */
476 void IMB_rectfill(struct ImBuf *drect, float col[4]);
477
478
479 #ifdef WITH_QUICKTIME
480 /**
481  *
482  * @attention Defined in quicktime_import.c
483  */
484 void quicktime_init(void);
485
486 /**
487  *
488  * @attention Defined in quicktime_import.c
489  */
490 void quicktime_exit(void);
491
492 #endif //WITH_QUICKTIME
493
494 /* intern/dynlibtiff.c */
495 void libtiff_exit(void);
496
497 #endif