images/images.h

   1 #ifndef _IMAGES_IMAGES_H
   2 #define _IMAGES_IMAGES_H
   3
   4 #include "lib/mempool.h"
   5
   6 /* image.c */
   7
   8 /* error handling */
   9
  10 enum image_error {
  11   IMAGE_ERR_OK = 0,
  12   IMAGE_ERR_UNSPECIFIED,
  13   IMAGE_ERR_NOT_IMPLEMENTED,
  14   IMAGE_ERR_INVALID_DIMENSIONS,
  15   IMAGE_ERR_INVALID_FILE_FORMAT,
  16   IMAGE_ERR_INVALID_PIXEL_FORMAT,
  17   IMAGE_ERR_READ_FAILED,
  18   IMAGE_ERR_WRITE_FAILED,
  19   IMAGE_ERR_MAX
  20 };
  21
  22 struct image_thread {
  23   byte *err_msg;
  24   enum image_error err_code;
  25   struct mempool *pool;
  26 };
  27
  28 void image_thread_init(struct image_thread *thread);
  29 void image_thread_cleanup(struct image_thread *thread);
  30
  31 static inline void
  32 image_thread_flush(struct image_thread *thread)
  33 {
  34   thread->err_code = 0;
  35   thread->err_msg = NULL;
  36   mp_flush(thread->pool);
  37 }
  38
  39 static inline void
  40 image_thread_err(struct image_thread *thread, uns code, char *msg)
  41 {
  42   thread->err_code = code;
  43   thread->err_msg = (byte *)msg;
  44 }
  45
  46 void image_thread_err_format(struct image_thread *thread, uns code, char *msg, ...);
  47
  48 /* basic image manupulation */
  49
  50 #define IMAGE_MAX_SIZE          0xffffU /* maximum number of cols/rows, must be <(1<<16) */
  51 #define IMAGE_SSE_ALIGN_SIZE    (MAX(16, sizeof(uns)))
  52
  53 enum color_space {
  54   COLOR_SPACE_UNKNOWN,
  55   COLOR_SPACE_GRAYSCALE,
  56   COLOR_SPACE_RGB,
  57   COLOR_SPACE_MAX
  58 };
  59
  60 enum image_flag {
  61   IMAGE_COLOR_SPACE = 0x7,      /* mask for enum color_space */
  62   IMAGE_ALPHA = 0x8,            /* alpha channel */
  63   IMAGE_PIXELS_ALIGNED = 0x10,  /* align pixel size to the nearest power of two  */
  64   IMAGE_SSE_ALIGNED = 0x20,     /* align scanlines to multiples of 16 bytes (both start and size) */
  65   IMAGE_CHANNELS_FORMAT = IMAGE_COLOR_SPACE | IMAGE_ALPHA,
  66   IMAGE_PIXEL_FORMAT = IMAGE_CHANNELS_FORMAT | IMAGE_PIXELS_ALIGNED,
  67   IMAGE_ALIGNED = IMAGE_PIXELS_ALIGNED | IMAGE_SSE_ALIGNED,
  68 };
  69
  70 struct image {
  71   byte *pixels;                 /* left top pixel, there are at least sizeof(uns)
  72                                    unsed bytes after the buffer (possible optimizations) */
  73   u32 cols;                     /* number of columns */
  74   u32 rows;                     /* number of rows */
  75   u32 pixel_size;               /* size of pixel (1, 2, 3 or 4) */
  76   u32 row_size;                 /* scanline size in bytes */
  77   u32 image_size;               /* size of pixels buffer (rows * rows_size) */
  78   u32 flags;                    /* enum image_flag */
  79 };
  80
  81 struct image *image_new(struct image_thread *it, uns cols, uns rows, uns flags, struct mempool *pool);
  82 struct image *image_clone(struct image_thread *it, struct image *src, uns flags, struct mempool *pool);
  83 void image_destroy(struct image_thread *it, struct image *img); /* only with NULL mempool */
  84 void image_clear(struct image_thread *it, struct image *img);
  85
  86 byte *color_space_to_name(enum color_space cs);
  87 byte *image_channels_format_to_name(uns format);
  88 uns image_name_to_channels_format(byte *name);
  89
  90 /* scale.c */
  91
  92 int image_scale(struct image_thread *thread, struct image *dest, struct image *src);
  93 void image_dimensions_fit_to_box(u32 *cols, u32 *rows, u32 max_cols, u32 max_rows, uns upsample);
  94
  95 /* image-io.c */
  96
  97 enum image_format {
  98   IMAGE_FORMAT_UNDEFINED,
  99   IMAGE_FORMAT_JPEG,
 100   IMAGE_FORMAT_PNG,
 101   IMAGE_FORMAT_GIF,
 102   IMAGE_FORMAT_MAX
 103 };
 104
 105 struct image_io {
 106   struct image *image;
 107   struct fastbuf *fastbuf;
 108   enum image_format format;
 109   struct mempool *pool;
 110   u32 cols;
 111   u32 rows;
 112   u32 flags;
 113   /* internals */
 114   struct image_thread *thread;
 115   struct mempool *internal_pool;
 116   int image_destroy;
 117   void *read_data;
 118   void (*read_cancel)(struct image_io *io);
 119   union {
 120     struct {
 121     } jpeg;
 122     struct {
 123     } png;
 124     struct {
 125     } gif;
 126   };
 127 };
 128
 129 void image_io_init(struct image_thread *it, struct image_io *io);
 130 void image_io_cleanup(struct image_io *io);
 131 void image_io_reset(struct image_io *io);
 132
 133 int image_io_read_header(struct image_io *io);
 134 struct image *image_io_read_data(struct image_io *io, int ref);
 135 struct image *image_io_read(struct image_io *io, int ref);
 136
 137 int image_io_write(struct image_io *io);
 138
 139 byte *image_format_to_extension(enum image_format format);
 140 enum image_format image_extension_to_format(byte *extension);
 141 enum image_format image_file_name_to_format(byte *file_name);
 142
 143 /* internals */
 144
 145 #ifdef CONFIG_LIBJPEG
 146 int libjpeg_read_header(struct image_io *io);
 147 int libjpeg_read_data(struct image_io *io);
 148 int libjpeg_write(struct image_io *io);
 149 #endif
 150
 151 #ifdef CONFIG_LIBPNG
 152 int libpng_read_header(struct image_io *io);
 153 int libpng_read_data(struct image_io *io);
 154 int libpng_write(struct image_io *io);
 155 #endif
 156
 157 #ifdef CONFIG_LIBUNGIF
 158 int libungif_read_header(struct image_io *io);
 159 int libungif_read_data(struct image_io *io);
 160 #endif
 161
 162 #ifdef CONFIG_LIBMAGICK
 163 int libmagick_read_header(struct image_io *io);
 164 int libmagick_read_data(struct image_io *io);
 165 int libmagick_write(struct image_io *io);
 166 #endif
 167
 168 #endif