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       // FreeType 2.6 and 2.6.1 cannot get PS name from pure-CFF.
 189       // (FreeType 2.5.5 and earlier does not have this issue.
 190       //  FreeType 2.6.2+ has this bug fixed.)
 191       // So we need direct parsing of the 'CFF' table, in this case.
 192
 193       debug_output (_f ("Directly parsing 'CFF' table of font %s.",
 194                         face_ps_name.c_str ()));
 195
 196       // See Adobe technote '5176.CFF.pdf', sections 2 and 5-7.
 197       size_t hdrsize = static_cast<unsigned char>(cff_table.at(2));
 198       string::iterator it = cff_table.begin () + hdrsize;
 199
 200       unsigned int name_index_count;
 201       name_index_count = static_cast<unsigned char>(*it++) << 8;
 202       name_index_count |= static_cast<unsigned char>(*it++);
 203
 204       size_t offsize = static_cast<unsigned char>(*it++);
 205
 206       if (name_index_count && 1 <= offsize && offsize <= 4)
 207         {
 208           // We get the first name in the CFF's name index
 209           // because this CFF (derived from OTF and OTC)
 210           // has only one name.
 211           size_t off1 = 0, off2 = 0;
 212           for (size_t t = 0; t < offsize; t++)
 213             off1 = ( off1 << 8 ) | static_cast<unsigned char>(*it++);
 214           if (off1)
 215             {
 216               for (size_t t = 0; t < offsize; t++)
 217                 off2 = ( off2 << 8 ) | static_cast<unsigned char>(*it++);
 218             }
 219           if (off1 && off1 < off2)
 220             {
 221               ret.assign (&cff_table.at(hdrsize + 3
 222                                         + offsize * (name_index_count + 1)
 223                                         + off1 - 1),
 224                           &cff_table.at(hdrsize + 3
 225                                         + offsize * (name_index_count + 1)
 226                                         + off2 - 1));
 227             }
 228         }
 229
 230       if (ret.empty ())
 231         {
 232           warning (_f ("cannot get font %s CFF name", face_ps_name.c_str ()));
 233           ret = face_ps_name;
 234         }
 235     }
 236
 237   debug_output (_f ("Replace font name from %s to %s.",
 238                     face_ps_name.c_str (), ret.c_str ()));
 239
 240   FT_Done_Face (cff_face);
 241
 242   return ret;
 243 }
 244
 245 SCM
 246 Open_type_font::make_otf (const string &str)
 247 {
 248   FT_Face face = open_ft_face (str, 0 /* index */);
 249   Open_type_font *otf = new Open_type_font (face);
 250
 251   return otf->self_scm ();
 252 }
 253
 254 Preinit_Open_type_font::Preinit_Open_type_font ()
 255 {
 256   lily_character_table_ = SCM_EOL;
 257   lily_global_table_ = SCM_EOL;
 258   lily_subfonts_ = SCM_EOL;
 259   lily_index_to_bbox_table_ = SCM_EOL;
 260 }
 261
 262 Open_type_font::Open_type_font (FT_Face face)
 263 {
 264   face_ = face;
 265
 266   lily_character_table_ = alist_to_hashq (load_scheme_table ("LILC", face_));
 267   lily_global_table_ = alist_to_hashq (load_scheme_table ("LILY", face_));
 268   lily_subfonts_ = load_scheme_table ("LILF", face_);
 269   index_to_charcode_map_ = make_index_to_charcode_map (face_);
 270
 271   lily_index_to_bbox_table_ = scm_c_make_hash_table (257);
 272
 273   postscript_name_ = get_postscript_name (face_);
 274 }
 275
 276 void
 277 Open_type_font::derived_mark () const
 278 {
 279   scm_gc_mark (lily_character_table_);
 280   scm_gc_mark (lily_global_table_);
 281   scm_gc_mark (lily_subfonts_);
 282   scm_gc_mark (lily_index_to_bbox_table_);
 283 }
 284
 285 Offset
 286 Open_type_font::attachment_point (const string &glyph_name) const
 287 {
 288   SCM sym = ly_symbol2scm (glyph_name.c_str ());
 289   SCM entry = scm_hashq_ref (lily_character_table_, sym, SCM_BOOL_F);
 290
 291   Offset o;
 292   if (scm_is_false (entry))
 293     return o;
 294
 295   SCM char_alist = entry;
 296   SCM att_scm = scm_cdr (scm_assq (ly_symbol2scm ("attachment"), char_alist));
 297
 298   return point_constant * ly_scm2offset (att_scm);
 299 }
 300
 301 Box
 302 Open_type_font::get_indexed_char_dimensions (size_t signed_idx) const
 303 {
 304   if (SCM_HASHTABLE_P (lily_index_to_bbox_table_))
 305     {
 306       SCM box = scm_hashq_ref (lily_index_to_bbox_table_,
 307                                scm_from_unsigned_integer (signed_idx), SCM_BOOL_F);
 308       Box *box_ptr = unsmob<Box> (box);
 309       if (box_ptr)
 310         return *box_ptr;
 311     }
 312
 313   if (SCM_HASHTABLE_P (lily_character_table_))
 314     {
 315       const size_t len = 256;
 316       char name[len];
 317       FT_Error code = FT_Get_Glyph_Name (face_, FT_UInt (signed_idx),
 318                                          name, FT_UInt (len));
 319       if (code)
 320         warning (_f ("FT_Get_Glyph_Name () Freetype error: %s",
 321                      freetype_error_string (code)));
 322
 323       SCM sym = ly_symbol2scm (name);
 324       SCM alist = scm_hashq_ref (lily_character_table_, sym, SCM_BOOL_F);
 325
 326       if (scm_is_true (alist))
 327         {
 328           SCM bbox = scm_cdr (scm_assq (ly_symbol2scm ("bbox"), alist));
 329
 330           Box b;
 331           b[X_AXIS][LEFT] = scm_to_double (scm_car (bbox));
 332           bbox = scm_cdr (bbox);
 333           b[Y_AXIS][LEFT] = scm_to_double (scm_car (bbox));
 334           bbox = scm_cdr (bbox);
 335           b[X_AXIS][RIGHT] = scm_to_double (scm_car (bbox));
 336           bbox = scm_cdr (bbox);
 337           b[Y_AXIS][RIGHT] = scm_to_double (scm_car (bbox));
 338           bbox = scm_cdr (bbox);
 339
 340           b.scale (point_constant);
 341
 342           scm_hashq_set_x (lily_index_to_bbox_table_,
 343                            scm_from_unsigned_integer (signed_idx),
 344                            b.smobbed_copy ());
 345           return b;
 346         }
 347     }
 348
 349   Box b = get_unscaled_indexed_char_dimensions (signed_idx);
 350
 351   b.scale (design_size () / Real (face_->units_per_EM));
 352   return b;
 353 }
 354
 355 Real
 356 Open_type_font::get_units_per_EM () const
 357 {
 358   return face_->units_per_EM;
 359 }
 360
 361 size_t
 362 Open_type_font::name_to_index (string nm) const
 363 {
 364   char *nm_str = (char *) nm.c_str ();
 365   if (FT_UInt idx = FT_Get_Name_Index (face_, nm_str))
 366     return (size_t) idx;
 367
 368   return (size_t) - 1;
 369 }
 370
 371 Box
 372 Open_type_font::get_unscaled_indexed_char_dimensions (size_t signed_idx) const
 373 {
 374   return ly_FT_get_unscaled_indexed_char_dimensions (face_, signed_idx);
 375 }
 376
 377 Box
 378 Open_type_font::get_glyph_outline_bbox (size_t signed_idx) const
 379 {
 380   return ly_FT_get_glyph_outline_bbox (face_, signed_idx);
 381 }
 382
 383 SCM
 384 Open_type_font::get_glyph_outline (size_t signed_idx) const
 385 {
 386   return ly_FT_get_glyph_outline (face_, signed_idx);
 387 }
 388
 389 size_t
 390 Open_type_font::index_to_charcode (size_t i) const
 391 {
 392   map<FT_UInt, FT_ULong>::const_iterator iter;
 393   iter = index_to_charcode_map_.find (FT_UInt (i));
 394
 395   if (iter != index_to_charcode_map_.end ())
 396     return (size_t) iter->second;
 397   else
 398     {
 399       programming_error ("Invalid index for character");
 400       return 0;
 401     }
 402 }
 403
 404 size_t
 405 Open_type_font::count () const
 406 {
 407   return index_to_charcode_map_.size ();
 408 }
 409
 410 Real
 411 Open_type_font::design_size () const
 412 {
 413   SCM entry = scm_hashq_ref (lily_global_table_,
 414                              ly_symbol2scm ("design_size"),
 415
 416                              /*
 417                                Hmm. Design size is arbitrary for
 418                                non-design-size fonts. I vote for 1 -
 419                                which will trip errors more
 420                                quickly. --hwn.
 421                              */
 422                              scm_from_unsigned_integer (1));
 423   return scm_to_double (entry) * Real (point_constant);
 424 }
 425
 426 SCM
 427 Open_type_font::sub_fonts () const
 428 {
 429   return lily_subfonts_;
 430 }
 431
 432 SCM
 433 Open_type_font::get_char_table () const
 434 {
 435   return lily_character_table_;
 436 }
 437
 438 SCM
 439 Open_type_font::get_subfonts () const
 440 {
 441   return lily_subfonts_;
 442 }
 443
 444 SCM
 445 Open_type_font::get_global_table () const
 446 {
 447   return lily_global_table_;
 448 }
 449
 450 string
 451 Open_type_font::font_name () const
 452 {
 453   return postscript_name_;
 454 }
 455
 456 SCM
 457 Open_type_font::glyph_list () const
 458 {
 459   SCM retval = SCM_EOL;
 460   SCM *tail = &retval;
 461
 462   for (int i = 0; i < face_->num_glyphs; i++)
 463     {
 464       const size_t len = 256;
 465       char name[len];
 466       FT_Error code = FT_Get_Glyph_Name (face_, i, name, len);
 467       if (code)
 468         warning (_f ("FT_Get_Glyph_Name () error: %s",
 469                      freetype_error_string (code).c_str ()));
 470
 471       *tail = scm_cons (scm_from_ascii_string (name), SCM_EOL);
 472       tail = SCM_CDRLOC (*tail);
 473     }
 474
 475   return retval;
 476 }