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