1 /*****************************************************************************
2 * display.c: "vout display" managment
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 *****************************************************************************/
32 #include <vlc_common.h>
33 #include <vlc_video_splitter.h>
34 #include <vlc_vout_display.h>
43 /* It must be present as long as a vout_display_t must be created using a dummy
44 * vout (as an opengl provider) */
45 #define ALLOW_DUMMY_VOUT
47 static void SplitterClose(vout_display_t *vd);
49 /*****************************************************************************
50 * FIXME/TODO see how to have direct rendering here (interact with vout.c)
51 *****************************************************************************/
52 static picture_t *VideoBufferNew(filter_t *filter)
54 vout_display_t *vd = (vout_display_t*)filter->p_owner;
55 const video_format_t *fmt = &filter->fmt_out.video;
57 assert(vd->fmt.i_chroma == fmt->i_chroma &&
58 vd->fmt.i_width == fmt->i_width &&
59 vd->fmt.i_height == fmt->i_height);
61 picture_pool_t *pool = vout_display_Pool(vd, 3);
64 return picture_pool_Get(pool);
66 static void VideoBufferDelete(filter_t *filter, picture_t *picture)
69 picture_Release(picture);
72 static int FilterAllocationInit(filter_t *filter, void *vd)
74 filter->pf_video_buffer_new = VideoBufferNew;
75 filter->pf_video_buffer_del = VideoBufferDelete;
80 static void FilterAllocationClean(filter_t *filter)
82 filter->pf_video_buffer_new = NULL;
83 filter->pf_video_buffer_del = NULL;
84 filter->p_owner = NULL;
87 /*****************************************************************************
89 *****************************************************************************/
92 * It creates a new vout_display_t using the given configuration.
94 static vout_display_t *vout_display_New(vlc_object_t *obj,
95 const char *module, bool load_module,
96 const video_format_t *fmt,
97 const vout_display_cfg_t *cfg,
98 vout_display_owner_t *owner)
101 vout_display_t *vd = vlc_object_create(obj, sizeof(*vd));
104 video_format_Copy(&vd->source, fmt);
106 /* Picture buffer does not have the concept of aspect ratio */
107 video_format_Copy(&vd->fmt, fmt);
108 vd->fmt.i_sar_num = 0;
109 vd->fmt.i_sar_den = 0;
111 vd->info.is_slow = false;
112 vd->info.has_double_click = false;
113 vd->info.has_hide_mouse = false;
114 vd->info.has_pictures_invalid = false;
126 vlc_object_attach(vd, obj);
129 vd->module = module_need(vd, "vout display", module, module && *module != '\0');
131 vlc_object_release(vd);
141 * It deletes a vout_display_t
143 static void vout_display_Delete(vout_display_t *vd)
146 module_unneed(vd, vd->module);
148 vlc_object_release(vd);
152 * It controls a vout_display_t
154 static int vout_display_Control(vout_display_t *vd, int query, ...)
159 va_start(args, query);
160 result = vd->control(vd, query, args);
165 static void vout_display_Manage(vout_display_t *vd)
172 void vout_display_GetDefaultDisplaySize(unsigned *width, unsigned *height,
173 const video_format_t *source,
174 const vout_display_cfg_t *cfg)
176 if (cfg->display.width > 0 && cfg->display.height > 0) {
177 *width = cfg->display.width;
178 *height = cfg->display.height;
179 } else if (cfg->display.width > 0) {
180 *width = cfg->display.width;
181 *height = (int64_t)source->i_visible_height * source->i_sar_den * cfg->display.width * cfg->display.sar.num /
182 source->i_visible_width / source->i_sar_num / cfg->display.sar.den;
183 } else if (cfg->display.height > 0) {
184 *width = (int64_t)source->i_visible_width * source->i_sar_num * cfg->display.height * cfg->display.sar.den /
185 source->i_visible_height / source->i_sar_den / cfg->display.sar.num;
186 *height = cfg->display.height;
187 } else if (source->i_sar_num >= source->i_sar_den) {
188 *width = (int64_t)source->i_visible_width * source->i_sar_num * cfg->display.sar.den / source->i_sar_den / cfg->display.sar.num;
189 *height = source->i_visible_height;
191 *width = source->i_visible_width;
192 *height = (int64_t)source->i_visible_height * source->i_sar_den * cfg->display.sar.num / source->i_sar_num / cfg->display.sar.den;
195 *width = *width * cfg->zoom.num / cfg->zoom.den;
196 *height = *height * cfg->zoom.num / cfg->zoom.den;
200 void vout_display_PlacePicture(vout_display_place_t *place,
201 const video_format_t *source,
202 const vout_display_cfg_t *cfg,
206 memset(place, 0, sizeof(*place));
207 if (cfg->display.width <= 0 || cfg->display.height <= 0)
211 unsigned display_width;
212 unsigned display_height;
214 if (cfg->is_display_filled) {
215 display_width = cfg->display.width;
216 display_height = cfg->display.height;
218 vout_display_cfg_t cfg_tmp = *cfg;
220 cfg_tmp.display.width = 0;
221 cfg_tmp.display.height = 0;
222 vout_display_GetDefaultDisplaySize(&display_width, &display_height,
226 display_width = __MIN(display_width, cfg->display.width);
227 display_height = __MIN(display_height, cfg->display.height);
231 const unsigned width = source->i_visible_width;
232 const unsigned height = source->i_visible_height;
233 /* Compute the height if we use the width to fill up display_width */
234 const int64_t scaled_height = (int64_t)height * display_width * cfg->display.sar.num * source->i_sar_den / width / source->i_sar_num / cfg->display.sar.den;
235 /* And the same but switching width/height */
236 const int64_t scaled_width = (int64_t)width * display_height * cfg->display.sar.den * source->i_sar_num / height / source->i_sar_den / cfg->display.sar.num;
238 /* We keep the solution that avoid filling outside the display */
239 if (scaled_width <= cfg->display.width) {
240 place->width = scaled_width;
241 place->height = display_height;
243 place->width = display_width;
244 place->height = scaled_height;
247 /* Compute position */
248 switch (cfg->align.horizontal) {
249 case VOUT_DISPLAY_ALIGN_LEFT:
252 case VOUT_DISPLAY_ALIGN_RIGHT:
253 place->x = cfg->display.width - place->width;
256 place->x = (cfg->display.width - place->width) / 2;
260 switch (cfg->align.vertical) {
261 case VOUT_DISPLAY_ALIGN_TOP:
264 case VOUT_DISPLAY_ALIGN_BOTTOM:
265 place->y = cfg->display.height - place->height;
268 place->y = (cfg->display.height - place->height) / 2;
273 struct vout_display_owner_sys_t {
275 bool is_wrapper; /* Is the current display a wrapper */
276 vout_display_t *wrapper; /* Vout display wrapper */
279 vout_display_cfg_t cfg;
280 unsigned wm_state_initial;
296 bool ch_display_filled;
297 bool is_display_filled;
325 video_format_t source;
326 filter_chain_t *filters;
328 /* Lock protecting the variables used by
329 * VoutDisplayEvent(ie vout_display_SendEvent) */
336 mtime_t last_pressed;
342 mtime_t double_click_timeout;
343 mtime_t hide_timeout;
351 bool ch_display_size;
354 bool display_is_fullscreen;
355 bool display_is_forced;
359 #ifdef ALLOW_DUMMY_VOUT
360 vlc_mouse_t vout_mouse;
364 static void DummyVoutSendDisplayEventMouse(vout_thread_t *, vlc_mouse_t *fallback, const vlc_mouse_t *m);
366 static void VoutDisplayCreateRender(vout_display_t *vd)
368 vout_display_owner_sys_t *osys = vd->owner.sys;
370 osys->filters = NULL;
372 video_format_t v_src = vd->source;
376 video_format_t v_dst = vd->fmt;
380 video_format_t v_dst_cmp = v_dst;
381 if ((v_src.i_chroma == VLC_CODEC_J420 && v_dst.i_chroma == VLC_CODEC_I420) ||
382 (v_src.i_chroma == VLC_CODEC_J422 && v_dst.i_chroma == VLC_CODEC_I422) ||
383 (v_src.i_chroma == VLC_CODEC_J440 && v_dst.i_chroma == VLC_CODEC_I440) ||
384 (v_src.i_chroma == VLC_CODEC_J444 && v_dst.i_chroma == VLC_CODEC_I444))
385 v_dst_cmp.i_chroma = v_src.i_chroma;
387 const bool convert = memcmp(&v_src, &v_dst_cmp, sizeof(v_src)) != 0;
391 msg_Dbg(vd, "A filter to adapt decoder to display is needed");
393 osys->filters = filter_chain_New(vd, "video filter2", false,
394 FilterAllocationInit,
395 FilterAllocationClean, vd);
396 assert(osys->filters); /* TODO critical */
400 es_format_InitFromVideo(&src, &v_src);
406 for (int i = 0; i < 1 + (v_dst_cmp.i_chroma != v_dst.i_chroma); i++) {
408 es_format_InitFromVideo(&dst, i == 0 ? &v_dst : &v_dst_cmp);
410 filter_chain_Reset(osys->filters, &src, &dst);
411 filter = filter_chain_AppendFilter(osys->filters,
412 NULL, NULL, &src, &dst);
418 msg_Err(vd, "VoutDisplayCreateRender FAILED");
424 static void VoutDisplayDestroyRender(vout_display_t *vd)
426 vout_display_owner_sys_t *osys = vd->owner.sys;
429 filter_chain_Delete(osys->filters);
432 static void VoutDisplayResetRender(vout_display_t *vd)
434 VoutDisplayDestroyRender(vd);
435 VoutDisplayCreateRender(vd);
437 static void VoutDisplayEventMouse(vout_display_t *vd, int event, va_list args)
439 vout_display_owner_sys_t *osys = vd->owner.sys;
441 vlc_mutex_lock(&osys->lock);
444 vlc_mouse_t m = osys->mouse.state;
445 bool is_ignored = false;
448 case VOUT_DISPLAY_EVENT_MOUSE_STATE: {
449 const int x = (int)va_arg(args, int);
450 const int y = (int)va_arg(args, int);
451 const int button_mask = (int)va_arg(args, int);
456 m.i_pressed = button_mask;
459 case VOUT_DISPLAY_EVENT_MOUSE_MOVED: {
460 const int x = (int)va_arg(args, int);
461 const int y = (int)va_arg(args, int);
462 if (x != osys->mouse.state.i_x || y != osys->mouse.state.i_y) {
463 //msg_Dbg(vd, "VoutDisplayEvent 'mouse' @%d,%d", x, y);
467 m.b_double_click = false;
473 case VOUT_DISPLAY_EVENT_MOUSE_PRESSED:
474 case VOUT_DISPLAY_EVENT_MOUSE_RELEASED: {
475 const int button = (int)va_arg(args, int);
476 const int button_mask = 1 << button;
478 /* Ignore inconsistent event */
479 if ((event == VOUT_DISPLAY_EVENT_MOUSE_PRESSED && (osys->mouse.state.i_pressed & button_mask)) ||
480 (event == VOUT_DISPLAY_EVENT_MOUSE_RELEASED && !(osys->mouse.state.i_pressed & button_mask))) {
486 msg_Dbg(vd, "VoutDisplayEvent 'mouse button' %d t=%d", button, event);
488 m.b_double_click = false;
489 if (event == VOUT_DISPLAY_EVENT_MOUSE_PRESSED)
490 m.i_pressed |= button_mask;
492 m.i_pressed &= ~button_mask;
495 case VOUT_DISPLAY_EVENT_MOUSE_DOUBLE_CLICK:
496 msg_Dbg(vd, "VoutDisplayEvent 'double click'");
498 m.b_double_click = true;
505 vlc_mutex_unlock(&osys->lock);
509 /* Emulate double-click if needed */
510 if (!vd->info.has_double_click &&
511 vlc_mouse_HasPressed(&osys->mouse.state, &m, MOUSE_BUTTON_LEFT)) {
512 const mtime_t i_date = mdate();
514 if (i_date - osys->mouse.last_pressed < osys->mouse.double_click_timeout ) {
515 m.b_double_click = true;
516 osys->mouse.last_pressed = 0;
518 osys->mouse.last_pressed = mdate();
523 osys->mouse.state = m;
526 osys->mouse.ch_activity = true;
527 if (!vd->info.has_hide_mouse)
528 osys->mouse.last_moved = mdate();
531 vout_SendEventMouseVisible(osys->vout);
532 #ifdef ALLOW_DUMMY_VOUT
533 DummyVoutSendDisplayEventMouse(osys->vout, &osys->vout_mouse, &m);
535 vout_SendDisplayEventMouse(osys->vout, &m);
537 vlc_mutex_unlock(&osys->lock);
540 static void VoutDisplayEvent(vout_display_t *vd, int event, va_list args)
542 vout_display_owner_sys_t *osys = vd->owner.sys;
545 case VOUT_DISPLAY_EVENT_CLOSE: {
546 msg_Dbg(vd, "VoutDisplayEvent 'close'");
547 vout_SendEventClose(osys->vout);
550 case VOUT_DISPLAY_EVENT_KEY: {
551 const int key = (int)va_arg(args, int);
552 msg_Dbg(vd, "VoutDisplayEvent 'key' 0x%2.2x", key);
553 vout_SendEventKey(osys->vout, key);
556 case VOUT_DISPLAY_EVENT_MOUSE_STATE:
557 case VOUT_DISPLAY_EVENT_MOUSE_MOVED:
558 case VOUT_DISPLAY_EVENT_MOUSE_PRESSED:
559 case VOUT_DISPLAY_EVENT_MOUSE_RELEASED:
560 case VOUT_DISPLAY_EVENT_MOUSE_DOUBLE_CLICK:
561 VoutDisplayEventMouse(vd, event, args);
564 case VOUT_DISPLAY_EVENT_FULLSCREEN: {
565 const int is_fullscreen = (int)va_arg(args, int);
567 msg_Dbg(vd, "VoutDisplayEvent 'fullscreen' %d", is_fullscreen);
569 vlc_mutex_lock(&osys->lock);
570 if (!is_fullscreen != !osys->is_fullscreen) {
571 osys->ch_fullscreen = true;
572 osys->is_fullscreen = is_fullscreen;
574 vlc_mutex_unlock(&osys->lock);
578 case VOUT_DISPLAY_EVENT_WINDOW_STATE: {
579 const unsigned state = va_arg(args, unsigned);
581 msg_Dbg(vd, "VoutDisplayEvent 'window state' %u", state);
583 vlc_mutex_lock(&osys->lock);
584 if (state != osys->wm_state) {
585 osys->ch_wm_state = true;
586 osys->wm_state = state;
588 vlc_mutex_unlock(&osys->lock);
592 case VOUT_DISPLAY_EVENT_DISPLAY_SIZE: {
593 const int width = (int)va_arg(args, int);
594 const int height = (int)va_arg(args, int);
595 const bool is_fullscreen = (bool)va_arg(args, int);
596 msg_Dbg(vd, "VoutDisplayEvent 'resize' %dx%d %s",
597 width, height, is_fullscreen ? "fullscreen" : "window");
600 vlc_mutex_lock(&osys->lock);
602 osys->ch_display_size = true;
603 osys->display_width = width;
604 osys->display_height = height;
605 osys->display_is_fullscreen = is_fullscreen;
606 osys->display_is_forced = false;
608 vlc_mutex_unlock(&osys->lock);
612 case VOUT_DISPLAY_EVENT_PICTURES_INVALID: {
613 msg_Warn(vd, "VoutDisplayEvent 'pictures invalid'");
616 assert(vd->info.has_pictures_invalid);
618 vlc_mutex_lock(&osys->lock);
619 osys->reset_pictures = true;
620 vlc_mutex_unlock(&osys->lock);
624 msg_Err(vd, "VoutDisplayEvent received event %d", event);
625 /* TODO add an assert when all event are handled */
630 static vout_window_t *VoutDisplayNewWindow(vout_display_t *vd, const vout_window_cfg_t *cfg)
632 vout_display_owner_sys_t *osys = vd->owner.sys;
634 return vout_NewDisplayWindow(osys->vout, vd, cfg);
636 static void VoutDisplayDelWindow(vout_display_t *vd, vout_window_t *window)
638 vout_display_owner_sys_t *osys = vd->owner.sys;
640 vout_DeleteDisplayWindow(osys->vout, vd, window);
643 static void VoutDisplayFitWindow(vout_display_t *vd, bool default_size)
645 vout_display_owner_sys_t *osys = vd->owner.sys;
646 vout_display_cfg_t cfg = osys->cfg;
648 if (!cfg.is_display_filled)
651 cfg.display.width = 0;
653 cfg.display.height = 0;
655 cfg.display.height = osys->height_saved;
660 unsigned display_width;
661 unsigned display_height;
662 vout_display_GetDefaultDisplaySize(&display_width, &display_height,
665 vlc_mutex_lock(&osys->lock);
667 osys->ch_display_size = true;
668 osys->display_width = display_width;
669 osys->display_height = display_height;
670 osys->display_is_fullscreen = osys->cfg.is_fullscreen;
671 osys->display_is_forced = true;
673 vlc_mutex_unlock(&osys->lock);
676 static void VoutDisplayCropRatio(unsigned *x, unsigned *y,
677 unsigned *width, unsigned *height,
678 const video_format_t *source,
679 unsigned num, unsigned den)
681 unsigned scaled_width = (uint64_t)source->i_visible_height * num * source->i_sar_den / den / source->i_sar_num;
682 unsigned scaled_height = (uint64_t)source->i_visible_width * den * source->i_sar_num / num / source->i_sar_den;
684 if (scaled_width < source->i_visible_width) {
685 *x = (source->i_visible_width - scaled_width) / 2;
687 *width = scaled_width;
688 *height = source->i_visible_height;
691 *y = (source->i_visible_height - scaled_height) / 2;
692 *width = source->i_visible_width;
693 *height = scaled_height;
695 *x += source->i_x_offset;
696 *y += source->i_y_offset;
699 void vout_ManageDisplay(vout_display_t *vd, bool allow_reset_pictures)
701 vout_display_owner_sys_t *osys = vd->owner.sys;
703 vout_display_Manage(vd);
705 /* Handle mouse timeout */
706 const mtime_t date = mdate();
707 bool hide_mouse = false;
709 vlc_mutex_lock(&osys->lock);
711 if (!osys->mouse.is_hidden &&
712 osys->mouse.last_moved + osys->mouse.hide_timeout < date) {
713 osys->mouse.is_hidden = hide_mouse = true;
714 } else if (osys->mouse.ch_activity) {
715 osys->mouse.is_hidden = false;
717 osys->mouse.ch_activity = false;
718 vlc_mutex_unlock(&osys->lock);
721 if (!vd->info.has_hide_mouse) {
722 msg_Dbg(vd, "auto hidding mouse");
723 vout_display_Control(vd, VOUT_DISPLAY_HIDE_MOUSE);
725 vout_SendEventMouseHidden(osys->vout);
728 bool reset_render = false;
731 vlc_mutex_lock(&osys->lock);
733 bool ch_fullscreen = osys->ch_fullscreen;
734 bool is_fullscreen = osys->is_fullscreen;
735 osys->ch_fullscreen = false;
737 bool ch_wm_state = osys->ch_wm_state;
738 unsigned wm_state = osys->wm_state;
739 osys->ch_wm_state = false;
741 bool ch_display_size = osys->ch_display_size;
742 int display_width = osys->display_width;
743 int display_height = osys->display_height;
744 bool display_is_fullscreen = osys->display_is_fullscreen;
745 bool display_is_forced = osys->display_is_forced;
746 osys->ch_display_size = false;
749 if (allow_reset_pictures) {
750 reset_pictures = osys->reset_pictures;
751 osys->reset_pictures = false;
753 reset_pictures = false;
756 vlc_mutex_unlock(&osys->lock);
758 if (!ch_fullscreen &&
761 !osys->ch_display_filled &&
767 if (!osys->cfg.is_fullscreen && osys->fit_window != 0) {
768 VoutDisplayFitWindow(vd, osys->fit_window == -1);
769 osys->fit_window = 0;
777 vout_display_cfg_t cfg = osys->cfg;
779 cfg.is_fullscreen = is_fullscreen;
780 cfg.display.width = cfg.is_fullscreen ? 0 : osys->width_saved;
781 cfg.display.height = cfg.is_fullscreen ? 0 : osys->height_saved;
783 if (vout_display_Control(vd, VOUT_DISPLAY_CHANGE_FULLSCREEN, &cfg)) {
784 msg_Err(vd, "Failed to set fullscreen");
785 is_fullscreen = osys->cfg.is_fullscreen;
786 } else if (!is_fullscreen) {
787 vout_display_Control(vd, VOUT_DISPLAY_CHANGE_DISPLAY_SIZE, &cfg, true);
789 osys->cfg.is_fullscreen = is_fullscreen;
792 vout_SendEventFullscreen(osys->vout, osys->cfg.is_fullscreen);
796 if (ch_display_size) {
797 vout_display_cfg_t cfg = osys->cfg;
798 cfg.display.width = display_width;
799 cfg.display.height = display_height;
801 if (!cfg.is_fullscreen != !display_is_fullscreen ||
802 vout_display_Control(vd, VOUT_DISPLAY_CHANGE_DISPLAY_SIZE, &cfg, display_is_forced)) {
803 if (!cfg.is_fullscreen == !display_is_fullscreen)
804 msg_Err(vd, "Failed to resize display");
806 /* We ignore the resized */
807 display_width = osys->cfg.display.width;
808 display_height = osys->cfg.display.height;
810 osys->cfg.display.width = display_width;
811 osys->cfg.display.height = display_height;
813 if (!display_is_fullscreen) {
814 osys->width_saved = display_width;
815 osys->height_saved = display_height;
819 if (osys->ch_display_filled) {
820 vout_display_cfg_t cfg = osys->cfg;
822 cfg.is_display_filled = osys->is_display_filled;
824 if (vout_display_Control(vd, VOUT_DISPLAY_CHANGE_DISPLAY_FILLED, &cfg)) {
825 msg_Err(vd, "Failed to change display filled state");
826 osys->is_display_filled = osys->cfg.is_display_filled;
828 osys->cfg.is_display_filled = osys->is_display_filled;
829 osys->ch_display_filled = false;
831 vout_SendEventDisplayFilled(osys->vout, osys->cfg.is_display_filled);
835 vout_display_cfg_t cfg = osys->cfg;
837 cfg.zoom.num = osys->zoom.num;
838 cfg.zoom.den = osys->zoom.den;
840 if (10 * cfg.zoom.num <= cfg.zoom.den) {
843 } else if (cfg.zoom.num >= 10 * cfg.zoom.den) {
848 if (vout_display_Control(vd, VOUT_DISPLAY_CHANGE_ZOOM, &cfg)) {
849 msg_Err(vd, "Failed to change zoom");
850 osys->zoom.num = osys->cfg.zoom.num;
851 osys->zoom.den = osys->cfg.zoom.den;
853 osys->fit_window = -1;
856 osys->cfg.zoom.num = osys->zoom.num;
857 osys->cfg.zoom.den = osys->zoom.den;
858 osys->ch_zoom = false;
860 vout_SendEventZoom(osys->vout, osys->cfg.zoom.num, osys->cfg.zoom.den);
864 if (vout_display_Control(vd, VOUT_DISPLAY_CHANGE_WINDOW_STATE, wm_state)) {
865 msg_Err(vd, "Failed to set on top");
866 wm_state = osys->wm_state;
868 osys->wm_state_initial = wm_state;
871 vout_SendEventOnTop(osys->vout, osys->wm_state_initial);
875 video_format_t source = vd->source;
877 if (osys->sar.num > 0 && osys->sar.den > 0) {
878 source.i_sar_num = osys->sar.num;
879 source.i_sar_den = osys->sar.den;
881 source.i_sar_num = osys->source.i_sar_num;
882 source.i_sar_den = osys->source.i_sar_den;
885 if (vout_display_Control(vd, VOUT_DISPLAY_CHANGE_SOURCE_ASPECT, &source)) {
886 /* There nothing much we can do. The only reason a vout display
887 * does not support it is because it need the core to add black border
888 * to the video for it.
889 * TODO add black borders ?
891 msg_Err(vd, "Failed to change source AR");
893 } else if (!osys->fit_window) {
894 osys->fit_window = 1;
897 osys->sar.num = source.i_sar_num;
898 osys->sar.den = source.i_sar_den;
899 osys->ch_sar = false;
902 if (osys->sar.num == osys->source.i_sar_num &&
903 osys->sar.den == osys->source.i_sar_den)
905 vout_SendEventSourceAspect(osys->vout, 0, 0);
909 unsigned dar_num, dar_den;
910 vlc_ureduce( &dar_num, &dar_den,
911 osys->sar.num * vd->source.i_visible_width,
912 osys->sar.den * vd->source.i_visible_height,
914 vout_SendEventSourceAspect(osys->vout, dar_num, dar_den);
916 /* If a crop ratio is requested, recompute the parameters */
917 if (osys->crop.num > 0 && osys->crop.den > 0)
918 osys->ch_crop = true;
922 video_format_t source = vd->source;
924 unsigned crop_num = osys->crop.num;
925 unsigned crop_den = osys->crop.den;
926 if (crop_num > 0 && crop_den > 0) {
927 video_format_t fmt = osys->source;
928 fmt.i_sar_num = source.i_sar_num;
929 fmt.i_sar_den = source.i_sar_den;
930 VoutDisplayCropRatio(&osys->crop.x, &osys->crop.y,
931 &osys->crop.width, &osys->crop.height,
932 &fmt, crop_num, crop_den);
935 source.i_x_offset = osys->crop.x;
936 source.i_y_offset = osys->crop.y;
937 source.i_visible_width = osys->crop.width;
938 source.i_visible_height = osys->crop.height;
941 const bool is_valid = source.i_x_offset < source.i_width &&
942 source.i_y_offset < source.i_height &&
943 source.i_x_offset + source.i_visible_width <= source.i_width &&
944 source.i_y_offset + source.i_visible_height <= source.i_height &&
945 source.i_visible_width > 0 && source.i_visible_height > 0;
947 if (!is_valid || vout_display_Control(vd, VOUT_DISPLAY_CHANGE_SOURCE_CROP, &source)) {
949 msg_Err(vd, "Failed to change source crop TODO implement crop at core");
951 msg_Err(vd, "Invalid crop requested");
954 crop_num = osys->crop_saved.num;
955 crop_den = osys->crop_saved.den;
956 /* FIXME implement cropping in the core if not supported by the
959 } else if (!osys->fit_window) {
960 osys->fit_window = 1;
963 osys->crop.x = source.i_x_offset;
964 osys->crop.y = source.i_y_offset;
965 osys->crop.width = source.i_visible_width;
966 osys->crop.height = source.i_visible_height;
967 osys->crop.num = crop_num;
968 osys->crop.den = crop_den;
969 osys->ch_crop = false;
971 /* TODO fix when a ratio is used (complicated). */
972 const unsigned left = osys->crop.x - osys->source.i_x_offset;
973 const unsigned top = osys->crop.y - osys->source.i_y_offset;
974 const unsigned right = osys->source.i_visible_width - (osys->crop.width + osys->crop.x);
975 const unsigned bottom = osys->source.i_visible_height - (osys->crop.height + osys->crop.y);
976 vout_SendEventSourceCrop(osys->vout,
977 osys->crop.num, osys->crop.den,
978 left, top, right, bottom);
982 if (reset_pictures) {
983 if (vout_display_Control(vd, VOUT_DISPLAY_RESET_PICTURES)) {
984 /* FIXME what to do here ? */
985 msg_Err(vd, "Failed to reset pictures (probably fatal)");
991 VoutDisplayResetRender(vd);
994 bool vout_AreDisplayPicturesInvalid(vout_display_t *vd)
996 vout_display_owner_sys_t *osys = vd->owner.sys;
998 vlc_mutex_lock(&osys->lock);
999 const bool reset_pictures = osys->reset_pictures;
1000 vlc_mutex_unlock(&osys->lock);
1002 return reset_pictures;
1005 bool vout_IsDisplayFiltered(vout_display_t *vd)
1007 vout_display_owner_sys_t *osys = vd->owner.sys;
1009 return osys->filters != NULL;
1012 picture_t *vout_FilterDisplay(vout_display_t *vd, picture_t *picture)
1014 vout_display_owner_sys_t *osys = vd->owner.sys;
1016 assert(osys->filters);
1017 return filter_chain_VideoFilter(osys->filters, picture);
1020 void vout_SetDisplayFullscreen(vout_display_t *vd, bool is_fullscreen)
1022 vout_display_owner_sys_t *osys = vd->owner.sys;
1024 vlc_mutex_lock(&osys->lock);
1025 if (!osys->is_fullscreen != !is_fullscreen) {
1026 osys->ch_fullscreen = true;
1027 osys->is_fullscreen = is_fullscreen;
1029 vlc_mutex_unlock(&osys->lock);
1032 void vout_SetDisplayFilled(vout_display_t *vd, bool is_filled)
1034 vout_display_owner_sys_t *osys = vd->owner.sys;
1036 if (!osys->is_display_filled != !is_filled) {
1037 osys->ch_display_filled = true;
1038 osys->is_display_filled = is_filled;
1042 void vout_SetDisplayZoom(vout_display_t *vd, int num, int den)
1044 vout_display_owner_sys_t *osys = vd->owner.sys;
1046 if (osys->is_display_filled ||
1047 osys->zoom.num != num || osys->zoom.den != den) {
1048 osys->ch_zoom = true;
1049 osys->zoom.num = num;
1050 osys->zoom.den = den;
1054 void vout_SetWindowState(vout_display_t *vd, unsigned state)
1056 vout_display_owner_sys_t *osys = vd->owner.sys;
1058 vlc_mutex_lock(&osys->lock);
1059 if (osys->wm_state != state) {
1060 osys->ch_wm_state = true;
1061 osys->wm_state = state;
1063 vlc_mutex_unlock(&osys->lock);
1066 void vout_SetDisplayAspect(vout_display_t *vd, unsigned sar_num, unsigned sar_den)
1068 vout_display_owner_sys_t *osys = vd->owner.sys;
1070 if (osys->sar.num != sar_num || osys->sar.den != sar_den) {
1071 osys->ch_sar = true;
1072 osys->sar.num = sar_num;
1073 osys->sar.den = sar_den;
1076 void vout_SetDisplayCrop(vout_display_t *vd,
1077 unsigned crop_num, unsigned crop_den,
1078 unsigned x, unsigned y, unsigned width, unsigned height)
1080 vout_display_owner_sys_t *osys = vd->owner.sys;
1082 if (osys->crop.x != x || osys->crop.y != y ||
1083 osys->crop.width != width || osys->crop.height != height ||
1084 (crop_num > 0 && crop_den > 0 &&
1085 (crop_num != osys->crop.num || crop_den != osys->crop.den))) {
1089 osys->crop.width = width;
1090 osys->crop.height = height;
1091 osys->crop.num = crop_num;
1092 osys->crop.den = crop_den;
1094 osys->ch_crop = true;
1097 vout_opengl_t *vout_GetDisplayOpengl(vout_display_t *vd)
1100 if (vout_display_Control(vd, VOUT_DISPLAY_GET_OPENGL, &gl))
1105 static vout_display_t *DisplayNew(vout_thread_t *vout,
1106 const video_format_t *source_org,
1107 const vout_display_state_t *state,
1109 bool is_wrapper, vout_display_t *wrapper,
1110 mtime_t double_click_timeout,
1111 mtime_t hide_timeout,
1112 const vout_display_owner_t *owner_ptr)
1115 vout_display_owner_sys_t *osys = calloc(1, sizeof(*osys));
1116 vout_display_cfg_t *cfg = &osys->cfg;
1119 osys->wm_state_initial = -1;
1120 osys->sar_initial.num = state->sar.num;
1121 osys->sar_initial.den = state->sar.den;
1122 vout_display_GetDefaultDisplaySize(&cfg->display.width, &cfg->display.height,
1126 osys->is_wrapper = is_wrapper;
1127 osys->wrapper = wrapper;
1129 vlc_mutex_init(&osys->lock);
1131 vlc_mouse_Init(&osys->mouse.state);
1132 osys->mouse.last_moved = mdate();
1133 osys->mouse.double_click_timeout = double_click_timeout;
1134 osys->mouse.hide_timeout = hide_timeout;
1135 osys->is_fullscreen = cfg->is_fullscreen;
1136 osys->display_width = cfg->display.width;
1137 osys->display_height = cfg->display.height;
1138 osys->is_display_filled = cfg->is_display_filled;
1139 osys->width_saved = cfg->display.width;
1140 osys->height_saved = cfg->display.height;
1141 if (osys->is_fullscreen) {
1142 vout_display_cfg_t cfg_windowed = *cfg;
1143 cfg_windowed.is_fullscreen = false;
1144 cfg_windowed.display.width = 0;
1145 cfg_windowed.display.height = 0;
1146 vout_display_GetDefaultDisplaySize(&osys->width_saved,
1147 &osys->height_saved,
1148 source_org, &cfg_windowed);
1150 osys->zoom.num = cfg->zoom.num;
1151 osys->zoom.den = cfg->zoom.den;
1152 osys->wm_state = state->wm_state;
1153 osys->fit_window = 0;
1155 osys->source = *source_org;
1157 video_format_t source = *source_org;
1163 source.i_visible_width =
1164 osys->crop.width = source.i_width;
1165 source.i_visible_height =
1166 osys->crop.height = source.i_height;
1167 osys->crop_saved.num = 0;
1168 osys->crop_saved.den = 0;
1172 osys->sar.num = osys->sar_initial.num ? osys->sar_initial.num : source.i_sar_num;
1173 osys->sar.den = osys->sar_initial.den ? osys->sar_initial.den : source.i_sar_den;
1174 #ifdef ALLOW_DUMMY_VOUT
1175 vlc_mouse_Init(&osys->vout_mouse);
1178 vout_display_owner_t owner;
1182 owner.event = VoutDisplayEvent;
1183 owner.window_new = VoutDisplayNewWindow;
1184 owner.window_del = VoutDisplayDelWindow;
1189 vout_display_t *p_display = vout_display_New(VLC_OBJECT(vout),
1190 module, !is_wrapper,
1191 &source, cfg, &owner);
1197 VoutDisplayCreateRender(p_display);
1199 /* Setup delayed request */
1200 if (osys->sar.num != source_org->i_sar_num ||
1201 osys->sar.den != source_org->i_sar_den)
1202 osys->ch_sar = true;
1203 if (osys->wm_state != osys->wm_state_initial)
1204 osys->ch_wm_state = true;
1205 if (osys->crop.x != source_org->i_x_offset ||
1206 osys->crop.y != source_org->i_y_offset ||
1207 osys->crop.width != source_org->i_visible_width ||
1208 osys->crop.height != source_org->i_visible_height)
1209 osys->ch_crop = true;
1214 void vout_DeleteDisplay(vout_display_t *vd, vout_display_state_t *state)
1216 vout_display_owner_sys_t *osys = vd->owner.sys;
1219 if (!osys->is_wrapper )
1220 state->cfg = osys->cfg;
1221 state->wm_state = osys->wm_state;
1222 state->sar.num = osys->sar_initial.num;
1223 state->sar.den = osys->sar_initial.den;
1226 VoutDisplayDestroyRender(vd);
1227 if (osys->is_wrapper)
1229 vout_display_Delete(vd);
1230 vlc_mutex_destroy(&osys->lock);
1234 /*****************************************************************************
1236 *****************************************************************************/
1237 vout_display_t *vout_NewDisplay(vout_thread_t *vout,
1238 const video_format_t *source,
1239 const vout_display_state_t *state,
1241 mtime_t double_click_timeout,
1242 mtime_t hide_timeout)
1244 return DisplayNew(vout, source, state, module, false, NULL,
1245 double_click_timeout, hide_timeout, NULL);
1248 /*****************************************************************************
1250 *****************************************************************************/
1251 struct vout_display_sys_t {
1252 picture_pool_t *pool;
1253 video_splitter_t *splitter;
1257 picture_t **picture;
1258 vout_display_t **display;
1260 struct video_splitter_owner_t {
1261 vout_display_t *wrapper;
1264 static vout_window_t *SplitterNewWindow(vout_display_t *vd, const vout_window_cfg_t *cfg_ptr)
1266 vout_display_owner_sys_t *osys = vd->owner.sys;
1268 vout_window_cfg_t cfg = *cfg_ptr;
1269 cfg.is_standalone = true;
1270 cfg.x += 0;//output->window.i_x; FIXME
1271 cfg.y += 0;//output->window.i_y;
1273 return vout_NewDisplayWindow(osys->vout, vd, &cfg);
1275 static void SplitterDelWindow(vout_display_t *vd, vout_window_t *window)
1277 vout_display_owner_sys_t *osys = vd->owner.sys;
1279 vout_DeleteDisplayWindow(osys->vout, vd, window);
1281 static void SplitterEvent(vout_display_t *vd, int event, va_list args)
1283 //vout_display_owner_sys_t *osys = vd->owner.sys;
1287 case VOUT_DISPLAY_EVENT_MOUSE_STATE:
1288 case VOUT_DISPLAY_EVENT_MOUSE_MOVED:
1289 case VOUT_DISPLAY_EVENT_MOUSE_PRESSED:
1290 case VOUT_DISPLAY_EVENT_MOUSE_RELEASED:
1294 case VOUT_DISPLAY_EVENT_MOUSE_DOUBLE_CLICK:
1295 case VOUT_DISPLAY_EVENT_KEY:
1296 case VOUT_DISPLAY_EVENT_CLOSE:
1297 case VOUT_DISPLAY_EVENT_FULLSCREEN:
1298 case VOUT_DISPLAY_EVENT_DISPLAY_SIZE:
1299 case VOUT_DISPLAY_EVENT_PICTURES_INVALID:
1300 VoutDisplayEvent(vd, event, args);
1304 msg_Err(vd, "SplitterEvent TODO");
1309 static picture_pool_t *SplitterPool(vout_display_t *vd, unsigned count)
1311 vout_display_sys_t *sys = vd->sys;
1313 sys->pool = picture_pool_NewFromFormat(&vd->fmt, count);
1316 static void SplitterPrepare(vout_display_t *vd, picture_t *picture)
1318 vout_display_sys_t *sys = vd->sys;
1320 picture_Hold(picture);
1322 if (video_splitter_Filter(sys->splitter, sys->picture, picture)) {
1323 for (int i = 0; i < sys->count; i++)
1324 sys->picture[i] = NULL;
1325 picture_Release(picture);
1329 for (int i = 0; i < sys->count; i++) {
1330 if (vout_IsDisplayFiltered(sys->display[i]))
1331 sys->picture[i] = vout_FilterDisplay(sys->display[i], sys->picture[i]);
1332 if (sys->picture[i])
1333 vout_display_Prepare(sys->display[i], sys->picture[i]);
1336 static void SplitterDisplay(vout_display_t *vd, picture_t *picture)
1338 vout_display_sys_t *sys = vd->sys;
1340 for (int i = 0; i < sys->count; i++) {
1341 if (sys->picture[i])
1342 vout_display_Display(sys->display[i], sys->picture[i]);
1344 picture_Release(picture);
1346 static int SplitterControl(vout_display_t *vd, int query, va_list args)
1348 return VLC_EGENERIC;
1350 static void SplitterManage(vout_display_t *vd)
1352 vout_display_sys_t *sys = vd->sys;
1354 for (int i = 0; i < sys->count; i++)
1355 vout_ManageDisplay(sys->display[i], true);
1358 static int SplitterPictureNew(video_splitter_t *splitter, picture_t *picture[])
1360 vout_display_sys_t *wsys = splitter->p_owner->wrapper->sys;
1362 for (int i = 0; i < wsys->count; i++) {
1363 if (vout_IsDisplayFiltered(wsys->display[i])) {
1364 /* TODO use a pool ? */
1365 picture[i] = picture_NewFromFormat(&wsys->display[i]->source);
1367 picture_pool_t *pool = vout_display_Pool(wsys->display[i], 1);
1368 picture[i] = pool ? picture_pool_Get(pool) : NULL;
1371 for (int j = 0; j < i; j++)
1372 picture_Release(picture[j]);
1373 return VLC_EGENERIC;
1378 static void SplitterPictureDel(video_splitter_t *splitter, picture_t *picture[])
1380 vout_display_sys_t *wsys = splitter->p_owner->wrapper->sys;
1382 for (int i = 0; i < wsys->count; i++)
1383 picture_Release(picture[i]);
1385 static void SplitterClose(vout_display_t *vd)
1387 vout_display_sys_t *sys = vd->sys;
1390 video_splitter_t *splitter = sys->splitter;
1391 free(splitter->p_owner);
1392 video_splitter_Delete(splitter);
1395 picture_pool_Delete(sys->pool);
1398 for (int i = 0; i < sys->count; i++)
1399 vout_DeleteDisplay(sys->display[i], NULL);
1400 TAB_CLEAN(sys->count, sys->display);
1406 vout_display_t *vout_NewSplitter(vout_thread_t *vout,
1407 const video_format_t *source,
1408 const vout_display_state_t *state,
1410 const char *splitter_module,
1411 mtime_t double_click_timeout,
1412 mtime_t hide_timeout)
1414 video_splitter_t *splitter =
1415 video_splitter_New(VLC_OBJECT(vout), splitter_module, source);
1420 vout_display_t *wrapper =
1421 DisplayNew(vout, source, state, module, true, NULL,
1422 double_click_timeout, hide_timeout, NULL);
1424 video_splitter_Delete(splitter);
1427 vout_display_sys_t *sys = malloc(sizeof(*sys));
1430 sys->picture = calloc(splitter->i_output, sizeof(*sys->picture));
1433 sys->splitter = splitter;
1436 wrapper->pool = SplitterPool;
1437 wrapper->prepare = SplitterPrepare;
1438 wrapper->display = SplitterDisplay;
1439 wrapper->control = SplitterControl;
1440 wrapper->manage = SplitterManage;
1444 video_splitter_owner_t *owner = malloc(sizeof(*owner));
1447 owner->wrapper = wrapper;
1448 splitter->p_owner = owner;
1449 splitter->pf_picture_new = SplitterPictureNew;
1450 splitter->pf_picture_del = SplitterPictureDel;
1453 TAB_INIT(sys->count, sys->display);
1454 for (int i = 0; i < splitter->i_output; i++) {
1455 vout_display_owner_t owner;
1457 owner.event = SplitterEvent;
1458 owner.window_new = SplitterNewWindow;
1459 owner.window_del = SplitterDelWindow;
1461 const video_splitter_output_t *output = &splitter->p_output[i];
1462 vout_display_state_t ostate;
1464 memset(&ostate, 0, sizeof(ostate));
1465 ostate.cfg.is_fullscreen = false;
1466 ostate.cfg.display = state->cfg.display;
1467 ostate.cfg.align.horizontal = 0; /* TODO */
1468 ostate.cfg.align.vertical = 0; /* TODO */
1469 ostate.cfg.is_display_filled = true;
1470 ostate.cfg.zoom.num = 1;
1471 ostate.cfg.zoom.den = 1;
1473 vout_display_t *vd = DisplayNew(vout, &output->fmt, &ostate,
1474 output->psz_module ? output->psz_module : module,
1476 double_click_timeout, hide_timeout, &owner);
1478 vout_DeleteDisplay(wrapper, NULL);
1481 TAB_APPEND(sys->count, sys->display, vd);
1487 /*****************************************************************************
1489 *****************************************************************************/
1490 #include "vout_internal.h"
1491 void vout_SendDisplayEventMouse(vout_thread_t *vout, const vlc_mouse_t *m)
1495 /* The check on p_spu is needed as long as ALLOW_DUMMY_VOUT is defined */
1496 if (vout->p->p_spu && spu_ProcessMouse( vout->p->p_spu, m, &vout->p->display.vd->source))
1499 vlc_mutex_lock( &vout->p->vfilter_lock );
1500 if (vout->p->vfilter_chain) {
1501 if (!filter_chain_MouseFilter(vout->p->vfilter_chain, &tmp, m))
1504 vlc_mutex_unlock( &vout->p->vfilter_lock );
1506 if (vlc_mouse_HasMoved(&vout->p->mouse, m)) {
1507 vout_SendEventMouseMoved(vout, m->i_x, m->i_y);
1509 if (vlc_mouse_HasButton(&vout->p->mouse, m)) {
1510 static const int buttons[] = {
1512 MOUSE_BUTTON_CENTER,
1514 MOUSE_BUTTON_WHEEL_UP,
1515 MOUSE_BUTTON_WHEEL_DOWN,
1518 for (int i = 0; buttons[i] >= 0; i++) {
1519 const int button = buttons[i];
1520 if (vlc_mouse_HasPressed(&vout->p->mouse, m, button))
1521 vout_SendEventMousePressed(vout, button);
1522 else if (vlc_mouse_HasReleased(&vout->p->mouse, m, button))
1523 vout_SendEventMouseReleased(vout, button);
1526 if (m->b_double_click)
1527 vout_SendEventMouseDoubleClick(vout);
1528 vout->p->mouse = *m;
1530 #ifdef ALLOW_DUMMY_VOUT
1531 static void DummyVoutSendDisplayEventMouse(vout_thread_t *vout, vlc_mouse_t *fallback, const vlc_mouse_t *m)
1533 vout_thread_sys_t p;
1536 p.mouse = *fallback;
1537 vlc_mutex_init(&p.vfilter_lock);
1538 p.vfilter_chain = NULL;
1542 vout_SendDisplayEventMouse(vout, m);
1543 if (vout->p == &p) {
1544 vlc_mutex_destroy(&p.vfilter_lock);
1545 *fallback = p.mouse;