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