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