src/gallium/include/frontend/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 _API_H_
  28 #define _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    /* GL internal format. */
 186    unsigned internalformat;
 187 };
 188
 189 /**
 190  * Represent the visual of a framebuffer.
 191  */
 192 struct st_visual
 193 {
 194    bool no_config;
 195
 196    /**
 197     * Available buffers.  Bitfield of ST_ATTACHMENT_*_MASK bits.
 198     */
 199    unsigned buffer_mask;
 200
 201    /**
 202     * Buffer formats.  The formats are always set even when the buffer is
 203     * not available.
 204     */
 205    enum pipe_format color_format;
 206    enum pipe_format depth_stencil_format;
 207    enum pipe_format accum_format;
 208    unsigned samples;
 209
 210    /**
 211     * Desired render buffer.
 212     */
 213    enum st_attachment_type render_buffer;
 214 };
 215
 216
 217 /**
 218  * Configuration options from driconf
 219  */
 220 struct st_config_options
 221 {
 222    bool disable_blend_func_extended;
 223    bool disable_glsl_line_continuations;
 224    bool disable_arb_gpu_shader5;
 225    bool force_glsl_extensions_warn;
 226    unsigned force_glsl_version;
 227    bool allow_glsl_extension_directive_midshader;
 228    bool allow_glsl_builtin_const_expression;
 229    bool allow_glsl_relaxed_es;
 230    bool allow_glsl_builtin_variable_redeclaration;
 231    bool allow_higher_compat_version;
 232    bool glsl_zero_init;
 233    bool vs_position_always_invariant;
 234    bool force_glsl_abs_sqrt;
 235    bool allow_glsl_cross_stage_interpolation_mismatch;
 236    bool allow_glsl_layout_qualifier_on_function_parameters;
 237    bool allow_draw_out_of_order;
 238    bool force_integer_tex_nearest;
 239    char *force_gl_vendor;
 240    unsigned char config_options_sha1[20];
 241 };
 242
 243 /**
 244  * Represent the attributes of a context.
 245  */
 246 struct st_context_attribs
 247 {
 248    /**
 249     * The profile and minimal version to support.
 250     *
 251     * The valid profiles and versions are rendering API dependent.  The latest
 252     * version satisfying the request should be returned.
 253     */
 254    enum st_profile_type profile;
 255    int major, minor;
 256
 257    /** Mask of ST_CONTEXT_FLAG_x bits */
 258    unsigned flags;
 259
 260    /**
 261     * The visual of the framebuffers the context will be bound to.
 262     */
 263    struct st_visual visual;
 264
 265    /**
 266     * Configuration options.
 267     */
 268    struct st_config_options options;
 269 };
 270
 271 struct st_context_iface;
 272 struct st_manager;
 273
 274 /**
 275  * Represent a windowing system drawable.
 276  *
 277  * The framebuffer is implemented by the state tracker manager and
 278  * used by the state trackers.
 279  *
 280  * Instead of the winsys poking into the API context to figure
 281  * out what buffers that might be needed in the future by the API
 282  * context, it calls into the framebuffer to get the textures.
 283  *
 284  * This structure along with the notify_invalid_framebuffer
 285  * allows framebuffers to be shared between different threads
 286  * but at the same make the API context free from thread
 287  * synchronization primitves, with the exception of a small
 288  * atomic flag used for notification of framebuffer dirty status.
 289  *
 290  * The thread synchronization is put inside the framebuffer
 291  * and only called once the framebuffer has become dirty.
 292  */
 293 struct st_framebuffer_iface
 294 {
 295    /**
 296     * Atomic stamp which changes when framebuffers need to be updated.
 297     */
 298    int32_t stamp;
 299
 300    /**
 301     * Identifier that uniquely identifies the framebuffer interface object.
 302     */
 303    uint32_t ID;
 304
 305    /**
 306     * The state tracker manager that manages this object.
 307     */
 308    struct st_manager *state_manager;
 309
 310    /**
 311     * Available for the state tracker manager to use.
 312     */
 313    void *st_manager_private;
 314
 315    /**
 316     * The visual of a framebuffer.
 317     */
 318    const struct st_visual *visual;
 319
 320    /**
 321     * Flush the front buffer.
 322     *
 323     * On some window systems, changes to the front buffers are not immediately
 324     * visible.  They need to be flushed.
 325     *
 326     * @att is one of the front buffer attachments.
 327     */
 328    bool (*flush_front)(struct st_context_iface *stctx,
 329                        struct st_framebuffer_iface *stfbi,
 330                        enum st_attachment_type statt);
 331
 332    /**
 333     * The state tracker asks for the textures it needs.
 334     *
 335     * It should try to only ask for attachments that it currently renders
 336     * to, thus allowing the winsys to delay the allocation of textures not
 337     * needed. For example front buffer attachments are not needed if you
 338     * only do back buffer rendering.
 339     *
 340     * The implementor of this function needs to also ensure
 341     * thread safty as this call might be done from multiple threads.
 342     *
 343     * The returned textures are owned by the caller.  They should be
 344     * unreferenced when no longer used.  If this function is called multiple
 345     * times with different sets of attachments, those buffers not included in
 346     * the last call might be destroyed.  This behavior might change in the
 347     * future.
 348     */
 349    bool (*validate)(struct st_context_iface *stctx,
 350                     struct st_framebuffer_iface *stfbi,
 351                     const enum st_attachment_type *statts,
 352                     unsigned count,
 353                     struct pipe_resource **out);
 354    bool (*flush_swapbuffers) (struct st_context_iface *stctx,
 355                               struct st_framebuffer_iface *stfbi);
 356 };
 357
 358 /**
 359  * Represent a rendering context.
 360  *
 361  * This entity is created from st_api and used by the state tracker manager.
 362  */
 363 struct st_context_iface
 364 {
 365    /**
 366     * Available for the state tracker and the manager to use.
 367     */
 368    void *st_context_private;
 369    void *st_manager_private;
 370
 371    /**
 372     * The state tracker manager that manages this object.
 373     */
 374    struct st_manager *state_manager;
 375
 376    /**
 377     * The CSO context associated with this context in case we need to draw
 378     * something before swap buffers.
 379     */
 380    struct cso_context *cso_context;
 381
 382    /**
 383     * The gallium context.
 384     */
 385    struct pipe_context *pipe;
 386
 387    /**
 388     * Destroy the context.
 389     */
 390    void (*destroy)(struct st_context_iface *stctxi);
 391
 392    /**
 393     * Flush all drawing from context to the pipe also flushes the pipe.
 394     */
 395    void (*flush)(struct st_context_iface *stctxi, unsigned flags,
 396                  struct pipe_fence_handle **fence,
 397                  void (*notify_before_flush_cb) (void*),
 398                  void* notify_before_flush_cb_args);
 399
 400    /**
 401     * Replace the texture image of a texture object at the specified level.
 402     *
 403     * This function is optional.
 404     */
 405    bool (*teximage)(struct st_context_iface *stctxi,
 406                     enum st_texture_type target,
 407                     int level, enum pipe_format internal_format,
 408                     struct pipe_resource *tex, bool mipmap);
 409
 410    /**
 411     * Used to implement glXCopyContext.
 412     */
 413    void (*copy)(struct st_context_iface *stctxi,
 414                 struct st_context_iface *stsrci, unsigned mask);
 415
 416    /**
 417     * Used to implement wglShareLists.
 418     */
 419    bool (*share)(struct st_context_iface *stctxi,
 420                  struct st_context_iface *stsrci);
 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    bool (*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                                   struct util_queue_monitoring *queue_info);
 478
 479    /**
 480     * Destroy any private data used by the state tracker manager.
 481     */
 482    void (*destroy)(struct st_manager *smapi);
 483
 484    /**
 485     * Available for the state tracker manager to use.
 486     */
 487    void *st_manager_private;
 488 };
 489
 490 /**
 491  * Represent a rendering API such as OpenGL or OpenVG.
 492  *
 493  * Implemented by the state tracker and used by the state tracker manager.
 494  */
 495 struct st_api
 496 {
 497    /**
 498     * The name of the rendering API.  This is informative.
 499     */
 500    const char *name;
 501
 502    /**
 503     * The supported rendering API.
 504     */
 505    enum st_api_type api;
 506
 507    /**
 508     * The supported profiles.  Tested with ST_PROFILE_*_MASK.
 509     */
 510    unsigned profile_mask;
 511
 512    /**
 513     * The supported optional features.  Tested with ST_FEATURE_*_MASK.
 514     */
 515    unsigned feature_mask;
 516
 517    /**
 518     * Destroy the API.
 519     */
 520    void (*destroy)(struct st_api *stapi);
 521
 522    /**
 523     * Query supported OpenGL versions. (if applicable)
 524     * The format is (major*10+minor).
 525     */
 526    void (*query_versions)(struct st_api *stapi, struct st_manager *sm,
 527                           struct st_config_options *options,
 528                           int *gl_core_version,
 529                           int *gl_compat_version,
 530                           int *gl_es1_version,
 531                           int *gl_es2_version);
 532
 533    /**
 534     * Create a rendering context.
 535     */
 536    struct st_context_iface *(*create_context)(struct st_api *stapi,
 537                                               struct st_manager *smapi,
 538                                               const struct st_context_attribs *attribs,
 539                                               enum st_context_error *error,
 540                                               struct st_context_iface *stsharei);
 541
 542    /**
 543     * Bind the context to the calling thread with draw and read as drawables.
 544     *
 545     * The framebuffers might be NULL, or might have different visuals than the
 546     * context does.
 547     */
 548    bool (*make_current)(struct st_api *stapi,
 549                         struct st_context_iface *stctxi,
 550                         struct st_framebuffer_iface *stdrawi,
 551                         struct st_framebuffer_iface *streadi);
 552
 553    /**
 554     * Get the currently bound context in the calling thread.
 555     */
 556    struct st_context_iface *(*get_current)(struct st_api *stapi);
 557
 558    /**
 559     * Notify the st manager the framebuffer interface object
 560     * is no longer valid.
 561     */
 562    void (*destroy_drawable)(struct st_api *stapi,
 563                             struct st_framebuffer_iface *stfbi);
 564 };
 565
 566 /**
 567  * Return true if the visual has the specified buffers.
 568  */
 569 static inline bool
 570 st_visual_have_buffers(const struct st_visual *visual, unsigned mask)
 571 {
 572    return ((visual->buffer_mask & mask) == mask);
 573 }
 574
 575 #endif /* _API_H_ */