1 /* 2 * Copyright (c) 2014, 2016-2017, The Linux Foundation. All rights reserved. 3 * 4 * Redistribution and use in source and binary forms, with or without modification, are permitted 5 * provided that the following conditions are met: 6 * * Redistributions of source code must retain the above copyright notice, this list of 7 * conditions and the following disclaimer. 8 * * Redistributions in binary form must reproduce the above copyright notice, this list of 9 * conditions and the following disclaimer in the documentation and/or other materials provided 10 * with the distribution. 11 * * Neither the name of The Linux Foundation nor the names of its contributors may be used to 12 * endorse or promote products derived from this software without specific prior written 13 * permission. 14 * 15 * THIS SOFTWARE IS PROVIDED "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 16 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND 17 * NON-INFRINGEMENT ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE 18 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, 19 * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; 20 * OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, 21 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 22 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 23 */ 24 25 /*! @file layer_buffer.h 26 @brief File for layer buffer structure. 27 28 */ 29 #ifndef __LAYER_BUFFER_H__ 30 #define __LAYER_BUFFER_H__ 31 32 #include <stdint.h> 33 #include <color_metadata.h> 34 35 #include "sdm_types.h" 36 37 namespace sdm { 38 39 /*! @brief This enum represents display layer inverse gamma correction (IGC) types. 40 41 @sa Layer 42 */ 43 enum LayerIGC { 44 kIGCNotSpecified, //!< IGC is not specified. 45 kIGCsRGB, //!< sRGB IGC type. 46 }; 47 48 /*! @brief This enum represents different buffer formats supported by display manager. 49 50 @sa LayerBuffer 51 */ 52 enum LayerBufferFormat { 53 /* All RGB formats, Any new format will be added towards end of this group to maintain backward 54 compatibility. 55 */ 56 kFormatARGB8888, //!< 8-bits Alpha, Red, Green, Blue interleaved in ARGB order. 57 kFormatRGBA8888, //!< 8-bits Red, Green, Blue, Alpha interleaved in RGBA order. 58 kFormatBGRA8888, //!< 8-bits Blue, Green, Red, Alpha interleaved in BGRA order. 59 kFormatXRGB8888, //!< 8-bits Padding, Red, Green, Blue interleaved in XRGB order. No Alpha. 60 kFormatRGBX8888, //!< 8-bits Red, Green, Blue, Padding interleaved in RGBX order. No Alpha. 61 kFormatBGRX8888, //!< 8-bits Blue, Green, Red, Padding interleaved in BGRX order. No Alpha. 62 kFormatRGBA5551, //!< 5-bits Red, Green, Blue, and 1 bit Alpha interleaved in RGBA order. 63 kFormatRGBA4444, //!< 4-bits Red, Green, Blue, Alpha interleaved in RGBA order. 64 kFormatRGB888, //!< 8-bits Red, Green, Blue interleaved in RGB order. No Alpha. 65 kFormatBGR888, //!< 8-bits Blue, Green, Red interleaved in BGR order. No Alpha. 66 kFormatRGB565, //!< 5-bit Red, 6-bit Green, 5-bit Blue interleaved in RGB order. No Alpha. 67 kFormatBGR565, //!< 5-bit Blue, 6-bit Green, 5-bit Red interleaved in BGR order. No Alpha. 68 kFormatRGBA8888Ubwc, //!< UBWC aligned RGBA8888 format 69 kFormatRGBX8888Ubwc, //!< UBWC aligned RGBX8888 format 70 kFormatBGR565Ubwc, //!< UBWC aligned BGR565 format 71 kFormatRGBA1010102, //!< 10-bits Red, Green, Blue, Alpha interleaved in RGBA order. 72 kFormatARGB2101010, //!< 10-bits Alpha, Red, Green, Blue interleaved in ARGB order. 73 kFormatRGBX1010102, //!< 10-bits Red, Green, Blue, Padding interleaved in RGBX order. No Alpha. 74 kFormatXRGB2101010, //!< 10-bits Padding, Red, Green, Blue interleaved in XRGB order. No Alpha. 75 kFormatBGRA1010102, //!< 10-bits Blue, Green, Red, Alpha interleaved in BGRA order. 76 kFormatABGR2101010, //!< 10-bits Alpha, Blue, Green, Red interleaved in ABGR order. 77 kFormatBGRX1010102, //!< 10-bits Blue, Green, Red, Padding interleaved in BGRX order. No Alpha. 78 kFormatXBGR2101010, //!< 10-bits Padding, Blue, Green, Red interleaved in XBGR order. No Alpha. 79 kFormatRGBA1010102Ubwc, //!< UBWC aligned RGBA1010102 format 80 kFormatRGBX1010102Ubwc, //!< UBWC aligned RGBX1010102 format 81 kFormatRGB101010, // 10-bits Red, Green, Blue, interleaved in RGB order. No Alpha. 82 83 /* All YUV-Planar formats, Any new format will be added towards end of this group to maintain 84 backward compatibility. 85 */ 86 kFormatYCbCr420Planar = 0x100, //!< Y-plane: y(0), y(1), y(2) ... y(n) 87 //!< 2x2 subsampled U-plane: u(0), u(2) ... u(n-1) 88 //!< 2x2 subsampled V-plane: v(0), v(2) ... v(n-1) 89 90 kFormatYCrCb420Planar, //!< Y-plane: y(0), y(1), y(2) ... y(n) 91 //!< 2x2 subsampled V-plane: v(0), v(2) ... v(n-1) 92 //!< 2x2 subsampled U-plane: u(0), u(2) ... u(n-1) 93 94 kFormatYCrCb420PlanarStride16, //!< kFormatYCrCb420Planar with stride aligned to 16 bytes 95 96 /* All YUV-Semiplanar formats, Any new format will be added towards end of this group to 97 maintain backward compatibility. 98 */ 99 kFormatYCbCr420SemiPlanar = 0x200, //!< Y-plane: y(0), y(1), y(2) ... y(n) 100 //!< 2x2 subsampled interleaved UV-plane: 101 //!< u(0), v(0), u(2), v(2) ... u(n-1), v(n-1) 102 //!< aka NV12. 103 104 kFormatYCrCb420SemiPlanar, //!< Y-plane: y(0), y(1), y(2) ... y(n) 105 //!< 2x2 subsampled interleaved VU-plane: 106 //!< v(0), u(0), v(2), u(2) ... v(n-1), u(n-1) 107 //!< aka NV21. 108 109 kFormatYCbCr420SemiPlanarVenus, //!< Y-plane: y(0), y(1), y(2) ... y(n) 110 //!< 2x2 subsampled interleaved UV-plane: 111 //!< u(0), v(0), u(2), v(2) ... u(n-1), v(n-1) 112 113 kFormatYCbCr422H1V2SemiPlanar, //!< Y-plane: y(0), y(1), y(2) ... y(n) 114 //!< vertically subsampled interleaved UV-plane: 115 //!< u(0), v(1), u(2), v(3) ... u(n-1), v(n) 116 117 kFormatYCrCb422H1V2SemiPlanar, //!< Y-plane: y(0), y(1), y(2) ... y(n) 118 //!< vertically subsampled interleaved VU-plane: 119 //!< v(0), u(1), v(2), u(3) ... v(n-1), u(n) 120 121 kFormatYCbCr422H2V1SemiPlanar, //!< Y-plane: y(0), y(1), y(2) ... y(n) 122 //!< horizontally subsampled interleaved UV-plane: 123 //!< u(0), v(1), u(2), v(3) ... u(n-1), v(n) 124 125 kFormatYCrCb422H2V1SemiPlanar, //!< Y-plane: y(0), y(1), y(2) ... y(n) 126 //!< horizontally subsampled interleaved VU-plane: 127 //!< v(0), u(1), v(2), u(3) ... v(n-1), u(n) 128 129 kFormatYCbCr420SPVenusUbwc, //!< UBWC aligned YCbCr420SemiPlanarVenus format 130 131 kFormatYCrCb420SemiPlanarVenus, //!< Y-plane: y(0), y(1), y(2) ... y(n) 132 //!< 2x2 subsampled interleaved UV-plane: 133 //!< v(0), u(0), v(2), u(2) ... v(n-1), u(n-1) 134 135 kFormatYCbCr420P010, //!< 16 bit Y-plane with 5 MSB bits set to 0: 136 //!< y(0), y(1), y(2) ... y(n) 137 //!< 2x2 subsampled interleaved 10 bit UV-plane with 138 //!< 5 MSB bits set to 0: 139 //!< u(0), v(0), u(2), v(2) ... u(n-1), v(n-1) 140 //!< aka P010. 141 142 kFormatYCbCr420TP10Ubwc, //!< UBWC aligned YCbCr420TP10 format. 143 144 kFormatYCbCr420P010Ubwc, //!< UBWC aligned YCbCr420P010 format. 145 146 /* All YUV-Packed formats, Any new format will be added towards end of this group to maintain 147 backward compatibility. 148 */ 149 kFormatYCbCr422H2V1Packed = 0x300, //!< Y-plane interleaved with horizontally subsampled U/V by 150 //!< factor of 2 151 //!< y(0), u(0), y(1), v(0), y(2), u(2), y(3), v(2) 152 //!< y(n-1), u(n-1), y(n), v(n-1) 153 154 kFormatCbYCrY422H2V1Packed, 155 kFormatInvalid = 0xFFFFFFFF, 156 }; 157 158 159 /*! @brief This enum represents different types of 3D formats supported. 160 161 @sa LayerBufferS3DFormat 162 */ 163 enum LayerBufferS3DFormat { 164 kS3dFormatNone, //!< Layer buffer content is not 3D content. 165 kS3dFormatLeftRight, //!< Left and Right view of a 3D content stitched left and right. 166 kS3dFormatRightLeft, //!< Right and Left view of a 3D content stitched left and right. 167 kS3dFormatTopBottom, //!< Left and RightView of a 3D content stitched top and bottom. 168 kS3dFormatFramePacking //!< Left and right view of 3D content coded in consecutive frames. 169 }; 170 171 /*! @brief This structure defines a color sample plane belonging to a buffer format. RGB buffer 172 formats have 1 plane whereas YUV buffer formats may have upto 4 planes. 173 174 @sa LayerBuffer 175 */ 176 struct LayerBufferPlane { 177 int fd = -1; //!< File descriptor referring to the buffer associated with this plane. 178 uint32_t offset = 0; //!< Offset of the plane in bytes from beginning of the buffer. 179 uint32_t stride = 0; //!< Stride in bytes i.e. length of a scanline including padding. 180 }; 181 182 /*! @brief This structure defines flags associated with a layer buffer. The 1-bit flag can be set 183 to ON(1) or OFF(0). 184 185 @sa LayerBuffer 186 */ 187 struct LayerBufferFlags { 188 union { 189 struct { 190 uint32_t secure : 1; //!< This flag shall be set by client to indicate that the 191 //!< buffer need to be handled securely. 192 193 uint32_t video : 1; //!< This flag shall be set by client to indicate that the 194 //!< buffer is video/ui buffer. 195 196 uint32_t macro_tile : 1; //!< This flag shall be set by client to indicate that the 197 //!< buffer format is macro tiled. 198 199 uint32_t interlace : 1; //!< This flag shall be set by the client to indicate that 200 //!< the buffer has interlaced content. 201 202 uint32_t secure_display : 1; //!< This flag shall be set by the client to indicate that the 203 //!< secure display session is in progress. Secure display 204 //!< session can not coexist with non-secure session. 205 206 uint32_t secure_camera : 1; //!< This flag shall be set by the client to indicate that the 207 //!< buffer is associated with secure camera session. A secure 208 //!< camera layer can co-exist with non-secure layer(s). 209 210 uint32_t hdr : 1; //!< This flag shall be set by the client to indicate that the 211 //!< the content is HDR. 212 }; 213 214 uint32_t flags = 0; //!< For initialization purpose only. 215 //!< Client shall not refer to it directly. 216 }; 217 }; 218 219 /*! @brief This structure defines a layer buffer handle which contains raw buffer and its associated 220 properties. 221 222 @sa LayerBuffer 223 @sa LayerStack 224 */ 225 struct LayerBuffer { 226 uint32_t width = 0; //!< Aligned width of the Layer that this buffer is for. 227 uint32_t height = 0; //!< Aligned height of the Layer that this buffer is for. 228 uint32_t unaligned_width = 0; 229 //!< Unaligned width of the Layer that this buffer is for. 230 uint32_t unaligned_height = 0; 231 //!< Unaligned height of the Layer that this buffer is for. 232 uint32_t size = 0; //!< Size of a single buffer (even if multiple clubbed together) 233 LayerBufferFormat format = kFormatRGBA8888; //!< Format of the buffer content. 234 ColorMetaData color_metadata = {}; //!< CSC + Range + Transfer + Matrix + HDR Info 235 LayerIGC igc = kIGCNotSpecified; //!< IGC that will be applied on this layer. 236 LayerBufferPlane planes[4] = {}; 237 //!< Array of planes that this buffer contains. RGB buffer formats 238 //!< have 1 plane whereas YUV buffer formats may have upto 4 planes 239 //!< Total number of planes for the buffer will be interpreted based 240 //!< on the buffer format specified. 241 242 int acquire_fence_fd = -1; //!< File descriptor referring to a sync fence object which will be 243 //!< signaled when buffer can be read/write by display manager. 244 //!< This fence object is set by the client during Commit(). For 245 //!< input buffers client shall signal this fence when buffer 246 //!< content is available and can be read by display manager. For 247 //!< output buffers, client shall signal fence when buffer is ready 248 //!< to be written by display manager. 249 250 //!< This field is used only during Commit() and shall be set to -1 251 //!< by the client when buffer is already available for read/write. 252 253 int release_fence_fd = -1; //!< File descriptor referring to a sync fence object which will be 254 //!< signaled when buffer has been read/written by display manager. 255 //!< This fence object is set by display manager during Commit(). 256 //!< For input buffers display manager will signal this fence when 257 //!< buffer has been consumed. For output buffers, display manager 258 //!< will signal this fence when buffer is produced. 259 260 //!< This field is used only during Commit() and will be set to -1 261 //!< by display manager when buffer is already available for 262 //!< read/write. 263 264 LayerBufferFlags flags; //!< Flags associated with this buffer. 265 266 LayerBufferS3DFormat s3d_format = kS3dFormatNone; 267 //!< Represents the format of the buffer content in 3D. This field 268 //!< could be modified by both client and SDM. 269 uint64_t buffer_id __attribute__((aligned(8))) = 0; 270 //!< Specifies the buffer id. 271 }; 272 273 // This enum represents buffer layout types. 274 enum BufferLayout { 275 kLinear, //!< Linear data 276 kUBWC, //!< UBWC aligned data 277 kTPTiled //!< Tightly Packed data 278 }; 279 280 } // namespace sdm 281 282 #endif // __LAYER_BUFFER_H__ 283 284