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 Han-Wen Nienhuys <hanwen@xs4all.nl>
   7 */
   8
   9 #include <map>
  10 #include <stdio.h>
  11
  12 #include <freetype/tttables.h>
  13
  14 #include "warn.hh"
  15 #include "open-type-font.hh"
  16 #include "dimensions.hh"
  17 #include "modified-font-metric.hh"
  18
  19 FT_Byte *
  20 load_table (char const *tag_str, FT_Face face, FT_ULong *length)
  21 {
  22   FT_ULong tag = FT_MAKE_TAG (tag_str[0], tag_str[1], tag_str[2], tag_str[3]);
  23
  24   int error_code = FT_Load_Sfnt_Table (face, tag, 0, NULL, length);
  25   if (!error_code)
  26     {
  27       FT_Byte *buffer = (FT_Byte*) malloc (*length);
  28       if (buffer == NULL)
  29         error (_f ("Cannot allocate %d bytes", *length));
  30
  31       error_code = FT_Load_Sfnt_Table (face, tag, 0, buffer, length );
  32       if (error_code)
  33         error (_f ("Could not load %s font table", tag_str));
  34
  35       return buffer;
  36     }
  37
  38   return 0;
  39 }
  40
  41 SCM
  42 load_scheme_table (char const *tag_str, FT_Face face)
  43 {
  44   FT_ULong length = 0;
  45   FT_Byte *buffer = load_table (tag_str, face, &length);
  46
  47   SCM tab = SCM_EOL;
  48   if (buffer)
  49     {
  50       String contents ((Byte const*)buffer, length);
  51       contents = "(quote (" +  contents + "))";
  52
  53       tab = scm_c_eval_string (contents.to_str0 ());
  54       free (buffer);
  55     }
  56   return tab;
  57 }
  58
  59 Index_to_charcode_map
  60 make_index_to_charcode_map (FT_Face face)
  61 {
  62   Index_to_charcode_map m;
  63   FT_ULong charcode;
  64   FT_UInt gindex;
  65
  66   for (charcode = FT_Get_First_Char (face, &gindex); gindex != 0;
  67        charcode = FT_Get_Next_Char (face, charcode, &gindex))
  68     m[gindex] = charcode;
  69   return m;
  70 }
  71
  72 Open_type_font::~Open_type_font()
  73 {
  74   FT_Done_Face (face_);
  75 }
  76
  77 SCM
  78 Open_type_font::make_otf (String str)
  79 {
  80   FT_Face face;
  81   int error_code = FT_New_Face(freetype2_library, str.to_str0 (), 0, &face);
  82
  83   if (error_code == FT_Err_Unknown_File_Format)
  84     {
  85       error (_f ("Unsupported font format: %s", str.to_str0 ()));
  86     }
  87   else if (error_code)
  88     {
  89       error (_f ("Unknown error: %d reading font file: %s", error_code,
  90                  str.to_str0 ()));
  91     }
  92
  93   Open_type_font *otf = new Open_type_font (face);
  94
  95   return otf->self_scm ();
  96 }
  97
  98 Open_type_font::Open_type_font (FT_Face face)
  99 {
 100   face_ = face;
 101   lily_character_table_ = SCM_EOL;
 102   lily_global_table_ = SCM_EOL;
 103   lily_subfonts_ = SCM_EOL;
 104
 105   lily_character_table_ = alist_to_hashq (load_scheme_table ("LILC", face_));
 106   lily_global_table_ = alist_to_hashq (load_scheme_table ("LILY", face_));
 107   lily_subfonts_ = load_scheme_table ("LILF", face_);
 108   index_to_charcode_map_ = make_index_to_charcode_map (face_);
 109 }
 110
 111 void
 112 Open_type_font::derived_mark () const
 113 {
 114   scm_gc_mark (lily_character_table_);
 115   scm_gc_mark (lily_global_table_);
 116   scm_gc_mark (lily_subfonts_);
 117 }
 118
 119 Offset
 120 Open_type_font::attachment_point (String glyph_name) const
 121 {
 122   SCM sym = ly_symbol2scm (glyph_name.to_str0 ());
 123   SCM entry = scm_hashq_ref (lily_character_table_, sym, SCM_BOOL_F);
 124
 125   Offset o;
 126   if (entry == SCM_BOOL_F)
 127     return o;
 128
 129   SCM char_alist = entry;
 130   SCM att_scm = scm_cdr (scm_assq (ly_symbol2scm ("attachment"), char_alist));
 131
 132   return point_constant * ly_scm2offset (att_scm);
 133 }
 134
 135 Box
 136 Open_type_font::get_indexed_char (int signed_idx) const
 137 {
 138   if (SCM_HASHTABLE_P (lily_character_table_))
 139     {
 140       const int len =256;
 141       char name[len];
 142       int code = FT_Get_Glyph_Name (face_, signed_idx, name, len);
 143       if (code)
 144         warning (_f ("FT_Get_Glyph_Name() returned error: %d", code));
 145
 146       SCM sym = ly_symbol2scm (name);
 147       SCM alist = scm_hashq_ref (lily_character_table_, sym, SCM_BOOL_F);
 148
 149       if (alist != SCM_BOOL_F)
 150         {
 151           SCM bbox = scm_cdr (scm_assq (ly_symbol2scm ("bbox"), alist));
 152
 153           Box b;
 154           b[X_AXIS][LEFT] = scm_to_double (scm_car (bbox));
 155           bbox = scm_cdr (bbox);
 156           b[Y_AXIS][LEFT] = scm_to_double (scm_car (bbox));
 157           bbox = scm_cdr (bbox);
 158           b[X_AXIS][RIGHT] = scm_to_double (scm_car (bbox));
 159           bbox = scm_cdr (bbox);
 160           b[Y_AXIS][RIGHT] = scm_to_double (scm_car (bbox));
 161           bbox = scm_cdr (bbox);
 162
 163           b.scale (point_constant);
 164           return b;
 165         }
 166     }
 167
 168   FT_UInt idx = signed_idx;
 169   FT_Load_Glyph (face_,
 170                  idx,
 171                  FT_LOAD_NO_SCALE);
 172
 173   FT_Glyph_Metrics m = face_->glyph->metrics;
 174   int hb = m.horiBearingX;
 175   int vb = m.horiBearingY;
 176   Box b (Interval (-hb, m.width - hb),
 177          Interval (-vb, m.height - vb));
 178
 179   b.scale (design_size ()  / Real (face_->units_per_EM));
 180   return b;
 181 }
 182
 183 int
 184 Open_type_font::name_to_index (String nm) const
 185 {
 186   char *nm_str = (char*) nm.to_str0 ();
 187   if (int idx = FT_Get_Name_Index (face_, nm_str))
 188     return idx;
 189   return -1;
 190 }
 191
 192 unsigned
 193 Open_type_font::index_to_charcode (int i) const
 194 {
 195   return ((Open_type_font*) this)->index_to_charcode_map_[i];
 196 }
 197
 198 int
 199 Open_type_font::count () const
 200 {
 201   return ((Open_type_font*) this)->index_to_charcode_map_.size ();
 202 }
 203
 204 Real
 205 Open_type_font::design_size () const
 206 {
 207   SCM entry = scm_hashq_ref (lily_global_table_,
 208                              ly_symbol2scm ("design_size"),
 209
 210                              /*
 211                                Hmm. Design size is arbitrary for
 212                                non-design-size fonts. I vote for 1 -
 213                                which will trip errors more
 214                                quickly. --hwn.
 215                               */
 216                              scm_from_int (1));
 217   return scm_to_double (entry) * Real (point_constant);
 218 }
 219
 220
 221 SCM
 222 Open_type_font::sub_fonts () const
 223 {
 224   return lily_subfonts_;
 225 }
 226
 227 LY_DEFINE (ly_font_sub_fonts, "ly:font-sub-fonts", 1, 0, 0,
 228           (SCM font),
 229            "Given the font metric @var{font} of an OpenType font, return the "
 230            "names of the subfonts within @var{font}.")
 231 {
 232   Font_metric *fm = unsmob_metrics (font);
 233   SCM_ASSERT_TYPE (fm, font, SCM_ARG1, __FUNCTION__, "font-metric");
 234   return fm->sub_fonts ();
 235 }
 236
 237 LY_DEFINE (ly_otf_font_glyph_info, "ly:otf-font-glyph-info", 2, 0, 0,
 238           (SCM font, SCM glyph),
 239            "Given the font metric @var{font} of an OpenType font, return the "
 240            "information about named glyph @var{glyph} (a string)")
 241 {
 242   Modified_font_metric * fm
 243     = dynamic_cast<Modified_font_metric*> (unsmob_metrics (font));
 244   Open_type_font * otf = dynamic_cast<Open_type_font*> (fm->original_font ());
 245   SCM_ASSERT_TYPE (otf, font, SCM_ARG1, __FUNCTION__, "OTF font-metric");
 246   SCM_ASSERT_TYPE (scm_is_string (glyph), glyph, SCM_ARG1,
 247                    __FUNCTION__, "string");
 248
 249   SCM sym = scm_string_to_symbol (glyph);
 250   return scm_hashq_ref (otf->get_char_table (), sym, SCM_EOL);
 251 }
 252
 253 SCM
 254 Open_type_font::get_char_table () const
 255 {
 256   return lily_character_table_;
 257 }
 258
 259 SCM
 260 Open_type_font::get_subfonts () const
 261 {
 262   return lily_subfonts_;
 263 }
 264
 265 SCM
 266 Open_type_font::get_global_table () const
 267 {
 268   return lily_global_table_;
 269 }
 270
 271 String
 272 Open_type_font::font_name () const
 273 {
 274   return FT_Get_Postscript_Name (face_);
 275 }
 276