GraphicBuffer.h revision f974bffb36a97d21432a504a741330c4f4245746
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#include <utils/RefBase.h> 28 29 30struct ANativeWindowBuffer; 31 32namespace android { 33 34class GraphicBufferMapper; 35 36// =========================================================================== 37// GraphicBuffer 38// =========================================================================== 39 40class GraphicBuffer 41 : public ANativeObjectBase< ANativeWindowBuffer, GraphicBuffer, RefBase >, 42 public Flattenable<GraphicBuffer> 43{ 44 friend class Flattenable<GraphicBuffer>; 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 uint64_t getId() const { return mId; } 92 93 status_t reallocate(uint32_t w, uint32_t h, PixelFormat f, uint32_t usage); 94 95 status_t lock(uint32_t usage, void** vaddr); 96 status_t lock(uint32_t usage, const Rect& rect, void** vaddr); 97 // For HAL_PIXEL_FORMAT_YCbCr_420_888 98 status_t lockYCbCr(uint32_t usage, android_ycbcr *ycbcr); 99 status_t lockYCbCr(uint32_t usage, const Rect& rect, android_ycbcr *ycbcr); 100 status_t unlock(); 101 status_t lockAsync(uint32_t usage, void** vaddr, int fenceFd); 102 status_t lockAsync(uint32_t usage, const Rect& rect, void** vaddr, int fenceFd); 103 status_t lockAsyncYCbCr(uint32_t usage, android_ycbcr *ycbcr, int fenceFd); 104 status_t lockAsyncYCbCr(uint32_t usage, const Rect& rect, android_ycbcr *ycbcr, int fenceFd); 105 status_t unlockAsync(int *fenceFd); 106 107 ANativeWindowBuffer* getNativeBuffer() const; 108 109 // for debugging 110 static void dumpAllocationsToSystemLog(); 111 112 // Flattenable protocol 113 size_t getFlattenedSize() const; 114 size_t getFdCount() const; 115 status_t flatten(void*& buffer, size_t& size, int*& fds, size_t& count) const; 116 status_t unflatten(void const*& buffer, size_t& size, int const*& fds, size_t& count); 117 118private: 119 ~GraphicBuffer(); 120 121 enum { 122 ownNone = 0, 123 ownHandle = 1, 124 ownData = 2, 125 }; 126 127 inline const GraphicBufferMapper& getBufferMapper() const { 128 return mBufferMapper; 129 } 130 inline GraphicBufferMapper& getBufferMapper() { 131 return mBufferMapper; 132 } 133 uint8_t mOwner; 134 135private: 136 friend class Surface; 137 friend class BpSurface; 138 friend class BnSurface; 139 friend class LightRefBase<GraphicBuffer>; 140 GraphicBuffer(const GraphicBuffer& rhs); 141 GraphicBuffer& operator = (const GraphicBuffer& rhs); 142 const GraphicBuffer& operator = (const GraphicBuffer& rhs) const; 143 144 status_t initSize(uint32_t w, uint32_t h, PixelFormat format, 145 uint32_t usage); 146 147 void free_handle(); 148 149 GraphicBufferMapper& mBufferMapper; 150 ssize_t mInitCheck; 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 uint64_t mId; 157}; 158 159}; // namespace android 160 161#endif // ANDROID_GRAPHIC_BUFFER_H 162