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 ("cannot allocate %lu bytes", *length));
  34
  35       error_code = FT_Load_Sfnt_Table (face, tag, 0, buffer, length);
  36       if (error_code)
  37         error (_f ("cannot 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
  72 Open_type_font::~Open_type_font ()
  73 {
  74   FT_Done_Face (face_);
  75 }
  76
  77 /*
  78   UGH fix naming
  79 */
  80 string
  81 get_otf_table (FT_Face face, string tag)
  82 {
  83   FT_ULong len;
  84   FT_Byte *tab = load_table (tag.c_str (), face, &len);
  85   string ret ((char const*) tab, len);
  86   free (tab);
  87
  88   return ret;
  89 }
  90
  91 FT_Face
  92 open_ft_face (string str)
  93 {
  94   FT_Face face;
  95   int error_code = FT_New_Face (freetype2_library, str.c_str (), 0, &face);
  96
  97   if (error_code == FT_Err_Unknown_File_Format)
  98     error (_f ("unsupported font format: %s", str.c_str ()));
  99   else if (error_code)
 100     error (_f ("unknown error: %d reading font file: %s", error_code,
 101                str.c_str ()));
 102   return face;
 103 }
 104
 105 SCM
 106 Open_type_font::make_otf (string str)
 107 {
 108   FT_Face face = open_ft_face (str);
 109   Open_type_font *otf = new Open_type_font (face);
 110
 111   return otf->self_scm ();
 112 }
 113
 114 Open_type_font::Open_type_font (FT_Face face)
 115 {
 116   face_ = face;
 117   lily_character_table_ = SCM_EOL;
 118   lily_global_table_ = SCM_EOL;
 119   lily_subfonts_ = SCM_EOL;
 120   lily_index_to_bbox_table_ = SCM_EOL;
 121
 122   lily_character_table_ = alist_to_hashq (load_scheme_table ("LILC", face_));
 123   lily_global_table_ = alist_to_hashq (load_scheme_table ("LILY", face_));
 124   lily_subfonts_ = load_scheme_table ("LILF", face_);
 125   index_to_charcode_map_ = make_index_to_charcode_map (face_);
 126
 127   lily_index_to_bbox_table_ = scm_c_make_hash_table (257);
 128 }
 129
 130 void
 131 Open_type_font::derived_mark () const
 132 {
 133   scm_gc_mark (lily_character_table_);
 134   scm_gc_mark (lily_global_table_);
 135   scm_gc_mark (lily_subfonts_);
 136   scm_gc_mark (lily_index_to_bbox_table_);
 137 }
 138
 139 Offset
 140 Open_type_font::attachment_point (string glyph_name) const
 141 {
 142   SCM sym = ly_symbol2scm (glyph_name.c_str ());
 143   SCM entry = scm_hashq_ref (lily_character_table_, sym, SCM_BOOL_F);
 144
 145   Offset o;
 146   if (entry == SCM_BOOL_F)
 147     return o;
 148
 149   SCM char_alist = entry;
 150   SCM att_scm = scm_cdr (scm_assq (ly_symbol2scm ("attachment"), char_alist));
 151
 152   return point_constant * ly_scm2offset (att_scm);
 153 }
 154
 155 Box
 156 Open_type_font::get_indexed_char (size_t signed_idx) const
 157 {
 158   if (SCM_HASHTABLE_P (lily_index_to_bbox_table_))
 159     {
 160       SCM box = scm_hashq_ref (lily_index_to_bbox_table_,
 161                                scm_from_unsigned (signed_idx), SCM_BOOL_F);
 162       Box *box_ptr = Box::unsmob (box);
 163       if (box_ptr)
 164         return *box_ptr;
 165     }
 166
 167   if (SCM_HASHTABLE_P (lily_character_table_))
 168     {
 169       const size_t len = 256;
 170       char name[len];
 171       size_t code = FT_Get_Glyph_Name (face_, signed_idx, name, len);
 172       if (code)
 173         warning (_f ("FT_Get_Glyph_Name() returned error: %u", unsigned (code)));
 174
 175       SCM sym = ly_symbol2scm (name);
 176       SCM alist = scm_hashq_ref (lily_character_table_, sym, SCM_BOOL_F);
 177
 178       if (alist != SCM_BOOL_F)
 179         {
 180           SCM bbox = scm_cdr (scm_assq (ly_symbol2scm ("bbox"), alist));
 181
 182           Box b;
 183           b[X_AXIS][LEFT] = scm_to_double (scm_car (bbox));
 184           bbox = scm_cdr (bbox);
 185           b[Y_AXIS][LEFT] = scm_to_double (scm_car (bbox));
 186           bbox = scm_cdr (bbox);
 187           b[X_AXIS][RIGHT] = scm_to_double (scm_car (bbox));
 188           bbox = scm_cdr (bbox);
 189           b[Y_AXIS][RIGHT] = scm_to_double (scm_car (bbox));
 190           bbox = scm_cdr (bbox);
 191
 192           b.scale (point_constant);
 193
 194           scm_hashq_set_x (lily_index_to_bbox_table_,
 195                            scm_from_unsigned (signed_idx),
 196                            b.smobbed_copy ());
 197           return b;
 198         }
 199     }
 200
 201   FT_UInt idx = signed_idx;
 202   FT_Load_Glyph (face_,
 203                  idx,
 204                  FT_LOAD_NO_SCALE);
 205
 206   FT_Glyph_Metrics m = face_->glyph->metrics;
 207   int hb = m.horiBearingX;
 208   int vb = m.horiBearingY;
 209   Box b (Interval (-hb, m.width - hb),
 210          Interval (-vb, m.height - vb));
 211
 212   b.scale (design_size () / Real (face_->units_per_EM));
 213   return b;
 214 }
 215
 216 size_t
 217 Open_type_font::name_to_index (string nm) const
 218 {
 219   char *nm_str = (char *) nm.c_str ();
 220   if (size_t idx = FT_Get_Name_Index (face_, nm_str))
 221     return idx;
 222
 223   return (size_t) -1;
 224 }
 225
 226 size_t
 227 Open_type_font::index_to_charcode (size_t i) const
 228 {
 229   return ((Open_type_font *) this)->index_to_charcode_map_[i];
 230 }
 231
 232 size_t
 233 Open_type_font::count () const
 234 {
 235   return ((Open_type_font *) this)->index_to_charcode_map_.size ();
 236 }
 237
 238 Real
 239 Open_type_font::design_size () const
 240 {
 241   SCM entry = scm_hashq_ref (lily_global_table_,
 242                              ly_symbol2scm ("design_size"),
 243
 244                              /*
 245                                Hmm. Design size is arbitrary for
 246                                non-design-size fonts. I vote for 1 -
 247                                which will trip errors more
 248                                quickly. --hwn.
 249                              */
 250                              scm_from_unsigned (1));
 251   return scm_to_double (entry) * Real (point_constant);
 252 }
 253
 254 SCM
 255 Open_type_font::sub_fonts () const
 256 {
 257   return lily_subfonts_;
 258 }
 259
 260 SCM
 261 Open_type_font::get_char_table () const
 262 {
 263   return lily_character_table_;
 264 }
 265
 266 SCM
 267 Open_type_font::get_subfonts () const
 268 {
 269   return lily_subfonts_;
 270 }
 271
 272 SCM
 273 Open_type_font::get_global_table () const
 274 {
 275   return lily_global_table_;
 276 }
 277
 278 string
 279 Open_type_font::font_name () const
 280 {
 281   return FT_Get_Postscript_Name (face_);
 282 }
 283
 284
 285 SCM
 286 Open_type_font::glyph_list () const
 287 {
 288   SCM retval = SCM_EOL;
 289   SCM *tail = &retval;
 290
 291   for (int i = 0; i < face_->num_glyphs; i++)
 292     {
 293       const size_t len = 256;
 294       char name[len];
 295       size_t code = FT_Get_Glyph_Name (face_, i, name, len);
 296       if (code)
 297         warning (_f ("FT_Get_Glyph_Name() returned error: %u", unsigned (code)));
 298
 299       *tail = scm_cons (scm_from_locale_string (name), SCM_EOL);
 300       tail = SCM_CDRLOC (*tail);
 301     }
 302
 303   return retval;
 304 }