]> git.donarmstrong.com Git - lilypond.git/blobdiff - lily/open-type-font.cc
Doc-es: various updates.
[lilypond.git] / lily / open-type-font.cc
index 97c49feca2880936f5c173c1b685f3ad3491db2f..730d6cef3580cef522f924b503b4ee9c51f85d55 100644 (file)
@@ -1,18 +1,39 @@
 /*
-  open-type-font.cc -- implement Open_type_font
+  This file is part of LilyPond, the GNU music typesetter.
 
-  source file of the GNU LilyPond music typesetter
+  Copyright (C) 2004--2015 Han-Wen Nienhuys <hanwen@xs4all.nl>
 
-  (c) 2004--2008 Han-Wen Nienhuys <hanwen@xs4all.nl>
+  LilyPond is free software: you can redistribute it and/or modify
+  it under the terms of the GNU General Public License as published by
+  the Free Software Foundation, either version 3 of the License, or
+  (at your option) any later version.
+
+  LilyPond is distributed in the hope that it will be useful,
+  but WITHOUT ANY WARRANTY; without even the implied warranty of
+  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+  GNU General Public License for more details.
+
+  You should have received a copy of the GNU General Public License
+  along with LilyPond.  If not, see <http://www.gnu.org/licenses/>.
 */
 
 #include "open-type-font.hh"
+#include "freetype.hh"
+
+#ifdef FT_FONT_FORMATS_H
+/* FreeType 2.6+ */
+#include FT_FONT_FORMATS_H
+#else
+/* FreeType 2.5.5 and earlier */
+#include FT_XFREE86_H
+#define FT_Get_Font_Format FT_Get_X11_Font_Format
+#endif
 
 #include <cstdio>
 
 using namespace std;
 
-#include <freetype/tttables.h>
+#include FT_TRUETYPE_TABLES_H
 
 #include "dimensions.hh"
 #include "international.hh"
@@ -25,29 +46,29 @@ load_table (char const *tag_str, FT_Face face, FT_ULong *length)
   *length = 0;
   FT_ULong tag = FT_MAKE_TAG (tag_str[0], tag_str[1], tag_str[2], tag_str[3]);
 
-  int error_code = FT_Load_Sfnt_Table (face, tag, 0, NULL, length);
+  FT_Error error_code = FT_Load_Sfnt_Table (face, tag, 0, NULL, length);
   if (!error_code)
     {
       FT_Byte *buffer = (FT_Byte *) malloc (*length);
       if (buffer == NULL)
-       error (_f ("cannot allocate %lu bytes", *length));
+        error (_f ("cannot allocate %lu bytes", *length));
 
       error_code = FT_Load_Sfnt_Table (face, tag, 0, buffer, length);
       if (error_code)
-       error (_f ("cannot load font table: %s", tag_str));
+        error (_f ("cannot load font table: %s", tag_str));
 
       return buffer;
     }
   else
-    programming_error (_f ("Free type error: %s",
-                          freetype_error_string (error_code).c_str ()
-                          ));
+    programming_error (_f ("FreeType error: %s",
+                           freetype_error_string (error_code).c_str ()
+                          ));
 
   return 0;
 }
 
 string
-Open_type_font::get_otf_table (string tag) const
+Open_type_font::get_otf_table (const string &tag) const
 {
   return ::get_otf_table (face_, tag);
 }
@@ -61,16 +82,19 @@ load_scheme_table (char const *tag_str, FT_Face face)
   SCM tab = SCM_EOL;
   if (buffer)
     {
-      string contents ((char const*)buffer, length);
+      string contents ((char const *)buffer, length);
       contents = "(quote (" + contents + "))";
 
+#if GUILEV2
+      tab = scm_eval_string (scm_from_utf8_string (contents.c_str ()));
+#else
       tab = scm_c_eval_string (contents.c_str ());
+#endif
       free (buffer);
     }
   return tab;
 }
 
-
 Open_type_font::~Open_type_font ()
 {
   FT_Done_Face (face_);
@@ -80,48 +104,164 @@ Open_type_font::~Open_type_font ()
   UGH fix naming
 */
 string
-get_otf_table (FT_Face face, string tag)
+get_otf_table (FT_Face face, const string &tag)
 {
   FT_ULong len;
   FT_Byte *tab = load_table (tag.c_str (), face, &len);
-  string ret ((char const*) tab, len);
+  string ret ((char const *) tab, len);
   free (tab);
 
   return ret;
 }
 
 FT_Face
-open_ft_face (string str)
+open_ft_face (const string &str, FT_Long idx)
 {
   FT_Face face;
-  int error_code = FT_New_Face (freetype2_library, str.c_str (), 0, &face);
+  FT_Error error_code = FT_New_Face (freetype2_library, str.c_str (), idx, &face);
 
   if (error_code == FT_Err_Unknown_File_Format)
     error (_f ("unsupported font format: %s", str.c_str ()));
   else if (error_code)
-    error (_f ("error reading font file %s: %s", 
-              str.c_str (),
-              freetype_error_string (error_code).c_str ()
-              ));
+    error (_f ("error reading font file %s: %s",
+               str.c_str (),
+               freetype_error_string (error_code).c_str ()));
   return face;
 }
 
+string
+get_postscript_name (FT_Face face)
+{
+  string face_ps_name;
+  const char *psname = FT_Get_Postscript_Name (face);
+  if (psname)
+    face_ps_name = psname;
+  else
+    {
+      warning (_ ("cannot get postscript name"));
+      return "";
+    }
+
+  const char *fmt = FT_Get_Font_Format (face);
+  if (fmt)
+    {
+      if (static_cast<string>(fmt) != "CFF")
+        return face_ps_name;  // For non-CFF font, pass it through.
+    }
+  else
+    {
+      warning (_f ("cannot get font %s format", face_ps_name.c_str ()));
+      return face_ps_name;
+    }
+
+  // For OTF and OTC fonts, we use data from the font's 'CFF' table only
+  // because other tables are not embedded in the output PS file.
+  string cff_table = get_otf_table (face, "CFF ");
+
+  FT_Open_Args args;
+  args.flags = FT_OPEN_MEMORY;
+  args.memory_base = static_cast<const FT_Byte*>
+    (static_cast<const void*>(cff_table.data ()));
+  args.memory_size = cff_table.size ();
+
+  FT_Face cff_face;
+  // According to OpenType Specification ver 1.7,
+  // the CFF (derived from OTF and OTC) has only one name.
+  // So we use zero as the font index.
+  FT_Error error_code = FT_Open_Face (freetype2_library, &args,
+                                      0 /* font index */,
+                                      &cff_face);
+  if (error_code)
+    {
+      warning (_f ("cannot read CFF %s: %s",
+                   face_ps_name,
+                   freetype_error_string (error_code).c_str ()));
+      return face_ps_name;
+    }
+
+  string ret;
+  const char *cffname = FT_Get_Postscript_Name (cff_face);
+  if (cffname)
+    ret = cffname;
+  else
+    {
+      // FreeType 2.6 and 2.6.1 cannot get PS name from pure-CFF.
+      // (FreeType 2.5.5 and earlier does not have this issue.
+      //  FreeType 2.6.2+ has this bug fixed.)
+      // So we need direct parsing of the 'CFF' table, in this case.
+
+      debug_output (_f ("Directly parsing 'CFF' table of font %s.",
+                        face_ps_name.c_str ()));
+
+      // See Adobe technote '5176.CFF.pdf', sections 2 and 5-7.
+      size_t hdrsize = static_cast<unsigned char>(cff_table.at(2));
+      string::iterator it = cff_table.begin () + hdrsize;
+
+      unsigned int name_index_count;
+      name_index_count = static_cast<unsigned char>(*it++) << 8;
+      name_index_count |= static_cast<unsigned char>(*it++);
+
+      size_t offsize = static_cast<unsigned char>(*it++);
+
+      if (name_index_count && 1 <= offsize && offsize <= 4)
+        {
+          // We get the first name in the CFF's name index
+          // because this CFF (derived from OTF and OTC)
+          // has only one name.
+          size_t off1 = 0, off2 = 0;
+          for (size_t t = 0; t < offsize; t++)
+            off1 = ( off1 << 8 ) | static_cast<unsigned char>(*it++);
+          if (off1)
+            {
+              for (size_t t = 0; t < offsize; t++)
+                off2 = ( off2 << 8 ) | static_cast<unsigned char>(*it++);
+            }
+          if (off1 && off1 < off2)
+            {
+              ret.assign (&cff_table.at(hdrsize + 3
+                                        + offsize * (name_index_count + 1)
+                                        + off1 - 1),
+                          &cff_table.at(hdrsize + 3
+                                        + offsize * (name_index_count + 1)
+                                        + off2 - 1));
+            }
+        }
+
+      if (ret.empty ())
+        {
+          warning (_f ("cannot get font %s CFF name", face_ps_name.c_str ()));
+          ret = face_ps_name;
+        }
+    }
+
+  debug_output (_f ("Replace font name from %s to %s.",
+                    face_ps_name.c_str (), ret.c_str ()));
+
+  FT_Done_Face (cff_face);
+
+  return ret;
+}
+
 SCM
-Open_type_font::make_otf (string str)
+Open_type_font::make_otf (const string &str)
 {
-  FT_Face face = open_ft_face (str);
+  FT_Face face = open_ft_face (str, 0 /* index */);
   Open_type_font *otf = new Open_type_font (face);
 
   return otf->self_scm ();
 }
 
-Open_type_font::Open_type_font (FT_Face face)
+Preinit_Open_type_font::Preinit_Open_type_font ()
 {
-  face_ = face;
   lily_character_table_ = SCM_EOL;
   lily_global_table_ = SCM_EOL;
   lily_subfonts_ = SCM_EOL;
   lily_index_to_bbox_table_ = SCM_EOL;
+}
+
+Open_type_font::Open_type_font (FT_Face face)
+{
+  face_ = face;
 
   lily_character_table_ = alist_to_hashq (load_scheme_table ("LILC", face_));
   lily_global_table_ = alist_to_hashq (load_scheme_table ("LILY", face_));
@@ -129,6 +269,8 @@ Open_type_font::Open_type_font (FT_Face face)
   index_to_charcode_map_ = make_index_to_charcode_map (face_);
 
   lily_index_to_bbox_table_ = scm_c_make_hash_table (257);
+
+  postscript_name_ = get_postscript_name (face_);
 }
 
 void
@@ -141,13 +283,13 @@ Open_type_font::derived_mark () const
 }
 
 Offset
-Open_type_font::attachment_point (string glyph_name) const
+Open_type_font::attachment_point (const string &glyph_name) const
 {
   SCM sym = ly_symbol2scm (glyph_name.c_str ());
   SCM entry = scm_hashq_ref (lily_character_table_, sym, SCM_BOOL_F);
 
   Offset o;
-  if (entry == SCM_BOOL_F)
+  if (scm_is_false (entry))
     return o;
 
   SCM char_alist = entry;
@@ -157,102 +299,127 @@ Open_type_font::attachment_point (string glyph_name) const
 }
 
 Box
-Open_type_font::get_indexed_char (size_t signed_idx) const
+Open_type_font::get_indexed_char_dimensions (size_t signed_idx) const
 {
   if (SCM_HASHTABLE_P (lily_index_to_bbox_table_))
     {
       SCM box = scm_hashq_ref (lily_index_to_bbox_table_,
-                              scm_from_unsigned (signed_idx), SCM_BOOL_F);
-      Box *box_ptr = Box::unsmob (box);
+                               scm_from_unsigned_integer (signed_idx), SCM_BOOL_F);
+      Box *box_ptr = unsmob<Box> (box);
       if (box_ptr)
-       return *box_ptr;
+        return *box_ptr;
     }
 
   if (SCM_HASHTABLE_P (lily_character_table_))
     {
       const size_t len = 256;
       char name[len];
-      size_t code = FT_Get_Glyph_Name (face_, signed_idx, name, len);
+      FT_Error code = FT_Get_Glyph_Name (face_, FT_UInt (signed_idx),
+                                         name, FT_UInt (len));
       if (code)
-       warning (_f ("FT_Get_Glyph_Name () Freetype error: %s",
-                    freetype_error_string (code)));
+        warning (_f ("FT_Get_Glyph_Name () Freetype error: %s",
+                     freetype_error_string (code)));
 
       SCM sym = ly_symbol2scm (name);
       SCM alist = scm_hashq_ref (lily_character_table_, sym, SCM_BOOL_F);
 
-      if (alist != SCM_BOOL_F)
-       {
-         SCM bbox = scm_cdr (scm_assq (ly_symbol2scm ("bbox"), alist));
-
-         Box b;
-         b[X_AXIS][LEFT] = scm_to_double (scm_car (bbox));
-         bbox = scm_cdr (bbox);
-         b[Y_AXIS][LEFT] = scm_to_double (scm_car (bbox));
-         bbox = scm_cdr (bbox);
-         b[X_AXIS][RIGHT] = scm_to_double (scm_car (bbox));
-         bbox = scm_cdr (bbox);
-         b[Y_AXIS][RIGHT] = scm_to_double (scm_car (bbox));
-         bbox = scm_cdr (bbox);
-
-         b.scale (point_constant);
-
-         scm_hashq_set_x (lily_index_to_bbox_table_,
-                          scm_from_unsigned (signed_idx),
-                          b.smobbed_copy ());
-         return b;
-       }
+      if (scm_is_true (alist))
+        {
+          SCM bbox = scm_cdr (scm_assq (ly_symbol2scm ("bbox"), alist));
+
+          Box b;
+          b[X_AXIS][LEFT] = scm_to_double (scm_car (bbox));
+          bbox = scm_cdr (bbox);
+          b[Y_AXIS][LEFT] = scm_to_double (scm_car (bbox));
+          bbox = scm_cdr (bbox);
+          b[X_AXIS][RIGHT] = scm_to_double (scm_car (bbox));
+          bbox = scm_cdr (bbox);
+          b[Y_AXIS][RIGHT] = scm_to_double (scm_car (bbox));
+          bbox = scm_cdr (bbox);
+
+          b.scale (point_constant);
+
+          scm_hashq_set_x (lily_index_to_bbox_table_,
+                           scm_from_unsigned_integer (signed_idx),
+                           b.smobbed_copy ());
+          return b;
+        }
     }
 
-  FT_UInt idx = signed_idx;
-  FT_Load_Glyph (face_,
-                idx,
-                FT_LOAD_NO_SCALE);
-
-  FT_Glyph_Metrics m = face_->glyph->metrics;
-  int hb = m.horiBearingX;
-  int vb = m.horiBearingY;
-  Box b (Interval (-hb, m.width - hb),
-        Interval (-vb, m.height - vb));
+  Box b = get_unscaled_indexed_char_dimensions (signed_idx);
 
   b.scale (design_size () / Real (face_->units_per_EM));
   return b;
 }
 
+Real
+Open_type_font::get_units_per_EM () const
+{
+  return face_->units_per_EM;
+}
+
 size_t
 Open_type_font::name_to_index (string nm) const
 {
   char *nm_str = (char *) nm.c_str ();
-  if (size_t idx = FT_Get_Name_Index (face_, nm_str))
-    return idx;
-  
-  return (size_t) -1;
+  if (FT_UInt idx = FT_Get_Name_Index (face_, nm_str))
+    return (size_t) idx;
+
+  return (size_t) - 1;
+}
+
+Box
+Open_type_font::get_unscaled_indexed_char_dimensions (size_t signed_idx) const
+{
+  return ly_FT_get_unscaled_indexed_char_dimensions (face_, signed_idx);
+}
+
+Box
+Open_type_font::get_glyph_outline_bbox (size_t signed_idx) const
+{
+  return ly_FT_get_glyph_outline_bbox (face_, signed_idx);
+}
+
+SCM
+Open_type_font::get_glyph_outline (size_t signed_idx) const
+{
+  return ly_FT_get_glyph_outline (face_, signed_idx);
 }
 
 size_t
 Open_type_font::index_to_charcode (size_t i) const
 {
-  return ((Open_type_font *) this)->index_to_charcode_map_[i];
+  map<FT_UInt, FT_ULong>::const_iterator iter;
+  iter = index_to_charcode_map_.find (FT_UInt (i));
+
+  if (iter != index_to_charcode_map_.end ())
+    return (size_t) iter->second;
+  else
+    {
+      programming_error ("Invalid index for character");
+      return 0;
+    }
 }
 
 size_t
 Open_type_font::count () const
 {
-  return ((Open_type_font *) this)->index_to_charcode_map_.size ();
+  return index_to_charcode_map_.size ();
 }
 
 Real
 Open_type_font::design_size () const
 {
   SCM entry = scm_hashq_ref (lily_global_table_,
-                            ly_symbol2scm ("design_size"),
-
-                            /*
-                              Hmm. Design size is arbitrary for
-                              non-design-size fonts. I vote for 1 -
-                              which will trip errors more
-                              quickly. --hwn.
-                            */
-                            scm_from_unsigned (1));
+                             ly_symbol2scm ("design_size"),
+
+                             /*
+                               Hmm. Design size is arbitrary for
+                               non-design-size fonts. I vote for 1 -
+                               which will trip errors more
+                               quickly. --hwn.
+                             */
+                             scm_from_unsigned_integer (1));
   return scm_to_double (entry) * Real (point_constant);
 }
 
@@ -283,28 +450,27 @@ Open_type_font::get_global_table () const
 string
 Open_type_font::font_name () const
 {
-  return FT_Get_Postscript_Name (face_);
+  return postscript_name_;
 }
 
-
 SCM
 Open_type_font::glyph_list () const
 {
   SCM retval = SCM_EOL;
   SCM *tail = &retval;
-  
+
   for (int i = 0; i < face_->num_glyphs; i++)
     {
       const size_t len = 256;
       char name[len];
-      size_t code = FT_Get_Glyph_Name (face_, i, name, len);
+      FT_Error code = FT_Get_Glyph_Name (face_, i, name, len);
       if (code)
-       warning (_f ("FT_Get_Glyph_Name () error: %s",
-                    freetype_error_string (code).c_str ()));
+        warning (_f ("FT_Get_Glyph_Name () error: %s",
+                     freetype_error_string (code).c_str ()));
 
-      *tail = scm_cons (scm_from_locale_string (name), SCM_EOL);
+      *tail = scm_cons (scm_from_ascii_string (name), SCM_EOL);
       tail = SCM_CDRLOC (*tail);
     }
-  
+
   return retval;
 }