rsFont.h revision 02000b3cdcb2ac369bd06313932b26d4b8e023a9 
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
26struct FT_LibraryRec_;
27struct FT_FaceRec_;
28struct FT_Bitmap_;
29
30// ---------------------------------------------------------------------------
31namespace android {
32
33namespace 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
44class FontState;
45
46class Font : public ObjectBase {
47public:
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;
59        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
71    virtual void serialize(OStream *stream) const {
72    }
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
80protected:
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
140class FontState {
141public:
142    FontState();
143    ~FontState();
144
145    void init(Context *rsc);
146    void deinit(Context *rsc);
147
148    ObjectBaseRef<Font> mDefault;
149    ObjectBaseRef<Font> mLast;
150
151    void renderText(const char *text, uint32_t len, int32_t x, int32_t y,
152                    uint32_t startIndex = 0, int numGlyphs = -1,
153                    Font::RenderMode mode = Font::FRAMEBUFFER,
154                    Font::Rect *bounds = NULL,
155                    uint8_t *bitmap = NULL, uint32_t bitmapW = 0, uint32_t bitmapH = 0);
156
157    void measureText(const char *text, uint32_t len, Font::Rect *bounds);
158
159    void setFontColor(float r, float g, float b, float a);
160    void getFontColor(float *r, float *g, float *b, float *a) const;
161
162protected:
163
164    friend class Font;
165
166    struct CacheTextureLine {
167        uint32_t mMaxHeight;
168        uint32_t mMaxWidth;
169        uint32_t mCurrentRow;
170        uint32_t mCurrentCol;
171        bool mDirty;
172
173        CacheTextureLine(uint32_t maxHeight, uint32_t maxWidth, uint32_t currentRow, uint32_t currentCol)
174            : mMaxHeight(maxHeight), mMaxWidth(maxWidth), mCurrentRow(currentRow),
175              mCurrentCol(currentCol), mDirty(false)  {
176        }
177
178        bool fitBitmap(FT_Bitmap_ *bitmap, uint32_t *retOriginX, uint32_t *retOriginY);
179    };
180
181    Vector<CacheTextureLine*> mCacheLines;
182    uint32_t getRemainingCacheCapacity();
183
184    void precacheLatin(Font *font);
185    String8 mLatinPrecache;
186
187    Context *mRSC;
188
189    struct {
190        float mFontColor[4];
191        float mGamma;
192    } mConstants;
193    bool mConstantsDirty;
194
195    float mBlackGamma;
196    float mWhiteGamma;
197
198    float mBlackThreshold;
199    float mWhiteThreshold;
200
201    // Free type library, we only need one copy
202    FT_LibraryRec_ *mLibrary;
203    FT_LibraryRec_ *getLib();
204    Vector<Font*> mActiveFonts;
205
206    // Render state for the font
207    ObjectBaseRef<Allocation> mFontShaderFConstant;
208    ObjectBaseRef<ProgramFragment> mFontShaderF;
209    ObjectBaseRef<Sampler> mFontSampler;
210    ObjectBaseRef<ProgramStore> mFontProgramStore;
211    void initRenderState();
212
213    // Texture to cache glyph bitmaps
214    ObjectBaseRef<Allocation> mTextTexture;
215    void initTextTexture();
216    const uint8_t* getTextTextureData() const {
217        return (uint8_t*)mTextTexture->getPtr();
218    }
219
220    bool cacheBitmap(FT_Bitmap_ *bitmap, uint32_t *retOriginX, uint32_t *retOriginY);
221    const Type* getCacheTextureType() {
222        return mTextTexture->getType();
223    }
224
225    void flushAllAndInvalidate();
226
227    // Pointer to vertex data to speed up frame to frame work
228    float *mTextMeshPtr;
229    uint32_t mCurrentQuadIndex;
230    uint32_t mMaxNumberOfQuads;
231
232    void initVertexArrayBuffers();
233    ObjectBaseRef<Allocation> mIndexBuffer;
234    ObjectBaseRef<Allocation> mVertexArray;
235
236
237    bool mInitialized;
238
239    void checkInit();
240
241    void issueDrawCommand();
242
243    void appendMeshQuad(float x1, float y1, float z1,
244                        float u1, float v1,
245                        float x2, float y2, float z2,
246                        float u2, float v2,
247                        float x3, float y3, float z3,
248                        float u3, float v3,
249                        float x4, float y4, float z4,
250                        float u4, float v4);
251};
252
253}
254}
255
256#endif
257