libass/ass_cache.h

   1 /*
   2  * Copyright (C) 2006 Evgeniy Stepanov <eugeni.stepanov@gmail.com>
   3  * Copyright (C) 2011 Grigori Goronzy <greg@chown.ath.cx>
   4  *
   5  * This file is part of libass.
   6  *
   7  * Permission to use, copy, modify, and distribute this software for any
   8  * purpose with or without fee is hereby granted, provided that the above
   9  * copyright notice and this permission notice appear in all copies.
  10  *
  11  * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
  12  * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
  13  * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
  14  * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
  15  * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
  16  * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
  17  * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
  18  */
  19
  20 #ifndef LIBASS_CACHE_H
  21 #define LIBASS_CACHE_H
  22
  23 #include "ass.h"
  24 #include "ass_font.h"
  25 #include "ass_bitmap.h"
  26
  27 typedef struct cache Cache;
  28
  29 // Create definitions for bitmap, glyph and composite hash keys
  30 #define CREATE_STRUCT_DEFINITIONS
  31 #include "ass_cache_template.h"
  32
  33 typedef struct {
  34     Bitmap *bm;               // the actual bitmaps
  35     Bitmap *bm_o;
  36     Bitmap *bm_s;
  37 } BitmapHashValue;
  38
  39 typedef struct {
  40     unsigned char *a;
  41     unsigned char *b;
  42 } CompositeHashValue;
  43
  44 typedef struct {
  45     FT_Library lib;
  46     FT_Outline *outline;
  47     FT_Outline *border;
  48     FT_BBox bbox_scaled;        // bbox after scaling, but before rotation
  49     FT_Vector advance;          // 26.6, advance distance to the next bitmap in line
  50     int asc, desc;              // ascender/descender of a drawing
  51 } GlyphHashValue;
  52
  53 // Type-specific function pointers
  54 typedef unsigned(*HashFunction)(void *key, size_t key_size);
  55 typedef size_t(*ItemSize)(void *value, size_t value_size);
  56 typedef unsigned(*HashCompare)(void *a, void *b, size_t key_size);
  57 typedef void(*CacheItemDestructor)(void *key, void *value);
  58
  59 Cache *ass_cache_create(HashFunction hash_func, HashCompare compare_func,
  60                         CacheItemDestructor destruct_func, ItemSize size_func,
  61                         size_t key_size, size_t value_size);
  62 void *ass_cache_put(Cache *cache, void *key, void *value);
  63 void *ass_cache_get(Cache *cache, void *key);
  64 size_t ass_cache_empty(Cache *cache, size_t max_size);
  65 void ass_cache_stats(Cache *cache, size_t *size, unsigned *hits,
  66                      unsigned *misses, unsigned *count);
  67 void ass_cache_done(Cache *cache);
  68 Cache *ass_font_cache_create(void);
  69 Cache *ass_glyph_cache_create(void);
  70 Cache *ass_bitmap_cache_create(void);
  71 Cache *ass_composite_cache_create(void);
  72
  73 #endif                          /* LIBASS_CACHE_H */