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