Updated xcb vout module to the new API.
[vlc.git] / modules / video_output / xcb / xvideo.c
1 /**
2  * @file xvideo.c
3  * @brief X C Bindings video output module for VLC media player
4  */
5 /*****************************************************************************
6  * Copyright © 2009 Rémi Denis-Courmont
7  *
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.0
11  * of the License, or (at your option) any later version.
12  *
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.
17  *
18  * You should have received a copy of the GNU Lesser 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  ****************************************************************************/
22
23 #ifdef HAVE_CONFIG_H
24 # include <config.h>
25 #endif
26
27 #include <stdlib.h>
28 #include <assert.h>
29
30 #include <xcb/xcb.h>
31 #include <xcb/shm.h>
32 #include <xcb/xv.h>
33
34 #include <vlc_common.h>
35 #include <vlc_plugin.h>
36 #include <vlc_vout.h>
37 #include <vlc_vout_window.h>
38
39 #include "xcb_vlc.h"
40
41 #define DISPLAY_TEXT N_("X11 display")
42 #define DISPLAY_LONGTEXT N_( \
43     "X11 hardware display to use. By default VLC will " \
44     "use the value of the DISPLAY environment variable.")
45
46 #define SHM_TEXT N_("Use shared memory")
47 #define SHM_LONGTEXT N_( \
48     "Use shared memory to communicate between VLC and the X server.")
49
50 static int  Open (vlc_object_t *);
51 static void Close (vlc_object_t *);
52
53 /*
54  * Module descriptor
55  */
56 vlc_module_begin ()
57     set_shortname (N_("XVideo"))
58     set_description (N_("(Experimental) XVideo output"))
59     set_category (CAT_VIDEO)
60     set_subcategory (SUBCAT_VIDEO_VOUT)
61     set_capability ("video output", 0)
62     set_callbacks (Open, Close)
63
64     add_string ("x11-display", NULL, NULL,
65                 DISPLAY_TEXT, DISPLAY_LONGTEXT, true)
66     add_bool ("x11-shm", true, NULL, SHM_TEXT, SHM_LONGTEXT, true)
67     add_shortcut ("xcb-xv")
68 vlc_module_end ()
69
70 struct vout_sys_t
71 {
72     xcb_connection_t *conn;
73     xcb_xv_query_adaptors_reply_t *adaptors;
74     vout_window_t *embed;/* VLC window */
75
76     xcb_window_t window; /* drawable X window */
77     xcb_gcontext_t gc;   /* context to put images */
78     xcb_xv_port_t port;  /* XVideo port */
79     uint32_t id;         /* XVideo format */
80     uint16_t width;      /* display width */
81     uint16_t height;     /* display height */
82     uint32_t data_size;  /* picture byte size (for non-SHM) */
83     bool shm;            /* whether to use MIT-SHM */
84 };
85
86 static int Init (vout_thread_t *);
87 static void Deinit (vout_thread_t *);
88 static void Display (vout_thread_t *, picture_t *);
89 static int Manage (vout_thread_t *);
90 static int Control (vout_thread_t *, int, va_list);
91
92 int CheckError (vout_thread_t *vout, const char *str, xcb_void_cookie_t ck)
93 {
94     xcb_generic_error_t *err;
95
96     err = xcb_request_check (vout->p_sys->conn, ck);
97     if (err)
98     {
99         msg_Err (vout, "%s: X11 error %d", str, err->error_code);
100         return VLC_EGENERIC;
101     }
102     return VLC_SUCCESS;
103 }
104
105 /**
106  * Check that the X server supports the XVideo extension.
107  */
108 static bool CheckXVideo (vout_thread_t *vout, xcb_connection_t *conn)
109 {
110     xcb_xv_query_extension_reply_t *r;
111     xcb_xv_query_extension_cookie_t ck = xcb_xv_query_extension (conn);
112     bool ok = false;
113
114     r = xcb_xv_query_extension_reply (conn, ck, NULL);
115     if (r != NULL)
116     {   /* We need XVideo 2.2 for PutImage */
117         if ((r->major > 2) || (r->major == 2 && r->minor >= 2))
118         {
119             msg_Dbg (vout, "using XVideo extension v%"PRIu8".%"PRIu8,
120                      r->major, r->minor);
121             ok = true;
122         }
123         else
124             msg_Dbg (vout, "XVideo extension too old (v%"PRIu8".%"PRIu8,
125                      r->major, r->minor);
126         free (r);
127     }
128     else
129         msg_Dbg (vout, "XVideo extension not available");
130     return ok;
131 }
132
133 /**
134  * Get a list of XVideo adaptors for a given window.
135  */
136 static xcb_xv_query_adaptors_reply_t *GetAdaptors (vout_window_t *wnd,
137                                                    xcb_connection_t *conn)
138 {
139     xcb_xv_query_adaptors_cookie_t ck;
140
141     ck = xcb_xv_query_adaptors (conn, wnd->handle.xid);
142     return xcb_xv_query_adaptors_reply (conn, ck, NULL);
143 }
144
145 #define p_vout vout
146
147 /**
148  * Probe the X server.
149  */
150 static int Open (vlc_object_t *obj)
151 {
152     vout_thread_t *vout = (vout_thread_t *)obj;
153     vout_sys_t *p_sys = malloc (sizeof (*p_sys));
154     if (p_sys == NULL)
155         return VLC_ENOMEM;
156
157     vout->p_sys = p_sys;
158
159     /* Connect to X */
160     p_sys->conn = Connect (obj);
161     if (p_sys->conn == NULL)
162     {
163         free (p_sys);
164         return VLC_EGENERIC;
165     }
166
167     if (!CheckXVideo (vout, p_sys->conn))
168     {
169         msg_Warn (vout, "Please enable XVideo 2.2 for faster video display");
170         xcb_disconnect (p_sys->conn);
171         free (p_sys);
172         return VLC_EGENERIC;
173     }
174
175     const xcb_screen_t *screen;
176     p_sys->embed = GetWindow (vout, p_sys->conn, &screen, &p_sys->shm);
177     if (p_sys->embed == NULL)
178     {
179         xcb_disconnect (p_sys->conn);
180         free (p_sys);
181         return VLC_EGENERIC;
182     }
183
184     /* Cache adaptors infos */
185     p_sys->adaptors = GetAdaptors (p_sys->embed, p_sys->conn);
186     if (p_sys->adaptors == NULL)
187         goto error;
188
189     /* Create window */
190     {
191         const uint32_t mask =
192             /* XCB_CW_EVENT_MASK */
193             XCB_EVENT_MASK_BUTTON_PRESS | XCB_EVENT_MASK_BUTTON_RELEASE |
194             XCB_EVENT_MASK_POINTER_MOTION;
195         xcb_void_cookie_t c;
196         xcb_window_t window = xcb_generate_id (p_sys->conn);
197
198         c = xcb_create_window_checked (p_sys->conn, screen->root_depth, window,
199                                        p_sys->embed->handle.xid, 0, 0, 1, 1, 0,
200                                        XCB_WINDOW_CLASS_INPUT_OUTPUT,
201                                        screen->root_visual,
202                                        XCB_CW_EVENT_MASK, &mask);
203         if (CheckError (vout, "cannot create X11 window", c))
204             goto error;
205         p_sys->window = window;
206         msg_Dbg (vout, "using X11 window %08"PRIx32, p_sys->window);
207         xcb_map_window (p_sys->conn, window);
208     }
209
210     p_sys->gc = xcb_generate_id (p_sys->conn);
211     xcb_create_gc (p_sys->conn, p_sys->gc, p_sys->window, 0, NULL);
212     msg_Dbg (vout, "using X11 graphic context %08"PRIx32, p_sys->gc);
213
214     vout->pf_init = Init;
215     vout->pf_end = Deinit;
216     vout->pf_display = Display;
217     vout->pf_manage = Manage;
218     vout->pf_control = Control;
219     return VLC_SUCCESS;
220
221 error:
222     Close (obj);
223     return VLC_EGENERIC;
224 }
225
226
227 /**
228  * Disconnect from the X server.
229  */
230 static void Close (vlc_object_t *obj)
231 {
232     vout_thread_t *vout = (vout_thread_t *)obj;
233     vout_sys_t *p_sys = vout->p_sys;
234
235     free (p_sys->adaptors);
236     vout_window_Delete (p_sys->embed);
237     xcb_disconnect (p_sys->conn);
238     free (p_sys);
239 }
240
241 static vlc_fourcc_t ParseFormat (vout_thread_t *vout,
242                                  const xcb_xv_image_format_info_t *restrict f)
243 {
244     if (f->byte_order != ORDER && f->bpp != 8)
245         return 0; /* Argh! */
246
247     switch (f->type)
248     {
249       case XCB_XV_IMAGE_FORMAT_INFO_TYPE_RGB:
250         switch (f->num_planes)
251         {
252           case 1:
253             switch (f->bpp)
254             {
255               case 32:
256                 if (f->depth == 24)
257                     return VLC_CODEC_RGB32;
258                 break;
259               case 24:
260                 if (f->depth == 24)
261                     return VLC_CODEC_RGB24;
262                 break;
263               case 16:
264                 if (f->depth == 16)
265                     return VLC_CODEC_RGB16;
266                 if (f->depth == 15)
267                     return VLC_CODEC_RGB15;
268                 break;
269               case 8:
270                 if (f->depth == 8)
271                     return VLC_CODEC_RGB8;
272                 break;
273             }
274             break;
275         }
276         msg_Err (vout, "unknown XVideo RGB format %"PRIx32" (%.4s)",
277                  f->id, f->guid);
278         msg_Dbg (vout, " %"PRIu8" planes, %"PRIu8" bits/pixel, "
279                  "depth %"PRIu8, f->num_planes, f->bpp, f->depth);
280         break;
281
282       case XCB_XV_IMAGE_FORMAT_INFO_TYPE_YUV:
283         if (f->u_sample_bits != f->v_sample_bits
284          || f->vhorz_u_period != f->vhorz_v_period
285          || f->vvert_u_period != f->vvert_v_period
286          || f->y_sample_bits != 8 || f->u_sample_bits != 8
287          || f->vhorz_y_period != 1 || f->vvert_y_period != 1)
288             goto bad;
289         switch (f->num_planes)
290         {
291           case 1:
292             switch (f->bpp)
293             {
294               /*untested: case 24:
295                 if (f->vhorz_u_period == 1 && f->vvert_u_period == 1)
296                     return VLC_CODEC_I444;
297                 break;*/
298               case 16:
299                 if (f->vhorz_u_period == 2 && f->vvert_u_period == 1)
300                 {
301                     if (!strcmp ((const char *)f->vcomp_order, "YUYV"))
302                         return VLC_CODEC_YUYV;
303                     if (!strcmp ((const char *)f->vcomp_order, "UYVY"))
304                         return VLC_CODEC_UYVY;
305                 }
306                 break;
307             }
308             break;
309           case 3:
310             switch (f->bpp)
311             {
312               case 12:
313                 if (f->vhorz_u_period == 2 && f->vvert_u_period == 2)
314                 {
315                     if (!strcmp ((const char *)f->vcomp_order, "YVU"))
316                         return VLC_CODEC_YV12;
317                     if (!strcmp ((const char *)f->vcomp_order, "YUV"))
318                         return VLC_CODEC_I420;
319                 }
320             }
321             break;
322         }
323     bad:
324         msg_Err (vout, "unknown XVideo YUV format %"PRIx32" (%.4s)", f->id,
325                  f->guid);
326         msg_Dbg (vout, " %"PRIu8" planes, %"PRIu32" bits/pixel, "
327                  "%"PRIu32"/%"PRIu32"/%"PRIu32" bits/sample", f->num_planes,
328                  f->bpp, f->y_sample_bits, f->u_sample_bits, f->v_sample_bits);
329         msg_Dbg (vout, " period: %"PRIu32"/%"PRIu32"/%"PRIu32"x"
330                  "%"PRIu32"/%"PRIu32"/%"PRIu32,
331                  f->vhorz_y_period, f->vhorz_u_period, f->vhorz_v_period,
332                  f->vvert_y_period, f->vvert_u_period, f->vvert_v_period);
333         msg_Warn (vout, " order: %.32s", f->vcomp_order);
334         break;
335     }
336     return 0;
337 }
338
339
340 static const xcb_xv_image_format_info_t *
341 FindFormat (vout_thread_t *vout, vlc_fourcc_t chroma, xcb_xv_port_t port,
342             const xcb_xv_list_image_formats_reply_t *list,
343             xcb_xv_query_image_attributes_reply_t **restrict pa)
344 {
345     xcb_connection_t *conn = vout->p_sys->conn;
346     const xcb_xv_image_format_info_t *f, *end;
347
348 #ifndef XCB_XV_OLD
349     f = xcb_xv_list_image_formats_format (list);
350 #else
351     f = (xcb_xv_image_format_info_t *) (list + 1);
352 #endif
353     end = f + xcb_xv_list_image_formats_format_length (list);
354     for (; f < end; f++)
355     {
356         if (chroma != ParseFormat (vout, f))
357             continue;
358
359         xcb_xv_query_image_attributes_reply_t *i;
360         i = xcb_xv_query_image_attributes_reply (conn,
361             xcb_xv_query_image_attributes (conn, port, f->id,
362                 vout->fmt_in.i_width, vout->fmt_in.i_height), NULL);
363         if (i == NULL)
364             continue;
365
366         if (i->width != vout->fmt_in.i_width
367          || i->height != vout->fmt_in.i_height)
368         {
369             msg_Warn (vout, "incompatible size %ux%u -> %"PRIu32"x%"PRIu32,
370                       vout->fmt_in.i_width, vout->fmt_in.i_height,
371                       i->width, i->height);
372             free (i);
373             continue;
374         }
375         *pa = i;
376         return f;
377     }
378     return NULL;
379 }
380
381 /**
382  * Allocate drawable window and picture buffers.
383  */
384 static int Init (vout_thread_t *vout)
385 {
386     vout_sys_t *p_sys = vout->p_sys;
387     xcb_xv_query_image_attributes_reply_t *att = NULL;
388     bool swap_planes = false; /* whether X wants V before U */
389
390     /* FIXME: check max image size */
391     xcb_xv_adaptor_info_iterator_t it;
392     for (it = xcb_xv_query_adaptors_info_iterator (p_sys->adaptors);
393          it.rem > 0;
394          xcb_xv_adaptor_info_next (&it))
395     {
396         const xcb_xv_adaptor_info_t *a = it.data;
397
398         /* FIXME: Open() should fail if none of the ports are usable to VLC */
399         if (!(a->type & XCB_XV_TYPE_IMAGE_MASK))
400             continue;
401
402         xcb_xv_list_image_formats_reply_t *r;
403         r = xcb_xv_list_image_formats_reply (p_sys->conn,
404             xcb_xv_list_image_formats (p_sys->conn, a->base_id), NULL);
405         if (r == NULL)
406             continue;
407
408         const xcb_xv_image_format_info_t *fmt;
409
410         /* Video chroma in preference order */
411         const vlc_fourcc_t chromas[] = {
412             vout->fmt_in.i_chroma,
413             VLC_CODEC_YUYV,
414             VLC_CODEC_RGB24,
415             VLC_CODEC_RGB15,
416         };
417         for (size_t i = 0; i < sizeof (chromas) / sizeof (chromas[0]); i++)
418         {
419             vlc_fourcc_t chroma = chromas[i];
420             fmt = FindFormat (vout, chroma, a->base_id, r, &att);
421             if (fmt != NULL)
422             {
423                 vout->output.i_chroma = chroma;
424                 goto found_format;
425             }
426         }
427         free (r);
428         continue;
429
430     found_format:
431         /* TODO: grab port */
432         p_sys->port = a->base_id;
433         msg_Dbg (vout, "using port %"PRIu32, p_sys->port);
434
435         p_sys->id = fmt->id;
436         msg_Dbg (vout, "using image format 0x%"PRIx32, p_sys->id);
437         if (fmt->type == XCB_XV_IMAGE_FORMAT_INFO_TYPE_RGB)
438         {
439             vout->fmt_out.i_rmask = vout->output.i_rmask = fmt->red_mask;
440             vout->fmt_out.i_gmask = vout->output.i_gmask = fmt->green_mask;
441             vout->fmt_out.i_bmask = vout->output.i_bmask = fmt->blue_mask;
442         }
443         else
444         if (fmt->num_planes == 3)
445             swap_planes = !strcmp ((const char *)fmt->vcomp_order, "YVU");
446         free (r);
447         goto found_adaptor;
448     }
449     msg_Err (vout, "no available XVideo adaptor");
450     return VLC_EGENERIC; /* no usable adaptor */
451
452     /* Allocate picture buffers */
453     const uint32_t *offsets;
454 found_adaptor:
455     offsets = xcb_xv_query_image_attributes_offsets (att);
456     p_sys->data_size = att->data_size;
457
458     I_OUTPUTPICTURES = 0;
459     for (size_t index = 0; I_OUTPUTPICTURES < 2; index++)
460     {
461         picture_t *pic = vout->p_picture + index;
462
463         if (index > sizeof (vout->p_picture) / sizeof (pic))
464             break;
465         if (pic->i_status != FREE_PICTURE)
466             continue;
467
468         picture_Setup (pic, vout->output.i_chroma,
469                        att->width, att->height,
470                        vout->fmt_in.i_aspect);
471         if (PictureAlloc (vout, pic, att->data_size,
472                           p_sys->shm ? p_sys->conn : NULL))
473             break;
474         /* Allocate further planes as specified by XVideo */
475         /* We assume that offsets[0] is zero */
476         for (int i = 1; i < pic->i_planes; i++)
477              pic->p[i].p_pixels =
478                  pic->p->p_pixels + offsets[swap_planes ? (3 - i) : i];
479         PP_OUTPUTPICTURE[I_OUTPUTPICTURES++] = pic;
480     }
481     free (att);
482
483     unsigned x, y, width, height;
484
485     if (GetWindowSize (p_sys->embed, p_sys->conn, &width, &height))
486         return VLC_EGENERIC;
487     vout_PlacePicture (vout, width, height, &x, &y, &width, &height);
488
489     const uint32_t values[] = { x, y, width, height, };
490     xcb_configure_window (p_sys->conn, p_sys->window,
491                           XCB_CONFIG_WINDOW_X | XCB_CONFIG_WINDOW_Y |
492                           XCB_CONFIG_WINDOW_WIDTH | XCB_CONFIG_WINDOW_HEIGHT,
493                           values);
494     xcb_flush (p_sys->conn);
495     p_sys->height = height;
496     p_sys->width = width;
497
498     vout->fmt_out.i_chroma = vout->output.i_chroma;
499     vout->fmt_out.i_visible_width = vout->fmt_in.i_visible_width;
500     vout->fmt_out.i_visible_height = vout->fmt_in.i_visible_height;
501     vout->fmt_out.i_sar_num = vout->fmt_out.i_sar_den = 1;
502
503     vout->output.i_width = vout->fmt_out.i_width = vout->fmt_in.i_width;
504     vout->output.i_height = vout->fmt_out.i_height = vout->fmt_in.i_height;
505     vout->fmt_out.i_x_offset = vout->fmt_in.i_x_offset;
506     vout->fmt_out.i_y_offset = vout->fmt_in.i_y_offset;
507
508     assert (height > 0);
509     vout->output.i_aspect = vout->fmt_out.i_aspect =
510         width * VOUT_ASPECT_FACTOR / height;
511
512     return VLC_SUCCESS;
513 }
514
515 /**
516  * Free picture buffers.
517  */
518 static void Deinit (vout_thread_t *vout)
519 {
520     vout_sys_t *p_sys = vout->p_sys;
521
522     for (int i = 0; i < I_OUTPUTPICTURES; i++)
523         PictureFree (PP_OUTPUTPICTURE[i], p_sys->conn);
524 }
525
526 /**
527  * Sends an image to the X server.
528  */
529 static void Display (vout_thread_t *vout, picture_t *pic)
530 {
531     vout_sys_t *p_sys = vout->p_sys;
532     xcb_shm_seg_t segment = (uintptr_t)pic->p_sys;
533
534     if (segment)
535         xcb_xv_shm_put_image (p_sys->conn, p_sys->port, p_sys->window,
536                               p_sys->gc, segment, p_sys->id, 0,
537                               /* Src: */ vout->fmt_out.i_x_offset,
538                               vout->fmt_out.i_y_offset,
539                               vout->fmt_out.i_visible_width,
540                               vout->fmt_out.i_visible_height,
541                               /* Dst: */ 0, 0, p_sys->width, p_sys->height,
542                               /* Memory: */
543                               pic->p->i_pitch / pic->p->i_pixel_pitch,
544                               pic->p->i_lines, false);
545     else
546         xcb_xv_put_image (p_sys->conn, p_sys->port, p_sys->window,
547                           p_sys->gc, p_sys->id,
548                           vout->fmt_out.i_x_offset, vout->fmt_out.i_y_offset,
549                           vout->fmt_out.i_visible_width,
550                           vout->fmt_out.i_visible_height,
551                           0, 0, p_sys->width, p_sys->height,
552                           vout->fmt_out.i_width, vout->fmt_out.i_height,
553                           p_sys->data_size, pic->p->p_pixels);
554     xcb_flush (p_sys->conn);
555 }
556
557 /**
558  * Process incoming X events.
559  */
560 static int Manage (vout_thread_t *vout)
561 {
562     vout_sys_t *p_sys = vout->p_sys;
563     xcb_generic_event_t *ev;
564
565     while ((ev = xcb_poll_for_event (p_sys->conn)) != NULL)
566         ProcessEvent (vout, p_sys->conn, p_sys->window, ev);
567
568     if (xcb_connection_has_error (p_sys->conn))
569     {
570         msg_Err (vout, "X server failure");
571         return VLC_EGENERIC;
572     }
573
574     CommonManage (vout);
575     if (vout->i_changes & VOUT_SIZE_CHANGE)
576     {   /* TODO: factor this code with XV and X11 Init() */
577         unsigned x, y, width, height;
578
579         if (GetWindowSize (p_sys->embed, p_sys->conn, &width, &height))
580             return VLC_EGENERIC;
581         vout_PlacePicture (vout, width, height, &x, &y, &width, &height);
582
583         const uint32_t values[] = { x, y, width, height, };
584         xcb_configure_window (p_sys->conn, p_sys->window, XCB_CONFIG_WINDOW_X |
585                               XCB_CONFIG_WINDOW_Y | XCB_CONFIG_WINDOW_WIDTH |
586                               XCB_CONFIG_WINDOW_HEIGHT, values);
587         vout->p_sys->width = width; // XXX: <-- this is useless, as the zoom is
588         vout->p_sys->height = height; // handled with VOUT_SET_SIZE anyway.
589         vout->i_changes &= ~VOUT_SIZE_CHANGE;
590     }
591     return VLC_SUCCESS;
592 }
593
594 void
595 HandleParentStructure (vout_thread_t *vout, xcb_connection_t *conn,
596                        xcb_window_t xid, xcb_configure_notify_event_t *ev)
597 {
598     unsigned width, height, x, y;
599
600     vout_PlacePicture (vout, ev->width, ev->height, &x, &y, &width, &height);
601
602     /* Move the picture within the window */
603     const uint32_t values[] = { x, y, width, height, };
604     xcb_configure_window (conn, xid,
605                           XCB_CONFIG_WINDOW_X | XCB_CONFIG_WINDOW_Y
606                         | XCB_CONFIG_WINDOW_WIDTH | XCB_CONFIG_WINDOW_HEIGHT,
607                           values);
608     vout->p_sys->width = width;
609     vout->p_sys->height = height;
610 }
611
612 static int Control (vout_thread_t *vout, int query, va_list ap)
613 {
614     /* FIXME it can be shared between x11 and xvideo */
615     switch (query)
616     {
617     case VOUT_SET_SIZE:
618     {
619         const unsigned width  = va_arg (ap, unsigned);
620         const unsigned height = va_arg (ap, unsigned);
621         return vout_window_SetSize (vout->p_sys->embed, width, height);
622     }
623     case VOUT_SET_STAY_ON_TOP:
624     {
625         const bool is_on_top = va_arg (ap, int);
626         return vout_window_SetOnTop (vout->p_sys->embed, is_on_top);
627     }
628     default:
629         return VLC_EGENERIC;
630     }
631
632 }