gbm: Export a per plane getter for stride
[mesa.git] / src / gbm / main / gbm.h
1 /*
2 * Copyright © 2011 Intel Corporation
3 *
4 * Permission is hereby granted, free of charge, to any person obtaining a
5 * copy of this software and associated documentation files (the "Software"),
6 * to deal in the Software without restriction, including without limitation
7 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
8 * and/or sell copies of the Software, and to permit persons to whom the
9 * Software is furnished to do so, subject to the following conditions:
10 *
11 * The above copyright notice and this permission notice (including the next
12 * paragraph) shall be included in all copies or substantial portions of the
13 * Software.
14 *
15 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
16 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
17 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
18 * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
19 * HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
20 * WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
21 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
22 * DEALINGS IN THE SOFTWARE.
23 *
24 * Authors:
25 * Benjamin Franzke <benjaminfranzke@googlemail.com>
26 */
27
28 #ifndef _GBM_H_
29 #define _GBM_H_
30
31 #define __GBM__ 1
32
33 #include <stddef.h>
34 #include <stdint.h>
35
36 #ifdef __cplusplus
37 extern "C" {
38 #endif
39
40
41 /**
42 * \file gbm.h
43 * \brief Generic Buffer Manager
44 */
45
46 struct gbm_device;
47 struct gbm_bo;
48 struct gbm_surface;
49
50 /**
51 * \mainpage The Generic Buffer Manager
52 *
53 * This module provides an abstraction that the caller can use to request a
54 * buffer from the underlying memory management system for the platform.
55 *
56 * This allows the creation of portable code whilst still allowing access to
57 * the underlying memory manager.
58 */
59
60 /**
61 * Abstraction representing the handle to a buffer allocated by the
62 * manager
63 */
64 union gbm_bo_handle {
65 void *ptr;
66 int32_t s32;
67 uint32_t u32;
68 int64_t s64;
69 uint64_t u64;
70 };
71
72 /** Format of the allocated buffer */
73 enum gbm_bo_format {
74 /** RGB with 8 bits per channel in a 32 bit value */
75 GBM_BO_FORMAT_XRGB8888,
76 /** ARGB with 8 bits per channel in a 32 bit value */
77 GBM_BO_FORMAT_ARGB8888
78 };
79
80 #define __gbm_fourcc_code(a,b,c,d) ((uint32_t)(a) | ((uint32_t)(b) << 8) | \
81 ((uint32_t)(c) << 16) | ((uint32_t)(d) << 24))
82
83 #define GBM_FORMAT_BIG_ENDIAN (1<<31) /* format is big endian instead of little endian */
84
85 /* color index */
86 #define GBM_FORMAT_C8 __gbm_fourcc_code('C', '8', ' ', ' ') /* [7:0] C */
87
88 /* 8 bpp Red */
89 #define GBM_FORMAT_R8 __gbm_fourcc_code('R', '8', ' ', ' ') /* [7:0] R */
90
91 /* 16 bpp RG */
92 #define GBM_FORMAT_GR88 __gbm_fourcc_code('G', 'R', '8', '8') /* [15:0] G:R 8:8 little endian */
93
94 /* 8 bpp RGB */
95 #define GBM_FORMAT_RGB332 __gbm_fourcc_code('R', 'G', 'B', '8') /* [7:0] R:G:B 3:3:2 */
96 #define GBM_FORMAT_BGR233 __gbm_fourcc_code('B', 'G', 'R', '8') /* [7:0] B:G:R 2:3:3 */
97
98 /* 16 bpp RGB */
99 #define GBM_FORMAT_XRGB4444 __gbm_fourcc_code('X', 'R', '1', '2') /* [15:0] x:R:G:B 4:4:4:4 little endian */
100 #define GBM_FORMAT_XBGR4444 __gbm_fourcc_code('X', 'B', '1', '2') /* [15:0] x:B:G:R 4:4:4:4 little endian */
101 #define GBM_FORMAT_RGBX4444 __gbm_fourcc_code('R', 'X', '1', '2') /* [15:0] R:G:B:x 4:4:4:4 little endian */
102 #define GBM_FORMAT_BGRX4444 __gbm_fourcc_code('B', 'X', '1', '2') /* [15:0] B:G:R:x 4:4:4:4 little endian */
103
104 #define GBM_FORMAT_ARGB4444 __gbm_fourcc_code('A', 'R', '1', '2') /* [15:0] A:R:G:B 4:4:4:4 little endian */
105 #define GBM_FORMAT_ABGR4444 __gbm_fourcc_code('A', 'B', '1', '2') /* [15:0] A:B:G:R 4:4:4:4 little endian */
106 #define GBM_FORMAT_RGBA4444 __gbm_fourcc_code('R', 'A', '1', '2') /* [15:0] R:G:B:A 4:4:4:4 little endian */
107 #define GBM_FORMAT_BGRA4444 __gbm_fourcc_code('B', 'A', '1', '2') /* [15:0] B:G:R:A 4:4:4:4 little endian */
108
109 #define GBM_FORMAT_XRGB1555 __gbm_fourcc_code('X', 'R', '1', '5') /* [15:0] x:R:G:B 1:5:5:5 little endian */
110 #define GBM_FORMAT_XBGR1555 __gbm_fourcc_code('X', 'B', '1', '5') /* [15:0] x:B:G:R 1:5:5:5 little endian */
111 #define GBM_FORMAT_RGBX5551 __gbm_fourcc_code('R', 'X', '1', '5') /* [15:0] R:G:B:x 5:5:5:1 little endian */
112 #define GBM_FORMAT_BGRX5551 __gbm_fourcc_code('B', 'X', '1', '5') /* [15:0] B:G:R:x 5:5:5:1 little endian */
113
114 #define GBM_FORMAT_ARGB1555 __gbm_fourcc_code('A', 'R', '1', '5') /* [15:0] A:R:G:B 1:5:5:5 little endian */
115 #define GBM_FORMAT_ABGR1555 __gbm_fourcc_code('A', 'B', '1', '5') /* [15:0] A:B:G:R 1:5:5:5 little endian */
116 #define GBM_FORMAT_RGBA5551 __gbm_fourcc_code('R', 'A', '1', '5') /* [15:0] R:G:B:A 5:5:5:1 little endian */
117 #define GBM_FORMAT_BGRA5551 __gbm_fourcc_code('B', 'A', '1', '5') /* [15:0] B:G:R:A 5:5:5:1 little endian */
118
119 #define GBM_FORMAT_RGB565 __gbm_fourcc_code('R', 'G', '1', '6') /* [15:0] R:G:B 5:6:5 little endian */
120 #define GBM_FORMAT_BGR565 __gbm_fourcc_code('B', 'G', '1', '6') /* [15:0] B:G:R 5:6:5 little endian */
121
122 /* 24 bpp RGB */
123 #define GBM_FORMAT_RGB888 __gbm_fourcc_code('R', 'G', '2', '4') /* [23:0] R:G:B little endian */
124 #define GBM_FORMAT_BGR888 __gbm_fourcc_code('B', 'G', '2', '4') /* [23:0] B:G:R little endian */
125
126 /* 32 bpp RGB */
127 #define GBM_FORMAT_XRGB8888 __gbm_fourcc_code('X', 'R', '2', '4') /* [31:0] x:R:G:B 8:8:8:8 little endian */
128 #define GBM_FORMAT_XBGR8888 __gbm_fourcc_code('X', 'B', '2', '4') /* [31:0] x:B:G:R 8:8:8:8 little endian */
129 #define GBM_FORMAT_RGBX8888 __gbm_fourcc_code('R', 'X', '2', '4') /* [31:0] R:G:B:x 8:8:8:8 little endian */
130 #define GBM_FORMAT_BGRX8888 __gbm_fourcc_code('B', 'X', '2', '4') /* [31:0] B:G:R:x 8:8:8:8 little endian */
131
132 #define GBM_FORMAT_ARGB8888 __gbm_fourcc_code('A', 'R', '2', '4') /* [31:0] A:R:G:B 8:8:8:8 little endian */
133 #define GBM_FORMAT_ABGR8888 __gbm_fourcc_code('A', 'B', '2', '4') /* [31:0] A:B:G:R 8:8:8:8 little endian */
134 #define GBM_FORMAT_RGBA8888 __gbm_fourcc_code('R', 'A', '2', '4') /* [31:0] R:G:B:A 8:8:8:8 little endian */
135 #define GBM_FORMAT_BGRA8888 __gbm_fourcc_code('B', 'A', '2', '4') /* [31:0] B:G:R:A 8:8:8:8 little endian */
136
137 #define GBM_FORMAT_XRGB2101010 __gbm_fourcc_code('X', 'R', '3', '0') /* [31:0] x:R:G:B 2:10:10:10 little endian */
138 #define GBM_FORMAT_XBGR2101010 __gbm_fourcc_code('X', 'B', '3', '0') /* [31:0] x:B:G:R 2:10:10:10 little endian */
139 #define GBM_FORMAT_RGBX1010102 __gbm_fourcc_code('R', 'X', '3', '0') /* [31:0] R:G:B:x 10:10:10:2 little endian */
140 #define GBM_FORMAT_BGRX1010102 __gbm_fourcc_code('B', 'X', '3', '0') /* [31:0] B:G:R:x 10:10:10:2 little endian */
141
142 #define GBM_FORMAT_ARGB2101010 __gbm_fourcc_code('A', 'R', '3', '0') /* [31:0] A:R:G:B 2:10:10:10 little endian */
143 #define GBM_FORMAT_ABGR2101010 __gbm_fourcc_code('A', 'B', '3', '0') /* [31:0] A:B:G:R 2:10:10:10 little endian */
144 #define GBM_FORMAT_RGBA1010102 __gbm_fourcc_code('R', 'A', '3', '0') /* [31:0] R:G:B:A 10:10:10:2 little endian */
145 #define GBM_FORMAT_BGRA1010102 __gbm_fourcc_code('B', 'A', '3', '0') /* [31:0] B:G:R:A 10:10:10:2 little endian */
146
147 /* packed YCbCr */
148 #define GBM_FORMAT_YUYV __gbm_fourcc_code('Y', 'U', 'Y', 'V') /* [31:0] Cr0:Y1:Cb0:Y0 8:8:8:8 little endian */
149 #define GBM_FORMAT_YVYU __gbm_fourcc_code('Y', 'V', 'Y', 'U') /* [31:0] Cb0:Y1:Cr0:Y0 8:8:8:8 little endian */
150 #define GBM_FORMAT_UYVY __gbm_fourcc_code('U', 'Y', 'V', 'Y') /* [31:0] Y1:Cr0:Y0:Cb0 8:8:8:8 little endian */
151 #define GBM_FORMAT_VYUY __gbm_fourcc_code('V', 'Y', 'U', 'Y') /* [31:0] Y1:Cb0:Y0:Cr0 8:8:8:8 little endian */
152
153 #define GBM_FORMAT_AYUV __gbm_fourcc_code('A', 'Y', 'U', 'V') /* [31:0] A:Y:Cb:Cr 8:8:8:8 little endian */
154
155 /*
156 * 2 plane YCbCr
157 * index 0 = Y plane, [7:0] Y
158 * index 1 = Cr:Cb plane, [15:0] Cr:Cb little endian
159 * or
160 * index 1 = Cb:Cr plane, [15:0] Cb:Cr little endian
161 */
162 #define GBM_FORMAT_NV12 __gbm_fourcc_code('N', 'V', '1', '2') /* 2x2 subsampled Cr:Cb plane */
163 #define GBM_FORMAT_NV21 __gbm_fourcc_code('N', 'V', '2', '1') /* 2x2 subsampled Cb:Cr plane */
164 #define GBM_FORMAT_NV16 __gbm_fourcc_code('N', 'V', '1', '6') /* 2x1 subsampled Cr:Cb plane */
165 #define GBM_FORMAT_NV61 __gbm_fourcc_code('N', 'V', '6', '1') /* 2x1 subsampled Cb:Cr plane */
166
167 /*
168 * 3 plane YCbCr
169 * index 0: Y plane, [7:0] Y
170 * index 1: Cb plane, [7:0] Cb
171 * index 2: Cr plane, [7:0] Cr
172 * or
173 * index 1: Cr plane, [7:0] Cr
174 * index 2: Cb plane, [7:0] Cb
175 */
176 #define GBM_FORMAT_YUV410 __gbm_fourcc_code('Y', 'U', 'V', '9') /* 4x4 subsampled Cb (1) and Cr (2) planes */
177 #define GBM_FORMAT_YVU410 __gbm_fourcc_code('Y', 'V', 'U', '9') /* 4x4 subsampled Cr (1) and Cb (2) planes */
178 #define GBM_FORMAT_YUV411 __gbm_fourcc_code('Y', 'U', '1', '1') /* 4x1 subsampled Cb (1) and Cr (2) planes */
179 #define GBM_FORMAT_YVU411 __gbm_fourcc_code('Y', 'V', '1', '1') /* 4x1 subsampled Cr (1) and Cb (2) planes */
180 #define GBM_FORMAT_YUV420 __gbm_fourcc_code('Y', 'U', '1', '2') /* 2x2 subsampled Cb (1) and Cr (2) planes */
181 #define GBM_FORMAT_YVU420 __gbm_fourcc_code('Y', 'V', '1', '2') /* 2x2 subsampled Cr (1) and Cb (2) planes */
182 #define GBM_FORMAT_YUV422 __gbm_fourcc_code('Y', 'U', '1', '6') /* 2x1 subsampled Cb (1) and Cr (2) planes */
183 #define GBM_FORMAT_YVU422 __gbm_fourcc_code('Y', 'V', '1', '6') /* 2x1 subsampled Cr (1) and Cb (2) planes */
184 #define GBM_FORMAT_YUV444 __gbm_fourcc_code('Y', 'U', '2', '4') /* non-subsampled Cb (1) and Cr (2) planes */
185 #define GBM_FORMAT_YVU444 __gbm_fourcc_code('Y', 'V', '2', '4') /* non-subsampled Cr (1) and Cb (2) planes */
186
187
188 /**
189 * Flags to indicate the intended use for the buffer - these are passed into
190 * gbm_bo_create(). The caller must set the union of all the flags that are
191 * appropriate
192 *
193 * \sa Use gbm_device_is_format_supported() to check if the combination of format
194 * and use flags are supported
195 */
196 enum gbm_bo_flags {
197 /**
198 * Buffer is going to be presented to the screen using an API such as KMS
199 */
200 GBM_BO_USE_SCANOUT = (1 << 0),
201 /**
202 * Buffer is going to be used as cursor
203 */
204 GBM_BO_USE_CURSOR = (1 << 1),
205 /**
206 * Deprecated
207 */
208 GBM_BO_USE_CURSOR_64X64 = GBM_BO_USE_CURSOR,
209 /**
210 * Buffer is to be used for rendering - for example it is going to be used
211 * as the storage for a color buffer
212 */
213 GBM_BO_USE_RENDERING = (1 << 2),
214 /**
215 * Buffer can be used for gbm_bo_write. This is guaranteed to work
216 * with GBM_BO_USE_CURSOR, but may not work for other combinations.
217 */
218 GBM_BO_USE_WRITE = (1 << 3),
219 /**
220 * Buffer is linear, i.e. not tiled.
221 */
222 GBM_BO_USE_LINEAR = (1 << 4),
223 };
224
225 int
226 gbm_device_get_fd(struct gbm_device *gbm);
227
228 const char *
229 gbm_device_get_backend_name(struct gbm_device *gbm);
230
231 int
232 gbm_device_is_format_supported(struct gbm_device *gbm,
233 uint32_t format, uint32_t usage);
234
235 void
236 gbm_device_destroy(struct gbm_device *gbm);
237
238 struct gbm_device *
239 gbm_create_device(int fd);
240
241 struct gbm_bo *
242 gbm_bo_create(struct gbm_device *gbm,
243 uint32_t width, uint32_t height,
244 uint32_t format, uint32_t flags);
245
246 #define GBM_BO_IMPORT_WL_BUFFER 0x5501
247 #define GBM_BO_IMPORT_EGL_IMAGE 0x5502
248 #define GBM_BO_IMPORT_FD 0x5503
249
250 struct gbm_import_fd_data {
251 int fd;
252 uint32_t width;
253 uint32_t height;
254 uint32_t stride;
255 uint32_t format;
256 };
257
258 struct gbm_bo *
259 gbm_bo_import(struct gbm_device *gbm, uint32_t type,
260 void *buffer, uint32_t usage);
261
262 /**
263 * Flags to indicate the type of mapping for the buffer - these are
264 * passed into gbm_bo_map(). The caller must set the union of all the
265 * flags that are appropriate.
266 *
267 * These flags are independent of the GBM_BO_USE_* creation flags. However,
268 * mapping the buffer may require copying to/from a staging buffer.
269 *
270 * See also: pipe_transfer_usage
271 */
272 enum gbm_bo_transfer_flags {
273 /**
274 * Buffer contents read back (or accessed directly) at transfer
275 * create time.
276 */
277 GBM_BO_TRANSFER_READ = (1 << 0),
278 /**
279 * Buffer contents will be written back at unmap time
280 * (or modified as a result of being accessed directly).
281 */
282 GBM_BO_TRANSFER_WRITE = (1 << 1),
283 /**
284 * Read/modify/write
285 */
286 GBM_BO_TRANSFER_READ_WRITE = (GBM_BO_TRANSFER_READ | GBM_BO_TRANSFER_WRITE),
287 };
288
289 void *
290 gbm_bo_map(struct gbm_bo *bo,
291 uint32_t x, uint32_t y, uint32_t width, uint32_t height,
292 uint32_t flags, uint32_t *stride, void **map_data);
293
294 void
295 gbm_bo_unmap(struct gbm_bo *bo, void *map_data);
296
297 uint32_t
298 gbm_bo_get_width(struct gbm_bo *bo);
299
300 uint32_t
301 gbm_bo_get_height(struct gbm_bo *bo);
302
303 uint32_t
304 gbm_bo_get_stride(struct gbm_bo *bo);
305
306 uint32_t
307 gbm_bo_get_stride_for_plane(struct gbm_bo *bo, int plane);
308
309 uint32_t
310 gbm_bo_get_format(struct gbm_bo *bo);
311
312 struct gbm_device *
313 gbm_bo_get_device(struct gbm_bo *bo);
314
315 union gbm_bo_handle
316 gbm_bo_get_handle(struct gbm_bo *bo);
317
318 int
319 gbm_bo_get_fd(struct gbm_bo *bo);
320
321 int
322 gbm_bo_get_plane_count(struct gbm_bo *bo);
323
324 union gbm_bo_handle
325 gbm_bo_get_handle_for_plane(struct gbm_bo *bo, int plane);
326
327 int
328 gbm_bo_write(struct gbm_bo *bo, const void *buf, size_t count);
329
330 void
331 gbm_bo_set_user_data(struct gbm_bo *bo, void *data,
332 void (*destroy_user_data)(struct gbm_bo *, void *));
333
334 void *
335 gbm_bo_get_user_data(struct gbm_bo *bo);
336
337 void
338 gbm_bo_destroy(struct gbm_bo *bo);
339
340 struct gbm_surface *
341 gbm_surface_create(struct gbm_device *gbm,
342 uint32_t width, uint32_t height,
343 uint32_t format, uint32_t flags);
344
345 int
346 gbm_surface_needs_lock_front_buffer(struct gbm_surface *surface);
347
348 struct gbm_bo *
349 gbm_surface_lock_front_buffer(struct gbm_surface *surface);
350
351 void
352 gbm_surface_release_buffer(struct gbm_surface *surface, struct gbm_bo *bo);
353
354 int
355 gbm_surface_has_free_buffers(struct gbm_surface *surface);
356
357 void
358 gbm_surface_destroy(struct gbm_surface *surface);
359
360 #ifdef __cplusplus
361 }
362 #endif
363
364 #endif