* modules/control/netsync.c: Experimental network synchronisation module.
[vlc.git] / modules / control / netsync.c
1 /*****************************************************************************\r
2  * netsync.c: synchronisation between several network clients.\r
3  *****************************************************************************\r
4  * Copyright (C) 2004 VideoLAN\r
5  * $Id: ntservice.c 6963 2004-03-05 19:24:14Z murray $\r
6  *\r
7  * Authors: Gildas Bazin <gbazin@videolan.org>\r
8  *\r
9  * This program is free software; you can redistribute it and/or modify\r
10  * it under the terms of the GNU General Public License as published by\r
11  * the Free Software Foundation; either version 2 of the License, or\r
12  * (at your option) any later version.\r
13  *\r
14  * This program is distributed in the hope that it will be useful,\r
15  * but WITHOUT ANY WARRANTY; without even the implied warranty of\r
16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the\r
17  * GNU General Public License for more details.\r
18  *\r
19  * You should have received a copy of the GNU General Public License\r
20  * along with this program; if not, write to the Free Software\r
21  * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111, USA.\r
22  *****************************************************************************/\r
23 \r
24 /*****************************************************************************\r
25  * Preamble\r
26  *****************************************************************************/\r
27 #include <stdlib.h>\r
28 #include <vlc/vlc.h>\r
29 #include <vlc/intf.h>\r
30 \r
31 #ifdef HAVE_UNISTD_H\r
32 #    include <unistd.h>\r
33 #endif\r
34 \r
35 #ifdef HAVE_SYS_TIME_H\r
36 #    include <sys/time.h>\r
37 #endif\r
38 #include <sys/types.h>\r
39 \r
40 #ifdef WIN32\r
41 #   include <winsock2.h>\r
42 #   include <ws2tcpip.h>\r
43 #   ifndef IN_MULTICAST\r
44 #       define IN_MULTICAST(a) IN_CLASSD(a)\r
45 #   endif\r
46 #else\r
47 #   include <sys/socket.h>\r
48 #   include <netinet/in.h>\r
49 #   if HAVE_ARPA_INET_H\r
50 #      include <arpa/inet.h>\r
51 #   elif defined( SYS_BEOS )\r
52 #      include <net/netdb.h>\r
53 #   endif\r
54 #endif\r
55 \r
56 #ifdef UNDER_CE\r
57 #   define close(a) CloseHandle(a);\r
58 #elif defined( WIN32 )\r
59 #   define close(a) closesocket(a);\r
60 #endif\r
61 \r
62 #include "network.h"\r
63 #include "input_ext-plugins.h"\r
64 \r
65 #define NETSYNC_PORT_MASTER 9875\r
66 #define NETSYNC_PORT_SLAVE  9876\r
67 \r
68 /*****************************************************************************\r
69  * Module descriptor\r
70  *****************************************************************************/\r
71 static int  Activate( vlc_object_t * );\r
72 static void Close   ( vlc_object_t * );\r
73 \r
74 static mtime_t GetClockRef( intf_thread_t *, mtime_t );\r
75 \r
76 #define NETSYNC_TEXT N_( "Act as master for network synchronisation" )\r
77 #define NETSYNC_LONGTEXT N_( "Allows you to specify if this client should " \\r
78   "act as the master client for the network synchronisation." )\r
79 \r
80 #define MIP_TEXT N_( "Master client ip address" )\r
81 #define MIP_LONGTEXT N_( "Allows you to specify the ip address of " \\r
82   "the master client used for the network synchronisation." )\r
83 \r
84 vlc_module_begin();\r
85     set_description( _("Network synchronisation") );\r
86 \r
87     add_bool( "netsync-master", 0, NULL,\r
88               NETSYNC_TEXT, NETSYNC_LONGTEXT, VLC_TRUE );\r
89     add_string( "netsync-master-ip", NULL, NULL, MIP_TEXT, MIP_LONGTEXT,\r
90                 VLC_TRUE );\r
91 \r
92     set_capability( "interface", 0 );\r
93     set_callbacks( Activate, Close );\r
94 vlc_module_end();\r
95 \r
96 struct intf_sys_t\r
97 {\r
98     input_thread_t *p_input;\r
99 };\r
100 \r
101 /*****************************************************************************\r
102  * Local prototypes\r
103  *****************************************************************************/\r
104 static void Run( intf_thread_t *p_intf );\r
105 \r
106 /*****************************************************************************\r
107  * Activate: initialize and create stuff\r
108  *****************************************************************************/\r
109 static int Activate( vlc_object_t *p_this )\r
110 {\r
111     intf_thread_t *p_intf = (intf_thread_t*)p_this;\r
112 \r
113     msg_Info( p_intf, "Using the netsync interface module..." );\r
114 \r
115     p_intf->p_sys = malloc( sizeof( intf_sys_t ) );\r
116 \r
117     p_intf->pf_run = Run;\r
118     return VLC_SUCCESS;\r
119 }\r
120 \r
121 /*****************************************************************************\r
122  * Close: destroy interface\r
123  *****************************************************************************/\r
124 void Close( vlc_object_t *p_this )\r
125 {\r
126     intf_thread_t *p_intf = (intf_thread_t*)p_this;\r
127 \r
128     free( p_intf->p_sys );\r
129 }\r
130 \r
131 /*****************************************************************************\r
132  * Run: interface thread\r
133  *****************************************************************************/\r
134 static void Run( intf_thread_t *p_intf )\r
135 {\r
136 #define MAX_MSG_LENGTH (2 * sizeof(int64_t))\r
137 \r
138     vlc_bool_t b_master = config_GetInt( p_intf, "netsync-master" );\r
139     char *psz_master = config_GetPsz( p_intf, "netsync-master-ip" );\r
140     struct sockaddr_in master_addr;\r
141     char p_data[MAX_MSG_LENGTH];\r
142     int i_socket;\r
143 \r
144     if( !psz_master || inet_addr( psz_master ) == INADDR_NONE )\r
145     {\r
146         if( psz_master ) free( psz_master );\r
147         msg_Err( p_intf, "invalid master address." );\r
148         return;\r
149     }\r
150 \r
151     memset( &master_addr, 0, sizeof( struct sockaddr_in ) );\r
152     master_addr.sin_family = AF_INET;\r
153     master_addr.sin_port = htons( (uint16_t)NETSYNC_PORT_MASTER );\r
154     master_addr.sin_addr.s_addr = inet_addr( psz_master );\r
155     free( psz_master );\r
156 \r
157     i_socket = net_OpenUDP( p_intf, NULL, b_master ? NETSYNC_PORT_MASTER :\r
158                             NETSYNC_PORT_SLAVE, NULL, 0 );\r
159     if( i_socket < 0 )\r
160     {\r
161         msg_Err( p_intf, "failed opening UDP socket." );\r
162         return;\r
163     }\r
164 \r
165     /* High priority thread */\r
166     vlc_thread_set_priority( p_intf, VLC_THREAD_PRIORITY_INPUT );\r
167 \r
168     while( !p_intf->b_die )\r
169     {\r
170         struct timeval  timeout;\r
171         fd_set fds_r;\r
172 \r
173         /* Update the input */\r
174         if( p_intf->p_sys->p_input == NULL )\r
175         {\r
176             p_intf->p_sys->p_input =\r
177                 (input_thread_t *)vlc_object_find( p_intf, VLC_OBJECT_INPUT,\r
178                                                    FIND_ANYWHERE );\r
179         }\r
180         else if( p_intf->p_sys->p_input->b_dead )\r
181         {\r
182             vlc_object_release( p_intf->p_sys->p_input );\r
183             p_intf->p_sys->p_input = NULL;\r
184         }\r
185 \r
186         if( p_intf->p_sys->p_input == NULL )\r
187         {\r
188             /* Wait a bit */\r
189             msleep( INTF_IDLE_SLEEP );\r
190             continue;\r
191         }\r
192 \r
193         /*\r
194          * We now have an input\r
195          */\r
196 \r
197         /* Initialize file descriptor set and timeout (0.5s) */\r
198         FD_ZERO( &fds_r );\r
199         FD_SET( i_socket, &fds_r );\r
200         timeout.tv_sec = 0;\r
201         timeout.tv_usec = 500000;\r
202 \r
203         if( b_master )\r
204         {\r
205             struct sockaddr_in from;\r
206             mtime_t i_date, i_clockref, i_master_clockref;\r
207             int i_struct_size, i_read, i_ret;\r
208 \r
209             /* Don't block */\r
210             i_ret = select( i_socket + 1, &fds_r, 0, 0, &timeout );\r
211             if( i_ret == 0 ) continue;\r
212             if( i_ret < 0 )\r
213             {\r
214                 /* Wait a bit */\r
215                 msleep( INTF_IDLE_SLEEP );\r
216                 continue;\r
217             }\r
218 \r
219             /* We received something */\r
220             i_struct_size = sizeof(struct sockaddr_in);\r
221             i_read = recvfrom( i_socket, p_data, MAX_MSG_LENGTH, 0,\r
222                                (struct sockaddr*)&from, &i_struct_size );\r
223 \r
224             from.sin_port = htons( (uint16_t)NETSYNC_PORT_SLAVE );\r
225 \r
226             i_clockref = ntoh64(*(int64_t *)p_data);\r
227 \r
228             i_date = mdate();\r
229             *(int64_t *)p_data = hton64( i_date );\r
230 \r
231             i_master_clockref = GetClockRef( p_intf, i_clockref );\r
232             *(((int64_t *)p_data)+1) = hton64( i_master_clockref );\r
233 \r
234             /* Reply to the sender */\r
235             sendto( i_socket, p_data, 2 * sizeof(int64_t), 0,\r
236                     (struct sockaddr *)&from, sizeof(struct sockaddr_in) );\r
237 \r
238             msg_Dbg( p_intf, "Master clockref: "I64Fd" -> "I64Fd", from %s "\r
239                      "(date: "I64Fd")", i_clockref, i_master_clockref, \r
240                      inet_ntoa(from.sin_addr), i_date );\r
241         }\r
242         else\r
243         {\r
244             mtime_t i_send_date, i_receive_date, i_master_date, i_diff_date;\r
245             mtime_t i_master_clockref, i_client_clockref, i_drift;\r
246             mtime_t i_clockref = 0;\r
247             int i_sent, i_read, i_ret;\r
248 \r
249             /* Send clock request to the master */\r
250             *(int64_t *)p_data = hton64( i_clockref );\r
251             i_send_date = mdate();\r
252 \r
253             i_sent = sendto( i_socket, p_data, sizeof(int64_t), 0,\r
254                              (struct sockaddr *)&master_addr,\r
255                              sizeof(struct sockaddr_in) );\r
256             if( i_sent <= 0 )\r
257             {\r
258                 /* Wait a bit */\r
259                 msleep( INTF_IDLE_SLEEP );\r
260                 continue;\r
261             }\r
262 \r
263             /* Don't block */\r
264             i_ret = select(i_socket + 1, &fds_r, 0, 0, &timeout);\r
265             if( i_ret == 0 ) continue;\r
266             if( i_ret < 0 )\r
267             {\r
268                 /* Wait a bit */\r
269                 msleep( INTF_IDLE_SLEEP );\r
270                 continue;\r
271             }\r
272 \r
273             i_receive_date = mdate();\r
274 \r
275             i_read = recv( i_socket, p_data, MAX_MSG_LENGTH, 0 );\r
276             if( i_read <= 0 )\r
277             {\r
278                 /* Wait a bit */\r
279                 msleep( INTF_IDLE_SLEEP );\r
280                 continue;\r
281             }\r
282 \r
283             i_master_date = ntoh64(*(int64_t *)p_data);\r
284             i_master_clockref = ntoh64(*(((int64_t *)p_data)+1));\r
285 \r
286             i_diff_date = i_receive_date -\r
287                           ((i_receive_date - i_send_date) / 2 + i_master_date);\r
288 \r
289             i_client_clockref = i_drift = 0;\r
290             if( p_intf->p_sys->p_input && i_master_clockref )\r
291             {\r
292                 i_client_clockref = GetClockRef( p_intf, i_clockref );\r
293                 i_drift = i_client_clockref - i_master_clockref - i_diff_date;\r
294 \r
295                 /* Update our clock to match the master's one */\r
296                 if( i_client_clockref )\r
297                     p_intf->p_sys->p_input->i_pts_delay -= i_drift;\r
298             }\r
299 \r
300             msg_Dbg( p_intf, "Slave clockref: "I64Fd" -> "I64Fd" -> "I64Fd", "\r
301                      "clock diff: "I64Fd" drift: "I64Fd,\r
302                      i_clockref, i_master_clockref, \r
303                      i_client_clockref, i_diff_date, i_drift );\r
304 \r
305             /* Wait a bit */\r
306             msleep( INTF_IDLE_SLEEP );\r
307         }\r
308     }\r
309 \r
310     if( p_intf->p_sys->p_input ) vlc_object_release( p_intf->p_sys->p_input );\r
311     net_Close( i_socket );\r
312 }\r
313 \r
314 static mtime_t GetClockRef( intf_thread_t *p_intf, mtime_t i_pts )\r
315 {\r
316     input_thread_t *p_input = p_intf->p_sys->p_input;\r
317     pgrm_descriptor_t *p_pgrm;\r
318 \r
319     if( !p_input ) return 0;\r
320 \r
321     p_pgrm = p_input->stream.p_selected_program;\r
322     if( p_pgrm ) return input_ClockGetTS( p_input, p_pgrm, i_pts );\r
323 \r
324     return 0;\r
325 }\r