1 /*****************************************************************************
2 * vout_display.c: "vout display" -> "video output" wrapper
3 *****************************************************************************
4 * Copyright (C) 2009 Laurent Aimar
7 * Authors: Laurent Aimar <fenrir _AT_ videolan _DOT_ org>
9 * This program is free software; you can redistribute it and/or modify
10 * it under the terms of the GNU General Public License as published by
11 * the Free Software Foundation; either version 2 of the License, or
12 * (at your option) any later version.
14 * This program is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 * GNU General Public License for more details.
19 * You should have received a copy of the GNU General Public License
20 * along with this program; if not, write to the Free Software
21 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
22 *****************************************************************************/
24 /*****************************************************************************
26 *****************************************************************************/
31 #include <vlc_common.h>
32 #include <vlc_plugin.h>
33 #include <vlc_vout_display.h>
34 #include <vlc_vout_wrapper.h>
36 #include "../video_filter/filter_common.h"
39 /*****************************************************************************
41 *****************************************************************************/
42 static int Open (vlc_object_t *, const char *module);
43 static void Close(vlc_object_t *);
45 #define DECLARE_OPEN(name) \
46 static int Open##name(vlc_object_t *object) { return Open(object, #name); }
51 DECLARE_OPEN(xcb_x11);
55 DECLARE_OPEN(directfb);
59 #define DECLARE_MODULE(name, priority) \
60 set_description( "Video display "#name" wrapper" ) \
61 set_shortname( "Video display "#name" wrapper" ) \
62 set_capability( "video output", priority ) \
63 set_callbacks( Open##name, Close ) \
67 set_category( CAT_VIDEO )
68 set_subcategory( SUBCAT_VIDEO_VOUT )
70 DECLARE_MODULE(aalib, 10)
73 DECLARE_MODULE(caca, 12)
76 DECLARE_MODULE(sdl, 60)
79 DECLARE_MODULE(xcb_x11, 75)
82 DECLARE_MODULE(xcb_xv, 155)
85 DECLARE_MODULE(dummy, 1)
88 DECLARE_MODULE(fb, 30)
91 DECLARE_MODULE(directfb, 60)
97 /*****************************************************************************
99 *****************************************************************************/
106 struct picture_sys_t {
110 /*****************************************************************************
112 *****************************************************************************/
113 static int Init (vout_thread_t *);
114 static void End (vout_thread_t *);
115 static int Manage (vout_thread_t *);
116 static void Render (vout_thread_t *, picture_t *);
117 static void Display(vout_thread_t *, picture_t *);
119 static void VoutGetDisplayCfg(vout_thread_t *,
120 vout_display_cfg_t *, const char *title);
122 /*****************************************************************************
124 *****************************************************************************/
125 static int Open(vlc_object_t *object, const char *module)
127 vout_thread_t *vout = (vout_thread_t *)object;
130 msg_Err(vout, "Opening vout display wrapper");
133 sys = malloc(sizeof(*sys));
137 sys->title = var_CreateGetNonEmptyString(vout, "video-title");
140 video_format_t source = vout->fmt_render;
141 source.i_visible_width = source.i_width;
142 source.i_visible_height = source.i_height;
143 source.i_x_offset = 0;
144 source.i_y_offset = 0;
146 vout_display_state_t state;
147 VoutGetDisplayCfg(vout, &state.cfg, sys->title);
148 state.is_on_top = var_CreateGetBool(vout, "video-on-top");
152 const mtime_t double_click_timeout = 300000;
153 const mtime_t hide_timeout = var_CreateGetInteger(vout, "mouse-hide-timeout") * 1000;
155 sys->vd = vout_NewDisplay(vout, &source, &state, module,
156 double_click_timeout, hide_timeout);
164 vout->pf_init = Init;
166 vout->pf_manage = Manage;
167 vout->pf_render = Render;
168 vout->pf_display = Display;
169 vout->pf_control = NULL;
175 /*****************************************************************************
177 *****************************************************************************/
178 static void Close(vlc_object_t *object)
180 vout_thread_t *vout = (vout_thread_t *)object;
181 vout_sys_t *sys = vout->p_sys;
184 vout_DeleteDisplay(sys->vd, NULL);
189 /*****************************************************************************
191 *****************************************************************************/
192 static int Init(vout_thread_t *vout)
194 vout_sys_t *sys = vout->p_sys;
195 vout_display_t *vd = sys->vd;
198 video_format_t source = vd->source;
200 vout->output.i_chroma = source.i_chroma;
201 vout->output.i_width = source.i_width;
202 vout->output.i_height = source.i_height;
203 vout->output.i_aspect = source.i_aspect;
204 vout->output.i_rmask = source.i_rmask;
205 vout->output.i_gmask = source.i_gmask;
206 vout->output.i_bmask = source.i_bmask;
207 vout->output.pf_setpalette = NULL; /* FIXME What to do ? Seems unused anyway */
209 /* also set fmt_out (completly broken API) */
210 vout->fmt_out.i_chroma = vout->output.i_chroma;
211 vout->fmt_out.i_width =
212 vout->fmt_out.i_visible_width = vout->output.i_width;
213 vout->fmt_out.i_height =
214 vout->fmt_out.i_visible_height = vout->output.i_height;
215 vout->fmt_out.i_aspect = vout->output.i_aspect;
216 vout->fmt_out.i_x_offset = 0;
217 vout->fmt_out.i_y_offset = 0;
221 if (p_vout->fmt_render.i_visible_width != source.i_visible_width ||
222 p_vout->fmt_render.i_visible_height != source.i_visible_height ||
223 p_vout->fmt_render.i_x_offset != source.i_x_offset ||
224 p_vout->fmt_render.i_y_offset != source.i_y_offset )
226 p_vout->i_changes |= VOUT_CROP_CHANGE;
230 vout_SetDisplayOnTop(vd, true);
232 /* XXX For non dr case, the current vout implementation force us to
233 * create at most 1 direct picture (otherwise the buffers will be kept
234 * referenced even through the Init/End.
236 sys->use_dr = !vout_IsDisplayFiltered(vd);
237 const bool allow_dr = !vd->info.has_pictures_invalid && sys->use_dr;
238 const int picture_max = allow_dr ? VOUT_MAX_PICTURES : 1;
239 for (vout->output.i_pictures = 0;
240 vout->output.i_pictures < picture_max;
241 vout->output.i_pictures++) {
242 /* Find an empty picture slot */
243 picture_t *picture = NULL;
244 for (int index = 0; index < VOUT_MAX_PICTURES; index++) {
245 if (vout->p_picture[index].i_status == FREE_PICTURE) {
246 picture = &vout->p_picture[index];
252 memset(picture, 0, sizeof(*picture));
254 picture->p_sys = malloc(sizeof(*picture->p_sys));
257 picture_t *direct = vout_display_Get(vd);
260 picture->format = direct->format;
261 picture->i_planes = direct->i_planes;
262 for (int i = 0; i < direct->i_planes; i++)
263 picture->p[i] = direct->p[i];
264 picture->b_slow = vd->info.is_slow;
266 picture->p_sys->direct = direct;
268 vout_AllocatePicture(VLC_OBJECT(vd), picture,
270 vd->source.i_width, vd->source.i_height,
271 vd->source.i_aspect);
272 if (!picture->i_planes)
274 picture->p_sys->direct = NULL;
276 picture->i_status = DESTROYED_PICTURE;
277 picture->i_type = DIRECT_PICTURE;
279 vout->output.pp_picture[vout->output.i_pictures] = picture;
284 /*****************************************************************************
286 *****************************************************************************/
287 static void End(vout_thread_t *vout)
289 vout_sys_t *sys = vout->p_sys;
291 for (int i = 0; i < VOUT_MAX_PICTURES; i++) {
292 picture_t *picture = &vout->p_picture[i];
294 if (picture->i_type != DIRECT_PICTURE)
297 if (picture->p_sys->direct)
298 picture_Release(picture->p_sys->direct);
300 free(picture->p_data_orig);
301 free(picture->p_sys);
305 /*****************************************************************************
307 *****************************************************************************/
308 static int Manage(vout_thread_t *vout)
310 vout_sys_t *sys = vout->p_sys;
311 vout_display_t *vd = sys->vd;
313 while (vout->i_changes & (VOUT_FULLSCREEN_CHANGE |
320 if (vout->i_changes & VOUT_FULLSCREEN_CHANGE) {
321 vout->b_fullscreen = !vout->b_fullscreen;
323 var_SetBool(vout, "fullscreen", vout->b_fullscreen);
324 vout_SetDisplayFullscreen(vd, vout->b_fullscreen);
325 vout->i_changes &= ~VOUT_FULLSCREEN_CHANGE;
327 if (vout->i_changes & VOUT_ASPECT_CHANGE) {
328 vout->output.i_aspect =
329 vout->fmt_out.i_aspect = vout->fmt_in.i_aspect;
330 vout->fmt_out.i_sar_num = vout->fmt_in.i_sar_num;
331 vout->fmt_out.i_sar_den = vout->fmt_in.i_sar_den;
333 vout_SetDisplayAspect(vd, vout->fmt_in.i_sar_num, vout->fmt_in.i_sar_den);
335 vout->i_changes &= ~VOUT_ASPECT_CHANGE;
337 if (vout->i_changes & VOUT_ZOOM_CHANGE) {
338 const float zoom = var_GetFloat(vout, "scale");
340 unsigned den = ZOOM_FP_FACTOR;
341 unsigned num = den * zoom;
342 if (num < (ZOOM_FP_FACTOR+9) / 10)
343 num = (ZOOM_FP_FACTOR+9) / 10;
344 else if (num > ZOOM_FP_FACTOR * 10)
345 num = ZOOM_FP_FACTOR * 10;
347 vout_SetDisplayZoom(vd, num, den);
349 vout->i_changes &= ~VOUT_ZOOM_CHANGE;
351 if (vout->i_changes & VOUT_SCALE_CHANGE) {
352 const bool is_display_filled = var_GetBool(vout, "autoscale");
354 vout_SetDisplayFilled(vd, is_display_filled);
356 vout->i_changes &= ~VOUT_SCALE_CHANGE;
358 if (vout->i_changes & VOUT_ON_TOP_CHANGE) {
359 vout_SetDisplayOnTop(vd, vout->b_on_top);
361 vout->i_changes &= ~VOUT_ON_TOP_CHANGE;
363 if (vout->i_changes & VOUT_CROP_CHANGE) {
364 const video_format_t crop = vout->fmt_in;
365 const video_format_t org = vout->fmt_render;
366 /* FIXME because of rounding errors, the reconstructed ratio is wrong */
369 if (crop.i_x_offset == org.i_x_offset &&
370 crop.i_visible_width == org.i_visible_width &&
371 crop.i_y_offset == org.i_y_offset + (org.i_visible_height - crop.i_visible_height)/2) {
372 vlc_ureduce(&num, &den,
373 crop.i_visible_width * crop.i_sar_num,
374 crop.i_visible_height * crop.i_sar_den, 0);
375 } else if (crop.i_y_offset == org.i_y_offset &&
376 crop.i_visible_height == org.i_visible_height &&
377 crop.i_x_offset == org.i_x_offset + (org.i_visible_width - crop.i_visible_width)/2) {
378 vlc_ureduce(&num, &den,
379 crop.i_visible_width * crop.i_sar_num,
380 crop.i_visible_height * crop.i_sar_den, 0);
382 vout_SetDisplayCrop(vd, num, den,
383 crop.i_x_offset, crop.i_y_offset,
384 crop.i_visible_width, crop.i_visible_height);
385 vout->i_changes &= ~VOUT_CROP_CHANGE;
390 if (sys->use_dr && vout_AreDisplayPicturesInvalid(vd)) {
391 vout->i_changes |= VOUT_PICTURE_BUFFERS_CHANGE;
394 vout_ManageDisplay(vd);
398 /*****************************************************************************
400 *****************************************************************************/
401 static void Render(vout_thread_t *vout, picture_t *picture)
403 vout_sys_t *sys = vout->p_sys;
404 vout_display_t *vd = sys->vd;
406 assert(sys->use_dr || !picture->p_sys->direct);
409 assert(!vout_IsDisplayFiltered(vd));
410 assert(picture->p_sys->direct);
412 vout_display_Prepare(vd, picture->p_sys->direct);
414 picture_t *filtered = vout_FilterDisplay(vd, picture);
416 picture_t *direct = picture->p_sys->direct = vout_display_Get(vd);
418 picture_Copy(direct, filtered);
419 vout_display_Prepare(vd, direct);
421 picture_Release(filtered);
426 /*****************************************************************************
428 *****************************************************************************/
429 static void Display(vout_thread_t *vout, picture_t *picture)
431 vout_sys_t *sys = vout->p_sys;
432 vout_display_t *vd = sys->vd;
434 picture_t *direct = picture->p_sys->direct;
438 /* XXX This is a hack that will work with current vout_display_t modules */
440 picture_Hold(direct);
442 vout_display_Display(vd, direct);
445 picture->p_sys->direct = NULL;
448 static void VoutGetDisplayCfg(vout_thread_t *vout, vout_display_cfg_t *cfg, const char *title)
450 /* Load configuration */
451 cfg->is_fullscreen = var_CreateGetBool(vout, "fullscreen");
452 cfg->display.title = title;
453 const int display_width = var_CreateGetInteger(vout, "width");
454 const int display_height = var_CreateGetInteger(vout, "height");
455 cfg->display.width = display_width > 0 ? display_width : 0;
456 cfg->display.height = display_height > 0 ? display_height : 0;
457 cfg->is_display_filled = var_CreateGetBool(vout, "autoscale");
458 cfg->display.sar.num = 1; /* TODO monitor AR */
459 cfg->display.sar.den = 1;
460 unsigned zoom_den = 1000;
461 unsigned zoom_num = zoom_den * var_CreateGetFloat(vout, "scale");
462 vlc_ureduce(&zoom_num, &zoom_den, zoom_num, zoom_den, 0);
463 cfg->zoom.num = zoom_num;
464 cfg->zoom.den = zoom_den;
465 cfg->align.vertical = VOUT_DISPLAY_ALIGN_CENTER;
466 cfg->align.horizontal = VOUT_DISPLAY_ALIGN_CENTER;
467 const int align_mask = var_CreateGetInteger(vout, "align");
468 if (align_mask & 0x1)
469 cfg->align.horizontal = VOUT_DISPLAY_ALIGN_LEFT;
470 else if (align_mask & 0x2)
471 cfg->align.horizontal = VOUT_DISPLAY_ALIGN_RIGHT;
472 if (align_mask & 0x4)
473 cfg->align.horizontal = VOUT_DISPLAY_ALIGN_TOP;
474 else if (align_mask & 0x8)
475 cfg->align.horizontal = VOUT_DISPLAY_ALIGN_BOTTOM;