]> git.sesse.net Git - vlc/blobdiff - modules/access/screen/xcb.c
LGPL
[vlc] / modules / access / screen / xcb.c
index f07da3922dc6f8a0338d808929ef225ee4359ad0..bca05d5d34bcc1072ddc7c5690a1e3b2a1827706 100644 (file)
@@ -5,42 +5,39 @@
 /*****************************************************************************
  * Copyright © 2009 Rémi Denis-Courmont
  *
- * This library is free software; you can redistribute it and/or
- * modify it under the terms of the GNU General Public License
- * as published by the Free Software Foundation; either version 2.0
- * of the License, or (at your option) any later version.
+ * This program is free software; you can redistribute it and/or modify it
+ * under the terms of the GNU Lesser General Public License as published by
+ * the Free Software Foundation; either version 2.1 of the License, or
+ * (at your option) any later version.
  *
- * This library is distributed in the hope that it will be useful,
+ * This program is distributed in the hope that it will be useful,
  * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
- * GNU General Public License for more details.
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU Lesser General Public License for more details.
  *
- * You should have received a copy of the GNU Lesser General Public
- * License along with this library; if not, write to the Free Software
- * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
- ****************************************************************************/
+ * You should have received a copy of the GNU Lesser General Public License
+ * along with this program; if not, write to the Free Software Foundation,
+ * Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
+ *****************************************************************************/
 
 #ifdef HAVE_CONFIG_H
 # include <config.h>
 #endif
 #include <stdarg.h>
+#include <assert.h>
 #include <xcb/xcb.h>
+#include <xcb/composite.h>
 #include <vlc_common.h>
 #include <vlc_demux.h>
 #include <vlc_plugin.h>
 
-#define CACHING_TEXT N_("Caching value in ms")
-#define CACHING_LONGTEXT N_( \
-    "Caching value for screen capture. " \
-    "This value should be set in milliseconds.")
-
 #define FPS_TEXT N_("Frame rate")
 #define FPS_LONGTEXT N_( \
     "How many times the screen content should be refreshed per second.")
 
 #define LEFT_TEXT N_("Region left column")
 #define LEFT_LONGTEXT N_( \
-    "Abscissa of the capture reion in pixels.")
+    "Abscissa of the capture region in pixels.")
 
 #define TOP_TEXT N_("Region top row")
 #define TOP_LONGTEXT N_( \
 #define HEIGHT_LONGTEXT N_( \
     "Pixel height of the capture region, or 0 for full height")
 
+#define FOLLOW_MOUSE_TEXT N_( "Follow the mouse" )
+#define FOLLOW_MOUSE_LONGTEXT N_( \
+    "Follow the mouse when capturing a subscreen." )
+
 static int  Open (vlc_object_t *);
 static void Close (vlc_object_t *);
 
@@ -68,41 +69,47 @@ vlc_module_begin ()
     set_capability ("access_demux", 0)
     set_callbacks (Open, Close)
 
-    add_integer ("screen-caching", DEFAULT_PTS_DELAY * 1000 / CLOCK_FREQ,
-                 NULL, CACHING_TEXT, CACHING_LONGTEXT, true)
-    add_float ("screen-fps", 2.0, NULL, FPS_TEXT, FPS_LONGTEXT, true)
-    add_integer ("screen-left", 0, NULL, LEFT_TEXT, LEFT_LONGTEXT, true)
+    add_float ("screen-fps", 2.0, FPS_TEXT, FPS_LONGTEXT, true)
+    add_integer ("screen-left", 0, LEFT_TEXT, LEFT_LONGTEXT, true)
         change_integer_range (-32768, 32767)
         change_safe ()
-    add_integer ("screen-top", 0, NULL, LEFT_TEXT, LEFT_LONGTEXT, true)
+    add_integer ("screen-top", 0, TOP_TEXT, TOP_LONGTEXT, true)
         change_integer_range (-32768, 32767)
         change_safe ()
-    add_integer ("screen-width", 0, NULL, LEFT_TEXT, LEFT_LONGTEXT, true)
+    add_integer ("screen-width", 0, WIDTH_TEXT, WIDTH_LONGTEXT, true)
         change_integer_range (0, 65535)
         change_safe ()
-    add_integer ("screen-height", 0, NULL, LEFT_TEXT, LEFT_LONGTEXT, true)
+    add_integer ("screen-height", 0, HEIGHT_TEXT, HEIGHT_LONGTEXT, true)
         change_integer_range (0, 65535)
         change_safe ()
+    add_bool ("screen-follow-mouse", false, FOLLOW_MOUSE_TEXT,
+              FOLLOW_MOUSE_LONGTEXT, true)
 
-    add_shortcut ("screen")
-    add_shortcut ("window")
+    add_shortcut ("screen", "window")
 vlc_module_end ()
 
 /*
  * Local prototypes
  */
-static int Demux (demux_t *);
+static void Demux (void *);
 static int Control (demux_t *, int, va_list);
+static es_out_id_t *InitES (demux_t *, uint_fast16_t, uint_fast16_t,
+                            uint_fast8_t);
 
 struct demux_sys_t
 {
+    /* All owned by timer thread while timer is armed: */
     xcb_connection_t *conn;
     es_out_id_t      *es;
-    es_format_t       fmt;
-    mtime_t           pts, interval;
-    xcb_window_t      root, window;
+    float             rate;
+    xcb_window_t      window;
+    xcb_pixmap_t      pixmap;
     int16_t           x, y;
     uint16_t          w, h;
+    uint16_t          cur_w, cur_h;
+    bool              follow_mouse;
+    /* Timer does not use this, only input thread: */
+    vlc_timer_t       timer;
 };
 
 /**
@@ -115,10 +122,10 @@ static int Open (vlc_object_t *obj)
 
     if (p_sys == NULL)
         return VLC_ENOMEM;
-    demux->p_sys      = p_sys;
+    demux->p_sys = p_sys;
 
     /* Connect to X server */
-    char *display = var_CreateGetNonEmptyString (obj, "x11-display");
+    char *display = var_InheritString (obj, "x11-display");
     int snum;
     xcb_connection_t *conn = xcb_connect (display, &snum);
     free (display);
@@ -129,122 +136,98 @@ static int Open (vlc_object_t *obj)
     }
     p_sys->conn = conn;
 
-    /* Find configured screen */
-    const xcb_setup_t *setup = xcb_get_setup (conn);
-    xcb_screen_t *scr = NULL;
-    for (xcb_screen_iterator_t i = xcb_setup_roots_iterator (setup);
-         i.rem > 0; xcb_screen_next (&i))
+   /* Find configured screen */
+    if (!strcmp (demux->psz_access, "screen"))
     {
-        if (snum == 0)
+        const xcb_setup_t *setup = xcb_get_setup (conn);
+        const xcb_screen_t *scr = NULL;
+        for (xcb_screen_iterator_t i = xcb_setup_roots_iterator (setup);
+             i.rem > 0; xcb_screen_next (&i))
         {
-            scr = i.data;
-            break;
+            if (snum == 0)
+            {
+               scr = i.data;
+                break;
+            }
+            snum--;
         }
-        snum--;
-    }
-    if (scr == NULL)
-    {
-        msg_Err (obj, "bad X11 screen number");
-        goto error;
+        if (scr == NULL)
+        {
+            msg_Err (obj, "bad X11 screen number");
+            goto error;
+        }
+        p_sys->window = scr->root;
     }
-
-    /* Determine capture window */
-    p_sys->root = scr->root;
-    if (!strcmp (demux->psz_access, "screen"))
-        p_sys->window = p_sys->root;
     else
+    /* Determine capture window */
     if (!strcmp (demux->psz_access, "window"))
     {
         char *end;
-        unsigned long ul = strtoul (demux->psz_path, &end, 0);
+        unsigned long ul = strtoul (demux->psz_location, &end, 0);
         if (*end || ul > 0xffffffff)
         {
-            msg_Err (obj, "bad X11 drawable %s", demux->psz_path);
+            msg_Err (obj, "bad X11 drawable %s", demux->psz_location);
             goto error;
         }
         p_sys->window = ul;
-    }
-    else
-        goto error;
 
-    /* Window properties */
-    p_sys->x = var_CreateGetInteger (obj, "screen-left");
-    p_sys->y = var_CreateGetInteger (obj, "screen-top");
-    p_sys->w = var_CreateGetInteger (obj, "screen-width");
-    p_sys->h = var_CreateGetInteger (obj, "screen-height");
-
-    uint32_t chroma = 0;
-    uint8_t bpp;
-    for (const xcb_format_t *fmt = xcb_setup_pixmap_formats (setup),
-             *end = fmt + xcb_setup_pixmap_formats_length (setup);
-         fmt < end; fmt++)
-    {
-        if (fmt->depth != scr->root_depth)
-            continue;
-        bpp = fmt->depth;
-        switch (fmt->depth)
+        xcb_composite_query_version_reply_t *r =
+            xcb_composite_query_version_reply (conn,
+                xcb_composite_query_version (conn, 0, 4), NULL);
+        if (r == NULL || r->minor_version < 2)
         {
-            case 32:
-                if (fmt->bits_per_pixel == 32)
-                    chroma = VLC_CODEC_RGBA;
-                break;
-            case 24:
-                if (fmt->bits_per_pixel == 32)
-                {
-                    chroma = VLC_CODEC_RGB32;
-                    bpp = 32;
-                }
-                else if (fmt->bits_per_pixel == 24)
-                    chroma = VLC_CODEC_RGB24;
-                break;
-            case 16:
-                if (fmt->bits_per_pixel == 16)
-                    chroma = VLC_CODEC_RGB16;
-                break;
-            case 15:
-                if (fmt->bits_per_pixel == 16)
-                    chroma = VLC_CODEC_RGB15;
-                break;
-            case 8: /* XXX: screw grey scale! */
-                if (fmt->bits_per_pixel == 8)
-                    chroma = VLC_CODEC_RGB8;
-                break;
+            msg_Err (obj, "X Composite extension not available");
+            free (r);
+            goto error;
         }
-        if (chroma != 0)
-            break;
+        msg_Dbg (obj, "using Composite extension v%"PRIu32".%"PRIu32,
+                 r->major_version, r->minor_version);
+        free (r);
+
+        xcb_composite_redirect_window (conn, p_sys->window,
+                                       XCB_COMPOSITE_REDIRECT_AUTOMATIC);
     }
+    else
+        goto error;
 
-    if (!chroma)
+    /* Window properties */
+    p_sys->pixmap = xcb_generate_id (conn);
+    p_sys->w = var_InheritInteger (obj, "screen-width");
+    p_sys->h = var_InheritInteger (obj, "screen-height");
+    if (p_sys->w != 0 || p_sys->h != 0)
+        p_sys->follow_mouse = var_InheritBool (obj, "screen-follow-mouse");
+    else /* Following mouse is meaningless if width&height are dynamic. */
+        p_sys->follow_mouse = false;
+    if (!p_sys->follow_mouse) /* X and Y are meaningless if following mouse */
     {
-        msg_Err (obj, "unsupported pixmap formats");
-        goto error;
+        p_sys->x = var_InheritInteger (obj, "screen-left");
+        p_sys->y = var_InheritInteger (obj, "screen-top");
     }
 
     /* Initializes format */
-    float rate = var_CreateGetFloat (obj, "screen-fps");
-    if (!rate)
+    p_sys->rate = var_InheritFloat (obj, "screen-fps");
+    if (!p_sys->rate)
         goto error;
-    p_sys->interval = (float)CLOCK_FREQ / rate;
-    if (!p_sys->interval)
+
+    mtime_t interval = (float)CLOCK_FREQ / p_sys->rate;
+    if (!interval)
         goto error;
-    var_Create (obj, "screen-caching", VLC_VAR_INTEGER|VLC_VAR_DOINHERIT);
-
-    es_format_Init (&p_sys->fmt, VIDEO_ES, chroma);
-    p_sys->fmt.video.i_chroma = chroma;
-    p_sys->fmt.video.i_bits_per_pixel = bpp;
-    p_sys->fmt.video.i_sar_num = p_sys->fmt.video.i_sar_den = 1;
-    p_sys->fmt.video.i_frame_rate = 1000 * rate;
-    p_sys->fmt.video.i_frame_rate_base = 1000;
+
+    p_sys->cur_w = 0;
+    p_sys->cur_h = 0;
     p_sys->es = NULL;
-    p_sys->pts = VLC_TS_INVALID;
+    if (vlc_timer_create (&p_sys->timer, Demux, demux))
+        goto error;
+    vlc_timer_schedule (p_sys->timer, false, 1, interval);
 
     /* Initializes demux */
-    demux->pf_demux   = Demux;
+    demux->pf_demux   = NULL;
     demux->pf_control = Control;
     return VLC_SUCCESS;
 
 error:
-    Close (obj);
+    xcb_disconnect (p_sys->conn);
+    free (p_sys);
     return VLC_EGENERIC;
 }
 
@@ -257,6 +240,7 @@ static void Close (vlc_object_t *obj)
     demux_t *demux = (demux_t *)obj;
     demux_sys_t *p_sys = demux->p_sys;
 
+    vlc_timer_destroy (p_sys->timer);
     xcb_disconnect (p_sys->conn);
     free (p_sys);
 }
@@ -267,8 +251,6 @@ static void Close (vlc_object_t *obj)
  */
 static int Control (demux_t *demux, int query, va_list args)
 {
-    demux_sys_t *p_sys = demux->p_sys;
-
     switch (query)
     {
         case DEMUX_GET_POSITION:
@@ -291,28 +273,11 @@ static int Control (demux_t *demux, int query, va_list args)
         case DEMUX_GET_PTS_DELAY:
         {
             int64_t *v = va_arg (args, int64_t *);
-            *v = var_GetInteger (demux, "screen-caching") * UINT64_C(1000);
+            *v = INT64_C(1000) * var_InheritInteger (demux, "live-caching");
             return VLC_SUCCESS;
         }
 
         case DEMUX_CAN_PAUSE:
-        {
-            bool *v = (bool*)va_arg( args, bool * );
-            *v = true;
-            return VLC_SUCCESS;
-        }
-
-        case DEMUX_SET_PAUSE_STATE:
-        {
-            bool pausing = va_arg (args, int);
-            if (!pausing)
-            {
-                p_sys->pts = VLC_TS_INVALID;
-                es_out_Control (demux->out, ES_OUT_RESET_PCR);
-            }
-            return VLC_SUCCESS;
-        }
-
         case DEMUX_CAN_CONTROL_PACE:
         case DEMUX_CAN_CONTROL_RATE:
         case DEMUX_CAN_SEEK:
@@ -321,6 +286,9 @@ static int Control (demux_t *demux, int query, va_list args)
             *v = false;
             return VLC_SUCCESS;
         }
+
+        case DEMUX_SET_PAUSE_STATE:
+            return VLC_SUCCESS; /* should not happen */
     }
 
     return VLC_EGENERIC;
@@ -330,82 +298,199 @@ static int Control (demux_t *demux, int query, va_list args)
 /**
  * Processing callback
  */
-static int Demux (demux_t *demux)
+static void Demux (void *opaque)
 {
-    demux_sys_t *p_sys = demux->p_sys;
-    xcb_connection_t *conn = p_sys->conn;
-    mtime_t now = mdate ();
+    demux_t *demux = opaque;
+    demux_sys_t *sys = demux->p_sys;
+    xcb_connection_t *conn = sys->conn;
 
-    if (p_sys->pts != VLC_TS_INVALID)
-        mwait (p_sys->pts);
-    else
-        p_sys->pts = now;
+    /* Determine capture region */
+    xcb_get_geometry_cookie_t gc;
+    xcb_query_pointer_cookie_t qc;
 
-    /* Update capture region (if needed) */
-    xcb_get_geometry_cookie_t gc = xcb_get_geometry (conn, p_sys->window);
-    int16_t x = p_sys->x, y = p_sys->y;
-    xcb_translate_coordinates_cookie_t tc;
-
-    if (p_sys->window != p_sys->root)
-        tc = xcb_translate_coordinates (conn, p_sys->window, p_sys->root,
-                                        x, y);
+    gc = xcb_get_geometry (conn, sys->window);
+    if (sys->follow_mouse)
+        qc = xcb_query_pointer (conn, sys->window);
 
     xcb_get_geometry_reply_t *geo = xcb_get_geometry_reply (conn, gc, NULL);
     if (geo == NULL)
     {
-        msg_Err (demux, "bad X11 drawable 0x%08"PRIx32, p_sys->window);
-        return 0;
+        msg_Err (demux, "bad X11 drawable 0x%08"PRIx32, sys->window);
+discard:
+        if (sys->follow_mouse)
+            xcb_discard_reply (conn, gc.sequence);
+        return;
     }
 
-    uint16_t w = geo->width - x;
-    uint16_t h = geo->height - y;
-    if (p_sys->w > 0 && p_sys->w < w)
-        w = p_sys->w;
-    if (p_sys->h > 0 && p_sys->h < h)
-        h = p_sys->h;
+    int w = sys->w;
+    int h = sys->h;
+    int x, y;
+
+    if (sys->follow_mouse)
+    {
+        xcb_query_pointer_reply_t *ptr =
+            xcb_query_pointer_reply (conn, qc, NULL);
+        if (ptr == NULL)
+        {
+            free (geo);
+            return;
+        }
 
-    if (w != p_sys->fmt.video.i_visible_width
-     || h != p_sys->fmt.video.i_visible_height)
+        if (w == 0 || w > geo->width)
+            w = geo->width;
+        x = ptr->win_x;
+        if (x < w / 2)
+            x = 0;
+        else if (x >= (int)geo->width - (w / 2))
+            x = geo->width - w;
+        else
+            x -= w / 2;
+
+        if (h == 0 || h > geo->height)
+            h = geo->height;
+        y = ptr->win_y;
+        if (y < h / 2)
+            y = 0;
+        else if (y >= (int)geo->height - (h / 2))
+            y = geo->height - h;
+        else
+            y -= h / 2;
+    }
+    else
     {
-        if (p_sys->es != NULL)
-            es_out_Del (demux->out, p_sys->es);
-        p_sys->fmt.video.i_visible_width = p_sys->fmt.video.i_width = w;
-        p_sys->fmt.video.i_visible_height = p_sys->fmt.video.i_height = h;
-        p_sys->es = es_out_Add (demux->out, &p_sys->fmt);
+        int max;
+
+        x = sys->x;
+        max = (int)geo->width - x;
+        if (max <= 0)
+            goto discard;
+        if (w == 0 || w > max)
+            w = max;
+
+        y = sys->y;
+        max = (int)geo->height - y;
+        if (max <= 0)
+            goto discard;
+        if (h == 0 || h > max)
+            h = max;
     }
-    free (geo);
 
-    if (p_sys->window != p_sys->root)
+    /* Update elementary stream format (if needed) */
+    if (w != sys->cur_w || h != sys->cur_h)
     {
-        xcb_translate_coordinates_reply_t *coords =
-             xcb_translate_coordinates_reply (conn, tc, NULL);
-        if (coords == NULL)
-            return 1;
-        x = coords->dst_x;
-        y = coords->dst_y;
-        free (coords);
+        if (sys->es != NULL)
+            es_out_Del (demux->out, sys->es);
+
+        /* Update composite pixmap */
+        if (sys->window != geo->root)
+        {
+            xcb_free_pixmap (conn, sys->pixmap); /* no-op first time */
+            xcb_composite_name_window_pixmap (conn, sys->window, sys->pixmap);
+            xcb_create_pixmap (conn, geo->depth, sys->pixmap,
+                               geo->root, geo->width, geo->height);
+        }
+
+        sys->es = InitES (demux, w, h, geo->depth);
+        if (sys->es != NULL)
+        {
+            sys->cur_w = w;
+            sys->cur_h = h;
+        }
     }
 
     /* Capture screen */
-    if (p_sys->es == NULL)
-        return 1;
+    xcb_drawable_t drawable =
+        (sys->window != geo->root) ? sys->pixmap : sys->window;
+    free (geo);
 
     xcb_get_image_reply_t *img;
     img = xcb_get_image_reply (conn,
-        xcb_get_image (conn, XCB_IMAGE_FORMAT_Z_PIXMAP, p_sys->root,
+        xcb_get_image (conn, XCB_IMAGE_FORMAT_Z_PIXMAP, drawable,
                        x, y, w, h, ~0), NULL);
     if (img == NULL)
-        return 1;
+        return;
 
-    /* Send block - zero copy */
-    block_t *block = block_heap_Alloc (img, xcb_get_image_data (img),
-                                       xcb_get_image_data_length (img));
+    uint8_t *data = xcb_get_image_data (img);
+    size_t datalen = xcb_get_image_data_length (img);
+    block_t *block = block_heap_Alloc (img, data + datalen - (uint8_t *)img);
     if (block == NULL)
-        return 0;
-    block->i_pts = block->i_dts = now;
+        return;
+    block->p_buffer = data;
+    block->i_buffer = datalen;
+
+    /* Send block - zero copy */
+    if (sys->es != NULL)
+    {
+        block->i_pts = block->i_dts = mdate ();
+
+        es_out_Control (demux->out, ES_OUT_SET_PCR, block->i_pts);
+        es_out_Send (demux->out, sys->es, block);
+    }
+}
+
+static es_out_id_t *InitES (demux_t *demux, uint_fast16_t width,
+                            uint_fast16_t height, uint_fast8_t depth)
+{
+    demux_sys_t *p_sys = demux->p_sys;
+    const xcb_setup_t *setup = xcb_get_setup (p_sys->conn);
+    uint32_t chroma = 0;
+    uint8_t bpp;
+
+    for (const xcb_format_t *fmt = xcb_setup_pixmap_formats (setup),
+             *end = fmt + xcb_setup_pixmap_formats_length (setup);
+         fmt < end; fmt++)
+    {
+        if (fmt->depth != depth)
+            continue;
+        bpp = fmt->depth;
+        switch (fmt->depth)
+        {
+            case 32:
+                if (fmt->bits_per_pixel == 32)
+                    chroma = VLC_CODEC_RGBA;
+                break;
+            case 24:
+                if (fmt->bits_per_pixel == 32)
+                {
+                    chroma = VLC_CODEC_RGB32;
+                    bpp = 32;
+                }
+                else if (fmt->bits_per_pixel == 24)
+                    chroma = VLC_CODEC_RGB24;
+                break;
+            case 16:
+                if (fmt->bits_per_pixel == 16)
+                    chroma = VLC_CODEC_RGB16;
+                break;
+            case 15:
+                if (fmt->bits_per_pixel == 16)
+                    chroma = VLC_CODEC_RGB15;
+                break;
+            case 8: /* XXX: screw grey scale! */
+                if (fmt->bits_per_pixel == 8)
+                    chroma = VLC_CODEC_RGB8;
+                break;
+        }
+        if (chroma != 0)
+            break;
+    }
+
+    if (!chroma)
+    {
+        msg_Err (demux, "unsupported pixmap formats");
+        return NULL;
+    }
+
+    es_format_t fmt;
+
+    es_format_Init (&fmt, VIDEO_ES, chroma);
+    fmt.video.i_chroma = chroma;
+    fmt.video.i_bits_per_pixel = bpp;
+    fmt.video.i_sar_num = fmt.video.i_sar_den = 1;
+    fmt.video.i_frame_rate = 1000 * p_sys->rate;
+    fmt.video.i_frame_rate_base = 1000;
+    fmt.video.i_visible_width = fmt.video.i_width = width;
+    fmt.video.i_visible_height = fmt.video.i_height = height;
 
-    es_out_Control (demux->out, ES_OUT_SET_PCR, now);
-    es_out_Send (demux->out, p_sys->es, block);
-    p_sys->pts += p_sys->interval;
-    return 1;
+    return es_out_Add (demux->out, &fmt);
 }