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