git.mutantstargoat.com Git - eradicate/blob - libs/imago/src/imago2.h

   1 /*
   2 libimago - a multi-format image file input/output library.
   3 Copyright (C) 2010-2012 John Tsiombikas <nuclear@member.fsf.org>
   4
   5 This program is free software: you can redistribute it and/or modify
   6 it under the terms of the GNU Lesser General Public License as published
   7 by the Free Software Foundation, either version 3 of the License, or
   8 (at your option) any later version.
   9
  10 This program is distributed in the hope that it will be useful,
  11 but WITHOUT ANY WARRANTY; without even the implied warranty of
  12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13 GNU Lesser General Public License for more details.
  14
  15 You should have received a copy of the GNU Lesser General Public License
  16 along with this program.  If not, see <http://www.gnu.org/licenses/>.
  17 */
  18
  19 #ifndef IMAGO2_H_
  20 #define IMAGO2_H_
  21
  22 #include <stdio.h>
  23
  24 #ifdef __cplusplus
  25 #define IMG_OPTARG(arg, val)    arg = val
  26 #else
  27 #define IMG_OPTARG(arg, val)    arg
  28 #endif
  29
  30 /* XXX if you change this make sure to also change pack/unpack arrays in conv.c */
  31 enum img_fmt {
  32         IMG_FMT_GREY8,
  33         IMG_FMT_RGB24,
  34         IMG_FMT_RGBA32,
  35         IMG_FMT_GREYF,
  36         IMG_FMT_RGBF,
  37         IMG_FMT_RGBAF,
  38         IMG_FMT_RGB565,
  39
  40         NUM_IMG_FMT
  41 };
  42
  43 struct img_pixmap {
  44         void *pixels;
  45         int width, height;
  46         enum img_fmt fmt;
  47         int pixelsz;
  48         char *name;
  49 };
  50
  51 struct img_io {
  52         void *uptr;     /* user-data */
  53
  54         size_t (*read)(void *buf, size_t bytes, void *uptr);
  55         size_t (*write)(void *buf, size_t bytes, void *uptr);
  56         long (*seek)(long offs, int whence, void *uptr);
  57 };
  58
  59 #ifdef __cplusplus
  60 extern "C" {
  61 #endif
  62
  63 /* initialize the img_pixmap structure */
  64 void img_init(struct img_pixmap *img);
  65 /* destroys the img_pixmap structure, freeing the pixel buffer (if available)
  66  * and any other memory held by the pixmap.
  67  */
  68 void img_destroy(struct img_pixmap *img);
  69
  70 /* convenience function that allocates an img_pixmap struct and then initializes it.
  71  * returns null if the malloc fails.
  72  */
  73 struct img_pixmap *img_create(void);
  74 /* frees a pixmap previously allocated with img_create (free followed by img_destroy) */
  75 void img_free(struct img_pixmap *img);
  76
  77 int img_set_name(struct img_pixmap *img, const char *name);
  78
  79 /* set the image pixel format */
  80 int img_set_format(struct img_pixmap *img, enum img_fmt fmt);
  81
  82 /* copies one pixmap to another.
  83  * equivalent to: img_set_pixels(dest, src->width, src->height, src->fmt, src->pixels)
  84  */
  85 int img_copy(struct img_pixmap *dest, struct img_pixmap *src);
  86
  87 /* allocates a pixel buffer of the specified dimensions and format, and copies the
  88  * pixels given through the pix pointer into it.
  89  * the pix pointer can be null, in which case there's no copy, just allocation.
  90  *
  91  * C++: fmt and pix have default parameters IMG_FMT_RGBA32 and null respectively.
  92  */
  93 int img_set_pixels(struct img_pixmap *img, int w, int h, IMG_OPTARG(enum img_fmt fmt, IMG_FMT_RGBA32), IMG_OPTARG(void *pix, 0));
  94
  95 /* Simplified image loading
  96  * Loads the specified file, and returns a pointer to an array of pixels of the
  97  * requested pixel format. The width and height of the image are returned through
  98  * the xsz and ysz pointers.
  99  * If the image cannot be loaded, the function returns null.
 100  *
 101  * C++: the format argument is optional and defaults to IMG_FMT_RGBA32
 102  */
 103 void *img_load_pixels(const char *fname, int *xsz, int *ysz, IMG_OPTARG(enum img_fmt fmt, IMG_FMT_RGBA32));
 104
 105 /* Simplified image saving
 106  * Reads an array of pixels supplied through the pix pointer, of dimensions xsz
 107  * and ysz, and pixel-format fmt, and saves it to a file.
 108  * The output filetype is guessed by the filename suffix.
 109  *
 110  * C++: the format argument is optional and defaults to IMG_FMT_RGBA32
 111  */
 112 int img_save_pixels(const char *fname, void *pix, int xsz, int ysz, IMG_OPTARG(enum img_fmt fmt, IMG_FMT_RGBA32));
 113
 114 /* Frees the memory allocated by img_load_pixels */
 115 void img_free_pixels(void *pix);
 116
 117 /* Loads an image file into the supplied pixmap */
 118 int img_load(struct img_pixmap *img, const char *fname);
 119 /* Saves the supplied pixmap to a file. The output filetype is guessed by the filename suffix */
 120 int img_save(struct img_pixmap *img, const char *fname);
 121
 122 /* Reads an image from an open FILE* into the supplied pixmap */
 123 int img_read_file(struct img_pixmap *img, FILE *fp);
 124 /* Writes the supplied pixmap to an open FILE* */
 125 int img_write_file(struct img_pixmap *img, FILE *fp);
 126
 127 /* Reads an image using user-defined file-i/o functions (see img_io_set_*) */
 128 int img_read(struct img_pixmap *img, struct img_io *io);
 129 /* Writes an image using user-defined file-i/o functions (see img_io_set_*) */
 130 int img_write(struct img_pixmap *img, struct img_io *io);
 131
 132 /* Converts an image to the specified pixel format */
 133 int img_convert(struct img_pixmap *img, enum img_fmt tofmt);
 134
 135 /* Converts an image from an integer pixel format to the corresponding floating point one */
 136 int img_to_float(struct img_pixmap *img);
 137 /* Converts an image from a floating point pixel format to the corresponding integer one */
 138 int img_to_integer(struct img_pixmap *img);
 139
 140 /* Returns non-zero (true) if the supplied image is in a floating point pixel format */
 141 int img_is_float(struct img_pixmap *img);
 142 /* Returns non-zero (true) if the supplied image has an alpha channel */
 143 int img_has_alpha(struct img_pixmap *img);
 144
 145
 146 /* don't use these for anything performance-critical */
 147 void img_setpixel(struct img_pixmap *img, int x, int y, void *pixel);
 148 void img_getpixel(struct img_pixmap *img, int x, int y, void *pixel);
 149
 150 void img_setpixel1i(struct img_pixmap *img, int x, int y, int pix);
 151 void img_setpixel1f(struct img_pixmap *img, int x, int y, float pix);
 152 void img_setpixel4i(struct img_pixmap *img, int x, int y, int r, int g, int b, int a);
 153 void img_setpixel4f(struct img_pixmap *img, int x, int y, float r, float g, float b, float a);
 154
 155 void img_getpixel1i(struct img_pixmap *img, int x, int y, int *pix);
 156 void img_getpixel1f(struct img_pixmap *img, int x, int y, float *pix);
 157 void img_getpixel4i(struct img_pixmap *img, int x, int y, int *r, int *g, int *b, int *a);
 158 void img_getpixel4f(struct img_pixmap *img, int x, int y, float *r, float *g, float *b, float *a);
 159
 160
 161 /* OpenGL helper functions */
 162
 163 /* Returns the equivalent OpenGL "format" as expected by the 7th argument of glTexImage2D */
 164 unsigned int img_fmt_glfmt(enum img_fmt fmt);
 165 /* Returns the equivalent OpenGL "type" as expected by the 8th argument of glTexImage2D */
 166 unsigned int img_fmt_gltype(enum img_fmt fmt);
 167 /* Returns the equivalent OpenGL "internal format" as expected by the 3rd argument of glTexImage2D */
 168 unsigned int img_fmt_glintfmt(enum img_fmt fmt);
 169
 170 /* Same as above, based on the pixel format of the supplied image */
 171 unsigned int img_glfmt(struct img_pixmap *img);
 172 unsigned int img_gltype(struct img_pixmap *img);
 173 unsigned int img_glintfmt(struct img_pixmap *img);
 174
 175 /* Creates an OpenGL texture from the image, and returns the texture id, or 0 for failure */
 176 unsigned int img_gltexture(struct img_pixmap *img);
 177
 178 /* Load an image and create an OpenGL texture out of it */
 179 unsigned int img_gltexture_load(const char *fname);
 180 unsigned int img_gltexture_read_file(FILE *fp);
 181 unsigned int img_gltexture_read(struct img_io *io);
 182
 183 /* These functions can be used to fill an img_io struct before it's passed to
 184  * one of the user-defined i/o image reading/writing functions (img_read/img_write).
 185  *
 186  * User-defined i/o functions:
 187  *
 188  * - size_t read_func(void *buffer, size_t bytes, void *user_ptr)
 189  * Must try to fill the buffer with the specified number of bytes, and return
 190  * the number of bytes actually read.
 191  *
 192  * - size_t write_func(void *buffer, size_t bytes, void *user_ptr)
 193  * Must write the specified number of bytes from the supplied buffer and return
 194  * the number of bytes actually written.
 195  *
 196  * - long seek_func(long offset, int whence, void *user_ptr)
 197  * Must seek offset bytes from: the beginning of the file if whence is SEEK_SET,
 198  * the current position if whence is SEEK_CUR, or the end of the file if whence is
 199  * SEEK_END, and return the resulting file offset from the beginning of the file.
 200  * (i.e. seek_func(0, SEEK_CUR, user_ptr); must be equivalent to an ftell).
 201  *
 202  * All three functions get the user-data pointer set through img_io_set_user_data
 203  * as their last argument.
 204  *
 205  * Note: obviously you don't need to set a write function if you're only going
 206  * to call img_read, or the read and seek function if you're only going to call
 207  * img_write.
 208  *
 209  * Note: if the user-supplied write function is buffered, make sure to flush
 210  * (or close the file) after img_write returns.
 211  */
 212 void img_io_set_user_data(struct img_io *io, void *uptr);
 213 void img_io_set_read_func(struct img_io *io, size_t (*read)(void*, size_t, void*));
 214 void img_io_set_write_func(struct img_io *io, size_t (*write)(void*, size_t, void*));
 215 void img_io_set_seek_func(struct img_io *io, long (*seek)(long, int, void*));
 216
 217
 218 #ifdef __cplusplus
 219 }
 220 #endif
 221
 222
 223 #endif  /* IMAGO_H_ */