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_OPENGL_ES1,
  51    ST_API_OPENGL_ES2,
  52    ST_API_OPENVG,
  53
  54    ST_API_COUNT
  55 };
  56
  57 /**
  58  * Used in st_context_iface->teximage.
  59  */
  60 enum st_texture_type {
  61    ST_TEXTURE_1D,
  62    ST_TEXTURE_2D,
  63    ST_TEXTURE_3D,
  64    ST_TEXTURE_RECT
  65 };
  66
  67 /**
  68  * Available attachments of framebuffer.
  69  */
  70 enum st_attachment_type {
  71    ST_ATTACHMENT_FRONT_LEFT,
  72    ST_ATTACHMENT_BACK_LEFT,
  73    ST_ATTACHMENT_FRONT_RIGHT,
  74    ST_ATTACHMENT_BACK_RIGHT,
  75    ST_ATTACHMENT_DEPTH_STENCIL,
  76    ST_ATTACHMENT_ACCUM,
  77    ST_ATTACHMENT_SAMPLE,
  78
  79    ST_ATTACHMENT_COUNT,
  80    ST_ATTACHMENT_INVALID = -1
  81 };
  82
  83 /* for buffer_mask in st_visual */
  84 #define ST_ATTACHMENT_FRONT_LEFT_MASK     (1 << ST_ATTACHMENT_FRONT_LEFT)
  85 #define ST_ATTACHMENT_BACK_LEFT_MASK      (1 << ST_ATTACHMENT_BACK_LEFT)
  86 #define ST_ATTACHMENT_FRONT_RIGHT_MASK    (1 << ST_ATTACHMENT_FRONT_RIGHT)
  87 #define ST_ATTACHMENT_BACK_RIGHT_MASK     (1 << ST_ATTACHMENT_BACK_RIGHT)
  88 #define ST_ATTACHMENT_DEPTH_STENCIL_MASK  (1 << ST_ATTACHMENT_DEPTH_STENCIL)
  89 #define ST_ATTACHMENT_ACCUM_MASK          (1 << ST_ATTACHMENT_ACCUM)
  90 #define ST_ATTACHMENT_SAMPLE_MASK         (1 << ST_ATTACHMENT_SAMPLE)
  91
  92 /**
  93  * Enumerations of state tracker context resources.
  94  */
  95 enum st_context_resource_type {
  96    ST_CONTEXT_RESOURCE_OPENGL_TEXTURE_2D,
  97    ST_CONTEXT_RESOURCE_OPENGL_TEXTURE_3D,
  98    ST_CONTEXT_RESOURCE_OPENGL_TEXTURE_CUBE_MAP_POSITIVE_X,
  99    ST_CONTEXT_RESOURCE_OPENGL_TEXTURE_CUBE_MAP_NEGATIVE_X,
 100    ST_CONTEXT_RESOURCE_OPENGL_TEXTURE_CUBE_MAP_POSITIVE_Y,
 101    ST_CONTEXT_RESOURCE_OPENGL_TEXTURE_CUBE_MAP_NEGATIVE_Y,
 102    ST_CONTEXT_RESOURCE_OPENGL_TEXTURE_CUBE_MAP_POSITIVE_Z,
 103    ST_CONTEXT_RESOURCE_OPENGL_TEXTURE_CUBE_MAP_NEGATIVE_Z,
 104    ST_CONTEXT_RESOURCE_OPENGL_RENDERBUFFER,
 105    ST_CONTEXT_RESOURCE_OPENVG_PARENT_IMAGE
 106 };
 107
 108 /**
 109  * Value to st_manager->get_param function.
 110  */
 111 enum st_manager_param {
 112    /**
 113     * The dri state tracker on old libGL's doesn't do the right thing
 114     * with regards to invalidating the framebuffers.
 115     *
 116     * For the mesa state tracker that means that it needs to invalidate
 117     * the framebuffer in glViewport itself.
 118     */
 119    ST_MANAGER_BROKEN_INVALIDATE
 120 };
 121
 122 /**
 123  * The return type of st_api->get_proc_address.
 124  */
 125 typedef void (*st_proc_t)(void);
 126
 127 struct pipe_context;
 128 struct pipe_resource;
 129 struct pipe_fence_handle;
 130
 131 /**
 132  * Used in st_context_iface->get_resource_for_egl_image.
 133  */
 134 struct st_context_resource
 135 {
 136    /* these fields are filled by the caller */
 137    enum st_context_resource_type type;
 138    void *resource;
 139
 140    /* this is owned by the caller */
 141    struct pipe_resource *texture;
 142 };
 143
 144 /**
 145  * Used in st_manager_iface->get_egl_image.
 146  */
 147 struct st_egl_image
 148 {
 149    /* these fields are filled by the caller */
 150    struct st_context_iface *stctxi;
 151    void *egl_image;
 152
 153    /* this is owned by the caller */
 154    struct pipe_resource *texture;
 155
 156    unsigned face;
 157    unsigned level;
 158    unsigned zslice;
 159 };
 160
 161 /**
 162  * Represent the visual of a framebuffer.
 163  */
 164 struct st_visual
 165 {
 166    /**
 167     * Available buffers.  Tested with ST_FRAMEBUFFER_*_MASK.
 168     */
 169    unsigned buffer_mask;
 170
 171    /**
 172     * Buffer formats.  The formats are always set even when the buffer is
 173     * not available.
 174     */
 175    enum pipe_format color_format;
 176    enum pipe_format depth_stencil_format;
 177    enum pipe_format accum_format;
 178    int samples;
 179
 180    /**
 181     * Desired render buffer.
 182     */
 183    enum st_attachment_type render_buffer;
 184 };
 185
 186 /**
 187  * Represent a windowing system drawable.
 188  *
 189  * The framebuffer is implemented by the state tracker manager and
 190  * used by the state trackers.
 191  *
 192  * Instead of the winsys pokeing into the API context to figure
 193  * out what buffers that might be needed in the future by the API
 194  * context, it calls into the framebuffer to get the textures.
 195  *
 196  * This structure along with the notify_invalid_framebuffer
 197  * allows framebuffers to be shared between different threads
 198  * but at the same make the API context free from thread
 199  * syncronisation primitves, with the exception of a small
 200  * atomic flag used for notification of framebuffer dirty status.
 201  *
 202  * The thread syncronisation is put inside the framebuffer
 203  * and only called once the framebuffer has become dirty.
 204  */
 205 struct st_framebuffer_iface
 206 {
 207    /**
 208     * Available for the state tracker manager to use.
 209     */
 210    void *st_manager_private;
 211
 212    /**
 213     * The visual of a framebuffer.
 214     */
 215    const struct st_visual *visual;
 216
 217    /**
 218     * Flush the front buffer.
 219     *
 220     * On some window systems, changes to the front buffers are not immediately
 221     * visible.  They need to be flushed.
 222     *
 223     * @att is one of the front buffer attachments.
 224     */
 225    boolean (*flush_front)(struct st_framebuffer_iface *stfbi,
 226                           enum st_attachment_type statt);
 227
 228    /**
 229     * The state tracker asks for the textures it needs.
 230     *
 231     * It should try to only ask for attachments that it currently renders
 232     * to, thus allowing the winsys to delay the allocation of textures not
 233     * needed. For example front buffer attachments are not needed if you
 234     * only do back buffer rendering.
 235     *
 236     * The implementor of this function needs to also ensure
 237     * thread safty as this call might be done from multiple threads.
 238     *
 239     * The returned textures are owned by the caller.  They should be
 240     * unreferenced when no longer used.  If this function is called multiple
 241     * times with different sets of attachments, those buffers not included in
 242     * the last call might be destroyed.  This behavior might change in the
 243     * future.
 244     */
 245    boolean (*validate)(struct st_framebuffer_iface *stfbi,
 246                        const enum st_attachment_type *statts,
 247                        unsigned count,
 248                        struct pipe_resource **out);
 249 };
 250
 251 /**
 252  * Represent a rendering context.
 253  *
 254  * This entity is created from st_api and used by the state tracker manager.
 255  */
 256 struct st_context_iface
 257 {
 258    /**
 259     * Available for the state tracker and the manager to use.
 260     */
 261    void *st_context_private;
 262    void *st_manager_private;
 263
 264    /**
 265     * Destroy the context.
 266     */
 267    void (*destroy)(struct st_context_iface *stctxi);
 268
 269    /**
 270     * Invalidate the current textures that was taken from a framebuffer.
 271     *
 272     * The state tracker manager calls this function to let the rendering
 273     * context know that it should update the textures it got from
 274     * st_framebuffer_iface::validate.  It should do so at the latest time possible.
 275     * Possible right before sending triangles to the pipe context.
 276     *
 277     * For certain platforms this function might be called from a thread other
 278     * than the thread that the context is currently bound in, and must
 279     * therefore be thread safe. But it is the state tracker manager's
 280     * responsibility to make sure that the framebuffer is bound to the context
 281     * and the API context is current for the duration of this call.
 282     *
 283     * Thus reducing the sync primitive needed to a single atomic flag.
 284     */
 285    void (*notify_invalid_framebuffer)(struct st_context_iface *stctxi,
 286                                       struct st_framebuffer_iface *stfbi);
 287
 288    /**
 289     * Flush all drawing from context to the pipe also flushes the pipe.
 290     */
 291    void (*flush)(struct st_context_iface *stctxi, unsigned flags,
 292                  struct pipe_fence_handle **fence);
 293
 294    /**
 295     * Replace the texture image of a texture object at the specified level.
 296     *
 297     * This function is optional.
 298     */
 299    boolean (*teximage)(struct st_context_iface *stctxi, enum st_texture_type target,
 300                        int level, enum pipe_format internal_format,
 301                        struct pipe_resource *tex, boolean mipmap);
 302
 303    /**
 304     * Used to implement glXCopyContext.
 305     */
 306    void (*copy)(struct st_context_iface *stctxi,
 307                 struct st_context_iface *stsrci, unsigned mask);
 308
 309    /**
 310     * Look up and return the info of a resource for EGLImage.
 311     *
 312     * This function is optional.
 313     */
 314    boolean (*get_resource_for_egl_image)(struct st_context_iface *stctxi,
 315                                          struct st_context_resource *stres);
 316 };
 317
 318
 319 /**
 320  * Represent a state tracker manager.
 321  *
 322  * This interface is implemented by the state tracker manager.  It corresponds
 323  * to a "display" in the window system.
 324  */
 325 struct st_manager
 326 {
 327    struct pipe_screen *screen;
 328
 329    /**
 330     * Look up and return the info of an EGLImage.
 331     *
 332     * This function is optional.
 333     */
 334    boolean (*get_egl_image)(struct st_manager *smapi,
 335                             struct st_egl_image *stimg);
 336
 337    /**
 338     * Query an manager param.
 339     */
 340    int (*get_param)(struct st_manager *smapi,
 341                     enum st_manager_param param);
 342 };
 343
 344 /**
 345  * Represent a rendering API such as OpenGL or OpenVG.
 346  *
 347  * Implemented by the state tracker and used by the state tracker manager.
 348  */
 349 struct st_api
 350 {
 351    /**
 352     * Destroy the API.
 353     */
 354    void (*destroy)(struct st_api *stapi);
 355
 356    /**
 357     * Return an API entry point.
 358     *
 359     * For GL this is the same as _glapi_get_proc_address.
 360     */
 361    st_proc_t (*get_proc_address)(struct st_api *stapi, const char *procname);
 362
 363    /**
 364     * Return true if the visual is supported by the state tracker.
 365     */
 366    boolean (*is_visual_supported)(struct st_api *stapi,
 367                                   const struct st_visual *visual);
 368
 369    /**
 370     * Create a rendering context.
 371     */
 372    struct st_context_iface *(*create_context)(struct st_api *stapi,
 373                                               struct st_manager *smapi,
 374                                               const struct st_visual *visual,
 375                                               struct st_context_iface *stsharei);
 376
 377    /**
 378     * Bind the context to the calling thread with draw and read as drawables.
 379     *
 380     * The framebuffers might have different visuals than the context does.
 381     */
 382    boolean (*make_current)(struct st_api *stapi,
 383                            struct st_context_iface *stctxi,
 384                            struct st_framebuffer_iface *stdrawi,
 385                            struct st_framebuffer_iface *streadi);
 386
 387    /**
 388     * Get the currently bound context in the calling thread.
 389     */
 390    struct st_context_iface *(*get_current)(struct st_api *stapi);
 391 };
 392
 393 /**
 394  * Return true if the visual has the specified buffers.
 395  */
 396 static INLINE boolean
 397 st_visual_have_buffers(const struct st_visual *visual, unsigned mask)
 398 {
 399    return ((visual->buffer_mask & mask) == mask);
 400 }
 401
 402 /* these symbols may need to be dynamically lookup up */
 403 extern PUBLIC struct st_api * st_api_create_OpenGL(void);
 404 extern PUBLIC struct st_api * st_api_create_OpenGL_ES1(void);
 405 extern PUBLIC struct st_api * st_api_create_OpenGL_ES2(void);
 406 extern PUBLIC struct st_api * st_api_create_OpenVG(void);
 407
 408 /**
 409  * The entry points of the state trackers.
 410  */
 411 #define ST_CREATE_OPENGL_SYMBOL      "st_api_create_OpenGL"
 412 #define ST_CREATE_OPENGL_ES1_SYMBOL  "st_api_create_OpenGL_ES1"
 413 #define ST_CREATE_OPENGL_ES2_SYMBOL  "st_api_create_OpenGL_ES2"
 414 #define ST_CREATE_OPENVG_SYMBOL      "st_api_create_OpenVG"
 415
 416 #endif /* _ST_API_H_ */