lily/open-type-font.cc

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