Multi-View and Stereo 3D
[blender-staging.git] / source / blender / imbuf / IMB_imbuf.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
28 /** \file blender/imbuf/IMB_imbuf.h
29  *  \ingroup imbuf
30  */
31
32 /**
33  * \brief IMage Buffer module.
34  *
35  * This module offers import/export of several graphical file formats.
36  * \ingroup imbuf
37  *
38  * \page IMB Imbuf module external interface
39  *
40  *
41  * \section about About the IMB module
42  *
43  * External interface of the IMage Buffer module. This module offers
44  * import/export of several graphical file formats. It offers the
45  * ImBuf type as a common structure to refer to different graphical
46  * file formats, and to enable a uniform way of handling them.
47  *
48  * \section issues Known issues with IMB
49  *
50  * - imbuf is written in C.
51  * - Endianness issues are dealt with internally.
52  * - File I/O must be done externally. The module uses FILE*'s to
53  *   direct input/output.
54  *
55  * \section dependencies Dependencies
56  *
57  * IMB needs:
58  * - \ref DNA module
59  *     The listbase types are used for handling the memory
60  *     management.
61  * - \ref blenlib module
62  *     blenlib handles guarded memory management in blender-style.
63  *     BLI_winstuff.h makes a few windows specific behaviors
64  *     posix-compliant.
65  */
66
67 #ifndef __IMB_IMBUF_H__
68 #define __IMB_IMBUF_H__
69
70 #define IM_MAX_SPACE 64
71
72 /* for bool */
73 #include "../blenlib/BLI_sys_types.h"
74
75 /**
76  *
77  * \attention defined in ???
78  */
79 struct ImBuf;
80
81 /**
82  *
83  * \attention defined in ???
84  */
85 struct anim;
86
87 struct ColorManagedDisplay;
88
89 struct GSet;
90 /**
91  *
92  * \attention defined in DNA_scene_types.h
93  */
94 struct ImageFormatData;
95 struct Stereo3dFormat;
96
97 /**
98  *
99  * \attention Defined in allocimbuf.c
100  */
101 void IMB_init(void);
102 void IMB_exit(void);
103
104 /**
105  *
106  * \attention Defined in readimage.c
107  */
108 struct ImBuf *IMB_ibImageFromMemory(unsigned char *mem, size_t size, int flags, char colorspace[IM_MAX_SPACE], const char *descr);
109
110 /**
111  *
112  * \attention Defined in readimage.c
113  */
114 struct ImBuf *IMB_testiffname(const char *filepath, int flags);
115
116 /**
117  *
118  * \attention Defined in readimage.c
119  */
120 struct ImBuf *IMB_loadiffname(const char *filepath, int flags, char colorspace[IM_MAX_SPACE]);
121
122 /**
123  *
124  * \attention Defined in allocimbuf.c
125  */
126 void IMB_freeImBuf(struct ImBuf *ibuf);
127
128 /**
129  *
130  * \attention Defined in allocimbuf.c
131  */
132 struct ImBuf *IMB_allocImBuf(unsigned int x, unsigned int y,
133                              unsigned char d, unsigned int flags);
134
135 /**
136  * Create a copy of a pixel buffer and wrap it to a new ImBuf
137  * \attention Defined in allocimbuf.c
138  */
139 struct ImBuf *IMB_allocFromBuffer(const unsigned int *rect, const float *rectf,
140                                   unsigned int w, unsigned int h);
141
142 /**
143  *
144  * Increase reference count to imbuf
145  * (to delete an imbuf you have to call freeImBuf as many times as it
146  * is referenced)
147  *
148  * \attention Defined in allocimbuf.c
149  */
150
151 void IMB_refImBuf(struct ImBuf *ibuf);
152 struct ImBuf *IMB_makeSingleUser(struct ImBuf *ibuf);
153
154 /**
155  *
156  * \attention Defined in allocimbuf.c
157  */
158 struct ImBuf *IMB_dupImBuf(struct ImBuf *ibuf1);
159
160 /**
161  *
162  * \attention Defined in allocimbuf.c
163  */
164 bool addzbufImBuf(struct ImBuf *ibuf);
165 bool addzbuffloatImBuf(struct ImBuf *ibuf);
166
167 /**
168  *
169  * \attention Defined in rectop.c
170  */
171
172 typedef enum IMB_BlendMode {
173         IMB_BLEND_MIX = 0,
174         IMB_BLEND_ADD = 1,
175         IMB_BLEND_SUB = 2,
176         IMB_BLEND_MUL = 3,
177         IMB_BLEND_LIGHTEN = 4,
178         IMB_BLEND_DARKEN = 5,
179         IMB_BLEND_ERASE_ALPHA = 6,
180         IMB_BLEND_ADD_ALPHA = 7,
181         IMB_BLEND_OVERLAY = 8,
182         IMB_BLEND_HARDLIGHT     = 9,
183         IMB_BLEND_COLORBURN     = 10,
184         IMB_BLEND_LINEARBURN = 11,
185         IMB_BLEND_COLORDODGE = 12,
186         IMB_BLEND_SCREEN = 13,
187         IMB_BLEND_SOFTLIGHT     = 14,
188         IMB_BLEND_PINLIGHT = 15,
189         IMB_BLEND_VIVIDLIGHT = 16,
190         IMB_BLEND_LINEARLIGHT = 17,
191         IMB_BLEND_DIFFERENCE = 18,
192         IMB_BLEND_EXCLUSION     = 19,
193         IMB_BLEND_HUE = 20,
194         IMB_BLEND_SATURATION = 21,
195         IMB_BLEND_LUMINOSITY = 22,
196         IMB_BLEND_COLOR = 23,
197
198         IMB_BLEND_COPY = 1000,
199         IMB_BLEND_COPY_RGB = 1001,
200         IMB_BLEND_COPY_ALPHA = 1002
201 } IMB_BlendMode;
202
203 void IMB_blend_color_byte(unsigned char dst[4], unsigned char src1[4],
204         unsigned char src2[4], IMB_BlendMode mode);
205 void IMB_blend_color_float(float dst[4], float src1[4], float src2[4],
206         IMB_BlendMode mode);
207
208 void IMB_rectclip(struct ImBuf *dbuf, struct ImBuf *sbuf, int *destx, 
209         int *desty, int *srcx, int *srcy, int *width, int *height);
210 void IMB_rectcpy(struct ImBuf *drect, struct ImBuf *srect, int destx,
211         int desty, int srcx, int srcy, int width, int height);
212 void IMB_rectblend(struct ImBuf *dbuf, struct ImBuf *obuf, struct ImBuf *sbuf,
213         unsigned short *dmask, unsigned short *curvemask, unsigned short *mmask, float mask_max,
214         int destx,  int desty, int origx, int origy, int srcx, int srcy,
215         int width, int height, IMB_BlendMode mode, bool accumulate);
216
217 /**
218  *
219  * \attention Defined in indexer.c
220  */
221
222 typedef enum IMB_Timecode_Type {
223         IMB_TC_NONE       = 0, /* don't use timecode files at all */
224
225         IMB_TC_RECORD_RUN = 1, /* use images in the order as they are recorded
226                                 * (currently, this is the only one implemented
227                                 * and is a sane default) */
228
229         IMB_TC_FREE_RUN   = 2, /* use global timestamp written by recording
230                             * device (prosumer camcorders e.g. can do that) */
231         IMB_TC_INTERPOLATED_REC_DATE_FREE_RUN = 4, /* interpolate a global timestamp using the
232                                                     * record date and time written by recording
233                                                     * device (*every* consumer camcorder can do
234                                                     * that :) )*/
235         IMB_TC_RECORD_RUN_NO_GAPS = 8,
236         IMB_TC_MAX_SLOT   = 4
237 } IMB_Timecode_Type;
238
239 typedef enum IMB_Proxy_Size {
240         IMB_PROXY_NONE = 0,
241         IMB_PROXY_25 = 1,
242         IMB_PROXY_50 = 2,
243         IMB_PROXY_75 = 4,
244         IMB_PROXY_100 = 8,
245         IMB_PROXY_MAX_SLOT = 4
246 } IMB_Proxy_Size;
247
248 /* defaults to BL_proxy within the directory of the animation */
249 void IMB_anim_set_index_dir(struct anim *anim, const char *dir);
250 void IMB_anim_get_fname(struct anim *anim, char *file, int size);
251
252 int IMB_anim_index_get_frame_index(struct anim *anim, IMB_Timecode_Type tc,
253                                    int position);
254
255 IMB_Proxy_Size IMB_anim_proxy_get_existing(struct anim *anim);
256
257 struct IndexBuildContext;
258
259 /* prepare context for proxies/imecodes builder */
260 struct IndexBuildContext *IMB_anim_index_rebuild_context(struct anim *anim, IMB_Timecode_Type tcs_in_use,
261                                                          IMB_Proxy_Size proxy_sizes_in_use, int quality,
262                                                          const bool overwite, struct GSet *file_list);
263
264 /* will rebuild all used indices and proxies at once */
265 void IMB_anim_index_rebuild(struct IndexBuildContext *context,
266                             short *stop, short *do_update, float *progress);
267
268 /* finish rebuilding proxises/timecodes and free temporary contexts used */
269 void IMB_anim_index_rebuild_finish(struct IndexBuildContext *context, short stop);
270
271 /**
272  * Return the length (in frames) of the given \a anim.
273  */
274 int IMB_anim_get_duration(struct anim *anim, IMB_Timecode_Type tc);
275
276
277 /**
278  * Return the fps contained in movie files (function rval is false,
279  * and frs_sec and frs_sec_base untouched if none available!)
280  */
281 bool IMB_anim_get_fps(struct anim *anim,
282                       short *frs_sec, float *frs_sec_base);
283
284 /**
285  *
286  * \attention Defined in anim_movie.c
287  */
288 struct anim *IMB_open_anim(const char *name, int ib_flags, int streamindex, char colorspace[IM_MAX_SPACE]);
289 void IMB_suffix_anim(struct anim *anim, const char *suffix);
290 void IMB_close_anim(struct anim *anim);
291 void IMB_close_anim_proxies(struct anim *anim);
292
293 /**
294  *
295  * \attention Defined in anim_movie.c
296  */
297
298 int ismovie(const char *filepath);
299 void IMB_anim_set_preseek(struct anim *anim, int preseek);
300 int IMB_anim_get_preseek(struct anim *anim);
301
302 /**
303  *
304  * \attention Defined in anim_movie.c
305  */
306
307 struct ImBuf *IMB_anim_absolute(
308         struct anim *anim, int position,
309         IMB_Timecode_Type tc        /* = 1 = IMB_TC_RECORD_RUN */, 
310         IMB_Proxy_Size preview_size /* = 0 = IMB_PROXY_NONE */);
311
312 /**
313  *
314  * \attention Defined in anim_movie.c
315  * fetches a define previewframe, usually half way into the movie
316  */
317 struct ImBuf *IMB_anim_previewframe(struct anim *anim);
318
319 /**
320  *
321  * \attention Defined in anim_movie.c
322  */
323 void IMB_free_anim(struct anim *anim);
324
325 /**
326  *
327  * \attention Defined in filter.c
328  */
329
330 #define FILTER_MASK_NULL                0
331 #define FILTER_MASK_MARGIN              1
332 #define FILTER_MASK_USED                2
333
334 void IMB_filter(struct ImBuf *ibuf);
335 void IMB_filterN(struct ImBuf *out, struct ImBuf *in);
336 void IMB_mask_filter_extend(char *mask, int width, int height);
337 void IMB_mask_clear(struct ImBuf *ibuf, char *mask, int val);
338 void IMB_filter_extend(struct ImBuf *ibuf, char *mask, int filter);
339 void IMB_makemipmap(struct ImBuf *ibuf, int use_filter);
340 void IMB_remakemipmap(struct ImBuf *ibuf, int use_filter);
341 struct ImBuf *IMB_getmipmap(struct ImBuf *ibuf, int level);
342
343 /**
344  *
345  * \attention Defined in cache.c
346  */
347
348 void IMB_tile_cache_params(int totthread, int maxmem);
349 unsigned int *IMB_gettile(struct ImBuf *ibuf, int tx, int ty, int thread);
350 void IMB_tiles_to_rect(struct ImBuf *ibuf);
351
352 /**
353  *
354  * \attention Defined in filter.c
355  */
356 void IMB_filtery(struct ImBuf *ibuf);
357
358 /**
359  *
360  * \attention Defined in scaling.c
361  */
362 struct ImBuf *IMB_onehalf(struct ImBuf *ibuf1);
363
364 /**
365  *
366  * \attention Defined in scaling.c
367  */
368 struct ImBuf *IMB_scaleImBuf(struct ImBuf *ibuf, unsigned int newx, unsigned int newy);
369
370 /**
371  *
372  * \attention Defined in scaling.c
373  */
374 struct ImBuf *IMB_scalefastImBuf(struct ImBuf *ibuf, unsigned int newx, unsigned int newy);
375
376 /**
377  *
378  * \attention Defined in scaling.c
379  */
380 void IMB_scaleImBuf_threaded(struct ImBuf *ibuf, unsigned int newx, unsigned int newy);
381
382 /**
383  *
384  * \attention Defined in writeimage.c
385  */
386 short IMB_saveiff(struct ImBuf *ibuf, const char *filepath, int flags);
387 struct ImBuf *IMB_prepare_write_ImBuf(const bool isfloat, struct ImBuf *ibuf);
388
389 /**
390  *
391  * \attention Defined in util.c
392  */
393 bool IMB_ispic(const char *name);
394 int  IMB_ispic_type(const char *name);
395
396 /**
397  *
398  * \attention Defined in util.c
399  */
400 bool IMB_isanim(const char *name);
401
402 /**
403  *
404  * \attention Defined in util.c
405  */
406 int imb_get_anim_type(const char *name);
407
408 /**
409  *
410  * \attention Defined in util.c
411  */
412 bool IMB_isfloat(struct ImBuf *ibuf);
413
414 /**
415  *
416  * \attention Defined in divers.c
417  */
418 void IMB_de_interlace(struct ImBuf *ibuf);
419 void IMB_interlace(struct ImBuf *ibuf);
420
421 /* create char buffer, color corrected if necessary, for ImBufs that lack one */ 
422 void IMB_rect_from_float(struct ImBuf *ibuf);
423 /* Create char buffer for part of the image, color corrected if necessary,
424  * Changed part will be stored in buffer. This is expected to be used for texture painting updates */
425 void IMB_partial_rect_from_float(struct ImBuf *ibuf, float *buffer, int x, int y, int w, int h, bool is_data);
426 void IMB_float_from_rect(struct ImBuf *ibuf);
427 void IMB_color_to_bw(struct ImBuf *ibuf);
428 void IMB_saturation(struct ImBuf *ibuf, float sat);
429
430 /* converting pixel buffers */
431 void IMB_buffer_byte_from_float(unsigned char *rect_to, const float *rect_from,
432         int channels_from, float dither, int profile_to, int profile_from, bool predivide,
433         int width, int height, int stride_to, int stride_from);
434 void IMB_buffer_byte_from_float_mask(unsigned char *rect_to, const float *rect_from,
435         int channels_from, float dither, bool predivide,
436         int width, int height, int stride_to, int stride_from, char *mask);
437 void IMB_buffer_float_from_byte(float *rect_to, const unsigned char *rect_from,
438         int profile_to, int profile_from, bool predivide,
439         int width, int height, int stride_to, int stride_from);
440 void IMB_buffer_float_from_float(float *rect_to, const float *rect_from,
441         int channels_from, int profile_to, int profile_from, bool predivide,
442         int width, int height, int stride_to, int stride_from);
443 void IMB_buffer_float_from_float_mask(float *rect_to, const float *rect_from,
444         int channels_from, int width, int height, int stride_to, int stride_from, char *mask);
445 void IMB_buffer_byte_from_byte(unsigned char *rect_to, const unsigned char *rect_from,
446         int profile_to, int profile_from, bool predivide,
447         int width, int height, int stride_to, int stride_from);
448 void IMB_buffer_float_clamp(float *buf, int width, int height);
449 void IMB_buffer_float_unpremultiply(float *buf, int width, int height);
450 void IMB_buffer_float_premultiply(float *buf, int width, int height);
451
452 /**
453  * Change the ordering of the color bytes pointed to by rect from
454  * rgba to abgr. size * 4 color bytes are reordered.
455  *
456  * \attention Defined in imageprocess.c
457  */
458 void IMB_convert_rgba_to_abgr(struct ImBuf *ibuf);
459
460 /**
461  *
462  * \attention defined in imageprocess.c
463  */
464 void bicubic_interpolation(struct ImBuf *in, struct ImBuf *out, float u, float v, int xout, int yout);
465 void nearest_interpolation(struct ImBuf *in, struct ImBuf *out, float u, float v, int xout, int yout);
466 void bilinear_interpolation(struct ImBuf *in, struct ImBuf *out, float u, float v, int xout, int yout);
467
468 void bicubic_interpolation_color(struct ImBuf *in, unsigned char col[4], float col_float[4], float u, float v);
469 void nearest_interpolation_color(struct ImBuf *in, unsigned char col[4], float col_float[4], float u, float v);
470 void bilinear_interpolation_color(struct ImBuf *in, unsigned char col[4], float col_float[4], float u, float v);
471 void bilinear_interpolation_color_wrap(struct ImBuf *in, unsigned char col[4], float col_float[4], float u, float v);
472
473 void IMB_alpha_under_color_float(float *rect_float, int x, int y, float backcol[3]);
474 void IMB_alpha_under_color_byte(unsigned char *rect, int x, int y, float backcol[3]);
475
476 /**
477  *
478  * \attention defined in readimage.c
479  */  
480 struct ImBuf *IMB_loadifffile(int file, const char *filepath, int flags, char colorspace[IM_MAX_SPACE], const char *descr);
481
482 /**
483  *
484  * \attention defined in scaling.c
485  */
486 struct ImBuf *IMB_half_x(struct ImBuf *ibuf1);
487
488 /**
489  *
490  * \attention defined in scaling.c
491  */
492 struct ImBuf *IMB_double_fast_x(struct ImBuf *ibuf1);
493
494 /**
495  *
496  * \attention defined in scaling.c
497  */
498 struct ImBuf *IMB_double_x(struct ImBuf *ibuf1);
499
500 /**
501  *
502  * \attention defined in scaling.c
503  */
504 struct ImBuf *IMB_half_y(struct ImBuf *ibuf1);
505
506 /**
507  *
508  * \attention defined in scaling.c
509  */
510 struct ImBuf *IMB_double_fast_y(struct ImBuf *ibuf1);
511
512 /**
513  *
514  * \attention defined in scaling.c
515  */
516 struct ImBuf *IMB_double_y(struct ImBuf *ibuf1);
517
518 /**
519  *
520  * \attention Defined in rotate.c
521  */
522 void IMB_flipx(struct ImBuf *ibuf);
523 void IMB_flipy(struct ImBuf *ibuf);
524
525 /* Premultiply alpha */
526
527 void IMB_premultiply_alpha(struct ImBuf *ibuf);
528 void IMB_unpremultiply_alpha(struct ImBuf *ibuf);
529
530 /**
531  *
532  * \attention Defined in allocimbuf.c
533  */
534 void IMB_freezbufImBuf(struct ImBuf *ibuf);
535 void IMB_freezbuffloatImBuf(struct ImBuf *ibuf);
536
537 /**
538  *
539  * \attention Defined in rectop.c
540  */
541 void IMB_rectfill(struct ImBuf *drect, const float col[4]);
542 void IMB_rectfill_area(struct ImBuf *ibuf, const float col[4], int x1, int y1, int x2, int y2, struct ColorManagedDisplay *display);
543 void IMB_rectfill_alpha(struct ImBuf *ibuf, const float value);
544
545 /* this should not be here, really, we needed it for operating on render data, IMB_rectfill_area calls it */
546 void buf_rectfill_area(unsigned char *rect, float *rectf, int width, int height,
547                        const float col[4], struct ColorManagedDisplay *display,
548                        int x1, int y1, int x2, int y2);
549
550 /* defined in metadata.c */
551 bool IMB_metadata_change_field(struct ImBuf *img, const char *key, const char *field);
552
553 /* exported for image tools in blender, to quickly allocate 32 bits rect */
554 bool imb_addrectImBuf(struct ImBuf *ibuf);
555 void imb_freerectImBuf(struct ImBuf *ibuf);
556
557 bool imb_addrectfloatImBuf(struct ImBuf *ibuf);
558 void imb_freerectfloatImBuf(struct ImBuf *ibuf);
559 void imb_freemipmapImBuf(struct ImBuf *ibuf);
560
561 bool imb_addtilesImBuf(struct ImBuf *ibuf);
562 void imb_freetilesImBuf(struct ImBuf *ibuf);
563
564 /* threaded processors */
565 void IMB_processor_apply_threaded(int buffer_lines, int handle_size, void *init_customdata,
566                                   void (init_handle) (void *handle, int start_line, int tot_line,
567                                                       void *customdata),
568                                   void *(do_thread) (void *));
569
570 /* ffmpeg */
571 void IMB_ffmpeg_init(void);
572 const char *IMB_ffmpeg_last_error(void);
573
574 /**
575  *
576  * \attention defined in stereoimbuf.c
577  */
578 void IMB_stereo3d_write_dimensions(
579         const char mode, const bool is_squeezed, const size_t width, const size_t height,
580         size_t *r_width, size_t *r_height);
581 void IMB_stereo3d_read_dimensions(
582         const char mode, const bool is_squeezed, const size_t width, const size_t height,
583         size_t *r_width, size_t *r_height);
584 int *IMB_stereo3d_from_rect(
585         struct ImageFormatData *im_format, const size_t x, const size_t y, const size_t channels,
586         int *rect_left, int *rect_right);
587 float *IMB_stereo3d_from_rectf(
588         struct ImageFormatData *im_format, const size_t x, const size_t y, const size_t channels,
589         float *rectf_left, float *rectf_right);
590 struct ImBuf *IMB_stereo3d_ImBuf(
591         struct ImageFormatData *im_format,
592         struct ImBuf *ibuf_left, struct ImBuf *ibuf_right);
593 void IMB_ImBufFromStereo3d(
594         struct Stereo3dFormat *s3d, struct ImBuf *ibuf_stereo,
595         struct ImBuf **r_ibuf_left, struct ImBuf **r_ibuf_right);
596
597 #endif