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 *****************************************************************************/
28 #include <vlc_interface.h>
29 #include <vlc_input.h>
30 #include <vlc_es_out.h>
35 #ifdef HAVE_SYS_TIME_H
36 # include <sys/time.h>
38 #ifdef HAVE_SYS_TYPES_H
39 # include <sys/types.h>
45 #include <vlc_network.h>
47 #define NETSYNC_PORT 9875
49 /* Needed for Solaris */
51 #define INADDR_NONE 0xffffffff
54 /* FIXME: UGLY UGLY !! Netsync should be totally reworked */
55 #include "../../src/input/input_internal.h"
57 /*****************************************************************************
59 *****************************************************************************/
60 static int Activate( vlc_object_t * );
61 static void Close ( vlc_object_t * );
63 static mtime_t GetClockRef( intf_thread_t *, mtime_t );
65 /// \bug [String] This string is BAD.
66 #define NETSYNC_TEXT N_( "Act as master" )
67 #define NETSYNC_LONGTEXT N_( "Should " \
68 "act as the master client for the network synchronisation?" )
70 /// \bug [String] This string is BAD.
71 #define MIP_TEXT N_( "Master client ip address" )
72 #define MIP_LONGTEXT N_( "IP address of " \
73 "the master client used for the network synchronisation." )
76 set_shortname( _("Network Sync"));
77 set_description( _("Network synchronisation") );
78 set_category( CAT_ADVANCED );
79 set_subcategory( SUBCAT_ADVANCED_MISC );
81 add_bool( "netsync-master", 0, NULL,
82 NETSYNC_TEXT, NETSYNC_LONGTEXT, VLC_TRUE );
83 add_string( "netsync-master-ip", NULL, NULL, MIP_TEXT, MIP_LONGTEXT,
86 set_capability( "interface", 0 );
87 set_callbacks( Activate, Close );
92 input_thread_t *p_input;
95 /*****************************************************************************
97 *****************************************************************************/
98 static void Run( intf_thread_t *p_intf );
100 /*****************************************************************************
101 * Activate: initialize and create stuff
102 *****************************************************************************/
103 static int Activate( vlc_object_t *p_this )
105 intf_thread_t *p_intf = (intf_thread_t*)p_this;
107 p_intf->p_sys = malloc( sizeof( intf_sys_t ) );
110 msg_Err( p_intf, "no memory" );
114 p_intf->p_sys->p_input = NULL;
116 p_intf->pf_run = Run;
120 /*****************************************************************************
121 * Close: destroy interface
122 *****************************************************************************/
123 void Close( vlc_object_t *p_this )
125 intf_thread_t *p_intf = (intf_thread_t*)p_this;
127 free( p_intf->p_sys );
130 /*****************************************************************************
131 * Run: interface thread
132 *****************************************************************************/
133 static void Run( intf_thread_t *p_intf )
135 #define MAX_MSG_LENGTH (2 * sizeof(int64_t))
137 vlc_bool_t b_master = config_GetInt( p_intf, "netsync-master" );
138 char *psz_master = NULL;
139 char p_data[MAX_MSG_LENGTH];
144 psz_master = config_GetPsz( p_intf, "netsync-master-ip" );
145 if( psz_master == NULL )
147 msg_Err( p_intf, "master address not specified" );
153 i_socket = net_ListenUDP1( VLC_OBJECT(p_intf), NULL, NETSYNC_PORT );
155 i_socket = net_ConnectUDP( VLC_OBJECT(p_intf), psz_master, NETSYNC_PORT, 0 );
157 if( psz_master ) free( psz_master );
161 msg_Err( p_intf, "failed opening UDP socket" ); /* str review: is this good enough? */
165 /* High priority thread */
166 vlc_thread_set_priority( p_intf, VLC_THREAD_PRIORITY_INPUT );
168 while( !intf_ShouldDie( p_intf ) )
170 /* Update the input */
171 if( p_intf->p_sys->p_input == NULL )
173 p_intf->p_sys->p_input =
174 (input_thread_t *)vlc_object_find( p_intf, VLC_OBJECT_INPUT,
177 else if( p_intf->p_sys->p_input->b_dead )
179 vlc_object_release( p_intf->p_sys->p_input );
180 p_intf->p_sys->p_input = NULL;
183 if( p_intf->p_sys->p_input == NULL )
186 msleep( INTF_IDLE_SLEEP );
191 * We now have an input
194 /* Initialize file descriptor set and timeout (0.5s) */
195 /* FIXME: arbitrary tick */
196 struct pollfd ufd = { .fd = i_socket, .events = POLLIN, };
200 struct sockaddr_storage from;
201 mtime_t i_date, i_clockref, i_master_clockref;
202 int i_struct_size, i_read, i_ret;
205 i_ret = poll( &ufd, 1, 500 );
206 if( i_ret == 0 ) continue;
210 msleep( INTF_IDLE_SLEEP );
214 /* We received something */
215 i_struct_size = sizeof( from );
216 i_read = recvfrom( i_socket, p_data, MAX_MSG_LENGTH, 0,
217 (struct sockaddr*)&from,
218 (unsigned int *)&i_struct_size );
220 i_clockref = ntoh64(*(int64_t *)p_data);
223 *(int64_t *)p_data = hton64( i_date );
225 i_master_clockref = GetClockRef( p_intf, i_clockref );
226 *(((int64_t *)p_data)+1) = hton64( i_master_clockref );
228 /* Reply to the sender */
229 sendto( i_socket, p_data, 2 * sizeof(int64_t), 0,
230 (struct sockaddr *)&from, i_struct_size );
233 msg_Dbg( p_intf, "Master clockref: "I64Fd" -> "I64Fd", from %s "
234 "(date: "I64Fd")", i_clockref, i_master_clockref,
235 from.ss_family == AF_INET
236 ? inet_ntoa(((struct sockaddr_in *)&from)->sin_addr)
237 : "non-IPv4", i_date );
242 mtime_t i_send_date, i_receive_date, i_master_date, i_diff_date;
243 mtime_t i_master_clockref, i_client_clockref, i_drift;
244 mtime_t i_clockref = 0;
245 int i_sent, i_read, i_ret;
247 /* Send clock request to the master */
248 *(int64_t *)p_data = hton64( i_clockref );
249 i_send_date = mdate();
251 i_sent = send( i_socket, p_data, sizeof(int64_t), 0 );
255 msleep( INTF_IDLE_SLEEP );
260 i_ret = poll( &ufd, 1, 500 );
261 if( i_ret == 0 ) continue;
265 msleep( INTF_IDLE_SLEEP );
269 i_receive_date = mdate();
271 i_read = recv( i_socket, p_data, MAX_MSG_LENGTH, 0 );
275 msleep( INTF_IDLE_SLEEP );
279 i_master_date = ntoh64(*(int64_t *)p_data);
280 i_master_clockref = ntoh64(*(((int64_t *)p_data)+1));
282 i_diff_date = i_receive_date -
283 ((i_receive_date - i_send_date) / 2 + i_master_date);
285 i_client_clockref = i_drift = 0;
286 if( p_intf->p_sys->p_input && i_master_clockref )
288 i_client_clockref = GetClockRef( p_intf, i_clockref );
289 i_drift = i_client_clockref - i_master_clockref - i_diff_date;
291 /* Update our clock to match the master's one */
292 if( i_client_clockref )
293 p_intf->p_sys->p_input->i_pts_delay -= i_drift;
297 msg_Dbg( p_intf, "Slave clockref: "I64Fd" -> "I64Fd" -> "I64Fd", "
298 "clock diff: "I64Fd" drift: "I64Fd,
299 i_clockref, i_master_clockref,
300 i_client_clockref, i_diff_date, i_drift );
304 msleep( INTF_IDLE_SLEEP );
308 if( p_intf->p_sys->p_input ) vlc_object_release( p_intf->p_sys->p_input );
309 net_Close( i_socket );
312 static mtime_t GetClockRef( intf_thread_t *p_intf, mtime_t i_pts )
314 input_thread_t *p_input = p_intf->p_sys->p_input;
317 if( !p_input || !p_input->p->p_es_out ) return 0;
319 if( es_out_Control( p_input->p->p_es_out, ES_OUT_GET_TS, i_pts, &i_ts ) ==