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