1 /*****************************************************************************
3 *****************************************************************************
4 * Copyright (C) 2013 VideoLAN Authors
5 *****************************************************************************
7 * This program is free software; you can redistribute it and/or modify it
8 * under the terms of the GNU Lesser General Public License as published by
9 * the Free Software Foundation; either version 2.1 of the License, or
10 * (at your option) any later version.
12 * This program is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 * GNU Lesser General Public License for more details.
17 * You should have received a copy of the GNU Lesser General Public License
18 * along with this program; if not, write to the Free Software Foundation,
19 * Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
20 *****************************************************************************/
22 /*****************************************************************************
23 * NOTA BENE: this module requires the linking against a library which is
24 * known to require licensing under the GNU General Public License version 2
25 * (or later). Therefore, the result of compiling this module will normally
26 * be subject to the terms of that later license.
27 *****************************************************************************/
29 /*****************************************************************************
31 *****************************************************************************/
37 #include <vlc_common.h>
38 #include <vlc_plugin.h>
39 #include <vlc_demux.h>
42 #include <vlc_fourcc.h>
44 #include <rfb/rfbclient.h>
46 #define RFB_USER N_("Username")
47 #define RFB_PASSWORD N_("Password")
48 #define RFB_CA_TEXT N_("X.509 Certificate Authority")
49 #define RFB_CA_LONGTEXT N_("Certificate of the Authority to verify server's against")
50 #define RFB_CRL_TEXT N_("X.509 Certificate Revocation List")
51 #define RFB_CRL_LONGTEXT N_("List of revoked servers certificates")
52 #define RFB_CERT_TEXT N_("X.509 Client certificate")
53 #define RFB_CERT_LONGTEXT N_("Certificate for client authentification")
54 #define RFB_KEY_TEXT N_("X.509 Client private key")
55 #define RFB_KEY_LONGTEXT N_("Private key for authentification by certificate")
57 #define RFB_CHROMA N_("Frame buffer depth")
58 #define RFB_CHROMA_LONGTEXT N_("RGB chroma (RV32, RV24, RV16, RGB2)")
59 #define RFB_FPS N_("Frame rate")
60 #define RFB_FPS_LONGTEXT N_("How many times the screen content should be refreshed per second.")
61 #define RFB_COMPRESS N_("Compression level")
62 #define RFB_COMPRESS_LONGTEXT N_("Transfer compression level from 0 (none) to 9 (max)")
63 #define RFB_QUALITY N_("Image quality")
64 #define RFB_QUALITY_LONGTEXT N_("Image quality 1 to 9 (max)")
66 #define CFG_PREFIX "rfb-"
68 const char *const rgb_chromas[] = { N_("32 bits"), N_("24 bits"), N_("16 bits"), N_("8 bits") };
69 const char *const rgb_chromas_v[] = { "RV32", "RV24", "RV16", "RGB8" };
71 /*****************************************************************************
73 *****************************************************************************/
74 static int Open ( vlc_object_t * );
75 static void Close( vlc_object_t * );
78 set_shortname( N_("VNC") )
80 set_category( CAT_INPUT )
81 set_subcategory( SUBCAT_INPUT_ACCESS )
82 set_description( N_("VNC client access") )
83 set_capability( "access_demux", 0 )
85 add_string( CFG_PREFIX "user", NULL, RFB_USER, RFB_USER, false )
87 add_password( CFG_PREFIX "password", NULL, RFB_PASSWORD, RFB_PASSWORD, false )
89 add_loadfile( CFG_PREFIX "x509-ca", NULL, RFB_CA_TEXT, RFB_CA_LONGTEXT, true )
91 add_loadfile( CFG_PREFIX "x509-crl", NULL, RFB_CRL_TEXT, RFB_CRL_LONGTEXT, true )
93 add_loadfile( CFG_PREFIX "x509-client-cert", NULL, RFB_CERT_TEXT, RFB_CERT_LONGTEXT, true )
95 add_loadfile( CFG_PREFIX "x509-client-key", NULL, RFB_KEY_TEXT, RFB_KEY_LONGTEXT, true )
98 add_float( CFG_PREFIX "fps", 5, RFB_FPS, RFB_FPS_LONGTEXT, true )
99 add_string( CFG_PREFIX "chroma", rgb_chromas_v[0], RFB_CHROMA, RFB_CHROMA_LONGTEXT, false )
100 change_string_list (rgb_chromas_v, rgb_chromas)
102 add_integer( CFG_PREFIX "compress-level", 0, RFB_COMPRESS, RFB_COMPRESS_LONGTEXT, true )
103 change_integer_range (0, 9)
105 add_integer( CFG_PREFIX "quality-level", 9, RFB_QUALITY, RFB_QUALITY_LONGTEXT, true )
106 change_integer_range (1, 9)
109 set_callbacks( Open, Close )
118 int i_framebuffersize;
122 int i_frame_interval;
128 static void *DemuxThread( void *p_data );
130 /*****************************************************************************
132 *****************************************************************************/
134 static rfbBool mallocFrameBufferHandler( rfbClient* p_client )
136 vlc_fourcc_t i_chroma;
137 demux_t *p_demux = (demux_t *) rfbClientGetClientData( p_client, DemuxThread );
138 demux_sys_t *p_sys = p_demux->p_sys;
140 if ( p_sys->es ) /* Source has changed resolution */
142 es_out_Del( p_demux->out, p_sys->es );
146 int i_width = p_client->width;
147 int i_height = p_client->height;
148 int i_depth = p_client->format.bitsPerPixel;
153 i_chroma = VLC_CODEC_RGB8;
157 i_chroma = VLC_CODEC_RGB16;
160 i_chroma = VLC_CODEC_RGB24;
163 i_chroma = VLC_CODEC_RGB32;
167 if ( i_chroma != VLC_CODEC_RGB8 ) /* Palette based, no mask */
169 video_format_t videofmt;
170 memset( &videofmt, 0, sizeof(video_format_t) );
171 videofmt.i_chroma = i_chroma;
172 video_format_FixRgb( &videofmt );
174 p_client->format.redShift = videofmt.i_lrshift;
175 p_client->format.greenShift = videofmt.i_lgshift;
176 p_client->format.blueShift = videofmt.i_lbshift;
177 p_client->format.redMax = videofmt.i_rmask >> videofmt.i_lrshift;
178 p_client->format.greenMax = videofmt.i_gmask >> videofmt.i_lgshift;
179 p_client->format.blueMax = videofmt.i_bmask >> videofmt.i_lbshift;
182 /* Set up framebuffer */
183 p_sys->i_framebuffersize = i_width * i_height * i_depth / 8;
185 /* Reuse unsent block */
186 if ( p_sys->p_block )
187 p_sys->p_block = block_Realloc( p_sys->p_block, 0, p_sys->i_framebuffersize );
189 p_sys->p_block = block_Alloc( p_sys->i_framebuffersize );
191 if ( p_sys->p_block )
192 p_sys->p_block->i_buffer = p_sys->i_framebuffersize;
196 /* Push our VNC config */
197 SetFormatAndEncodings( p_client );
199 /* Now init and fill es format */
201 es_format_Init( &fmt, VIDEO_ES, i_chroma );
203 /* Fill input format */
204 fmt.video.i_chroma = i_chroma;
205 fmt.video.i_visible_width =
206 fmt.video.i_width = i_width;
208 fmt.video.i_visible_height =
209 fmt.video.i_height = i_height;
211 fmt.video.i_frame_rate_base = 1000;
212 fmt.video.i_frame_rate = 1000 * p_sys->f_fps;
214 fmt.video.i_bits_per_pixel = i_depth;
215 fmt.video.i_rmask = p_client->format.redMax << p_client->format.redShift;
216 fmt.video.i_gmask = p_client->format.greenMax << p_client->format.greenShift;
217 fmt.video.i_bmask = p_client->format.blueMax << p_client->format.blueShift;
219 fmt.video.i_sar_num = fmt.video.i_sar_den = 1;
221 /* declare the new es */
222 p_sys->es = es_out_Add( p_demux->out, &fmt );
228 static char *getPasswordHandler( rfbClient *p_client )
230 demux_t *p_demux = (demux_t *) rfbClientGetClientData( p_client, DemuxThread );
231 /* freed by libvnc */
232 return var_InheritString( p_demux, CFG_PREFIX "password" );
235 static rfbCredential* getCredentialHandler( rfbClient *p_client, int i_credentialType )
237 demux_t *p_demux = (demux_t *) rfbClientGetClientData( p_client, DemuxThread );
239 rfbCredential *credential = calloc( 1, sizeof(rfbCredential) );
240 if ( !credential ) return NULL;
242 switch( i_credentialType )
244 case rfbCredentialTypeX509:
245 /* X509None, X509Vnc, X509Plain */
246 credential->x509Credential.x509CACertFile =
247 var_InheritString( p_demux, CFG_PREFIX "x509-ca" );
248 credential->x509Credential.x509CACrlFile =
249 var_InheritString( p_demux, CFG_PREFIX "x509-crl" );
250 /* client auth by certificate */
251 credential->x509Credential.x509ClientCertFile =
252 var_InheritString( p_demux, CFG_PREFIX "x509-client-cert" );
253 credential->x509Credential.x509ClientKeyFile =
254 var_InheritString( p_demux, CFG_PREFIX "x509-client-key" );
257 case rfbCredentialTypeUser:
258 credential->userCredential.username =
259 var_InheritString( p_demux, CFG_PREFIX "user" );
260 credential->userCredential.password =
261 var_InheritString( p_demux, CFG_PREFIX "password" );
266 return NULL; /* Unsupported Auth */
268 /* freed by libvnc */
272 /*****************************************************************************
274 *****************************************************************************/
275 static int Control( demux_t *p_demux, int i_query, va_list args )
284 case DEMUX_CAN_PAUSE:
286 case DEMUX_CAN_CONTROL_PACE:
287 case DEMUX_CAN_CONTROL_RATE:
288 case DEMUX_HAS_UNSUPPORTED_META:
289 pb = (bool*)va_arg( args, bool * );
293 case DEMUX_CAN_RECORD:
294 pb = (bool*)va_arg( args, bool * );
298 case DEMUX_GET_PTS_DELAY:
299 pi64 = (int64_t*)va_arg( args, int64_t * );
300 *pi64 = INT64_C(1000)
301 * var_InheritInteger( p_demux, "network-caching" );
305 pi64 = (int64_t*)va_arg( args, int64_t * );
306 *pi64 = mdate() - p_demux->p_sys->i_starttime;
309 case DEMUX_GET_LENGTH:
310 pi64 = (int64_t*)va_arg( args, int64_t * );
315 p_dbl = (double*)va_arg( args, double * );
316 *p_dbl = p_demux->p_sys->f_fps;
320 p_meta = (vlc_meta_t*)va_arg( args, vlc_meta_t* );
321 vlc_meta_Set( p_meta, vlc_meta_Title, p_demux->psz_location );
329 /*****************************************************************************
331 *****************************************************************************/
333 static void *DemuxThread( void *p_data )
335 demux_t *p_demux = (demux_t *) p_data;
336 demux_sys_t *p_sys = p_demux->p_sys;
337 mtime_t i_next_frame_date = mdate() + p_sys->i_frame_interval;
342 p_sys->i_cancel_state = vlc_savecancel();
343 i_status = WaitForMessage( p_sys->p_client, p_sys->i_frame_interval );
344 vlc_restorecancel( p_sys->i_cancel_state );
346 /* Ensure we're not building frames too fast */
347 /* as WaitForMessage takes only a maximum wait */
348 mwait( i_next_frame_date );
349 i_next_frame_date += p_sys->i_frame_interval;
353 p_sys->p_client->frameBuffer = p_sys->p_block->p_buffer;
354 p_sys->i_cancel_state = vlc_savecancel();
355 i_status = HandleRFBServerMessage( p_sys->p_client );
356 vlc_restorecancel( p_sys->i_cancel_state );
359 msg_Warn( p_demux, "Cannot get announced data. Server closed ?" );
360 es_out_Del( p_demux->out, p_sys->es );
366 block_t *p_block = block_Duplicate( p_sys->p_block );
367 if ( p_block ) /* drop frame/content if no next block */
369 p_sys->p_block->i_dts = p_sys->p_block->i_pts = mdate();
370 es_out_Control( p_demux->out, ES_OUT_SET_PCR, p_sys->p_block->i_pts );
371 es_out_Send( p_demux->out, p_sys->es, p_sys->p_block );
372 p_sys->p_block = p_block;
380 /*****************************************************************************
382 *****************************************************************************/
383 static int Open( vlc_object_t *p_this )
385 demux_t *p_demux = (demux_t*)p_this;
388 p_sys = calloc( 1, sizeof(demux_sys_t) );
389 if( !p_sys ) return VLC_ENOMEM;
391 p_sys->f_fps = var_InheritFloat( p_demux, CFG_PREFIX "fps" );
392 if ( p_sys->f_fps <= 0 ) p_sys->f_fps = 1.0;
393 p_sys->i_frame_interval = 1000000 / p_sys->f_fps ;
395 char *psz_chroma = var_InheritString( p_demux, CFG_PREFIX "chroma" );
396 vlc_fourcc_t i_chroma = vlc_fourcc_GetCodecFromString( VIDEO_ES, psz_chroma );
398 if ( !i_chroma || vlc_fourcc_IsYUV( i_chroma ) )
400 msg_Err( p_demux, "Only RGB chroma are supported" );
405 const vlc_chroma_description_t *p_chroma_desc = vlc_fourcc_GetChromaDescription( i_chroma );
406 if ( !p_chroma_desc )
408 msg_Err( p_demux, "Unable to get RGB chroma description" );
414 rfbEnableClientLogging = FALSE;
417 p_sys->p_client = rfbGetClient( p_chroma_desc->pixel_bits / 3, // bitsPerSample
418 3, // samplesPerPixel
419 p_chroma_desc->pixel_size ); // bytesPerPixel
420 if ( ! p_sys->p_client )
422 msg_Dbg( p_demux, "Unable to set up client for %s",
423 vlc_fourcc_GetDescription( VIDEO_ES, i_chroma ) );
428 msg_Dbg( p_demux, "set up client for %s %d %d %d",
429 vlc_fourcc_GetDescription( VIDEO_ES, i_chroma ),
430 p_chroma_desc->pixel_bits / 3, 3, p_chroma_desc->pixel_size );
432 p_sys->p_client->MallocFrameBuffer = mallocFrameBufferHandler;
433 p_sys->p_client->canHandleNewFBSize = TRUE;
434 p_sys->p_client->GetCredential = getCredentialHandler;
435 p_sys->p_client->GetPassword = getPasswordHandler; /* VNC simple auth */
437 /* Set compression and quality levels */
438 p_sys->p_client->appData.compressLevel =
439 var_InheritInteger( p_demux, CFG_PREFIX "compress-level" );
440 p_sys->p_client->appData.qualityLevel =
441 var_InheritInteger( p_demux, CFG_PREFIX "quality-level" );
443 /* Parse uri params */
445 vlc_UrlParse( &url, p_demux->psz_location, 0 );
447 if ( !EMPTY_STR(url.psz_host) )
448 p_sys->p_client->serverHost = strdup( url.psz_host );
450 p_sys->p_client->serverHost = strdup( "localhost" );
452 p_sys->p_client->appData.viewOnly = TRUE;
453 p_sys->p_client->serverPort = ( url.i_port > 0 ) ? url.i_port : 5900;
455 msg_Dbg( p_demux, "VNC init %s host=%s pass=%s port=%d",
456 p_demux->psz_location,
457 p_sys->p_client->serverHost,
459 p_sys->p_client->serverPort );
461 vlc_UrlClean( &url );
463 /* make demux available for callback handlers */
464 rfbClientSetClientData( p_sys->p_client, DemuxThread, p_demux );
465 p_demux->p_sys = p_sys;
467 if( !rfbInitClient( p_sys->p_client, NULL, NULL ) )
469 msg_Err( p_demux, "can't connect to RFB server" );
473 p_sys->i_starttime = mdate();
475 if ( vlc_clone( &p_sys->thread, DemuxThread, p_demux, VLC_THREAD_PRIORITY_INPUT ) != VLC_SUCCESS )
477 msg_Err( p_demux, "can't spawn thread" );
481 p_demux->pf_demux = NULL;
482 p_demux->pf_control = Control;
491 /*****************************************************************************
493 *****************************************************************************/
494 static void Close( vlc_object_t *p_this )
496 demux_t *p_demux = (demux_t*)p_this;
497 demux_sys_t *p_sys = p_demux->p_sys;
499 vlc_cancel( p_sys->thread );
500 vlc_join( p_sys->thread, NULL );
503 es_out_Del( p_demux->out, p_sys->es );
505 rfbClientCleanup( p_sys->p_client );
507 if ( p_sys->p_block )
508 block_Release( p_sys->p_block );