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