IMB_imbuf.h

Go to the documentation of this file.

/*
 * ***** BEGIN GPL LICENSE BLOCK *****
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License
 * as published by the Free Software Foundation; either version 2
 * of the License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software Foundation,
 * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
 *
 * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
 * All rights reserved.
 *
 * The Original Code is: all of this file.
 *
 * Contributor(s): none yet.
 *
 * ***** END GPL LICENSE BLOCK *****
 */

#ifndef IMB_IMBUF_H
#define IMB_IMBUF_H

struct ImBuf;

struct anim;

void IMB_init(void);
void IMB_exit(void);

struct ImBuf *IMB_ibImageFromMemory(unsigned char *mem, size_t size,
                                    int flags, const char *descr);

struct ImBuf *IMB_testiffname(const char *filepath, int flags);

struct ImBuf *IMB_loadiffname(const char *filepath, int flags);

void IMB_freeImBuf(struct ImBuf *ibuf);

struct ImBuf *IMB_allocImBuf(unsigned int x, unsigned int y,
                             unsigned char d, unsigned int flags);

void IMB_refImBuf(struct ImBuf *ibuf);
struct ImBuf * IMB_makeSingleUser(struct ImBuf *ibuf);

struct ImBuf *IMB_dupImBuf(struct ImBuf *ibuf1);

short addzbufImBuf(struct ImBuf *ibuf);
short addzbuffloatImBuf(struct ImBuf *ibuf);

typedef enum IMB_BlendMode {
    IMB_BLEND_MIX = 0,
    IMB_BLEND_ADD = 1,
    IMB_BLEND_SUB = 2,
    IMB_BLEND_MUL = 3,
    IMB_BLEND_LIGHTEN = 4,
    IMB_BLEND_DARKEN = 5,
    IMB_BLEND_ERASE_ALPHA = 6,
    IMB_BLEND_ADD_ALPHA = 7,

    IMB_BLEND_COPY = 1000,
    IMB_BLEND_COPY_RGB = 1001,
    IMB_BLEND_COPY_ALPHA = 1002
} IMB_BlendMode;

unsigned int IMB_blend_color(unsigned int src1, unsigned int src2, int fac,
    IMB_BlendMode mode);
void IMB_blend_color_float(float *dst, float *src1, float *src2, float fac,
    IMB_BlendMode mode);

void IMB_rectclip(struct ImBuf *dbuf, struct ImBuf *sbuf, int *destx, 
    int *desty, int *srcx, int *srcy, int *width, int *height);
void IMB_rectcpy(struct ImBuf *drect, struct ImBuf *srect, int destx,
    int desty, int srcx, int srcy, int width, int height);
void IMB_rectblend(struct ImBuf *dbuf, struct ImBuf *sbuf, int destx, 
    int desty, int srcx, int srcy, int width, int height, IMB_BlendMode mode);

typedef enum IMB_Timecode_Type {
    IMB_TC_NONE       = 0, /* don't use timecode files at all */
    IMB_TC_RECORD_RUN = 1, /* use images in the order as they are recorded 
                  (currently, this is the only one implemented
                  and is a sane default)
                   */
    IMB_TC_FREE_RUN   = 2, /* use global timestamp written by recording
                  device (prosumer camcorders e.g. can do
                  that) */
    IMB_TC_INTERPOLATED_REC_DATE_FREE_RUN = 4, 
                               /* interpolate a global timestamp using the
                  record date and time written by recording
                  device (*every* consumer camcorder can do
                  that :) )*/
    IMB_TC_RECORD_RUN_NO_GAPS = 8,
    IMB_TC_MAX_SLOT   = 8
} IMB_Timecode_Type;

typedef enum IMB_Proxy_Size {
    IMB_PROXY_NONE = 0,
    IMB_PROXY_25 = 1,
    IMB_PROXY_50 = 2,
    IMB_PROXY_75 = 4,
    IMB_PROXY_100 = 8,
    IMB_PROXY_MAX_SLOT = 4
} IMB_Proxy_Size;

/* defaults to BL_proxy within the directory of the animation */
void IMB_anim_set_index_dir(struct anim * anim, const char * dir);

int IMB_anim_index_get_frame_index(struct anim * anim, IMB_Timecode_Type tc,
                                   int position);

/* will rebuild all used indices and proxies at once */
void IMB_anim_index_rebuild(struct anim * anim, 
                            IMB_Timecode_Type build_tcs,
                            IMB_Proxy_Size build_preview_sizes,
                            int build_quality,
                            short *stop, short *do_update, float *progress);

int IMB_anim_get_duration(struct anim *anim, IMB_Timecode_Type tc);


int IMB_anim_get_fps(struct anim * anim, 
                     short * frs_sec, float * frs_sec_base);

struct anim *IMB_open_anim(const char *name, int ib_flags, int streamindex);
void IMB_close_anim(struct anim *anim);


int ismovie(const char *filepath);
void IMB_anim_set_preseek(struct anim *anim, int preseek);
int IMB_anim_get_preseek(struct anim *anim);

struct ImBuf *IMB_anim_absolute(
    struct anim *anim, int position,
    IMB_Timecode_Type tc        /* = 1 = IMB_TC_RECORD_RUN */, 
    IMB_Proxy_Size preview_size /* = 0 = IMB_PROXY_NONE */);

struct ImBuf *IMB_anim_previewframe(struct anim *anim);

void IMB_free_anim(struct anim *anim);

#define FILTER_MASK_NULL        0
#define FILTER_MASK_MARGIN      1
#define FILTER_MASK_USED        2

void IMB_filter(struct ImBuf *ibuf);
void IMB_filterN(struct ImBuf *out, struct ImBuf *in);
void IMB_mask_filter_extend(char *mask, int width, int height);
void IMB_mask_clear(struct ImBuf *ibuf, char *mask, int val);
void IMB_filter_extend(struct ImBuf *ibuf, char *mask, int filter);
void IMB_makemipmap(struct ImBuf *ibuf, int use_filter);
void IMB_remakemipmap(struct ImBuf *ibuf, int use_filter);
struct ImBuf *IMB_getmipmap(struct ImBuf *ibuf, int level);

void IMB_tile_cache_params(int totthread, int maxmem);
unsigned int *IMB_gettile(struct ImBuf *ibuf, int tx, int ty, int thread);
void IMB_tiles_to_rect(struct ImBuf *ibuf);

void IMB_filtery(struct ImBuf *ibuf);

struct ImBuf *IMB_onehalf(struct ImBuf *ibuf1);

struct ImBuf *IMB_scaleImBuf(struct ImBuf *ibuf, unsigned int newx, unsigned int newy);

struct ImBuf *IMB_scalefastImBuf(struct ImBuf *ibuf, unsigned int newx, unsigned int newy);

short IMB_saveiff(struct ImBuf *ibuf, const char *filepath, int flags);

short IMB_png_encode(struct ImBuf *ibuf, int file, int flags);

int IMB_ispic(const char *name);

int IMB_isanim(const char *name);

int imb_get_anim_type(const char *name);

void IMB_de_interlace(struct ImBuf *ibuf);
void IMB_interlace(struct ImBuf *ibuf);

/* create char buffer, color corrected if necessary, for ImBufs that lack one */ 
void IMB_rect_from_float(struct ImBuf *ibuf);
/* create char buffer for part of the image, color corrected if necessary,
   Changed part will be stored in buffer. This is expected to be used for texture painting updates */ 
void IMB_partial_rect_from_float(struct ImBuf *ibuf, float *buffer, int x, int y, int w, int h);
void IMB_float_from_rect(struct ImBuf *ibuf);
void IMB_float_from_rect_simple(struct ImBuf *ibuf); /* no profile conversion */
/* note, check that the conversion exists, only some are supported */
void IMB_convert_profile(struct ImBuf *ibuf, int profile);
float *IMB_float_profile_ensure(struct ImBuf *ibuf, int profile, int *alloc);
void IMB_color_to_bw(struct ImBuf *ibuf);

/* converting pixel buffers */
void IMB_buffer_byte_from_float(unsigned char *rect_to, const float *rect_from,
    int channels_from, float dither, int profile_to, int profile_from, int predivide,
    int width, int height, int stride_to, int stride_from);
void IMB_buffer_float_from_byte(float *rect_to, const unsigned char *rect_from,
    int profile_to, int profile_from, int predivide,
    int width, int height, int stride_to, int stride_from);
void IMB_buffer_float_from_float(float *rect_to, const float *rect_from,
    int channels_from, int profile_to, int profile_from, int predivide,
    int width, int height, int stride_to, int stride_from);
void IMB_buffer_byte_from_byte(unsigned char *rect_to, const unsigned char *rect_from,
    int profile_to, int profile_from, int predivide,
    int width, int height, int stride_to, int stride_from);

void IMB_convert_rgba_to_abgr(struct ImBuf *ibuf);

void IMB_convert_bgra_to_rgba(int size, unsigned int *rect);

void bicubic_interpolation(struct ImBuf *in, struct ImBuf *out, float u, float v, int xout, int yout);
void neareast_interpolation(struct ImBuf *in, struct ImBuf *out, float u, float v, int xout, int yout);
void bilinear_interpolation(struct ImBuf *in, struct ImBuf *out, float u, float v, int xout, int yout);

void bicubic_interpolation_color(struct ImBuf *in, unsigned char *col, float *col_float, float u, float v);
void neareast_interpolation_color(struct ImBuf *in, unsigned char *col, float *col_float, float u, float v);
void bilinear_interpolation_color(struct ImBuf *in, unsigned char *col, float *col_float, float u, float v);
void bilinear_interpolation_color_wrap(struct ImBuf *in, unsigned char *col, float *col_float, float u, float v);

struct ImBuf *IMB_loadifffile(int file, int flags, const char *descr);

struct ImBuf *IMB_half_x(struct ImBuf *ibuf1);

struct ImBuf *IMB_double_fast_x(struct ImBuf *ibuf1);

struct ImBuf *IMB_double_x(struct ImBuf *ibuf1);

struct ImBuf *IMB_half_y(struct ImBuf *ibuf1);

struct ImBuf *IMB_double_fast_y(struct ImBuf *ibuf1);

struct ImBuf *IMB_double_y(struct ImBuf *ibuf1);

void IMB_flipx(struct ImBuf *ibuf);
void IMB_flipy(struct ImBuf *ibuf);

/* Premultiply alpha */

void IMB_premultiply_alpha(struct ImBuf *ibuf);

void IMB_freezbufImBuf(struct ImBuf *ibuf);
void IMB_freezbuffloatImBuf(struct ImBuf *ibuf);

void IMB_rectfill(struct ImBuf *drect, const float col[4]);
void IMB_rectfill_area(struct ImBuf *ibuf, float *col, int x1, int y1, int x2, int y2);
void IMB_rectfill_alpha(struct ImBuf *ibuf, const float value);

/* this should not be here, really, we needed it for operating on render data, IMB_rectfill_area calls it */
void buf_rectfill_area(unsigned char *rect, float *rectf, int width, int height, const float col[4], int x1, int y1, int x2, int y2);

/* defined in metadata.c */
int IMB_metadata_change_field(struct ImBuf *img, const char *key, const char *field);

/* exported for image tools in blender, to quickly allocate 32 bits rect */
short imb_addrectImBuf(struct ImBuf *ibuf);
void imb_freerectImBuf(struct ImBuf *ibuf);

short imb_addrectfloatImBuf(struct ImBuf *ibuf);
void imb_freerectfloatImBuf(struct ImBuf *ibuf);
void imb_freemipmapImBuf(struct ImBuf *ibuf);

short imb_addtilesImBuf(struct ImBuf *ibuf);
void imb_freetilesImBuf(struct ImBuf *ibuf);

#endif