libass/ass_cache.c

   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 #include "config.h"
  24
  25 #include <inttypes.h>
  26 #include <ft2build.h>
  27 #include FT_FREETYPE_H
  28 #include FT_GLYPH_H
  29
  30 #include <assert.h>
  31
  32 #include "mputils.h"
  33 #include "ass.h"
  34 #include "ass_fontconfig.h"
  35 #include "ass_font.h"
  36 #include "ass_bitmap.h"
  37 #include "ass_cache.h"
  38
  39
  40 typedef struct hashmap_item_s {
  41         void* key;
  42         void* value;
  43         struct hashmap_item_s* next;
  44 } hashmap_item_t;
  45 typedef hashmap_item_t* hashmap_item_p;
  46
  47 struct hashmap_s {
  48         int nbuckets;
  49         size_t key_size, value_size;
  50         hashmap_item_p* root;
  51         hashmap_item_dtor_t item_dtor; // a destructor for hashmap key/value pairs
  52         hashmap_key_compare_t key_compare;
  53         hashmap_hash_t hash;
  54         // stats
  55         int hit_count;
  56         int miss_count;
  57         int count;
  58 };
  59
  60 #define FNV1_32A_INIT (unsigned)0x811c9dc5
  61
  62 static inline unsigned fnv_32a_buf(void* buf, size_t len, unsigned hval)
  63 {
  64         unsigned char *bp = buf;
  65         unsigned char *be = bp + len;
  66         while (bp < be) {
  67                 hval ^= (unsigned)*bp++;
  68                 hval += (hval<<1) + (hval<<4) + (hval<<7) + (hval<<8) + (hval<<24);
  69         }
  70         return hval;
  71 }
  72 static inline unsigned fnv_32a_str(char* str, unsigned hval)
  73 {
  74         unsigned char* s = (unsigned char*)str;
  75         while (*s) {
  76                 hval ^= (unsigned)*s++;
  77                 hval += (hval<<1) + (hval<<4) + (hval<<7) + (hval<<8) + (hval<<24);
  78         }
  79         return hval;
  80 }
  81
  82 static unsigned hashmap_hash(void* buf, size_t len)
  83 {
  84         return fnv_32a_buf(buf, len, FNV1_32A_INIT);
  85 }
  86
  87 static int hashmap_key_compare(void* a, void* b, size_t size)
  88 {
  89         return memcmp(a, b, size) == 0;
  90 }
  91
  92 static void hashmap_item_dtor(void* key, size_t key_size, void* value, size_t value_size)
  93 {
  94         free(key);
  95         free(value);
  96 }
  97
  98 hashmap_t* hashmap_init(size_t key_size, size_t value_size, int nbuckets,
  99                         hashmap_item_dtor_t item_dtor, hashmap_key_compare_t key_compare,
 100                         hashmap_hash_t hash)
 101 {
 102         hashmap_t* map = calloc(1, sizeof(hashmap_t));
 103         map->nbuckets = nbuckets;
 104         map->key_size = key_size;
 105         map->value_size = value_size;
 106         map->root = calloc(nbuckets, sizeof(hashmap_item_p));
 107         map->item_dtor = item_dtor ? item_dtor : hashmap_item_dtor;
 108         map->key_compare = key_compare ? key_compare : hashmap_key_compare;
 109         map->hash = hash ? hash : hashmap_hash;
 110         return map;
 111 }
 112
 113 void hashmap_done(hashmap_t* map)
 114 {
 115         int i;
 116         // print stats
 117         if (map->count > 0 || map->hit_count + map->miss_count > 0)
 118                 mp_msg(MSGT_ASS, MSGL_V, "cache statistics: \n  total accesses: %d\n  hits: %d\n  misses: %d\n  object count: %d\n",
 119                        map->hit_count + map->miss_count, map->hit_count, map->miss_count, map->count);
 120
 121         for (i = 0; i < map->nbuckets; ++i) {
 122                 hashmap_item_t* item = map->root[i];
 123                 while (item) {
 124                         hashmap_item_t* next = item->next;
 125                         map->item_dtor(item->key, map->key_size, item->value, map->value_size);
 126                         free(item);
 127                         item = next;
 128                 }
 129         }
 130         free(map->root);
 131         free(map);
 132 }
 133
 134 // does nothing if key already exists
 135 void* hashmap_insert(hashmap_t* map, void* key, void* value)
 136 {
 137         unsigned hash = map->hash(key, map->key_size);
 138         hashmap_item_t** next = map->root + (hash % map->nbuckets);
 139         while (*next) {
 140                 if (map->key_compare(key, (*next)->key, map->key_size))
 141                         return (*next)->value;
 142                 next = &((*next)->next);
 143                 assert(next);
 144         }
 145         (*next) = malloc(sizeof(hashmap_item_t));
 146         (*next)->key = malloc(map->key_size);
 147         (*next)->value = malloc(map->value_size);
 148         memcpy((*next)->key, key, map->key_size);
 149         memcpy((*next)->value, value, map->value_size);
 150         (*next)->next = 0;
 151
 152         map->count ++;
 153         return (*next)->value;
 154 }
 155
 156 void* hashmap_find(hashmap_t* map, void* key)
 157 {
 158         unsigned hash = map->hash(key, map->key_size);
 159         hashmap_item_t* item = map->root[hash % map->nbuckets];
 160         while (item) {
 161                 if (map->key_compare(key, item->key, map->key_size)) {
 162                         map->hit_count++;
 163                         return item->value;
 164                 }
 165                 item = item->next;
 166         }
 167         map->miss_count++;
 168         return 0;
 169 }
 170
 171 //---------------------------------
 172 // font cache
 173
 174 hashmap_t* font_cache;
 175
 176 static unsigned font_desc_hash(void* buf, size_t len)
 177 {
 178         ass_font_desc_t* desc = buf;
 179         unsigned hval;
 180         hval = fnv_32a_str(desc->family, FNV1_32A_INIT);
 181         hval = fnv_32a_buf(&desc->bold, sizeof(desc->bold), hval);
 182         hval = fnv_32a_buf(&desc->italic, sizeof(desc->italic), hval);
 183         return hval;
 184 }
 185
 186 static int font_compare(void* key1, void* key2, size_t key_size) {
 187         ass_font_desc_t* a = key1;
 188         ass_font_desc_t* b = key2;
 189         if (strcmp(a->family, b->family) != 0)
 190                 return 0;
 191         if (a->bold != b->bold)
 192                 return 0;
 193         if (a->italic != b->italic)
 194                 return 0;
 195         if (a->treat_family_as_pattern != b->treat_family_as_pattern)
 196                 return 0;
 197         return 1;
 198 }
 199
 200 static void font_hash_dtor(void* key, size_t key_size, void* value, size_t value_size)
 201 {
 202         ass_font_free(value);
 203         free(key);
 204 }
 205
 206 ass_font_t* ass_font_cache_find(ass_font_desc_t* desc)
 207 {
 208         return hashmap_find(font_cache, desc);
 209 }
 210
 211 /**
 212  * \brief Add a face struct to cache.
 213  * \param font font struct
 214 */
 215 void* ass_font_cache_add(ass_font_t* font)
 216 {
 217         return hashmap_insert(font_cache, &(font->desc), font);
 218 }
 219
 220 void ass_font_cache_init(void)
 221 {
 222         font_cache = hashmap_init(sizeof(ass_font_desc_t),
 223                                   sizeof(ass_font_t),
 224                                   1000,
 225                                   font_hash_dtor, font_compare, font_desc_hash);
 226 }
 227
 228 void ass_font_cache_done(void)
 229 {
 230         hashmap_done(font_cache);
 231 }
 232
 233 //---------------------------------
 234 // bitmap cache
 235
 236 hashmap_t* bitmap_cache;
 237
 238 static void bitmap_hash_dtor(void* key, size_t key_size, void* value, size_t value_size)
 239 {
 240         bitmap_hash_val_t* v = value;
 241         if (v->bm) ass_free_bitmap(v->bm);
 242         if (v->bm_o) ass_free_bitmap(v->bm_o);
 243         if (v->bm_s) ass_free_bitmap(v->bm_s);
 244         free(key);
 245         free(value);
 246 }
 247
 248 void* cache_add_bitmap(bitmap_hash_key_t* key, bitmap_hash_val_t* val)
 249 {
 250         return hashmap_insert(bitmap_cache, key, val);
 251 }
 252
 253 /**
 254  * \brief Get a bitmap from bitmap cache.
 255  * \param key hash key
 256  * \return requested hash val or 0 if not found
 257 */
 258 bitmap_hash_val_t* cache_find_bitmap(bitmap_hash_key_t* key)
 259 {
 260         return hashmap_find(bitmap_cache, key);
 261 }
 262
 263 void ass_bitmap_cache_init(void)
 264 {
 265         bitmap_cache = hashmap_init(sizeof(bitmap_hash_key_t),
 266                                    sizeof(bitmap_hash_val_t),
 267                                    0xFFFF + 13,
 268                                    bitmap_hash_dtor, NULL, NULL);
 269 }
 270
 271 void ass_bitmap_cache_done(void)
 272 {
 273         hashmap_done(bitmap_cache);
 274 }
 275
 276 void ass_bitmap_cache_reset(void)
 277 {
 278         ass_bitmap_cache_done();
 279         ass_bitmap_cache_init();
 280 }
 281
 282 //---------------------------------
 283 // glyph cache
 284
 285 hashmap_t* glyph_cache;
 286
 287 static void glyph_hash_dtor(void* key, size_t key_size, void* value, size_t value_size)
 288 {
 289         glyph_hash_val_t* v = value;
 290         if (v->glyph) FT_Done_Glyph(v->glyph);
 291         if (v->outline_glyph) FT_Done_Glyph(v->outline_glyph);
 292         free(key);
 293         free(value);
 294 }
 295
 296 void* cache_add_glyph(glyph_hash_key_t* key, glyph_hash_val_t* val)
 297 {
 298         return hashmap_insert(glyph_cache, key, val);
 299 }
 300
 301 /**
 302  * \brief Get a glyph from glyph cache.
 303  * \param key hash key
 304  * \return requested hash val or 0 if not found
 305 */
 306 glyph_hash_val_t* cache_find_glyph(glyph_hash_key_t* key)
 307 {
 308         return hashmap_find(glyph_cache, key);
 309 }
 310
 311 void ass_glyph_cache_init(void)
 312 {
 313         glyph_cache = hashmap_init(sizeof(glyph_hash_key_t),
 314                                    sizeof(glyph_hash_val_t),
 315                                    0xFFFF + 13,
 316                                    glyph_hash_dtor, NULL, NULL);
 317 }
 318
 319 void ass_glyph_cache_done(void)
 320 {
 321         hashmap_done(glyph_cache);
 322 }
 323
 324 void ass_glyph_cache_reset(void)
 325 {
 326         ass_glyph_cache_done();
 327         ass_glyph_cache_init();
 328 }
 329
 330
 331 //---------------------------------
 332 // composite cache
 333
 334 hashmap_t* composite_cache;
 335
 336 static void composite_hash_dtor(void* key, size_t key_size, void* value, size_t value_size)
 337 {
 338         composite_hash_val_t* v = value;
 339         free(v->a);
 340         free(v->b);
 341         free(key);
 342         free(value);
 343 }
 344
 345 void* cache_add_composite(composite_hash_key_t* key, composite_hash_val_t* val)
 346 {
 347         return hashmap_insert(composite_cache, key, val);
 348 }
 349
 350 /**
 351  * \brief Get a composite bitmap from composite cache.
 352  * \param key hash key
 353  * \return requested hash val or 0 if not found
 354 */
 355 composite_hash_val_t* cache_find_composite(composite_hash_key_t* key)
 356 {
 357         return hashmap_find(composite_cache, key);
 358 }
 359
 360 void ass_composite_cache_init(void)
 361 {
 362         composite_cache = hashmap_init(sizeof(composite_hash_key_t),
 363                                    sizeof(composite_hash_val_t),
 364                                    0xFFFF + 13,
 365                                    composite_hash_dtor, NULL, NULL);
 366 }
 367
 368 void ass_composite_cache_done(void)
 369 {
 370         hashmap_done(composite_cache);
 371 }
 372
 373 void ass_composite_cache_reset(void)
 374 {
 375         ass_composite_cache_done();
 376         ass_composite_cache_init();
 377 }
 378