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