rsFont.h revision 44bef6fba6244292b751387f3d6c31cca96c28ad
1/* 2 * Copyright (C) 2009 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#ifndef ANDROID_RS_FONT_H 18#define ANDROID_RS_FONT_H 19 20#include <map> 21#include <vector> 22 23#include "rsStream.h" 24 25struct FT_LibraryRec_; 26struct FT_FaceRec_; 27struct FT_Bitmap_; 28 29// --------------------------------------------------------------------------- 30namespace android { 31 32namespace renderscript { 33 34// Gamma (>= 1.0, <= 10.0) 35#define PROPERTY_TEXT_GAMMA "ro.text_gamma" 36#define PROPERTY_TEXT_BLACK_GAMMA_THRESHOLD "ro.text_gamma.black_threshold" 37#define PROPERTY_TEXT_WHITE_GAMMA_THRESHOLD "ro.text_gamma.white_threshold" 38 39#define DEFAULT_TEXT_GAMMA 1.4f 40#define DEFAULT_TEXT_BLACK_GAMMA_THRESHOLD 64 41#define DEFAULT_TEXT_WHITE_GAMMA_THRESHOLD 192 42 43class FontState; 44 45class Font : public ObjectBase { 46public: 47 enum RenderMode { 48 FRAMEBUFFER, 49 BITMAP, 50 MEASURE, 51 }; 52 53 struct Rect { 54 int32_t left; 55 int32_t top; 56 int32_t right; 57 int32_t bottom; 58 void set(int32_t l, int32_t r, int32_t t, int32_t b) { 59 left = l; 60 right = r; 61 top = t; 62 bottom = b; 63 } 64 }; 65 66 ~Font(); 67 68 // Currently files do not get serialized, 69 // but we need to inherit from ObjectBase for ref tracking 70 virtual void serialize(Context *rsc, OStream *stream) const { 71 } 72 virtual RsA3DClassID getClassId() const { 73 return RS_A3D_CLASS_ID_UNKNOWN; 74 } 75 76 static Font * create(Context *rsc, const char *name, float fontSize, uint32_t dpi, 77 const void *data = nullptr, uint32_t dataLen = 0); 78 79protected: 80 81 friend class FontState; 82 83 // Pointer to the utf data, length of data, where to start, number of glyphs ot read 84 // (each glyph may be longer than a char because we are dealing with utf data) 85 // Last two variables are the initial pen position 86 void renderUTF(const char *text, uint32_t len, int32_t x, int32_t y, 87 uint32_t start, int32_t numGlyphs, 88 RenderMode mode = FRAMEBUFFER, Rect *bounds = nullptr, 89 uint8_t *bitmap = nullptr, uint32_t bitmapW = 0, uint32_t bitmapH = 0); 90 91 void invalidateTextureCache(); 92 struct CachedGlyphInfo 93 { 94 // Has the cache been invalidated? 95 bool mIsValid; 96 // Location of the cached glyph in the bitmap 97 // in case we need to resize the texture 98 uint32_t mBitmapMinX; 99 uint32_t mBitmapMinY; 100 uint32_t mBitmapWidth; 101 uint32_t mBitmapHeight; 102 // Also cache texture coords for the quad 103 float mBitmapMinU; 104 float mBitmapMinV; 105 float mBitmapMaxU; 106 float mBitmapMaxV; 107 // Minimize how much we call freetype 108 int32_t mGlyphIndex; 109 int32_t mAdvanceX; 110 int32_t mAdvanceY; 111 // Values below contain a glyph's origin in the bitmap 112 int32_t mBitmapLeft; 113 int32_t mBitmapTop; 114 }; 115 116 const char *mFontName; 117 float mFontSize; 118 uint32_t mDpi; 119 120 Font(Context *rsc); 121 bool init(const char *name, float fontSize, uint32_t dpi, const void *data = nullptr, uint32_t dataLen = 0); 122 123 virtual void preDestroy() const; 124 FT_FaceRec_ *mFace; 125 bool mInitialized; 126 bool mHasKerning; 127 128 std::map<uint32_t, CachedGlyphInfo* > mCachedGlyphs; 129 CachedGlyphInfo* getCachedUTFChar(int32_t utfChar); 130 131 CachedGlyphInfo *cacheGlyph(uint32_t glyph); 132 void updateGlyphCache(CachedGlyphInfo *glyph); 133 void measureCachedGlyph(CachedGlyphInfo *glyph, int32_t x, int32_t y, Rect *bounds); 134 void drawCachedGlyph(CachedGlyphInfo *glyph, int32_t x, int32_t y); 135 void drawCachedGlyph(CachedGlyphInfo *glyph, int32_t x, int32_t y, 136 uint8_t *bitmap, uint32_t bitmapW, uint32_t bitmapH); 137}; 138 139class FontState { 140public: 141 FontState(); 142 ~FontState(); 143 144 void init(Context *rsc); 145 void deinit(Context *rsc); 146 147 ObjectBaseRef<Font> mDefault; 148 149 void renderText(const char *text, uint32_t len, int32_t x, int32_t y, 150 uint32_t startIndex = 0, int numGlyphs = -1, 151 Font::RenderMode mode = Font::FRAMEBUFFER, 152 Font::Rect *bounds = nullptr, 153 uint8_t *bitmap = nullptr, uint32_t bitmapW = 0, uint32_t bitmapH = 0); 154 155 void measureText(const char *text, uint32_t len, Font::Rect *bounds); 156 157 void setFontColor(float r, float g, float b, float a); 158 void getFontColor(float *r, float *g, float *b, float *a) const; 159 160protected: 161 162 float mSurfaceWidth; 163 float mSurfaceHeight; 164 165 friend class Font; 166 167 struct CacheTextureLine { 168 uint32_t mMaxHeight; 169 uint32_t mMaxWidth; 170 uint32_t mCurrentRow; 171 uint32_t mCurrentCol; 172 bool mDirty; 173 174 CacheTextureLine(uint32_t maxHeight, uint32_t maxWidth, uint32_t currentRow, uint32_t currentCol) 175 : mMaxHeight(maxHeight), mMaxWidth(maxWidth), mCurrentRow(currentRow), 176 mCurrentCol(currentCol), mDirty(false) { 177 } 178 179 bool fitBitmap(FT_Bitmap_ *bitmap, uint32_t *retOriginX, uint32_t *retOriginY); 180 }; 181 182 std::vector<CacheTextureLine*> mCacheLines; 183 uint32_t getRemainingCacheCapacity(); 184 185 void precacheLatin(Font *font); 186 const char *mLatinPrecache; 187 188 Context *mRSC; 189 190 struct { 191 float mFontColor[4]; 192 float mGamma; 193 } mConstants; 194 bool mConstantsDirty; 195 196 float mBlackGamma; 197 float mWhiteGamma; 198 199 float mBlackThreshold; 200 float mWhiteThreshold; 201 202 // Free type library, we only need one copy 203#ifndef ANDROID_RS_SERIALIZE 204 FT_LibraryRec_ *mLibrary; 205 FT_LibraryRec_ *getLib(); 206#endif //ANDROID_RS_SERIALIZE 207 std::vector<Font*> mActiveFonts; 208 209 // Render state for the font 210 ObjectBaseRef<Allocation> mFontShaderFConstant; 211 ObjectBaseRef<ProgramFragment> mFontShaderF; 212 ObjectBaseRef<Sampler> mFontSampler; 213 ObjectBaseRef<ProgramStore> mFontProgramStore; 214 void initRenderState(); 215 216 // Texture to cache glyph bitmaps 217 ObjectBaseRef<Allocation> mTextTexture; 218 uint8_t *mCacheBuffer; 219 uint32_t mCacheWidth; 220 uint32_t mCacheHeight; 221 222 void initTextTexture(); 223 224#ifndef ANDROID_RS_SERIALIZE 225 bool cacheBitmap(FT_Bitmap_ *bitmap, uint32_t *retOriginX, uint32_t *retOriginY); 226#endif //ANDROID_RS_SERIALIZE 227 const Type* getCacheTextureType() { 228 return mTextTexture->getType(); 229 } 230 231 void flushAllAndInvalidate(); 232 233 // Pointer to vertex data to speed up frame to frame work 234 float *mTextMeshPtr; 235 uint32_t mCurrentQuadIndex; 236 uint32_t mMaxNumberOfQuads; 237 238 void initVertexArrayBuffers(); 239 ObjectBaseRef<Mesh> mMesh; 240 241 bool mInitialized; 242 243 void checkInit(); 244 245 void issueDrawCommand(); 246 247 void appendMeshQuad(float x1, float y1, float z1, 248 float u1, float v1, 249 float x2, float y2, float z2, 250 float u2, float v2, 251 float x3, float y3, float z3, 252 float u3, float v3, 253 float x4, float y4, float z4, 254 float u4, float v4); 255}; 256 257} 258} 259 260#endif 261