lily/open-type-font.cc

   1 /*
   2   This file is part of LilyPond, the GNU music typesetter.
   3
   4   Copyright (C) 2004--2015 Han-Wen Nienhuys <hanwen@xs4all.nl>
   5
   6   LilyPond 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 3 of the License, or
   9   (at your option) any later version.
  10
  11   LilyPond 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
  17   along with LilyPond.  If not, see <http://www.gnu.org/licenses/>.
  18 */
  19
  20 #include "open-type-font.hh"
  21 #include "freetype.hh"
  22
  23 #ifdef FT_FONT_FORMATS_H
  24 /* FreeType 2.6+ */
  25 #include FT_FONT_FORMATS_H
  26 #else
  27 /* FreeType 2.5.5 and earlier */
  28 #include FT_XFREE86_H
  29 #define FT_Get_Font_Format FT_Get_X11_Font_Format
  30 #endif
  31
  32 #include <cstdio>
  33
  34 using namespace std;
  35
  36 #include FT_TRUETYPE_TABLES_H
  37
  38 #include "dimensions.hh"
  39 #include "international.hh"
  40 #include "modified-font-metric.hh"
  41 #include "warn.hh"
  42
  43 FT_Byte *
  44 load_table (char const *tag_str, FT_Face face, FT_ULong *length)
  45 {
  46   *length = 0;
  47   FT_ULong tag = FT_MAKE_TAG (tag_str[0], tag_str[1], tag_str[2], tag_str[3]);
  48
  49   FT_Error error_code = FT_Load_Sfnt_Table (face, tag, 0, NULL, length);
  50   if (!error_code)
  51     {
  52       FT_Byte *buffer = (FT_Byte *) malloc (*length);
  53       if (buffer == NULL)
  54         error (_f ("cannot allocate %lu bytes", *length));
  55
  56       error_code = FT_Load_Sfnt_Table (face, tag, 0, buffer, length);
  57       if (error_code)
  58         error (_f ("cannot load font table: %s", tag_str));
  59
  60       return buffer;
  61     }
  62   else
  63     programming_error (_f ("FreeType error: %s",
  64                            freetype_error_string (error_code).c_str ()
  65                           ));
  66
  67   return 0;
  68 }
  69
  70 string
  71 Open_type_font::get_otf_table (const string &tag) const
  72 {
  73   return ::get_otf_table (face_, tag);
  74 }
  75
  76 SCM
  77 load_scheme_table (char const *tag_str, FT_Face face)
  78 {
  79   FT_ULong length = 0;
  80   FT_Byte *buffer = load_table (tag_str, face, &length);
  81
  82   SCM tab = SCM_EOL;
  83   if (buffer)
  84     {
  85       string contents ((char const *)buffer, length);
  86       contents = "(quote (" + contents + "))";
  87
  88 #if GUILEV2
  89       tab = scm_eval_string (scm_from_utf8_string (contents.c_str ()));
  90 #else
  91       tab = scm_c_eval_string (contents.c_str ());
  92 #endif
  93       free (buffer);
  94     }
  95   return tab;
  96 }
  97
  98 Open_type_font::~Open_type_font ()
  99 {
 100   FT_Done_Face (face_);
 101 }
 102
 103 /*
 104   UGH fix naming
 105 */
 106 string
 107 get_otf_table (FT_Face face, const string &tag)
 108 {
 109   FT_ULong len;
 110   FT_Byte *tab = load_table (tag.c_str (), face, &len);
 111   string ret ((char const *) tab, len);
 112   free (tab);
 113
 114   return ret;
 115 }
 116
 117 FT_Face
 118 open_ft_face (const string &str, FT_Long idx)
 119 {
 120   FT_Face face;
 121   FT_Error error_code = FT_New_Face (freetype2_library, str.c_str (), idx, &face);
 122
 123   if (error_code == FT_Err_Unknown_File_Format)
 124     error (_f ("unsupported font format: %s", str.c_str ()));
 125   else if (error_code)
 126     error (_f ("error reading font file %s: %s",
 127                str.c_str (),
 128                freetype_error_string (error_code).c_str ()));
 129   return face;
 130 }
 131
 132 string
 133 get_postscript_name (FT_Face face)
 134 {
 135   string face_ps_name;
 136   const char *psname = FT_Get_Postscript_Name (face);
 137   if (psname)
 138     face_ps_name = psname;
 139   else
 140     {
 141       warning (_ ("cannot get postscript name"));
 142       return "";
 143     }
 144
 145   const char *fmt = FT_Get_Font_Format (face);
 146   if (fmt)
 147     {
 148       if (static_cast<string>(fmt) != "CFF")
 149         return face_ps_name;  // For non-CFF font, pass it through.
 150     }
 151   else
 152     {
 153       warning (_f ("cannot get font %s format", face_ps_name.c_str ()));
 154       return face_ps_name;
 155     }
 156
 157   // For OTF and OTC fonts, we use data from the font's 'CFF' table only
 158   // because other tables are not embedded in the output PS file.
 159   string cff_table = get_otf_table (face, "CFF ");
 160
 161   FT_Open_Args args;
 162   args.flags = FT_OPEN_MEMORY;
 163   args.memory_base = static_cast<const FT_Byte*>
 164     (static_cast<const void*>(cff_table.data ()));
 165   args.memory_size = cff_table.size ();
 166
 167   FT_Face cff_face;
 168   // According to OpenType Specification ver 1.7,
 169   // the CFF (derived from OTF and OTC) has only one name.
 170   // So we use zero as the font index.
 171   FT_Error error_code = FT_Open_Face (freetype2_library, &args,
 172                                       0 /* font index */,
 173                                       &cff_face);
 174   if (error_code)
 175     {
 176       warning (_f ("cannot read CFF %s: %s",
 177                    face_ps_name,
 178                    freetype_error_string (error_code).c_str ()));
 179       return face_ps_name;
 180     }
 181
 182   string ret;
 183   const char *cffname = FT_Get_Postscript_Name (cff_face);
 184   if (cffname)
 185     ret = cffname;
 186   else
 187     {
 188       warning (_f ("cannot get font %s CFF name", face_ps_name.c_str ()));
 189       ret = face_ps_name;
 190     }
 191
 192   debug_output (_f ("Replace font name from %s to %s.",
 193                     face_ps_name.c_str (), ret.c_str ()));
 194
 195   FT_Done_Face (cff_face);
 196
 197   return ret;
 198 }
 199
 200 SCM
 201 Open_type_font::make_otf (const string &str)
 202 {
 203   FT_Face face = open_ft_face (str, 0 /* index */);
 204   Open_type_font *otf = new Open_type_font (face);
 205
 206   return otf->self_scm ();
 207 }
 208
 209 Open_type_font::Open_type_font (FT_Face face)
 210 {
 211   face_ = face;
 212   lily_character_table_ = SCM_EOL;
 213   lily_global_table_ = SCM_EOL;
 214   lily_subfonts_ = SCM_EOL;
 215   lily_index_to_bbox_table_ = SCM_EOL;
 216
 217   lily_character_table_ = alist_to_hashq (load_scheme_table ("LILC", face_));
 218   lily_global_table_ = alist_to_hashq (load_scheme_table ("LILY", face_));
 219   lily_subfonts_ = load_scheme_table ("LILF", face_);
 220   index_to_charcode_map_ = make_index_to_charcode_map (face_);
 221
 222   lily_index_to_bbox_table_ = scm_c_make_hash_table (257);
 223 }
 224
 225 void
 226 Open_type_font::derived_mark () const
 227 {
 228   scm_gc_mark (lily_character_table_);
 229   scm_gc_mark (lily_global_table_);
 230   scm_gc_mark (lily_subfonts_);
 231   scm_gc_mark (lily_index_to_bbox_table_);
 232 }
 233
 234 Offset
 235 Open_type_font::attachment_point (const string &glyph_name) const
 236 {
 237   SCM sym = ly_symbol2scm (glyph_name.c_str ());
 238   SCM entry = scm_hashq_ref (lily_character_table_, sym, SCM_BOOL_F);
 239
 240   Offset o;
 241   if (scm_is_false (entry))
 242     return o;
 243
 244   SCM char_alist = entry;
 245   SCM att_scm = scm_cdr (scm_assq (ly_symbol2scm ("attachment"), char_alist));
 246
 247   return point_constant * ly_scm2offset (att_scm);
 248 }
 249
 250 Box
 251 Open_type_font::get_indexed_char_dimensions (size_t signed_idx) const
 252 {
 253   if (SCM_HASHTABLE_P (lily_index_to_bbox_table_))
 254     {
 255       SCM box = scm_hashq_ref (lily_index_to_bbox_table_,
 256                                scm_from_unsigned_integer (signed_idx), SCM_BOOL_F);
 257       Box *box_ptr = unsmob<Box> (box);
 258       if (box_ptr)
 259         return *box_ptr;
 260     }
 261
 262   if (SCM_HASHTABLE_P (lily_character_table_))
 263     {
 264       const size_t len = 256;
 265       char name[len];
 266       FT_Error code = FT_Get_Glyph_Name (face_, FT_UInt (signed_idx),
 267                                          name, FT_UInt (len));
 268       if (code)
 269         warning (_f ("FT_Get_Glyph_Name () Freetype error: %s",
 270                      freetype_error_string (code)));
 271
 272       SCM sym = ly_symbol2scm (name);
 273       SCM alist = scm_hashq_ref (lily_character_table_, sym, SCM_BOOL_F);
 274
 275       if (scm_is_true (alist))
 276         {
 277           SCM bbox = scm_cdr (scm_assq (ly_symbol2scm ("bbox"), alist));
 278
 279           Box b;
 280           b[X_AXIS][LEFT] = scm_to_double (scm_car (bbox));
 281           bbox = scm_cdr (bbox);
 282           b[Y_AXIS][LEFT] = scm_to_double (scm_car (bbox));
 283           bbox = scm_cdr (bbox);
 284           b[X_AXIS][RIGHT] = scm_to_double (scm_car (bbox));
 285           bbox = scm_cdr (bbox);
 286           b[Y_AXIS][RIGHT] = scm_to_double (scm_car (bbox));
 287           bbox = scm_cdr (bbox);
 288
 289           b.scale (point_constant);
 290
 291           scm_hashq_set_x (lily_index_to_bbox_table_,
 292                            scm_from_unsigned_integer (signed_idx),
 293                            b.smobbed_copy ());
 294           return b;
 295         }
 296     }
 297
 298   Box b = get_unscaled_indexed_char_dimensions (signed_idx);
 299
 300   b.scale (design_size () / Real (face_->units_per_EM));
 301   return b;
 302 }
 303
 304 Real
 305 Open_type_font::get_units_per_EM () const
 306 {
 307   return face_->units_per_EM;
 308 }
 309
 310 size_t
 311 Open_type_font::name_to_index (string nm) const
 312 {
 313   char *nm_str = (char *) nm.c_str ();
 314   if (FT_UInt idx = FT_Get_Name_Index (face_, nm_str))
 315     return (size_t) idx;
 316
 317   return (size_t) - 1;
 318 }
 319
 320 Box
 321 Open_type_font::get_unscaled_indexed_char_dimensions (size_t signed_idx) const
 322 {
 323   return ly_FT_get_unscaled_indexed_char_dimensions (face_, signed_idx);
 324 }
 325
 326 Box
 327 Open_type_font::get_glyph_outline_bbox (size_t signed_idx) const
 328 {
 329   return ly_FT_get_glyph_outline_bbox (face_, signed_idx);
 330 }
 331
 332 SCM
 333 Open_type_font::get_glyph_outline (size_t signed_idx) const
 334 {
 335   return ly_FT_get_glyph_outline (face_, signed_idx);
 336 }
 337
 338 size_t
 339 Open_type_font::index_to_charcode (size_t i) const
 340 {
 341   map<FT_UInt, FT_ULong>::const_iterator iter;
 342   iter = index_to_charcode_map_.find (FT_UInt (i));
 343
 344   if (iter != index_to_charcode_map_.end ())
 345     return (size_t) iter->second;
 346   else
 347     {
 348       programming_error ("Invalid index for character");
 349       return 0;
 350     }
 351 }
 352
 353 size_t
 354 Open_type_font::count () const
 355 {
 356   return index_to_charcode_map_.size ();
 357 }
 358
 359 Real
 360 Open_type_font::design_size () const
 361 {
 362   SCM entry = scm_hashq_ref (lily_global_table_,
 363                              ly_symbol2scm ("design_size"),
 364
 365                              /*
 366                                Hmm. Design size is arbitrary for
 367                                non-design-size fonts. I vote for 1 -
 368                                which will trip errors more
 369                                quickly. --hwn.
 370                              */
 371                              scm_from_unsigned_integer (1));
 372   return scm_to_double (entry) * Real (point_constant);
 373 }
 374
 375 SCM
 376 Open_type_font::sub_fonts () const
 377 {
 378   return lily_subfonts_;
 379 }
 380
 381 SCM
 382 Open_type_font::get_char_table () const
 383 {
 384   return lily_character_table_;
 385 }
 386
 387 SCM
 388 Open_type_font::get_subfonts () const
 389 {
 390   return lily_subfonts_;
 391 }
 392
 393 SCM
 394 Open_type_font::get_global_table () const
 395 {
 396   return lily_global_table_;
 397 }
 398
 399 string
 400 Open_type_font::font_name () const
 401 {
 402   return FT_Get_Postscript_Name (face_);
 403 }
 404
 405 SCM
 406 Open_type_font::glyph_list () const
 407 {
 408   SCM retval = SCM_EOL;
 409   SCM *tail = &retval;
 410
 411   for (int i = 0; i < face_->num_glyphs; i++)
 412     {
 413       const size_t len = 256;
 414       char name[len];
 415       FT_Error code = FT_Get_Glyph_Name (face_, i, name, len);
 416       if (code)
 417         warning (_f ("FT_Get_Glyph_Name () error: %s",
 418                      freetype_error_string (code).c_str ()));
 419
 420       *tail = scm_cons (scm_from_ascii_string (name), SCM_EOL);
 421       tail = SCM_CDRLOC (*tail);
 422     }
 423
 424   return retval;
 425 }