rsAllocation.h revision 358747a3118301c5faeee73c98dd5f839bbfb54a 
1/*
2 * Copyright (C) 2009-2012 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_STRUCTURED_ALLOCATION_H
18#define ANDROID_STRUCTURED_ALLOCATION_H
19
20#include "rsType.h"
21
22struct ANativeWindow;
23
24// ---------------------------------------------------------------------------
25namespace android {
26class SurfaceTexture;
27
28namespace renderscript {
29
30class Program;
31
32/*****************************************************************************
33 * CAUTION
34 *
35 * Any layout changes for this class may require a corresponding change to be
36 * made to frameworks/compile/libbcc/lib/ScriptCRT/rs_core.c, which contains
37 * a partial copy of the information below.
38 *
39 *****************************************************************************/
40class Allocation : public ObjectBase {
41    // The graphics equivalent of malloc.  The allocation contains a structure of elements.
42
43public:
44    const static int MAX_LOD = 16;
45
46    struct Hal {
47        void * drv;
48
49        struct State {
50            const Type * type;
51
52            uint32_t usageFlags;
53            RsAllocationMipmapControl mipmapControl;
54
55            // Cached fields from the Type and Element
56            // to prevent pointer chasing in critical loops.
57            uint32_t dimensionX;
58            uint32_t dimensionY;
59            uint32_t dimensionZ;
60            uint32_t elementSizeBytes;
61            bool hasMipmaps;
62            bool hasFaces;
63            bool hasReferences;
64            void * unused_01;
65            int32_t surfaceTextureID;
66            ANativeWindow *wndSurface;
67            SurfaceTexture *surfaceTexture;
68            RsDataType eType;
69        };
70        State state;
71
72        struct DrvState {
73            struct LodState {
74                void * mallocPtr;
75                size_t stride;
76                uint32_t dimX;
77                uint32_t dimY;
78                uint32_t dimZ;
79            } lod[android::renderscript::Allocation::MAX_LOD];
80            size_t faceOffset;
81            uint32_t lodCount;
82            uint32_t faceCount;
83        };
84        mutable DrvState drvState;
85
86    };
87    Hal mHal;
88
89    static Allocation * createAllocation(Context *rsc, const Type *, uint32_t usages,
90                                         RsAllocationMipmapControl mc = RS_ALLOCATION_MIPMAP_NONE,
91                                         void *ptr = 0);
92    virtual ~Allocation();
93    void updateCache();
94
95    const Type * getType() const {return mHal.state.type;}
96
97    void syncAll(Context *rsc, RsAllocationUsageType src);
98
99    void copyRange1D(Context *rsc, const Allocation *src, int32_t srcOff, int32_t destOff, int32_t len);
100
101    void resize1D(Context *rsc, uint32_t dimX);
102    void resize2D(Context *rsc, uint32_t dimX, uint32_t dimY);
103
104    void data(Context *rsc, uint32_t xoff, uint32_t lod, uint32_t count, const void *data, size_t sizeBytes);
105    void data(Context *rsc, uint32_t xoff, uint32_t yoff, uint32_t lod, RsAllocationCubemapFace face,
106              uint32_t w, uint32_t h, const void *data, size_t sizeBytes);
107    void data(Context *rsc, uint32_t xoff, uint32_t yoff, uint32_t lod, RsAllocationCubemapFace face,
108              uint32_t w, uint32_t h, const void *data, size_t sizeBytes, size_t stride);
109    void data(Context *rsc, uint32_t xoff, uint32_t yoff, uint32_t zoff, uint32_t lod, RsAllocationCubemapFace face,
110              uint32_t w, uint32_t h, uint32_t d, const void *data, size_t sizeBytes);
111
112    void read(Context *rsc, uint32_t xoff, uint32_t lod, uint32_t count, void *data, size_t sizeBytes);
113    void readUnchecked(Context *rsc, uint32_t xoff, uint32_t lod, uint32_t count, void *data, size_t sizeBytes);
114    void read(Context *rsc, uint32_t xoff, uint32_t yoff, uint32_t lod, RsAllocationCubemapFace face,
115              uint32_t w, uint32_t h, void *data, size_t sizeBytes);
116    void read(Context *rsc, uint32_t xoff, uint32_t yoff, uint32_t lod, RsAllocationCubemapFace face,
117              uint32_t w, uint32_t h, void *data, size_t sizeBytes, size_t stride);
118    void read(Context *rsc, uint32_t xoff, uint32_t yoff, uint32_t zoff, uint32_t lod, RsAllocationCubemapFace face,
119              uint32_t w, uint32_t h, uint32_t d, void *data, size_t sizeBytes);
120
121    void elementData(Context *rsc, uint32_t x,
122                     const void *data, uint32_t elementOff, size_t sizeBytes);
123    void elementData(Context *rsc, uint32_t x, uint32_t y,
124                     const void *data, uint32_t elementOff, size_t sizeBytes);
125
126    void addProgramToDirty(const Program *);
127    void removeProgramToDirty(const Program *);
128
129    virtual void dumpLOGV(const char *prefix) const;
130    virtual void serialize(Context *rsc, OStream *stream) const;
131    virtual RsA3DClassID getClassId() const { return RS_A3D_CLASS_ID_ALLOCATION; }
132    static Allocation *createFromStream(Context *rsc, IStream *stream);
133
134    bool getIsScript() const {
135        return (mHal.state.usageFlags & RS_ALLOCATION_USAGE_SCRIPT) != 0;
136    }
137    bool getIsTexture() const {
138        return (mHal.state.usageFlags & RS_ALLOCATION_USAGE_GRAPHICS_TEXTURE) != 0;
139    }
140    bool getIsRenderTarget() const {
141        return (mHal.state.usageFlags & RS_ALLOCATION_USAGE_GRAPHICS_RENDER_TARGET) != 0;
142    }
143    bool getIsBufferObject() const {
144        return (mHal.state.usageFlags & RS_ALLOCATION_USAGE_GRAPHICS_VERTEX) != 0;
145    }
146
147    void incRefs(const void *ptr, size_t ct, size_t startOff = 0) const;
148    void decRefs(const void *ptr, size_t ct, size_t startOff = 0) const;
149    virtual bool freeChildren();
150
151    void sendDirty(const Context *rsc) const;
152    bool getHasGraphicsMipmaps() const {
153        return mHal.state.mipmapControl != RS_ALLOCATION_MIPMAP_NONE;
154    }
155
156    int32_t getSurfaceTextureID(const Context *rsc);
157    void setSurfaceTexture(const Context *rsc, SurfaceTexture *st);
158    void setSurface(const Context *rsc, RsNativeWindow sur);
159    void ioSend(const Context *rsc);
160    void ioReceive(const Context *rsc);
161
162protected:
163    Vector<const Program *> mToDirtyList;
164    ObjectBaseRef<const Type> mType;
165    void setType(const Type *t) {
166        mType.set(t);
167        mHal.state.type = t;
168    }
169
170private:
171    void freeChildrenUnlocked();
172    Allocation(Context *rsc, const Type *, uint32_t usages, RsAllocationMipmapControl mc, void *ptr);
173
174    uint32_t getPackedSize() const;
175    static void writePackedData(Context *rsc, const Type *type, uint8_t *dst,
176                                const uint8_t *src, bool dstPadded);
177    void unpackVec3Allocation(Context *rsc, const void *data, size_t dataSize);
178    void packVec3Allocation(Context *rsc, OStream *stream) const;
179};
180
181}
182}
183#endif
184
185