cbad60a7031cd9aeb4a7c741d046efe17103c23d
[mesa.git] / 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
103 struct pipe_framebuffer_state fb_state;
104 struct pipe_vertex_buffer vertex_buf;
105
106 void *sampler_linear;
107 void *sampler_nearest;
108 void *blend_clear, *blend_add;
109 void *rast;
110 void *dsa;
111 void *vertex_elems_state;
112
113 void *vs;
114 void *fs_video_buffer;
115 void *fs_weave_rgb;
116 void *fs_rgba;
117
118 struct {
119 struct {
120 void *y;
121 void *uv;
122 } weave;
123 struct {
124 void *y;
125 void *uv;
126 } bob;
127 } fs_yuv;
128
129 struct {
130 void *rgb;
131 void *yuv;
132 } fs_palette;
133
134 struct {
135 void *y;
136 void *uv;
137 } fs_rgb_yuv;
138 };
139
140 /**
141 * initialize this compositor
142 */
143 bool
144 vl_compositor_init(struct vl_compositor *compositor, struct pipe_context *pipe);
145
146 /**
147 * init state bag
148 */
149 bool
150 vl_compositor_init_state(struct vl_compositor_state *state, struct pipe_context *pipe);
151
152 /**
153 * set yuv -> rgba conversion matrix
154 */
155 bool
156 vl_compositor_set_csc_matrix(struct vl_compositor_state *settings,
157 const vl_csc_matrix *matrix,
158 float luma_min, float luma_max);
159
160 /**
161 * reset dirty area, so it's cleared with the clear colour
162 */
163 void
164 vl_compositor_reset_dirty_area(struct u_rect *dirty);
165
166 /**
167 * set the clear color
168 */
169 void
170 vl_compositor_set_clear_color(struct vl_compositor_state *settings, union pipe_color_union *color);
171
172 /**
173 * get the clear color
174 */
175 void
176 vl_compositor_get_clear_color(struct vl_compositor_state *settings, union pipe_color_union *color);
177
178 /**
179 * set the destination clipping
180 */
181 void
182 vl_compositor_set_dst_clip(struct vl_compositor_state *settings, struct u_rect *dst_clip);
183
184 /**
185 * set overlay samplers
186 */
187 /*@{*/
188
189 /**
190 * reset all currently set layers
191 */
192 void
193 vl_compositor_clear_layers(struct vl_compositor_state *state);
194
195 /**
196 * set the blender used to render a layer
197 */
198 void
199 vl_compositor_set_layer_blend(struct vl_compositor_state *state,
200 unsigned layer, void *blend, bool is_clearing);
201
202 /**
203 * set the layer destination area
204 */
205 void
206 vl_compositor_set_layer_dst_area(struct vl_compositor_state *settings,
207 unsigned layer, struct u_rect *dst_area);
208
209 /**
210 * set a video buffer as a layer to render
211 */
212 void
213 vl_compositor_set_buffer_layer(struct vl_compositor_state *state,
214 struct vl_compositor *compositor,
215 unsigned layer,
216 struct pipe_video_buffer *buffer,
217 struct u_rect *src_rect,
218 struct u_rect *dst_rect,
219 enum vl_compositor_deinterlace deinterlace);
220
221 /**
222 * set a paletted sampler as a layer to render
223 */
224 void
225 vl_compositor_set_palette_layer(struct vl_compositor_state *state,
226 struct vl_compositor *compositor,
227 unsigned layer,
228 struct pipe_sampler_view *indexes,
229 struct pipe_sampler_view *palette,
230 struct u_rect *src_rect,
231 struct u_rect *dst_rect,
232 bool include_color_conversion);
233
234 /**
235 * set a rgba sampler as a layer to render
236 */
237 void
238 vl_compositor_set_rgba_layer(struct vl_compositor_state *state,
239 struct vl_compositor *compositor,
240 unsigned layer,
241 struct pipe_sampler_view *rgba,
242 struct u_rect *src_rect,
243 struct u_rect *dst_rect,
244 struct vertex4f *colors);
245
246 /**
247 * set the layer rotation
248 */
249 void
250 vl_compositor_set_layer_rotation(struct vl_compositor_state *state,
251 unsigned layer,
252 enum vl_compositor_rotation rotate);
253
254 /**
255 * deinterlace yuv buffer with full abilities
256 */
257 void
258 vl_compositor_yuv_deint_full(struct vl_compositor_state *state,
259 struct vl_compositor *compositor,
260 struct pipe_video_buffer *src,
261 struct pipe_video_buffer *dst,
262 struct u_rect *src_rect,
263 struct u_rect *dst_rect,
264 enum vl_compositor_deinterlace deinterlace);
265
266 /*@}*/
267
268 /**
269 * render the layers to the frontbuffer
270 */
271 void
272 vl_compositor_render(struct vl_compositor_state *state,
273 struct vl_compositor *compositor,
274 struct pipe_surface *dst_surface,
275 struct u_rect *dirty_area,
276 bool clear_dirty);
277
278 /**
279 * destroy this compositor
280 */
281 void
282 vl_compositor_cleanup(struct vl_compositor *compositor);
283
284 /**
285 * destroy this state bag
286 */
287 void
288 vl_compositor_cleanup_state(struct vl_compositor_state *state);
289
290 #endif /* vl_compositor_h */