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