summaryrefslogtreecommitdiffstats
path: root/Source/WebCore/platform/graphics/android/BaseTileTexture.h
blob: b21659f0750c9af716f0c38f5983b9eb90241647 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
/*
 * Copyright 2010, The Android Open Source Project
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *  * Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 *  * Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS ``AS IS'' AND ANY
 * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
 * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE COPYRIGHT OWNER OR
 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
 * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
 * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */

#ifndef BaseTileTexture_h
#define BaseTileTexture_h

#include "DoubleBufferedTexture.h"
#include "GLWebViewState.h"
#include "TextureOwner.h"
#include "TilePainter.h"
#include <SkBitmap.h>

class SkCanvas;

namespace WebCore {

class BaseTile;

class TextureTileInfo {
public:
    TextureTileInfo()
    : m_x(-1)
    , m_y(-1)
    , m_layerId(-1)
    , m_scale(0)
    , m_texture(0)
    , m_painter(0)
    , m_picture(0)
    {
    }
    int m_x;
    int m_y;
    int m_layerId;
    float m_scale;
    TextureInfo* m_texture;
    TilePainter* m_painter;
    unsigned int m_picture;
};

// While in the queue, the BaseTile can be re-used, the updated bitmap
// can be discarded. In order to track this obsolete base tiles, we save
// the Tile's Info to make the comparison.
// At the time of base tile's dtor or webview destroy, we want to discard
// all the data in the queue. However, we have to do the Surface Texture
// update in the same GL context as the UI thread. So we mark the status
// as pendingDiscard, and delay the Surface Texture operation to the next
// draw call.

enum TransferItemStatus {
    emptyItem = 0, // S.T. buffer ready for new content
    pendingBlit = 1, // Ready for bliting into tile's GL Tex.
    pendingDiscard = 2 // Waiting for the next draw call to discard
};

class TileTransferData {
public:
    TileTransferData()
    : status(emptyItem)
    , savedBaseTilePtr(0)
    {
    }
    TransferItemStatus status;
    BaseTile* savedBaseTilePtr;
    TextureTileInfo tileInfo;
};

// DoubleBufferedTexture using a SkBitmap as backing mechanism
class BaseTileTexture : public DoubleBufferedTexture {
public:
    // This object is to be constructed on the consumer's thread and must have
    // a width and height greater than 0.
    BaseTileTexture(uint32_t w, uint32_t h);
    virtual ~BaseTileTexture();

    // these functions override their parent
    virtual TextureInfo* producerLock();
    virtual void producerRelease();
    virtual void producerReleaseAndSwap();

    // updates the texture with current bitmap and releases (and if needed also
    // swaps) the texture.
    virtual void producerUpdate(TextureInfo* textureInfo, const SkBitmap& bitmap);

    // The level can be one of the following values:
    //  * -1 for an unused texture.
    //  *  0 for the tiles intersecting with the viewport.
    //  *  n where n > 0 for the distance between the viewport and the tile.
    // We use this to prioritize the order in which we reclaim textures, see
    // TilesManager::getAvailableTexture() for more information.
    int usedLevel() { return m_usedLevel; }
    void setUsedLevel(int used) { m_usedLevel = used; }

    // allows consumer thread to assign ownership of the texture to the tile. It
    // returns false if ownership cannot be transferred because the tile is busy
    bool acquire(TextureOwner* owner, bool force = false);
    bool release(TextureOwner* owner);
    bool tryAcquire(TextureOwner* owner);

    // set the texture owner if not busy. Return false if busy, true otherwise.
    bool setOwner(TextureOwner* owner, bool force = false);

    // private member accessor functions
    TextureOwner* owner() { return m_owner; } // only used by the consumer thread
    TextureOwner* delayedReleaseOwner() { return m_delayedReleaseOwner; }

    bool busy();
    void setNotBusy();

    const SkSize& getSize() const { return m_size; }

    void setTile(TextureInfo* info, int x, int y, float scale,
                 TilePainter* painter, unsigned int pictureCount);
    bool readyFor(BaseTile* baseTile);
    float scale();

    GLuint m_ownTextureId;

    void setOwnTextureTileInfoFromQueue(const TextureTileInfo* info);

protected:
    HashMap<SharedTexture*, TextureTileInfo*> m_texturesInfo;

private:
    void destroyTextures(SharedTexture** textures);
    TextureTileInfo m_ownTextureTileInfo;

    SkSize m_size;
    int m_usedLevel;
    SkBitmap::Config m_config;
    TextureOwner* m_owner;

    // When trying to release a texture, we may delay this if the texture is
    // currently used (busy being painted). We use the following two variables
    // to do so in setNotBusy()
    TextureOwner* m_delayedReleaseOwner;
    bool m_delayedRelease;

    // This values signals that the texture is currently in use by the consumer.
    // This allows us to prevent the owner of the texture from changing while the
    // consumer is holding a lock on the texture.
    bool m_busy;
    // We mutex protect the reads/writes of m_busy to ensure that we are reading
    // the most up-to-date value even across processors in an SMP system.
    android::Mutex m_busyLock;
    // We use this condition variable to signal that the texture
    // is not busy anymore
    android::Condition m_busyCond;
};

} // namespace WebCore

#endif // BaseTileTexture_h