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 
29 struct ANativeWindowBuffer;
30 
31 namespace android {
32 
33 class GraphicBufferMapper;
34 
35 // ===========================================================================
36 // GraphicBuffer
37 // ===========================================================================
38 
39 class GraphicBuffer
40     : public EGLNativeBase<
41         ANativeWindowBuffer,
42         GraphicBuffer,
43         LightRefBase<GraphicBuffer> >, public Flattenable
44 {
45 public:
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 
getWidth()85     uint32_t getWidth() const           { return width; }
getHeight()86     uint32_t getHeight() const          { return height; }
getStride()87     uint32_t getStride() const          { return stride; }
getUsage()88     uint32_t getUsage() const           { return usage; }
getPixelFormat()89     PixelFormat getPixelFormat() const  { return format; }
getBounds()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 lock(GGLSurface* surface, uint32_t usage);
97     status_t unlock();
98 
99     ANativeWindowBuffer* getNativeBuffer() const;
100 
101     void setIndex(int index);
102     int getIndex() const;
103 
104     // for debugging
105     static void dumpAllocationsToSystemLog();
106 
107 private:
108     virtual ~GraphicBuffer();
109 
110     enum {
111         ownNone   = 0,
112         ownHandle = 1,
113         ownData   = 2,
114     };
115 
getBufferMapper()116     inline const GraphicBufferMapper& getBufferMapper() const {
117         return mBufferMapper;
118     }
getBufferMapper()119     inline GraphicBufferMapper& getBufferMapper() {
120         return mBufferMapper;
121     }
122     uint8_t mOwner;
123 
124 private:
125     friend class Surface;
126     friend class BpSurface;
127     friend class BnSurface;
128     friend class SurfaceTextureClient;
129     friend class LightRefBase<GraphicBuffer>;
130     GraphicBuffer(const GraphicBuffer& rhs);
131     GraphicBuffer& operator = (const GraphicBuffer& rhs);
132     const GraphicBuffer& operator = (const GraphicBuffer& rhs) const;
133 
134     status_t initSize(uint32_t w, uint32_t h, PixelFormat format,
135             uint32_t usage);
136 
137     void free_handle();
138 
139     // Flattenable interface
140     size_t getFlattenedSize() const;
141     size_t getFdCount() const;
142     status_t flatten(void* buffer, size_t size,
143             int fds[], size_t count) const;
144     status_t unflatten(void const* buffer, size_t size,
145             int fds[], size_t count);
146 
147 
148     GraphicBufferMapper& mBufferMapper;
149     ssize_t mInitCheck;
150     int mIndex;
151 
152     // If we're wrapping another buffer then this reference will make sure it
153     // doesn't get freed.
154     sp<ANativeWindowBuffer> mWrappedBuffer;
155 };
156 
157 }; // namespace android
158 
159 #endif // ANDROID_GRAPHIC_BUFFER_H
160