netsync.c 9.3 KB
Newer Older
1
/*****************************************************************************
2
 * netsync.c: synchronization between several network clients.
3
 *****************************************************************************
Jean-Paul Saman's avatar
Jean-Paul Saman committed
4
 * Copyright (C) 2004-2009 the VideoLAN team
5 6 7
 * $Id$
 *
 * Authors: Gildas Bazin <gbazin@videolan.org>
Jean-Paul Saman's avatar
Jean-Paul Saman committed
8
 *          Jean-Paul Saman <jpsaman@videolan.org>
9 10 11 12 13 14 15 16 17 18 19 20 21
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
Antoine Cellerier's avatar
Antoine Cellerier committed
22
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
23 24 25 26 27
 *****************************************************************************/

/*****************************************************************************
 * Preamble
 *****************************************************************************/
28 29 30
#ifdef HAVE_CONFIG_H
# include "config.h"
#endif
31
#include <assert.h>
32

33
#define VLC_MODULE_LICENSE VLC_LICENSE_GPL_2_PLUS
34
#include <vlc_common.h>
35
#include <vlc_plugin.h>
Clément Stenac's avatar
Clément Stenac committed
36 37
#include <vlc_interface.h>
#include <vlc_input.h>
Jean-Paul Saman's avatar
Jean-Paul Saman committed
38
#include <vlc_playlist.h>
39

40
#include <sys/types.h>
41
#include <unistd.h>
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
42
#ifdef HAVE_POLL
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
43 44
#   include <poll.h>
#endif
45

Clément Stenac's avatar
Clément Stenac committed
46
#include <vlc_network.h>
47

48
#define NETSYNC_PORT 9875
49 50 51 52

/*****************************************************************************
 * Module descriptor
 *****************************************************************************/
53 54
static int  Open (vlc_object_t *);
static void Close(vlc_object_t *);
55

56
#define NETSYNC_TEXT N_("Network master clock")
57 58 59
#define NETSYNC_LONGTEXT N_("When set, " \
  "this VLC instance will act as the master clock for synchronization " \
  "for clients listening")
60

61
#define MIP_TEXT N_("Master server IP address")
62
#define MIP_LONGTEXT N_("The IP address of " \
63
  "the network master clock to use for clock synchronization.")
64

65
#define NETSYNC_TIMEOUT_TEXT N_("UDP timeout (in ms)")
66 67
#define NETSYNC_TIMEOUT_LONGTEXT N_("Length of time (in ms) " \
  "until aborting data reception.")
68

69 70
vlc_module_begin()
    set_shortname(N_("Network Sync"))
71
    set_description(N_("Network synchronization"))
72 73
    set_category(CAT_ADVANCED)
    set_subcategory(SUBCAT_ADVANCED_MISC)
74

75
    add_bool("netsync-master", false,
76
              NETSYNC_TEXT, NETSYNC_LONGTEXT, true)
77
    add_string("netsync-master-ip", NULL, MIP_TEXT, MIP_LONGTEXT,
78
                true)
79
    add_integer("netsync-timeout", 500,
80
                 NETSYNC_TIMEOUT_TEXT, NETSYNC_TIMEOUT_LONGTEXT, true)
81

82 83 84
    set_capability("interface", 0)
    set_callbacks(Open, Close)
vlc_module_end()
85 86 87 88

/*****************************************************************************
 * Local prototypes
 *****************************************************************************/
Laurent Aimar's avatar
Laurent Aimar committed
89 90 91 92 93
struct intf_sys_t {
    int            fd;
    int            timeout;
    bool           is_master;
    playlist_t     *playlist;
94 95

    /* */
Laurent Aimar's avatar
Laurent Aimar committed
96
    input_thread_t *input;
97
    vlc_thread_t   thread;
Laurent Aimar's avatar
Laurent Aimar committed
98
};
99 100 101

static int PlaylistEvent(vlc_object_t *, char const *cmd,
                         vlc_value_t oldval, vlc_value_t newval, void *data);
102 103 104 105

/*****************************************************************************
 * Activate: initialize and create stuff
 *****************************************************************************/
106
static int Open(vlc_object_t *object)
107
{
108
    intf_thread_t *intf = (intf_thread_t*)object;
Laurent Aimar's avatar
Laurent Aimar committed
109
    intf_sys_t    *sys;
110
    int fd;
111

112 113 114 115
    if (!var_InheritBool(intf, "netsync-master")) {
        char *psz_master = var_InheritString(intf, "netsync-master-ip");
        if (psz_master == NULL) {
            msg_Err(intf, "master address not specified");
116 117
            return VLC_EGENERIC;
        }
118 119
        fd = net_ConnectUDP(VLC_OBJECT(intf), psz_master, NETSYNC_PORT, -1);
        free(psz_master);
Laurent Aimar's avatar
Laurent Aimar committed
120
    } else {
121
        fd = net_ListenUDP1(VLC_OBJECT(intf), NULL, NETSYNC_PORT);
Laurent Aimar's avatar
Laurent Aimar committed
122
    }
123

124 125
    if (fd == -1) {
        msg_Err(intf, "Netsync socket failure");
126 127
        return VLC_EGENERIC;
    }
128

Laurent Aimar's avatar
Laurent Aimar committed
129 130 131 132 133 134 135 136 137 138 139
    intf->p_sys = sys = malloc(sizeof(*sys));
    if (!sys) {
        net_Close(fd);
        return VLC_ENOMEM;
    }

    sys->fd = fd;
    sys->is_master = var_InheritBool(intf, "netsync-master");
    sys->timeout = var_InheritInteger(intf, "netsync-timeout");
    if (sys->timeout < 500)
        sys->timeout = 500;
140
    sys->playlist = pl_Get(intf);
Laurent Aimar's avatar
Laurent Aimar committed
141 142
    sys->input = NULL;

143
    var_AddCallback(sys->playlist, "input-current", PlaylistEvent, intf);
144 145 146 147 148 149
    return VLC_SUCCESS;
}

/*****************************************************************************
 * Close: destroy interface
 *****************************************************************************/
150
void Close(vlc_object_t *object)
151
{
152
    intf_thread_t *intf = (intf_thread_t*)object;
Laurent Aimar's avatar
Laurent Aimar committed
153
    intf_sys_t *sys = intf->p_sys;
154

155
    var_DelCallback(sys->playlist, "input-current", PlaylistEvent, intf);
156 157 158 159 160 161

    if (sys->input != NULL) {
        vlc_cancel(sys->thread);
        vlc_join(sys->thread, NULL);
    }

Laurent Aimar's avatar
Laurent Aimar committed
162 163
    net_Close(sys->fd);
    free(sys);
164 165
}

166
static mtime_t GetPcrSystem(input_thread_t *input)
Laurent Aimar's avatar
Laurent Aimar committed
167
{
168
    int canc = vlc_savecancel();
169
    /* TODO use the delay */
170
    mtime_t system;
171
    if (input_GetPcrSystem(input, &system, NULL))
172 173
        system = -1;
    vlc_restorecancel(canc);
Laurent Aimar's avatar
Laurent Aimar committed
174

175 176
    return system;
}
Laurent Aimar's avatar
Laurent Aimar committed
177

178 179 180 181 182 183 184 185
static void *Master(void *handle)
{
    intf_thread_t *intf = handle;
    intf_sys_t *sys = intf->p_sys;
    for (;;) {
        struct pollfd ufd = { .fd = sys->fd, .events = POLLIN, };
        uint64_t data[2];

186
        if (poll(&ufd, 1, -1) < 0)
187
            continue;
Laurent Aimar's avatar
Laurent Aimar committed
188

189 190
        /* We received something */
        struct sockaddr_storage from;
191 192 193 194 195
        socklen_t fromlen = sizeof (from);

        if (recvfrom(sys->fd, data, 8, 0,
                     (struct sockaddr *)&from, &fromlen) < 8)
            continue;
Laurent Aimar's avatar
Laurent Aimar committed
196

197 198 199
        mtime_t master_system = GetPcrSystem(sys->input);
        if (master_system < 0)
            continue;
Laurent Aimar's avatar
Laurent Aimar committed
200

201 202
        data[0] = hton64(mdate());
        data[1] = hton64(master_system);
Laurent Aimar's avatar
Laurent Aimar committed
203

204
        /* Reply to the sender */
205 206
        sendto(sys->fd, data, 16, 0,
               (struct sockaddr *)&from, fromlen);
Laurent Aimar's avatar
Laurent Aimar committed
207
#if 0
208 209 210 211 212 213 214
        /* not sure we need the client information to sync,
           since we are the master anyway */
        mtime_t client_system = ntoh64(data[0]);
        msg_Dbg(intf, "Master clockref: %"PRId64" -> %"PRId64", from %s "
                 "(date: %"PRId64")", client_system, master_system,
                 (from.ss_family == AF_INET) ? inet_ntoa(((struct sockaddr_in *)&from)->sin_addr)
                 : "non-IPv4", /*date*/ 0);
Laurent Aimar's avatar
Laurent Aimar committed
215
#endif
216
    }
217
    return NULL;
Laurent Aimar's avatar
Laurent Aimar committed
218 219
}

220
static void *Slave(void *handle)
Laurent Aimar's avatar
Laurent Aimar committed
221
{
222
    intf_thread_t *intf = handle;
Laurent Aimar's avatar
Laurent Aimar committed
223 224
    intf_sys_t *sys = intf->p_sys;

225 226 227 228 229 230
    for (;;) {
        struct pollfd ufd = { .fd = sys->fd, .events = POLLIN, };
        uint64_t data[2];

        mtime_t system = GetPcrSystem(sys->input);
        if (system < 0)
Laurent Aimar's avatar
Laurent Aimar committed
231 232
            goto wait;

233 234
        /* Send clock request to the master */
        const mtime_t send_date = mdate();
235 236 237

        data[0] = hton64(system);
        send(sys->fd, data, 8, 0);
Laurent Aimar's avatar
Laurent Aimar committed
238

239
        /* Don't block */
240
        if (poll(&ufd, 1, sys->timeout) <= 0)
241
            continue;
Jean-Paul Saman's avatar
Jean-Paul Saman committed
242

243
        const mtime_t receive_date = mdate();
244
        if (recv(sys->fd, data, 16, 0) < 16)
245
            goto wait;
246

247 248 249 250
        const mtime_t master_date   = ntoh64(data[0]);
        const mtime_t master_system = ntoh64(data[1]);
        const mtime_t diff_date = receive_date -
                                  ((receive_date - send_date) / 2 + master_date);
251

252 253
        if (master_system > 0) {
            int canc = vlc_savecancel();
254

255
            mtime_t client_system;
256
            if (!input_GetPcrSystem(sys->input, &client_system, NULL)) {
257 258 259 260 261 262 263 264 265 266 267 268
                const mtime_t diff_system = client_system - master_system - diff_date;
                if (diff_system != 0) {
                    input_ModifyPcrSystem(sys->input, true, master_system - diff_date);
#if 0
                    msg_Dbg(intf, "Slave clockref: %"PRId64" -> %"PRId64" -> %"PRId64","
                             " clock diff: %"PRId64", diff: %"PRId64"",
                             system, master_system, client_system,
                             diff_system, diff_date);
#endif
                }
            }
            vlc_restorecancel(canc);
269
        }
270 271
    wait:
        msleep(INTF_IDLE_SLEEP);
272
    }
273
    return NULL;
274
}
275

276 277
static int PlaylistEvent(vlc_object_t *object, char const *cmd,
                         vlc_value_t oldval, vlc_value_t newval, void *data)
278
{
279
    VLC_UNUSED(cmd); VLC_UNUSED(object);
280 281
    intf_thread_t  *intf = data;
    intf_sys_t     *sys = intf->p_sys;
282
    input_thread_t *input = newval.p_address;
283

284
    if (sys->input != NULL) {
285
        msg_Err(intf, "InputEvent DEAD");
286 287
        assert(oldval.p_address == sys->input);

288 289 290 291
        vlc_cancel(sys->thread);
        vlc_join(sys->thread, NULL);
    }

292
    sys->input = input;
293

294
    if (input != NULL) {
295
        if (vlc_clone(&sys->thread, sys->is_master ? Master : Slave, intf,
296
                      VLC_THREAD_PRIORITY_INPUT))
297
            sys->input = NULL;
298 299
    }
    return VLC_SUCCESS;
300 301
}