libass/ass_cache.c

   1 /*
   2  * Copyright (C) 2006 Evgeniy Stepanov <eugeni.stepanov@gmail.com>
   3  *
   4  * This file is part of libass.
   5  *
   6  * libass is free software; you can redistribute it and/or modify
   7  * it under the terms of the GNU General Public License as published by
   8  * the Free Software Foundation; either version 2 of the License, or
   9  * (at your option) any later version.
  10  *
  11  * libass is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14  * GNU General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU General Public License along
  17  * with libass; if not, write to the Free Software Foundation, Inc.,
  18  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
  19  */
  20
  21 #include "config.h"
  22
  23 #include <inttypes.h>
  24 #include <ft2build.h>
  25 #include FT_FREETYPE_H
  26 #include FT_GLYPH_H
  27
  28 #include <assert.h>
  29
  30 #include "ass_utils.h"
  31 #include "ass.h"
  32 #include "ass_fontconfig.h"
  33 #include "ass_font.h"
  34 #include "ass_bitmap.h"
  35 #include "ass_cache.h"
  36
  37 static unsigned hashmap_hash(void *buf, size_t len)
  38 {
  39     return fnv_32a_buf(buf, len, FNV1_32A_INIT);
  40 }
  41
  42 static int hashmap_key_compare(void *a, void *b, size_t size)
  43 {
  44     return memcmp(a, b, size) == 0;
  45 }
  46
  47 static void hashmap_item_dtor(void *key, size_t key_size, void *value,
  48                               size_t value_size)
  49 {
  50     free(key);
  51     free(value);
  52 }
  53
  54 Hashmap *hashmap_init(ASS_Library *library, size_t key_size,
  55                       size_t value_size, int nbuckets,
  56                       HashmapItemDtor item_dtor,
  57                       HashmapKeyCompare key_compare,
  58                       HashmapHash hash)
  59 {
  60     Hashmap *map = calloc(1, sizeof(Hashmap));
  61     map->library = library;
  62     map->nbuckets = nbuckets;
  63     map->key_size = key_size;
  64     map->value_size = value_size;
  65     map->root = calloc(nbuckets, sizeof(hashmap_item_p));
  66     map->item_dtor = item_dtor ? item_dtor : hashmap_item_dtor;
  67     map->key_compare = key_compare ? key_compare : hashmap_key_compare;
  68     map->hash = hash ? hash : hashmap_hash;
  69     return map;
  70 }
  71
  72 void hashmap_done(Hashmap *map)
  73 {
  74     int i;
  75     // print stats
  76     if (map->count > 0 || map->hit_count + map->miss_count > 0)
  77         ass_msg(map->library, MSGL_V,
  78                "cache statistics: \n  total accesses: %d\n  hits: %d\n  "
  79                "misses: %d\n  object count: %d",
  80                map->hit_count + map->miss_count, map->hit_count,
  81                map->miss_count, map->count);
  82
  83     for (i = 0; i < map->nbuckets; ++i) {
  84         HashmapItem *item = map->root[i];
  85         while (item) {
  86             HashmapItem *next = item->next;
  87             map->item_dtor(item->key, map->key_size, item->value,
  88                            map->value_size);
  89             free(item);
  90             item = next;
  91         }
  92     }
  93     free(map->root);
  94     free(map);
  95 }
  96
  97 // does nothing if key already exists
  98 void *hashmap_insert(Hashmap *map, void *key, void *value)
  99 {
 100     unsigned hash = map->hash(key, map->key_size);
 101     HashmapItem **next = map->root + (hash % map->nbuckets);
 102     while (*next) {
 103         if (map->key_compare(key, (*next)->key, map->key_size))
 104             return (*next)->value;
 105         next = &((*next)->next);
 106         assert(next);
 107     }
 108     (*next) = malloc(sizeof(HashmapItem));
 109     (*next)->key = malloc(map->key_size);
 110     (*next)->value = malloc(map->value_size);
 111     memcpy((*next)->key, key, map->key_size);
 112     memcpy((*next)->value, value, map->value_size);
 113     (*next)->next = 0;
 114
 115     map->count++;
 116     return (*next)->value;
 117 }
 118
 119 void *hashmap_find(Hashmap *map, void *key)
 120 {
 121     unsigned hash = map->hash(key, map->key_size);
 122     HashmapItem *item = map->root[hash % map->nbuckets];
 123     while (item) {
 124         if (map->key_compare(key, item->key, map->key_size)) {
 125             map->hit_count++;
 126             return item->value;
 127         }
 128         item = item->next;
 129     }
 130     map->miss_count++;
 131     return 0;
 132 }
 133
 134 //---------------------------------
 135 // font cache
 136
 137 static unsigned font_desc_hash(void *buf, size_t len)
 138 {
 139     ASS_FontDesc *desc = buf;
 140     unsigned hval;
 141     hval = fnv_32a_str(desc->family, FNV1_32A_INIT);
 142     hval = fnv_32a_buf(&desc->bold, sizeof(desc->bold), hval);
 143     hval = fnv_32a_buf(&desc->italic, sizeof(desc->italic), hval);
 144     return hval;
 145 }
 146
 147 static int font_compare(void *key1, void *key2, size_t key_size)
 148 {
 149     ASS_FontDesc *a = key1;
 150     ASS_FontDesc *b = key2;
 151     if (strcmp(a->family, b->family) != 0)
 152         return 0;
 153     if (a->bold != b->bold)
 154         return 0;
 155     if (a->italic != b->italic)
 156         return 0;
 157     if (a->treat_family_as_pattern != b->treat_family_as_pattern)
 158         return 0;
 159     return 1;
 160 }
 161
 162 static void font_hash_dtor(void *key, size_t key_size, void *value,
 163                            size_t value_size)
 164 {
 165     ass_font_free(value);
 166     free(key);
 167 }
 168
 169 ASS_Font *ass_font_cache_find(Hashmap *font_cache,
 170                               ASS_FontDesc *desc)
 171 {
 172     return hashmap_find(font_cache, desc);
 173 }
 174
 175 /**
 176  * \brief Add a face struct to cache.
 177  * \param font font struct
 178 */
 179 void *ass_font_cache_add(Hashmap *font_cache, ASS_Font *font)
 180 {
 181     return hashmap_insert(font_cache, &(font->desc), font);
 182 }
 183
 184 Hashmap *ass_font_cache_init(ASS_Library *library)
 185 {
 186     Hashmap *font_cache;
 187     font_cache = hashmap_init(library, sizeof(ASS_FontDesc),
 188                               sizeof(ASS_Font),
 189                               1000,
 190                               font_hash_dtor, font_compare, font_desc_hash);
 191     return font_cache;
 192 }
 193
 194 void ass_font_cache_done(Hashmap *font_cache)
 195 {
 196     hashmap_done(font_cache);
 197 }
 198
 199
 200 // Create hash/compare functions for bitmap and glyph
 201 #define CREATE_HASH_FUNCTIONS
 202 #include "ass_cache_template.h"
 203 #define CREATE_COMPARISON_FUNCTIONS
 204 #include "ass_cache_template.h"
 205
 206 //---------------------------------
 207 // bitmap cache
 208
 209 static void bitmap_hash_dtor(void *key, size_t key_size, void *value,
 210                              size_t value_size)
 211 {
 212     BitmapHashValue *v = value;
 213     if (v->bm)
 214         ass_free_bitmap(v->bm);
 215     if (v->bm_o)
 216         ass_free_bitmap(v->bm_o);
 217     if (v->bm_s)
 218         ass_free_bitmap(v->bm_s);
 219     free(key);
 220     free(value);
 221 }
 222
 223 void *cache_add_bitmap(Hashmap *bitmap_cache, BitmapHashKey *key,
 224                        BitmapHashValue *val)
 225 {
 226     // Note: this is only an approximation
 227     if (val->bm_o)
 228         bitmap_cache->cache_size += val->bm_o->w * val->bm_o->h * 3;
 229     else if (val->bm)
 230         bitmap_cache->cache_size += val->bm->w * val->bm->h * 3;
 231
 232     return hashmap_insert(bitmap_cache, key, val);
 233 }
 234
 235 /**
 236  * \brief Get a bitmap from bitmap cache.
 237  * \param key hash key
 238  * \return requested hash val or 0 if not found
 239 */
 240 BitmapHashValue *cache_find_bitmap(Hashmap *bitmap_cache,
 241                                    BitmapHashKey *key)
 242 {
 243     return hashmap_find(bitmap_cache, key);
 244 }
 245
 246 Hashmap *ass_bitmap_cache_init(ASS_Library *library)
 247 {
 248     Hashmap *bitmap_cache;
 249     bitmap_cache = hashmap_init(library,
 250                                 sizeof(BitmapHashKey),
 251                                 sizeof(BitmapHashValue),
 252                                 0xFFFF + 13,
 253                                 bitmap_hash_dtor, bitmap_compare,
 254                                 bitmap_hash);
 255     return bitmap_cache;
 256 }
 257
 258 void ass_bitmap_cache_done(Hashmap *bitmap_cache)
 259 {
 260     hashmap_done(bitmap_cache);
 261 }
 262
 263 Hashmap *ass_bitmap_cache_reset(Hashmap *bitmap_cache)
 264 {
 265     ASS_Library *lib = bitmap_cache->library;
 266
 267     ass_bitmap_cache_done(bitmap_cache);
 268     return ass_bitmap_cache_init(lib);
 269 }
 270
 271 //---------------------------------
 272 // glyph cache
 273
 274 static void glyph_hash_dtor(void *key, size_t key_size, void *value,
 275                             size_t value_size)
 276 {
 277     GlyphHashValue *v = value;
 278     if (v->glyph)
 279         FT_Done_Glyph(v->glyph);
 280     if (v->outline_glyph)
 281         FT_Done_Glyph(v->outline_glyph);
 282     free(key);
 283     free(value);
 284 }
 285
 286 void *cache_add_glyph(Hashmap *glyph_cache, GlyphHashKey *key,
 287                       GlyphHashValue *val)
 288 {
 289     return hashmap_insert(glyph_cache, key, val);
 290 }
 291
 292 /**
 293  * \brief Get a glyph from glyph cache.
 294  * \param key hash key
 295  * \return requested hash val or 0 if not found
 296 */
 297 GlyphHashValue *cache_find_glyph(Hashmap *glyph_cache,
 298                                  GlyphHashKey *key)
 299 {
 300     return hashmap_find(glyph_cache, key);
 301 }
 302
 303 Hashmap *ass_glyph_cache_init(ASS_Library *library)
 304 {
 305     Hashmap *glyph_cache;
 306     glyph_cache = hashmap_init(library, sizeof(GlyphHashKey),
 307                                sizeof(GlyphHashValue),
 308                                0xFFFF + 13,
 309                                glyph_hash_dtor, glyph_compare, glyph_hash);
 310     return glyph_cache;
 311 }
 312
 313 void ass_glyph_cache_done(Hashmap *glyph_cache)
 314 {
 315     hashmap_done(glyph_cache);
 316 }
 317
 318 Hashmap *ass_glyph_cache_reset(Hashmap *glyph_cache)
 319 {
 320     ASS_Library *lib = glyph_cache->library;
 321
 322     ass_glyph_cache_done(glyph_cache);
 323     return ass_glyph_cache_init(lib);
 324 }
 325
 326
 327 //---------------------------------
 328 // composite cache
 329
 330 static void composite_hash_dtor(void *key, size_t key_size, void *value,
 331                                 size_t value_size)
 332 {
 333     CompositeHashValue *v = value;
 334     free(v->a);
 335     free(v->b);
 336     free(key);
 337     free(value);
 338 }
 339
 340 void *cache_add_composite(Hashmap *composite_cache,
 341                           CompositeHashKey *key,
 342                           CompositeHashValue *val)
 343 {
 344     return hashmap_insert(composite_cache, key, val);
 345 }
 346
 347 /**
 348  * \brief Get a composite bitmap from composite cache.
 349  * \param key hash key
 350  * \return requested hash val or 0 if not found
 351 */
 352 CompositeHashValue *cache_find_composite(Hashmap *composite_cache,
 353                                          CompositeHashKey *key)
 354 {
 355     return hashmap_find(composite_cache, key);
 356 }
 357
 358 Hashmap *ass_composite_cache_init(ASS_Library *library)
 359 {
 360     Hashmap *composite_cache;
 361     composite_cache = hashmap_init(library, sizeof(CompositeHashKey),
 362                                    sizeof(CompositeHashValue),
 363                                    0xFFFF + 13,
 364                                    composite_hash_dtor, composite_compare,
 365                                    composite_hash);
 366     return composite_cache;
 367 }
 368
 369 void ass_composite_cache_done(Hashmap *composite_cache)
 370 {
 371     hashmap_done(composite_cache);
 372 }
 373
 374 Hashmap *ass_composite_cache_reset(Hashmap *composite_cache)
 375 {
 376     ASS_Library *lib = composite_cache->library;
 377
 378     ass_composite_cache_done(composite_cache);
 379     return ass_composite_cache_init(lib);
 380 }