lily/open-type-font.cc

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