1 /* 2 * Copyright (C) 2008-2012 The Android Open Source Project 3 * 4 * Licensed under the Apache License, Version 2.0 (the "License"); 5 * you may not use this file except in compliance with the License. 6 * You may obtain a copy of the License at 7 * 8 * http://www.apache.org/licenses/LICENSE-2.0 9 * 10 * Unless required by applicable law or agreed to in writing, software 11 * distributed under the License is distributed on an "AS IS" BASIS, 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 * See the License for the specific language governing permissions and 14 * limitations under the License. 15 */ 16 17 package android.renderscript; 18 19 import java.io.File; 20 import java.io.InputStream; 21 import java.util.HashMap; 22 import java.util.Map; 23 24 import android.os.Environment; 25 26 import android.annotation.UnsupportedAppUsage; 27 import android.content.res.AssetManager; 28 import android.content.res.Resources; 29 30 /** 31 * @hide 32 * @deprecated in API 16 33 * <p>This class gives users a simple way to draw hardware accelerated text. 34 * Internally, the glyphs are rendered using the Freetype library and an internal cache of 35 * rendered glyph bitmaps is maintained. Each font object represents a combination of a typeface, 36 * and point size. You can create multiple font objects to represent styles such as bold or italic text, 37 * faces, and different font sizes. During creation, the Android system quieries device's screen DPI to 38 * ensure proper sizing across multiple device configurations.</p> 39 * <p>Fonts are rendered using screen-space positions and no state setup beyond binding a 40 * font to the RenderScript is required. A note of caution on performance, though the state changes 41 * are transparent to the user, they do happen internally, and it is more efficient to 42 * render large batches of text in sequence. It is also more efficient to render multiple 43 * characters at once instead of one by one to improve draw call batching.</p> 44 * <p>Font color and transparency are not part of the font object and you can freely modify 45 * them in the script to suit the user's rendering needs. Font colors work as a state machine. 46 * Every new call to draw text uses the last color set in the script.</p> 47 **/ 48 public class Font extends BaseObj { 49 50 //These help us create a font by family name 51 private static final String[] sSansNames = { 52 "sans-serif", "arial", "helvetica", "tahoma", "verdana" 53 }; 54 55 private static final String[] sSerifNames = { 56 "serif", "times", "times new roman", "palatino", "georgia", "baskerville", 57 "goudy", "fantasy", "cursive", "ITC Stone Serif" 58 }; 59 60 private static final String[] sMonoNames = { 61 "monospace", "courier", "courier new", "monaco" 62 }; 63 64 private static class FontFamily { 65 String[] mNames; 66 String mNormalFileName; 67 String mBoldFileName; 68 String mItalicFileName; 69 String mBoldItalicFileName; 70 } 71 72 private static Map<String, FontFamily> sFontFamilyMap; 73 74 /** 75 * @deprecated in API 16 76 */ 77 public enum Style { 78 /** 79 * @deprecated in API 16 80 */ 81 NORMAL, 82 /** 83 * @deprecated in API 16 84 */ 85 BOLD, 86 /** 87 * @deprecated in API 16 88 */ 89 @UnsupportedAppUsage 90 ITALIC, 91 /** 92 * @deprecated in API 16 93 */ 94 BOLD_ITALIC; 95 } 96 addFamilyToMap(FontFamily family)97 private static void addFamilyToMap(FontFamily family) { 98 for(int i = 0; i < family.mNames.length; i ++) { 99 sFontFamilyMap.put(family.mNames[i], family); 100 } 101 } 102 initFontFamilyMap()103 private static void initFontFamilyMap() { 104 sFontFamilyMap = new HashMap<String, FontFamily>(); 105 106 FontFamily sansFamily = new FontFamily(); 107 sansFamily.mNames = sSansNames; 108 sansFamily.mNormalFileName = "Roboto-Regular.ttf"; 109 sansFamily.mBoldFileName = "Roboto-Bold.ttf"; 110 sansFamily.mItalicFileName = "Roboto-Italic.ttf"; 111 sansFamily.mBoldItalicFileName = "Roboto-BoldItalic.ttf"; 112 addFamilyToMap(sansFamily); 113 114 FontFamily serifFamily = new FontFamily(); 115 serifFamily.mNames = sSerifNames; 116 serifFamily.mNormalFileName = "NotoSerif-Regular.ttf"; 117 serifFamily.mBoldFileName = "NotoSerif-Bold.ttf"; 118 serifFamily.mItalicFileName = "NotoSerif-Italic.ttf"; 119 serifFamily.mBoldItalicFileName = "NotoSerif-BoldItalic.ttf"; 120 addFamilyToMap(serifFamily); 121 122 FontFamily monoFamily = new FontFamily(); 123 monoFamily.mNames = sMonoNames; 124 monoFamily.mNormalFileName = "DroidSansMono.ttf"; 125 monoFamily.mBoldFileName = "DroidSansMono.ttf"; 126 monoFamily.mItalicFileName = "DroidSansMono.ttf"; 127 monoFamily.mBoldItalicFileName = "DroidSansMono.ttf"; 128 addFamilyToMap(monoFamily); 129 } 130 131 static { initFontFamilyMap()132 initFontFamilyMap(); 133 } 134 getFontFileName(String familyName, Style style)135 static String getFontFileName(String familyName, Style style) { 136 FontFamily family = sFontFamilyMap.get(familyName); 137 if(family != null) { 138 switch(style) { 139 case NORMAL: 140 return family.mNormalFileName; 141 case BOLD: 142 return family.mBoldFileName; 143 case ITALIC: 144 return family.mItalicFileName; 145 case BOLD_ITALIC: 146 return family.mBoldItalicFileName; 147 } 148 } 149 // Fallback if we could not find the desired family 150 return "DroidSans.ttf"; 151 } 152 Font(long id, RenderScript rs)153 Font(long id, RenderScript rs) { 154 super(id, rs); 155 guard.open("destroy"); 156 } 157 158 /** 159 * @deprecated in API 16 160 * Takes a specific file name as an argument 161 */ createFromFile(RenderScript rs, Resources res, String path, float pointSize)162 static public Font createFromFile(RenderScript rs, Resources res, String path, float pointSize) { 163 rs.validate(); 164 int dpi = res.getDisplayMetrics().densityDpi; 165 long fontId = rs.nFontCreateFromFile(path, pointSize, dpi); 166 167 if(fontId == 0) { 168 throw new RSRuntimeException("Unable to create font from file " + path); 169 } 170 Font rsFont = new Font(fontId, rs); 171 172 return rsFont; 173 } 174 175 /** 176 * @deprecated in API 16 177 */ createFromFile(RenderScript rs, Resources res, File path, float pointSize)178 static public Font createFromFile(RenderScript rs, Resources res, File path, float pointSize) { 179 return createFromFile(rs, res, path.getAbsolutePath(), pointSize); 180 } 181 182 /** 183 * @deprecated in API 16 184 */ createFromAsset(RenderScript rs, Resources res, String path, float pointSize)185 static public Font createFromAsset(RenderScript rs, Resources res, String path, float pointSize) { 186 rs.validate(); 187 AssetManager mgr = res.getAssets(); 188 int dpi = res.getDisplayMetrics().densityDpi; 189 190 long fontId = rs.nFontCreateFromAsset(mgr, path, pointSize, dpi); 191 if(fontId == 0) { 192 throw new RSRuntimeException("Unable to create font from asset " + path); 193 } 194 Font rsFont = new Font(fontId, rs); 195 return rsFont; 196 } 197 198 /** 199 * @deprecated in API 16 200 */ createFromResource(RenderScript rs, Resources res, int id, float pointSize)201 static public Font createFromResource(RenderScript rs, Resources res, int id, float pointSize) { 202 String name = "R." + Integer.toString(id); 203 204 rs.validate(); 205 InputStream is = null; 206 try { 207 is = res.openRawResource(id); 208 } catch (Exception e) { 209 throw new RSRuntimeException("Unable to open resource " + id); 210 } 211 212 int dpi = res.getDisplayMetrics().densityDpi; 213 214 long fontId = 0; 215 if (is instanceof AssetManager.AssetInputStream) { 216 long asset = ((AssetManager.AssetInputStream) is).getNativeAsset(); 217 fontId = rs.nFontCreateFromAssetStream(name, pointSize, dpi, asset); 218 } else { 219 throw new RSRuntimeException("Unsupported asset stream created"); 220 } 221 222 if(fontId == 0) { 223 throw new RSRuntimeException("Unable to create font from resource " + id); 224 } 225 Font rsFont = new Font(fontId, rs); 226 return rsFont; 227 } 228 229 /** 230 * @deprecated in API 16 231 * Accepts one of the following family names as an argument 232 * and will attempt to produce the best match with a system font: 233 * 234 * "sans-serif" "arial" "helvetica" "tahoma" "verdana" 235 * "serif" "times" "times new roman" "palatino" "georgia" "baskerville" 236 * "goudy" "fantasy" "cursive" "ITC Stone Serif" 237 * "monospace" "courier" "courier new" "monaco" 238 * 239 * Returns default font if no match could be found. 240 */ 241 @UnsupportedAppUsage create(RenderScript rs, Resources res, String familyName, Style fontStyle, float pointSize)242 static public Font create(RenderScript rs, Resources res, String familyName, Style fontStyle, float pointSize) { 243 String fileName = getFontFileName(familyName, fontStyle); 244 String fontPath = Environment.getRootDirectory().getAbsolutePath(); 245 fontPath += "/fonts/" + fileName; 246 return createFromFile(rs, res, fontPath, pointSize); 247 } 248 249 } 250