nuclear@1: /* nuclear@1: libimago - a multi-format image file input/output library. nuclear@1: Copyright (C) 2010-2012 John Tsiombikas nuclear@1: nuclear@1: This program is free software: you can redistribute it and/or modify nuclear@1: it under the terms of the GNU Lesser General Public License as published nuclear@1: by the Free Software Foundation, either version 3 of the License, or nuclear@1: (at your option) any later version. nuclear@1: nuclear@1: This program is distributed in the hope that it will be useful, nuclear@1: but WITHOUT ANY WARRANTY; without even the implied warranty of nuclear@1: MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the nuclear@1: GNU Lesser General Public License for more details. nuclear@1: nuclear@1: You should have received a copy of the GNU Lesser General Public License nuclear@1: along with this program. If not, see . nuclear@1: */ nuclear@1: nuclear@1: #ifndef IMAGO2_H_ nuclear@1: #define IMAGO2_H_ nuclear@1: nuclear@1: #include nuclear@1: nuclear@1: #ifdef __cplusplus nuclear@1: #define IMG_OPTARG(arg, val) arg = val nuclear@1: #else nuclear@1: #define IMG_OPTARG(arg, val) arg nuclear@1: #endif nuclear@1: nuclear@1: /* XXX if you change this make sure to also change pack/unpack arrays in conv.c */ nuclear@1: enum img_fmt { nuclear@1: IMG_FMT_GREY8, nuclear@1: IMG_FMT_RGB24, nuclear@1: IMG_FMT_RGBA32, nuclear@1: IMG_FMT_GREYF, nuclear@1: IMG_FMT_RGBF, nuclear@1: IMG_FMT_RGBAF, nuclear@1: nuclear@1: NUM_IMG_FMT nuclear@1: }; nuclear@1: nuclear@1: struct img_pixmap { nuclear@1: void *pixels; nuclear@1: int width, height; nuclear@1: enum img_fmt fmt; nuclear@1: int pixelsz; nuclear@1: char *name; nuclear@1: }; nuclear@1: nuclear@1: struct img_io { nuclear@1: void *uptr; /* user-data */ nuclear@1: nuclear@1: size_t (*read)(void *buf, size_t bytes, void *uptr); nuclear@1: size_t (*write)(void *buf, size_t bytes, void *uptr); nuclear@1: long (*seek)(long offs, int whence, void *uptr); nuclear@1: }; nuclear@1: nuclear@1: #ifdef __cplusplus nuclear@1: extern "C" { nuclear@1: #endif nuclear@1: nuclear@1: /* initialize the img_pixmap structure */ nuclear@1: void img_init(struct img_pixmap *img); nuclear@1: /* destroys the img_pixmap structure, freeing the pixel buffer (if available) nuclear@1: * and any other memory held by the pixmap. nuclear@1: */ nuclear@1: void img_destroy(struct img_pixmap *img); nuclear@1: nuclear@1: /* convenience function that allocates an img_pixmap struct and then initializes it. nuclear@1: * returns null if the malloc fails. nuclear@1: */ nuclear@1: struct img_pixmap *img_create(void); nuclear@1: /* frees a pixmap previously allocated with img_create (free followed by img_destroy) */ nuclear@1: void img_free(struct img_pixmap *img); nuclear@1: nuclear@1: int img_set_name(struct img_pixmap *img, const char *name); nuclear@1: nuclear@1: /* set the image pixel format */ nuclear@1: int img_set_format(struct img_pixmap *img, enum img_fmt fmt); nuclear@1: nuclear@1: /* copies one pixmap to another. nuclear@1: * equivalent to: img_set_pixels(dest, src->width, src->height, src->fmt, src->pixels) nuclear@1: */ nuclear@1: int img_copy(struct img_pixmap *dest, struct img_pixmap *src); nuclear@1: nuclear@1: /* allocates a pixel buffer of the specified dimensions and format, and copies the nuclear@1: * pixels given through the pix pointer into it. nuclear@1: * the pix pointer can be null, in which case there's no copy, just allocation. nuclear@1: * nuclear@1: * C++: fmt and pix have default parameters IMG_FMT_RGBA32 and null respectively. nuclear@1: */ nuclear@1: 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)); nuclear@1: nuclear@1: /* Simplified image loading nuclear@1: * Loads the specified file, and returns a pointer to an array of pixels of the nuclear@1: * requested pixel format. The width and height of the image are returned through nuclear@1: * the xsz and ysz pointers. nuclear@1: * If the image cannot be loaded, the function returns null. nuclear@1: * nuclear@1: * C++: the format argument is optional and defaults to IMG_FMT_RGBA32 nuclear@1: */ nuclear@1: void *img_load_pixels(const char *fname, int *xsz, int *ysz, IMG_OPTARG(enum img_fmt fmt, IMG_FMT_RGBA32)); nuclear@1: nuclear@1: /* Simplified image saving nuclear@1: * Reads an array of pixels supplied through the pix pointer, of dimensions xsz nuclear@1: * and ysz, and pixel-format fmt, and saves it to a file. nuclear@1: * The output filetype is guessed by the filename suffix. nuclear@1: * nuclear@1: * C++: the format argument is optional and defaults to IMG_FMT_RGBA32 nuclear@1: */ nuclear@1: int img_save_pixels(const char *fname, void *pix, int xsz, int ysz, IMG_OPTARG(enum img_fmt fmt, IMG_FMT_RGBA32)); nuclear@1: nuclear@1: /* Frees the memory allocated by img_load_pixels */ nuclear@1: void img_free_pixels(void *pix); nuclear@1: nuclear@1: /* Loads an image file into the supplied pixmap */ nuclear@1: int img_load(struct img_pixmap *img, const char *fname); nuclear@1: /* Saves the supplied pixmap to a file. The output filetype is guessed by the filename suffix */ nuclear@1: int img_save(struct img_pixmap *img, const char *fname); nuclear@1: nuclear@1: /* Reads an image from an open FILE* into the supplied pixmap */ nuclear@1: int img_read_file(struct img_pixmap *img, FILE *fp); nuclear@1: /* Writes the supplied pixmap to an open FILE* */ nuclear@1: int img_write_file(struct img_pixmap *img, FILE *fp); nuclear@1: nuclear@1: /* Reads an image using user-defined file-i/o functions (see img_io_set_*) */ nuclear@1: int img_read(struct img_pixmap *img, struct img_io *io); nuclear@1: /* Writes an image using user-defined file-i/o functions (see img_io_set_*) */ nuclear@1: int img_write(struct img_pixmap *img, struct img_io *io); nuclear@1: nuclear@1: /* Converts an image to the specified pixel format */ nuclear@1: int img_convert(struct img_pixmap *img, enum img_fmt tofmt); nuclear@1: nuclear@1: /* Converts an image from an integer pixel format to the corresponding floating point one */ nuclear@1: int img_to_float(struct img_pixmap *img); nuclear@1: /* Converts an image from a floating point pixel format to the corresponding integer one */ nuclear@1: int img_to_integer(struct img_pixmap *img); nuclear@1: nuclear@1: /* Returns non-zero (true) if the supplied image is in a floating point pixel format */ nuclear@1: int img_is_float(struct img_pixmap *img); nuclear@1: /* Returns non-zero (true) if the supplied image has an alpha channel */ nuclear@1: int img_has_alpha(struct img_pixmap *img); nuclear@1: nuclear@1: nuclear@1: /* don't use these for anything performance-critical */ nuclear@1: void img_setpixel(struct img_pixmap *img, int x, int y, void *pixel); nuclear@1: void img_getpixel(struct img_pixmap *img, int x, int y, void *pixel); nuclear@1: nuclear@1: void img_setpixel1i(struct img_pixmap *img, int x, int y, int pix); nuclear@1: void img_setpixel1f(struct img_pixmap *img, int x, int y, float pix); nuclear@1: void img_setpixel4i(struct img_pixmap *img, int x, int y, int r, int g, int b, int a); nuclear@1: void img_setpixel4f(struct img_pixmap *img, int x, int y, float r, float g, float b, float a); nuclear@1: nuclear@1: void img_getpixel1i(struct img_pixmap *img, int x, int y, int *pix); nuclear@1: void img_getpixel1f(struct img_pixmap *img, int x, int y, float *pix); nuclear@1: void img_getpixel4i(struct img_pixmap *img, int x, int y, int *r, int *g, int *b, int *a); nuclear@1: void img_getpixel4f(struct img_pixmap *img, int x, int y, float *r, float *g, float *b, float *a); nuclear@1: nuclear@1: nuclear@1: /* OpenGL helper functions */ nuclear@1: nuclear@1: /* Returns the equivalent OpenGL "format" as expected by the 7th argument of glTexImage2D */ nuclear@1: unsigned int img_fmt_glfmt(enum img_fmt fmt); nuclear@1: /* Returns the equivalent OpenGL "type" as expected by the 8th argument of glTexImage2D */ nuclear@1: unsigned int img_fmt_gltype(enum img_fmt fmt); nuclear@1: /* Returns the equivalent OpenGL "internal format" as expected by the 3rd argument of glTexImage2D */ nuclear@1: unsigned int img_fmt_glintfmt(enum img_fmt fmt); nuclear@1: nuclear@1: /* Same as above, based on the pixel format of the supplied image */ nuclear@1: unsigned int img_glfmt(struct img_pixmap *img); nuclear@1: unsigned int img_gltype(struct img_pixmap *img); nuclear@1: unsigned int img_glintfmt(struct img_pixmap *img); nuclear@1: nuclear@1: /* Creates an OpenGL texture from the image, and returns the texture id, or 0 for failure */ nuclear@1: unsigned int img_gltexture(struct img_pixmap *img); nuclear@1: nuclear@1: /* Load an image and create an OpenGL texture out of it */ nuclear@1: unsigned int img_gltexture_load(const char *fname); nuclear@1: unsigned int img_gltexture_read_file(FILE *fp); nuclear@1: unsigned int img_gltexture_read(struct img_io *io); nuclear@1: nuclear@1: /* These functions can be used to fill an img_io struct before it's passed to nuclear@1: * one of the user-defined i/o image reading/writing functions (img_read/img_write). nuclear@1: * nuclear@1: * User-defined i/o functions: nuclear@1: * nuclear@1: * - size_t read_func(void *buffer, size_t bytes, void *user_ptr) nuclear@1: * Must try to fill the buffer with the specified number of bytes, and return nuclear@1: * the number of bytes actually read. nuclear@1: * nuclear@1: * - size_t write_func(void *buffer, size_t bytes, void *user_ptr) nuclear@1: * Must write the specified number of bytes from the supplied buffer and return nuclear@1: * the number of bytes actually written. nuclear@1: * nuclear@1: * - long seek_func(long offset, int whence, void *user_ptr) nuclear@1: * Must seek offset bytes from: the beginning of the file if whence is SEEK_SET, nuclear@1: * the current position if whence is SEEK_CUR, or the end of the file if whence is nuclear@1: * SEEK_END, and return the resulting file offset from the beginning of the file. nuclear@1: * (i.e. seek_func(0, SEEK_CUR, user_ptr); must be equivalent to an ftell). nuclear@1: * nuclear@1: * All three functions get the user-data pointer set through img_io_set_user_data nuclear@1: * as their last argument. nuclear@1: * nuclear@1: * Note: obviously you don't need to set a write function if you're only going nuclear@1: * to call img_read, or the read and seek function if you're only going to call nuclear@1: * img_write. nuclear@1: * nuclear@1: * Note: if the user-supplied write function is buffered, make sure to flush nuclear@1: * (or close the file) after img_write returns. nuclear@1: */ nuclear@1: void img_io_set_user_data(struct img_io *io, void *uptr); nuclear@1: void img_io_set_read_func(struct img_io *io, size_t (*read)(void*, size_t, void*)); nuclear@1: void img_io_set_write_func(struct img_io *io, size_t (*write)(void*, size_t, void*)); nuclear@1: void img_io_set_seek_func(struct img_io *io, long (*seek)(long, int, void*)); nuclear@1: nuclear@1: nuclear@1: #ifdef __cplusplus nuclear@1: } nuclear@1: #endif nuclear@1: nuclear@1: nuclear@1: #endif /* IMAGO_H_ */