vrshoot

annotate libs/imago/imago2.h @ 0:b2f14e535253

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