String fixes
[vlc.git] / modules / control / netsync.c
1 /*****************************************************************************
2  * netsync.c: synchronisation between several network clients.
3  *****************************************************************************
4  * Copyright (C) 2004 the VideoLAN team
5  * $Id$
6  *
7  * Authors: Gildas Bazin <gbazin@videolan.org>
8  *
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.
13  *
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.
18  *
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  *****************************************************************************/
23
24 /*****************************************************************************
25  * Preamble
26  *****************************************************************************/
27 #include <stdlib.h>
28 #include <vlc/vlc.h>
29 #include <vlc/intf.h>
30 #include <vlc/input.h>
31
32 #ifdef HAVE_UNISTD_H
33 #    include <unistd.h>
34 #endif
35 #ifdef HAVE_SYS_TIME_H
36 #    include <sys/time.h>
37 #endif
38 #ifdef HAVE_SYS_TYPES_H
39 #   include <sys/types.h>
40 #endif
41
42 #include "network.h"
43
44 #define NETSYNC_PORT 9875
45
46 /* Needed for Solaris */
47 #ifndef INADDR_NONE
48 #define INADDR_NONE 0xffffffff
49 #endif
50
51 /*****************************************************************************
52  * Module descriptor
53  *****************************************************************************/
54 static int  Activate( vlc_object_t * );
55 static void Close   ( vlc_object_t * );
56
57 static mtime_t GetClockRef( intf_thread_t *, mtime_t );
58
59 /// \bug [String] This string is BAD.
60 #define NETSYNC_TEXT N_( "Act as master" )
61 #define NETSYNC_LONGTEXT N_( "Should " \
62   "act as the master client for the network synchronisation?" )
63
64 /// \bug [String] This string is BAD.
65 #define MIP_TEXT N_( "Master client ip address" )
66 #define MIP_LONGTEXT N_( "IP address of " \
67   "the master client used for the network synchronisation." )
68
69 vlc_module_begin();
70     set_shortname( _("Network Sync"));
71     set_description( _("Network synchronisation") );
72     set_category( CAT_ADVANCED );
73     set_subcategory( SUBCAT_ADVANCED_MISC );
74
75     add_bool( "netsync-master", 0, NULL,
76               NETSYNC_TEXT, NETSYNC_LONGTEXT, VLC_TRUE );
77     add_string( "netsync-master-ip", NULL, NULL, MIP_TEXT, MIP_LONGTEXT,
78                 VLC_TRUE );
79
80     set_capability( "interface", 0 );
81     set_callbacks( Activate, Close );
82 vlc_module_end();
83
84 struct intf_sys_t
85 {
86     input_thread_t *p_input;
87 };
88
89 /*****************************************************************************
90  * Local prototypes
91  *****************************************************************************/
92 static void Run( intf_thread_t *p_intf );
93
94 /*****************************************************************************
95  * Activate: initialize and create stuff
96  *****************************************************************************/
97 static int Activate( vlc_object_t *p_this )
98 {
99     intf_thread_t *p_intf = (intf_thread_t*)p_this;
100
101     p_intf->p_sys = malloc( sizeof( intf_sys_t ) );
102     if( !p_intf->p_sys )
103     {
104         msg_Err( p_intf, "no memory" );
105         return VLC_ENOMEM;
106     }
107
108     p_intf->p_sys->p_input = NULL;
109
110     p_intf->pf_run = Run;
111     return VLC_SUCCESS;
112 }
113
114 /*****************************************************************************
115  * Close: destroy interface
116  *****************************************************************************/
117 void Close( vlc_object_t *p_this )
118 {
119     intf_thread_t *p_intf = (intf_thread_t*)p_this;
120
121     free( p_intf->p_sys );
122 }
123
124 /*****************************************************************************
125  * Run: interface thread
126  *****************************************************************************/
127 static void Run( intf_thread_t *p_intf )
128 {
129 #define MAX_MSG_LENGTH (2 * sizeof(int64_t))
130
131     vlc_bool_t b_master = config_GetInt( p_intf, "netsync-master" );
132     char *psz_master = NULL;
133     char p_data[MAX_MSG_LENGTH];
134     int i_socket;
135
136     if( !b_master )
137     {
138         psz_master = config_GetPsz( p_intf, "netsync-master-ip" );
139         if( psz_master == NULL )
140         {
141             msg_Err( p_intf, "master address not specified" );
142             return;
143         }
144     }
145
146     if( b_master )
147         i_socket = net_OpenUDP( p_intf, NULL, NETSYNC_PORT, NULL, 0 );
148     else
149         i_socket = net_ConnectUDP( p_intf, psz_master, NETSYNC_PORT, 0 );
150
151     if( psz_master ) free( psz_master );
152
153     if( i_socket < 0 )
154     {
155         msg_Err( p_intf, "failed opening UDP socket" ); /* str review: is this good enough? */
156         return;
157     }
158
159     /* High priority thread */
160     vlc_thread_set_priority( p_intf, VLC_THREAD_PRIORITY_INPUT );
161
162     while( !p_intf->b_die )
163     {
164         struct timeval timeout;
165         fd_set fds_r;
166
167         /* Update the input */
168         if( p_intf->p_sys->p_input == NULL )
169         {
170             p_intf->p_sys->p_input =
171                 (input_thread_t *)vlc_object_find( p_intf, VLC_OBJECT_INPUT,
172                                                    FIND_ANYWHERE );
173         }
174         else if( p_intf->p_sys->p_input->b_dead )
175         {
176             vlc_object_release( p_intf->p_sys->p_input );
177             p_intf->p_sys->p_input = NULL;
178         }
179
180         if( p_intf->p_sys->p_input == NULL )
181         {
182             /* Wait a bit */
183             msleep( INTF_IDLE_SLEEP );
184             continue;
185         }
186
187         /*
188          * We now have an input
189          */
190
191         /* Initialize file descriptor set and timeout (0.5s) */
192         FD_ZERO( &fds_r );
193         FD_SET( i_socket, &fds_r );
194         timeout.tv_sec = 0;
195         timeout.tv_usec = 500000;
196
197         if( b_master )
198         {
199             struct sockaddr_storage from;
200             mtime_t i_date, i_clockref, i_master_clockref;
201             int i_struct_size, i_read, i_ret;
202
203             /* Don't block */
204             i_ret = select( i_socket + 1, &fds_r, 0, 0, &timeout );
205             if( i_ret == 0 ) continue;
206             if( i_ret < 0 )
207             {
208                 /* Wait a bit */
209                 msleep( INTF_IDLE_SLEEP );
210                 continue;
211             }
212
213             /* We received something */
214             i_struct_size = sizeof( from );
215             i_read = recvfrom( i_socket, p_data, MAX_MSG_LENGTH, 0,
216                                (struct sockaddr*)&from,
217                                (unsigned int *)&i_struct_size );
218
219             i_clockref = ntoh64(*(int64_t *)p_data);
220
221             i_date = mdate();
222             *(int64_t *)p_data = hton64( i_date );
223
224             i_master_clockref = GetClockRef( p_intf, i_clockref );
225             *(((int64_t *)p_data)+1) = hton64( i_master_clockref );
226
227             /* Reply to the sender */
228             sendto( i_socket, p_data, 2 * sizeof(int64_t), 0,
229                     (struct sockaddr *)&from, i_struct_size );
230
231 #if 0
232             msg_Dbg( p_intf, "Master clockref: "I64Fd" -> "I64Fd", from %s "
233                      "(date: "I64Fd")", i_clockref, i_master_clockref,
234                      from.ss_family == AF_INET
235                      ? inet_ntoa(((struct sockaddr_in *)&from)->sin_addr)
236                      : "non-IPv4", i_date );
237 #endif
238         }
239         else
240         {
241             mtime_t i_send_date, i_receive_date, i_master_date, i_diff_date;
242             mtime_t i_master_clockref, i_client_clockref, i_drift;
243             mtime_t i_clockref = 0;
244             int i_sent, i_read, i_ret;
245
246             /* Send clock request to the master */
247             *(int64_t *)p_data = hton64( i_clockref );
248             i_send_date = mdate();
249
250             i_sent = send( i_socket, p_data, sizeof(int64_t), 0 );
251             if( i_sent <= 0 )
252             {
253                 /* Wait a bit */
254                 msleep( INTF_IDLE_SLEEP );
255                 continue;
256             }
257
258             /* Don't block */
259             i_ret = select(i_socket + 1, &fds_r, 0, 0, &timeout);
260             if( i_ret == 0 ) continue;
261             if( i_ret < 0 )
262             {
263                 /* Wait a bit */
264                 msleep( INTF_IDLE_SLEEP );
265                 continue;
266             }
267
268             i_receive_date = mdate();
269
270             i_read = recv( i_socket, p_data, MAX_MSG_LENGTH, 0 );
271             if( i_read <= 0 )
272             {
273                 /* Wait a bit */
274                 msleep( INTF_IDLE_SLEEP );
275                 continue;
276             }
277
278             i_master_date = ntoh64(*(int64_t *)p_data);
279             i_master_clockref = ntoh64(*(((int64_t *)p_data)+1));
280
281             i_diff_date = i_receive_date -
282                           ((i_receive_date - i_send_date) / 2 + i_master_date);
283
284             i_client_clockref = i_drift = 0;
285             if( p_intf->p_sys->p_input && i_master_clockref )
286             {
287                 i_client_clockref = GetClockRef( p_intf, i_clockref );
288                 i_drift = i_client_clockref - i_master_clockref - i_diff_date;
289
290                 /* Update our clock to match the master's one */
291                 if( i_client_clockref )
292                     p_intf->p_sys->p_input->i_pts_delay -= i_drift;
293             }
294
295 #if 0
296             msg_Dbg( p_intf, "Slave clockref: "I64Fd" -> "I64Fd" -> "I64Fd", "
297                      "clock diff: "I64Fd" drift: "I64Fd,
298                      i_clockref, i_master_clockref,
299                      i_client_clockref, i_diff_date, i_drift );
300 #endif
301
302             /* Wait a bit */
303             msleep( INTF_IDLE_SLEEP );
304         }
305     }
306
307     if( p_intf->p_sys->p_input ) vlc_object_release( p_intf->p_sys->p_input );
308     net_Close( i_socket );
309 }
310
311 static mtime_t GetClockRef( intf_thread_t *p_intf, mtime_t i_pts )
312 {
313     input_thread_t *p_input = p_intf->p_sys->p_input;
314     mtime_t i_ts;
315
316     if( !p_input || !p_input->p_es_out ) return 0;
317
318     if( es_out_Control( p_input->p_es_out, ES_OUT_GET_TS, i_pts, &i_ts ) ==
319         VLC_SUCCESS )
320     {
321         return i_ts;
322     }
323
324     return 0;
325 }