vl_compositor.h revision b90727bb241e4a04158d34aad078cb18e478fea7 
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 TUNGSTEN GRAPHICS 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_decoder.h"
33#include "pipe/p_video_state.h"
34
35#include "util/u_rect.h"
36
37#include "vl_types.h"
38
39struct pipe_context;
40
41/**
42 * composing and displaying of image data
43 */
44
45#define VL_COMPOSITOR_MAX_LAYERS 16
46
47/* deinterlace allgorithem */
48enum vl_compositor_deinterlace
49{
50   VL_COMPOSITOR_WEAVE,
51   VL_COMPOSITOR_BOB_TOP,
52   VL_COMPOSITOR_BOB_BOTTOM
53};
54
55struct vl_compositor_layer
56{
57   bool clearing;
58
59   void *fs;
60   void *samplers[3];
61   void *blend;
62
63   struct pipe_sampler_view *sampler_views[3];
64   struct {
65      struct vertex2f tl, br;
66   } src, dst;
67   struct vertex2f zw;
68   struct vertex4f colors[4];
69};
70
71struct vl_compositor_state
72{
73   struct pipe_context *pipe;
74
75   bool viewport_valid, scissor_valid;
76   struct pipe_viewport_state viewport;
77   struct pipe_scissor_state scissor;
78   struct pipe_resource *csc_matrix;
79
80   union pipe_color_union clear_color;
81
82   unsigned used_layers:VL_COMPOSITOR_MAX_LAYERS;
83   struct vl_compositor_layer layers[VL_COMPOSITOR_MAX_LAYERS];
84};
85
86struct vl_compositor
87{
88   struct pipe_context *pipe;
89
90   struct pipe_framebuffer_state fb_state;
91   struct pipe_vertex_buffer vertex_buf;
92
93   void *sampler_linear;
94   void *sampler_nearest;
95   void *blend_clear, *blend_add;
96   void *rast;
97   void *dsa;
98   void *vertex_elems_state;
99
100   void *vs;
101   void *fs_video_buffer;
102   void *fs_weave;
103   void *fs_rgba;
104
105   struct {
106      void *rgb;
107      void *yuv;
108   } fs_palette;
109};
110
111/**
112 * initialize this compositor
113 */
114bool
115vl_compositor_init(struct vl_compositor *compositor, struct pipe_context *pipe);
116
117/**
118 * init state bag
119 */
120bool
121vl_compositor_init_state(struct vl_compositor_state *state, struct pipe_context *pipe);
122
123/**
124 * set yuv -> rgba conversion matrix
125 */
126void
127vl_compositor_set_csc_matrix(struct vl_compositor_state *settings, const float mat[16]);
128
129/**
130 * reset dirty area, so it's cleared with the clear colour
131 */
132void
133vl_compositor_reset_dirty_area(struct u_rect *dirty);
134
135/**
136 * set the clear color
137 */
138void
139vl_compositor_set_clear_color(struct vl_compositor_state *settings, union pipe_color_union *color);
140
141/**
142 * get the clear color
143 */
144void
145vl_compositor_get_clear_color(struct vl_compositor_state *settings, union pipe_color_union *color);
146
147/**
148 * set the destination area
149 */
150void
151vl_compositor_set_dst_area(struct vl_compositor_state *settings, struct u_rect *dst_area);
152
153/**
154 * set the destination clipping
155 */
156void
157vl_compositor_set_dst_clip(struct vl_compositor_state *settings, struct u_rect *dst_clip);
158
159/**
160 * set overlay samplers
161 */
162/*@{*/
163
164/**
165 * reset all currently set layers
166 */
167void
168vl_compositor_clear_layers(struct vl_compositor_state *state);
169
170/**
171 * set the blender used to render a layer
172 */
173void
174vl_compositor_set_layer_blend(struct vl_compositor_state *state,
175                              unsigned layer, void *blend, bool is_clearing);
176
177/**
178 * set a video buffer as a layer to render
179 */
180void
181vl_compositor_set_buffer_layer(struct vl_compositor_state *state,
182                               struct vl_compositor *compositor,
183                               unsigned layer,
184                               struct pipe_video_buffer *buffer,
185                               struct u_rect *src_rect,
186                               struct u_rect *dst_rect,
187                               enum vl_compositor_deinterlace deinterlace);
188
189/**
190 * set a paletted sampler as a layer to render
191 */
192void
193vl_compositor_set_palette_layer(struct vl_compositor_state *state,
194                                struct vl_compositor *compositor,
195                                unsigned layer,
196                                struct pipe_sampler_view *indexes,
197                                struct pipe_sampler_view *palette,
198                                struct u_rect *src_rect,
199                                struct u_rect *dst_rect,
200                                bool include_color_conversion);
201
202/**
203 * set a rgba sampler as a layer to render
204 */
205void
206vl_compositor_set_rgba_layer(struct vl_compositor_state *state,
207                             struct vl_compositor *compositor,
208                             unsigned layer,
209                             struct pipe_sampler_view *rgba,
210                             struct u_rect *src_rect,
211                             struct u_rect *dst_rect,
212                             struct vertex4f *colors);
213
214/*@}*/
215
216/**
217 * render the layers to the frontbuffer
218 */
219void
220vl_compositor_render(struct vl_compositor_state *state,
221                     struct vl_compositor       *compositor,
222                     struct pipe_surface        *dst_surface,
223                     struct u_rect              *dirty_area);
224
225/**
226 * destroy this compositor
227 */
228void
229vl_compositor_cleanup(struct vl_compositor *compositor);
230
231/**
232 * destroy this state bag
233 */
234void
235vl_compositor_cleanup_state(struct vl_compositor_state *state);
236
237#endif /* vl_compositor_h */
238