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 #include <cstdio>
  24
  25
  26 #include FT_TRUETYPE_TABLES_H
  27
  28 #include "dimensions.hh"
  29 #include "international.hh"
  30 #include "modified-font-metric.hh"
  31 #include "warn.hh"
  32
  33 using std::map;
  34 using std::string;
  35
  36 FT_Byte *
  37 load_table (char const *tag_str, FT_Face face, FT_ULong *length)
  38 {
  39   *length = 0;
  40   FT_ULong tag = FT_MAKE_TAG (tag_str[0], tag_str[1], tag_str[2], tag_str[3]);
  41
  42   FT_Error error_code = FT_Load_Sfnt_Table (face, tag, 0, NULL, length);
  43   if (!error_code)
  44     {
  45       FT_Byte *buffer = (FT_Byte *) malloc (*length);
  46       if (buffer == NULL)
  47         error (_f ("cannot allocate %lu bytes", *length));
  48
  49       error_code = FT_Load_Sfnt_Table (face, tag, 0, buffer, length);
  50       if (error_code)
  51         error (_f ("cannot load font table: %s", tag_str));
  52
  53       return buffer;
  54     }
  55   else
  56     programming_error (_f ("FreeType error: %s",
  57                            freetype_error_string (error_code).c_str ()
  58                           ));
  59
  60   return 0;
  61 }
  62
  63 string
  64 Open_type_font::get_otf_table (const string &tag) const
  65 {
  66   return ::get_otf_table (face_, tag);
  67 }
  68
  69 SCM
  70 load_scheme_table (char const *tag_str, FT_Face face)
  71 {
  72   FT_ULong length = 0;
  73   FT_Byte *buffer = load_table (tag_str, face, &length);
  74
  75   SCM tab = SCM_EOL;
  76   if (buffer)
  77     {
  78       string contents ((char const *)buffer, length);
  79       contents = "(quote (" + contents + "))";
  80
  81 #if GUILEV2
  82       tab = scm_eval_string (scm_from_utf8_string (contents.c_str ()));
  83 #else
  84       tab = scm_c_eval_string (contents.c_str ());
  85 #endif
  86       free (buffer);
  87     }
  88   return tab;
  89 }
  90
  91 Open_type_font::~Open_type_font ()
  92 {
  93   FT_Done_Face (face_);
  94 }
  95
  96 /*
  97   UGH fix naming
  98 */
  99 string
 100 get_otf_table (FT_Face face, const string &tag)
 101 {
 102   FT_ULong len;
 103   FT_Byte *tab = load_table (tag.c_str (), face, &len);
 104   string ret ((char const *) tab, len);
 105   free (tab);
 106
 107   return ret;
 108 }
 109
 110 FT_Face
 111 open_ft_face (const string &str, FT_Long idx)
 112 {
 113   FT_Face face;
 114   FT_Error error_code = FT_New_Face (freetype2_library, str.c_str (), idx, &face);
 115
 116   if (error_code == FT_Err_Unknown_File_Format)
 117     error (_f ("unsupported font format: %s", str.c_str ()));
 118   else if (error_code)
 119     error (_f ("error reading font file %s: %s",
 120                str.c_str (),
 121                freetype_error_string (error_code).c_str ()));
 122   return face;
 123 }
 124
 125 SCM
 126 Open_type_font::make_otf (const string &str)
 127 {
 128   FT_Face face = open_ft_face (str, 0 /* index */);
 129   Open_type_font *otf = new Open_type_font (face);
 130
 131   return otf->self_scm ();
 132 }
 133
 134 Open_type_font::Open_type_font (FT_Face face)
 135 {
 136   face_ = face;
 137   lily_character_table_ = SCM_EOL;
 138   lily_global_table_ = SCM_EOL;
 139   lily_subfonts_ = SCM_EOL;
 140   lily_index_to_bbox_table_ = SCM_EOL;
 141
 142   lily_character_table_ = alist_to_hashq (load_scheme_table ("LILC", face_));
 143   lily_global_table_ = alist_to_hashq (load_scheme_table ("LILY", face_));
 144   lily_subfonts_ = load_scheme_table ("LILF", face_);
 145   index_to_charcode_map_ = make_index_to_charcode_map (face_);
 146
 147   lily_index_to_bbox_table_ = scm_c_make_hash_table (257);
 148 }
 149
 150 void
 151 Open_type_font::derived_mark () const
 152 {
 153   scm_gc_mark (lily_character_table_);
 154   scm_gc_mark (lily_global_table_);
 155   scm_gc_mark (lily_subfonts_);
 156   scm_gc_mark (lily_index_to_bbox_table_);
 157 }
 158
 159 Offset
 160 Open_type_font::attachment_point (const string &glyph_name) const
 161 {
 162   SCM sym = ly_symbol2scm (glyph_name.c_str ());
 163   SCM entry = scm_hashq_ref (lily_character_table_, sym, SCM_BOOL_F);
 164
 165   Offset o;
 166   if (scm_is_false (entry))
 167     return o;
 168
 169   SCM char_alist = entry;
 170   SCM att_scm = scm_cdr (scm_assq (ly_symbol2scm ("attachment"), char_alist));
 171
 172   return point_constant * ly_scm2offset (att_scm);
 173 }
 174
 175 Box
 176 Open_type_font::get_indexed_char_dimensions (size_t signed_idx) const
 177 {
 178   if (SCM_HASHTABLE_P (lily_index_to_bbox_table_))
 179     {
 180       SCM box = scm_hashq_ref (lily_index_to_bbox_table_,
 181                                scm_from_unsigned_integer (signed_idx), SCM_BOOL_F);
 182       Box *box_ptr = unsmob<Box> (box);
 183       if (box_ptr)
 184         return *box_ptr;
 185     }
 186
 187   if (SCM_HASHTABLE_P (lily_character_table_))
 188     {
 189       const size_t len = 256;
 190       char name[len];
 191       FT_Error code = FT_Get_Glyph_Name (face_, FT_UInt (signed_idx),
 192                                          name, FT_UInt (len));
 193       if (code)
 194         warning (_f ("FT_Get_Glyph_Name () Freetype error: %s",
 195                      freetype_error_string (code)));
 196
 197       SCM sym = ly_symbol2scm (name);
 198       SCM alist = scm_hashq_ref (lily_character_table_, sym, SCM_BOOL_F);
 199
 200       if (scm_is_true (alist))
 201         {
 202           SCM bbox = scm_cdr (scm_assq (ly_symbol2scm ("bbox"), alist));
 203
 204           Box b;
 205           b[X_AXIS][LEFT] = scm_to_double (scm_car (bbox));
 206           bbox = scm_cdr (bbox);
 207           b[Y_AXIS][LEFT] = scm_to_double (scm_car (bbox));
 208           bbox = scm_cdr (bbox);
 209           b[X_AXIS][RIGHT] = scm_to_double (scm_car (bbox));
 210           bbox = scm_cdr (bbox);
 211           b[Y_AXIS][RIGHT] = scm_to_double (scm_car (bbox));
 212           bbox = scm_cdr (bbox);
 213
 214           b.scale (point_constant);
 215
 216           scm_hashq_set_x (lily_index_to_bbox_table_,
 217                            scm_from_unsigned_integer (signed_idx),
 218                            b.smobbed_copy ());
 219           return b;
 220         }
 221     }
 222
 223   Box b = get_unscaled_indexed_char_dimensions (signed_idx);
 224
 225   b.scale (design_size () / Real (face_->units_per_EM));
 226   return b;
 227 }
 228
 229 Real
 230 Open_type_font::get_units_per_EM () const
 231 {
 232   return face_->units_per_EM;
 233 }
 234
 235 size_t
 236 Open_type_font::name_to_index (string nm) const
 237 {
 238   char *nm_str = (char *) nm.c_str ();
 239   if (FT_UInt idx = FT_Get_Name_Index (face_, nm_str))
 240     return (size_t) idx;
 241
 242   return (size_t) - 1;
 243 }
 244
 245 Box
 246 Open_type_font::get_unscaled_indexed_char_dimensions (size_t signed_idx) const
 247 {
 248   return ly_FT_get_unscaled_indexed_char_dimensions (face_, signed_idx);
 249 }
 250
 251 Box
 252 Open_type_font::get_glyph_outline_bbox (size_t signed_idx) const
 253 {
 254   return ly_FT_get_glyph_outline_bbox (face_, signed_idx);
 255 }
 256
 257 SCM
 258 Open_type_font::get_glyph_outline (size_t signed_idx) const
 259 {
 260   return ly_FT_get_glyph_outline (face_, signed_idx);
 261 }
 262
 263 size_t
 264 Open_type_font::index_to_charcode (size_t i) const
 265 {
 266   map<FT_UInt, FT_ULong>::const_iterator iter;
 267   iter = index_to_charcode_map_.find (FT_UInt (i));
 268
 269   if (iter != index_to_charcode_map_.end ())
 270     return (size_t) iter->second;
 271   else
 272     {
 273       programming_error ("Invalid index for character");
 274       return 0;
 275     }
 276 }
 277
 278 size_t
 279 Open_type_font::count () const
 280 {
 281   return index_to_charcode_map_.size ();
 282 }
 283
 284 Real
 285 Open_type_font::design_size () const
 286 {
 287   SCM entry = scm_hashq_ref (lily_global_table_,
 288                              ly_symbol2scm ("design_size"),
 289
 290                              /*
 291                                Hmm. Design size is arbitrary for
 292                                non-design-size fonts. I vote for 1 -
 293                                which will trip errors more
 294                                quickly. --hwn.
 295                              */
 296                              scm_from_unsigned_integer (1));
 297   return scm_to_double (entry) * Real (point_constant);
 298 }
 299
 300 SCM
 301 Open_type_font::sub_fonts () const
 302 {
 303   return lily_subfonts_;
 304 }
 305
 306 SCM
 307 Open_type_font::get_char_table () const
 308 {
 309   return lily_character_table_;
 310 }
 311
 312 SCM
 313 Open_type_font::get_subfonts () const
 314 {
 315   return lily_subfonts_;
 316 }
 317
 318 SCM
 319 Open_type_font::get_global_table () const
 320 {
 321   return lily_global_table_;
 322 }
 323
 324 string
 325 Open_type_font::font_name () const
 326 {
 327   return FT_Get_Postscript_Name (face_);
 328 }
 329
 330 SCM
 331 Open_type_font::glyph_list () const
 332 {
 333   SCM retval = SCM_EOL;
 334   SCM *tail = &retval;
 335
 336   for (int i = 0; i < face_->num_glyphs; i++)
 337     {
 338       const size_t len = 256;
 339       char name[len];
 340       FT_Error code = FT_Get_Glyph_Name (face_, i, name, len);
 341       if (code)
 342         warning (_f ("FT_Get_Glyph_Name () error: %s",
 343                      freetype_error_string (code).c_str ()));
 344
 345       *tail = scm_cons (scm_from_ascii_string (name), SCM_EOL);
 346       tail = SCM_CDRLOC (*tail);
 347     }
 348
 349   return retval;
 350 }