1 /**********************************************************
2 * Copyright 2010 VMware, Inc. All rights reserved.
3 *
4 * Permission is hereby granted, free of charge, to any person
5 * obtaining a copy of this software and associated documentation
6 * files (the "Software"), to deal in the Software without
7 * restriction, including without limitation the rights to use, copy,
8 * modify, merge, publish, distribute, sublicense, and/or sell copies
9 * of the Software, and to permit persons to whom the Software is
10 * furnished to do so, subject to the following conditions:
11 *
12 * The above copyright notice and this permission notice shall be
13 * included in all copies or substantial portions of the 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 HOLDERS
19 * BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
20 * ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
21 * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
22 * SOFTWARE.
23 *
24 **********************************************************/
25
26
27 #ifndef _API_H_
28 #define _API_H_
29
30 #include "pipe/p_format.h"
31
32 /**
33 * \file API for communication between gallium frontends and supporting
34 * frontends such as DRI.
35 *
36 * This file defines an API to be implemented by both gallium frontends and
37 * their managers.
38 */
39
40 /**
41 * The supported rendering API.
42 */
43 enum st_api_type {
44 ST_API_OPENGL,
45 ST_API_OPENVG,
46
47 ST_API_COUNT
48 };
49
50 /**
51 * The profile of a context.
52 */
53 enum st_profile_type
54 {
55 ST_PROFILE_DEFAULT, /**< OpenGL compatibility profile */
56 ST_PROFILE_OPENGL_CORE, /**< OpenGL 3.2+ core profile */
57 ST_PROFILE_OPENGL_ES1, /**< OpenGL ES 1.x */
58 ST_PROFILE_OPENGL_ES2 /**< OpenGL ES 2.0 */
59 };
60
61 /* for profile_mask in st_api */
62 #define ST_PROFILE_DEFAULT_MASK (1 << ST_PROFILE_DEFAULT)
63 #define ST_PROFILE_OPENGL_CORE_MASK (1 << ST_PROFILE_OPENGL_CORE)
64 #define ST_PROFILE_OPENGL_ES1_MASK (1 << ST_PROFILE_OPENGL_ES1)
65 #define ST_PROFILE_OPENGL_ES2_MASK (1 << ST_PROFILE_OPENGL_ES2)
66
67 /**
68 * Optional API features.
69 */
70 enum st_api_feature
71 {
72 ST_API_FEATURE_MS_VISUALS /**< support for multisample visuals */
73 };
74
75 /* for feature_mask in st_api */
76 #define ST_API_FEATURE_MS_VISUALS_MASK (1 << ST_API_FEATURE_MS_VISUALS)
77
78 /**
79 * New context flags for GL 3.0 and beyond.
80 *
81 * Profile information (core vs. compatibilty for OpenGL 3.2+) is communicated
82 * through the \c st_profile_type, not through flags.
83 */
84 #define ST_CONTEXT_FLAG_DEBUG (1 << 0)
85 #define ST_CONTEXT_FLAG_FORWARD_COMPATIBLE (1 << 1)
86 #define ST_CONTEXT_FLAG_ROBUST_ACCESS (1 << 2)
87 #define ST_CONTEXT_FLAG_RESET_NOTIFICATION_ENABLED (1 << 3)
88 #define ST_CONTEXT_FLAG_NO_ERROR (1 << 4)
89 #define ST_CONTEXT_FLAG_RELEASE_NONE (1 << 5)
90 #define ST_CONTEXT_FLAG_HIGH_PRIORITY (1 << 6)
91 #define ST_CONTEXT_FLAG_LOW_PRIORITY (1 << 7)
92
93 /**
94 * Reasons that context creation might fail.
95 */
96 enum st_context_error {
97 ST_CONTEXT_SUCCESS = 0,
98 ST_CONTEXT_ERROR_NO_MEMORY,
99 ST_CONTEXT_ERROR_BAD_API,
100 ST_CONTEXT_ERROR_BAD_VERSION,
101 ST_CONTEXT_ERROR_BAD_FLAG,
102 ST_CONTEXT_ERROR_UNKNOWN_ATTRIBUTE,
103 ST_CONTEXT_ERROR_UNKNOWN_FLAG
104 };
105
106 /**
107 * Used in st_context_iface->teximage.
108 */
109 enum st_texture_type {
110 ST_TEXTURE_1D,
111 ST_TEXTURE_2D,
112 ST_TEXTURE_3D,
113 ST_TEXTURE_RECT
114 };
115
116 /**
117 * Available attachments of framebuffer.
118 */
119 enum st_attachment_type {
120 ST_ATTACHMENT_FRONT_LEFT,
121 ST_ATTACHMENT_BACK_LEFT,
122 ST_ATTACHMENT_FRONT_RIGHT,
123 ST_ATTACHMENT_BACK_RIGHT,
124 ST_ATTACHMENT_DEPTH_STENCIL,
125 ST_ATTACHMENT_ACCUM,
126 ST_ATTACHMENT_SAMPLE,
127
128 ST_ATTACHMENT_COUNT,
129 ST_ATTACHMENT_INVALID = -1
130 };
131
132 /* for buffer_mask in st_visual */
133 #define ST_ATTACHMENT_FRONT_LEFT_MASK (1 << ST_ATTACHMENT_FRONT_LEFT)
134 #define ST_ATTACHMENT_BACK_LEFT_MASK (1 << ST_ATTACHMENT_BACK_LEFT)
135 #define ST_ATTACHMENT_FRONT_RIGHT_MASK (1 << ST_ATTACHMENT_FRONT_RIGHT)
136 #define ST_ATTACHMENT_BACK_RIGHT_MASK (1 << ST_ATTACHMENT_BACK_RIGHT)
137 #define ST_ATTACHMENT_DEPTH_STENCIL_MASK (1 << ST_ATTACHMENT_DEPTH_STENCIL)
138 #define ST_ATTACHMENT_ACCUM_MASK (1 << ST_ATTACHMENT_ACCUM)
139 #define ST_ATTACHMENT_SAMPLE_MASK (1 << ST_ATTACHMENT_SAMPLE)
140
141 /**
142 * Flush flags.
143 */
144 #define ST_FLUSH_FRONT (1 << 0)
145 #define ST_FLUSH_END_OF_FRAME (1 << 1)
146 #define ST_FLUSH_WAIT (1 << 2)
147 #define ST_FLUSH_FENCE_FD (1 << 3)
148
149 /**
150 * Value to st_manager->get_param function.
151 */
152 enum st_manager_param {
153 /**
154 * The DRI frontend on old libGL's doesn't do the right thing
155 * with regards to invalidating the framebuffers.
156 *
157 * For the GL gallium frontend that means that it needs to invalidate
158 * the framebuffer in glViewport itself.
159 */
160 ST_MANAGER_BROKEN_INVALIDATE
161 };
162
163 struct pipe_context;
164 struct pipe_resource;
165 struct pipe_fence_handle;
166 struct util_queue_monitoring;
167
168 /**
169 * Used in st_manager_iface->get_egl_image.
170 */
171 struct st_egl_image
172 {
173 /* this is owned by the caller */
174 struct pipe_resource *texture;
175
176 /* format only differs from texture->format for multi-planar (YUV): */
177 enum pipe_format format;
178
179 unsigned level;
180 unsigned layer;
181 /* GL internal format. */
182 unsigned internalformat;
183 };
184
185 /**
186 * Represent the visual of a framebuffer.
187 */
188 struct st_visual
189 {
190 bool no_config;
191
192 /**
193 * Available buffers. Bitfield of ST_ATTACHMENT_*_MASK bits.
194 */
195 unsigned buffer_mask;
196
197 /**
198 * Buffer formats. The formats are always set even when the buffer is
199 * not available.
200 */
201 enum pipe_format color_format;
202 enum pipe_format depth_stencil_format;
203 enum pipe_format accum_format;
204 unsigned samples;
205
206 /**
207 * Desired render buffer.
208 */
209 enum st_attachment_type render_buffer;
210 };
211
212
213 /**
214 * Configuration options from driconf
215 */
216 struct st_config_options
217 {
218 bool disable_blend_func_extended;
219 bool disable_glsl_line_continuations;
220 bool disable_arb_gpu_shader5;
221 bool force_glsl_extensions_warn;
222 unsigned force_glsl_version;
223 bool allow_extra_pp_tokens;
224 bool allow_glsl_extension_directive_midshader;
225 bool allow_glsl_120_subset_in_110;
226 bool allow_glsl_builtin_const_expression;
227 bool allow_glsl_relaxed_es;
228 bool allow_glsl_builtin_variable_redeclaration;
229 bool allow_higher_compat_version;
230 bool glsl_zero_init;
231 bool vs_position_always_invariant;
232 bool force_glsl_abs_sqrt;
233 bool allow_glsl_cross_stage_interpolation_mismatch;
234 bool allow_draw_out_of_order;
235 bool force_integer_tex_nearest;
236 bool force_gl_names_reuse;
237 char *force_gl_vendor;
238 unsigned char config_options_sha1[20];
239 };
240
241 /**
242 * Represent the attributes of a context.
243 */
244 struct st_context_attribs
245 {
246 /**
247 * The profile and minimal version to support.
248 *
249 * The valid profiles and versions are rendering API dependent. The latest
250 * version satisfying the request should be returned.
251 */
252 enum st_profile_type profile;
253 int major, minor;
254
255 /** Mask of ST_CONTEXT_FLAG_x bits */
256 unsigned flags;
257
258 /**
259 * The visual of the framebuffers the context will be bound to.
260 */
261 struct st_visual visual;
262
263 /**
264 * Configuration options.
265 */
266 struct st_config_options options;
267 };
268
269 struct st_context_iface;
270 struct st_manager;
271
272 /**
273 * Represent a windowing system drawable.
274 *
275 * The framebuffer is implemented by the frontend manager and
276 * used by gallium frontends.
277 *
278 * Instead of the winsys poking into the frontend context to figure
279 * out what buffers that might be needed in the future by the frontend
280 * context, it calls into the framebuffer to get the textures.
281 *
282 * This structure along with the notify_invalid_framebuffer
283 * allows framebuffers to be shared between different threads
284 * but at the same make the API context free from thread
285 * synchronization primitves, with the exception of a small
286 * atomic flag used for notification of framebuffer dirty status.
287 *
288 * The thread synchronization is put inside the framebuffer
289 * and only called once the framebuffer has become dirty.
290 */
291 struct st_framebuffer_iface
292 {
293 /**
294 * Atomic stamp which changes when framebuffers need to be updated.
295 */
296 int32_t stamp;
297
298 /**
299 * Identifier that uniquely identifies the framebuffer interface object.
300 */
301 uint32_t ID;
302
303 /**
304 * The frontend manager that manages this object.
305 */
306 struct st_manager *state_manager;
307
308 /**
309 * Available for the frontend manager to use.
310 */
311 void *st_manager_private;
312
313 /**
314 * The visual of a framebuffer.
315 */
316 const struct st_visual *visual;
317
318 /**
319 * Flush the front buffer.
320 *
321 * On some window systems, changes to the front buffers are not immediately
322 * visible. They need to be flushed.
323 *
324 * @att is one of the front buffer attachments.
325 */
326 bool (*flush_front)(struct st_context_iface *stctx,
327 struct st_framebuffer_iface *stfbi,
328 enum st_attachment_type statt);
329
330 /**
331 * the gallium frontend asks for the textures it needs.
332 *
333 * It should try to only ask for attachments that it currently renders
334 * to, thus allowing the winsys to delay the allocation of textures not
335 * needed. For example front buffer attachments are not needed if you
336 * only do back buffer rendering.
337 *
338 * The implementor of this function needs to also ensure
339 * thread safty as this call might be done from multiple threads.
340 *
341 * The returned textures are owned by the caller. They should be
342 * unreferenced when no longer used. If this function is called multiple
343 * times with different sets of attachments, those buffers not included in
344 * the last call might be destroyed. This behavior might change in the
345 * future.
346 */
347 bool (*validate)(struct st_context_iface *stctx,
348 struct st_framebuffer_iface *stfbi,
349 const enum st_attachment_type *statts,
350 unsigned count,
351 struct pipe_resource **out);
352 bool (*flush_swapbuffers) (struct st_context_iface *stctx,
353 struct st_framebuffer_iface *stfbi);
354 };
355
356 /**
357 * Represent a rendering context.
358 *
359 * This entity is created from st_api and used by the frontend manager.
360 */
361 struct st_context_iface
362 {
363 /**
364 * Available for the gallium frontend and the manager to use.
365 */
366 void *st_context_private;
367 void *st_manager_private;
368
369 /**
370 * The frontend manager that manages this object.
371 */
372 struct st_manager *state_manager;
373
374 /**
375 * The CSO context associated with this context in case we need to draw
376 * something before swap buffers.
377 */
378 struct cso_context *cso_context;
379
380 /**
381 * The gallium context.
382 */
383 struct pipe_context *pipe;
384
385 /**
386 * Destroy the context.
387 */
388 void (*destroy)(struct st_context_iface *stctxi);
389
390 /**
391 * Flush all drawing from context to the pipe also flushes the pipe.
392 */
393 void (*flush)(struct st_context_iface *stctxi, unsigned flags,
394 struct pipe_fence_handle **fence,
395 void (*notify_before_flush_cb) (void*),
396 void* notify_before_flush_cb_args);
397
398 /**
399 * Replace the texture image of a texture object at the specified level.
400 *
401 * This function is optional.
402 */
403 bool (*teximage)(struct st_context_iface *stctxi,
404 enum st_texture_type target,
405 int level, enum pipe_format internal_format,
406 struct pipe_resource *tex, bool mipmap);
407
408 /**
409 * Used to implement glXCopyContext.
410 */
411 void (*copy)(struct st_context_iface *stctxi,
412 struct st_context_iface *stsrci, unsigned mask);
413
414 /**
415 * Used to implement wglShareLists.
416 */
417 bool (*share)(struct st_context_iface *stctxi,
418 struct st_context_iface *stsrci);
419
420 /**
421 * Start the thread if the API has a worker thread.
422 * Called after the context has been created and fully initialized on both
423 * sides (e.g. st/mesa and st/dri).
424 */
425 void (*start_thread)(struct st_context_iface *stctxi);
426
427 /**
428 * If the API is multithreaded, wait for all queued commands to complete.
429 * Called from the main thread.
430 */
431 void (*thread_finish)(struct st_context_iface *stctxi);
432 };
433
434
435 /**
436 * Represent a frontend manager.
437 *
438 * This interface is implemented by the frontend manager. It corresponds
439 * to a "display" in the window system.
440 */
441 struct st_manager
442 {
443 struct pipe_screen *screen;
444
445 /**
446 * Look up and return the info of an EGLImage.
447 *
448 * This is used to implement for example EGLImageTargetTexture2DOES.
449 * The GLeglImageOES agrument of that call is passed directly to this
450 * function call and the information needed to access this is returned
451 * in the given struct out.
452 *
453 * @smapi: manager owning the caller context
454 * @stctx: caller context
455 * @egl_image: EGLImage that caller recived
456 * @out: return struct filled out with access information.
457 *
458 * This function is optional.
459 */
460 bool (*get_egl_image)(struct st_manager *smapi,
461 void *egl_image,
462 struct st_egl_image *out);
463
464 /**
465 * Query an manager param.
466 */
467 int (*get_param)(struct st_manager *smapi,
468 enum st_manager_param param);
469
470 /**
471 * Call the loader function setBackgroundContext. Called from the worker
472 * thread.
473 */
474 void (*set_background_context)(struct st_context_iface *stctxi,
475 struct util_queue_monitoring *queue_info);
476
477 /**
478 * Destroy any private data used by the frontend manager.
479 */
480 void (*destroy)(struct st_manager *smapi);
481
482 /**
483 * Available for the frontend manager to use.
484 */
485 void *st_manager_private;
486 };
487
488 /**
489 * Represent a rendering API such as OpenGL or OpenVG.
490 *
491 * Implemented by the gallium frontend and used by the frontend manager.
492 */
493 struct st_api
494 {
495 /**
496 * The name of the rendering API. This is informative.
497 */
498 const char *name;
499
500 /**
501 * The supported rendering API.
502 */
503 enum st_api_type api;
504
505 /**
506 * The supported profiles. Tested with ST_PROFILE_*_MASK.
507 */
508 unsigned profile_mask;
509
510 /**
511 * The supported optional features. Tested with ST_FEATURE_*_MASK.
512 */
513 unsigned feature_mask;
514
515 /**
516 * Destroy the API.
517 */
518 void (*destroy)(struct st_api *stapi);
519
520 /**
521 * Query supported OpenGL versions. (if applicable)
522 * The format is (major*10+minor).
523 */
524 void (*query_versions)(struct st_api *stapi, struct st_manager *sm,
525 struct st_config_options *options,
526 int *gl_core_version,
527 int *gl_compat_version,
528 int *gl_es1_version,
529 int *gl_es2_version);
530
531 /**
532 * Create a rendering context.
533 */
534 struct st_context_iface *(*create_context)(struct st_api *stapi,
535 struct st_manager *smapi,
536 const struct st_context_attribs *attribs,
537 enum st_context_error *error,
538 struct st_context_iface *stsharei);
539
540 /**
541 * Bind the context to the calling thread with draw and read as drawables.
542 *
543 * The framebuffers might be NULL, or might have different visuals than the
544 * context does.
545 */
546 bool (*make_current)(struct st_api *stapi,
547 struct st_context_iface *stctxi,
548 struct st_framebuffer_iface *stdrawi,
549 struct st_framebuffer_iface *streadi);
550
551 /**
552 * Get the currently bound context in the calling thread.
553 */
554 struct st_context_iface *(*get_current)(struct st_api *stapi);
555
556 /**
557 * Notify the st manager the framebuffer interface object
558 * is no longer valid.
559 */
560 void (*destroy_drawable)(struct st_api *stapi,
561 struct st_framebuffer_iface *stfbi);
562 };
563
564 /**
565 * Return true if the visual has the specified buffers.
566 */
567 static inline bool
st_visual_have_buffers(const struct st_visual * visual,unsigned mask)568 st_visual_have_buffers(const struct st_visual *visual, unsigned mask)
569 {
570 return ((visual->buffer_mask & mask) == mask);
571 }
572
573 #endif /* _API_H_ */
574