GraphicBuffer.h revision 89592bbede762588248006f20afd8bd9d4bf5a98
1/*
2 * Copyright (C) 2007 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_GRAPHIC_BUFFER_H
18#define ANDROID_GRAPHIC_BUFFER_H
19
20#include <stdint.h>
21#include <sys/types.h>
22
23#include <ui/ANativeObjectBase.h>
24#include <ui/PixelFormat.h>
25#include <ui/Rect.h>
26#include <utils/Flattenable.h>
27
28
29struct ANativeWindowBuffer;
30
31namespace android {
32
33class GraphicBufferMapper;
34
35// ===========================================================================
36// GraphicBuffer
37// ===========================================================================
38
39class GraphicBuffer
40    : public ANativeObjectBase<
41        ANativeWindowBuffer,
42        GraphicBuffer,
43        LightRefBase<GraphicBuffer> >, public Flattenable
44{
45public:
46
47    enum {
48        USAGE_SW_READ_NEVER     = GRALLOC_USAGE_SW_READ_NEVER,
49        USAGE_SW_READ_RARELY    = GRALLOC_USAGE_SW_READ_RARELY,
50        USAGE_SW_READ_OFTEN     = GRALLOC_USAGE_SW_READ_OFTEN,
51        USAGE_SW_READ_MASK      = GRALLOC_USAGE_SW_READ_MASK,
52
53        USAGE_SW_WRITE_NEVER    = GRALLOC_USAGE_SW_WRITE_NEVER,
54        USAGE_SW_WRITE_RARELY   = GRALLOC_USAGE_SW_WRITE_RARELY,
55        USAGE_SW_WRITE_OFTEN    = GRALLOC_USAGE_SW_WRITE_OFTEN,
56        USAGE_SW_WRITE_MASK     = GRALLOC_USAGE_SW_WRITE_MASK,
57
58        USAGE_SOFTWARE_MASK     = USAGE_SW_READ_MASK|USAGE_SW_WRITE_MASK,
59
60        USAGE_PROTECTED         = GRALLOC_USAGE_PROTECTED,
61
62        USAGE_HW_TEXTURE        = GRALLOC_USAGE_HW_TEXTURE,
63        USAGE_HW_RENDER         = GRALLOC_USAGE_HW_RENDER,
64        USAGE_HW_2D             = GRALLOC_USAGE_HW_2D,
65        USAGE_HW_COMPOSER       = GRALLOC_USAGE_HW_COMPOSER,
66        USAGE_HW_VIDEO_ENCODER  = GRALLOC_USAGE_HW_VIDEO_ENCODER,
67        USAGE_HW_MASK           = GRALLOC_USAGE_HW_MASK
68    };
69
70    GraphicBuffer();
71
72    // creates w * h buffer
73    GraphicBuffer(uint32_t w, uint32_t h, PixelFormat format, uint32_t usage);
74
75    // create a buffer from an existing handle
76    GraphicBuffer(uint32_t w, uint32_t h, PixelFormat format, uint32_t usage,
77            uint32_t stride, native_handle_t* handle, bool keepOwnership);
78
79    // create a buffer from an existing ANativeWindowBuffer
80    GraphicBuffer(ANativeWindowBuffer* buffer, bool keepOwnership);
81
82    // return status
83    status_t initCheck() const;
84
85    uint32_t getWidth() const           { return width; }
86    uint32_t getHeight() const          { return height; }
87    uint32_t getStride() const          { return stride; }
88    uint32_t getUsage() const           { return usage; }
89    PixelFormat getPixelFormat() const  { return format; }
90    Rect getBounds() const              { return Rect(width, height); }
91
92    status_t reallocate(uint32_t w, uint32_t h, PixelFormat f, uint32_t usage);
93
94    status_t lock(uint32_t usage, void** vaddr);
95    status_t lock(uint32_t usage, const Rect& rect, void** vaddr);
96    status_t unlock();
97
98    ANativeWindowBuffer* getNativeBuffer() const;
99
100    void setIndex(int index);
101    int getIndex() const;
102
103    // for debugging
104    static void dumpAllocationsToSystemLog();
105
106private:
107    virtual ~GraphicBuffer();
108
109    enum {
110        ownNone   = 0,
111        ownHandle = 1,
112        ownData   = 2,
113    };
114
115    inline const GraphicBufferMapper& getBufferMapper() const {
116        return mBufferMapper;
117    }
118    inline GraphicBufferMapper& getBufferMapper() {
119        return mBufferMapper;
120    }
121    uint8_t mOwner;
122
123private:
124    friend class Surface;
125    friend class BpSurface;
126    friend class BnSurface;
127    friend class LightRefBase<GraphicBuffer>;
128    GraphicBuffer(const GraphicBuffer& rhs);
129    GraphicBuffer& operator = (const GraphicBuffer& rhs);
130    const GraphicBuffer& operator = (const GraphicBuffer& rhs) const;
131
132    status_t initSize(uint32_t w, uint32_t h, PixelFormat format,
133            uint32_t usage);
134
135    void free_handle();
136
137    // Flattenable interface
138    size_t getFlattenedSize() const;
139    size_t getFdCount() const;
140    status_t flatten(void* buffer, size_t size,
141            int fds[], size_t count) const;
142    status_t unflatten(void const* buffer, size_t size,
143            int fds[], size_t count);
144
145
146    GraphicBufferMapper& mBufferMapper;
147    ssize_t mInitCheck;
148    int mIndex;
149
150    // If we're wrapping another buffer then this reference will make sure it
151    // doesn't get freed.
152    sp<ANativeWindowBuffer> mWrappedBuffer;
153};
154
155}; // namespace android
156
157#endif // ANDROID_GRAPHIC_BUFFER_H
158