lv_img_buf.h

Go to the documentation of this file.

 
#ifndef LV_IMG_BUF_H
#define LV_IMG_BUF_H
 
#ifdef __cplusplus
extern "C" {
#endif
 
/*********************
 *      INCLUDES
 *********************/
#include <stdbool.h>
#include "../misc/lv_color.h"
#include "../misc/lv_area.h"
 
/*********************
 *      DEFINES
 *********************/
/*If image pixels contains alpha we need to know how much byte is a pixel*/
#if LV_COLOR_DEPTH == 1 || LV_COLOR_DEPTH == 8
#define LV_IMG_PX_SIZE_ALPHA_BYTE 2
#elif LV_COLOR_DEPTH == 16
#define LV_IMG_PX_SIZE_ALPHA_BYTE 3
#elif LV_COLOR_DEPTH == 32
#define LV_IMG_PX_SIZE_ALPHA_BYTE 4
#endif
 
#define LV_IMG_BUF_SIZE_TRUE_COLOR(w, h) ((LV_COLOR_SIZE / 8) * w * h)
#define LV_IMG_BUF_SIZE_TRUE_COLOR_CHROMA_KEYED(w, h) ((LV_COLOR_SIZE / 8) * w * h)
#define LV_IMG_BUF_SIZE_TRUE_COLOR_ALPHA(w, h) (LV_IMG_PX_SIZE_ALPHA_BYTE * w * h)
 
/*+ 1: to be sure no fractional row*/
#define LV_IMG_BUF_SIZE_ALPHA_1BIT(w, h) ((((w / 8) + 1) * h))
#define LV_IMG_BUF_SIZE_ALPHA_2BIT(w, h) ((((w / 4) + 1) * h))
#define LV_IMG_BUF_SIZE_ALPHA_4BIT(w, h) ((((w / 2) + 1) * h))
#define LV_IMG_BUF_SIZE_ALPHA_8BIT(w, h) ((w * h))
 
/*4 * X: for palette*/
#define LV_IMG_BUF_SIZE_INDEXED_1BIT(w, h) (LV_IMG_BUF_SIZE_ALPHA_1BIT(w, h) + 4 * 2)
#define LV_IMG_BUF_SIZE_INDEXED_2BIT(w, h) (LV_IMG_BUF_SIZE_ALPHA_2BIT(w, h) + 4 * 4)
#define LV_IMG_BUF_SIZE_INDEXED_4BIT(w, h) (LV_IMG_BUF_SIZE_ALPHA_4BIT(w, h) + 4 * 16)
#define LV_IMG_BUF_SIZE_INDEXED_8BIT(w, h) (LV_IMG_BUF_SIZE_ALPHA_8BIT(w, h) + 4 * 256)
 
#define _LV_ZOOM_INV_UPSCALE 5
 
/**********************
 *      TYPEDEFS
 **********************/
 
/*Image color format*/
enum {
    LV_IMG_CF_UNKNOWN = 0,
 
    LV_IMG_CF_RAW,              
    LV_IMG_CF_RAW_ALPHA,        
    LV_IMG_CF_RAW_CHROMA_KEYED, 
    LV_IMG_CF_TRUE_COLOR,              
    LV_IMG_CF_TRUE_COLOR_ALPHA,        
    LV_IMG_CF_TRUE_COLOR_CHROMA_KEYED, 
    LV_IMG_CF_INDEXED_1BIT, 
    LV_IMG_CF_INDEXED_2BIT, 
    LV_IMG_CF_INDEXED_4BIT, 
    LV_IMG_CF_INDEXED_8BIT, 
    LV_IMG_CF_ALPHA_1BIT, 
    LV_IMG_CF_ALPHA_2BIT, 
    LV_IMG_CF_ALPHA_4BIT, 
    LV_IMG_CF_ALPHA_8BIT, 
    LV_IMG_CF_RGB888,
    LV_IMG_CF_RGBA8888,
    LV_IMG_CF_RGBX8888,
    LV_IMG_CF_RGB565,
    LV_IMG_CF_RGBA5658,
    LV_IMG_CF_RGB565A8,
 
    LV_IMG_CF_RESERVED_15,              
    LV_IMG_CF_RESERVED_16,              
    LV_IMG_CF_RESERVED_17,              
    LV_IMG_CF_RESERVED_18,              
    LV_IMG_CF_RESERVED_19,              
    LV_IMG_CF_RESERVED_20,              
    LV_IMG_CF_RESERVED_21,              
    LV_IMG_CF_RESERVED_22,              
    LV_IMG_CF_RESERVED_23,              
    LV_IMG_CF_USER_ENCODED_0,          
    LV_IMG_CF_USER_ENCODED_1,          
    LV_IMG_CF_USER_ENCODED_2,          
    LV_IMG_CF_USER_ENCODED_3,          
    LV_IMG_CF_USER_ENCODED_4,          
    LV_IMG_CF_USER_ENCODED_5,          
    LV_IMG_CF_USER_ENCODED_6,          
    LV_IMG_CF_USER_ENCODED_7,          
};
typedef uint8_t lv_img_cf_t;
 
 
#if LV_BIG_ENDIAN_SYSTEM
typedef struct {
 
    uint32_t h : 11; /*Height of the image map*/
    uint32_t w : 11; /*Width of the image map*/
    uint32_t reserved : 2; /*Reserved to be used later*/
    uint32_t always_zero : 3; /*It the upper bits of the first byte. Always zero to look like a
                                 non-printable character*/
    uint32_t cf : 5;          /*Color format: See `lv_img_color_format_t`*/
 
} lv_img_header_t;
#else
typedef struct {
 
    uint32_t cf : 5;          /*Color format: See `lv_img_color_format_t`*/
    uint32_t always_zero : 3; /*It the upper bits of the first byte. Always zero to look like a
                                 non-printable character*/
 
    uint32_t reserved : 2; /*Reserved to be used later*/
 
    uint32_t w : 11; /*Width of the image map*/
    uint32_t h : 11; /*Height of the image map*/
} lv_img_header_t;
#endif
 
typedef struct {
    lv_img_header_t header; 
    uint32_t data_size;     
    const uint8_t * data;   
} lv_img_dsc_t;
 
/**********************
 * GLOBAL PROTOTYPES
 **********************/
 
lv_img_dsc_t * lv_img_buf_alloc(lv_coord_t w, lv_coord_t h, lv_img_cf_t cf);
 
lv_color_t lv_img_buf_get_px_color(lv_img_dsc_t * dsc, lv_coord_t x, lv_coord_t y, lv_color_t color);
 
lv_opa_t lv_img_buf_get_px_alpha(lv_img_dsc_t * dsc, lv_coord_t x, lv_coord_t y);
 
void lv_img_buf_set_px_color(lv_img_dsc_t * dsc, lv_coord_t x, lv_coord_t y, lv_color_t c);
 
void lv_img_buf_set_px_alpha(lv_img_dsc_t * dsc, lv_coord_t x, lv_coord_t y, lv_opa_t opa);
 
void lv_img_buf_set_palette(lv_img_dsc_t * dsc, uint8_t id, lv_color_t c);
 
void lv_img_buf_free(lv_img_dsc_t * dsc);
 
uint32_t lv_img_buf_get_img_size(lv_coord_t w, lv_coord_t h, lv_img_cf_t cf);
 
void _lv_img_buf_get_transformed_area(lv_area_t * res, lv_coord_t w, lv_coord_t h, int16_t angle, uint16_t zoom,
                                      const lv_point_t * pivot);
 
/**********************
 *      MACROS
 **********************/
 
#ifdef __cplusplus
} /*extern "C"*/
#endif
 
#endif /*LV_IMG_BUF_H*/