src/hb-ot-font.cc

   1 /*
   2  * Copyright © 2011,2014  Google, Inc.
   3  *
   4  *  This is part of HarfBuzz, a text shaping library.
   5  *
   6  * Permission is hereby granted, without written agreement and without
   7  * license or royalty fees, to use, copy, modify, and distribute this
   8  * software and its documentation for any purpose, provided that the
   9  * above copyright notice and the following two paragraphs appear in
  10  * all copies of this software.
  11  *
  12  * IN NO EVENT SHALL THE COPYRIGHT HOLDER BE LIABLE TO ANY PARTY FOR
  13  * DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES
  14  * ARISING OUT OF THE USE OF THIS SOFTWARE AND ITS DOCUMENTATION, EVEN
  15  * IF THE COPYRIGHT HOLDER HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH
  16  * DAMAGE.
  17  *
  18  * THE COPYRIGHT HOLDER SPECIFICALLY DISCLAIMS ANY WARRANTIES, INCLUDING,
  19  * BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
  20  * FITNESS FOR A PARTICULAR PURPOSE.  THE SOFTWARE PROVIDED HEREUNDER IS
  21  * ON AN "AS IS" BASIS, AND THE COPYRIGHT HOLDER HAS NO OBLIGATION TO
  22  * PROVIDE MAINTENANCE, SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS.
  23  *
  24  * Google Author(s): Behdad Esfahbod, Roozbeh Pournader
  25  */
  26
  27 #include "hb.hh"
  28
  29 #ifndef HB_NO_OT_FONT
  30
  31 #include "hb-ot.h"
  32
  33 #include "hb-font.hh"
  34 #include "hb-machinery.hh"
  35 #include "hb-ot-face.hh"
  36
  37 #include "hb-ot-cmap-table.hh"
  38 #include "hb-ot-glyf-table.hh"
  39 #include "hb-ot-cff1-table.hh"
  40 #include "hb-ot-cff2-table.hh"
  41 #include "hb-ot-hmtx-table.hh"
  42 #include "hb-ot-os2-table.hh"
  43 #include "hb-ot-post-table.hh"
  44 #include "hb-ot-stat-table.hh" // Just so we compile it; unused otherwise.
  45 #include "hb-ot-vorg-table.hh"
  46 #include "hb-ot-color-cbdt-table.hh"
  47 #include "hb-ot-color-sbix-table.hh"
  48
  49
  50 /**
  51  * SECTION:hb-ot-font
  52  * @title: hb-ot-font
  53  * @short_description: OpenType font implementation
  54  * @include: hb-ot.h
  55  *
  56  * Functions for using OpenType fonts with hb_shape().  Note that fonts returned
  57  * by hb_font_create() default to using these functions, so most clients would
  58  * never need to call these functions directly.
  59  **/
  60
  61
  62 static hb_bool_t
  63 hb_ot_get_nominal_glyph (hb_font_t *font HB_UNUSED,
  64                          void *font_data,
  65                          hb_codepoint_t unicode,
  66                          hb_codepoint_t *glyph,
  67                          void *user_data HB_UNUSED)
  68 {
  69   const hb_ot_face_t *ot_face = (const hb_ot_face_t *) font_data;
  70   return ot_face->cmap->get_nominal_glyph (unicode, glyph);
  71 }
  72
  73 static unsigned int
  74 hb_ot_get_nominal_glyphs (hb_font_t *font HB_UNUSED,
  75                           void *font_data,
  76                           unsigned int count,
  77                           const hb_codepoint_t *first_unicode,
  78                           unsigned int unicode_stride,
  79                           hb_codepoint_t *first_glyph,
  80                           unsigned int glyph_stride,
  81                           void *user_data HB_UNUSED)
  82 {
  83   const hb_ot_face_t *ot_face = (const hb_ot_face_t *) font_data;
  84   return ot_face->cmap->get_nominal_glyphs (count,
  85                                             first_unicode, unicode_stride,
  86                                             first_glyph, glyph_stride);
  87 }
  88
  89 static hb_bool_t
  90 hb_ot_get_variation_glyph (hb_font_t *font HB_UNUSED,
  91                            void *font_data,
  92                            hb_codepoint_t unicode,
  93                            hb_codepoint_t variation_selector,
  94                            hb_codepoint_t *glyph,
  95                            void *user_data HB_UNUSED)
  96 {
  97   const hb_ot_face_t *ot_face = (const hb_ot_face_t *) font_data;
  98   return ot_face->cmap->get_variation_glyph (unicode, variation_selector, glyph);
  99 }
 100
 101 static void
 102 hb_ot_get_glyph_h_advances (hb_font_t* font, void* font_data,
 103                             unsigned count,
 104                             const hb_codepoint_t *first_glyph,
 105                             unsigned glyph_stride,
 106                             hb_position_t *first_advance,
 107                             unsigned advance_stride,
 108                             void *user_data HB_UNUSED)
 109 {
 110   const hb_ot_face_t *ot_face = (const hb_ot_face_t *) font_data;
 111   const OT::hmtx_accelerator_t &hmtx = *ot_face->hmtx;
 112
 113   for (unsigned int i = 0; i < count; i++)
 114   {
 115     *first_advance = font->em_scale_x (hmtx.get_advance (*first_glyph, font));
 116     first_glyph = &StructAtOffsetUnaligned<hb_codepoint_t> (first_glyph, glyph_stride);
 117     first_advance = &StructAtOffsetUnaligned<hb_position_t> (first_advance, advance_stride);
 118   }
 119 }
 120
 121 static void
 122 hb_ot_get_glyph_v_advances (hb_font_t* font, void* font_data,
 123                             unsigned count,
 124                             const hb_codepoint_t *first_glyph,
 125                             unsigned glyph_stride,
 126                             hb_position_t *first_advance,
 127                             unsigned advance_stride,
 128                             void *user_data HB_UNUSED)
 129 {
 130   const hb_ot_face_t *ot_face = (const hb_ot_face_t *) font_data;
 131   const OT::vmtx_accelerator_t &vmtx = *ot_face->vmtx;
 132
 133   for (unsigned int i = 0; i < count; i++)
 134   {
 135     *first_advance = font->em_scale_y (-(int) vmtx.get_advance (*first_glyph, font));
 136     first_glyph = &StructAtOffsetUnaligned<hb_codepoint_t> (first_glyph, glyph_stride);
 137     first_advance = &StructAtOffsetUnaligned<hb_position_t> (first_advance, advance_stride);
 138   }
 139 }
 140
 141 static hb_bool_t
 142 hb_ot_get_glyph_v_origin (hb_font_t *font,
 143                           void *font_data,
 144                           hb_codepoint_t glyph,
 145                           hb_position_t *x,
 146                           hb_position_t *y,
 147                           void *user_data HB_UNUSED)
 148 {
 149   const hb_ot_face_t *ot_face = (const hb_ot_face_t *) font_data;
 150
 151   *x = font->get_glyph_h_advance (glyph) / 2;
 152
 153 #ifndef HB_NO_OT_FONT_CFF
 154   const OT::VORG &VORG = *ot_face->VORG;
 155   if (VORG.has_data ())
 156   {
 157     *y = font->em_scale_y (VORG.get_y_origin (glyph));
 158     return true;
 159   }
 160 #endif
 161
 162   hb_glyph_extents_t extents = {0};
 163   if (ot_face->glyf->get_extents (font, glyph, &extents))
 164   {
 165     const OT::vmtx_accelerator_t &vmtx = *ot_face->vmtx;
 166     hb_position_t tsb = vmtx.get_side_bearing (font, glyph);
 167     *y = extents.y_bearing + font->em_scale_y (tsb);
 168     return true;
 169   }
 170
 171   hb_font_extents_t font_extents;
 172   font->get_h_extents_with_fallback (&font_extents);
 173   *y = font_extents.ascender;
 174
 175   return true;
 176 }
 177
 178 static hb_bool_t
 179 hb_ot_get_glyph_extents (hb_font_t *font,
 180                          void *font_data,
 181                          hb_codepoint_t glyph,
 182                          hb_glyph_extents_t *extents,
 183                          void *user_data HB_UNUSED)
 184 {
 185   const hb_ot_face_t *ot_face = (const hb_ot_face_t *) font_data;
 186
 187 #if !defined(HB_NO_OT_FONT_BITMAP) && !defined(HB_NO_COLOR)
 188   if (ot_face->sbix->get_extents (font, glyph, extents)) return true;
 189 #endif
 190   if (ot_face->glyf->get_extents (font, glyph, extents)) return true;
 191 #ifndef HB_NO_OT_FONT_CFF
 192   if (ot_face->cff1->get_extents (font, glyph, extents)) return true;
 193   if (ot_face->cff2->get_extents (font, glyph, extents)) return true;
 194 #endif
 195 #if !defined(HB_NO_OT_FONT_BITMAP) && !defined(HB_NO_COLOR)
 196   if (ot_face->CBDT->get_extents (font, glyph, extents)) return true;
 197 #endif
 198
 199   // TODO Hook up side-bearings variations.
 200   return false;
 201 }
 202
 203 #ifndef HB_NO_OT_FONT_GLYPH_NAMES
 204 static hb_bool_t
 205 hb_ot_get_glyph_name (hb_font_t *font HB_UNUSED,
 206                       void *font_data,
 207                       hb_codepoint_t glyph,
 208                       char *name, unsigned int size,
 209                       void *user_data HB_UNUSED)
 210 {
 211   const hb_ot_face_t *ot_face = (const hb_ot_face_t *) font_data;
 212   if (ot_face->post->get_glyph_name (glyph, name, size)) return true;
 213 #ifndef HB_NO_OT_FONT_CFF
 214   if (ot_face->cff1->get_glyph_name (glyph, name, size)) return true;
 215 #endif
 216   return false;
 217 }
 218 static hb_bool_t
 219 hb_ot_get_glyph_from_name (hb_font_t *font HB_UNUSED,
 220                            void *font_data,
 221                            const char *name, int len,
 222                            hb_codepoint_t *glyph,
 223                            void *user_data HB_UNUSED)
 224 {
 225   const hb_ot_face_t *ot_face = (const hb_ot_face_t *) font_data;
 226   if (ot_face->post->get_glyph_from_name (name, len, glyph)) return true;
 227 #ifndef HB_NO_OT_FONT_CFF
 228     if (ot_face->cff1->get_glyph_from_name (name, len, glyph)) return true;
 229 #endif
 230   return false;
 231 }
 232 #endif
 233
 234 static hb_bool_t
 235 hb_ot_get_font_h_extents (hb_font_t *font,
 236                           void *font_data HB_UNUSED,
 237                           hb_font_extents_t *metrics,
 238                           void *user_data HB_UNUSED)
 239 {
 240   return _hb_ot_metrics_get_position_common (font, HB_OT_METRICS_TAG_HORIZONTAL_ASCENDER, &metrics->ascender) &&
 241          _hb_ot_metrics_get_position_common (font, HB_OT_METRICS_TAG_HORIZONTAL_DESCENDER, &metrics->descender) &&
 242          _hb_ot_metrics_get_position_common (font, HB_OT_METRICS_TAG_HORIZONTAL_LINE_GAP, &metrics->line_gap);
 243 }
 244
 245 static hb_bool_t
 246 hb_ot_get_font_v_extents (hb_font_t *font,
 247                           void *font_data HB_UNUSED,
 248                           hb_font_extents_t *metrics,
 249                           void *user_data HB_UNUSED)
 250 {
 251   return _hb_ot_metrics_get_position_common (font, HB_OT_METRICS_TAG_VERTICAL_ASCENDER, &metrics->ascender) &&
 252          _hb_ot_metrics_get_position_common (font, HB_OT_METRICS_TAG_VERTICAL_DESCENDER, &metrics->descender) &&
 253          _hb_ot_metrics_get_position_common (font, HB_OT_METRICS_TAG_VERTICAL_LINE_GAP, &metrics->line_gap);
 254 }
 255
 256 #if HB_USE_ATEXIT
 257 static void free_static_ot_funcs ();
 258 #endif
 259
 260 static struct hb_ot_font_funcs_lazy_loader_t : hb_font_funcs_lazy_loader_t<hb_ot_font_funcs_lazy_loader_t>
 261 {
 262   static hb_font_funcs_t *create ()
 263   {
 264     hb_font_funcs_t *funcs = hb_font_funcs_create ();
 265
 266     hb_font_funcs_set_font_h_extents_func (funcs, hb_ot_get_font_h_extents, nullptr, nullptr);
 267     hb_font_funcs_set_font_v_extents_func (funcs, hb_ot_get_font_v_extents, nullptr, nullptr);
 268     hb_font_funcs_set_nominal_glyph_func (funcs, hb_ot_get_nominal_glyph, nullptr, nullptr);
 269     hb_font_funcs_set_nominal_glyphs_func (funcs, hb_ot_get_nominal_glyphs, nullptr, nullptr);
 270     hb_font_funcs_set_variation_glyph_func (funcs, hb_ot_get_variation_glyph, nullptr, nullptr);
 271     hb_font_funcs_set_glyph_h_advances_func (funcs, hb_ot_get_glyph_h_advances, nullptr, nullptr);
 272     hb_font_funcs_set_glyph_v_advances_func (funcs, hb_ot_get_glyph_v_advances, nullptr, nullptr);
 273     //hb_font_funcs_set_glyph_h_origin_func (funcs, hb_ot_get_glyph_h_origin, nullptr, nullptr);
 274     hb_font_funcs_set_glyph_v_origin_func (funcs, hb_ot_get_glyph_v_origin, nullptr, nullptr);
 275     hb_font_funcs_set_glyph_extents_func (funcs, hb_ot_get_glyph_extents, nullptr, nullptr);
 276     //hb_font_funcs_set_glyph_contour_point_func (funcs, hb_ot_get_glyph_contour_point, nullptr, nullptr);
 277 #ifndef HB_NO_OT_FONT_GLYPH_NAMES
 278     hb_font_funcs_set_glyph_name_func (funcs, hb_ot_get_glyph_name, nullptr, nullptr);
 279     hb_font_funcs_set_glyph_from_name_func (funcs, hb_ot_get_glyph_from_name, nullptr, nullptr);
 280 #endif
 281
 282     hb_font_funcs_make_immutable (funcs);
 283
 284 #if HB_USE_ATEXIT
 285     atexit (free_static_ot_funcs);
 286 #endif
 287
 288     return funcs;
 289   }
 290 } static_ot_funcs;
 291
 292 #if HB_USE_ATEXIT
 293 static
 294 void free_static_ot_funcs ()
 295 {
 296   static_ot_funcs.free_instance ();
 297 }
 298 #endif
 299
 300 static hb_font_funcs_t *
 301 _hb_ot_get_font_funcs ()
 302 {
 303   return static_ot_funcs.get_unconst ();
 304 }
 305
 306
 307 /**
 308  * hb_ot_font_set_funcs:
 309  *
 310  * Since: 0.9.28
 311  **/
 312 void
 313 hb_ot_font_set_funcs (hb_font_t *font)
 314 {
 315   hb_font_set_funcs (font,
 316                      _hb_ot_get_font_funcs (),
 317                      &font->face->table,
 318                      nullptr);
 319 }
 320
 321 #ifndef HB_NO_VAR
 322 int
 323 _glyf_get_side_bearing_var (hb_font_t *font, hb_codepoint_t glyph, bool is_vertical)
 324 {
 325   return font->face->table.glyf->get_side_bearing_var (font, glyph, is_vertical);
 326 }
 327
 328 unsigned
 329 _glyf_get_advance_var (hb_font_t *font, hb_codepoint_t glyph, bool is_vertical)
 330 {
 331   return font->face->table.glyf->get_advance_var (font, glyph, is_vertical);
 332 }
 333 #endif
 334
 335
 336 #endif