modules/text_renderer/platform_fonts.h

   1 /*****************************************************************************
   2  * freetype.c : Put text on the video, using freetype2
   3  *****************************************************************************
   4  * Copyright (C) 2002 - 2012 VLC authors and VideoLAN
   5  * $Id$
   6  *
   7  * Authors: Sigmund Augdal Helberg <dnumgis@videolan.org>
   8  *          Gildas Bazin <gbazin@videolan.org>
   9  *          Bernie Purcell <bitmap@videolan.org>
  10  *          Jean-Baptiste Kempf <jb@videolan.org>
  11  *          Felix Paul Kühne <fkuehne@videolan.org>
  12  *          Salah-Eddin Shaban <salshaaban@gmail.com>
  13  *
  14  * This program is free software; you can redistribute it and/or modify it
  15  * under the terms of the GNU Lesser General Public License as published by
  16  * the Free Software Foundation; either version 2.1 of the License, or
  17  * (at your option) any later version.
  18  *
  19  * This program is distributed in the hope that it will be useful,
  20  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  21  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  22  * GNU Lesser General Public License for more details.
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * along with this program; if not, write to the Free Software Foundation, Inc.,
  26  * Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
  27  *****************************************************************************/
  28
  29 /*****************************************************************************
  30  * Preamble
  31  *****************************************************************************/
  32
  33 #ifndef PLATFORM_FONTS_H
  34 #define PLATFORM_FONTS_H
  35
  36 #ifdef HAVE_CONFIG_H
  37 # include "config.h"
  38 #endif
  39
  40 #include <ft2build.h>
  41 #include FT_FREETYPE_H
  42
  43 #ifdef __OS2__
  44 typedef uint16_t uni_char_t;
  45 # define FREETYPE_TO_UCS    "UCS-2LE"
  46 #else
  47 typedef uint32_t uni_char_t;
  48 # if defined(WORDS_BIGENDIAN)
  49 #  define FREETYPE_TO_UCS   "UCS-4BE"
  50 # else
  51 #  define FREETYPE_TO_UCS   "UCS-4LE"
  52 # endif
  53 #endif
  54
  55 /* Default fonts */
  56 #ifdef __APPLE__
  57 # define SYSTEM_DEFAULT_FONT_FILE "/Library/Fonts/Arial Unicode.ttf"
  58 # define SYSTEM_DEFAULT_FAMILY "Arial Unicode MS"
  59 # define SYSTEM_DEFAULT_MONOSPACE_FONT_FILE "/System/Library/Fonts/Monaco.dfont"
  60 # define SYSTEM_DEFAULT_MONOSPACE_FAMILY "Monaco"
  61 #elif defined( _WIN32 )
  62 # define SYSTEM_DEFAULT_FONT_FILE "arial.ttf" /* Default path font found at run-time */
  63 # define SYSTEM_DEFAULT_FAMILY "Arial"
  64 # define SYSTEM_DEFAULT_MONOSPACE_FONT_FILE "cour.ttf"
  65 # define SYSTEM_DEFAULT_MONOSPACE_FAMILY "Courier New"
  66 #elif defined( __OS2__ )
  67 # define SYSTEM_DEFAULT_FONT_FILE "/psfonts/tnrwt_k.ttf"
  68 # define SYSTEM_DEFAULT_FAMILY "Times New Roman WT K"
  69 # define SYSTEM_DEFAULT_MONOSPACE_FONT_FILE "/psfonts/mtsansdk.ttf"
  70 # define SYSTEM_DEFAULT_MONOSPACE_FAMILY "Monotype Sans Duospace WT K"
  71 #elif defined( __ANDROID__ )
  72 # define SYSTEM_DEFAULT_FONT_FILE "/system/fonts/DroidSans-Bold.ttf"
  73 # define SYSTEM_DEFAULT_FAMILY "Droid Sans"
  74 # define SYSTEM_DEFAULT_MONOSPACE_FONT_FILE "/system/fonts/DroidSansMono.ttf"
  75 # define SYSTEM_DEFAULT_MONOSPACE_FAMILY "Monospace"
  76 #else
  77 # define SYSTEM_DEFAULT_FONT_FILE "/usr/share/fonts/truetype/freefont/FreeSerifBold.ttf"
  78 # define SYSTEM_DEFAULT_FAMILY "Serif Bold"
  79 # define SYSTEM_DEFAULT_MONOSPACE_FONT_FILE "/usr/share/fonts/truetype/freefont/FreeMono.ttf"
  80 # define SYSTEM_DEFAULT_MONOSPACE_FAMILY "Monospace"
  81 #endif
  82
  83 #ifndef DEFAULT_FONT_FILE
  84 #define DEFAULT_FONT_FILE SYSTEM_DEFAULT_FONT_FILE
  85 #endif
  86
  87 #ifndef DEFAULT_FAMILY
  88 #define DEFAULT_FAMILY SYSTEM_DEFAULT_FAMILY
  89 #endif
  90
  91 #ifndef DEFAULT_MONOSPACE_FONT_FILE
  92 #define DEFAULT_MONOSPACE_FONT_FILE SYSTEM_DEFAULT_MONOSPACE_FONT_FILE
  93 #endif
  94
  95 #ifndef DEFAULT_MONOSPACE_FAMILY
  96 #define DEFAULT_MONOSPACE_FAMILY SYSTEM_DEFAULT_MONOSPACE_FAMILY
  97 #endif
  98
  99 typedef struct vlc_font_t vlc_font_t;
 100 struct vlc_font_t
 101 {
 102     vlc_font_t *p_next;
 103     char       *psz_fontfile;
 104     int         i_index;
 105     bool        b_bold;
 106     bool        b_italic;
 107     FT_Face     p_face;
 108 };
 109
 110 typedef struct vlc_family_t vlc_family_t;
 111 struct vlc_family_t
 112 {
 113     vlc_family_t *p_next;
 114     char         *psz_name;
 115     vlc_font_t   *p_fonts;
 116 };
 117
 118 #define FB_LIST_ATTACHMENTS "attachments"
 119 #define FB_LIST_DEFAULT     "default"
 120 #define FB_NAME             "fallback"
 121
 122 #ifdef HAVE_FONTCONFIG
 123 const vlc_family_t *FontConfig_GetFamily( filter_t *p_filter, const char *psz_family );
 124 vlc_family_t *FontConfig_GetFallbacks( filter_t *p_filter, const char *psz_family,
 125                                        uni_char_t codepoint );
 126 void FontConfig_BuildCache( filter_t *p_filter );
 127 #endif
 128
 129 #if defined( _WIN32 ) && !VLC_WINSTORE_APP
 130 vlc_family_t *Win32_GetFallbacks( filter_t *p_filter, const char *psz_family,
 131                                   uni_char_t codepoint );
 132
 133 const vlc_family_t *Win32_GetFamily( filter_t *p_filter, const char *psz_family );
 134 #endif /* _WIN32 */
 135
 136 #ifdef __APPLE__
 137 #if !TARGET_OS_IPHONE
 138 char* MacLegacy_Select( filter_t *p_filter, const char* psz_fontname,
 139                         bool b_bold, bool b_italic,
 140                         int *i_idx, uni_char_t codepoint );
 141 #endif
 142 #endif
 143
 144 #ifdef __ANDROID__
 145 #define ANDROID_SYSTEM_FONTS "file:///system/etc/system_fonts.xml"
 146 #define ANDROID_FALLBACK_FONTS "file:///system/etc/fallback_fonts.xml"
 147 #define ANDROID_VENDOR_FONTS "file:///vendor/etc/fallback_fonts.xml"
 148 #define ANDROID_FONT_PATH "/system/fonts"
 149
 150 int Android_ParseSystemFonts( filter_t *p_filter, const char *psz_path );
 151 const vlc_family_t *Android_GetFamily( filter_t *p_filter, const char *psz_family );
 152 vlc_family_t *Android_GetFallbacks( filter_t *p_filter, const char *psz_family,
 153                                     uni_char_t codepoint );
 154 #endif
 155
 156 char* Dummy_Select( filter_t *p_filter, const char* family,
 157                     bool b_bold, bool b_italic,
 158                     int *i_idx, uni_char_t codepoint );
 159
 160 #define File_Select(a) Dummy_Select(NULL, a, 0, 0, NULL, 0)
 161
 162 char* Generic_Select( filter_t *p_filter, const char* family,
 163                       bool b_bold, bool b_italic,
 164                       int *i_idx, uni_char_t codepoint );
 165
 166 static inline void AppendFont( vlc_font_t **pp_list, vlc_font_t *p_font )
 167 {
 168     while( *pp_list )
 169         pp_list = &( *pp_list )->p_next;
 170
 171     *pp_list = p_font;
 172 }
 173
 174 static inline void AppendFamily( vlc_family_t **pp_list, vlc_family_t *p_family )
 175 {
 176     while( *pp_list )
 177         pp_list = &( *pp_list )->p_next;
 178
 179     *pp_list = p_family;
 180 }
 181
 182 vlc_family_t *NewFamily( filter_t *p_filter, const char *psz_family,
 183                          vlc_family_t **pp_list, vlc_dictionary_t *p_dict,
 184                          const char *psz_key );
 185
 186 /* This function takes ownership of psz_fontfile */
 187 vlc_font_t *NewFont( char *psz_fontfile, int i_index,
 188                      bool b_bold, bool b_italic,
 189                      vlc_family_t *p_parent );
 190
 191 void FreeFamiliesAndFonts( vlc_family_t *p_family );
 192 void FreeFamilies( void *p_families, void *p_obj );
 193
 194
 195 vlc_family_t *InitDefaultList( filter_t *p_filter, const char *const *ppsz_default,
 196                                int i_size );
 197
 198 void DumpFamily( filter_t *p_filter, const vlc_family_t *p_family,
 199                  bool b_dump_fonts, int i_max_families );
 200
 201 void DumpDictionary( filter_t *p_filter, const vlc_dictionary_t *p_dict,
 202                      bool b_dump_fonts, int i_max_families );
 203
 204 char* ToLower( const char *psz_src );
 205
 206 #endif //PLATFORM_FONTS_H