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