75f8df99e635eaadd9460a97cf6a1782b7808fe0
[blender.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 imb_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 imb_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 imb_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 planes, unsigned int flags);
134
135 /**
136  * Initialize given ImBuf.
137  *
138  * Use in cases when temporary image buffer is allocated on stack.
139  *
140  * \attention Defined in allocimbuf.c
141  */
142 bool IMB_initImBuf(struct ImBuf *ibuf,
143                    unsigned int x, unsigned int y,
144                    unsigned char planes, unsigned int flags);
145
146 /**
147  * Create a copy of a pixel buffer and wrap it to a new ImBuf
148  * \attention Defined in allocimbuf.c
149  */
150 struct ImBuf *IMB_allocFromBuffer(const unsigned int *rect, const float *rectf,
151                                   unsigned int w, unsigned int h);
152
153 /**
154  *
155  * Increase reference count to imbuf
156  * (to delete an imbuf you have to call freeImBuf as many times as it
157  * is referenced)
158  *
159  * \attention Defined in allocimbuf.c
160  */
161
162 void IMB_refImBuf(struct ImBuf *ibuf);
163 struct ImBuf *IMB_makeSingleUser(struct ImBuf *ibuf);
164
165 /**
166  *
167  * \attention Defined in allocimbuf.c
168  */
169 struct ImBuf *IMB_dupImBuf(const struct ImBuf *ibuf1);
170
171 /**
172  *
173  * \attention Defined in allocimbuf.c
174  */
175 bool addzbufImBuf(struct ImBuf *ibuf);
176 bool addzbuffloatImBuf(struct ImBuf *ibuf);
177
178 /**
179  *
180  * \attention Defined in rectop.c
181  */
182
183 typedef enum IMB_BlendMode {
184         IMB_BLEND_MIX = 0,
185         IMB_BLEND_ADD = 1,
186         IMB_BLEND_SUB = 2,
187         IMB_BLEND_MUL = 3,
188         IMB_BLEND_LIGHTEN = 4,
189         IMB_BLEND_DARKEN = 5,
190         IMB_BLEND_ERASE_ALPHA = 6,
191         IMB_BLEND_ADD_ALPHA = 7,
192         IMB_BLEND_OVERLAY = 8,
193         IMB_BLEND_HARDLIGHT     = 9,
194         IMB_BLEND_COLORBURN     = 10,
195         IMB_BLEND_LINEARBURN = 11,
196         IMB_BLEND_COLORDODGE = 12,
197         IMB_BLEND_SCREEN = 13,
198         IMB_BLEND_SOFTLIGHT     = 14,
199         IMB_BLEND_PINLIGHT = 15,
200         IMB_BLEND_VIVIDLIGHT = 16,
201         IMB_BLEND_LINEARLIGHT = 17,
202         IMB_BLEND_DIFFERENCE = 18,
203         IMB_BLEND_EXCLUSION     = 19,
204         IMB_BLEND_HUE = 20,
205         IMB_BLEND_SATURATION = 21,
206         IMB_BLEND_LUMINOSITY = 22,
207         IMB_BLEND_COLOR = 23,
208         IMB_BLEND_INTERPOLATE = 24,
209
210         IMB_BLEND_COPY = 1000,
211         IMB_BLEND_COPY_RGB = 1001,
212         IMB_BLEND_COPY_ALPHA = 1002
213 } IMB_BlendMode;
214
215 void IMB_blend_color_byte(unsigned char dst[4], unsigned char src1[4],
216         unsigned char src2[4], IMB_BlendMode mode);
217 void IMB_blend_color_float(float dst[4], float src1[4], float src2[4],
218         IMB_BlendMode mode);
219
220 void IMB_rectclip(struct ImBuf *dbuf, struct ImBuf *sbuf, int *destx,
221         int *desty, int *srcx, int *srcy, int *width, int *height);
222 void IMB_rectcpy(struct ImBuf *drect, struct ImBuf *srect, int destx,
223         int desty, int srcx, int srcy, int width, int height);
224 void IMB_rectblend(struct ImBuf *dbuf, struct ImBuf *obuf, struct ImBuf *sbuf,
225         unsigned short *dmask, unsigned short *curvemask, unsigned short *mmask, float mask_max,
226         int destx,  int desty, int origx, int origy, int srcx, int srcy,
227         int width, int height, IMB_BlendMode mode, bool accumulate);
228 void IMB_rectblend_threaded(struct ImBuf *dbuf, struct ImBuf *obuf, struct ImBuf *sbuf,
229         unsigned short *dmask, unsigned short *curvemask, unsigned short *mmask, float mask_max,
230         int destx,  int desty, int origx, int origy, int srcx, int srcy,
231         int width, int height, IMB_BlendMode mode, bool accumulate);
232
233 /**
234  *
235  * \attention Defined in indexer.c
236  */
237
238 typedef enum IMB_Timecode_Type {
239         IMB_TC_NONE       = 0, /* don't use timecode files at all */
240
241         IMB_TC_RECORD_RUN = 1, /* use images in the order as they are recorded
242                                 * (currently, this is the only one implemented
243                                 * and is a sane default) */
244
245         IMB_TC_FREE_RUN   = 2, /* use global timestamp written by recording
246                                 * device (prosumer camcorders e.g. can do that) */
247         IMB_TC_INTERPOLATED_REC_DATE_FREE_RUN = 4, /* interpolate a global timestamp using the
248                                                     * record date and time written by recording
249                                                     * device (*every* consumer camcorder can do
250                                                     * that :) )*/
251         IMB_TC_RECORD_RUN_NO_GAPS = 8,
252         IMB_TC_MAX_SLOT   = 4
253 } IMB_Timecode_Type;
254
255 typedef enum IMB_Proxy_Size {
256         IMB_PROXY_NONE = 0,
257         IMB_PROXY_25 = 1,
258         IMB_PROXY_50 = 2,
259         IMB_PROXY_75 = 4,
260         IMB_PROXY_100 = 8,
261         IMB_PROXY_MAX_SLOT = 4
262 } IMB_Proxy_Size;
263
264 /* defaults to BL_proxy within the directory of the animation */
265 void IMB_anim_set_index_dir(struct anim *anim, const char *dir);
266 void IMB_anim_get_fname(struct anim *anim, char *file, int size);
267
268 int IMB_anim_index_get_frame_index(struct anim *anim, IMB_Timecode_Type tc,
269                                    int position);
270
271 IMB_Proxy_Size IMB_anim_proxy_get_existing(struct anim *anim);
272
273 struct IndexBuildContext;
274
275 /* prepare context for proxies/imecodes builder */
276 struct IndexBuildContext *IMB_anim_index_rebuild_context(struct anim *anim, IMB_Timecode_Type tcs_in_use,
277                                                          IMB_Proxy_Size proxy_sizes_in_use, int quality,
278                                                          const bool overwite, struct GSet *file_list);
279
280 /* will rebuild all used indices and proxies at once */
281 void IMB_anim_index_rebuild(struct IndexBuildContext *context,
282                             short *stop, short *do_update, float *progress);
283
284 /* finish rebuilding proxises/timecodes and free temporary contexts used */
285 void IMB_anim_index_rebuild_finish(struct IndexBuildContext *context, short stop);
286
287 /**
288  * Return the length (in frames) of the given \a anim.
289  */
290 int IMB_anim_get_duration(struct anim *anim, IMB_Timecode_Type tc);
291
292
293 /**
294  * Return the fps contained in movie files (function rval is false,
295  * and frs_sec and frs_sec_base untouched if none available!)
296  */
297 bool IMB_anim_get_fps(struct anim *anim,
298                       short *frs_sec, float *frs_sec_base, bool no_av_base);
299
300 /**
301  *
302  * \attention Defined in anim_movie.c
303  */
304 struct anim *IMB_open_anim(const char *name, int ib_flags, int streamindex, char colorspace[IM_MAX_SPACE]);
305 void IMB_suffix_anim(struct anim *anim, const char *suffix);
306 void IMB_close_anim(struct anim *anim);
307 void IMB_close_anim_proxies(struct anim *anim);
308
309 /**
310  *
311  * \attention Defined in anim_movie.c
312  */
313
314 int ismovie(const char *filepath);
315 void IMB_anim_set_preseek(struct anim *anim, int preseek);
316 int IMB_anim_get_preseek(struct anim *anim);
317
318 /**
319  *
320  * \attention Defined in anim_movie.c
321  */
322
323 struct ImBuf *IMB_anim_absolute(
324         struct anim *anim, int position,
325         IMB_Timecode_Type tc        /* = 1 = IMB_TC_RECORD_RUN */,
326         IMB_Proxy_Size preview_size /* = 0 = IMB_PROXY_NONE */);
327
328 /**
329  *
330  * \attention Defined in anim_movie.c
331  * fetches a define previewframe, usually half way into the movie
332  */
333 struct ImBuf *IMB_anim_previewframe(struct anim *anim);
334
335 /**
336  *
337  * \attention Defined in anim_movie.c
338  */
339 void IMB_free_anim(struct anim *anim);
340
341 /**
342  *
343  * \attention Defined in filter.c
344  */
345
346 #define FILTER_MASK_NULL                0
347 #define FILTER_MASK_MARGIN              1
348 #define FILTER_MASK_USED                2
349
350 void IMB_filter(struct ImBuf *ibuf);
351 void IMB_mask_filter_extend(char *mask, int width, int height);
352 void IMB_mask_clear(struct ImBuf *ibuf, char *mask, int val);
353 void IMB_filter_extend(struct ImBuf *ibuf, char *mask, int filter);
354 void IMB_makemipmap(struct ImBuf *ibuf, int use_filter);
355 void IMB_remakemipmap(struct ImBuf *ibuf, int use_filter);
356 struct ImBuf *IMB_getmipmap(struct ImBuf *ibuf, int level);
357
358 /**
359  *
360  * \attention Defined in cache.c
361  */
362
363 void IMB_tile_cache_params(int totthread, int maxmem);
364 unsigned int *IMB_gettile(struct ImBuf *ibuf, int tx, int ty, int thread);
365 void IMB_tiles_to_rect(struct ImBuf *ibuf);
366
367 /**
368  *
369  * \attention Defined in filter.c
370  */
371 void IMB_filtery(struct ImBuf *ibuf);
372
373 /**
374  *
375  * \attention Defined in scaling.c
376  */
377 struct ImBuf *IMB_onehalf(struct ImBuf *ibuf1);
378
379 /**
380  *
381  * \attention Defined in scaling.c
382  */
383 bool IMB_scaleImBuf(struct ImBuf *ibuf, unsigned int newx, unsigned int newy);
384
385 /**
386  *
387  * \attention Defined in scaling.c
388  */
389 bool IMB_scalefastImBuf(struct ImBuf *ibuf, unsigned int newx, unsigned int newy);
390
391 /**
392  *
393  * \attention Defined in scaling.c
394  */
395 void IMB_scaleImBuf_threaded(struct ImBuf *ibuf, unsigned int newx, unsigned int newy);
396
397 /**
398  *
399  * \attention Defined in writeimage.c
400  */
401 short IMB_saveiff(struct ImBuf *ibuf, const char *filepath, int flags);
402 bool IMB_prepare_write_ImBuf(const bool isfloat, struct ImBuf *ibuf);
403
404 /**
405  *
406  * \attention Defined in util.c
407  */
408 bool IMB_ispic(const char *name);
409 int  IMB_ispic_type(const char *name);
410
411 /**
412  *
413  * \attention Defined in util.c
414  */
415 bool IMB_isanim(const char *name);
416
417 /**
418  *
419  * \attention Defined in util.c
420  */
421 int imb_get_anim_type(const char *name);
422
423 /**
424  *
425  * \attention Defined in util.c
426  */
427 bool IMB_isfloat(struct ImBuf *ibuf);
428
429 /**
430  *
431  * \attention Defined in divers.c
432  */
433 void IMB_de_interlace(struct ImBuf *ibuf);
434 void IMB_interlace(struct ImBuf *ibuf);
435
436 /* create char buffer, color corrected if necessary, for ImBufs that lack one */
437 void IMB_rect_from_float(struct ImBuf *ibuf);
438 /* Create char buffer for part of the image, color corrected if necessary,
439  * Changed part will be stored in buffer. This is expected to be used for texture painting updates */
440 void IMB_partial_rect_from_float(struct ImBuf *ibuf, float *buffer, int x, int y, int w, int h, bool is_data);
441 void IMB_float_from_rect(struct ImBuf *ibuf);
442 void IMB_color_to_bw(struct ImBuf *ibuf);
443 void IMB_saturation(struct ImBuf *ibuf, float sat);
444
445 /* converting pixel buffers */
446 void IMB_buffer_byte_from_float(unsigned char *rect_to, const float *rect_from,
447         int channels_from, float dither, int profile_to, int profile_from, bool predivide,
448         int width, int height, int stride_to, int stride_from);
449 void IMB_buffer_byte_from_float_mask(unsigned char *rect_to, const float *rect_from,
450         int channels_from, float dither, bool predivide,
451         int width, int height, int stride_to, int stride_from, char *mask);
452 void IMB_buffer_float_from_byte(float *rect_to, const unsigned char *rect_from,
453         int profile_to, int profile_from, bool predivide,
454         int width, int height, int stride_to, int stride_from);
455 void IMB_buffer_float_from_float(float *rect_to, const float *rect_from,
456         int channels_from, int profile_to, int profile_from, bool predivide,
457         int width, int height, int stride_to, int stride_from);
458 void IMB_buffer_float_from_float_threaded(float *rect_to, const float *rect_from,
459         int channels_from, int profile_to, int profile_from, bool predivide,
460         int width, int height, int stride_to, int stride_from);
461 void IMB_buffer_float_from_float_mask(float *rect_to, const float *rect_from,
462         int channels_from, int width, int height, int stride_to, int stride_from, char *mask);
463 void IMB_buffer_byte_from_byte(unsigned char *rect_to, const unsigned char *rect_from,
464         int profile_to, int profile_from, bool predivide,
465         int width, int height, int stride_to, int stride_from);
466 void IMB_buffer_float_clamp(float *buf, int width, int height);
467 void IMB_buffer_float_unpremultiply(float *buf, int width, int height);
468 void IMB_buffer_float_premultiply(float *buf, int width, int height);
469
470 /**
471  * Change the ordering of the color bytes pointed to by rect from
472  * rgba to abgr. size * 4 color bytes are reordered.
473  *
474  * \attention Defined in imageprocess.c
475  */
476 void IMB_convert_rgba_to_abgr(struct ImBuf *ibuf);
477
478 /**
479  *
480  * \attention defined in imageprocess.c
481  */
482 void bicubic_interpolation(struct ImBuf *in, struct ImBuf *out, float u, float v, int xout, int yout);
483 void nearest_interpolation(struct ImBuf *in, struct ImBuf *out, float u, float v, int xout, int yout);
484 void bilinear_interpolation(struct ImBuf *in, struct ImBuf *out, float u, float v, int xout, int yout);
485
486 void bicubic_interpolation_color(struct ImBuf *in, unsigned char col[4], float col_float[4], float u, float v);
487 void nearest_interpolation_color(struct ImBuf *in, unsigned char col[4], float col_float[4], float u, float v);
488 void nearest_interpolation_color_wrap(struct ImBuf *in, unsigned char col[4], float col_float[4], float u, float v);
489 void bilinear_interpolation_color(struct ImBuf *in, unsigned char col[4], float col_float[4], float u, float v);
490 void bilinear_interpolation_color_wrap(struct ImBuf *in, unsigned char col[4], float col_float[4], float u, float v);
491
492 void IMB_alpha_under_color_float(float *rect_float, int x, int y, float backcol[3]);
493 void IMB_alpha_under_color_byte(unsigned char *rect, int x, int y, float backcol[3]);
494
495 /**
496  *
497  * \attention defined in readimage.c
498  */
499 struct ImBuf *IMB_loadifffile(int file, const char *filepath, int flags, char colorspace[IM_MAX_SPACE], const char *descr);
500
501 /**
502  *
503  * \attention defined in scaling.c
504  */
505 struct ImBuf *IMB_half_x(struct ImBuf *ibuf1);
506
507 /**
508  *
509  * \attention defined in scaling.c
510  */
511 struct ImBuf *IMB_double_fast_x(struct ImBuf *ibuf1);
512
513 /**
514  *
515  * \attention defined in scaling.c
516  */
517 struct ImBuf *IMB_double_x(struct ImBuf *ibuf1);
518
519 /**
520  *
521  * \attention defined in scaling.c
522  */
523 struct ImBuf *IMB_half_y(struct ImBuf *ibuf1);
524
525 /**
526  *
527  * \attention defined in scaling.c
528  */
529 struct ImBuf *IMB_double_fast_y(struct ImBuf *ibuf1);
530
531 /**
532  *
533  * \attention defined in scaling.c
534  */
535 struct ImBuf *IMB_double_y(struct ImBuf *ibuf1);
536
537 /**
538  *
539  * \attention Defined in rotate.c
540  */
541 void IMB_flipx(struct ImBuf *ibuf);
542 void IMB_flipy(struct ImBuf *ibuf);
543
544 /* Premultiply alpha */
545
546 void IMB_premultiply_alpha(struct ImBuf *ibuf);
547 void IMB_unpremultiply_alpha(struct ImBuf *ibuf);
548
549 /**
550  *
551  * \attention Defined in allocimbuf.c
552  */
553 void IMB_freezbufImBuf(struct ImBuf *ibuf);
554 void IMB_freezbuffloatImBuf(struct ImBuf *ibuf);
555
556 /**
557  *
558  * \attention Defined in rectop.c
559  */
560 void IMB_rectfill(struct ImBuf *drect, const float col[4]);
561 void IMB_rectfill_area(struct ImBuf *ibuf, const float col[4], int x1, int y1, int x2, int y2, struct ColorManagedDisplay *display);
562 void IMB_rectfill_alpha(struct ImBuf *ibuf, const float value);
563
564 /* this should not be here, really, we needed it for operating on render data, IMB_rectfill_area calls it */
565 void buf_rectfill_area(unsigned char *rect, float *rectf, int width, int height,
566                        const float col[4], struct ColorManagedDisplay *display,
567                        int x1, int y1, int x2, int y2);
568
569 /* exported for image tools in blender, to quickly allocate 32 bits rect */
570 void *imb_alloc_pixels(unsigned int x,
571                        unsigned int y,
572                        unsigned int channels,
573                        size_t typesize,
574                        const char *name);
575
576 bool imb_addrectImBuf(struct ImBuf *ibuf);
577 void imb_freerectImBuf(struct ImBuf *ibuf);
578
579 bool imb_addrectfloatImBuf(struct ImBuf *ibuf);
580 void imb_freerectfloatImBuf(struct ImBuf *ibuf);
581 void imb_freemipmapImBuf(struct ImBuf *ibuf);
582
583 bool imb_addtilesImBuf(struct ImBuf *ibuf);
584 void imb_freetilesImBuf(struct ImBuf *ibuf);
585
586 /* threaded processors */
587 void IMB_processor_apply_threaded(int buffer_lines, int handle_size, void *init_customdata,
588                                   void (init_handle) (void *handle, int start_line, int tot_line,
589                                                       void *customdata),
590                                   void *(do_thread) (void *));
591
592 typedef void (*ScanlineThreadFunc) (void *custom_data,
593                                     int start_scanline,
594                                     int num_scanlines);
595 void IMB_processor_apply_threaded_scanlines(int total_scanlines,
596                                             ScanlineThreadFunc do_thread,
597                                             void *custom_data);
598
599
600 /* ffmpeg */
601 void IMB_ffmpeg_init(void);
602 const char *IMB_ffmpeg_last_error(void);
603
604 /**
605  *
606  * \attention defined in stereoimbuf.c
607  */
608 void IMB_stereo3d_write_dimensions(
609         const char mode, const bool is_squeezed, const size_t width, const size_t height,
610         size_t *r_width, size_t *r_height);
611 void IMB_stereo3d_read_dimensions(
612         const char mode, const bool is_squeezed, const size_t width, const size_t height,
613         size_t *r_width, size_t *r_height);
614 int *IMB_stereo3d_from_rect(
615         struct ImageFormatData *im_format, const size_t x, const size_t y, const size_t channels,
616         int *rect_left, int *rect_right);
617 float *IMB_stereo3d_from_rectf(
618         struct ImageFormatData *im_format, const size_t x, const size_t y, const size_t channels,
619         float *rectf_left, float *rectf_right);
620 struct ImBuf *IMB_stereo3d_ImBuf(
621         struct ImageFormatData *im_format,
622         struct ImBuf *ibuf_left, struct ImBuf *ibuf_right);
623 void IMB_ImBufFromStereo3d(
624         struct Stereo3dFormat *s3d, struct ImBuf *ibuf_stereo,
625         struct ImBuf **r_ibuf_left, struct ImBuf **r_ibuf_right);
626
627 #endif