modules/access/vnc.c

   1 /*****************************************************************************
   2  * vnc.c: libVNC access
   3  *****************************************************************************
   4  * Copyright (C) 2013 VideoLAN and VLC Authors
   5  *****************************************************************************
   6  *
   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.
  11  *
  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.
  16  *
  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  *****************************************************************************/
  21
  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  *****************************************************************************/
  28
  29 /*****************************************************************************
  30  * Preamble
  31  *****************************************************************************/
  32
  33 #ifdef HAVE_CONFIG_H
  34 # include "config.h"
  35 #endif
  36
  37 #include <vlc_common.h>
  38 #include <vlc_plugin.h>
  39 #include <vlc_demux.h>
  40 #include <vlc_url.h>
  41 #include <vlc_meta.h>
  42 #include <vlc_fourcc.h>
  43
  44 #include <rfb/rfbclient.h>
  45
  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 authentication")
  54 #define RFB_KEY_TEXT N_("X.509 Client private key")
  55 #define RFB_KEY_LONGTEXT N_("Private key for authentication by certificate")
  56
  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)")
  65
  66 #define CFG_PREFIX "rfb-"
  67
  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" };
  70
  71 /*****************************************************************************
  72  * Module descriptor
  73  *****************************************************************************/
  74 static int  Open ( vlc_object_t * );
  75 static void Close( vlc_object_t * );
  76
  77 vlc_module_begin()
  78     set_shortname( N_("VNC") )
  79     add_shortcut( "vnc" )
  80     set_category( CAT_INPUT )
  81     set_subcategory( SUBCAT_INPUT_ACCESS )
  82     set_description( N_("VNC client access") )
  83     set_capability( "access", 0 )
  84
  85     add_string( CFG_PREFIX "user", NULL, RFB_USER, RFB_USER, false )
  86         change_safe()
  87     add_password(CFG_PREFIX "password", NULL, RFB_PASSWORD, RFB_PASSWORD)
  88         change_safe()
  89     add_loadfile(CFG_PREFIX "x509-ca", NULL, RFB_CA_TEXT, RFB_CA_LONGTEXT)
  90         change_safe()
  91     add_loadfile(CFG_PREFIX "x509-crl", NULL, RFB_CRL_TEXT, RFB_CRL_LONGTEXT)
  92         change_safe()
  93     add_loadfile(CFG_PREFIX "x509-client-cert", NULL,
  94                  RFB_CERT_TEXT, RFB_CERT_LONGTEXT)
  95         change_safe()
  96     add_loadfile(CFG_PREFIX "x509-client-key", NULL,
  97                  RFB_KEY_TEXT, RFB_KEY_LONGTEXT)
  98         change_safe()
  99
 100     add_float( CFG_PREFIX "fps", 5, RFB_FPS, RFB_FPS_LONGTEXT, true )
 101     add_string( CFG_PREFIX "chroma", rgb_chromas_v[0], RFB_CHROMA, RFB_CHROMA_LONGTEXT, false )
 102         change_string_list (rgb_chromas_v, rgb_chromas)
 103         change_safe()
 104     add_integer( CFG_PREFIX "compress-level", 0, RFB_COMPRESS, RFB_COMPRESS_LONGTEXT, true )
 105         change_integer_range (0, 9)
 106         change_safe()
 107     add_integer( CFG_PREFIX "quality-level", 9, RFB_QUALITY, RFB_QUALITY_LONGTEXT, true )
 108         change_integer_range (1, 9)
 109         change_safe()
 110
 111     set_callbacks( Open, Close )
 112 vlc_module_end()
 113
 114 typedef struct
 115 {
 116     vlc_thread_t thread;
 117     int i_cancel_state;
 118
 119     rfbClient* p_client;
 120     int i_framebuffersize;
 121     block_t *p_block;
 122
 123     float f_fps;
 124     int i_frame_interval;
 125     vlc_tick_t i_starttime;
 126
 127     es_out_id_t *es;
 128 } demux_sys_t;
 129
 130 static void *DemuxThread( void *p_data );
 131
 132 /*****************************************************************************
 133  * Local prototypes
 134  *****************************************************************************/
 135
 136 static rfbBool mallocFrameBufferHandler( rfbClient* p_client )
 137 {
 138     vlc_fourcc_t i_chroma;
 139     demux_t *p_demux = (demux_t *) rfbClientGetClientData( p_client, DemuxThread );
 140     demux_sys_t *p_sys = p_demux->p_sys;
 141
 142     if ( p_sys->es ) /* Source has changed resolution */
 143     {
 144         es_out_Del( p_demux->out, p_sys->es );
 145         p_sys->es = NULL;
 146     }
 147
 148     int i_width = p_client->width;
 149     int i_height = p_client->height;
 150     int i_depth = p_client->format.bitsPerPixel;
 151
 152     switch( i_depth )
 153     {
 154         case 8:
 155             i_chroma = VLC_CODEC_RGB8;
 156             break;
 157         default:
 158         case 16:
 159             i_chroma = VLC_CODEC_RGB16;
 160             break;
 161         case 24:
 162             i_chroma = VLC_CODEC_RGB24;
 163             break;
 164         case 32:
 165             i_chroma = VLC_CODEC_RGB32;
 166             break;
 167     }
 168
 169     if ( i_chroma != VLC_CODEC_RGB8 ) /* Palette based, no mask */
 170     {
 171         video_format_t videofmt;
 172         video_format_Init( &videofmt, i_chroma );
 173         video_format_FixRgb( &videofmt );
 174
 175         p_client->format.redShift = videofmt.i_lrshift;
 176         p_client->format.greenShift = videofmt.i_lgshift;
 177         p_client->format.blueShift = videofmt.i_lbshift;
 178         p_client->format.redMax = videofmt.i_rmask >> videofmt.i_lrshift;
 179         p_client->format.greenMax = videofmt.i_gmask >> videofmt.i_lgshift;
 180         p_client->format.blueMax = videofmt.i_bmask >> videofmt.i_lbshift;
 181         video_format_Clean( &videofmt );
 182     }
 183
 184     /* Set up framebuffer */
 185     p_sys->i_framebuffersize = i_width * i_height * i_depth / 8;
 186
 187     /* Reuse unsent block */
 188     if ( p_sys->p_block )
 189         p_sys->p_block = block_Realloc( p_sys->p_block, 0, p_sys->i_framebuffersize );
 190     else
 191         p_sys->p_block = block_Alloc( p_sys->i_framebuffersize );
 192
 193     if ( p_sys->p_block )
 194         p_sys->p_block->i_buffer = p_sys->i_framebuffersize;
 195     else
 196         return FALSE;
 197
 198     /* Push our VNC config */
 199     SetFormatAndEncodings( p_client );
 200
 201     /* Now init and fill es format */
 202     es_format_t fmt;
 203     es_format_Init( &fmt, VIDEO_ES, i_chroma );
 204
 205     /* Fill input format */
 206     fmt.video.i_chroma = i_chroma;
 207     fmt.video.i_visible_width =
 208             fmt.video.i_width = i_width;
 209
 210     fmt.video.i_visible_height =
 211             fmt.video.i_height = i_height;
 212
 213     fmt.video.i_frame_rate_base = 1000;
 214     fmt.video.i_frame_rate = 1000 * p_sys->f_fps;
 215
 216     fmt.video.i_bits_per_pixel = i_depth;
 217     fmt.video.i_rmask = p_client->format.redMax << p_client->format.redShift;
 218     fmt.video.i_gmask = p_client->format.greenMax << p_client->format.greenShift;
 219     fmt.video.i_bmask = p_client->format.blueMax << p_client->format.blueShift;
 220
 221     fmt.video.i_sar_num = fmt.video.i_sar_den = 1;
 222
 223     /* declare the new es */
 224     p_sys->es = es_out_Add( p_demux->out, &fmt );
 225
 226     return TRUE;
 227 }
 228
 229 /* Auth */
 230 static char *getPasswordHandler( rfbClient *p_client )
 231 {
 232     demux_t *p_demux = (demux_t *) rfbClientGetClientData( p_client, DemuxThread );
 233     /* freed by libvnc */
 234     return var_InheritString( p_demux, CFG_PREFIX "password" );
 235 }
 236
 237 static rfbCredential* getCredentialHandler( rfbClient *p_client, int i_credentialType )
 238 {
 239     demux_t *p_demux = (demux_t *) rfbClientGetClientData( p_client, DemuxThread );
 240
 241     rfbCredential *credential = calloc( 1, sizeof(rfbCredential) );
 242     if ( !credential ) return NULL;
 243
 244     switch( i_credentialType )
 245     {
 246         case rfbCredentialTypeX509:
 247             /* X509None, X509Vnc, X509Plain */
 248             credential->x509Credential.x509CACertFile =
 249                     var_InheritString( p_demux, CFG_PREFIX "x509-ca" );
 250             credential->x509Credential.x509CACrlFile =
 251                     var_InheritString( p_demux, CFG_PREFIX "x509-crl" );
 252             /* client auth by certificate */
 253             credential->x509Credential.x509ClientCertFile =
 254                     var_InheritString( p_demux, CFG_PREFIX "x509-client-cert" );
 255             credential->x509Credential.x509ClientKeyFile =
 256                     var_InheritString( p_demux, CFG_PREFIX "x509-client-key" );
 257             break;
 258
 259         case rfbCredentialTypeUser:
 260             credential->userCredential.username =
 261                     var_InheritString( p_demux, CFG_PREFIX "user" );
 262             credential->userCredential.password =
 263                     var_InheritString( p_demux, CFG_PREFIX "password" );
 264             break;
 265
 266         default:
 267             free( credential );
 268             return NULL; /* Unsupported Auth */
 269     }
 270     /* freed by libvnc */
 271     return credential;
 272 }
 273
 274 /*****************************************************************************
 275  * Control:
 276  *****************************************************************************/
 277 static int Control( demux_t *p_demux, int i_query, va_list args )
 278 {
 279     demux_sys_t *p_sys = p_demux->p_sys;
 280     bool *pb;
 281     int64_t *pi64;
 282     double *p_dbl;
 283     vlc_meta_t *p_meta;
 284
 285     switch( i_query )
 286     {
 287         case DEMUX_CAN_PAUSE:
 288         case DEMUX_CAN_SEEK:
 289         case DEMUX_CAN_CONTROL_PACE:
 290         case DEMUX_CAN_CONTROL_RATE:
 291         case DEMUX_HAS_UNSUPPORTED_META:
 292             pb = va_arg( args, bool * );
 293             *pb = false;
 294             return VLC_SUCCESS;
 295
 296         case DEMUX_CAN_RECORD:
 297             pb = va_arg( args, bool * );
 298             *pb = true;
 299             return VLC_SUCCESS;
 300
 301         case DEMUX_GET_PTS_DELAY:
 302             *va_arg( args, vlc_tick_t * ) =
 303                 VLC_TICK_FROM_MS(var_InheritInteger( p_demux, "network-caching" ));
 304             return VLC_SUCCESS;
 305
 306         case DEMUX_GET_TIME:
 307             pi64 = va_arg( args, int64_t * );
 308             *pi64 = vlc_tick_now() - p_sys->i_starttime;
 309             return VLC_SUCCESS;
 310
 311         case DEMUX_GET_LENGTH:
 312             pi64 = va_arg( args, int64_t * );
 313             *pi64 = 0;
 314             return VLC_SUCCESS;
 315
 316         case DEMUX_GET_FPS:
 317             p_dbl = va_arg( args, double * );
 318             *p_dbl = p_sys->f_fps;
 319             return VLC_SUCCESS;
 320
 321         case DEMUX_GET_META:
 322             p_meta = va_arg( args, vlc_meta_t * );
 323             vlc_meta_Set( p_meta, vlc_meta_Title, p_demux->psz_location );
 324             return VLC_SUCCESS;
 325
 326         default:
 327             return VLC_EGENERIC;
 328     }
 329 }
 330
 331 /*****************************************************************************
 332  * Demux:
 333  *****************************************************************************/
 334
 335 static void *DemuxThread( void *p_data )
 336 {
 337     demux_t *p_demux = (demux_t *) p_data;
 338     demux_sys_t  *p_sys = p_demux->p_sys;
 339     vlc_tick_t i_next_frame_date = vlc_tick_now() + p_sys->i_frame_interval;
 340     int i_status;
 341
 342     for(;;)
 343     {
 344         p_sys->i_cancel_state = vlc_savecancel();
 345         i_status = WaitForMessage( p_sys->p_client, p_sys->i_frame_interval );
 346         vlc_restorecancel( p_sys->i_cancel_state );
 347
 348         /* Ensure we're not building frames too fast */
 349         /* as WaitForMessage takes only a maximum wait */
 350         vlc_tick_wait( i_next_frame_date );
 351         i_next_frame_date += p_sys->i_frame_interval;
 352
 353         if ( i_status > 0 )
 354         {
 355             p_sys->p_client->frameBuffer = p_sys->p_block->p_buffer;
 356             p_sys->i_cancel_state = vlc_savecancel();
 357             i_status = HandleRFBServerMessage( p_sys->p_client );
 358             vlc_restorecancel( p_sys->i_cancel_state );
 359             if ( ! i_status )
 360             {
 361                 msg_Warn( p_demux, "Cannot get announced data. Server closed ?" );
 362                 es_out_Del( p_demux->out, p_sys->es );
 363                 p_sys->es = NULL;
 364                 return NULL;
 365             }
 366             else
 367             {
 368                 block_t *p_block = block_Duplicate( p_sys->p_block );
 369                 if ( p_block ) /* drop frame/content if no next block */
 370                 {
 371                     p_sys->p_block->i_dts = p_sys->p_block->i_pts = vlc_tick_now();
 372                     es_out_SetPCR( p_demux->out, p_sys->p_block->i_pts );
 373                     es_out_Send( p_demux->out, p_sys->es, p_sys->p_block );
 374                     p_sys->p_block = p_block;
 375                 }
 376             }
 377         }
 378     }
 379     return NULL;
 380 }
 381
 382 /*****************************************************************************
 383  * Open:
 384  *****************************************************************************/
 385 static int Open( vlc_object_t *p_this )
 386 {
 387     demux_t      *p_demux = (demux_t*)p_this;
 388     demux_sys_t  *p_sys;
 389
 390     if (p_demux->out == NULL)
 391         return VLC_EGENERIC;
 392
 393     p_sys = vlc_obj_calloc( p_this, 1, sizeof(demux_sys_t) );
 394     if( !p_sys ) return VLC_ENOMEM;
 395
 396     p_sys->f_fps = var_InheritFloat( p_demux, CFG_PREFIX "fps" );
 397     if ( p_sys->f_fps <= 0 ) p_sys->f_fps = 1.0;
 398     p_sys->i_frame_interval = CLOCK_FREQ / p_sys->f_fps ;
 399
 400     char *psz_chroma = var_InheritString( p_demux, CFG_PREFIX "chroma" );
 401     vlc_fourcc_t i_chroma = vlc_fourcc_GetCodecFromString( VIDEO_ES, psz_chroma );
 402     free( psz_chroma );
 403     if ( !i_chroma || vlc_fourcc_IsYUV( i_chroma ) )
 404     {
 405         msg_Err( p_demux, "Only RGB chroma are supported" );
 406         return VLC_EGENERIC;
 407     }
 408
 409     const vlc_chroma_description_t *p_chroma_desc = vlc_fourcc_GetChromaDescription( i_chroma );
 410     if ( !p_chroma_desc )
 411     {
 412         msg_Err( p_demux, "Unable to get RGB chroma description" );
 413         return VLC_EGENERIC;
 414     }
 415
 416 #ifdef NDEBUG
 417     rfbEnableClientLogging = FALSE;
 418 #endif
 419
 420     p_sys->p_client = rfbGetClient( p_chroma_desc->pixel_bits / 3, // bitsPerSample
 421                                     3, // samplesPerPixel
 422                                     p_chroma_desc->pixel_size ); // bytesPerPixel
 423     if ( ! p_sys->p_client )
 424     {
 425         msg_Dbg( p_demux, "Unable to set up client for %s",
 426                  vlc_fourcc_GetDescription( VIDEO_ES, i_chroma ) );
 427         return VLC_EGENERIC;
 428     }
 429
 430     msg_Dbg( p_demux, "set up client for %s %d %d %d",
 431              vlc_fourcc_GetDescription( VIDEO_ES, i_chroma ),
 432              p_chroma_desc->pixel_bits / 3, 3, p_chroma_desc->pixel_size );
 433
 434     p_sys->p_client->MallocFrameBuffer = mallocFrameBufferHandler;
 435     p_sys->p_client->canHandleNewFBSize = TRUE;
 436     p_sys->p_client->GetCredential = getCredentialHandler;
 437     p_sys->p_client->GetPassword = getPasswordHandler; /* VNC simple auth */
 438
 439     /* Set compression and quality levels */
 440     p_sys->p_client->appData.compressLevel =
 441             var_InheritInteger( p_demux, CFG_PREFIX "compress-level" );
 442     p_sys->p_client->appData.qualityLevel =
 443             var_InheritInteger( p_demux, CFG_PREFIX "quality-level" );
 444
 445     /* Parse uri params */
 446     vlc_url_t url;
 447     vlc_UrlParse( &url, p_demux->psz_location );
 448
 449     if ( !EMPTY_STR(url.psz_host) )
 450         p_sys->p_client->serverHost = strdup( url.psz_host );
 451     else
 452         p_sys->p_client->serverHost = strdup( "localhost" );
 453
 454     p_sys->p_client->appData.viewOnly = TRUE;
 455     p_sys->p_client->serverPort = ( url.i_port > 0 ) ? url.i_port : 5900;
 456
 457     msg_Dbg( p_demux, "VNC init %s host=%s port=%d",
 458              p_demux->psz_location,
 459              p_sys->p_client->serverHost,
 460              p_sys->p_client->serverPort );
 461
 462     vlc_UrlClean( &url );
 463
 464     /* make demux available for callback handlers */
 465     rfbClientSetClientData( p_sys->p_client, DemuxThread, p_demux );
 466     p_demux->p_sys = p_sys;
 467
 468     if( !rfbInitClient( p_sys->p_client, NULL, NULL ) )
 469     {
 470         msg_Err( p_demux, "can't connect to RFB server" );
 471         return VLC_EGENERIC;
 472     }
 473
 474     p_sys->i_starttime = vlc_tick_now();
 475
 476     if ( vlc_clone( &p_sys->thread, DemuxThread, p_demux, VLC_THREAD_PRIORITY_INPUT ) != VLC_SUCCESS )
 477     {
 478         msg_Err( p_demux, "can't spawn thread" );
 479         return VLC_EGENERIC;
 480     }
 481
 482     p_demux->pf_demux = NULL;
 483     p_demux->pf_control = Control;
 484
 485     return VLC_SUCCESS;
 486 }
 487
 488 /*****************************************************************************
 489  * Close:
 490  *****************************************************************************/
 491 static void Close( vlc_object_t *p_this )
 492 {
 493     demux_t     *p_demux = (demux_t*)p_this;
 494     demux_sys_t *p_sys = p_demux->p_sys;
 495
 496     vlc_cancel( p_sys->thread );
 497     vlc_join( p_sys->thread, NULL );
 498
 499     if ( p_sys->es )
 500         es_out_Del( p_demux->out, p_sys->es );
 501
 502     rfbClientCleanup( p_sys->p_client );
 503
 504     if ( p_sys->p_block )
 505         block_Release( p_sys->p_block );
 506 }