* modules/access/screen.c: new screen capture access module. Only X11 for now but...
[vlc.git] / modules / access / screen.c
1 /*****************************************************************************
2  * screen.c: Screen capture module.
3  *****************************************************************************
4  * Copyright (C) 2004 VideoLAN
5  * $Id$
6  *
7  * Authors: Gildas Bazin <gbazin@videolan.org>
8  *
9  * This program is free software; you can redistribute it and/or modify
10  * it under the terms of the GNU General Public License as published by
11  * the Free Software Foundation; either version 2 of the License, or
12  * (at your option) any later version.
13  *
14  * This program is distributed in the hope that it will be useful,
15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
17  * GNU General Public License for more details.
18  *
19  * You should have received a copy of the GNU General Public License
20  * along with this program; if not, write to the Free Software
21  * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111, USA.
22  *****************************************************************************/
23
24 /*****************************************************************************
25  * Preamble
26  *****************************************************************************/
27 #include <stdlib.h>
28
29 #include <vlc/vlc.h>
30 #include <vlc/input.h>
31
32 #ifndef WIN32
33 #   include <X11/Xlib.h>
34 #   include <X11/Xutil.h>
35 #endif
36
37 /*****************************************************************************
38  * Module descriptor
39  *****************************************************************************/
40 #define CACHING_TEXT N_("Caching value in ms")
41 #define CACHING_LONGTEXT N_( \
42     "Allows you to modify the default caching value for screen capture " \
43     "streams. This value should be set in millisecond units." )
44 #define FPS_TEXT N_("Frame rate")
45 #define FPS_LONGTEXT N_( \
46     "Allows you to set the desired frame rate for the capture." )
47
48 static int  Open ( vlc_object_t * );
49 static void Close( vlc_object_t * );
50
51 vlc_module_begin();
52     set_description( _("Screen Input") );
53
54     add_integer( "screen-caching", DEFAULT_PTS_DELAY / 1000, NULL,
55         CACHING_TEXT, CACHING_LONGTEXT, VLC_TRUE );
56     add_float( "screen-fps", 5, NULL, FPS_TEXT, FPS_LONGTEXT, VLC_TRUE );
57
58     set_capability( "access_demux", 0 );
59     add_shortcut( "screen" );
60     set_callbacks( Open, Close );
61 vlc_module_end();
62
63 /*****************************************************************************
64  * Local prototypes
65  *****************************************************************************/
66 struct demux_sys_t
67 {
68     es_format_t fmt;
69     es_out_id_t *es;
70
71     float f_fps;
72     mtime_t i_next_date;
73     int i_incr;
74
75 #ifndef WIN32
76     Display *p_display;
77 #endif
78 };
79
80 static int Control( demux_t *, int, va_list );
81 static int Demux  ( demux_t * );
82
83 static int InitCapture ( demux_t * );
84 static int CloseCapture( demux_t * );
85 static block_t *Capture( demux_t * );
86
87 /*****************************************************************************
88  * DemuxOpen:
89  *****************************************************************************/
90 static int Open( vlc_object_t *p_this )
91 {
92     demux_t     *p_demux = (demux_t*)p_this;
93     demux_sys_t *p_sys;
94     vlc_value_t val;
95
96     /* Fill p_demux field */
97     p_demux->pf_demux = Demux;
98     p_demux->pf_control = Control;
99     p_demux->p_sys = p_sys = malloc( sizeof( demux_sys_t ) );
100     memset( p_sys, 0, sizeof( demux_sys_t ) );
101
102
103     if( InitCapture( p_demux ) != VLC_SUCCESS )
104     {
105         free( p_sys );
106         return VLC_EGENERIC;
107     }
108
109     p_sys->es = es_out_Add( p_demux->out, &p_sys->fmt );
110
111     /* Update default_pts to a suitable value for screen access */
112     var_Create( p_demux, "screen-caching", VLC_VAR_INTEGER|VLC_VAR_DOINHERIT );
113
114     var_Create( p_demux, "screen-fps", VLC_VAR_FLOAT|VLC_VAR_DOINHERIT );
115     var_Get( p_demux, "screen-fps", &val );
116     p_sys->f_fps = val.f_float;
117     p_sys->i_incr = 1000000 / val.f_float;
118     p_sys->i_next_date = 0;
119
120     return VLC_SUCCESS;
121 }
122
123 /*****************************************************************************
124  * Close:
125  *****************************************************************************/
126 static void Close( vlc_object_t *p_this )
127 {
128     demux_t     *p_demux = (demux_t*)p_this;
129     demux_sys_t *p_sys = p_demux->p_sys;
130
131     CloseCapture( p_demux );
132     free( p_sys );
133 }
134
135 /*****************************************************************************
136  * Demux:
137  *****************************************************************************/
138 static int Demux( demux_t *p_demux )
139 {
140     demux_sys_t *p_sys = p_demux->p_sys;
141     block_t *p_block;
142
143     if( !p_sys->i_next_date ) p_sys->i_next_date = mdate();
144
145     /* Frame skipping if necessary */
146     while( mdate() >= p_sys->i_next_date + p_sys->i_incr )
147         p_sys->i_next_date += p_sys->i_incr;
148
149     mwait( p_sys->i_next_date );
150     p_block = Capture( p_demux );
151     if( !p_block ) return 0;
152
153     p_block->i_dts = p_block->i_pts = p_sys->i_next_date;
154
155     es_out_Control( p_demux->out, ES_OUT_SET_PCR, p_block->i_pts );
156     es_out_Send( p_demux->out, p_sys->es, p_block );
157
158     p_sys->i_next_date += p_sys->i_incr;
159
160     return 1;
161 }
162
163 /*****************************************************************************
164  * Platform dependant capture functions
165  *****************************************************************************/
166 #ifdef WIN32
167 static int InitCapture( demux_t *p_demux )
168 {
169     return VLC_EGENERIC;
170 }
171 #else
172
173 static int InitCapture( demux_t *p_demux )
174 {
175     demux_sys_t *p_sys = p_demux->p_sys;
176     XWindowAttributes win_info;
177     int i_chroma;
178
179     /* Open the display */
180     p_sys->p_display = XOpenDisplay( NULL );
181     if( !p_sys->p_display )
182     {
183         msg_Err( p_demux, "cannot open display" );
184         return VLC_EGENERIC;
185     }
186
187     /* Get the parameters of the root window */
188     if( !XGetWindowAttributes( p_sys->p_display,
189                                DefaultRootWindow( p_sys->p_display ),
190                                &win_info ) )
191     {
192         msg_Err( p_demux, "can't get root window attributes" );
193         XCloseDisplay( p_sys->p_display );
194         return VLC_EGENERIC;
195     }
196
197     switch( win_info.depth )
198     {
199     case 8: /* FIXME: set the palette */
200         i_chroma = VLC_FOURCC('R','G','B','2'); break;
201     case 15:
202         i_chroma = VLC_FOURCC('R','V','1','5'); break;
203     case 16:
204         i_chroma = VLC_FOURCC('R','V','1','6'); break;
205     case 24:
206         i_chroma = VLC_FOURCC('R','V','2','4'); break;
207     case 32:
208         i_chroma = VLC_FOURCC('R','V','3','2'); break;
209     default:
210         msg_Err( p_demux, "unknown screen depth %i", win_info.depth );
211         XCloseDisplay( p_sys->p_display );
212         return VLC_EGENERIC;
213     }
214
215     es_format_Init( &p_sys->fmt, VIDEO_ES, i_chroma );
216     p_sys->fmt.video.i_width  = win_info.width;
217     p_sys->fmt.video.i_height = win_info.height;
218
219 #if 0
220     win_info.visual->red_mask;
221     win_info.visual->green_mask;
222     win_info.visual->blue_mask;
223     win_info.visual->bits_per_rgb;
224 #endif
225
226     return VLC_SUCCESS;
227 }
228 #endif
229
230 #ifdef WIN32
231 static int CloseCapture( demux_t *p_demux )
232 {
233     return VLC_SUCCESS;
234 }
235 #else
236 static int CloseCapture( demux_t *p_demux )
237 {
238     demux_sys_t *p_sys = p_demux->p_sys;
239
240     XCloseDisplay( p_sys->p_display );
241     return VLC_SUCCESS;
242 }
243 #endif
244
245 #ifdef WIN32
246 static block_t *Capture( demux_t *p_demux )
247 {
248     return NULL;
249 }
250 #else
251 static block_t *Capture( demux_t *p_demux )
252 {
253     demux_sys_t *p_sys = p_demux->p_sys;
254     block_t *p_block;
255     XImage *image;
256     int i_size;
257
258     image = XGetImage( p_sys->p_display, DefaultRootWindow( p_sys->p_display ),
259                        0, 0, p_sys->fmt.video.i_width,
260                        p_sys->fmt.video.i_height, AllPlanes, ZPixmap );
261
262     if( !image )
263     {
264         msg_Warn( p_demux, "cannot get image" );
265         return 0;
266     }
267
268     i_size = image->bytes_per_line * image->height;
269
270     if( !( p_block = block_New( p_demux, i_size ) ) )
271     {
272         msg_Warn( p_demux, "cannot get block" );
273         XDestroyImage( image );
274         return 0;
275     }
276
277     memcpy( p_block->p_buffer, image->data, i_size );
278
279     XDestroyImage( image );
280
281     return p_block;
282 }
283 #endif
284
285 /*****************************************************************************
286  * Control:
287  *****************************************************************************/
288 static int Control( demux_t *p_demux, int i_query, va_list args )
289 {
290     vlc_bool_t *pb;
291     int64_t *pi64;
292
293     switch( i_query )
294     {
295         /* Special for access_demux */
296         case DEMUX_CAN_PAUSE:
297         case DEMUX_CAN_CONTROL_PACE:
298             /* TODO */
299             pb = (vlc_bool_t*)va_arg( args, vlc_bool_t * );
300             *pb = VLC_FALSE;
301             return VLC_SUCCESS;
302
303         case DEMUX_GET_PTS_DELAY:
304             pi64 = (int64_t*)va_arg( args, int64_t * );
305             *pi64 = (int64_t)var_GetInteger( p_demux, "screen-caching" ) *1000;
306             return VLC_SUCCESS;
307
308         /* TODO implement others */
309         default:
310             return VLC_EGENERIC;
311     }
312 }