lily/open-type-font.cc

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