1 /*****************************************************************************
2 * remoteosd.c: remote osd over vnc filter module
3 *****************************************************************************
4 * Copyright (C) 2007-2008 Matthias Bauer
7 * Authors: Matthias Bauer <matthias dot bauer #_at_# gmx dot ch>
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.
14 * This program is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implid warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 * GNU General Public License for more details.
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., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
22 *****************************************************************************/
24 /*****************************************************************************
25 * RemoteOSD uses the RFB-Protocol of VNC to display an On-Screen-Display
26 * menu generated by a streaming server as overlay for the streamed video.
28 * The streaming server that implements this is the ffnetdev plugin for VDR.
29 * VDR (VideoDiskRecorder) is an Linux based OpenSource harddisk recorder
31 * The VDR ffnetdev plugin emulates the hardware MPEG decoder and streams the
32 * video over the network instead of hardware video outputs.
33 * The OSD menu of VDR is offered with the RFB protocol to a VNC client.
35 * In fact this video-filter is a simple VNC client that could be also used to
36 * connect to a real VNC host.
37 * Only 8-bit color is supported at the moment.
38 * Using password protected VNC hosts is supported but not recommended, because
39 * you need to insert the used password in the plugin configuration page of
40 * VLC configuration in plain text and it's saved in plain text.
41 *****************************************************************************/
45 /*****************************************************************************
47 *****************************************************************************/
53 #include <vlc_common.h>
54 #include <vlc_plugin.h>
57 #include "vlc_filter.h"
58 #include "filter_common.h"
59 #include "vlc_image.h"
63 #include <vlc_network.h>
64 #include <gcrypt.h> /* to encrypt password */
65 #include <vlc_gcrypt.h>
67 #include "remoteosd_rfbproto.h" /* type definitions of the RFB protocol for VNC */
69 /*****************************************************************************
71 *****************************************************************************/
72 #define READ_BUFFER_SIZE 1000000
74 #define RMTOSD_HOST_TEXT N_("VNC Host")
75 #define RMTOSD_HOST_LONGTEXT N_( \
76 "VNC hostname or IP address." )
78 #define RMTOSD_PORT_TEXT N_("VNC Port")
79 #define RMTOSD_PORT_LONGTEXT N_( \
82 #define RMTOSD_PASSWORD_TEXT N_("VNC Password")
83 #define RMTOSD_PASSWORD_LONGTEXT N_( \
86 #define RMTOSD_UPDATE_TEXT N_("VNC poll interval" )
87 #define RMTOSD_UPDATE_LONGTEXT N_( \
88 "In this interval an update from VNC is requested, default every 300 ms. ")
90 #define RMTOSD_POLL_TEXT N_("VNC polling")
91 #define RMTOSD_POLL_LONGTEXT N_( \
92 "Activate VNC polling. Do NOT activate for use as VDR ffnetdev client." )
94 #define RMTOSD_MOUSE_TEXT N_("Mouse events")
95 #define RMTOSD_MOUSE_LONGTEXT N_( \
96 "Send mouse events to VNC host. Not needed for use as VDR ffnetdev client." )
98 #define RMTOSD_KEYS_TEXT N_("Key events")
99 #define RMTOSD_KEYS_LONGTEXT N_( \
100 "Send key events to VNC host." )
102 #define RMTOSD_ALPHA_TEXT N_("Alpha transparency value (default 255)")
103 #define RMTOSD_ALPHA_LONGTEXT N_( \
104 "The transparency of the OSD VNC can be changed by giving a value " \
105 "between 0 and 255. A lower value specifies more transparency a higher " \
106 "means less transparency. The default is being not transparent " \
107 "(value 255) the minimum is fully transparent (value 0)." )
109 #define RMTOSD_CFG "rmtosd-"
111 #define RMTOSD_UPDATE_MIN 200
112 #define RMTOSD_UPDATE_DEFAULT 1000
113 #define RMTOSD_UPDATE_MAX 300
115 static int CreateFilter ( vlc_object_t * );
116 static void DestroyFilter( vlc_object_t * );
119 set_description( N_("Remote-OSD over VNC") );
120 set_capability( "sub filter", 100 );
121 set_shortname( N_("Remote-OSD") );
122 set_category( CAT_VIDEO );
123 set_subcategory( SUBCAT_VIDEO_SUBPIC );
124 add_shortcut( "rmtosd" );
125 set_callbacks( CreateFilter, DestroyFilter );
127 add_string( RMTOSD_CFG "host", "myvdr", NULL, RMTOSD_HOST_TEXT,
128 RMTOSD_HOST_LONGTEXT, false );
129 add_integer_with_range( RMTOSD_CFG "port", 20001, 1, 0xFFFF, NULL,
130 RMTOSD_PORT_TEXT, RMTOSD_PORT_LONGTEXT, false );
131 add_password( RMTOSD_CFG "password", "", NULL, RMTOSD_PASSWORD_TEXT,
132 RMTOSD_PASSWORD_LONGTEXT, false );
133 add_integer_with_range( RMTOSD_CFG "update", RMTOSD_UPDATE_DEFAULT,
134 RMTOSD_UPDATE_MIN, RMTOSD_UPDATE_MAX, NULL, RMTOSD_UPDATE_TEXT,
135 RMTOSD_UPDATE_LONGTEXT, true );
136 add_bool( RMTOSD_CFG "vnc-polling", 0, NULL,
137 RMTOSD_POLL_TEXT , RMTOSD_POLL_LONGTEXT, false );
138 add_bool( RMTOSD_CFG "mouse-events", 0, NULL,
139 RMTOSD_MOUSE_TEXT , RMTOSD_MOUSE_LONGTEXT, false );
140 add_bool( RMTOSD_CFG "key-events", 0, NULL,
141 RMTOSD_KEYS_TEXT , RMTOSD_KEYS_LONGTEXT, false );
142 add_integer_with_range( RMTOSD_CFG "alpha", 255, 0, 255, NULL,
143 RMTOSD_ALPHA_TEXT, RMTOSD_ALPHA_LONGTEXT, true );
148 /*****************************************************************************
150 *****************************************************************************/
151 #define CHALLENGESIZE 16
152 #define MAX_VNC_SERVER_NAME_LENGTH 255
154 /* subfilter functions */
155 static subpicture_t *Filter( filter_t *, mtime_t );
157 static int MouseEvent ( vlc_object_t *p_this, char const *psz_var,
158 vlc_value_t oldval, vlc_value_t newval, void *p_data );
160 static int KeyEvent( vlc_object_t *p_this, char const *psz_var,
161 vlc_value_t oldval, vlc_value_t newval, void *p_data );
163 static void stop_osdvnc ( filter_t *p_filter );
165 static void vnc_worker_thread ( vlc_object_t *p_thread_obj );
167 static void update_request_thread( vlc_object_t *p_thread_obj );
169 static bool open_vnc_connection ( filter_t *p_filter );
171 static bool handshaking ( filter_t *p_filter );
173 static bool process_server_message ( filter_t *p_filter,
174 rfbServerToClientMsg *msg );
176 static inline void rgb_to_yuv( uint8_t *y, uint8_t *u, uint8_t *v,
177 int r, int g, int b );
179 static inline bool fill_rect( filter_sys_t* p_sys,
180 uint16_t i_x, uint16_t i_y,
181 uint16_t i_w, uint16_t i_h,
184 static inline bool raw_line( filter_sys_t* p_sys,
185 uint16_t i_x, uint16_t i_y,
188 static void vnc_encrypt_bytes( unsigned char *bytes, char *passwd );
191 /*****************************************************************************
193 *****************************************************************************/
195 /*****************************************************************************
197 *****************************************************************************/
202 bool b_need_update; /* VNC picture is updated, do update the OSD*/
203 mtime_t i_vnc_poll_interval; /* Update the OSD menu every n ms */
205 uint8_t i_alpha; /* alpha transparency value */
207 char *psz_host; /* VNC host */
210 char *psz_passwd; /* VNC password */
212 bool b_vnc_poll; /* Activate VNC polling ? */
213 bool b_vnc_mouse_events; /* Send MouseEvents ? */
214 bool b_vnc_key_events; /* Send KeyEvents ? */
216 bool b_connection_active; /* Handshaking finished ? */
218 vlc_mutex_t lock; /* To lock for read/write on picture */
220 picture_t *p_pic; /* The picture with OSD data from VNC */
222 vout_thread_t *p_vout; /* Pointer to video-out thread */
224 int i_socket; /* Socket used for VNC */
226 uint16_t i_vnc_width; /* The with of the VNC screen */
227 uint16_t i_vnc_height; /* The height of the VNC screen */
228 uint32_t i_vnc_pixels; /* The pixels of the VNC screen */
230 bool b_alpha_from_vnc; /* Special ffnetdev alpha feature enabled ? */
232 char read_buffer[READ_BUFFER_SIZE];
236 vlc_object_t* p_worker_thread;
238 uint8_t ar_color_table_yuv[256][4];
241 /*****************************************************************************
242 * CreateFilter: Create the filter and open the definition file
243 *****************************************************************************/
244 static int CreateFilter ( vlc_object_t *p_this )
246 filter_t *p_filter = (filter_t *)p_this;
247 filter_sys_t *p_sys = NULL;
249 msg_Dbg( p_filter, "Creating vnc osd filter..." );
251 p_filter->p_sys = p_sys = malloc( sizeof(*p_sys) );
252 if( !p_filter->p_sys )
254 memset( p_sys, 0, sizeof(*p_sys) );
256 /* Populating struct */
257 vlc_mutex_init( &p_sys->lock );
258 p_sys->b_continue = true;
259 p_sys->i_socket = -1;
262 p_sys->psz_host = var_CreateGetString( p_this, RMTOSD_CFG "host" );
263 if( EMPTY_STR(p_sys->psz_host) )
265 msg_Err( p_filter, "unable to get vnc host" );
269 p_sys->psz_passwd = var_CreateGetString( p_this, RMTOSD_CFG "password" );
270 if( !p_sys->psz_passwd )
272 msg_Err( p_filter, "unable to get vnc password" );
276 p_sys->i_port = var_CreateGetIntegerCommand( p_this, RMTOSD_CFG "port" );
278 p_sys->i_alpha = var_CreateGetIntegerCommand( p_this, RMTOSD_CFG "alpha" );
280 /* in miliseconds, 0 disables polling, should not be lower than 100 */
281 p_sys->i_vnc_poll_interval = var_CreateGetIntegerCommand( p_this,
282 RMTOSD_CFG "update" );
283 if ( p_sys->i_vnc_poll_interval < 100)
285 p_sys->i_vnc_poll_interval = 100;
288 for ( int i = 0; i < 256; i++ )
290 p_sys->ar_color_table_yuv[i][0] = 255;
291 p_sys->ar_color_table_yuv[i][1] = 255;
292 p_sys->ar_color_table_yuv[i][2] = 255;
293 p_sys->ar_color_table_yuv[i][3] = 255;
296 p_sys->b_vnc_poll = var_CreateGetBoolCommand( p_this,
297 RMTOSD_CFG "vnc-polling" );
298 p_sys->b_vnc_mouse_events = var_CreateGetBoolCommand( p_this,
299 RMTOSD_CFG "mouse-events" );
300 p_sys->b_vnc_key_events = var_CreateGetBoolCommand( p_this,
301 RMTOSD_CFG "key-events" );
303 /* Keep track of OSD Events */
304 p_sys->b_need_update = false;
306 /* Attach subpicture filter callback */
307 p_filter->pf_sub_filter = Filter;
309 p_sys->p_vout = vlc_object_find( p_this, VLC_OBJECT_VOUT, FIND_PARENT );
313 var_AddCallback( p_sys->p_vout, "mouse-moved",
314 MouseEvent, p_this );
315 var_AddCallback( p_sys->p_vout, "mouse-button-down",
316 MouseEvent, p_this );
317 var_AddCallback( p_sys->p_vout->p_libvlc, "key-pressed",
321 es_format_Init( &p_filter->fmt_out, SPU_ES, VLC_FOURCC( 's','p','u',' ' ) );
322 p_filter->fmt_out.i_priority = 0;
326 /* create the vnc worker thread */
327 p_sys->p_worker_thread = vlc_object_create( p_this,
328 sizeof( vlc_object_t ) );
329 vlc_object_attach( p_sys->p_worker_thread, p_this );
330 if( vlc_thread_create( p_sys->p_worker_thread, "vnc worker thread",
332 VLC_THREAD_PRIORITY_LOW, false ) )
334 vlc_object_detach( p_sys->p_worker_thread );
335 vlc_object_release( p_sys->p_worker_thread );
336 msg_Err( p_filter, "cannot spawn vnc message reader thread" );
340 msg_Dbg( p_filter, "osdvnc filter started" );
345 msg_Err( p_filter, "osdvnc filter discarded" );
347 stop_osdvnc( p_filter );
349 vlc_mutex_destroy( &p_sys->lock );
350 free( p_sys->psz_host );
351 free( p_sys->psz_passwd );
357 /*****************************************************************************
358 * DestroyFilter: Make a clean exit of this plugin
359 *****************************************************************************/
360 static void DestroyFilter( vlc_object_t *p_this )
362 filter_t *p_filter = (filter_t*)p_this;
363 filter_sys_t *p_sys = p_filter->p_sys;
365 msg_Dbg( p_filter, "DestroyFilter called." );
367 stop_osdvnc( p_filter );
371 var_DelCallback( p_sys->p_vout, "mouse-moved",
372 MouseEvent, p_this );
373 var_DelCallback( p_sys->p_vout, "mouse-button-down",
374 MouseEvent, p_this );
375 var_DelCallback( p_sys->p_vout->p_libvlc, "key-pressed",
378 vlc_object_release( p_sys->p_vout );
381 var_Destroy( p_this, RMTOSD_CFG "host" );
382 var_Destroy( p_this, RMTOSD_CFG "port" );
383 var_Destroy( p_this, RMTOSD_CFG "password" );
384 var_Destroy( p_this, RMTOSD_CFG "update" );
385 var_Destroy( p_this, RMTOSD_CFG "vnc-polling" );
386 var_Destroy( p_this, RMTOSD_CFG "mouse-events" );
387 var_Destroy( p_this, RMTOSD_CFG "key-events" );
388 var_Destroy( p_this, RMTOSD_CFG "alpha" );
390 vlc_mutex_destroy( &p_sys->lock );
391 free( p_sys->psz_host );
392 free( p_sys->psz_passwd );
396 static void stop_osdvnc ( filter_t *p_filter )
398 filter_sys_t *p_sys = p_filter->p_sys;
400 /* It will unlock socket reading */
401 vlc_object_kill( p_filter );
404 if( p_sys->p_worker_thread )
406 msg_Dbg( p_filter, "joining worker_thread" );
407 vlc_object_kill( p_sys->p_worker_thread );
408 vlc_thread_join( p_sys->p_worker_thread );
409 vlc_object_detach( p_sys->p_worker_thread );
410 vlc_object_release( p_sys->p_worker_thread );
411 msg_Dbg( p_filter, "released worker_thread" );
414 msg_Dbg( p_filter, "osdvnc stopped" );
417 static bool read_exact( filter_t *p_filter,
422 return i_bytes == net_Read( p_filter, i_socket, NULL,
423 (unsigned char*)p_readbuf,
428 static bool write_exact( filter_t *p_filter,
433 return i_bytes == net_Write( p_filter, i_socket, NULL,
434 (unsigned char*)p_writebuf, i_bytes );
437 static bool open_vnc_connection ( filter_t *p_filter )
439 filter_sys_t *p_sys = p_filter->p_sys;
441 msg_Dbg( p_filter, "Open socket to vnc server on %s:%u.",
442 p_sys->psz_host, p_sys->i_port );
444 p_sys->i_socket = net_ConnectTCP( p_filter, p_sys->psz_host, p_sys->i_port );
446 if( p_sys->i_socket < 0 )
448 msg_Err( p_filter, "Could not open socket" );
452 msg_Dbg( p_filter, "socket is open." );
457 static bool handshaking ( filter_t *p_filter )
459 filter_sys_t *p_sys = p_filter->p_sys;
461 msg_Dbg( p_filter, "Reading protocol version" );
463 rfbProtocolVersionMsg pv;
464 if ( !read_exact( p_filter, p_sys->i_socket, pv,
465 sz_rfbProtocolVersionMsg ) )
467 msg_Err( p_filter, "Could not read version message" );
470 pv[sz_rfbProtocolVersionMsg] = '\0'; /* pv size is sz_rfbProtocolVersionMsg+1 */
472 msg_Dbg( p_filter, "Server version is %s", pv );
474 strncpy(pv, "RFB 003.003\n", sz_rfbProtocolVersionMsg);
476 if( !write_exact(p_filter, p_sys->i_socket, pv,
477 sz_rfbProtocolVersionMsg) )
479 msg_Err( p_filter, "Could not write version message" );
483 msg_Dbg( p_filter, "Reading authentication scheme" );
484 uint32_t i_authScheme;
485 if( !read_exact( p_filter, p_sys->i_socket, (char*)&i_authScheme, 4 ) )
487 msg_Err( p_filter, "Could not read authentication scheme" );
490 i_authScheme = htonl(i_authScheme);
492 msg_Dbg( p_filter, "Authentication scheme = %x", i_authScheme );
493 if ( i_authScheme == rfbConnFailed )
495 msg_Err( p_filter, "Connection rejected by server" );
498 if (i_authScheme == rfbVncAuth)
500 unsigned char challenge[CHALLENGESIZE];
501 if ( !read_exact( p_filter, p_sys->i_socket,
502 (char*)challenge, CHALLENGESIZE ) )
504 msg_Err( p_filter, "Could not read password challenge" );
508 vnc_encrypt_bytes( challenge, p_sys->psz_passwd );
510 if( !write_exact(p_filter, p_sys->i_socket,
511 (char*)challenge, CHALLENGESIZE ) )
513 msg_Err( p_filter, "Could not write password" );
516 uint32_t i_authResult;
517 if( !read_exact( p_filter, p_sys->i_socket, (char*)&i_authResult, 4 ) )
519 msg_Err( p_filter, "Could not read authentication result" );
522 i_authResult = htonl(i_authResult);
523 if (i_authResult != rfbVncAuthOK)
525 msg_Err( p_filter, "VNC authentication failed" );
530 msg_Dbg( p_filter, "Writing client init message" );
533 if( !write_exact( p_filter, p_sys->i_socket,
534 (char*)&ci, sz_rfbClientInitMsg ) )
536 msg_Err( p_filter, "Could not write client init message" );
540 msg_Dbg( p_filter, "Reading server init message" );
542 if( !read_exact( p_filter, p_sys->i_socket,
543 (char*)&si, sz_rfbServerInitMsg ) )
545 msg_Err( p_filter, "Could not read server init message" );
548 si.framebufferWidth = htons(si.framebufferWidth);
549 si.framebufferHeight = htons(si.framebufferHeight);
550 si.format.redMax = htons(si.format.redMax);
551 si.format.greenMax = htons(si.format.greenMax);
552 si.format.blueMax = htons(si.format.blueMax);
554 p_sys->i_vnc_width = si.framebufferWidth;
555 p_sys->i_vnc_height = si.framebufferHeight;
557 msg_Dbg( p_filter, "Servers preferred pixelformat: "
558 "%ux%u, R(%u),G(%u),B(%u), %u bit, depht=%u, %s",
560 si.framebufferHeight,
564 si.format.bitsPerPixel,
566 si.format.trueColour ? "TrueColor" : "Not-TrueColor");
568 uint32_t i_nameLength = htonl(si.nameLength);
569 if( i_nameLength > MAX_VNC_SERVER_NAME_LENGTH )
571 msg_Err( p_filter, "Server name too long" );
574 char s_ServerName[MAX_VNC_SERVER_NAME_LENGTH+1];
576 msg_Dbg( p_filter, "Reading server name with size = %u", i_nameLength );
577 if( !read_exact( p_filter, p_sys->i_socket, s_ServerName, i_nameLength ) )
579 msg_Err( p_filter, "Could not read server name" );
582 s_ServerName[i_nameLength] = '\0';
584 if( strcmp( s_ServerName, "VDR-OSD") == 0 )
586 msg_Dbg( p_filter, "Server is a VDR" );
587 p_sys->b_alpha_from_vnc = true;
591 msg_Dbg( p_filter, "Server is a normal VNC" );
592 p_sys->b_alpha_from_vnc = false;
596 msg_Dbg( p_filter, "Server init message read properly" );
597 msg_Dbg( p_filter, "Server name is %s", s_ServerName );
599 msg_Dbg( p_filter, "Writing SetPixelFormat message" );
601 rfbSetPixelFormatMsg sp;
602 sp.type = rfbSetPixelFormat;
603 sp.format.bitsPerPixel = 8;
604 sp.format.depth = 8 ;
605 sp.format.bigEndian = 1;
606 sp.format.trueColour = 0;
607 sp.format.redMax = htons(31);
608 sp.format.greenMax = htons(31);
609 sp.format.blueMax = htons(31);
610 sp.format.redShift = 10;
611 sp.format.greenShift = 5;
612 sp.format.blueShift = 0;
614 if( !write_exact( p_filter, p_sys->i_socket,
615 (char*)&sp, sz_rfbSetPixelFormatMsg) )
617 msg_Err( p_filter, "Could not write SetPixelFormat message" );
621 msg_Dbg( p_filter, "Writing SetEncodings message" );
623 rfbSetEncodingsMsg se;
624 se.type = rfbSetEncodings;
625 se.nEncodings = htons( p_sys->b_alpha_from_vnc ? 3 : 2 );
627 if( !write_exact( p_filter, p_sys->i_socket,
628 (char*)&se, sz_rfbSetEncodingsMsg) )
630 msg_Err( p_filter, "Could not write SetEncodings message begin" );
636 msg_Dbg( p_filter, "Writing SetEncodings rfbEncodingCopyRect" );
637 i_encoding = htonl(rfbEncodingCopyRect);
638 if( !write_exact( p_filter, p_sys->i_socket, (char*)&i_encoding, 4) )
640 msg_Err( p_filter, "Could not write encoding type rfbEncodingCopyRect." );
644 msg_Dbg( p_filter, "Writing SetEncodings rfbEncodingRRE" );
645 i_encoding = htonl(rfbEncodingRRE);
646 if( !write_exact(p_filter, p_sys->i_socket, (char*)&i_encoding, 4) )
648 msg_Err( p_filter, "Could not write encoding type rfbEncodingRRE." );
652 if( p_sys->b_alpha_from_vnc )
654 msg_Dbg( p_filter, "Writing SetEncodings rfbEncSpecialUseAlpha" );
655 i_encoding = 0x00F0FFFF; /* rfbEncSpecialUseAlpha is 0xFFFFF000
656 * before we swap it */
657 if( !write_exact(p_filter, p_sys->i_socket, (char*)&i_encoding, 4) )
659 msg_Err( p_filter, "Could not write encoding type rfbEncSpecialUseAlpha." );
667 static void vnc_worker_thread( vlc_object_t *p_thread_obj )
669 filter_t* p_filter = (filter_t*)(p_thread_obj->p_parent);
670 filter_sys_t *p_sys = p_filter->p_sys;
671 vlc_object_t *p_update_request_thread;
673 msg_Dbg( p_filter, "VNC worker thread started" );
675 if( !open_vnc_connection ( p_filter ) )
677 msg_Err( p_filter, "Could not connect to vnc host" );
681 if( !handshaking ( p_filter ) )
683 msg_Err( p_filter, "Error occured while handshaking vnc host" );
687 p_sys->b_connection_active = true; /* to enable sending key
688 * and mouse events to host */
690 /* Create an empty picture for VNC the data */
691 vlc_mutex_lock( &p_sys->lock );
692 p_sys->p_pic = picture_New( VLC_FOURCC('Y','U','V','A'),
693 p_sys->i_vnc_width, p_sys->i_vnc_height, VOUT_ASPECT_FACTOR );
696 vlc_mutex_unlock( &p_sys->lock );
699 p_sys->i_vnc_pixels = p_sys->i_vnc_width * p_sys->i_vnc_height;
701 vlc_mutex_unlock( &p_sys->lock );
703 /* create the update request thread */
704 p_update_request_thread = vlc_object_create( p_filter,
705 sizeof( vlc_object_t ) );
706 vlc_object_attach( p_update_request_thread, p_filter );
707 if( vlc_thread_create( p_update_request_thread,
708 "vnc update request thread",
709 update_request_thread,
710 VLC_THREAD_PRIORITY_LOW, false ) )
712 vlc_object_detach( p_update_request_thread );
713 vlc_object_release( p_update_request_thread );
714 msg_Err( p_filter, "cannot spawn vnc update request thread" );
718 /* connection is initialized, now read and handle server messages */
719 while( vlc_object_alive( p_thread_obj ) )
721 rfbServerToClientMsg msg;
724 memset( &msg, 0, sizeof(msg) );
726 if( !read_exact(p_filter, p_sys->i_socket, (char*)&msg, 1 ) )
728 msg_Err( p_filter, "Error while waiting for next server message");
733 case rfbFramebufferUpdate:
734 i_msgSize = sz_rfbFramebufferUpdateMsg;
736 case rfbSetColourMapEntries:
737 i_msgSize = sz_rfbSetColourMapEntriesMsg;
740 i_msgSize = sz_rfbBellMsg;
742 case rfbServerCutText:
743 i_msgSize = sz_rfbServerCutTextMsg;
745 case rfbReSizeFrameBuffer:
746 i_msgSize = sz_rfbReSizeFrameBufferMsg;
750 msg_Err( p_filter, "Invalid message %u received", msg.type );
757 if( --i_msgSize > 0 )
759 if ( !read_exact( p_filter, p_sys->i_socket,
760 ((char*)&msg)+1, i_msgSize ) )
762 msg_Err( p_filter, "Error while reading message of type %u",
767 process_server_message( p_filter, &msg);
770 msg_Dbg( p_filter, "joining update_request_thread" );
771 vlc_object_kill( p_update_request_thread );
772 vlc_thread_join( p_update_request_thread );
773 vlc_object_detach( p_update_request_thread );
774 vlc_object_release( p_update_request_thread );
775 msg_Dbg( p_filter, "released update_request_thread" );
779 vlc_mutex_lock( &p_sys->lock );
780 p_sys->b_connection_active = false;
782 if (p_sys->i_socket >= 0)
783 net_Close(p_sys->i_socket);
786 picture_Release( p_sys->p_pic );
788 /* It will hide the subtitle */
789 p_sys->b_continue = false;
790 p_sys->b_need_update = true;
791 vlc_mutex_unlock( &p_sys->lock );
793 msg_Dbg( p_filter, "VNC message reader thread ended" );
796 static void update_request_thread( vlc_object_t *p_thread_obj )
798 filter_t* p_filter = (filter_t*)(p_thread_obj->p_parent);
799 filter_sys_t *p_sys = p_filter->p_sys;
801 msg_Dbg( p_filter, "VNC update request thread started" );
803 rfbFramebufferUpdateRequestMsg udr;
804 udr.type = rfbFramebufferUpdateRequest;
808 udr.w = htons(p_sys->i_vnc_width);
809 udr.h = htons(p_sys->i_vnc_height);
811 if( write_exact(p_filter, p_sys->i_socket, (char*)&udr,
812 sz_rfbFramebufferUpdateRequestMsg) == false)
814 msg_Err( p_filter, "Could not write rfbFramebufferUpdateRequestMsg." );
815 p_sys->b_continue = false;
820 mtime_t i_poll_interval_microsec = p_sys->i_vnc_poll_interval * 1000;
822 if( p_sys->b_vnc_poll)
824 while( vlc_object_alive( p_thread_obj ) )
826 msleep( i_poll_interval_microsec );
827 if( write_exact(p_filter, p_sys->i_socket, (char*)&udr,
828 sz_rfbFramebufferUpdateRequestMsg) == false)
830 msg_Err( p_filter, "Could not write rfbFramebufferUpdateRequestMsg." );
834 p_sys->b_continue = false;
838 msg_Dbg( p_filter, "VNC polling disabled." );
841 msg_Dbg( p_filter, "VNC update request thread ended" );
844 static bool process_server_message ( filter_t *p_filter,
845 rfbServerToClientMsg *msg )
847 filter_sys_t *p_sys = p_filter->p_sys;
851 case rfbFramebufferUpdate:
853 msg->fu.nRects = htons(msg->fu.nRects);
854 rfbFramebufferUpdateRectHeader hdr;
856 for (int i_rect = 0; i_rect < msg->fu.nRects; i_rect++)
858 if (!read_exact(p_filter, p_sys->i_socket, (char*)&hdr,
859 sz_rfbFramebufferUpdateRectHeader ) )
861 msg_Err( p_filter, "Could not read FrameBufferUpdate header" );
864 hdr.r.x = htons(hdr.r.x);
865 hdr.r.y = htons(hdr.r.y);
866 hdr.r.w = htons(hdr.r.w);
867 hdr.r.h = htons(hdr.r.h);
868 hdr.encoding = htonl(hdr.encoding);
870 switch (hdr.encoding)
875 for (i_line = 0; i_line < hdr.r.h; i_line++)
877 if ( !read_exact( p_filter, p_sys->i_socket,
878 p_sys->read_buffer, hdr.r.w ) )
881 "Could not read FrameBufferUpdate line data" );
884 vlc_mutex_lock( &p_sys->lock );
885 if ( !raw_line( p_sys, hdr.r.x,
889 msg_Err( p_filter, "raw_line failed." );
890 vlc_mutex_unlock( &p_sys->lock );
893 vlc_mutex_unlock( &p_sys->lock );
898 case rfbEncodingCopyRect:
901 "Rect in unsupported encoding rfbEncodingCopyRect" );
908 if ( !read_exact( p_filter, p_sys->i_socket,
912 msg_Err( p_filter, "Could not read rfbRREHeader" );
916 if ( !read_exact(p_filter, p_sys->i_socket,
917 (char*)&i_pixcolor, 1 ) )
919 msg_Err( p_filter, "Could not read RRE pixcolor" );
923 vlc_mutex_lock( &p_sys->lock );
924 if ( !fill_rect( p_sys,
929 msg_Err( p_filter, "main fill_rect failed." );
930 vlc_mutex_unlock( &p_sys->lock );
933 vlc_mutex_unlock( &p_sys->lock );
935 rrehdr.nSubrects = htonl(rrehdr.nSubrects);
937 int i_datasize = rrehdr.nSubrects *
938 ( sizeof(i_pixcolor) + sz_rfbRectangle ) ;
939 if ( i_datasize > READ_BUFFER_SIZE )
941 msg_Err( p_filter, "Buffer too small, "
942 "need %u bytes", i_datasize );
945 if ( !read_exact( p_filter, p_sys->i_socket,
946 p_sys->read_buffer, i_datasize ) )
949 "Could not read RRE subrect data" );
954 rfbRectangle* p_subrect;
956 vlc_mutex_lock( &p_sys->lock );
958 i_subrect < rrehdr.nSubrects; i_subrect++)
960 i_pixcolor = p_sys->read_buffer[i_offset];
961 i_offset += sizeof(i_pixcolor);
963 (rfbRectangle*)(p_sys->read_buffer + i_offset);
964 i_offset += sz_rfbRectangle;
966 if (!fill_rect( p_sys,
967 htons(p_subrect->x) + hdr.r.x,
968 htons(p_subrect->y) + hdr.r.y,
974 "subrect %u fill_rect failed.", i_subrect );
975 vlc_mutex_unlock( &p_sys->lock );
979 vlc_mutex_unlock( &p_sys->lock );
986 vlc_mutex_lock( &p_sys->lock );
987 p_sys->b_need_update = true;
988 vlc_mutex_unlock( &p_sys->lock );
992 case rfbSetColourMapEntries:
994 msg->scme.nColours = htons(msg->scme.nColours);
995 msg->scme.firstColour = htons(msg->scme.firstColour);
997 if ( p_sys->b_alpha_from_vnc == true )
999 i_datasize = 2 * msg->scme.nColours * 4;
1003 i_datasize = 2 * msg->scme.nColours * 3;
1005 if ( i_datasize > READ_BUFFER_SIZE )
1007 msg_Err( p_filter, "Buffer too small, need %u bytes",
1012 if ( !read_exact( p_filter, p_sys->i_socket,
1013 p_sys->read_buffer, i_datasize ) )
1015 msg_Err( p_filter, "Could not read color map data" );
1019 uint8_t i_red, i_green, i_blue, i_alpha, i_color_index;
1020 uint16_t i_offset = 0;
1023 for (int i = 0; i < msg->scme.nColours; i++)
1025 i_color_index = i+msg->scme.firstColour;
1026 if ( p_sys->b_alpha_from_vnc == true )
1028 i_alpha = p_sys->read_buffer[i_offset];
1031 i_red = p_sys->read_buffer[i_offset];
1033 i_green = p_sys->read_buffer[i_offset];
1035 i_blue = p_sys->read_buffer[i_offset];
1037 rgb_to_yuv( &p_sys->ar_color_table_yuv[i_color_index][0],
1038 &p_sys->ar_color_table_yuv[i_color_index][1],
1039 &p_sys->ar_color_table_yuv[i_color_index][2],
1043 p_sys->ar_color_table_yuv[i][3] = i_alpha;
1049 msg_Err( p_filter, "rfbBell received" );
1052 case rfbServerCutText:
1053 msg->sct.length = htons(msg->sct.length);
1054 if ( msg->sct.length > READ_BUFFER_SIZE )
1056 msg_Err( p_filter, "Buffer too small, need %u bytes", msg->sct.length );
1059 if ( !read_exact(p_filter, p_sys->i_socket,
1060 p_sys->read_buffer, msg->sct.length ) )
1062 msg_Err( p_filter, "Could not read Reading rfbServerCutText data" );
1067 case rfbReSizeFrameBuffer:
1068 msg_Err( p_filter, "Reading rfbReSizeFrameBuffer not implemented" );
1072 msg_Err( p_filter, "Invalid message %u received", msg->type );
1078 /****************************************************************************
1079 * Filter: the whole thing
1080 ****************************************************************************
1081 * This function outputs subpictures at regular time intervals.
1082 ****************************************************************************/
1083 static subpicture_t *Filter( filter_t *p_filter, mtime_t date )
1085 filter_sys_t *p_sys = p_filter->p_sys;
1086 subpicture_t *p_spu;
1087 subpicture_region_t *p_region;
1091 if( !p_sys->b_need_update )
1096 vlc_mutex_lock( &p_sys->lock );
1098 p_pic = p_sys->p_pic;
1102 vlc_mutex_unlock( &p_sys->lock );
1106 /* Allocate the subpicture internal data. */
1107 p_spu = filter_NewSubpicture( p_filter );
1110 vlc_mutex_unlock( &p_sys->lock );
1114 p_spu->b_absolute = false;
1115 p_spu->i_start = date;
1117 p_spu->b_ephemer = true;
1119 if( !p_sys->b_continue )
1120 p_spu->i_stop = p_spu->i_start + 1;
1122 /* Create new SPU region */
1123 memset( &fmt, 0, sizeof(video_format_t) );
1124 fmt.i_chroma = VLC_FOURCC('Y','U','V','A');
1125 fmt.i_aspect = VOUT_ASPECT_FACTOR;
1126 fmt.i_sar_num = fmt.i_sar_den = 1;
1127 fmt.i_width = fmt.i_visible_width = p_pic->p[Y_PLANE].i_visible_pitch;
1128 fmt.i_height = fmt.i_visible_height = p_pic->p[Y_PLANE].i_visible_lines;
1129 fmt.i_x_offset = fmt.i_y_offset = 0;
1130 p_region = p_spu->pf_create_region( VLC_OBJECT(p_filter), &fmt );
1133 msg_Err( p_filter, "cannot allocate SPU region" );
1134 p_filter->pf_sub_buffer_del( p_filter, p_spu );
1135 vlc_mutex_unlock( &p_sys->lock );
1139 vout_CopyPicture( p_filter, &p_region->picture, p_pic );
1141 p_sys->b_need_update = false;
1143 vlc_mutex_unlock( &p_sys->lock );
1145 /* set to one of the 9 relative locations */
1146 p_region->i_align = 0; //=CENTER
1147 p_spu->b_absolute = false;
1153 p_spu->p_region = p_region;
1155 p_spu->i_alpha = ( p_sys->i_alpha );
1161 static inline void rgb_to_yuv( uint8_t *y, uint8_t *u, uint8_t *v,
1162 int r, int g, int b )
1164 *y = ( ( ( 66 * r + 129 * g + 25 * b + 128 ) >> 8 ) + 16 );
1165 *u = ( ( -38 * r - 74 * g + 112 * b + 128 ) >> 8 ) + 128 ;
1166 *v = ( ( 112 * r - 94 * g - 18 * b + 128 ) >> 8 ) + 128 ;
1169 static inline bool fill_rect( filter_sys_t* p_sys,
1170 uint16_t i_x, uint16_t i_y,
1171 uint16_t i_w, uint16_t i_h,
1174 plane_t *p_outY = p_sys->p_pic->p+Y_PLANE;
1175 plane_t *p_outU = p_sys->p_pic->p+U_PLANE;
1176 plane_t *p_outV = p_sys->p_pic->p+V_PLANE;
1177 plane_t *p_outA = p_sys->p_pic->p+A_PLANE;
1178 int i_pitch = p_outY->i_pitch;
1179 int i_lines = p_outY->i_lines;
1180 if ( i_x + i_w > i_pitch)
1182 if ( i_y + i_h > i_lines)
1184 int i_line_offset = i_y * i_pitch;
1185 uint8_t i_yuv_y = p_sys->ar_color_table_yuv[i_color][0];
1186 uint8_t i_yuv_u = p_sys->ar_color_table_yuv[i_color][1];
1187 uint8_t i_yuv_v = p_sys->ar_color_table_yuv[i_color][2];
1188 uint8_t i_alpha = p_sys->ar_color_table_yuv[i_color][3];
1189 for( int i_line = 0; i_line < i_h; i_line++ )
1191 for( int i_column = 0; i_column < i_w; i_column++ )
1193 int i_total_offset = i_line_offset + i_x + i_column;
1194 p_outY->p_pixels[ i_total_offset ] = i_yuv_y;
1195 p_outU->p_pixels[ i_total_offset ] = i_yuv_u;
1196 p_outV->p_pixels[ i_total_offset ] = i_yuv_v;
1197 p_outA->p_pixels[ i_total_offset ] = i_alpha;
1199 i_line_offset += i_pitch;
1204 static inline bool raw_line( filter_sys_t* p_sys,
1205 uint16_t i_x, uint16_t i_y,
1208 plane_t *p_outY = p_sys->p_pic->p+Y_PLANE;
1209 plane_t *p_outU = p_sys->p_pic->p+U_PLANE;
1210 plane_t *p_outV = p_sys->p_pic->p+V_PLANE;
1211 plane_t *p_outA = p_sys->p_pic->p+A_PLANE;
1212 int i_pitch = p_outY->i_pitch;
1213 int i_lines = p_outY->i_lines;
1214 if ( i_x + i_w > i_pitch)
1219 int i_line_offset = i_y * i_pitch + i_x;
1221 for( int i_column = 0; i_column < i_w; i_column++ )
1223 int i_offset = i_line_offset + i_column;
1224 uint8_t i_color = p_sys->read_buffer[i_column];
1225 p_outY->p_pixels[ i_offset ] = p_sys->ar_color_table_yuv[i_color][0];
1226 p_outU->p_pixels[ i_offset ] = p_sys->ar_color_table_yuv[i_color][1];
1227 p_outV->p_pixels[ i_offset ] = p_sys->ar_color_table_yuv[i_color][2];
1228 p_outA->p_pixels[ i_offset ] = p_sys->ar_color_table_yuv[i_color][3];
1235 /*****************************************************************************
1236 * MouseEvent: callback for mouse events
1237 *****************************************************************************/
1238 static int MouseEvent( vlc_object_t *p_this, char const *psz_var,
1239 vlc_value_t oldval, vlc_value_t newval, void *p_data )
1241 VLC_UNUSED(oldval); VLC_UNUSED(newval); VLC_UNUSED(psz_var);
1243 filter_t *p_filter = (filter_t *)p_data;
1244 filter_sys_t *p_sys = p_filter->p_sys;
1246 if( !p_sys->b_vnc_mouse_events )
1249 vout_thread_t *p_vout = (vout_thread_t*)p_sys->p_vout;
1253 int v_h = p_vout->output.i_height;
1254 int v_w = p_vout->output.i_width;
1256 i_v = var_GetInteger( p_sys->p_vout, "mouse-button-down" );
1257 i_y = var_GetInteger( p_sys->p_vout, "mouse-y" );
1258 i_x = var_GetInteger( p_sys->p_vout, "mouse-x" );
1260 if( i_y < 0 || i_x < 0 || i_y >= v_h || i_x >= v_w )
1262 msg_Dbg( p_this, "invalid mouse event? x=%d y=%d btn=%x", i_x, i_y, i_v );
1266 msg_Dbg( p_this, "mouse event x=%d y=%d btn=%x", i_x, i_y, i_v );
1269 /* FIXME: calculate x and y coordinates for scaled output */
1271 vlc_mutex_lock( &p_sys->lock );
1272 if( !p_sys->b_connection_active )
1274 vlc_mutex_unlock( &p_sys->lock );
1278 /* buttonMask bits 0-7 are buttons 1-8, 0=up, 1=down */
1279 rfbPointerEventMsg ev;
1280 ev.type = rfbPointerEvent;
1281 ev.buttonMask = i_v;
1285 write_exact( p_filter, p_sys->i_socket,
1286 (char*)&ev, sz_rfbPointerEventMsg);
1288 vlc_mutex_unlock( &p_sys->lock );
1293 /*****************************************************************************
1294 * KeyEvent: callback for keyboard events
1295 *****************************************************************************/
1296 static int KeyEvent( vlc_object_t *p_this, char const *psz_var,
1297 vlc_value_t oldval, vlc_value_t newval, void *p_data )
1299 VLC_UNUSED(psz_var); VLC_UNUSED(oldval);
1301 filter_t *p_filter = (filter_t *)p_data;
1302 filter_sys_t *p_sys = p_filter->p_sys;
1304 if( !p_sys->b_vnc_key_events )
1307 msg_Dbg( p_this, "key pressed (%d) ", newval.i_int );
1309 if ( !newval.i_int )
1311 msg_Err( p_this, "Received invalid key event %d", newval.i_int );
1312 return VLC_EGENERIC;
1315 vlc_mutex_lock( &p_sys->lock );
1316 if( !p_sys->b_connection_active )
1318 vlc_mutex_unlock( &p_sys->lock );
1322 uint32_t i_key32 = newval.i_int;
1323 i_key32 = htonl(i_key32);
1325 ev.type = rfbKeyEvent;
1328 /* first key-down for modifier-keys */
1329 if (newval.i_int & KEY_MODIFIER_CTRL)
1332 write_exact( p_filter, p_sys->i_socket,
1333 (char*)&ev, sz_rfbKeyEventMsg);
1335 if (newval.i_int & KEY_MODIFIER_SHIFT)
1338 write_exact( p_filter, p_sys->i_socket,
1339 (char*)&ev, sz_rfbKeyEventMsg);
1341 if (newval.i_int & KEY_MODIFIER_ALT)
1344 write_exact( p_filter, p_sys->i_socket,
1345 (char*)&ev, sz_rfbKeyEventMsg);
1348 /* then key-down for the pressed key */
1350 write_exact( p_filter, p_sys->i_socket,
1351 (char*)&ev, sz_rfbKeyEventMsg);
1355 /* then key-up for the pressed key */
1356 write_exact( p_filter, p_sys->i_socket,
1357 (char*)&ev, sz_rfbKeyEventMsg);
1359 /* last key-down for modifier-keys */
1360 if (newval.i_int & KEY_MODIFIER_CTRL)
1363 write_exact( p_filter, p_sys->i_socket,
1364 (char*)&ev, sz_rfbKeyEventMsg);
1366 if (newval.i_int & KEY_MODIFIER_SHIFT)
1369 write_exact( p_filter, p_sys->i_socket,
1370 (char*)&ev, sz_rfbKeyEventMsg);
1372 if (newval.i_int & KEY_MODIFIER_ALT)
1375 write_exact( p_filter, p_sys->i_socket,
1376 (char*)&ev, sz_rfbKeyEventMsg);
1378 vlc_mutex_unlock( &p_sys->lock );
1383 static void vnc_encrypt_bytes( unsigned char *bytes, char *passwd )
1385 unsigned char key[8];
1388 for (i = 0; i < 8; i++)
1389 key[i] = i < strlen( passwd ) ? passwd[i] : '\0';
1391 gcry_cipher_hd_t ctx;
1392 gcry_cipher_open( &ctx, GCRY_CIPHER_DES, GCRY_CIPHER_MODE_ECB,0);
1394 /* reverse bits of the key */
1395 for( i = 0 ; i < 8 ; i ++ )
1398 (((key[i] >> 6) & 0x01 ) << 1 ) +
1399 (((key[i] >> 5) & 0x01 ) << 2 ) +
1400 (((key[i] >> 4) & 0x01 ) << 3 ) +
1401 (((key[i] >> 3) & 0x01 ) << 4 ) +
1402 (((key[i] >> 2) & 0x01 ) << 5 ) +
1403 (((key[i] >> 1) & 0x01 ) << 6 ) +
1404 ((key[i] & 0x01) << 7 );
1406 gcry_cipher_setkey( ctx, key, 8 );
1407 gcry_cipher_encrypt( ctx, bytes, CHALLENGESIZE, bytes, CHALLENGESIZE );
1408 gcry_cipher_close( ctx );