src/gallium/include/state_tracker/st_api.h

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