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