1 /*****************************************************************************
2 * netsync.c: synchronisation between several network clients.
3 *****************************************************************************
4 * Copyright (C) 2004 the VideoLAN team
7 * Authors: Gildas Bazin <gbazin@videolan.org>
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 implied 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 /*****************************************************************************
26 *****************************************************************************/
32 #include <vlc_interface.h>
33 #include <vlc_input.h>
34 #include <vlc_es_out.h>
39 #ifdef HAVE_SYS_TIME_H
40 # include <sys/time.h>
42 #ifdef HAVE_SYS_TYPES_H
43 # include <sys/types.h>
49 #include <vlc_network.h>
51 #define NETSYNC_PORT 9875
53 /* Needed for Solaris */
55 #define INADDR_NONE 0xffffffff
58 /* FIXME: UGLY UGLY !! Netsync should be totally reworked */
59 #include "../../src/input/input_internal.h"
61 /*****************************************************************************
63 *****************************************************************************/
64 static int Activate( vlc_object_t * );
65 static void Close ( vlc_object_t * );
67 static mtime_t GetClockRef( intf_thread_t *, mtime_t );
69 /// \bug [String] This string is BAD.
70 #define NETSYNC_TEXT N_( "Act as master" )
71 #define NETSYNC_LONGTEXT N_( "Should " \
72 "act as the master client for the network synchronisation?" )
74 /// \bug [String] This string is BAD.
75 #define MIP_TEXT N_( "Master client ip address" )
76 #define MIP_LONGTEXT N_( "IP address of " \
77 "the master client used for the network synchronisation." )
80 set_shortname( _("Network Sync"));
81 set_description( _("Network synchronisation") );
82 set_category( CAT_ADVANCED );
83 set_subcategory( SUBCAT_ADVANCED_MISC );
85 add_bool( "netsync-master", 0, NULL,
86 NETSYNC_TEXT, NETSYNC_LONGTEXT, VLC_TRUE );
87 add_string( "netsync-master-ip", NULL, NULL, MIP_TEXT, MIP_LONGTEXT,
90 set_capability( "interface", 0 );
91 set_callbacks( Activate, Close );
96 input_thread_t *p_input;
99 /*****************************************************************************
101 *****************************************************************************/
102 static void Run( intf_thread_t *p_intf );
104 /*****************************************************************************
105 * Activate: initialize and create stuff
106 *****************************************************************************/
107 static int Activate( vlc_object_t *p_this )
109 intf_thread_t *p_intf = (intf_thread_t*)p_this;
111 p_intf->p_sys = malloc( sizeof( intf_sys_t ) );
114 msg_Err( p_intf, "no memory" );
118 p_intf->p_sys->p_input = NULL;
120 p_intf->pf_run = Run;
124 /*****************************************************************************
125 * Close: destroy interface
126 *****************************************************************************/
127 void Close( vlc_object_t *p_this )
129 intf_thread_t *p_intf = (intf_thread_t*)p_this;
131 free( p_intf->p_sys );
134 /*****************************************************************************
135 * Run: interface thread
136 *****************************************************************************/
137 static void Run( intf_thread_t *p_intf )
139 #define MAX_MSG_LENGTH (2 * sizeof(int64_t))
141 vlc_bool_t b_master = config_GetInt( p_intf, "netsync-master" );
142 char *psz_master = NULL;
143 char p_data[MAX_MSG_LENGTH];
148 psz_master = config_GetPsz( p_intf, "netsync-master-ip" );
149 if( psz_master == NULL )
151 msg_Err( p_intf, "master address not specified" );
157 i_socket = net_ListenUDP1( VLC_OBJECT(p_intf), NULL, NETSYNC_PORT );
159 i_socket = net_ConnectUDP( VLC_OBJECT(p_intf), psz_master, NETSYNC_PORT, 0 );
165 msg_Err( p_intf, "failed opening UDP socket" ); /* str review: is this good enough? */
169 /* High priority thread */
170 vlc_thread_set_priority( p_intf, VLC_THREAD_PRIORITY_INPUT );
172 while( !intf_ShouldDie( p_intf ) )
174 /* Update the input */
175 if( p_intf->p_sys->p_input == NULL )
177 p_intf->p_sys->p_input =
178 (input_thread_t *)vlc_object_find( p_intf, VLC_OBJECT_INPUT,
181 else if( p_intf->p_sys->p_input->b_dead )
183 vlc_object_release( p_intf->p_sys->p_input );
184 p_intf->p_sys->p_input = NULL;
187 if( p_intf->p_sys->p_input == NULL )
190 msleep( INTF_IDLE_SLEEP );
195 * We now have an input
198 /* Initialize file descriptor set and timeout (0.5s) */
199 /* FIXME: arbitrary tick */
200 struct pollfd ufd = { .fd = i_socket, .events = POLLIN, };
204 struct sockaddr_storage from;
205 mtime_t i_date, i_clockref, i_master_clockref;
206 int i_struct_size, i_read, i_ret;
209 i_ret = poll( &ufd, 1, 500 );
210 if( i_ret == 0 ) continue;
214 msleep( INTF_IDLE_SLEEP );
218 /* We received something */
219 i_struct_size = sizeof( from );
220 i_read = recvfrom( i_socket, p_data, MAX_MSG_LENGTH, 0,
221 (struct sockaddr*)&from,
222 (unsigned int *)&i_struct_size );
224 i_clockref = ntoh64(*(int64_t *)p_data);
227 *(int64_t *)p_data = hton64( i_date );
229 i_master_clockref = GetClockRef( p_intf, i_clockref );
230 *(((int64_t *)p_data)+1) = hton64( i_master_clockref );
232 /* Reply to the sender */
233 sendto( i_socket, p_data, 2 * sizeof(int64_t), 0,
234 (struct sockaddr *)&from, i_struct_size );
237 msg_Dbg( p_intf, "Master clockref: "I64Fd" -> "I64Fd", from %s "
238 "(date: "I64Fd")", i_clockref, i_master_clockref,
239 from.ss_family == AF_INET
240 ? inet_ntoa(((struct sockaddr_in *)&from)->sin_addr)
241 : "non-IPv4", i_date );
246 mtime_t i_send_date, i_receive_date, i_master_date, i_diff_date;
247 mtime_t i_master_clockref, i_client_clockref, i_drift;
248 mtime_t i_clockref = 0;
249 int i_sent, i_read, i_ret;
251 /* Send clock request to the master */
252 *(int64_t *)p_data = hton64( i_clockref );
253 i_send_date = mdate();
255 i_sent = send( i_socket, p_data, sizeof(int64_t), 0 );
259 msleep( INTF_IDLE_SLEEP );
264 i_ret = poll( &ufd, 1, 500 );
265 if( i_ret == 0 ) continue;
269 msleep( INTF_IDLE_SLEEP );
273 i_receive_date = mdate();
275 i_read = recv( i_socket, p_data, MAX_MSG_LENGTH, 0 );
279 msleep( INTF_IDLE_SLEEP );
283 i_master_date = ntoh64(*(int64_t *)p_data);
284 i_master_clockref = ntoh64(*(((int64_t *)p_data)+1));
286 i_diff_date = i_receive_date -
287 ((i_receive_date - i_send_date) / 2 + i_master_date);
289 i_client_clockref = i_drift = 0;
290 if( p_intf->p_sys->p_input && i_master_clockref )
292 i_client_clockref = GetClockRef( p_intf, i_clockref );
293 i_drift = i_client_clockref - i_master_clockref - i_diff_date;
295 /* Update our clock to match the master's one */
296 if( i_client_clockref )
297 p_intf->p_sys->p_input->i_pts_delay -= i_drift;
301 msg_Dbg( p_intf, "Slave clockref: "I64Fd" -> "I64Fd" -> "I64Fd", "
302 "clock diff: "I64Fd" drift: "I64Fd,
303 i_clockref, i_master_clockref,
304 i_client_clockref, i_diff_date, i_drift );
308 msleep( INTF_IDLE_SLEEP );
312 if( p_intf->p_sys->p_input ) vlc_object_release( p_intf->p_sys->p_input );
313 net_Close( i_socket );
316 static mtime_t GetClockRef( intf_thread_t *p_intf, mtime_t i_pts )
318 input_thread_t *p_input = p_intf->p_sys->p_input;
321 if( !p_input || !p_input->p->p_es_out ) return 0;
323 if( es_out_Control( p_input->p->p_es_out, ES_OUT_GET_TS, i_pts, &i_ts ) ==