modules/access/screen/screen.c

   1 /*****************************************************************************
   2  * screen.c: Screen capture module.
   3  *****************************************************************************
   4  * Copyright (C) 2004-2008 the VideoLAN team
   5  * $Id$
   6  *
   7  * Authors: Gildas Bazin <gbazin@videolan.org>
   8  *          Antoine Cellerier <dionoea at videolan dot org>
   9  *
  10  * This program is free software; you can redistribute it and/or modify
  11  * it under the terms of the GNU General Public License as published by
  12  * the Free Software Foundation; either version 2 of the License, or
  13  * (at your option) any later version.
  14  *
  15  * This program is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18  * GNU General Public License for more details.
  19  *
  20  * You should have received a copy of the GNU General Public License
  21  * along with this program; if not, write to the Free Software
  22  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
  23  *****************************************************************************/
  24
  25 /*****************************************************************************
  26  * Preamble
  27  *****************************************************************************/
  28
  29 #ifdef HAVE_CONFIG_H
  30 # include "config.h"
  31 #endif
  32
  33 #include <vlc_common.h>
  34 #include <vlc_plugin.h>
  35 #include "screen.h"
  36
  37 /*****************************************************************************
  38  * Module descriptor
  39  *****************************************************************************/
  40 #define CACHING_TEXT N_("Caching value in ms")
  41 #define CACHING_LONGTEXT N_( \
  42     "Caching value for screen capture. "\
  43     "This value should be set in milliseconds." )
  44 #define FPS_TEXT N_("Frame rate")
  45 #define FPS_LONGTEXT N_( \
  46     "Desired frame rate for the capture." )
  47
  48 #ifdef WIN32
  49 #define FRAGS_TEXT N_("Capture fragment size")
  50 #define FRAGS_LONGTEXT N_( \
  51     "Optimize the capture by fragmenting the screen in chunks " \
  52     "of predefined height (16 might be a good value, and 0 means disabled)." )
  53 #endif
  54
  55 #ifdef SCREEN_SUBSCREEN
  56 #define TOP_TEXT N_( "Subscreen top left corner" )
  57 #define TOP_LONGTEXT N_( \
  58     "Top coordinate of the subscreen top left corner." )
  59
  60 #define LEFT_TEXT N_( "Subscreen top left corner" )
  61 #define LEFT_LONGTEXT N_( \
  62     "Left coordinate of the subscreen top left corner." )
  63
  64 #define WIDTH_TEXT N_( "Subscreen width" )
  65 #define WIDTH_LONGTEXT N_( \
  66     "Subscreen width" )
  67
  68 #define HEIGHT_TEXT N_( "Subscreen height" )
  69 #define HEIGHT_LONGTEXT N_( \
  70     "Subscreen height"  )
  71
  72 #define FOLLOW_MOUSE_TEXT N_( "Follow the mouse" )
  73 #define FOLLOW_MOUSE_LONGTEXT N_( \
  74     "Follow the mouse when capturing a subscreen." )
  75 #endif
  76
  77 #ifdef SCREEN_MOUSE
  78 #define MOUSE_TEXT N_( "Mouse pointer image" )
  79 #define MOUSE_LONGTEXT N_( \
  80     "If specified, will use the image to draw the mouse pointer on the " \
  81     "capture." )
  82 #endif
  83
  84 static int  Open ( vlc_object_t * );
  85 static void Close( vlc_object_t * );
  86
  87 #ifdef WIN32
  88 #   define SCREEN_FPS 1
  89 #else
  90 #   define SCREEN_FPS 5
  91 #endif
  92
  93 vlc_module_begin ()
  94     set_description( N_("Screen Input") )
  95     set_shortname( N_("Screen" ))
  96     set_category( CAT_INPUT )
  97     set_subcategory( SUBCAT_INPUT_ACCESS )
  98
  99     add_integer( "screen-caching", DEFAULT_PTS_DELAY / 1000, NULL,
 100         CACHING_TEXT, CACHING_LONGTEXT, true )
 101     add_float( "screen-fps", SCREEN_FPS, 0, FPS_TEXT, FPS_LONGTEXT, true )
 102
 103 #ifdef SCREEN_SUBSCREEN
 104     add_integer( "screen-top", 0, NULL, TOP_TEXT, TOP_LONGTEXT, true )
 105     add_integer( "screen-left", 0, NULL, LEFT_TEXT, LEFT_LONGTEXT, true )
 106     add_integer( "screen-width", 0, NULL, WIDTH_TEXT, WIDTH_LONGTEXT, true )
 107     add_integer( "screen-height", 0, NULL, HEIGHT_TEXT, HEIGHT_LONGTEXT, true )
 108     add_bool( "screen-follow-mouse", false, NULL, FOLLOW_MOUSE_TEXT,
 109               FOLLOW_MOUSE_LONGTEXT, true )
 110 #endif
 111
 112 #ifdef SCREEN_MOUSE
 113     add_file( "screen-mouse-image", "", NULL, MOUSE_TEXT, MOUSE_LONGTEXT,
 114               true )
 115 #endif
 116
 117 #ifdef WIN32
 118     add_integer( "screen-fragment-size", 0, NULL, FRAGS_TEXT,
 119         FRAGS_LONGTEXT, true )
 120 #endif
 121
 122     set_capability( "access_demux", 0 )
 123     add_shortcut( "screen" )
 124     set_callbacks( Open, Close )
 125 vlc_module_end ()
 126
 127 /*****************************************************************************
 128  * Local prototypes
 129  *****************************************************************************/
 130 static int Control( demux_t *, int, va_list );
 131 static int Demux  ( demux_t * );
 132
 133 /*****************************************************************************
 134  * DemuxOpen:
 135  *****************************************************************************/
 136 static int Open( vlc_object_t *p_this )
 137 {
 138     demux_t     *p_demux = (demux_t*)p_this;
 139     demux_sys_t *p_sys;
 140
 141     /* Fill p_demux field */
 142     p_demux->pf_demux = Demux;
 143     p_demux->pf_control = Control;
 144     p_demux->p_sys = p_sys = calloc( 1, sizeof( demux_sys_t ) );
 145     if( !p_sys )
 146         return VLC_ENOMEM;
 147
 148     /* Update default_pts to a suitable value for screen access */
 149     var_Create( p_demux, "screen-caching", VLC_VAR_INTEGER|VLC_VAR_DOINHERIT );
 150
 151     p_sys->f_fps = var_CreateGetFloat( p_demux, "screen-fps" );
 152     p_sys->i_incr = 1000000 / p_sys->f_fps;;
 153     p_sys->i_next_date = 0;
 154
 155 #ifdef SCREEN_SUBSCREEN
 156     p_sys->i_top = var_CreateGetInteger( p_demux, "screen-top" );
 157     p_sys->i_left = var_CreateGetInteger( p_demux, "screen-left" );
 158     p_sys->i_width = var_CreateGetInteger( p_demux, "screen-width" );
 159     p_sys->i_height = var_CreateGetInteger( p_demux, "screen-height" );
 160     if( p_sys->i_width > 0 && p_sys->i_height > 0 )
 161         msg_Dbg( p_demux, "capturing subscreen top: %d, left: %d, "
 162                           "width: %d, height: %d",
 163                           p_sys->i_top,
 164                           p_sys->i_left,
 165                           p_sys->i_width,
 166                           p_sys->i_height );
 167 #endif
 168
 169     if( screen_InitCapture( p_demux ) != VLC_SUCCESS )
 170     {
 171         free( p_sys );
 172         return VLC_EGENERIC;
 173     }
 174
 175     msg_Dbg( p_demux, "screen width: %i, height: %i, depth: %i",
 176              p_sys->fmt.video.i_width, p_sys->fmt.video.i_height,
 177              p_sys->fmt.video.i_bits_per_pixel );
 178
 179 #ifdef SCREEN_SUBSCREEN
 180     if( p_sys->i_width > 0 && p_sys->i_height > 0 )
 181     {
 182         if( p_sys->i_left + p_sys->i_width > p_sys->fmt.video.i_width ||
 183             p_sys->i_top + p_sys->i_height > p_sys->fmt.video.i_height )
 184         {
 185             msg_Err( p_demux, "subscreen region overflows the screen" );
 186             free( p_sys );
 187             return VLC_EGENERIC;
 188         }
 189         else
 190         {
 191             p_sys->i_screen_width = p_sys->fmt.video.i_width;
 192             p_sys->i_screen_height = p_sys->fmt.video.i_height;
 193             p_sys->fmt.video.i_visible_width =
 194             p_sys->fmt.video.i_width = p_sys->i_width;
 195             p_sys->fmt.video.i_visible_height =
 196             p_sys->fmt.video.i_height = p_sys->i_height;
 197             p_sys->b_follow_mouse = var_CreateGetInteger( p_demux,
 198                                                 "screen-follow-mouse" );
 199             if( p_sys->b_follow_mouse )
 200                 msg_Dbg( p_demux, "mouse following enabled" );
 201         }
 202     }
 203 #endif
 204
 205 #ifdef SCREEN_MOUSE
 206     char * psz_mouse = var_CreateGetNonEmptyString( p_demux,
 207                                                     "screen-mouse-image" );
 208     if( psz_mouse )
 209     {
 210         image_handler_t *p_image;
 211         video_format_t fmt_in, fmt_out;
 212         msg_Dbg( p_demux, "Using %s for the mouse pointer image", psz_mouse );
 213         memset( &fmt_in, 0, sizeof( fmt_in ) );
 214         memset( &fmt_out, 0, sizeof( fmt_out ) );
 215         fmt_out.i_chroma = VLC_CODEC_RGBA;
 216         p_image = image_HandlerCreate( p_demux );
 217         if( p_image )
 218         {
 219             p_sys->p_mouse =
 220                 image_ReadUrl( p_image, psz_mouse, &fmt_in, &fmt_out );
 221             image_HandlerDelete( p_image );
 222         }
 223         if( !p_sys->p_mouse )
 224             msg_Err( p_demux, "Failed to open mouse pointer image (%s)",
 225                      psz_mouse );
 226         free( psz_mouse );
 227     }
 228 #endif
 229
 230     p_sys->es = es_out_Add( p_demux->out, &p_sys->fmt );
 231
 232     return VLC_SUCCESS;
 233 }
 234
 235 /*****************************************************************************
 236  * Close:
 237  *****************************************************************************/
 238 static void Close( vlc_object_t *p_this )
 239 {
 240     demux_t     *p_demux = (demux_t*)p_this;
 241     demux_sys_t *p_sys = p_demux->p_sys;
 242
 243     screen_CloseCapture( p_demux );
 244 #ifdef SCREEN_MOUSE
 245     if( p_sys->p_mouse )
 246         picture_Release( p_sys->p_mouse );
 247 #endif
 248     free( p_sys );
 249 }
 250
 251 /*****************************************************************************
 252  * Demux:
 253  *****************************************************************************/
 254 static int Demux( demux_t *p_demux )
 255 {
 256     demux_sys_t *p_sys = p_demux->p_sys;
 257     block_t *p_block;
 258
 259     if( !p_sys->i_next_date ) p_sys->i_next_date = mdate();
 260
 261     /* Frame skipping if necessary */
 262     while( mdate() >= p_sys->i_next_date + p_sys->i_incr )
 263         p_sys->i_next_date += p_sys->i_incr;
 264
 265     mwait( p_sys->i_next_date );
 266     p_block = screen_Capture( p_demux );
 267     if( !p_block )
 268     {
 269         p_sys->i_next_date += p_sys->i_incr;
 270         return 1;
 271     }
 272
 273     p_block->i_dts = p_block->i_pts = p_sys->i_next_date;
 274
 275     es_out_Control( p_demux->out, ES_OUT_SET_PCR, p_block->i_pts );
 276     es_out_Send( p_demux->out, p_sys->es, p_block );
 277
 278     p_sys->i_next_date += p_sys->i_incr;
 279
 280     return 1;
 281 }
 282
 283 /*****************************************************************************
 284  * Control:
 285  *****************************************************************************/
 286 static int Control( demux_t *p_demux, int i_query, va_list args )
 287 {
 288     bool *pb;
 289     int64_t *pi64;
 290
 291     switch( i_query )
 292     {
 293         /* Special for access_demux */
 294         case DEMUX_CAN_PAUSE:
 295         case DEMUX_CAN_SEEK:
 296         case DEMUX_CAN_CONTROL_PACE:
 297             /* TODO */
 298             pb = (bool*)va_arg( args, bool * );
 299             *pb = false;
 300             return VLC_SUCCESS;
 301
 302         case DEMUX_GET_PTS_DELAY:
 303             pi64 = (int64_t*)va_arg( args, int64_t * );
 304             *pi64 = var_GetInteger( p_demux, "screen-caching" ) *1000;
 305             return VLC_SUCCESS;
 306
 307         case DEMUX_GET_TIME:
 308             pi64 = (int64_t*)va_arg( args, int64_t * );
 309             *pi64 = mdate();
 310             return VLC_SUCCESS;
 311
 312         /* TODO implement others */
 313         default:
 314             return VLC_EGENERIC;
 315     }
 316 }
 317
 318 #ifdef SCREEN_SUBSCREEN
 319 void FollowMouse( demux_sys_t *p_sys, int i_x, int i_y )
 320 {
 321     i_x -= p_sys->i_width/2;
 322     if( i_x < 0 ) i_x = 0;
 323     p_sys->i_left = __MIN( (unsigned int)i_x,
 324     p_sys->i_screen_width - p_sys->i_width );
 325
 326     i_y -= p_sys->i_height/2;
 327     if( i_y < 0 ) i_y = 0;
 328     p_sys->i_top = __MIN( (unsigned int)i_y,
 329     p_sys->i_screen_height - p_sys->i_height );
 330 }
 331 #endif
 332
 333 #ifdef SCREEN_MOUSE
 334 void RenderCursor( demux_t *p_demux, int i_x, int i_y,
 335                    uint8_t *p_dst )
 336 {
 337     demux_sys_t *p_sys = p_demux->p_sys;
 338     if( !p_sys->dst.i_planes )
 339         picture_Setup( &p_sys->dst,
 340                        p_sys->fmt.video.i_chroma,
 341                        p_sys->fmt.video.i_width,
 342                        p_sys->fmt.video.i_height,
 343                        p_sys->fmt.video.i_sar_num,
 344                        p_sys->fmt.video.i_sar_den );
 345     if( !p_sys->p_blend )
 346     {
 347         p_sys->p_blend = vlc_object_create( p_demux, sizeof(filter_t) );
 348         if( p_sys->p_blend )
 349         {
 350             es_format_Init( &p_sys->p_blend->fmt_in, VIDEO_ES,
 351                             VLC_CODEC_RGBA );
 352             p_sys->p_blend->fmt_in.video = p_sys->p_mouse->format;
 353             p_sys->p_blend->fmt_out = p_sys->fmt;
 354             p_sys->p_blend->p_module =
 355                 module_need( p_sys->p_blend, "video blending", NULL, false );
 356             if( !p_sys->p_blend->p_module )
 357             {
 358                 msg_Err( p_demux, "Could not load video blending module" );
 359                 vlc_object_release( p_sys->p_blend );
 360                 p_sys->p_blend = NULL;
 361             }
 362         }
 363     }
 364     if( p_sys->p_blend )
 365     {
 366         p_sys->dst.p->p_pixels = p_dst;
 367         p_sys->p_blend->pf_video_blend( p_sys->p_blend,
 368                                         &p_sys->dst,
 369                                         p_sys->p_mouse,
 370 #ifdef SCREEN_SUBSCREEN
 371                                         i_x-p_sys->i_left,
 372 #else
 373                                         i_x,
 374 #endif
 375 #ifdef SCREEN_SUBSCREEN
 376                                         i_y-p_sys->i_top,
 377 #else
 378                                         i_y,
 379 #endif
 380                                         255 );
 381     }
 382     else
 383     {
 384         picture_Release( p_sys->p_mouse );
 385         p_sys->p_mouse = NULL;
 386     }
 387 }
 388 #endif