3
* @brief X C Bindings video output module for VLC media player
5
/*****************************************************************************
6
* Copyright © 2009 Rémi Denis-Courmont
8
* This library is free software; you can redistribute it and/or
9
* modify it under the terms of the GNU General Public License
10
* as published by the Free Software Foundation; either version 2
11
* of the License, or (at your option) any later version.
13
* This library is distributed in the hope that it will be useful,
14
* but WITHOUT ANY WARRANTY; without even the implied warranty of
15
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16
* GNU General Public License for more details.
18
* You should have received a copy of the GNU General Public
19
* License along with this library; if not, write to the Free Software
20
* Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
21
****************************************************************************/
34
#include <vlc_common.h>
35
#include <vlc_plugin.h>
36
#include <vlc_vout_display.h>
37
#include <vlc_picture_pool.h>
38
#include <vlc_dialog.h>
42
#define ADAPTOR_TEXT N_("XVideo adaptor number")
43
#define ADAPTOR_LONGTEXT N_( \
44
"XVideo hardware adaptor to use. By default, VLC will " \
45
"use the first functional adaptor.")
47
#define SHM_TEXT N_("Use shared memory")
48
#define SHM_LONGTEXT N_( \
49
"Use shared memory to communicate between VLC and the X server.")
51
static int Open (vlc_object_t *);
52
static void Close (vlc_object_t *);
58
set_shortname (N_("XVideo"))
59
set_description (N_("XVideo output (XCB)"))
60
set_category (CAT_VIDEO)
61
set_subcategory (SUBCAT_VIDEO_VOUT)
62
set_capability ("vout display", 155)
63
set_callbacks (Open, Close)
65
add_integer ("xvideo-adaptor", -1, NULL,
66
ADAPTOR_TEXT, ADAPTOR_LONGTEXT, true)
67
add_bool ("x11-shm", true, NULL, SHM_TEXT, SHM_LONGTEXT, true)
68
add_deprecated_alias ("xvideo-shm")
69
add_shortcut ("xcb-xv")
71
add_shortcut ("xvideo")
74
#define MAX_PICTURES (VOUT_MAX_PICTURES)
76
struct vout_display_sys_t
78
xcb_connection_t *conn;
79
vout_window_t *embed;/* VLC window */
81
xcb_cursor_t cursor; /* blank cursor */
82
xcb_window_t window; /* drawable X window */
83
xcb_gcontext_t gc; /* context to put images */
84
xcb_xv_port_t port; /* XVideo port */
85
uint32_t id; /* XVideo format */
86
uint16_t width; /* display width */
87
uint16_t height; /* display height */
88
uint32_t data_size; /* picture byte size (for non-SHM) */
89
bool swap_uv; /* U/V pointer must be swapped in a picture */
90
bool shm; /* whether to use MIT-SHM */
91
bool visible; /* whether it makes sense to draw at all */
93
xcb_xv_query_image_attributes_reply_t *att;
94
picture_pool_t *pool; /* picture pool */
95
picture_resource_t resource[MAX_PICTURES];
98
static picture_pool_t *Pool (vout_display_t *, unsigned);
99
static void Display (vout_display_t *, picture_t *);
100
static int Control (vout_display_t *, int, va_list);
101
static void Manage (vout_display_t *);
104
* Check that the X server supports the XVideo extension.
106
static bool CheckXVideo (vout_display_t *vd, xcb_connection_t *conn)
108
xcb_xv_query_extension_reply_t *r;
109
xcb_xv_query_extension_cookie_t ck = xcb_xv_query_extension (conn);
112
/* We need XVideo 2.2 for PutImage */
113
r = xcb_xv_query_extension_reply (conn, ck, NULL);
115
msg_Dbg (vd, "XVideo extension not available");
118
msg_Dbg (vd, "XVideo extension v%"PRIu8".%"PRIu8" unknown",
122
msg_Dbg (vd, "XVideo extension v%"PRIu8".%"PRIu8" too old",
126
msg_Dbg (vd, "using XVideo extension v%"PRIu8".%"PRIu8,
134
static vlc_fourcc_t ParseFormat (vout_display_t *vd,
135
const xcb_xv_image_format_info_t *restrict f)
137
if (f->byte_order != ORDER && f->bpp != 8)
138
return 0; /* Argh! */
142
case XCB_XV_IMAGE_FORMAT_INFO_TYPE_RGB:
143
switch (f->num_planes)
150
return VLC_CODEC_RGB32;
152
return 0; /* ARGB -> VLC cannot do that currently */
156
return VLC_CODEC_RGB24;
160
return VLC_CODEC_RGB16;
162
return VLC_CODEC_RGB15;
166
return VLC_CODEC_RGB8;
171
msg_Err (vd, "unknown XVideo RGB format %"PRIx32" (%.4s)",
173
msg_Dbg (vd, " %"PRIu8" planes, %"PRIu8" bits/pixel, "
174
"depth %"PRIu8, f->num_planes, f->bpp, f->depth);
177
case XCB_XV_IMAGE_FORMAT_INFO_TYPE_YUV:
178
if (f->u_sample_bits != f->v_sample_bits
179
|| f->vhorz_u_period != f->vhorz_v_period
180
|| f->vvert_u_period != f->vvert_v_period
181
|| f->y_sample_bits != 8 || f->u_sample_bits != 8
182
|| f->vhorz_y_period != 1 || f->vvert_y_period != 1)
184
switch (f->num_planes)
190
if (f->vhorz_u_period == 1 && f->vvert_u_period == 1)
191
return VLC_CODEC_I444;
194
if (f->vhorz_u_period == 2 && f->vvert_u_period == 1)
196
if (!strcmp ((const char *)f->vcomp_order, "YUYV"))
197
return VLC_CODEC_YUYV;
198
if (!strcmp ((const char *)f->vcomp_order, "UYVY"))
199
return VLC_CODEC_UYVY;
208
if (f->vhorz_u_period == 2 && f->vvert_u_period == 2)
210
if (!strcmp ((const char *)f->vcomp_order, "YVU"))
211
return VLC_CODEC_YV12;
212
if (!strcmp ((const char *)f->vcomp_order, "YUV"))
213
return VLC_CODEC_I420;
219
msg_Err (vd, "unknown XVideo YUV format %"PRIx32" (%.4s)", f->id,
221
msg_Dbg (vd, " %"PRIu8" planes, %"PRIu32" bits/pixel, "
222
"%"PRIu32"/%"PRIu32"/%"PRIu32" bits/sample", f->num_planes,
223
f->bpp, f->y_sample_bits, f->u_sample_bits, f->v_sample_bits);
224
msg_Dbg (vd, " period: %"PRIu32"/%"PRIu32"/%"PRIu32"x"
225
"%"PRIu32"/%"PRIu32"/%"PRIu32,
226
f->vhorz_y_period, f->vhorz_u_period, f->vhorz_v_period,
227
f->vvert_y_period, f->vvert_u_period, f->vvert_v_period);
228
msg_Warn (vd, " order: %.32s", f->vcomp_order);
235
static const xcb_xv_image_format_info_t *
236
FindFormat (vout_display_t *vd,
237
vlc_fourcc_t chroma, const video_format_t *fmt,
239
const xcb_xv_list_image_formats_reply_t *list,
240
xcb_xv_query_image_attributes_reply_t **restrict pa)
242
xcb_connection_t *conn = vd->sys->conn;
243
const xcb_xv_image_format_info_t *f, *end;
246
f = xcb_xv_list_image_formats_format (list);
248
f = (xcb_xv_image_format_info_t *) (list + 1);
250
end = f + xcb_xv_list_image_formats_format_length (list);
253
if (chroma != ParseFormat (vd, f))
256
/* VLC pads scanline to 16 pixels internally */
257
unsigned width = fmt->i_width;
258
unsigned height = fmt->i_height;
259
xcb_xv_query_image_attributes_reply_t *i;
260
i = xcb_xv_query_image_attributes_reply (conn,
261
xcb_xv_query_image_attributes (conn, port, f->id,
262
width, height), NULL);
266
if (i->width != width || i->height != height)
268
msg_Warn (vd, "incompatible size %ux%u -> %"PRIu32"x%"PRIu32,
269
fmt->i_width, fmt->i_height,
270
i->width, i->height);
271
var_Create (vd->p_libvlc, "xvideo-resolution-error", VLC_VAR_BOOL);
272
if (!var_GetBool (vd->p_libvlc, "xvideo-resolution-error"))
274
dialog_FatalWait (vd, _("Video acceleration not available"),
275
_("Your video output acceleration driver does not support "
276
"the required resolution: %ux%u pixels. The maximum "
277
"supported resolution is %"PRIu32"x%"PRIu32".\n"
278
"Video output acceleration will be disabled. However, "
279
"rendering videos with overly large resolution "
280
"may cause severe performance degration."),
281
width, height, i->width, i->height);
282
var_SetBool (vd->p_libvlc, "xvideo-resolution-error", true);
295
* Probe the X server.
297
static int Open (vlc_object_t *obj)
299
vout_display_t *vd = (vout_display_t *)obj;
300
vout_display_sys_t *p_sys;
302
if (!var_CreateGetBool (obj, "overlay"))
304
p_sys = malloc (sizeof (*p_sys));
311
xcb_connection_t *conn;
312
const xcb_screen_t *screen;
314
p_sys->embed = GetWindow (vd, &conn, &screen, &depth);
315
if (p_sys->embed == NULL)
324
p_sys->swap_uv = false;
326
if (!CheckXVideo (vd, conn))
328
msg_Warn (vd, "Please enable XVideo 2.2 for faster video display");
332
p_sys->window = xcb_generate_id (conn);
333
xcb_pixmap_t pixmap = xcb_generate_id (conn);
335
/* Cache adaptors infos */
336
xcb_xv_query_adaptors_reply_t *adaptors =
337
xcb_xv_query_adaptors_reply (conn,
338
xcb_xv_query_adaptors (conn, p_sys->embed->handle.xid), NULL);
339
if (adaptors == NULL)
342
int forced_adaptor = var_CreateGetInteger (obj, "xvideo-adaptor");
345
video_format_t fmt = vd->fmt;
346
bool found_adaptor = false;
348
xcb_xv_adaptor_info_iterator_t it;
349
for (it = xcb_xv_query_adaptors_info_iterator (adaptors);
350
it.rem > 0 && !found_adaptor;
351
xcb_xv_adaptor_info_next (&it))
353
const xcb_xv_adaptor_info_t *a = it.data;
356
if (forced_adaptor != -1 && forced_adaptor != 0)
362
if (!(a->type & XCB_XV_TYPE_INPUT_MASK)
363
|| !(a->type & XCB_XV_TYPE_IMAGE_MASK))
366
xcb_xv_list_image_formats_reply_t *r =
367
xcb_xv_list_image_formats_reply (conn,
368
xcb_xv_list_image_formats (conn, a->base_id), NULL);
372
/* Look for an image format */
373
const xcb_xv_image_format_info_t *xfmt = NULL;
374
const vlc_fourcc_t *chromas, chromas_default[] = {
383
if (vlc_fourcc_IsYUV (fmt.i_chroma))
384
chromas = vlc_fourcc_GetYUVFallback (fmt.i_chroma);
386
chromas = chromas_default;
389
for (size_t i = 0; chromas[i]; i++)
394
if ((chroma == VLC_CODEC_I420 || chroma == VLC_CODEC_YV12)
396
&& !memcmp ("OMAP", xcb_xv_adaptor_info_name (a), 4))
398
msg_Dbg (vd, "skipping slow I420 format");
399
continue; /* OMAP framebuffer sucks at YUV 4:2:0 */
402
xfmt = FindFormat (vd, chroma, &fmt, a->base_id, r, &p_sys->att);
405
p_sys->id = xfmt->id;
406
p_sys->swap_uv = vlc_fourcc_AreUVPlanesSwapped (fmt.i_chroma,
409
fmt.i_chroma = chroma;
410
if (xfmt->type == XCB_XV_IMAGE_FORMAT_INFO_TYPE_RGB)
412
fmt.i_rmask = xfmt->red_mask;
413
fmt.i_gmask = xfmt->green_mask;
414
fmt.i_bmask = xfmt->blue_mask;
420
if (xfmt == NULL) /* No acceptable image formats */
424
for (unsigned i = 0; i < a->num_ports; i++)
426
xcb_xv_port_t port = a->base_id + i;
427
xcb_xv_grab_port_reply_t *gr =
428
xcb_xv_grab_port_reply (conn,
429
xcb_xv_grab_port (conn, port, XCB_CURRENT_TIME), NULL);
430
uint8_t result = gr ? gr->result : 0xff;
438
msg_Dbg (vd, "cannot grab port %"PRIu32": Xv error %"PRIu8, port,
441
continue; /* No usable port */
444
/* Found port - initialize selected format */
445
name = strndup (xcb_xv_adaptor_info_name (a), a->name_size);
448
msg_Dbg (vd, "using adaptor %s", name);
451
msg_Dbg (vd, "using port %"PRIu32, p_sys->port);
452
msg_Dbg (vd, "using image format 0x%"PRIx32, p_sys->id);
454
/* Look for an X11 visual, create a window */
455
xcb_xv_format_t *f = xcb_xv_adaptor_info_formats (a);
456
for (uint_fast16_t i = a->num_formats; i > 0; i--, f++)
458
if (f->depth != screen->root_depth)
459
continue; /* this would fail anyway */
464
XCB_CW_BORDER_PIXMAP |
465
XCB_CW_BORDER_PIXEL |
468
const uint32_t list[] = {
469
/* XCB_CW_BACK_PIXMAP */
471
/* XCB_CW_BACK_PIXEL */
473
/* XCB_CW_BORDER_PIXMAP */
475
/* XCB_CW_BORDER_PIXEL */
477
/* XCB_CW_EVENT_MASK */
478
XCB_EVENT_MASK_VISIBILITY_CHANGE,
479
/* XCB_CW_COLORMAP */
480
screen->default_colormap,
485
xcb_create_pixmap (conn, f->depth, pixmap, screen->root, 1, 1);
486
c = xcb_create_window_checked (conn, f->depth, p_sys->window,
487
p_sys->embed->handle.xid, 0, 0, 1, 1, 0,
488
XCB_WINDOW_CLASS_INPUT_OUTPUT, f->visual, mask, list);
490
if (!CheckError (vd, conn, "cannot create X11 window", c))
492
msg_Dbg (vd, "using X11 visual ID 0x%"PRIx32
493
" (depth: %"PRIu8")", f->visual, f->depth);
494
msg_Dbg (vd, "using X11 window 0x%08"PRIx32, p_sys->window);
498
xcb_xv_ungrab_port (conn, p_sys->port, XCB_CURRENT_TIME);
499
msg_Dbg (vd, "no usable X11 visual");
500
continue; /* No workable XVideo format (visual/depth) */
503
found_adaptor = true;
509
msg_Err (vd, "no available XVideo adaptor");
514
xcb_map_window (conn, p_sys->window);
516
vout_display_place_t place;
518
vout_display_PlacePicture (&place, &vd->source, vd->cfg, false);
519
p_sys->width = place.width;
520
p_sys->height = place.height;
523
const uint32_t values[] = {
524
place.x, place.y, place.width, place.height };
525
xcb_configure_window (conn, p_sys->window,
526
XCB_CONFIG_WINDOW_X | XCB_CONFIG_WINDOW_Y |
527
XCB_CONFIG_WINDOW_WIDTH |
528
XCB_CONFIG_WINDOW_HEIGHT,
531
p_sys->visible = false;
533
/* Create graphic context */
534
p_sys->gc = xcb_generate_id (conn);
535
xcb_create_gc (conn, p_sys->gc, p_sys->window, 0, NULL);
536
msg_Dbg (vd, "using X11 graphic context 0x%08"PRIx32, p_sys->gc);
539
p_sys->cursor = CreateBlankCursor (conn, screen);
541
CheckSHM (obj, conn, &p_sys->shm);
544
vout_display_info_t info = vd->info;
545
info.has_pictures_invalid = false;
547
/* Setup vout_display_t once everything is fine */
553
vd->display = Display;
554
vd->control = Control;
558
vout_display_SendEventFullscreen (vd, false);
559
unsigned width, height;
560
if (!GetWindowSize (p_sys->embed, conn, &width, &height))
561
vout_display_SendEventDisplaySize (vd, width, height, false);
572
* Disconnect from the X server.
574
static void Close (vlc_object_t *obj)
576
vout_display_t *vd = (vout_display_t *)obj;
577
vout_display_sys_t *p_sys = vd->sys;
581
for (unsigned i = 0; i < MAX_PICTURES; i++)
583
picture_resource_t *res = &p_sys->resource[i];
585
if (!res->p->p_pixels)
587
PictureResourceFree (res, NULL);
589
picture_pool_Delete (p_sys->pool);
592
/* show the default cursor */
593
xcb_change_window_attributes (p_sys->conn, p_sys->embed->handle.xid, XCB_CW_CURSOR,
594
&(uint32_t) { XCB_CURSOR_NONE });
595
xcb_flush (p_sys->conn);
598
xcb_disconnect (p_sys->conn);
599
vout_display_DeleteWindow (vd, p_sys->embed);
604
* Return a direct buffer
606
static picture_pool_t *Pool (vout_display_t *vd, unsigned requested_count)
608
vout_display_sys_t *p_sys = vd->sys;
609
(void)requested_count;
613
memset (p_sys->resource, 0, sizeof(p_sys->resource));
615
const uint32_t *pitches =
616
xcb_xv_query_image_attributes_pitches (p_sys->att);
617
const uint32_t *offsets =
618
xcb_xv_query_image_attributes_offsets (p_sys->att);
619
p_sys->data_size = p_sys->att->data_size;
622
picture_t *pic_array[MAX_PICTURES];
623
for (count = 0; count < MAX_PICTURES; count++)
625
picture_resource_t *res = &p_sys->resource[count];
627
for (int i = 0; i < __MIN (p_sys->att->num_planes, PICTURE_PLANE_MAX); i++)
630
((i + 1 < p_sys->att->num_planes ? offsets[i+1] :
631
p_sys->data_size) - offsets[i]) / pitches[i];
632
res->p[i].i_pitch = pitches[i];
634
if (PictureResourceAlloc (vd, res, p_sys->att->data_size,
635
p_sys->conn, p_sys->shm))
638
/* Allocate further planes as specified by XVideo */
639
/* We assume that offsets[0] is zero */
640
for (int i = 1; i < __MIN (p_sys->att->num_planes, PICTURE_PLANE_MAX); i++)
641
res->p[i].p_pixels = res->p[0].p_pixels + offsets[i];
643
{ /* YVU: swap U and V planes */
644
uint8_t *buf = res->p[2].p_pixels;
645
res->p[2].p_pixels = res->p[1].p_pixels;
646
res->p[1].p_pixels = buf;
649
pic_array[count] = picture_NewFromResource (&vd->fmt, res);
650
if (!pic_array[count])
652
PictureResourceFree (res, p_sys->conn);
653
memset (res, 0, sizeof(*res));
661
p_sys->pool = picture_pool_New (count, pic_array);
662
/* TODO release picture resources if NULL */
663
xcb_flush (p_sys->conn);
670
* Sends an image to the X server.
672
static void Display (vout_display_t *vd, picture_t *pic)
674
vout_display_sys_t *p_sys = vd->sys;
675
xcb_shm_seg_t segment = pic->p_sys->segment;
676
xcb_void_cookie_t ck;
681
ck = xcb_xv_shm_put_image_checked (p_sys->conn, p_sys->port,
682
p_sys->window, p_sys->gc, segment, p_sys->id, 0,
683
/* Src: */ vd->source.i_x_offset,
684
vd->source.i_y_offset,
685
vd->source.i_visible_width,
686
vd->source.i_visible_height,
687
/* Dst: */ 0, 0, p_sys->width, p_sys->height,
688
/* Memory: */ pic->p->i_pitch / pic->p->i_pixel_pitch,
689
pic->p->i_lines, false);
691
ck = xcb_xv_put_image_checked (p_sys->conn, p_sys->port, p_sys->window,
692
p_sys->gc, p_sys->id,
693
vd->source.i_x_offset,
694
vd->source.i_y_offset,
695
vd->source.i_visible_width,
696
vd->source.i_visible_height,
697
0, 0, p_sys->width, p_sys->height,
698
pic->p->i_pitch / pic->p->i_pixel_pitch,
700
p_sys->data_size, pic->p->p_pixels);
702
/* Wait for reply. See x11.c for rationale. */
703
xcb_generic_error_t *e = xcb_request_check (p_sys->conn, ck);
706
msg_Dbg (vd, "%s: X11 error %d", "cannot put image", e->error_code);
710
picture_Release (pic);
713
static int Control (vout_display_t *vd, int query, va_list ap)
715
vout_display_sys_t *p_sys = vd->sys;
719
case VOUT_DISPLAY_CHANGE_FULLSCREEN:
721
const vout_display_cfg_t *c = va_arg (ap, const vout_display_cfg_t *);
722
return vout_window_SetFullScreen (p_sys->embed, c->is_fullscreen);
725
case VOUT_DISPLAY_CHANGE_DISPLAY_SIZE:
726
case VOUT_DISPLAY_CHANGE_DISPLAY_FILLED:
727
case VOUT_DISPLAY_CHANGE_ZOOM:
728
case VOUT_DISPLAY_CHANGE_SOURCE_ASPECT:
729
case VOUT_DISPLAY_CHANGE_SOURCE_CROP:
731
const vout_display_cfg_t *cfg;
732
const video_format_t *source;
733
bool is_forced = false;
735
if (query == VOUT_DISPLAY_CHANGE_SOURCE_ASPECT
736
|| query == VOUT_DISPLAY_CHANGE_SOURCE_CROP)
738
source = (const video_format_t *)va_arg (ap, const video_format_t *);
743
source = &vd->source;
744
cfg = (const vout_display_cfg_t*)va_arg (ap, const vout_display_cfg_t *);
745
if (query == VOUT_DISPLAY_CHANGE_DISPLAY_SIZE)
746
is_forced = (bool)va_arg (ap, int);
750
if (query == VOUT_DISPLAY_CHANGE_DISPLAY_SIZE
752
&& (cfg->display.width != vd->cfg->display.width
753
||cfg->display.height != vd->cfg->display.height)
754
&& vout_window_SetSize (p_sys->embed,
756
cfg->display.height))
759
vout_display_place_t place;
760
vout_display_PlacePicture (&place, source, cfg, false);
761
p_sys->width = place.width;
762
p_sys->height = place.height;
764
/* Move the picture within the window */
765
const uint32_t values[] = { place.x, place.y,
766
place.width, place.height, };
767
xcb_configure_window (p_sys->conn, p_sys->window,
768
XCB_CONFIG_WINDOW_X | XCB_CONFIG_WINDOW_Y
769
| XCB_CONFIG_WINDOW_WIDTH | XCB_CONFIG_WINDOW_HEIGHT,
771
xcb_flush (p_sys->conn);
774
case VOUT_DISPLAY_CHANGE_WINDOW_STATE:
776
unsigned state = va_arg (ap, unsigned);
777
return vout_window_SetState (p_sys->embed, state);
780
/* Hide the mouse. It will be send when
781
* vout_display_t::info.b_hide_mouse is false */
782
case VOUT_DISPLAY_HIDE_MOUSE:
783
xcb_change_window_attributes (p_sys->conn, p_sys->embed->handle.xid,
784
XCB_CW_CURSOR, &(uint32_t){ p_sys->cursor });
785
xcb_flush (p_sys->conn);
787
case VOUT_DISPLAY_RESET_PICTURES:
790
msg_Err (vd, "Unknown request in XCB vout display");
795
static void Manage (vout_display_t *vd)
797
vout_display_sys_t *p_sys = vd->sys;
799
ManageEvent (vd, p_sys->conn, &p_sys->visible);
added
removed
.pc/bp-xvideo-color-key-automatic-painting.patch/modules/video_output/xcb/xvideo.c
