src/gallium/auxiliary/vl/vl_compositor.h

   1 /**************************************************************************
   2  *
   3  * Copyright 2009 Younes Manton.
   4  * All Rights Reserved.
   5  *
   6  * Permission is hereby granted, free of charge, to any person obtaining a
   7  * copy of this software and associated documentation files (the
   8  * "Software"), to deal in the Software without restriction, including
   9  * without limitation the rights to use, copy, modify, merge, publish,
  10  * distribute, sub license, and/or sell copies of the Software, and to
  11  * permit persons to whom the Software is furnished to do so, subject to
  12  * the following conditions:
  13  *
  14  * The above copyright notice and this permission notice (including the
  15  * next paragraph) shall be included in all copies or substantial portions
  16  * of the Software.
  17  *
  18  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
  19  * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
  20  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT.
  21  * IN NO EVENT SHALL VMWARE AND/OR ITS SUPPLIERS BE LIABLE FOR
  22  * ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
  23  * TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
  24  * SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  25  *
  26  **************************************************************************/
  27
  28 #ifndef vl_compositor_h
  29 #define vl_compositor_h
  30
  31 #include "pipe/p_state.h"
  32 #include "pipe/p_video_codec.h"
  33 #include "pipe/p_video_state.h"
  34
  35 #include "util/u_rect.h"
  36
  37 #include "vl_types.h"
  38 #include "vl_csc.h"
  39
  40 struct pipe_context;
  41
  42 /**
  43  * composing and displaying of image data
  44  */
  45
  46 #define VL_COMPOSITOR_MAX_LAYERS 16
  47
  48 /* deinterlace allgorithem */
  49 enum vl_compositor_deinterlace
  50 {
  51    VL_COMPOSITOR_WEAVE,
  52    VL_COMPOSITOR_BOB_TOP,
  53    VL_COMPOSITOR_BOB_BOTTOM
  54 };
  55
  56 /* clockwise degree */
  57 enum vl_compositor_rotation
  58 {
  59    VL_COMPOSITOR_ROTATE_0,
  60    VL_COMPOSITOR_ROTATE_90,
  61    VL_COMPOSITOR_ROTATE_180,
  62    VL_COMPOSITOR_ROTATE_270
  63 };
  64
  65 struct vl_compositor_layer
  66 {
  67    bool clearing;
  68
  69    bool viewport_valid;
  70    struct pipe_viewport_state viewport;
  71
  72    void *fs;
  73    void *samplers[3];
  74    void *blend;
  75
  76    struct pipe_sampler_view *sampler_views[3];
  77    struct {
  78       struct vertex2f tl, br;
  79    } src, dst;
  80    struct vertex2f zw;
  81    struct vertex4f colors[4];
  82    enum vl_compositor_rotation rotate;
  83 };
  84
  85 struct vl_compositor_state
  86 {
  87    struct pipe_context *pipe;
  88
  89    bool scissor_valid;
  90    struct pipe_scissor_state scissor;
  91    struct pipe_resource *csc_matrix;
  92
  93    union pipe_color_union clear_color;
  94
  95    unsigned used_layers:VL_COMPOSITOR_MAX_LAYERS;
  96    struct vl_compositor_layer layers[VL_COMPOSITOR_MAX_LAYERS];
  97 };
  98
  99 struct vl_compositor
 100 {
 101    struct pipe_context *pipe;
 102    struct u_upload_mgr *upload;
 103
 104    struct pipe_framebuffer_state fb_state;
 105    struct pipe_vertex_buffer vertex_buf;
 106
 107    void *sampler_linear;
 108    void *sampler_nearest;
 109    void *blend_clear, *blend_add;
 110    void *rast;
 111    void *dsa;
 112    void *vertex_elems_state;
 113
 114    void *vs;
 115    void *fs_video_buffer;
 116    void *fs_weave;
 117    void *fs_rgba;
 118
 119    struct {
 120       void *rgb;
 121       void *yuv;
 122    } fs_palette;
 123 };
 124
 125 /**
 126  * initialize this compositor
 127  */
 128 bool
 129 vl_compositor_init(struct vl_compositor *compositor, struct pipe_context *pipe);
 130
 131 /**
 132  * init state bag
 133  */
 134 bool
 135 vl_compositor_init_state(struct vl_compositor_state *state, struct pipe_context *pipe);
 136
 137 /**
 138  * set yuv -> rgba conversion matrix
 139  */
 140 void
 141 vl_compositor_set_csc_matrix(struct vl_compositor_state *settings, const vl_csc_matrix *matrix);
 142
 143 /**
 144  * reset dirty area, so it's cleared with the clear colour
 145  */
 146 void
 147 vl_compositor_reset_dirty_area(struct u_rect *dirty);
 148
 149 /**
 150  * set the clear color
 151  */
 152 void
 153 vl_compositor_set_clear_color(struct vl_compositor_state *settings, union pipe_color_union *color);
 154
 155 /**
 156  * get the clear color
 157  */
 158 void
 159 vl_compositor_get_clear_color(struct vl_compositor_state *settings, union pipe_color_union *color);
 160
 161 /**
 162  * set the destination clipping
 163  */
 164 void
 165 vl_compositor_set_dst_clip(struct vl_compositor_state *settings, struct u_rect *dst_clip);
 166
 167 /**
 168  * set overlay samplers
 169  */
 170 /*@{*/
 171
 172 /**
 173  * reset all currently set layers
 174  */
 175 void
 176 vl_compositor_clear_layers(struct vl_compositor_state *state);
 177
 178 /**
 179  * set the blender used to render a layer
 180  */
 181 void
 182 vl_compositor_set_layer_blend(struct vl_compositor_state *state,
 183                               unsigned layer, void *blend, bool is_clearing);
 184
 185 /**
 186  * set the layer destination area
 187  */
 188 void
 189 vl_compositor_set_layer_dst_area(struct vl_compositor_state *settings,
 190                                  unsigned layer, struct u_rect *dst_area);
 191
 192 /**
 193  * set a video buffer as a layer to render
 194  */
 195 void
 196 vl_compositor_set_buffer_layer(struct vl_compositor_state *state,
 197                                struct vl_compositor *compositor,
 198                                unsigned layer,
 199                                struct pipe_video_buffer *buffer,
 200                                struct u_rect *src_rect,
 201                                struct u_rect *dst_rect,
 202                                enum vl_compositor_deinterlace deinterlace);
 203
 204 /**
 205  * set a paletted sampler as a layer to render
 206  */
 207 void
 208 vl_compositor_set_palette_layer(struct vl_compositor_state *state,
 209                                 struct vl_compositor *compositor,
 210                                 unsigned layer,
 211                                 struct pipe_sampler_view *indexes,
 212                                 struct pipe_sampler_view *palette,
 213                                 struct u_rect *src_rect,
 214                                 struct u_rect *dst_rect,
 215                                 bool include_color_conversion);
 216
 217 /**
 218  * set a rgba sampler as a layer to render
 219  */
 220 void
 221 vl_compositor_set_rgba_layer(struct vl_compositor_state *state,
 222                              struct vl_compositor *compositor,
 223                              unsigned layer,
 224                              struct pipe_sampler_view *rgba,
 225                              struct u_rect *src_rect,
 226                              struct u_rect *dst_rect,
 227                              struct vertex4f *colors);
 228
 229 /**
 230  * set the layer rotation
 231  */
 232 void
 233 vl_compositor_set_layer_rotation(struct vl_compositor_state *state,
 234                                  unsigned layer,
 235                                  enum vl_compositor_rotation rotate);
 236
 237 /*@}*/
 238
 239 /**
 240  * render the layers to the frontbuffer
 241  */
 242 void
 243 vl_compositor_render(struct vl_compositor_state *state,
 244                      struct vl_compositor       *compositor,
 245                      struct pipe_surface        *dst_surface,
 246                      struct u_rect              *dirty_area,
 247                      bool                        clear_dirty);
 248
 249 /**
 250  * destroy this compositor
 251  */
 252 void
 253 vl_compositor_cleanup(struct vl_compositor *compositor);
 254
 255 /**
 256  * destroy this state bag
 257  */
 258 void
 259 vl_compositor_cleanup_state(struct vl_compositor_state *state);
 260
 261 #endif /* vl_compositor_h */