g3dvl: extend the functionality of the compositor
[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 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 "vl_types.h"
36
37 struct pipe_context;
38
39 /**
40 * composing and displaying of image data
41 */
42
43 #define VL_COMPOSITOR_MAX_LAYERS 16
44
45 struct vl_compositor_layer
46 {
47 bool clearing;
48
49 void *fs;
50 void *samplers[3];
51 void *blend;
52
53 struct pipe_sampler_view *sampler_views[3];
54 struct {
55 struct vertex2f tl, br;
56 } src, dst;
57 };
58
59 struct vl_compositor
60 {
61 struct pipe_context *pipe;
62
63 struct pipe_framebuffer_state fb_state;
64 struct pipe_viewport_state viewport;
65 struct pipe_vertex_buffer vertex_buf;
66 struct pipe_resource *csc_matrix;
67
68 void *sampler_linear;
69 void *sampler_nearest;
70 void *blend_clear, *blend_add;
71 void *rast;
72 void *dsa;
73 void *vertex_elems_state;
74
75 void *vs;
76 void *fs_video_buffer;
77 void *fs_rgba;
78
79 struct {
80 void *rgb;
81 void *yuv;
82 } fs_palette;
83
84 float clear_color[4];
85 struct vertex2f dirty_tl, dirty_br;
86
87 unsigned used_layers:VL_COMPOSITOR_MAX_LAYERS;
88 struct vl_compositor_layer layers[VL_COMPOSITOR_MAX_LAYERS];
89 };
90
91 /**
92 * initialize this compositor
93 */
94 bool
95 vl_compositor_init(struct vl_compositor *compositor, struct pipe_context *pipe);
96
97 /**
98 * set yuv -> rgba conversion matrix
99 */
100 void
101 vl_compositor_set_csc_matrix(struct vl_compositor *compositor, const float mat[16]);
102
103 /**
104 * reset dirty area, so it's cleared with the clear colour
105 */
106 void
107 vl_compositor_reset_dirty_area(struct vl_compositor *compositor);
108
109 /**
110 * set the clear color
111 */
112 void
113 vl_compositor_set_clear_color(struct vl_compositor *compositor, float color[4]);
114
115 /**
116 * set overlay samplers
117 */
118 /*@{*/
119
120 /**
121 * reset all currently set layers
122 */
123 void
124 vl_compositor_clear_layers(struct vl_compositor *compositor);
125
126 /**
127 * set the blender used to render a layer
128 */
129 void
130 vl_compositor_set_layer_blend(struct vl_compositor *compositor,
131 unsigned layer, void *blend, bool is_clearing);
132
133 /**
134 * set a video buffer as a layer to render
135 */
136 void
137 vl_compositor_set_buffer_layer(struct vl_compositor *compositor,
138 unsigned layer,
139 struct pipe_video_buffer *buffer,
140 struct pipe_video_rect *src_rect,
141 struct pipe_video_rect *dst_rect);
142
143 /**
144 * set a paletted sampler as a layer to render
145 */
146 void
147 vl_compositor_set_palette_layer(struct vl_compositor *compositor,
148 unsigned layer,
149 struct pipe_sampler_view *indexes,
150 struct pipe_sampler_view *palette,
151 struct pipe_video_rect *src_rect,
152 struct pipe_video_rect *dst_rect,
153 bool include_color_conversion);
154
155 /**
156 * set a rgba sampler as a layer to render
157 */
158 void
159 vl_compositor_set_rgba_layer(struct vl_compositor *compositor,
160 unsigned layer,
161 struct pipe_sampler_view *rgba,
162 struct pipe_video_rect *src_rect,
163 struct pipe_video_rect *dst_rect);
164
165 /*@}*/
166
167 /**
168 * render the layers to the frontbuffer
169 */
170 void
171 vl_compositor_render(struct vl_compositor *compositor,
172 struct pipe_surface *dst_surface,
173 struct pipe_video_rect *dst_area,
174 struct pipe_video_rect *dst_clip,
175 bool clear_dirty_area);
176
177 /**
178 * destroy this compositor
179 */
180 void
181 vl_compositor_cleanup(struct vl_compositor *compositor);
182
183 #endif /* vl_compositor_h */