gif.c

#include <string.h>
#include <stdlib.h>
#include <stdint.h>

#include <magick/api.h>
// This is required because both GM and
// giflib define a function named
// DrawRectangle
#define DrawRectangle _DrawRectangle
#include <gif_lib.h>
#undef DrawRectangle

#include "macros.h"

#define NCOLORS 256
#define GIF_APP "NETSCAPE2.0"

#define INLINE static inline

#if !defined(GIFLIB_MAJOR) || GIFLIB_MAJOR < 5
    #define EGifOpen(x, y, z) EGifOpen(x, y)
    #define EGifCloseFile(x, y) EGifCloseFile(x)
    #define GifMakeMapObject MakeMapObject
    #define GifFreeMapObject FreeMapObject
    #define GifQuantizeBuffer QuantizeBuffer
    #define GIF_BEGIN_APP_EXTENSION(f) EGifPutExtensionFirst(f, APPLICATION_EXT_FUNC_CODE, strlen(GIF_APP), GIF_APP)
    #define GIF_END_APP_EXTENSION(f, m) EGifPutExtensionLast(f, APPLICATION_EXT_FUNC_CODE, sizeof(m), m)
#else
    #define GIF_BEGIN_APP_EXTENSION(f) ({ \
        int ret = EGifPutExtensionLeader(f, APPLICATION_EXT_FUNC_CODE); \
        if (ret != GIF_ERROR) { \
            ret = EGifPutExtensionBlock(f, strlen(GIF_APP), GIF_APP); \
        } \
        ret; \
    })
    #define GIF_END_APP_EXTENSION(f, m) ({ \
        int ret = EGifPutExtensionBlock(f, sizeof(m), m); \
        if (ret != GIF_ERROR) { \
            ret = EGifPutExtensionTrailer(f); \
        } \
        ret; \
    })
#endif

typedef struct {
    int width;
    int height;
    int duration;
    GifPixelType data[0];
} Frame;

struct _bucket {
    uint32_t key;
    GifByteType value;
    struct _bucket *next;
};

#define PIXEL_CACHE_BUCKETS 17

typedef struct {
    struct _bucket *buckets[PIXEL_CACHE_BUCKETS];
} PixelCache;

INLINE PixelCache *
pixel_cache_new(void)
{
    return calloc(1, sizeof(PixelCache));
}

INLINE void
pixel_cache_set(PixelCache *p, uint32_t key, GifByteType value)
{
    int offset = key % PIXEL_CACHE_BUCKETS;
    struct _bucket *b = malloc(sizeof(*b));
    b->key = key;
    b->value = value;
    b->next = p->buckets[offset];
    p->buckets[offset] = b;
}

INLINE int
pixel_cache_get(PixelCache *p, uint32_t key, GifByteType *value)
{
    struct _bucket *b = p->buckets[key % PIXEL_CACHE_BUCKETS];
    for (; b; b = b->next) {
        if (b->key == key) {
            *value = b->value;
            return 1;
        }
    }
    return 0;
}

INLINE void
pixel_cache_free(PixelCache *p)
{
    int ii;
    for (ii = 0; ii < PIXEL_CACHE_BUCKETS; ii++) {
        struct _bucket *b = p->buckets[ii];
        struct _bucket *next;
        for (; b; b = next) {
            next = b->next;
            free(b);
        }
    }
    free(p);
}

typedef struct {
    GifByteType *data;
    int size;
    int alloc;
    int pos;
} GifBuffer;

int
gif_buffer_write(GifFileType *ft, const GifByteType *bytes, int len)
{
    GifBuffer *buf = ft->UserData;
    if (buf->size + len > buf->alloc) {
        int new_size = buf->alloc * 1.25;
        if (new_size < buf->size + len) {
            new_size = buf->size + len;
        }
        buf->data = realloc(buf->data, new_size);
        buf->alloc = new_size;
    }
    memcpy(buf->data + buf->size, bytes, len);
    buf->size += len;
    return len;
}

int
gif_buffer_read(GifFileType *ft, GifByteType *bytes, int len)
{
    GifBuffer *buf = ft->UserData;
    int rem = buf->size - buf->pos;
    if (rem < len) {
        len = rem;
    }
    memcpy(bytes, buf->data + buf->pos, len);
    buf->pos += len;
    return len;
}

INLINE void *
gif_save(const Image *image, const ColorMapObject *color_map, Frame *frames, int count, int frame_size, int *size)
{
    GifBuffer buf = {0,};
    int estimated = count * (image->columns * image->rows);
    buf.alloc = estimated;
    buf.data = malloc(estimated);
    GifFileType *gif_file = EGifOpen(&buf, gif_buffer_write, NULL);
    if (!gif_file) {
        return NULL;
    }
    if (EGifPutScreenDesc(gif_file, image->columns, image->rows, NCOLORS, 0, color_map) == GIF_ERROR) {
        EGifCloseFile(gif_file, NULL);
        return NULL;
    }
    if (GIF_BEGIN_APP_EXTENSION(gif_file) == GIF_ERROR) {
        EGifCloseFile(gif_file, NULL);
        return NULL;
    }
    unsigned char meta[] = {
        0x01, //  data sub-block index (always 1)
        0xFF, 0xFF // 65535 repetitions - unsigned
    };
    if (GIF_END_APP_EXTENSION(gif_file, meta) == GIF_ERROR) {
        EGifCloseFile(gif_file, NULL);
        return NULL;
    }
    int ii;
    unsigned char *p = (unsigned char*)frames;
    for (ii = 0; ii < count; ii++, p += frame_size) {
        Frame *frame = (Frame*)p;
        // GCE
        unsigned char gce[] = {
            0x08, // no transparency
            frame->duration % 256, // LSB of delay
            frame->duration / 256, // MSB of delay in millisecs
            0x00, // no transparent color
        };
        if (EGifPutExtension(gif_file, GRAPHICS_EXT_FUNC_CODE, sizeof(gce), gce) == GIF_ERROR) {
            EGifCloseFile(gif_file, NULL);
            return NULL;
        }
        if (EGifPutImageDesc(gif_file, 0, 0, frame->width, frame->height, 0, NULL) == GIF_ERROR) {
            EGifCloseFile(gif_file, NULL);
            return NULL;
        }
        int yy;
        GifPixelType *p = frame->data;
        for (yy = 0; yy < frame->height; yy++, p += frame->width) {
            if (EGifPutLine(gif_file, p, frame->width) == GIF_ERROR) {
                EGifCloseFile(gif_file, NULL);
                return NULL;
            }
        }
    } 
    EGifCloseFile(gif_file, NULL);
    *size = buf.size;
    return buf.data;
}

INLINE int
acquire_image_pixels(const Image *image, GifByteType *red, GifByteType *green, GifByteType *blue)
{
    register long y;
    register long x;
    register const PixelPacket *p;
    ExceptionInfo ex;
    int width = image->columns;
    int height = image->rows;
    int ii = 0;
    for(y = 0; y < height; ++y) {
        p = ACQUIRE_IMAGE_PIXELS(image, 0, y, width, 1, &ex);
        if (!p) {
            return 0;
        }
        for (x = 0; x < width; x++, ii++, p++) {
            red[ii] = ScaleQuantumToChar(p->red);
            green[ii] = ScaleQuantumToChar(p->green);
            blue[ii] = ScaleQuantumToChar(p->blue);
        }
    }
    return 1;
}

INLINE int
aprox_image_pixels(const Image *image, GifColorType *colors, int color_count, PixelCache *cache, GifPixelType *out)
{
    int width = image->columns;
    int height = image->rows;
    ExceptionInfo ex;
    int ii;
    int jj;
    register const PixelPacket *p = ACQUIRE_IMAGE_PIXELS(image, 0, 0, width, height, &ex);
    if (!p) {
        return 0;
    }
    int end = width * height;
    for (ii = 0; ii < end; ii++, p++) {
        GifByteType r = ScaleQuantumToChar(p->red);
        GifByteType g = ScaleQuantumToChar(p->green);
        GifByteType b = ScaleQuantumToChar(p->blue);
        uint32_t key = (r << 16) + (g << 8) + b;
        if (!pixel_cache_get(cache, key, &out[ii])) {
            int min_delta = 3 * (NCOLORS * NCOLORS);
            int min_pos = 0;
            GifColorType *c = colors;
            for (jj = 0; jj < color_count; jj++, c++) {
                int rd = c->Red - r;
                int gd = c->Green - g;
                int bd = c->Blue - b;
                int delta = (rd * rd) + (gd * gd) + (bd * bd);
                if (delta < min_delta) {
                    min_delta = delta;
                    min_pos = jj;
                    if (min_delta == 0) {
                        break;
                    }
                }
            }
            out[ii] = min_pos;
            pixel_cache_set(cache, key, min_pos);
        }
    }
    return 1;
}

void *
gif_encode(Image *image, int single, int *size)
{
    int width = image->columns;
    int height = image->rows;
    int total = width * height;
    GifByteType red[total];
    GifByteType green[total];
    GifByteType blue[total];

    // Quantize the images using IM/GM first, to reduce
    // their number of colors to 256.
    int count = GetImageListLength(image);
    QuantizeInfo info;
    GetQuantizeInfo(&info);
    info.dither = 0;
    info.number_colors = NCOLORS;
    QuantizeImage(&info, image);
    if (count > 1) {
#ifdef _MAGICK_USES_IM
        RemapImages(&info, image->next, image);
#else
        MapImages(image->next, image, 0);
#endif
    }

    if (!acquire_image_pixels(image, red, green, blue)) {
        return NULL;
    }

    size_t frame_size = sizeof(Frame) + total;
    Frame *frames = malloc(frame_size * count);

    ColorMapObject *palette = GifMakeMapObject(NCOLORS, NULL);
    int palette_size = NCOLORS;

    // Quantize again using giflib, since it yields a palette which produces
    // better compression, reducing the file size by 20%. Note that this second
    // quantization is very fast, because the image already has 256 colors, so
    // its effect on performance is negligible.
    if (GifQuantizeBuffer(width, height, &palette_size, red, green, blue, frames->data, palette->Colors) == GIF_ERROR) {
        GifFreeMapObject(palette);
        free(frames);
        return NULL;
    }

    frames->width = width;
    frames->height = height;
    frames->duration = image->delay;
    GifColorType *colors = palette->Colors;

    Image *cur = image->next;
    PixelCache *cache = pixel_cache_new();
    unsigned char *p = (unsigned char*)frames;
    int ii;
    for (ii = 1; ii < count; ii++, cur = cur->next) {
        p += frame_size;
        Frame *frame = (Frame*)p;
        frame->width = width;
        frame->height = height;
        frame->duration = cur->delay;
        GifPixelType *data = frame->data;
        
        if (!aprox_image_pixels(cur, colors, palette_size, cache, data)) {
            GifFreeMapObject(palette);
            free(frames);
            pixel_cache_free(cache);
            return NULL;
        }
    }
    pixel_cache_free(cache);
    void *ret = gif_save(image, palette, frames, count, frame_size, size);
    GifFreeMapObject(palette);
    free(frames);
    return ret;
}