rsAllocation.h revision 6146238d58f914547c89b3a8cda9cccaa34f84a0 
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            mutable void * mallocPtrLOD0;
74            mutable uint32_t strideLOD0;
75        } drvState;
76
77    };
78    Hal mHal;
79
80    static Allocation * createAllocation(Context *rsc, const Type *, uint32_t usages,
81                                         RsAllocationMipmapControl mc = RS_ALLOCATION_MIPMAP_NONE,
82                                         void *ptr = 0);
83    virtual ~Allocation();
84    void updateCache();
85
86    const Type * getType() const {return mHal.state.type;}
87
88    void syncAll(Context *rsc, RsAllocationUsageType src);
89
90    void copyRange1D(Context *rsc, const Allocation *src, int32_t srcOff, int32_t destOff, int32_t len);
91
92    void resize1D(Context *rsc, uint32_t dimX);
93    void resize2D(Context *rsc, uint32_t dimX, uint32_t dimY);
94
95    void data(Context *rsc, uint32_t xoff, uint32_t lod, uint32_t count, const void *data, size_t sizeBytes);
96    void data(Context *rsc, uint32_t xoff, uint32_t yoff, uint32_t lod, RsAllocationCubemapFace face,
97                 uint32_t w, uint32_t h, const void *data, size_t sizeBytes);
98    void data(Context *rsc, uint32_t xoff, uint32_t yoff, uint32_t zoff, uint32_t lod, RsAllocationCubemapFace face,
99                 uint32_t w, uint32_t h, uint32_t d, const void *data, size_t sizeBytes);
100
101    void read(Context *rsc, uint32_t xoff, uint32_t lod, uint32_t count, void *data, size_t sizeBytes);
102    void read(Context *rsc, uint32_t xoff, uint32_t yoff, uint32_t lod, RsAllocationCubemapFace face,
103                 uint32_t w, uint32_t h, void *data, size_t sizeBytes);
104    void read(Context *rsc, uint32_t xoff, uint32_t yoff, uint32_t zoff, uint32_t lod, RsAllocationCubemapFace face,
105                 uint32_t w, uint32_t h, uint32_t d, void *data, size_t sizeBytes);
106
107    void elementData(Context *rsc, uint32_t x,
108                     const void *data, uint32_t elementOff, size_t sizeBytes);
109    void elementData(Context *rsc, uint32_t x, uint32_t y,
110                     const void *data, uint32_t elementOff, size_t sizeBytes);
111
112    void addProgramToDirty(const Program *);
113    void removeProgramToDirty(const Program *);
114
115    virtual void dumpLOGV(const char *prefix) const;
116    virtual void serialize(Context *rsc, OStream *stream) const;
117    virtual RsA3DClassID getClassId() const { return RS_A3D_CLASS_ID_ALLOCATION; }
118    static Allocation *createFromStream(Context *rsc, IStream *stream);
119
120    bool getIsScript() const {
121        return (mHal.state.usageFlags & RS_ALLOCATION_USAGE_SCRIPT) != 0;
122    }
123    bool getIsTexture() const {
124        return (mHal.state.usageFlags & RS_ALLOCATION_USAGE_GRAPHICS_TEXTURE) != 0;
125    }
126    bool getIsRenderTarget() const {
127        return (mHal.state.usageFlags & RS_ALLOCATION_USAGE_GRAPHICS_RENDER_TARGET) != 0;
128    }
129    bool getIsBufferObject() const {
130        return (mHal.state.usageFlags & RS_ALLOCATION_USAGE_GRAPHICS_VERTEX) != 0;
131    }
132
133    void incRefs(const void *ptr, size_t ct, size_t startOff = 0) const;
134    void decRefs(const void *ptr, size_t ct, size_t startOff = 0) const;
135    virtual bool freeChildren();
136
137    void sendDirty(const Context *rsc) const;
138    bool getHasGraphicsMipmaps() const {
139        return mHal.state.mipmapControl != RS_ALLOCATION_MIPMAP_NONE;
140    }
141
142    int32_t getSurfaceTextureID(const Context *rsc);
143    void setSurfaceTexture(const Context *rsc, SurfaceTexture *st);
144    void setSurface(const Context *rsc, RsNativeWindow sur);
145    void ioSend(const Context *rsc);
146    void ioReceive(const Context *rsc);
147
148protected:
149    Vector<const Program *> mToDirtyList;
150    ObjectBaseRef<const Type> mType;
151    void setType(const Type *t) {
152        mType.set(t);
153        mHal.state.type = t;
154    }
155
156private:
157    void freeChildrenUnlocked();
158    Allocation(Context *rsc, const Type *, uint32_t usages, RsAllocationMipmapControl mc, void *ptr);
159
160    uint32_t getPackedSize() const;
161    static void writePackedData(Context *rsc, const Type *type, uint8_t *dst,
162                                const uint8_t *src, bool dstPadded);
163    void unpackVec3Allocation(Context *rsc, const void *data, size_t dataSize);
164    void packVec3Allocation(Context *rsc, OStream *stream) const;
165};
166
167}
168}
169#endif
170
171