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