2 This file is part of LilyPond, the GNU music typesetter.
4 Copyright (C) 2004--2015 Han-Wen Nienhuys <hanwen@xs4all.nl>
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.
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.
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/>.
20 #include "open-type-font.hh"
21 #include "freetype.hh"
23 #ifdef FT_FONT_FORMATS_H
25 #include FT_FONT_FORMATS_H
27 /* FreeType 2.5.5 and earlier */
29 #define FT_Get_Font_Format FT_Get_X11_Font_Format
36 #include FT_TRUETYPE_TABLES_H
38 #include "dimensions.hh"
39 #include "international.hh"
40 #include "modified-font-metric.hh"
44 load_table (char const *tag_str, FT_Face face, FT_ULong *length)
47 FT_ULong tag = FT_MAKE_TAG (tag_str[0], tag_str[1], tag_str[2], tag_str[3]);
49 FT_Error error_code = FT_Load_Sfnt_Table (face, tag, 0, NULL, length);
52 FT_Byte *buffer = (FT_Byte *) malloc (*length);
54 error (_f ("cannot allocate %lu bytes", *length));
56 error_code = FT_Load_Sfnt_Table (face, tag, 0, buffer, length);
58 error (_f ("cannot load font table: %s", tag_str));
63 programming_error (_f ("FreeType error: %s",
64 freetype_error_string (error_code).c_str ()
71 Open_type_font::get_otf_table (const string &tag) const
73 return ::get_otf_table (face_, tag);
77 load_scheme_table (char const *tag_str, FT_Face face)
80 FT_Byte *buffer = load_table (tag_str, face, &length);
85 string contents ((char const *)buffer, length);
86 contents = "(quote (" + contents + "))";
89 tab = scm_eval_string (scm_from_utf8_string (contents.c_str ()));
91 tab = scm_c_eval_string (contents.c_str ());
98 Open_type_font::~Open_type_font ()
100 FT_Done_Face (face_);
107 get_otf_table (FT_Face face, const string &tag)
110 FT_Byte *tab = load_table (tag.c_str (), face, &len);
111 string ret ((char const *) tab, len);
118 open_ft_face (const string &str, FT_Long idx)
121 FT_Error error_code = FT_New_Face (freetype2_library, str.c_str (), idx, &face);
123 if (error_code == FT_Err_Unknown_File_Format)
124 error (_f ("unsupported font format: %s", str.c_str ()));
126 error (_f ("error reading font file %s: %s",
128 freetype_error_string (error_code).c_str ()));
133 get_postscript_name (FT_Face face)
136 const char *psname = FT_Get_Postscript_Name (face);
138 face_ps_name = psname;
141 warning (_ ("cannot get postscript name"));
145 const char *fmt = FT_Get_Font_Format (face);
148 if (static_cast<string>(fmt) != "CFF")
149 return face_ps_name; // For non-CFF font, pass it through.
153 warning (_f ("cannot get font %s format", face_ps_name.c_str ()));
157 // For OTF and OTC fonts, we use data from the font's 'CFF' table only
158 // because other tables are not embedded in the output PS file.
159 string cff_table = get_otf_table (face, "CFF ");
162 args.flags = FT_OPEN_MEMORY;
163 args.memory_base = static_cast<const FT_Byte*>
164 (static_cast<const void*>(cff_table.data ()));
165 args.memory_size = cff_table.size ();
168 // According to OpenType Specification ver 1.7,
169 // the CFF (derived from OTF and OTC) has only one name.
170 // So we use zero as the font index.
171 FT_Error error_code = FT_Open_Face (freetype2_library, &args,
176 warning (_f ("cannot read CFF %s: %s",
178 freetype_error_string (error_code).c_str ()));
183 const char *cffname = FT_Get_Postscript_Name (cff_face);
188 // FreeType 2.6 and 2.6.1 cannot get PS name from pure-CFF.
189 // (FreeType 2.5.5 and earlier does not have this issue.
190 // FreeType 2.6.2+ has this bug fixed.)
191 // So we need direct parsing of the 'CFF' table, in this case.
193 debug_output (_f ("Directly parsing 'CFF' table of font %s.",
194 face_ps_name.c_str ()));
196 // See Adobe technote '5176.CFF.pdf', sections 2 and 5-7.
197 size_t hdrsize = static_cast<unsigned char>(cff_table.at(2));
198 string::iterator it = cff_table.begin () + hdrsize;
200 unsigned int name_index_count;
201 name_index_count = static_cast<unsigned char>(*it++) << 8;
202 name_index_count |= static_cast<unsigned char>(*it++);
204 size_t offsize = static_cast<unsigned char>(*it++);
206 if (name_index_count && 1 <= offsize && offsize <= 4)
208 // We get the first name in the CFF's name index
209 // because this CFF (derived from OTF and OTC)
210 // has only one name.
211 size_t off1 = 0, off2 = 0;
212 for (size_t t = 0; t < offsize; t++)
213 off1 = ( off1 << 8 ) | static_cast<unsigned char>(*it++);
216 for (size_t t = 0; t < offsize; t++)
217 off2 = ( off2 << 8 ) | static_cast<unsigned char>(*it++);
219 if (off1 && off1 < off2)
221 ret.assign (&cff_table.at(hdrsize + 3
222 + offsize * (name_index_count + 1)
224 &cff_table.at(hdrsize + 3
225 + offsize * (name_index_count + 1)
232 warning (_f ("cannot get font %s CFF name", face_ps_name.c_str ()));
237 debug_output (_f ("Replace font name from %s to %s.",
238 face_ps_name.c_str (), ret.c_str ()));
240 FT_Done_Face (cff_face);
246 Open_type_font::make_otf (const string &str)
248 FT_Face face = open_ft_face (str, 0 /* index */);
249 Open_type_font *otf = new Open_type_font (face);
251 return otf->self_scm ();
254 Open_type_font::Open_type_font (FT_Face face)
257 lily_character_table_ = SCM_EOL;
258 lily_global_table_ = SCM_EOL;
259 lily_subfonts_ = SCM_EOL;
260 lily_index_to_bbox_table_ = SCM_EOL;
262 lily_character_table_ = alist_to_hashq (load_scheme_table ("LILC", face_));
263 lily_global_table_ = alist_to_hashq (load_scheme_table ("LILY", face_));
264 lily_subfonts_ = load_scheme_table ("LILF", face_);
265 index_to_charcode_map_ = make_index_to_charcode_map (face_);
267 lily_index_to_bbox_table_ = scm_c_make_hash_table (257);
269 postscript_name_ = get_postscript_name (face_);
273 Open_type_font::derived_mark () const
275 scm_gc_mark (lily_character_table_);
276 scm_gc_mark (lily_global_table_);
277 scm_gc_mark (lily_subfonts_);
278 scm_gc_mark (lily_index_to_bbox_table_);
282 Open_type_font::attachment_point (const string &glyph_name) const
284 SCM sym = ly_symbol2scm (glyph_name.c_str ());
285 SCM entry = scm_hashq_ref (lily_character_table_, sym, SCM_BOOL_F);
288 if (scm_is_false (entry))
291 SCM char_alist = entry;
292 SCM att_scm = scm_cdr (scm_assq (ly_symbol2scm ("attachment"), char_alist));
294 return point_constant * ly_scm2offset (att_scm);
298 Open_type_font::get_indexed_char_dimensions (size_t signed_idx) const
300 if (SCM_HASHTABLE_P (lily_index_to_bbox_table_))
302 SCM box = scm_hashq_ref (lily_index_to_bbox_table_,
303 scm_from_unsigned_integer (signed_idx), SCM_BOOL_F);
304 Box *box_ptr = unsmob<Box> (box);
309 if (SCM_HASHTABLE_P (lily_character_table_))
311 const size_t len = 256;
313 FT_Error code = FT_Get_Glyph_Name (face_, FT_UInt (signed_idx),
314 name, FT_UInt (len));
316 warning (_f ("FT_Get_Glyph_Name () Freetype error: %s",
317 freetype_error_string (code)));
319 SCM sym = ly_symbol2scm (name);
320 SCM alist = scm_hashq_ref (lily_character_table_, sym, SCM_BOOL_F);
322 if (scm_is_true (alist))
324 SCM bbox = scm_cdr (scm_assq (ly_symbol2scm ("bbox"), alist));
327 b[X_AXIS][LEFT] = scm_to_double (scm_car (bbox));
328 bbox = scm_cdr (bbox);
329 b[Y_AXIS][LEFT] = scm_to_double (scm_car (bbox));
330 bbox = scm_cdr (bbox);
331 b[X_AXIS][RIGHT] = scm_to_double (scm_car (bbox));
332 bbox = scm_cdr (bbox);
333 b[Y_AXIS][RIGHT] = scm_to_double (scm_car (bbox));
334 bbox = scm_cdr (bbox);
336 b.scale (point_constant);
338 scm_hashq_set_x (lily_index_to_bbox_table_,
339 scm_from_unsigned_integer (signed_idx),
345 Box b = get_unscaled_indexed_char_dimensions (signed_idx);
347 b.scale (design_size () / Real (face_->units_per_EM));
352 Open_type_font::get_units_per_EM () const
354 return face_->units_per_EM;
358 Open_type_font::name_to_index (string nm) const
360 char *nm_str = (char *) nm.c_str ();
361 if (FT_UInt idx = FT_Get_Name_Index (face_, nm_str))
368 Open_type_font::get_unscaled_indexed_char_dimensions (size_t signed_idx) const
370 return ly_FT_get_unscaled_indexed_char_dimensions (face_, signed_idx);
374 Open_type_font::get_glyph_outline_bbox (size_t signed_idx) const
376 return ly_FT_get_glyph_outline_bbox (face_, signed_idx);
380 Open_type_font::get_glyph_outline (size_t signed_idx) const
382 return ly_FT_get_glyph_outline (face_, signed_idx);
386 Open_type_font::index_to_charcode (size_t i) const
388 map<FT_UInt, FT_ULong>::const_iterator iter;
389 iter = index_to_charcode_map_.find (FT_UInt (i));
391 if (iter != index_to_charcode_map_.end ())
392 return (size_t) iter->second;
395 programming_error ("Invalid index for character");
401 Open_type_font::count () const
403 return index_to_charcode_map_.size ();
407 Open_type_font::design_size () const
409 SCM entry = scm_hashq_ref (lily_global_table_,
410 ly_symbol2scm ("design_size"),
413 Hmm. Design size is arbitrary for
414 non-design-size fonts. I vote for 1 -
415 which will trip errors more
418 scm_from_unsigned_integer (1));
419 return scm_to_double (entry) * Real (point_constant);
423 Open_type_font::sub_fonts () const
425 return lily_subfonts_;
429 Open_type_font::get_char_table () const
431 return lily_character_table_;
435 Open_type_font::get_subfonts () const
437 return lily_subfonts_;
441 Open_type_font::get_global_table () const
443 return lily_global_table_;
447 Open_type_font::font_name () const
449 return postscript_name_;
453 Open_type_font::glyph_list () const
455 SCM retval = SCM_EOL;
458 for (int i = 0; i < face_->num_glyphs; i++)
460 const size_t len = 256;
462 FT_Error code = FT_Get_Glyph_Name (face_, i, name, len);
464 warning (_f ("FT_Get_Glyph_Name () error: %s",
465 freetype_error_string (code).c_str ()));
467 *tail = scm_cons (scm_from_ascii_string (name), SCM_EOL);
468 tail = SCM_CDRLOC (*tail);