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