libnsbmp.h

Go to the documentation of this file.

/*
 * Copyright 2006 Richard Wilson <richard.wilson@netsurf-browser.org>
 * Copyright 2008 Sean Fox <dyntryx@gmail.com>
 *
 * This file is part of NetSurf's libnsbmp, http://www.netsurf-browser.org/
 * Licenced under the MIT License,
 *                http://www.opensource.org/licenses/mit-license.php
 */
 
#ifndef libnsbmp_h_
#define libnsbmp_h_
 
#include <stdbool.h>
#include <stdint.h>
#include <stddef.h>
 
/* bmp flags */
#define BMP_NEW         0
#define BMP_OPAQUE      (1 << 0)
#define BMP_CLEAR_MEMORY    (1 << 1)
 
typedef enum {
        BMP_OK = 0,
        BMP_INSUFFICIENT_MEMORY = 1,
        BMP_INSUFFICIENT_DATA = 2,
        BMP_DATA_ERROR = 3
} bmp_result;
 
typedef enum {
        BMP_ENCODING_RGB = 0,
        BMP_ENCODING_RLE8 = 1,
        BMP_ENCODING_RLE4 = 2,
        BMP_ENCODING_BITFIELDS = 3
} bmp_encoding;
 
/* API for Bitmap callbacks */
typedef void* (*bmp_bitmap_cb_create)(int width, int height, unsigned int state);
typedef void (*bmp_bitmap_cb_destroy)(void *bitmap);
typedef unsigned char* (*bmp_bitmap_cb_get_buffer)(void *bitmap);
typedef size_t (*bmp_bitmap_cb_get_bpp)(void *bitmap);
 
typedef struct bmp_bitmap_callback_vt_s {
        bmp_bitmap_cb_create bitmap_create;
        bmp_bitmap_cb_destroy bitmap_destroy;
        bmp_bitmap_cb_get_buffer bitmap_get_buffer;
} bmp_bitmap_callback_vt;
 
typedef struct bmp_image {
        bmp_bitmap_callback_vt bitmap_callbacks;
        uint8_t *bmp_data;
        uint32_t width;
        uint32_t height;
        bool decoded;
        void *bitmap;
 
        /* Internal members are listed below */
        uint32_t buffer_size;
        bmp_encoding encoding;
        uint32_t bitmap_offset;
        uint16_t bpp;
        uint32_t colours;
        uint32_t *colour_table;
        bool limited_trans;
        uint32_t trans_colour;
        bool reversed;
        bool ico;
        bool opaque;
        uint32_t mask[4];
        int32_t shift[4];
        uint32_t transparent_index;
} bmp_image;
 
typedef struct ico_image {
        bmp_image bmp;
        struct ico_image *next;
} ico_image;
 
typedef struct ico_collection {
        bmp_bitmap_callback_vt bitmap_callbacks;
        uint16_t width;
        uint16_t height;
 
        /* Internal members are listed below */
        uint8_t *ico_data;
        uint32_t buffer_size;
        ico_image *first;
} ico_collection;
 
bmp_result bmp_create(bmp_image *bmp, bmp_bitmap_callback_vt *callbacks);
 
bmp_result ico_collection_create(ico_collection *ico,
                                 bmp_bitmap_callback_vt *callbacks);
 
bmp_result bmp_analyse(bmp_image *bmp, size_t size, uint8_t *data);
 
bmp_result ico_analyse(ico_collection *ico, size_t size, uint8_t *data);
 
bmp_result bmp_decode(bmp_image *bmp);
 
bmp_result bmp_decode_trans(bmp_image *bmp, uint32_t transparent_colour);
 
bmp_image *ico_find(ico_collection *ico, uint16_t width, uint16_t height);
 
void bmp_finalise(bmp_image *bmp);
 
void ico_finalise(ico_collection *ico);
 
#endif