git.sesse.net Git - vlc/blob - modules/control/netsync.c

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