fix [#28430] Image with Stampinfo does not get saved correctly with alpha
[blender.git] / source / blender / blenpluginapi / iff.h
1 /** \file blender/blenpluginapi/iff.h
2  *  \ingroup blpluginapi
3  */
4 /* Copyright (c) 1999, Not a Number / NeoGeo b.v. 
5  * $Id$
6  * 
7  * All rights reserved.
8  * 
9  * Contact:      info@blender.org   
10  * Information:  http://www.blender.org
11  *
12  * Redistribution and use in source and binary forms, with or without
13  * modification, are permitted provided that the following conditions
14  * are met:
15  * 1. Redistributions of source code must retain the above copyright
16  *    notice, this list of conditions and the following disclaimer.
17  * 2. Redistributions in binary form must reproduce the above copyright
18  *    notice, this list of conditions and the following disclaimer in the
19  *    documentation and/or other materials provided with the distribution.
20  *
21  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
22  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
23  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
24  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
25  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
26  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
27  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
28  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
29  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
30  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
31  * SUCH DAMAGE.
32  */
33
34 #ifndef IFF_H
35 #define IFF_H
36
37 #include <sys/types.h>
38 #include "util.h"
39 #include "externdef.h"
40
41 struct ImMetaData;
42
43 #define IB_MIPMAP_LEVELS        20
44 #define IB_FILENAME_SIZE        1023
45
46 typedef struct ImBuf {
47         struct ImBuf *next, *prev;      /**< allow lists of ImBufs, for caches or flipbooks */
48         short   x, y;                           /**< width and Height of our image buffer */
49         unsigned char   depth;          /**< Active amount of bits/bitplanes */
50         unsigned int    *rect;          /**< pixel values stored here */
51         unsigned int    *crect;         /**< color corrected pixel values stored here */
52         int     flags;                          /**< Controls which components should exist. */
53         int     mall;                           /**< what is malloced internal, and can be freed */
54         int     *zbuf;                          /**< z buffer data, original zbuffer */
55         float *zbuf_float;              /**< z buffer data, camera coordinates */
56         void *userdata;                 /**< temporary storage, only used by baking at the moment */
57         unsigned char *encodedbuffer;     /**< Compressed image only used with png currently */
58         unsigned int   encodedsize;       /**< Size of data written to encodedbuffer */
59         unsigned int   encodedbuffersize; /**< Size of encodedbuffer */
60
61         float *rect_float;              /**< floating point Rect equivalent
62                                                                 Linear RGB color space - may need gamma correction to 
63                                                                 sRGB when generating 8bit representations */
64         int channels;                   /**< amount of channels in rect_float (0 = 4 channel default) */
65         float dither;                   /**< random dither value, for conversion from float -> byte rect */
66         short profile;                  /** color space/profile preset that the byte rect buffer represents */
67         char profile_filename[256];             /** to be implemented properly, specific filename for custom profiles */
68
69         /* mipmapping */
70         struct ImBuf *mipmap[IB_MIPMAP_LEVELS]; /**< MipMap levels, a series of halved images */
71         int miplevels;
72
73         /* externally used flags */
74         int index;                              /* reference index for ImBuf lists */
75         int     userflags;                      /* used to set imbuf to dirty and other stuff */
76         struct ImMetaData *metadata;
77
78         /* file information */
79         int     ftype;                                          /* file type we are going to save as */
80         char name[IB_FILENAME_SIZE];    /* filename associated with this image */
81
82         /* memory cache limiter */
83         struct MEM_CacheLimiterHandle_s *c_handle; /* handle for cache limiter */
84         int refcounter; /* reference counter for multiple users */
85 } ImBuf;
86
87 LIBIMPORT struct ImBuf *allocImBuf(short,short,uchar,uint);
88 LIBIMPORT struct ImBuf *dupImBuf(struct ImBuf *);
89 LIBIMPORT void freeImBuf(struct ImBuf*);
90
91 LIBIMPORT short saveiff(struct ImBuf *,char *,int);
92
93 LIBIMPORT struct ImBuf *loadifffile(int,int);
94 LIBIMPORT struct ImBuf *loadiffname(char *,int);
95 LIBIMPORT struct ImBuf *testiffname(char *,int);
96
97 LIBIMPORT struct ImBuf *onehalf(struct ImBuf *);
98 LIBIMPORT struct ImBuf *half_x(struct ImBuf *);
99 LIBIMPORT struct ImBuf *half_y(struct ImBuf *);
100 LIBIMPORT struct ImBuf *double_x(struct ImBuf *);
101 LIBIMPORT struct ImBuf *double_y(struct ImBuf *);
102 LIBIMPORT struct ImBuf *double_fast_x(struct ImBuf *);
103 LIBIMPORT struct ImBuf *double_fast_y(struct ImBuf *);
104
105 LIBIMPORT int ispic(char *);
106
107 LIBIMPORT struct ImBuf *scaleImBuf(struct ImBuf *, short, short);
108 LIBIMPORT struct ImBuf *scalefastImBuf(struct ImBuf *, short, short);
109
110 LIBIMPORT void de_interlace(struct ImBuf *ib);
111 LIBIMPORT void interlace(struct ImBuf *ib);
112
113 LIBIMPORT void IMB_rectcpy(struct ImBuf *dbuf, struct ImBuf *sbuf, 
114         int destx, int desty, int srcx, int srcy, int width, int height);
115
116 LIBIMPORT void IMB_rectfill(struct ImBuf *drect, const float col[4]);
117 LIBIMPORT void IMB_rectfill_area(struct ImBuf *ibuf, float *col, int x1, int y1, int x2, int y2);
118 LIBIMPORT 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);
119 LIBIMPORT void IMB_rectfill_alpha(struct ImBuf *drect, const float value);
120
121 #endif /* IFF_H */
122