GraphicBuffer.h revision 309d3bb2f902163356f9d40b6d45c11b435d77a9 
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/android_native_buffer.h>
24#include <ui/PixelFormat.h>
25#include <ui/Rect.h>
26#include <utils/Flattenable.h>
27#include <pixelflinger/pixelflinger.h>
28
29struct android_native_buffer_t;
30
31namespace android {
32
33class GraphicBufferMapper;
34
35// ===========================================================================
36// GraphicBuffer
37// ===========================================================================
38
39class GraphicBuffer
40    : public EGLNativeBase<
41        android_native_buffer_t,
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_HW_TEXTURE        = GRALLOC_USAGE_HW_TEXTURE,
61        USAGE_HW_RENDER         = GRALLOC_USAGE_HW_RENDER,
62        USAGE_HW_2D             = GRALLOC_USAGE_HW_2D,
63        USAGE_HW_MASK           = GRALLOC_USAGE_HW_MASK
64    };
65
66    GraphicBuffer();
67
68    // creates w * h buffer
69    GraphicBuffer(uint32_t w, uint32_t h, PixelFormat format, uint32_t usage);
70
71    // create a buffer from an existing handle
72    GraphicBuffer(uint32_t w, uint32_t h, PixelFormat format, uint32_t usage,
73            uint32_t stride, native_handle_t* handle, bool keepOwnership);
74
75    // create a buffer from an existing android_native_buffer_t
76    GraphicBuffer(android_native_buffer_t* buffer, bool keepOwnership);
77
78    // return status
79    status_t initCheck() const;
80
81    uint32_t getWidth() const           { return width; }
82    uint32_t getHeight() const          { return height; }
83    uint32_t getStride() const          { return stride; }
84    uint32_t getUsage() const           { return usage; }
85    PixelFormat getPixelFormat() const  { return format; }
86    Rect getBounds() const              { return Rect(width, height); }
87
88    status_t reallocate(uint32_t w, uint32_t h, PixelFormat f, uint32_t usage);
89
90    status_t lock(uint32_t usage, void** vaddr);
91    status_t lock(uint32_t usage, const Rect& rect, void** vaddr);
92    status_t lock(GGLSurface* surface, uint32_t usage);
93    status_t unlock();
94
95    android_native_buffer_t* getNativeBuffer() const;
96
97    void setIndex(int index);
98    int getIndex() const;
99
100private:
101    virtual ~GraphicBuffer();
102
103    enum {
104        ownNone   = 0,
105        ownHandle = 1,
106        ownData   = 2,
107    };
108
109    inline const GraphicBufferMapper& getBufferMapper() const {
110        return mBufferMapper;
111    }
112    inline GraphicBufferMapper& getBufferMapper() {
113        return mBufferMapper;
114    }
115    uint8_t mOwner;
116
117private:
118    friend class Surface;
119    friend class BpSurface;
120    friend class BnSurface;
121    friend class LightRefBase<GraphicBuffer>;
122    GraphicBuffer(const GraphicBuffer& rhs);
123    GraphicBuffer& operator = (const GraphicBuffer& rhs);
124    const GraphicBuffer& operator = (const GraphicBuffer& rhs) const;
125
126    status_t initSize(uint32_t w, uint32_t h, PixelFormat format,
127            uint32_t usage);
128
129    void free_handle();
130
131    // Flattenable interface
132    size_t getFlattenedSize() const;
133    size_t getFdCount() const;
134    status_t flatten(void* buffer, size_t size,
135            int fds[], size_t count) const;
136    status_t unflatten(void const* buffer, size_t size,
137            int fds[], size_t count);
138
139
140    GraphicBufferMapper& mBufferMapper;
141    ssize_t mInitCheck;
142    int mIndex;
143
144    // If we're wrapping another buffer then this reference will make sure it
145    // doesn't get freed.
146    sp<android_native_buffer_t> mWrappedBuffer;
147};
148
149}; // namespace android
150
151#endif // ANDROID_GRAPHIC_BUFFER_H
152