libass/ass_cache.h

   1 // -*- c-basic-offset: 8; indent-tabs-mode: t -*-
   2 // vim:ts=8:sw=8:noet:ai:
   3 /*
   4  * Copyright (C) 2006 Evgeniy Stepanov <eugeni.stepanov@gmail.com>
   5  *
   6  * This file is part of libass.
   7  *
   8  * libass is free software; you can redistribute it and/or modify
   9  * it under the terms of the GNU General Public License as published by
  10  * the Free Software Foundation; either version 2 of the License, or
  11  * (at your option) any later version.
  12  *
  13  * libass is distributed in the hope that it will be useful,
  14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  16  * GNU General Public License for more details.
  17  *
  18  * You should have received a copy of the GNU General Public License along
  19  * with libass; if not, write to the Free Software Foundation, Inc.,
  20  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
  21  */
  22
  23 #ifndef LIBASS_CACHE_H
  24 #define LIBASS_CACHE_H
  25
  26 #include "ass.h"
  27 #include "ass_font.h"
  28 #include "ass_bitmap.h"
  29
  30 void ass_font_cache_init(void);
  31 ass_font_t* ass_font_cache_find(ass_font_desc_t* desc);
  32 void* ass_font_cache_add(ass_font_t* font);
  33 void ass_font_cache_done(void);
  34
  35
  36 // describes a bitmap; bitmaps with equivalents structs are considered identical
  37 typedef struct bitmap_hash_key_s {
  38         char bitmap; // bool : true = bitmap, false = outline
  39         ass_font_t* font;
  40         double size; // font size
  41         uint32_t ch; // character code
  42         unsigned outline; // border width, 16.16 fixed point value
  43         int bold, italic;
  44         char be; // blur edges
  45
  46         unsigned scale_x, scale_y; // 16.16
  47         int frx, fry, frz; // signed 16.16
  48         int shift_x, shift_y; // shift vector that was added to glyph before applying rotation
  49                               // = 0, if frx = fry = frx = 0
  50                               // = (glyph base point) - (rotation origin), otherwise
  51
  52         FT_Vector advance; // subpixel shift vector
  53 } bitmap_hash_key_t;
  54
  55 typedef struct bitmap_hash_val_s {
  56         bitmap_t* bm; // the actual bitmaps
  57         bitmap_t* bm_o;
  58         bitmap_t* bm_s;
  59 } bitmap_hash_val_t;
  60
  61 void ass_bitmap_cache_init(void);
  62 void* cache_add_bitmap(bitmap_hash_key_t* key, bitmap_hash_val_t* val);
  63 bitmap_hash_val_t* cache_find_bitmap(bitmap_hash_key_t* key);
  64 void ass_bitmap_cache_reset(void);
  65 void ass_bitmap_cache_done(void);
  66
  67 // describes an outline glyph
  68 typedef struct glyph_hash_key_s {
  69         ass_font_t* font;
  70         double size; // font size
  71         uint32_t ch; // character code
  72         int bold, italic;
  73         unsigned scale_x, scale_y; // 16.16
  74         FT_Vector advance; // subpixel shift vector
  75         unsigned outline; // border width, 16.16
  76 } glyph_hash_key_t;
  77
  78 typedef struct glyph_hash_val_s {
  79         FT_Glyph glyph;
  80         FT_Glyph outline_glyph;
  81         FT_BBox bbox_scaled; // bbox after scaling, but before rotation
  82         FT_Vector advance; // 26.6, advance distance to the next bitmap in line
  83 } glyph_hash_val_t;
  84
  85 void ass_glyph_cache_init(void);
  86 void* cache_add_glyph(glyph_hash_key_t* key, glyph_hash_val_t* val);
  87 glyph_hash_val_t* cache_find_glyph(glyph_hash_key_t* key);
  88 void ass_glyph_cache_reset(void);
  89 void ass_glyph_cache_done(void);
  90
  91 typedef struct hashmap_s hashmap_t;
  92 typedef void (*hashmap_item_dtor_t)(void* key, size_t key_size, void* value, size_t value_size);
  93 typedef int (*hashmap_key_compare_t)(void* key1, void* key2, size_t key_size);
  94 typedef unsigned (*hashmap_hash_t)(void* key, size_t key_size);
  95
  96 hashmap_t* hashmap_init(size_t key_size, size_t value_size, int nbuckets,
  97                         hashmap_item_dtor_t item_dtor, hashmap_key_compare_t key_compare,
  98                         hashmap_hash_t hash);
  99 void hashmap_done(hashmap_t* map);
 100 void* hashmap_insert(hashmap_t* map, void* key, void* value);
 101 void* hashmap_find(hashmap_t* map, void* key);
 102
 103 #endif /* LIBASS_CACHE_H */