libs/gst/net/gstptpclock.c

   1 /* GStreamer
   2  * Copyright (C) 2015 Sebastian Dröge <sebastian@centricular.com>
   3  *
   4  *
   5  * This library is free software; you can redistribute it and/or
   6  * modify it under the terms of the GNU Library General Public
   7  * License as published by the Free Software Foundation; either
   8  * version 2 of the License, or (at your option) any later version.
   9  *
  10  * This library is distributed in the hope that it will be useful,
  11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  13  * Library General Public License for more details.
  14  *
  15  * You should have received a copy of the GNU Library General Public
  16  * License along with this library; if not, write to the
  17  * Free Software Foundation, Inc., 51 Franklin St, Fifth Floor,
  18  * Boston, MA 02110-1301, USA.
  19  */
  20 /**
  21  * SECTION:gstptpclock
  22  * @title: GstPtpClock
  23  * @short_description: Special clock that synchronizes to a remote time
  24  *                     provider via PTP (IEEE1588:2008).
  25  * @see_also: #GstClock, #GstNetClientClock, #GstPipeline
  26  *
  27  * GstPtpClock implements a PTP (IEEE1588:2008) ordinary clock in slave-only
  28  * mode, that allows a GStreamer pipeline to synchronize to a PTP network
  29  * clock in some specific domain.
  30  *
  31  * The PTP subsystem can be initialized with gst_ptp_init(), which then starts
  32  * a helper process to do the actual communication via the PTP ports. This is
  33  * required as PTP listens on ports < 1024 and thus requires special
  34  * privileges. Once this helper process is started, the main process will
  35  * synchronize to all PTP domains that are detected on the selected
  36  * interfaces.
  37  *
  38  * gst_ptp_clock_new() then allows to create a GstClock that provides the PTP
  39  * time from a master clock inside a specific PTP domain. This clock will only
  40  * return valid timestamps once the timestamps in the PTP domain are known. To
  41  * check this, you can use gst_clock_wait_for_sync(), the GstClock::synced
  42  * signal and gst_clock_is_synced().
  43  *
  44  * To gather statistics about the PTP clock synchronization,
  45  * gst_ptp_statistics_callback_add() can be used. This gives the application
  46  * the possibility to collect all kinds of statistics from the clock
  47  * synchronization.
  48  *
  49  * Since: 1.6
  50  *
  51  */
  52 #ifdef HAVE_CONFIG_H
  53 #include "config.h"
  54 #endif
  55
  56 #include "gstptpclock.h"
  57
  58 #include "gstptp_private.h"
  59
  60 #ifdef HAVE_SYS_WAIT_H
  61 #include <sys/wait.h>
  62 #endif
  63 #ifdef G_OS_WIN32
  64 #define WIN32_LEAN_AND_MEAN
  65 #include <windows.h>
  66 #endif
  67 #include <sys/types.h>
  68
  69 #ifdef HAVE_UNISTD_H
  70 #include <unistd.h>
  71 #elif defined(G_OS_WIN32)
  72 #include <io.h>
  73 #endif
  74
  75 #include <gst/base/base.h>
  76
  77 GST_DEBUG_CATEGORY_STATIC (ptp_debug);
  78 #define GST_CAT_DEFAULT (ptp_debug)
  79
  80 /* IEEE 1588 7.7.3.1 */
  81 #define PTP_ANNOUNCE_RECEIPT_TIMEOUT 4
  82
  83 /* Use a running average for calculating the mean path delay instead
  84  * of just using the last measurement. Enabling this helps in unreliable
  85  * networks, like wifi, with often changing delays
  86  *
  87  * Undef for following IEEE1588-2008 by the letter
  88  */
  89 #define USE_RUNNING_AVERAGE_DELAY 1
  90
  91 /* Filter out any measurements that are above a certain threshold compared to
  92  * previous measurements. Enabling this helps filtering out outliers that
  93  * happen fairly often in unreliable networks, like wifi.
  94  *
  95  * Undef for following IEEE1588-2008 by the letter
  96  */
  97 #define USE_MEASUREMENT_FILTERING 1
  98
  99 /* Select the first clock from which we capture a SYNC message as the master
 100  * clock of the domain until we are ready to run the best master clock
 101  * algorithm. This allows faster syncing but might mean a change of the master
 102  * clock in the beginning. As all clocks in a domain are supposed to use the
 103  * same time, this shouldn't be much of a problem.
 104  *
 105  * Undef for following IEEE1588-2008 by the letter
 106  */
 107 #define USE_OPPORTUNISTIC_CLOCK_SELECTION 1
 108
 109 /* Only consider SYNC messages for which we are allowed to send a DELAY_REQ
 110  * afterwards. This allows better synchronization in networks with varying
 111  * delays, as for every other SYNC message we would have to assume that it's
 112  * the average of what we saw before. But that might be completely off
 113  */
 114 #define USE_ONLY_SYNC_WITH_DELAY 1
 115
 116 /* Filter out delay measurements that are too far away from the median of the
 117  * last delay measurements, currently those that are more than 2 times as big.
 118  * This increases accuracy a lot on wifi.
 119  */
 120 #define USE_MEDIAN_PRE_FILTERING 1
 121 #define MEDIAN_PRE_FILTERING_WINDOW 9
 122
 123 /* How many updates should be skipped at maximum when using USE_MEASUREMENT_FILTERING */
 124 #define MAX_SKIPPED_UPDATES 5
 125
 126 typedef enum
 127 {
 128   PTP_MESSAGE_TYPE_SYNC = 0x0,
 129   PTP_MESSAGE_TYPE_DELAY_REQ = 0x1,
 130   PTP_MESSAGE_TYPE_PDELAY_REQ = 0x2,
 131   PTP_MESSAGE_TYPE_PDELAY_RESP = 0x3,
 132   PTP_MESSAGE_TYPE_FOLLOW_UP = 0x8,
 133   PTP_MESSAGE_TYPE_DELAY_RESP = 0x9,
 134   PTP_MESSAGE_TYPE_PDELAY_RESP_FOLLOW_UP = 0xA,
 135   PTP_MESSAGE_TYPE_ANNOUNCE = 0xB,
 136   PTP_MESSAGE_TYPE_SIGNALING = 0xC,
 137   PTP_MESSAGE_TYPE_MANAGEMENT = 0xD
 138 } PtpMessageType;
 139
 140 typedef struct
 141 {
 142   guint64 seconds_field;        /* 48 bits valid */
 143   guint32 nanoseconds_field;
 144 } PtpTimestamp;
 145
 146 #define PTP_TIMESTAMP_TO_GST_CLOCK_TIME(ptp) (ptp.seconds_field * GST_SECOND + ptp.nanoseconds_field)
 147 #define GST_CLOCK_TIME_TO_PTP_TIMESTAMP_SECONDS(gst) (((GstClockTime) gst) / GST_SECOND)
 148 #define GST_CLOCK_TIME_TO_PTP_TIMESTAMP_NANOSECONDS(gst) (((GstClockTime) gst) % GST_SECOND)
 149
 150 typedef struct
 151 {
 152   guint64 clock_identity;
 153   guint16 port_number;
 154 } PtpClockIdentity;
 155
 156 static gint
 157 compare_clock_identity (const PtpClockIdentity * a, const PtpClockIdentity * b)
 158 {
 159   if (a->clock_identity < b->clock_identity)
 160     return -1;
 161   else if (a->clock_identity > b->clock_identity)
 162     return 1;
 163
 164   if (a->port_number < b->port_number)
 165     return -1;
 166   else if (a->port_number > b->port_number)
 167     return 1;
 168
 169   return 0;
 170 }
 171
 172 typedef struct
 173 {
 174   guint8 clock_class;
 175   guint8 clock_accuracy;
 176   guint16 offset_scaled_log_variance;
 177 } PtpClockQuality;
 178
 179 typedef struct
 180 {
 181   guint8 transport_specific;
 182   PtpMessageType message_type;
 183   /* guint8 reserved; */
 184   guint8 version_ptp;
 185   guint16 message_length;
 186   guint8 domain_number;
 187   /* guint8 reserved; */
 188   guint16 flag_field;
 189   gint64 correction_field;      /* 48.16 fixed point nanoseconds */
 190   /* guint32 reserved; */
 191   PtpClockIdentity source_port_identity;
 192   guint16 sequence_id;
 193   guint8 control_field;
 194   gint8 log_message_interval;
 195
 196   union
 197   {
 198     struct
 199     {
 200       PtpTimestamp origin_timestamp;
 201       gint16 current_utc_offset;
 202       /* guint8 reserved; */
 203       guint8 grandmaster_priority_1;
 204       PtpClockQuality grandmaster_clock_quality;
 205       guint8 grandmaster_priority_2;
 206       guint64 grandmaster_identity;
 207       guint16 steps_removed;
 208       guint8 time_source;
 209     } announce;
 210
 211     struct
 212     {
 213       PtpTimestamp origin_timestamp;
 214     } sync;
 215
 216     struct
 217     {
 218       PtpTimestamp precise_origin_timestamp;
 219     } follow_up;
 220
 221     struct
 222     {
 223       PtpTimestamp origin_timestamp;
 224     } delay_req;
 225
 226     struct
 227     {
 228       PtpTimestamp receive_timestamp;
 229       PtpClockIdentity requesting_port_identity;
 230     } delay_resp;
 231
 232   } message_specific;
 233 } PtpMessage;
 234
 235 static GMutex ptp_lock;
 236 static GCond ptp_cond;
 237 static gboolean initted = FALSE;
 238 #ifdef HAVE_PTP
 239 static gboolean supported = TRUE;
 240 #else
 241 static gboolean supported = FALSE;
 242 #endif
 243 static GPid ptp_helper_pid;
 244 static GThread *ptp_helper_thread;
 245 static GMainContext *main_context;
 246 static GMainLoop *main_loop;
 247 static GIOChannel *stdin_channel, *stdout_channel;
 248 static GRand *delay_req_rand;
 249 static GstClock *observation_system_clock;
 250 static PtpClockIdentity ptp_clock_id = { GST_PTP_CLOCK_ID_NONE, 0 };
 251
 252 typedef struct
 253 {
 254   GstClockTime receive_time;
 255
 256   PtpClockIdentity master_clock_identity;
 257
 258   guint8 grandmaster_priority_1;
 259   PtpClockQuality grandmaster_clock_quality;
 260   guint8 grandmaster_priority_2;
 261   guint64 grandmaster_identity;
 262   guint16 steps_removed;
 263   guint8 time_source;
 264
 265   guint16 sequence_id;
 266 } PtpAnnounceMessage;
 267
 268 typedef struct
 269 {
 270   PtpClockIdentity master_clock_identity;
 271
 272   GstClockTime announce_interval;       /* last interval we received */
 273   GQueue announce_messages;
 274 } PtpAnnounceSender;
 275
 276 typedef struct
 277 {
 278   guint domain;
 279   PtpClockIdentity master_clock_identity;
 280
 281   guint16 sync_seqnum;
 282   GstClockTime sync_recv_time_local;    /* t2 */
 283   GstClockTime sync_send_time_remote;   /* t1, might be -1 if FOLLOW_UP pending */
 284   GstClockTime follow_up_recv_time_local;
 285
 286   GSource *timeout_source;
 287   guint16 delay_req_seqnum;
 288   GstClockTime delay_req_send_time_local;       /* t3, -1 if we wait for FOLLOW_UP */
 289   GstClockTime delay_req_recv_time_remote;      /* t4, -1 if we wait */
 290   GstClockTime delay_resp_recv_time_local;
 291
 292   gint64 correction_field_sync; /* sum of the correction fields of SYNC/FOLLOW_UP */
 293   gint64 correction_field_delay;        /* sum of the correction fields of DELAY_RESP */
 294 } PtpPendingSync;
 295
 296 static void
 297 ptp_pending_sync_free (PtpPendingSync * sync)
 298 {
 299   if (sync->timeout_source) {
 300     g_source_destroy (sync->timeout_source);
 301     g_source_unref(sync->timeout_source);
 302   }
 303   g_free (sync);
 304 }
 305
 306 typedef struct
 307 {
 308   guint domain;
 309
 310   GstClockTime last_ptp_time;
 311   GstClockTime last_local_time;
 312   gint skipped_updates;
 313
 314   /* Used for selecting the master/grandmaster */
 315   GList *announce_senders;
 316
 317   /* Last selected master clock */
 318   gboolean have_master_clock;
 319   PtpClockIdentity master_clock_identity;
 320   guint64 grandmaster_identity;
 321
 322   /* Last SYNC or FOLLOW_UP timestamp we received */
 323   GstClockTime last_ptp_sync_time;
 324   GstClockTime sync_interval;
 325
 326   GstClockTime mean_path_delay;
 327   GstClockTime last_delay_req, min_delay_req_interval;
 328   guint16 last_delay_req_seqnum;
 329
 330   GstClockTime last_path_delays[MEDIAN_PRE_FILTERING_WINDOW];
 331   gint last_path_delays_missing;
 332
 333   GQueue pending_syncs;
 334
 335   GstClock *domain_clock;
 336 } PtpDomainData;
 337
 338 static GList *domain_data;
 339 static GMutex domain_clocks_lock;
 340 static GList *domain_clocks;
 341
 342 /* Protected by PTP lock */
 343 static void emit_ptp_statistics (guint8 domain, const GstStructure * stats);
 344 static GHookList domain_stats_hooks;
 345 static gint domain_stats_n_hooks;
 346 static gboolean domain_stats_hooks_initted = FALSE;
 347
 348 /* Converts log2 seconds to GstClockTime */
 349 static GstClockTime
 350 log2_to_clock_time (gint l)
 351 {
 352   if (l < 0)
 353     return GST_SECOND >> (-l);
 354   else
 355     return GST_SECOND << l;
 356 }
 357
 358 static void
 359 dump_ptp_message (PtpMessage * msg)
 360 {
 361   GST_TRACE ("PTP message:");
 362   GST_TRACE ("\ttransport_specific: %u", msg->transport_specific);
 363   GST_TRACE ("\tmessage_type: 0x%01x", msg->message_type);
 364   GST_TRACE ("\tversion_ptp: %u", msg->version_ptp);
 365   GST_TRACE ("\tmessage_length: %u", msg->message_length);
 366   GST_TRACE ("\tdomain_number: %u", msg->domain_number);
 367   GST_TRACE ("\tflag_field: 0x%04x", msg->flag_field);
 368   GST_TRACE ("\tcorrection_field: %" G_GINT64_FORMAT ".%03u",
 369       (msg->correction_field / 65536),
 370       (guint) ((msg->correction_field & 0xffff) * 1000) / 65536);
 371   GST_TRACE ("\tsource_port_identity: 0x%016" G_GINT64_MODIFIER "x %u",
 372       msg->source_port_identity.clock_identity,
 373       msg->source_port_identity.port_number);
 374   GST_TRACE ("\tsequence_id: %u", msg->sequence_id);
 375   GST_TRACE ("\tcontrol_field: 0x%02x", msg->control_field);
 376   GST_TRACE ("\tmessage_interval: %" GST_TIME_FORMAT,
 377       GST_TIME_ARGS (log2_to_clock_time (msg->log_message_interval)));
 378
 379   switch (msg->message_type) {
 380     case PTP_MESSAGE_TYPE_ANNOUNCE:
 381       GST_TRACE ("\tANNOUNCE:");
 382       GST_TRACE ("\t\torigin_timestamp: %" G_GUINT64_FORMAT ".%09u",
 383           msg->message_specific.announce.origin_timestamp.seconds_field,
 384           msg->message_specific.announce.origin_timestamp.nanoseconds_field);
 385       GST_TRACE ("\t\tcurrent_utc_offset: %d",
 386           msg->message_specific.announce.current_utc_offset);
 387       GST_TRACE ("\t\tgrandmaster_priority_1: %u",
 388           msg->message_specific.announce.grandmaster_priority_1);
 389       GST_TRACE ("\t\tgrandmaster_clock_quality: 0x%02x 0x%02x %u",
 390           msg->message_specific.announce.grandmaster_clock_quality.clock_class,
 391           msg->message_specific.announce.
 392           grandmaster_clock_quality.clock_accuracy,
 393           msg->message_specific.announce.
 394           grandmaster_clock_quality.offset_scaled_log_variance);
 395       GST_TRACE ("\t\tgrandmaster_priority_2: %u",
 396           msg->message_specific.announce.grandmaster_priority_2);
 397       GST_TRACE ("\t\tgrandmaster_identity: 0x%016" G_GINT64_MODIFIER "x",
 398           msg->message_specific.announce.grandmaster_identity);
 399       GST_TRACE ("\t\tsteps_removed: %u",
 400           msg->message_specific.announce.steps_removed);
 401       GST_TRACE ("\t\ttime_source: 0x%02x",
 402           msg->message_specific.announce.time_source);
 403       break;
 404     case PTP_MESSAGE_TYPE_SYNC:
 405       GST_TRACE ("\tSYNC:");
 406       GST_TRACE ("\t\torigin_timestamp: %" G_GUINT64_FORMAT ".%09u",
 407           msg->message_specific.sync.origin_timestamp.seconds_field,
 408           msg->message_specific.sync.origin_timestamp.nanoseconds_field);
 409       break;
 410     case PTP_MESSAGE_TYPE_FOLLOW_UP:
 411       GST_TRACE ("\tFOLLOW_UP:");
 412       GST_TRACE ("\t\tprecise_origin_timestamp: %" G_GUINT64_FORMAT ".%09u",
 413           msg->message_specific.follow_up.
 414           precise_origin_timestamp.seconds_field,
 415           msg->message_specific.follow_up.
 416           precise_origin_timestamp.nanoseconds_field);
 417       break;
 418     case PTP_MESSAGE_TYPE_DELAY_REQ:
 419       GST_TRACE ("\tDELAY_REQ:");
 420       GST_TRACE ("\t\torigin_timestamp: %" G_GUINT64_FORMAT ".%09u",
 421           msg->message_specific.delay_req.origin_timestamp.seconds_field,
 422           msg->message_specific.delay_req.origin_timestamp.nanoseconds_field);
 423       break;
 424     case PTP_MESSAGE_TYPE_DELAY_RESP:
 425       GST_TRACE ("\tDELAY_RESP:");
 426       GST_TRACE ("\t\treceive_timestamp: %" G_GUINT64_FORMAT ".%09u",
 427           msg->message_specific.delay_resp.receive_timestamp.seconds_field,
 428           msg->message_specific.delay_resp.receive_timestamp.nanoseconds_field);
 429       GST_TRACE ("\t\trequesting_port_identity: 0x%016" G_GINT64_MODIFIER
 430           "x %u",
 431           msg->message_specific.delay_resp.
 432           requesting_port_identity.clock_identity,
 433           msg->message_specific.delay_resp.
 434           requesting_port_identity.port_number);
 435       break;
 436     default:
 437       break;
 438   }
 439   GST_TRACE (" ");
 440 }
 441
 442 /* IEEE 1588-2008 5.3.3 */
 443 static gboolean
 444 parse_ptp_timestamp (PtpTimestamp * timestamp, GstByteReader * reader)
 445 {
 446   g_return_val_if_fail (gst_byte_reader_get_remaining (reader) >= 10, FALSE);
 447
 448   timestamp->seconds_field =
 449       (((guint64) gst_byte_reader_get_uint32_be_unchecked (reader)) << 16) |
 450       gst_byte_reader_get_uint16_be_unchecked (reader);
 451   timestamp->nanoseconds_field =
 452       gst_byte_reader_get_uint32_be_unchecked (reader);
 453
 454   if (timestamp->nanoseconds_field >= 1000000000)
 455     return FALSE;
 456
 457   return TRUE;
 458 }
 459
 460 /* IEEE 1588-2008 13.3 */
 461 static gboolean
 462 parse_ptp_message_header (PtpMessage * msg, GstByteReader * reader)
 463 {
 464   guint8 b;
 465
 466   g_return_val_if_fail (gst_byte_reader_get_remaining (reader) >= 34, FALSE);
 467
 468   b = gst_byte_reader_get_uint8_unchecked (reader);
 469   msg->transport_specific = b >> 4;
 470   msg->message_type = b & 0x0f;
 471
 472   b = gst_byte_reader_get_uint8_unchecked (reader);
 473   msg->version_ptp = b & 0x0f;
 474   if (msg->version_ptp != 2) {
 475     GST_WARNING ("Unsupported PTP message version (%u != 2)", msg->version_ptp);
 476     return FALSE;
 477   }
 478
 479   msg->message_length = gst_byte_reader_get_uint16_be_unchecked (reader);
 480   if (gst_byte_reader_get_remaining (reader) + 4 < msg->message_length) {
 481     GST_WARNING ("Not enough data (%u < %u)",
 482         gst_byte_reader_get_remaining (reader) + 4, msg->message_length);
 483     return FALSE;
 484   }
 485
 486   msg->domain_number = gst_byte_reader_get_uint8_unchecked (reader);
 487   gst_byte_reader_skip_unchecked (reader, 1);
 488
 489   msg->flag_field = gst_byte_reader_get_uint16_be_unchecked (reader);
 490   msg->correction_field = gst_byte_reader_get_uint64_be_unchecked (reader);
 491   gst_byte_reader_skip_unchecked (reader, 4);
 492
 493   msg->source_port_identity.clock_identity =
 494       gst_byte_reader_get_uint64_be_unchecked (reader);
 495   msg->source_port_identity.port_number =
 496       gst_byte_reader_get_uint16_be_unchecked (reader);
 497
 498   msg->sequence_id = gst_byte_reader_get_uint16_be_unchecked (reader);
 499   msg->control_field = gst_byte_reader_get_uint8_unchecked (reader);
 500   msg->log_message_interval = gst_byte_reader_get_uint8_unchecked (reader);
 501
 502   return TRUE;
 503 }
 504
 505 /* IEEE 1588-2008 13.5 */
 506 static gboolean
 507 parse_ptp_message_announce (PtpMessage * msg, GstByteReader * reader)
 508 {
 509   g_return_val_if_fail (msg->message_type == PTP_MESSAGE_TYPE_ANNOUNCE, FALSE);
 510
 511   if (gst_byte_reader_get_remaining (reader) < 20)
 512     return FALSE;
 513
 514   if (!parse_ptp_timestamp (&msg->message_specific.announce.origin_timestamp,
 515           reader))
 516     return FALSE;
 517
 518   msg->message_specific.announce.current_utc_offset =
 519       gst_byte_reader_get_uint16_be_unchecked (reader);
 520   gst_byte_reader_skip_unchecked (reader, 1);
 521
 522   msg->message_specific.announce.grandmaster_priority_1 =
 523       gst_byte_reader_get_uint8_unchecked (reader);
 524   msg->message_specific.announce.grandmaster_clock_quality.clock_class =
 525       gst_byte_reader_get_uint8_unchecked (reader);
 526   msg->message_specific.announce.grandmaster_clock_quality.clock_accuracy =
 527       gst_byte_reader_get_uint8_unchecked (reader);
 528   msg->message_specific.announce.
 529       grandmaster_clock_quality.offset_scaled_log_variance =
 530       gst_byte_reader_get_uint16_be_unchecked (reader);
 531   msg->message_specific.announce.grandmaster_priority_2 =
 532       gst_byte_reader_get_uint8_unchecked (reader);
 533   msg->message_specific.announce.grandmaster_identity =
 534       gst_byte_reader_get_uint64_be_unchecked (reader);
 535   msg->message_specific.announce.steps_removed =
 536       gst_byte_reader_get_uint16_be_unchecked (reader);
 537   msg->message_specific.announce.time_source =
 538       gst_byte_reader_get_uint8_unchecked (reader);
 539
 540   return TRUE;
 541 }
 542
 543 /* IEEE 1588-2008 13.6 */
 544 static gboolean
 545 parse_ptp_message_sync (PtpMessage * msg, GstByteReader * reader)
 546 {
 547   g_return_val_if_fail (msg->message_type == PTP_MESSAGE_TYPE_SYNC, FALSE);
 548
 549   if (gst_byte_reader_get_remaining (reader) < 10)
 550     return FALSE;
 551
 552   if (!parse_ptp_timestamp (&msg->message_specific.sync.origin_timestamp,
 553           reader))
 554     return FALSE;
 555
 556   return TRUE;
 557 }
 558
 559 /* IEEE 1588-2008 13.6 */
 560 static gboolean
 561 parse_ptp_message_delay_req (PtpMessage * msg, GstByteReader * reader)
 562 {
 563   g_return_val_if_fail (msg->message_type == PTP_MESSAGE_TYPE_DELAY_REQ, FALSE);
 564
 565   if (gst_byte_reader_get_remaining (reader) < 10)
 566     return FALSE;
 567
 568   if (!parse_ptp_timestamp (&msg->message_specific.delay_req.origin_timestamp,
 569           reader))
 570     return FALSE;
 571
 572   return TRUE;
 573 }
 574
 575 /* IEEE 1588-2008 13.7 */
 576 static gboolean
 577 parse_ptp_message_follow_up (PtpMessage * msg, GstByteReader * reader)
 578 {
 579   g_return_val_if_fail (msg->message_type == PTP_MESSAGE_TYPE_FOLLOW_UP, FALSE);
 580
 581   if (gst_byte_reader_get_remaining (reader) < 10)
 582     return FALSE;
 583
 584   if (!parse_ptp_timestamp (&msg->message_specific.
 585           follow_up.precise_origin_timestamp, reader))
 586     return FALSE;
 587
 588   return TRUE;
 589 }
 590
 591 /* IEEE 1588-2008 13.8 */
 592 static gboolean
 593 parse_ptp_message_delay_resp (PtpMessage * msg, GstByteReader * reader)
 594 {
 595   g_return_val_if_fail (msg->message_type == PTP_MESSAGE_TYPE_DELAY_RESP,
 596       FALSE);
 597
 598   if (gst_byte_reader_get_remaining (reader) < 20)
 599     return FALSE;
 600
 601   if (!parse_ptp_timestamp (&msg->message_specific.delay_resp.receive_timestamp,
 602           reader))
 603     return FALSE;
 604
 605   msg->message_specific.delay_resp.requesting_port_identity.clock_identity =
 606       gst_byte_reader_get_uint64_be_unchecked (reader);
 607   msg->message_specific.delay_resp.requesting_port_identity.port_number =
 608       gst_byte_reader_get_uint16_be_unchecked (reader);
 609
 610   return TRUE;
 611 }
 612
 613 static gboolean
 614 parse_ptp_message (PtpMessage * msg, const guint8 * data, gsize size)
 615 {
 616   GstByteReader reader;
 617   gboolean ret = FALSE;
 618
 619   gst_byte_reader_init (&reader, data, size);
 620
 621   if (!parse_ptp_message_header (msg, &reader)) {
 622     GST_WARNING ("Failed to parse PTP message header");
 623     return FALSE;
 624   }
 625
 626   switch (msg->message_type) {
 627     case PTP_MESSAGE_TYPE_SYNC:
 628       ret = parse_ptp_message_sync (msg, &reader);
 629       break;
 630     case PTP_MESSAGE_TYPE_FOLLOW_UP:
 631       ret = parse_ptp_message_follow_up (msg, &reader);
 632       break;
 633     case PTP_MESSAGE_TYPE_DELAY_REQ:
 634       ret = parse_ptp_message_delay_req (msg, &reader);
 635       break;
 636     case PTP_MESSAGE_TYPE_DELAY_RESP:
 637       ret = parse_ptp_message_delay_resp (msg, &reader);
 638       break;
 639     case PTP_MESSAGE_TYPE_ANNOUNCE:
 640       ret = parse_ptp_message_announce (msg, &reader);
 641       break;
 642     default:
 643       /* ignore for now */
 644       break;
 645   }
 646
 647   return ret;
 648 }
 649
 650 static gint
 651 compare_announce_message (const PtpAnnounceMessage * a,
 652     const PtpAnnounceMessage * b)
 653 {
 654   /* IEEE 1588 Figure 27 */
 655   if (a->grandmaster_identity == b->grandmaster_identity) {
 656     if (a->steps_removed + 1 < b->steps_removed)
 657       return -1;
 658     else if (a->steps_removed > b->steps_removed + 1)
 659       return 1;
 660
 661     /* Error cases are filtered out earlier */
 662     if (a->steps_removed < b->steps_removed)
 663       return -1;
 664     else if (a->steps_removed > b->steps_removed)
 665       return 1;
 666
 667     /* Error cases are filtered out earlier */
 668     if (a->master_clock_identity.clock_identity <
 669         b->master_clock_identity.clock_identity)
 670       return -1;
 671     else if (a->master_clock_identity.clock_identity >
 672         b->master_clock_identity.clock_identity)
 673       return 1;
 674
 675     /* Error cases are filtered out earlier */
 676     if (a->master_clock_identity.port_number <
 677         b->master_clock_identity.port_number)
 678       return -1;
 679     else if (a->master_clock_identity.port_number >
 680         b->master_clock_identity.port_number)
 681       return 1;
 682     else
 683       g_assert_not_reached ();
 684
 685     return 0;
 686   }
 687
 688   if (a->grandmaster_priority_1 < b->grandmaster_priority_1)
 689     return -1;
 690   else if (a->grandmaster_priority_1 > b->grandmaster_priority_1)
 691     return 1;
 692
 693   if (a->grandmaster_clock_quality.clock_class <
 694       b->grandmaster_clock_quality.clock_class)
 695     return -1;
 696   else if (a->grandmaster_clock_quality.clock_class >
 697       b->grandmaster_clock_quality.clock_class)
 698     return 1;
 699
 700   if (a->grandmaster_clock_quality.clock_accuracy <
 701       b->grandmaster_clock_quality.clock_accuracy)
 702     return -1;
 703   else if (a->grandmaster_clock_quality.clock_accuracy >
 704       b->grandmaster_clock_quality.clock_accuracy)
 705     return 1;
 706
 707   if (a->grandmaster_clock_quality.offset_scaled_log_variance <
 708       b->grandmaster_clock_quality.offset_scaled_log_variance)
 709     return -1;
 710   else if (a->grandmaster_clock_quality.offset_scaled_log_variance >
 711       b->grandmaster_clock_quality.offset_scaled_log_variance)
 712     return 1;
 713
 714   if (a->grandmaster_priority_2 < b->grandmaster_priority_2)
 715     return -1;
 716   else if (a->grandmaster_priority_2 > b->grandmaster_priority_2)
 717     return 1;
 718
 719   if (a->grandmaster_identity < b->grandmaster_identity)
 720     return -1;
 721   else if (a->grandmaster_identity > b->grandmaster_identity)
 722     return 1;
 723   else
 724     g_assert_not_reached ();
 725
 726   return 0;
 727 }
 728
 729 static void
 730 select_best_master_clock (PtpDomainData * domain, GstClockTime now)
 731 {
 732   GList *qualified_messages = NULL;
 733   GList *l, *m;
 734   PtpAnnounceMessage *best = NULL;
 735
 736   /* IEEE 1588 9.3.2.5 */
 737   for (l = domain->announce_senders; l; l = l->next) {
 738     PtpAnnounceSender *sender = l->data;
 739     GstClockTime window = 4 * sender->announce_interval;
 740     gint count = 0;
 741
 742     for (m = sender->announce_messages.head; m; m = m->next) {
 743       PtpAnnounceMessage *msg = m->data;
 744
 745       if (now - msg->receive_time <= window)
 746         count++;
 747     }
 748
 749     /* Only include the newest message of announce senders that had at least 2
 750      * announce messages in the last 4 announce intervals. Which also means
 751      * that we wait at least 4 announce intervals before we select a master
 752      * clock. Until then we just report based on the newest SYNC we received
 753      */
 754     if (count >= 2) {
 755       qualified_messages =
 756           g_list_prepend (qualified_messages,
 757           g_queue_peek_tail (&sender->announce_messages));
 758     }
 759   }
 760
 761   if (!qualified_messages) {
 762     GST_DEBUG
 763         ("No qualified announce messages for domain %u, can't select a master clock",
 764         domain->domain);
 765     domain->have_master_clock = FALSE;
 766     return;
 767   }
 768
 769   for (l = qualified_messages; l; l = l->next) {
 770     PtpAnnounceMessage *msg = l->data;
 771
 772     if (!best || compare_announce_message (msg, best) < 0)
 773       best = msg;
 774   }
 775
 776   if (domain->have_master_clock
 777       && compare_clock_identity (&domain->master_clock_identity,
 778           &best->master_clock_identity) == 0) {
 779     GST_DEBUG ("Master clock in domain %u did not change", domain->domain);
 780   } else {
 781     GST_DEBUG ("Selected master clock for domain %u: 0x%016" G_GINT64_MODIFIER
 782         "x %u with grandmaster clock 0x%016" G_GINT64_MODIFIER "x",
 783         domain->domain, best->master_clock_identity.clock_identity,
 784         best->master_clock_identity.port_number, best->grandmaster_identity);
 785
 786     domain->have_master_clock = TRUE;
 787     domain->grandmaster_identity = best->grandmaster_identity;
 788
 789     /* Opportunistic master clock selection likely gave us the same master
 790      * clock before, no need to reset all statistics */
 791     if (compare_clock_identity (&domain->master_clock_identity,
 792             &best->master_clock_identity) != 0) {
 793       memcpy (&domain->master_clock_identity, &best->master_clock_identity,
 794           sizeof (PtpClockIdentity));
 795       domain->mean_path_delay = 0;
 796       domain->last_delay_req = 0;
 797       domain->last_path_delays_missing = 9;
 798       domain->min_delay_req_interval = 0;
 799       domain->sync_interval = 0;
 800       domain->last_ptp_sync_time = 0;
 801       domain->skipped_updates = 0;
 802       g_queue_foreach (&domain->pending_syncs, (GFunc) ptp_pending_sync_free,
 803           NULL);
 804       g_queue_clear (&domain->pending_syncs);
 805     }
 806
 807     if (g_atomic_int_get (&domain_stats_n_hooks)) {
 808       GstStructure *stats =
 809           gst_structure_new (GST_PTP_STATISTICS_BEST_MASTER_CLOCK_SELECTED,
 810           "domain", G_TYPE_UINT, domain->domain,
 811           "master-clock-id", G_TYPE_UINT64,
 812           domain->master_clock_identity.clock_identity,
 813           "master-clock-port", G_TYPE_UINT,
 814           domain->master_clock_identity.port_number,
 815           "grandmaster-clock-id", G_TYPE_UINT64, domain->grandmaster_identity,
 816           NULL);
 817       emit_ptp_statistics (domain->domain, stats);
 818       gst_structure_free (stats);
 819     }
 820   }
 821 }
 822
 823 static void
 824 handle_announce_message (PtpMessage * msg, GstClockTime receive_time)
 825 {
 826   GList *l;
 827   PtpDomainData *domain = NULL;
 828   PtpAnnounceSender *sender = NULL;
 829   PtpAnnounceMessage *announce;
 830
 831   /* IEEE1588 9.3.2.2 e)
 832    * Don't consider messages with the alternate master flag set
 833    */
 834   if ((msg->flag_field & 0x0100))
 835     return;
 836
 837   /* IEEE 1588 9.3.2.5 d)
 838    * Don't consider announce messages with steps_removed>=255
 839    */
 840   if (msg->message_specific.announce.steps_removed >= 255)
 841     return;
 842
 843   for (l = domain_data; l; l = l->next) {
 844     PtpDomainData *tmp = l->data;
 845
 846     if (tmp->domain == msg->domain_number) {
 847       domain = tmp;
 848       break;
 849     }
 850   }
 851
 852   if (!domain) {
 853     gchar *clock_name;
 854
 855     domain = g_new0 (PtpDomainData, 1);
 856     domain->domain = msg->domain_number;
 857     clock_name = g_strdup_printf ("ptp-clock-%u", domain->domain);
 858     domain->domain_clock =
 859         g_object_new (GST_TYPE_SYSTEM_CLOCK, "name", clock_name, NULL);
 860     g_free (clock_name);
 861     g_queue_init (&domain->pending_syncs);
 862     domain->last_path_delays_missing = 9;
 863     domain_data = g_list_prepend (domain_data, domain);
 864
 865     g_mutex_lock (&domain_clocks_lock);
 866     domain_clocks = g_list_prepend (domain_clocks, domain);
 867     g_mutex_unlock (&domain_clocks_lock);
 868
 869     if (g_atomic_int_get (&domain_stats_n_hooks)) {
 870       GstStructure *stats =
 871           gst_structure_new (GST_PTP_STATISTICS_NEW_DOMAIN_FOUND, "domain",
 872           G_TYPE_UINT, domain->domain, "clock", GST_TYPE_CLOCK,
 873           domain->domain_clock, NULL);
 874       emit_ptp_statistics (domain->domain, stats);
 875       gst_structure_free (stats);
 876     }
 877   }
 878
 879   for (l = domain->announce_senders; l; l = l->next) {
 880     PtpAnnounceSender *tmp = l->data;
 881
 882     if (compare_clock_identity (&tmp->master_clock_identity,
 883             &msg->source_port_identity) == 0) {
 884       sender = tmp;
 885       break;
 886     }
 887   }
 888
 889   if (!sender) {
 890     sender = g_new0 (PtpAnnounceSender, 1);
 891
 892     memcpy (&sender->master_clock_identity, &msg->source_port_identity,
 893         sizeof (PtpClockIdentity));
 894     g_queue_init (&sender->announce_messages);
 895     domain->announce_senders =
 896         g_list_prepend (domain->announce_senders, sender);
 897   }
 898
 899   for (l = sender->announce_messages.head; l; l = l->next) {
 900     PtpAnnounceMessage *tmp = l->data;
 901
 902     /* IEEE 1588 9.3.2.5 c)
 903      * Don't consider identical messages, i.e. duplicates
 904      */
 905     if (tmp->sequence_id == msg->sequence_id)
 906       return;
 907   }
 908
 909   sender->announce_interval = log2_to_clock_time (msg->log_message_interval);
 910
 911   announce = g_new0 (PtpAnnounceMessage, 1);
 912   announce->receive_time = receive_time;
 913   announce->sequence_id = msg->sequence_id;
 914   memcpy (&announce->master_clock_identity, &msg->source_port_identity,
 915       sizeof (PtpClockIdentity));
 916   announce->grandmaster_identity =
 917       msg->message_specific.announce.grandmaster_identity;
 918   announce->grandmaster_priority_1 =
 919       msg->message_specific.announce.grandmaster_priority_1;
 920   announce->grandmaster_clock_quality.clock_class =
 921       msg->message_specific.announce.grandmaster_clock_quality.clock_class;
 922   announce->grandmaster_clock_quality.clock_accuracy =
 923       msg->message_specific.announce.grandmaster_clock_quality.clock_accuracy;
 924   announce->grandmaster_clock_quality.offset_scaled_log_variance =
 925       msg->message_specific.announce.
 926       grandmaster_clock_quality.offset_scaled_log_variance;
 927   announce->grandmaster_priority_2 =
 928       msg->message_specific.announce.grandmaster_priority_2;
 929   announce->steps_removed = msg->message_specific.announce.steps_removed;
 930   announce->time_source = msg->message_specific.announce.time_source;
 931   g_queue_push_tail (&sender->announce_messages, announce);
 932
 933   select_best_master_clock (domain, receive_time);
 934 }
 935
 936 static gboolean
 937 send_delay_req_timeout (PtpPendingSync * sync)
 938 {
 939   StdIOHeader header = { 0, };
 940   guint8 delay_req[44];
 941   GstByteWriter writer;
 942   GIOStatus status;
 943   gsize written;
 944   GError *err = NULL;
 945
 946   header.type = TYPE_EVENT;
 947   header.size = 44;
 948
 949   gst_byte_writer_init_with_data (&writer, delay_req, 44, FALSE);
 950   gst_byte_writer_put_uint8_unchecked (&writer, PTP_MESSAGE_TYPE_DELAY_REQ);
 951   gst_byte_writer_put_uint8_unchecked (&writer, 2);
 952   gst_byte_writer_put_uint16_be_unchecked (&writer, 44);
 953   gst_byte_writer_put_uint8_unchecked (&writer, sync->domain);
 954   gst_byte_writer_put_uint8_unchecked (&writer, 0);
 955   gst_byte_writer_put_uint16_be_unchecked (&writer, 0);
 956   gst_byte_writer_put_uint64_be_unchecked (&writer, 0);
 957   gst_byte_writer_put_uint32_be_unchecked (&writer, 0);
 958   gst_byte_writer_put_uint64_be_unchecked (&writer,
 959       ptp_clock_id.clock_identity);
 960   gst_byte_writer_put_uint16_be_unchecked (&writer, ptp_clock_id.port_number);
 961   gst_byte_writer_put_uint16_be_unchecked (&writer, sync->delay_req_seqnum);
 962   gst_byte_writer_put_uint8_unchecked (&writer, 0x01);
 963   gst_byte_writer_put_uint8_unchecked (&writer, 0x7f);
 964   gst_byte_writer_put_uint64_be_unchecked (&writer, 0);
 965   gst_byte_writer_put_uint16_be_unchecked (&writer, 0);
 966
 967   status =
 968       g_io_channel_write_chars (stdout_channel, (gchar *) & header,
 969       sizeof (header), &written, &err);
 970   if (status == G_IO_STATUS_ERROR) {
 971     g_warning ("Failed to write to stdout: %s", err->message);
 972     g_clear_error (&err);
 973     return G_SOURCE_REMOVE;
 974   } else if (status == G_IO_STATUS_EOF) {
 975     g_message ("EOF on stdout");
 976     g_main_loop_quit (main_loop);
 977     return G_SOURCE_REMOVE;
 978   } else if (status != G_IO_STATUS_NORMAL) {
 979     g_warning ("Unexpected stdout write status: %d", status);
 980     g_main_loop_quit (main_loop);
 981     return G_SOURCE_REMOVE;
 982   } else if (written != sizeof (header)) {
 983     g_warning ("Unexpected write size: %" G_GSIZE_FORMAT, written);
 984     g_main_loop_quit (main_loop);
 985     return G_SOURCE_REMOVE;
 986   }
 987
 988   sync->delay_req_send_time_local =
 989       gst_clock_get_time (observation_system_clock);
 990
 991   status =
 992       g_io_channel_write_chars (stdout_channel,
 993       (const gchar *) delay_req, 44, &written, &err);
 994   if (status == G_IO_STATUS_ERROR) {
 995     g_warning ("Failed to write to stdout: %s", err->message);
 996     g_clear_error (&err);
 997     g_main_loop_quit (main_loop);
 998     return G_SOURCE_REMOVE;
 999   } else if (status == G_IO_STATUS_EOF) {
1000     g_message ("EOF on stdout");
1001     g_main_loop_quit (main_loop);
1002     return G_SOURCE_REMOVE;
1003   } else if (status != G_IO_STATUS_NORMAL) {
1004     g_warning ("Unexpected stdout write status: %d", status);
1005     g_main_loop_quit (main_loop);
1006     return G_SOURCE_REMOVE;
1007   } else if (written != 44) {
1008     g_warning ("Unexpected write size: %" G_GSIZE_FORMAT, written);
1009     g_main_loop_quit (main_loop);
1010     return G_SOURCE_REMOVE;
1011   }
1012
1013   return G_SOURCE_REMOVE;
1014 }
1015
1016 static gboolean
1017 send_delay_req (PtpDomainData * domain, PtpPendingSync * sync)
1018 {
1019   GstClockTime now = gst_clock_get_time (observation_system_clock);
1020   guint timeout;
1021   GSource *timeout_source;
1022
1023   if (domain->last_delay_req != 0
1024       && domain->last_delay_req + domain->min_delay_req_interval > now)
1025     return FALSE;
1026
1027   domain->last_delay_req = now;
1028   sync->delay_req_seqnum = domain->last_delay_req_seqnum++;
1029
1030   /* IEEE 1588 9.5.11.2 */
1031   if (domain->last_delay_req == 0 || domain->min_delay_req_interval == 0)
1032     timeout = 0;
1033   else
1034     timeout =
1035         g_rand_int_range (delay_req_rand, 0,
1036         (domain->min_delay_req_interval * 2) / GST_MSECOND);
1037
1038   sync->timeout_source = timeout_source = g_timeout_source_new (timeout);
1039   g_source_set_priority (timeout_source, G_PRIORITY_DEFAULT);
1040   g_source_set_callback (timeout_source, (GSourceFunc) send_delay_req_timeout,
1041       sync, NULL);
1042   g_source_attach (timeout_source, main_context);
1043
1044   return TRUE;
1045 }
1046
1047 /* Filtering of outliers for RTT and time calculations inspired
1048  * by the code from gstnetclientclock.c
1049  */
1050 static void
1051 update_ptp_time (PtpDomainData * domain, PtpPendingSync * sync)
1052 {
1053   GstClockTime internal_time, external_time, rate_num, rate_den;
1054   GstClockTime corrected_ptp_time, corrected_local_time;
1055   gdouble r_squared = 0.0;
1056   gboolean synced;
1057   GstClockTimeDiff discont = 0;
1058   GstClockTime estimated_ptp_time = GST_CLOCK_TIME_NONE;
1059 #ifdef USE_MEASUREMENT_FILTERING
1060   GstClockTime orig_internal_time, orig_external_time, orig_rate_num,
1061       orig_rate_den;
1062   GstClockTime new_estimated_ptp_time;
1063   GstClockTime max_discont, estimated_ptp_time_min, estimated_ptp_time_max;
1064   gboolean now_synced;
1065 #endif
1066
1067 #ifdef USE_ONLY_SYNC_WITH_DELAY
1068   GstClockTime mean_path_delay;
1069
1070   if (sync->delay_req_send_time_local == GST_CLOCK_TIME_NONE)
1071     return;
1072
1073   /* IEEE 1588 11.3 */
1074   mean_path_delay =
1075       (sync->delay_req_recv_time_remote - sync->sync_send_time_remote +
1076       sync->sync_recv_time_local - sync->delay_req_send_time_local -
1077       (sync->correction_field_sync + sync->correction_field_delay +
1078           32768) / 65536) / 2;
1079 #endif
1080
1081   /* IEEE 1588 11.2 */
1082   corrected_ptp_time =
1083       sync->sync_send_time_remote +
1084       (sync->correction_field_sync + 32768) / 65536;
1085
1086 #ifdef USE_ONLY_SYNC_WITH_DELAY
1087   corrected_local_time = sync->sync_recv_time_local - mean_path_delay;
1088 #else
1089   corrected_local_time = sync->sync_recv_time_local - domain->mean_path_delay;
1090 #endif
1091
1092 #ifdef USE_MEASUREMENT_FILTERING
1093   /* We check this here and when updating the mean path delay, because
1094    * we can get here without a delay response too */
1095   if (sync->follow_up_recv_time_local != GST_CLOCK_TIME_NONE
1096       && sync->follow_up_recv_time_local >
1097       sync->sync_recv_time_local + 2 * domain->mean_path_delay) {
1098     GST_WARNING ("Sync-follow-up delay for domain %u too big: %" GST_TIME_FORMAT
1099         " > 2 * %" GST_TIME_FORMAT, domain->domain,
1100         GST_TIME_ARGS (sync->follow_up_recv_time_local),
1101         GST_TIME_ARGS (domain->mean_path_delay));
1102     synced = FALSE;
1103     gst_clock_get_calibration (GST_CLOCK_CAST (domain->domain_clock),
1104         &internal_time, &external_time, &rate_num, &rate_den);
1105     goto out;
1106   }
1107 #endif
1108
1109   /* Set an initial local-remote relation */
1110   if (domain->last_ptp_time == 0)
1111     gst_clock_set_calibration (domain->domain_clock, corrected_local_time,
1112         corrected_ptp_time, 1, 1);
1113
1114 #ifdef USE_MEASUREMENT_FILTERING
1115   /* Check if the corrected PTP time is +/- 3/4 RTT around what we would
1116    * estimate with our present knowledge about the clock
1117    */
1118   /* Store what the clock produced as 'now' before this update */
1119   gst_clock_get_calibration (GST_CLOCK_CAST (domain->domain_clock),
1120       &orig_internal_time, &orig_external_time, &orig_rate_num, &orig_rate_den);
1121   internal_time = orig_internal_time;
1122   external_time = orig_external_time;
1123   rate_num = orig_rate_num;
1124   rate_den = orig_rate_den;
1125
1126   /* 3/4 RTT window around the estimation */
1127   max_discont = domain->mean_path_delay * 3 / 2;
1128
1129   /* Check if the estimated sync time is inside our window */
1130   estimated_ptp_time_min = corrected_local_time - max_discont;
1131   estimated_ptp_time_min =
1132       gst_clock_adjust_with_calibration (GST_CLOCK_CAST (domain->domain_clock),
1133       estimated_ptp_time_min, internal_time, external_time, rate_num, rate_den);
1134   estimated_ptp_time_max = corrected_local_time + max_discont;
1135   estimated_ptp_time_max =
1136       gst_clock_adjust_with_calibration (GST_CLOCK_CAST (domain->domain_clock),
1137       estimated_ptp_time_max, internal_time, external_time, rate_num, rate_den);
1138
1139   synced = (estimated_ptp_time_min < corrected_ptp_time
1140       && corrected_ptp_time < estimated_ptp_time_max);
1141
1142   GST_DEBUG ("Adding observation for domain %u: %" GST_TIME_FORMAT " - %"
1143       GST_TIME_FORMAT, domain->domain,
1144       GST_TIME_ARGS (corrected_ptp_time), GST_TIME_ARGS (corrected_local_time));
1145
1146   GST_DEBUG ("Synced %d: %" GST_TIME_FORMAT " < %" GST_TIME_FORMAT " < %"
1147       GST_TIME_FORMAT, synced, GST_TIME_ARGS (estimated_ptp_time_min),
1148       GST_TIME_ARGS (corrected_ptp_time),
1149       GST_TIME_ARGS (estimated_ptp_time_max));
1150
1151   if (gst_clock_add_observation_unapplied (domain->domain_clock,
1152           corrected_local_time, corrected_ptp_time, &r_squared,
1153           &internal_time, &external_time, &rate_num, &rate_den)) {
1154     GST_DEBUG ("Regression gave r_squared: %f", r_squared);
1155
1156     /* Old estimated PTP time based on receive time and path delay */
1157     estimated_ptp_time = corrected_local_time;
1158     estimated_ptp_time =
1159         gst_clock_adjust_with_calibration (GST_CLOCK_CAST
1160         (domain->domain_clock), estimated_ptp_time, orig_internal_time,
1161         orig_external_time, orig_rate_num, orig_rate_den);
1162
1163     /* New estimated PTP time based on receive time and path delay */
1164     new_estimated_ptp_time = corrected_local_time;
1165     new_estimated_ptp_time =
1166         gst_clock_adjust_with_calibration (GST_CLOCK_CAST
1167         (domain->domain_clock), new_estimated_ptp_time, internal_time,
1168         external_time, rate_num, rate_den);
1169
1170     discont = GST_CLOCK_DIFF (estimated_ptp_time, new_estimated_ptp_time);
1171     if (synced && ABS (discont) > max_discont) {
1172       GstClockTimeDiff offset;
1173       GST_DEBUG ("Too large a discont %s%" GST_TIME_FORMAT
1174           ", clamping to 1/4 average RTT = %" GST_TIME_FORMAT,
1175           (discont < 0 ? "-" : ""), GST_TIME_ARGS (ABS (discont)),
1176           GST_TIME_ARGS (max_discont));
1177       if (discont > 0) {        /* Too large a forward step - add a -ve offset */
1178         offset = max_discont - discont;
1179         if (-offset > external_time)
1180           external_time = 0;
1181         else
1182           external_time += offset;
1183       } else {                  /* Too large a backward step - add a +ve offset */
1184         offset = -(max_discont + discont);
1185         external_time += offset;
1186       }
1187
1188       discont += offset;
1189     } else {
1190       GST_DEBUG ("Discont %s%" GST_TIME_FORMAT " (max: %" GST_TIME_FORMAT ")",
1191           (discont < 0 ? "-" : ""), GST_TIME_ARGS (ABS (discont)),
1192           GST_TIME_ARGS (max_discont));
1193     }
1194
1195     /* Check if the estimated sync time is now (still) inside our window */
1196     estimated_ptp_time_min = corrected_local_time - max_discont;
1197     estimated_ptp_time_min =
1198         gst_clock_adjust_with_calibration (GST_CLOCK_CAST
1199         (domain->domain_clock), estimated_ptp_time_min, internal_time,
1200         external_time, rate_num, rate_den);
1201     estimated_ptp_time_max = corrected_local_time + max_discont;
1202     estimated_ptp_time_max =
1203         gst_clock_adjust_with_calibration (GST_CLOCK_CAST
1204         (domain->domain_clock), estimated_ptp_time_max, internal_time,
1205         external_time, rate_num, rate_den);
1206
1207     now_synced = (estimated_ptp_time_min < corrected_ptp_time
1208         && corrected_ptp_time < estimated_ptp_time_max);
1209
1210     GST_DEBUG ("Now synced %d: %" GST_TIME_FORMAT " < %" GST_TIME_FORMAT " < %"
1211         GST_TIME_FORMAT, now_synced, GST_TIME_ARGS (estimated_ptp_time_min),
1212         GST_TIME_ARGS (corrected_ptp_time),
1213         GST_TIME_ARGS (estimated_ptp_time_max));
1214
1215     if (synced || now_synced || domain->skipped_updates > MAX_SKIPPED_UPDATES) {
1216       gst_clock_set_calibration (GST_CLOCK_CAST (domain->domain_clock),
1217           internal_time, external_time, rate_num, rate_den);
1218       domain->skipped_updates = 0;
1219
1220       domain->last_ptp_time = corrected_ptp_time;
1221       domain->last_local_time = corrected_local_time;
1222     } else {
1223       domain->skipped_updates++;
1224     }
1225   } else {
1226     domain->last_ptp_time = corrected_ptp_time;
1227     domain->last_local_time = corrected_local_time;
1228   }
1229
1230 #else
1231   GST_DEBUG ("Adding observation for domain %u: %" GST_TIME_FORMAT " - %"
1232       GST_TIME_FORMAT, domain->domain,
1233       GST_TIME_ARGS (corrected_ptp_time), GST_TIME_ARGS (corrected_local_time));
1234
1235   gst_clock_get_calibration (GST_CLOCK_CAST (domain->domain_clock),
1236       &internal_time, &external_time, &rate_num, &rate_den);
1237
1238   estimated_ptp_time = corrected_local_time;
1239   estimated_ptp_time =
1240       gst_clock_adjust_with_calibration (GST_CLOCK_CAST
1241       (domain->domain_clock), estimated_ptp_time, internal_time,
1242       external_time, rate_num, rate_den);
1243
1244   gst_clock_add_observation (domain->domain_clock,
1245       corrected_local_time, corrected_ptp_time, &r_squared);
1246
1247   gst_clock_get_calibration (GST_CLOCK_CAST (domain->domain_clock),
1248       &internal_time, &external_time, &rate_num, &rate_den);
1249
1250   synced = TRUE;
1251   domain->last_ptp_time = corrected_ptp_time;
1252   domain->last_local_time = corrected_local_time;
1253 #endif
1254
1255 #ifdef USE_MEASUREMENT_FILTERING
1256 out:
1257 #endif
1258   if (g_atomic_int_get (&domain_stats_n_hooks)) {
1259     GstStructure *stats = gst_structure_new (GST_PTP_STATISTICS_TIME_UPDATED,
1260         "domain", G_TYPE_UINT, domain->domain,
1261         "mean-path-delay-avg", GST_TYPE_CLOCK_TIME, domain->mean_path_delay,
1262         "local-time", GST_TYPE_CLOCK_TIME, corrected_local_time,
1263         "ptp-time", GST_TYPE_CLOCK_TIME, corrected_ptp_time,
1264         "estimated-ptp-time", GST_TYPE_CLOCK_TIME, estimated_ptp_time,
1265         "discontinuity", G_TYPE_INT64, discont,
1266         "synced", G_TYPE_BOOLEAN, synced,
1267         "r-squared", G_TYPE_DOUBLE, r_squared,
1268         "internal-time", GST_TYPE_CLOCK_TIME, internal_time,
1269         "external-time", GST_TYPE_CLOCK_TIME, external_time,
1270         "rate-num", G_TYPE_UINT64, rate_num,
1271         "rate-den", G_TYPE_UINT64, rate_den,
1272         "rate", G_TYPE_DOUBLE, (gdouble) (rate_num) / rate_den,
1273         NULL);
1274     emit_ptp_statistics (domain->domain, stats);
1275     gst_structure_free (stats);
1276   }
1277
1278 }
1279
1280 #ifdef USE_MEDIAN_PRE_FILTERING
1281 static gint
1282 compare_clock_time (const GstClockTime * a, const GstClockTime * b)
1283 {
1284   if (*a < *b)
1285     return -1;
1286   else if (*a > *b)
1287     return 1;
1288   return 0;
1289 }
1290 #endif
1291
1292 static gboolean
1293 update_mean_path_delay (PtpDomainData * domain, PtpPendingSync * sync)
1294 {
1295 #ifdef USE_MEDIAN_PRE_FILTERING
1296   GstClockTime last_path_delays[MEDIAN_PRE_FILTERING_WINDOW];
1297   GstClockTime median;
1298   gint i;
1299 #endif
1300
1301   GstClockTime mean_path_delay, delay_req_delay = 0;
1302   gboolean ret;
1303
1304   /* IEEE 1588 11.3 */
1305   mean_path_delay =
1306       (sync->delay_req_recv_time_remote - sync->sync_send_time_remote +
1307       sync->sync_recv_time_local - sync->delay_req_send_time_local -
1308       (sync->correction_field_sync + sync->correction_field_delay +
1309           32768) / 65536) / 2;
1310
1311 #ifdef USE_MEDIAN_PRE_FILTERING
1312   for (i = 1; i < MEDIAN_PRE_FILTERING_WINDOW; i++)
1313     domain->last_path_delays[i - 1] = domain->last_path_delays[i];
1314   domain->last_path_delays[i - 1] = mean_path_delay;
1315
1316   if (domain->last_path_delays_missing) {
1317     domain->last_path_delays_missing--;
1318   } else {
1319     memcpy (&last_path_delays, &domain->last_path_delays,
1320         sizeof (last_path_delays));
1321     g_qsort_with_data (&last_path_delays,
1322         MEDIAN_PRE_FILTERING_WINDOW, sizeof (GstClockTime),
1323         (GCompareDataFunc) compare_clock_time, NULL);
1324
1325     median = last_path_delays[MEDIAN_PRE_FILTERING_WINDOW / 2];
1326
1327     /* FIXME: We might want to use something else here, like only allowing
1328      * things in the interquartile range, or also filtering away delays that
1329      * are too small compared to the median. This here worked well enough
1330      * in tests so far.
1331      */
1332     if (mean_path_delay > 2 * median) {
1333       GST_WARNING ("Path delay for domain %u too big compared to median: %"
1334           GST_TIME_FORMAT " > 2 * %" GST_TIME_FORMAT, domain->domain,
1335           GST_TIME_ARGS (mean_path_delay), GST_TIME_ARGS (median));
1336       ret = FALSE;
1337       goto out;
1338     }
1339   }
1340 #endif
1341
1342 #ifdef USE_RUNNING_AVERAGE_DELAY
1343   /* Track an average round trip time, for a bit of smoothing */
1344   /* Always update before discarding a sample, so genuine changes in
1345    * the network get picked up, eventually */
1346   if (domain->mean_path_delay == 0)
1347     domain->mean_path_delay = mean_path_delay;
1348   else if (mean_path_delay < domain->mean_path_delay)   /* Shorter RTTs carry more weight than longer */
1349     domain->mean_path_delay =
1350         (3 * domain->mean_path_delay + mean_path_delay) / 4;
1351   else
1352     domain->mean_path_delay =
1353         (15 * domain->mean_path_delay + mean_path_delay) / 16;
1354 #else
1355   domain->mean_path_delay = mean_path_delay;
1356 #endif
1357
1358 #ifdef USE_MEASUREMENT_FILTERING
1359   if (sync->follow_up_recv_time_local != GST_CLOCK_TIME_NONE &&
1360       domain->mean_path_delay != 0
1361       && sync->follow_up_recv_time_local >
1362       sync->sync_recv_time_local + 2 * domain->mean_path_delay) {
1363     GST_WARNING ("Sync-follow-up delay for domain %u too big: %" GST_TIME_FORMAT
1364         " > 2 * %" GST_TIME_FORMAT, domain->domain,
1365         GST_TIME_ARGS (sync->follow_up_recv_time_local -
1366             sync->sync_recv_time_local),
1367         GST_TIME_ARGS (domain->mean_path_delay));
1368     ret = FALSE;
1369     goto out;
1370   }
1371
1372   if (mean_path_delay > 2 * domain->mean_path_delay) {
1373     GST_WARNING ("Mean path delay for domain %u too big: %" GST_TIME_FORMAT
1374         " > 2 * %" GST_TIME_FORMAT, domain->domain,
1375         GST_TIME_ARGS (mean_path_delay),
1376         GST_TIME_ARGS (domain->mean_path_delay));
1377     ret = FALSE;
1378     goto out;
1379   }
1380 #endif
1381
1382   delay_req_delay =
1383       sync->delay_resp_recv_time_local - sync->delay_req_send_time_local;
1384
1385 #ifdef USE_MEASUREMENT_FILTERING
1386   /* delay_req_delay is a RTT, so 2 times the path delay */
1387   if (delay_req_delay > 4 * domain->mean_path_delay) {
1388     GST_WARNING ("Delay-request-response delay for domain %u too big: %"
1389         GST_TIME_FORMAT " > 4 * %" GST_TIME_FORMAT, domain->domain,
1390         GST_TIME_ARGS (delay_req_delay),
1391         GST_TIME_ARGS (domain->mean_path_delay));
1392     ret = FALSE;
1393     goto out;
1394   }
1395 #endif
1396
1397   ret = TRUE;
1398
1399   GST_DEBUG ("Got mean path delay for domain %u: %" GST_TIME_FORMAT " (new: %"
1400       GST_TIME_FORMAT ")", domain->domain,
1401       GST_TIME_ARGS (domain->mean_path_delay), GST_TIME_ARGS (mean_path_delay));
1402   GST_DEBUG ("Delay request delay for domain %u: %" GST_TIME_FORMAT,
1403       domain->domain, GST_TIME_ARGS (delay_req_delay));
1404
1405 #ifdef USE_MEASUREMENT_FILTERING
1406 out:
1407 #endif
1408   if (g_atomic_int_get (&domain_stats_n_hooks)) {
1409     GstStructure *stats =
1410         gst_structure_new (GST_PTP_STATISTICS_PATH_DELAY_MEASURED,
1411         "domain", G_TYPE_UINT, domain->domain,
1412         "mean-path-delay-avg", GST_TYPE_CLOCK_TIME, domain->mean_path_delay,
1413         "mean-path-delay", GST_TYPE_CLOCK_TIME, mean_path_delay,
1414         "delay-request-delay", GST_TYPE_CLOCK_TIME, delay_req_delay, NULL);
1415     emit_ptp_statistics (domain->domain, stats);
1416     gst_structure_free (stats);
1417   }
1418
1419   return ret;
1420 }
1421
1422 static void
1423 handle_sync_message (PtpMessage * msg, GstClockTime receive_time)
1424 {
1425   GList *l;
1426   PtpDomainData *domain = NULL;
1427   PtpPendingSync *sync = NULL;
1428
1429   /* Don't consider messages with the alternate master flag set */
1430   if ((msg->flag_field & 0x0100))
1431     return;
1432
1433   for (l = domain_data; l; l = l->next) {
1434     PtpDomainData *tmp = l->data;
1435
1436     if (msg->domain_number == tmp->domain) {
1437       domain = tmp;
1438       break;
1439     }
1440   }
1441
1442   if (!domain) {
1443     gchar *clock_name;
1444
1445     domain = g_new0 (PtpDomainData, 1);
1446     domain->domain = msg->domain_number;
1447     clock_name = g_strdup_printf ("ptp-clock-%u", domain->domain);
1448     domain->domain_clock =
1449         g_object_new (GST_TYPE_SYSTEM_CLOCK, "name", clock_name, NULL);
1450     g_free (clock_name);
1451     g_queue_init (&domain->pending_syncs);
1452     domain->last_path_delays_missing = 9;
1453     domain_data = g_list_prepend (domain_data, domain);
1454
1455     g_mutex_lock (&domain_clocks_lock);
1456     domain_clocks = g_list_prepend (domain_clocks, domain);
1457     g_mutex_unlock (&domain_clocks_lock);
1458   }
1459
1460   /* If we have a master clock, ignore this message if it's not coming from there */
1461   if (domain->have_master_clock
1462       && compare_clock_identity (&domain->master_clock_identity,
1463           &msg->source_port_identity) != 0)
1464     return;
1465
1466 #ifdef USE_OPPORTUNISTIC_CLOCK_SELECTION
1467   /* Opportunistic selection of master clock */
1468   if (!domain->have_master_clock)
1469     memcpy (&domain->master_clock_identity, &msg->source_port_identity,
1470         sizeof (PtpClockIdentity));
1471 #else
1472   if (!domain->have_master_clock)
1473     return;
1474 #endif
1475
1476   domain->sync_interval = log2_to_clock_time (msg->log_message_interval);
1477
1478   /* Check if duplicated */
1479   for (l = domain->pending_syncs.head; l; l = l->next) {
1480     PtpPendingSync *tmp = l->data;
1481
1482     if (tmp->sync_seqnum == msg->sequence_id)
1483       return;
1484   }
1485
1486   if (msg->message_specific.sync.origin_timestamp.seconds_field >
1487       GST_CLOCK_TIME_NONE / GST_SECOND) {
1488     GST_FIXME ("Unsupported sync message seconds field value: %"
1489         G_GUINT64_FORMAT " > %" G_GUINT64_FORMAT,
1490         msg->message_specific.sync.origin_timestamp.seconds_field,
1491         GST_CLOCK_TIME_NONE / GST_SECOND);
1492     return;
1493   }
1494
1495   sync = g_new0 (PtpPendingSync, 1);
1496   sync->domain = domain->domain;
1497   sync->sync_seqnum = msg->sequence_id;
1498   sync->sync_recv_time_local = receive_time;
1499   sync->sync_send_time_remote = GST_CLOCK_TIME_NONE;
1500   sync->follow_up_recv_time_local = GST_CLOCK_TIME_NONE;
1501   sync->delay_req_send_time_local = GST_CLOCK_TIME_NONE;
1502   sync->delay_req_recv_time_remote = GST_CLOCK_TIME_NONE;
1503   sync->delay_resp_recv_time_local = GST_CLOCK_TIME_NONE;
1504
1505   /* 0.5 correction factor for division later */
1506   sync->correction_field_sync = msg->correction_field;
1507
1508   if ((msg->flag_field & 0x0200)) {
1509     /* Wait for FOLLOW_UP */
1510   } else {
1511     sync->sync_send_time_remote =
1512         PTP_TIMESTAMP_TO_GST_CLOCK_TIME (msg->message_specific.
1513         sync.origin_timestamp);
1514
1515     if (domain->last_ptp_sync_time != 0
1516         && domain->last_ptp_sync_time >= sync->sync_send_time_remote) {
1517       GST_WARNING ("Backwards PTP times in domain %u: %" GST_TIME_FORMAT " >= %"
1518           GST_TIME_FORMAT, domain->domain,
1519           GST_TIME_ARGS (domain->last_ptp_sync_time),
1520           GST_TIME_ARGS (sync->sync_send_time_remote));
1521       ptp_pending_sync_free (sync);
1522       sync = NULL;
1523       return;
1524     }
1525     domain->last_ptp_sync_time = sync->sync_send_time_remote;
1526
1527     if (send_delay_req (domain, sync)) {
1528       /* Sent delay request */
1529     } else {
1530       update_ptp_time (domain, sync);
1531       ptp_pending_sync_free (sync);
1532       sync = NULL;
1533     }
1534   }
1535
1536   if (sync)
1537     g_queue_push_tail (&domain->pending_syncs, sync);
1538 }
1539
1540 static void
1541 handle_follow_up_message (PtpMessage * msg, GstClockTime receive_time)
1542 {
1543   GList *l;
1544   PtpDomainData *domain = NULL;
1545   PtpPendingSync *sync = NULL;
1546
1547   /* Don't consider messages with the alternate master flag set */
1548   if ((msg->flag_field & 0x0100))
1549     return;
1550
1551   for (l = domain_data; l; l = l->next) {
1552     PtpDomainData *tmp = l->data;
1553
1554     if (msg->domain_number == tmp->domain) {
1555       domain = tmp;
1556       break;
1557     }
1558   }
1559
1560   if (!domain)
1561     return;
1562
1563   /* If we have a master clock, ignore this message if it's not coming from there */
1564   if (domain->have_master_clock
1565       && compare_clock_identity (&domain->master_clock_identity,
1566           &msg->source_port_identity) != 0)
1567     return;
1568
1569   /* Check if we know about this one */
1570   for (l = domain->pending_syncs.head; l; l = l->next) {
1571     PtpPendingSync *tmp = l->data;
1572
1573     if (tmp->sync_seqnum == msg->sequence_id) {
1574       sync = tmp;
1575       break;
1576     }
1577   }
1578
1579   if (!sync)
1580     return;
1581
1582   /* Got a FOLLOW_UP for this already */
1583   if (sync->sync_send_time_remote != GST_CLOCK_TIME_NONE)
1584     return;
1585
1586   if (sync->sync_recv_time_local >= receive_time) {
1587     GST_ERROR ("Got bogus follow up in domain %u: %" GST_TIME_FORMAT " > %"
1588         GST_TIME_FORMAT, domain->domain,
1589         GST_TIME_ARGS (sync->sync_recv_time_local),
1590         GST_TIME_ARGS (receive_time));
1591     g_queue_remove (&domain->pending_syncs, sync);
1592     ptp_pending_sync_free (sync);
1593     return;
1594   }
1595
1596   sync->correction_field_sync += msg->correction_field;
1597   sync->sync_send_time_remote =
1598       PTP_TIMESTAMP_TO_GST_CLOCK_TIME (msg->message_specific.
1599       follow_up.precise_origin_timestamp);
1600   sync->follow_up_recv_time_local = receive_time;
1601
1602   if (domain->last_ptp_sync_time >= sync->sync_send_time_remote) {
1603     GST_WARNING ("Backwards PTP times in domain %u: %" GST_TIME_FORMAT " >= %"
1604         GST_TIME_FORMAT, domain->domain,
1605         GST_TIME_ARGS (domain->last_ptp_sync_time),
1606         GST_TIME_ARGS (sync->sync_send_time_remote));
1607     g_queue_remove (&domain->pending_syncs, sync);
1608     ptp_pending_sync_free (sync);
1609     sync = NULL;
1610     return;
1611   }
1612   domain->last_ptp_sync_time = sync->sync_send_time_remote;
1613
1614   if (send_delay_req (domain, sync)) {
1615     /* Sent delay request */
1616   } else {
1617     update_ptp_time (domain, sync);
1618     g_queue_remove (&domain->pending_syncs, sync);
1619     ptp_pending_sync_free (sync);
1620     sync = NULL;
1621   }
1622 }
1623
1624 static void
1625 handle_delay_resp_message (PtpMessage * msg, GstClockTime receive_time)
1626 {
1627   GList *l;
1628   PtpDomainData *domain = NULL;
1629   PtpPendingSync *sync = NULL;
1630
1631   /* Don't consider messages with the alternate master flag set */
1632   if ((msg->flag_field & 0x0100))
1633     return;
1634
1635   for (l = domain_data; l; l = l->next) {
1636     PtpDomainData *tmp = l->data;
1637
1638     if (msg->domain_number == tmp->domain) {
1639       domain = tmp;
1640       break;
1641     }
1642   }
1643
1644   if (!domain)
1645     return;
1646
1647   /* If we have a master clock, ignore this message if it's not coming from there */
1648   if (domain->have_master_clock
1649       && compare_clock_identity (&domain->master_clock_identity,
1650           &msg->source_port_identity) != 0)
1651     return;
1652
1653   /* Not for us */
1654   if (msg->message_specific.delay_resp.
1655       requesting_port_identity.clock_identity != ptp_clock_id.clock_identity
1656       || msg->message_specific.delay_resp.
1657       requesting_port_identity.port_number != ptp_clock_id.port_number)
1658     return;
1659
1660   domain->min_delay_req_interval =
1661       log2_to_clock_time (msg->log_message_interval);
1662
1663   /* Check if we know about this one */
1664   for (l = domain->pending_syncs.head; l; l = l->next) {
1665     PtpPendingSync *tmp = l->data;
1666
1667     if (tmp->delay_req_seqnum == msg->sequence_id) {
1668       sync = tmp;
1669       break;
1670     }
1671   }
1672
1673   if (!sync)
1674     return;
1675
1676   /* Got a DELAY_RESP for this already */
1677   if (sync->delay_req_recv_time_remote != GST_CLOCK_TIME_NONE)
1678     return;
1679
1680   if (sync->delay_req_send_time_local > receive_time) {
1681     GST_ERROR ("Got bogus delay response in domain %u: %" GST_TIME_FORMAT " > %"
1682         GST_TIME_FORMAT, domain->domain,
1683         GST_TIME_ARGS (sync->delay_req_send_time_local),
1684         GST_TIME_ARGS (receive_time));
1685     g_queue_remove (&domain->pending_syncs, sync);
1686     ptp_pending_sync_free (sync);
1687     return;
1688   }
1689
1690   sync->correction_field_delay = msg->correction_field;
1691
1692   sync->delay_req_recv_time_remote =
1693       PTP_TIMESTAMP_TO_GST_CLOCK_TIME (msg->message_specific.
1694       delay_resp.receive_timestamp);
1695   sync->delay_resp_recv_time_local = receive_time;
1696
1697   if (domain->mean_path_delay != 0
1698       && sync->sync_send_time_remote > sync->delay_req_recv_time_remote) {
1699     GST_WARNING ("Sync send time after delay req receive time for domain %u: %"
1700         GST_TIME_FORMAT " > %" GST_TIME_FORMAT, domain->domain,
1701         GST_TIME_ARGS (sync->sync_send_time_remote),
1702         GST_TIME_ARGS (sync->delay_req_recv_time_remote));
1703     g_queue_remove (&domain->pending_syncs, sync);
1704     ptp_pending_sync_free (sync);
1705     return;
1706   }
1707
1708   if (update_mean_path_delay (domain, sync))
1709     update_ptp_time (domain, sync);
1710   g_queue_remove (&domain->pending_syncs, sync);
1711   ptp_pending_sync_free (sync);
1712 }
1713
1714 static void
1715 handle_ptp_message (PtpMessage * msg, GstClockTime receive_time)
1716 {
1717   /* Ignore our own messages */
1718   if (msg->source_port_identity.clock_identity == ptp_clock_id.clock_identity &&
1719       msg->source_port_identity.port_number == ptp_clock_id.port_number)
1720     return;
1721
1722   switch (msg->message_type) {
1723     case PTP_MESSAGE_TYPE_ANNOUNCE:
1724       handle_announce_message (msg, receive_time);
1725       break;
1726     case PTP_MESSAGE_TYPE_SYNC:
1727       handle_sync_message (msg, receive_time);
1728       break;
1729     case PTP_MESSAGE_TYPE_FOLLOW_UP:
1730       handle_follow_up_message (msg, receive_time);
1731       break;
1732     case PTP_MESSAGE_TYPE_DELAY_RESP:
1733       handle_delay_resp_message (msg, receive_time);
1734       break;
1735     default:
1736       break;
1737   }
1738 }
1739
1740 static gboolean
1741 have_stdin_data_cb (GIOChannel * channel, GIOCondition condition,
1742     gpointer user_data)
1743 {
1744   GIOStatus status;
1745   StdIOHeader header;
1746   gchar buffer[8192];
1747   GError *err = NULL;
1748   gsize read;
1749
1750   if ((condition & G_IO_STATUS_EOF)) {
1751     GST_ERROR ("Got EOF on stdin");
1752     g_main_loop_quit (main_loop);
1753     return G_SOURCE_REMOVE;
1754   }
1755
1756   status =
1757       g_io_channel_read_chars (channel, (gchar *) & header, sizeof (header),
1758       &read, &err);
1759   if (status == G_IO_STATUS_ERROR) {
1760     GST_ERROR ("Failed to read from stdin: %s", err->message);
1761     g_clear_error (&err);
1762     g_main_loop_quit (main_loop);
1763     return G_SOURCE_REMOVE;
1764   } else if (status == G_IO_STATUS_EOF) {
1765     GST_ERROR ("Got EOF on stdin");
1766     g_main_loop_quit (main_loop);
1767     return G_SOURCE_REMOVE;
1768   } else if (status != G_IO_STATUS_NORMAL) {
1769     GST_ERROR ("Unexpected stdin read status: %d", status);
1770     g_main_loop_quit (main_loop);
1771     return G_SOURCE_REMOVE;
1772   } else if (read != sizeof (header)) {
1773     GST_ERROR ("Unexpected read size: %" G_GSIZE_FORMAT, read);
1774     g_main_loop_quit (main_loop);
1775     return G_SOURCE_REMOVE;
1776   } else if (header.size > 8192) {
1777     GST_ERROR ("Unexpected size: %u", header.size);
1778     g_main_loop_quit (main_loop);
1779     return G_SOURCE_REMOVE;
1780   }
1781
1782   status = g_io_channel_read_chars (channel, buffer, header.size, &read, &err);
1783   if (status == G_IO_STATUS_ERROR) {
1784     GST_ERROR ("Failed to read from stdin: %s", err->message);
1785     g_clear_error (&err);
1786     g_main_loop_quit (main_loop);
1787     return G_SOURCE_REMOVE;
1788   } else if (status == G_IO_STATUS_EOF) {
1789     GST_ERROR ("EOF on stdin");
1790     g_main_loop_quit (main_loop);
1791     return G_SOURCE_REMOVE;
1792   } else if (status != G_IO_STATUS_NORMAL) {
1793     GST_ERROR ("Unexpected stdin read status: %d", status);
1794     g_main_loop_quit (main_loop);
1795     return G_SOURCE_REMOVE;
1796   } else if (read != header.size) {
1797     GST_ERROR ("Unexpected read size: %" G_GSIZE_FORMAT, read);
1798     g_main_loop_quit (main_loop);
1799     return G_SOURCE_REMOVE;
1800   }
1801
1802   switch (header.type) {
1803     case TYPE_EVENT:
1804     case TYPE_GENERAL:{
1805       GstClockTime receive_time = gst_clock_get_time (observation_system_clock);
1806       PtpMessage msg;
1807
1808       if (parse_ptp_message (&msg, (const guint8 *) buffer, header.size)) {
1809         dump_ptp_message (&msg);
1810         handle_ptp_message (&msg, receive_time);
1811       }
1812       break;
1813     }
1814     default:
1815     case TYPE_CLOCK_ID:{
1816       if (header.size != 8) {
1817         GST_ERROR ("Unexpected clock id size (%u != 8)", header.size);
1818         g_main_loop_quit (main_loop);
1819         return G_SOURCE_REMOVE;
1820       }
1821       g_mutex_lock (&ptp_lock);
1822       ptp_clock_id.clock_identity = GST_READ_UINT64_BE (buffer);
1823       ptp_clock_id.port_number = getpid ();
1824       GST_DEBUG ("Got clock id 0x%016" G_GINT64_MODIFIER "x %u",
1825           ptp_clock_id.clock_identity, ptp_clock_id.port_number);
1826       g_cond_signal (&ptp_cond);
1827       g_mutex_unlock (&ptp_lock);
1828       break;
1829     }
1830   }
1831
1832   return G_SOURCE_CONTINUE;
1833 }
1834
1835 /* Cleanup all announce messages and announce message senders
1836  * that are timed out by now, and clean up all pending syncs
1837  * that are missing their FOLLOW_UP or DELAY_RESP */
1838 static gboolean
1839 cleanup_cb (gpointer data)
1840 {
1841   GstClockTime now = gst_clock_get_time (observation_system_clock);
1842   GList *l, *m, *n;
1843
1844   for (l = domain_data; l; l = l->next) {
1845     PtpDomainData *domain = l->data;
1846
1847     for (n = domain->announce_senders; n;) {
1848       PtpAnnounceSender *sender = n->data;
1849       gboolean timed_out = TRUE;
1850
1851       /* Keep only 5 messages per sender around */
1852       while (g_queue_get_length (&sender->announce_messages) > 5) {
1853         PtpAnnounceMessage *msg = g_queue_pop_head (&sender->announce_messages);
1854         g_free (msg);
1855       }
1856
1857       for (m = sender->announce_messages.head; m; m = m->next) {
1858         PtpAnnounceMessage *msg = m->data;
1859
1860         if (msg->receive_time +
1861             sender->announce_interval * PTP_ANNOUNCE_RECEIPT_TIMEOUT > now) {
1862           timed_out = FALSE;
1863           break;
1864         }
1865       }
1866
1867       if (timed_out) {
1868         GST_DEBUG ("Announce sender 0x%016" G_GINT64_MODIFIER "x %u timed out",
1869             sender->master_clock_identity.clock_identity,
1870             sender->master_clock_identity.port_number);
1871         g_queue_foreach (&sender->announce_messages, (GFunc) g_free, NULL);
1872         g_queue_clear (&sender->announce_messages);
1873       }
1874
1875       if (g_queue_get_length (&sender->announce_messages) == 0) {
1876         GList *tmp = n->next;
1877
1878         if (compare_clock_identity (&sender->master_clock_identity,
1879                 &domain->master_clock_identity) == 0)
1880           GST_WARNING ("currently selected master clock timed out");
1881         g_free (sender);
1882         domain->announce_senders =
1883             g_list_delete_link (domain->announce_senders, n);
1884         n = tmp;
1885       } else {
1886         n = n->next;
1887       }
1888     }
1889     select_best_master_clock (domain, now);
1890
1891     /* Clean up any pending syncs */
1892     for (n = domain->pending_syncs.head; n;) {
1893       PtpPendingSync *sync = n->data;
1894       gboolean timed_out = FALSE;
1895
1896       /* Time out pending syncs after 4 sync intervals or 10 seconds,
1897        * and pending delay reqs after 4 delay req intervals or 10 seconds
1898        */
1899       if (sync->delay_req_send_time_local != GST_CLOCK_TIME_NONE &&
1900           ((domain->min_delay_req_interval != 0
1901                   && sync->delay_req_send_time_local +
1902                   4 * domain->min_delay_req_interval < now)
1903               || (sync->delay_req_send_time_local + 10 * GST_SECOND < now))) {
1904         timed_out = TRUE;
1905       } else if ((domain->sync_interval != 0
1906               && sync->sync_recv_time_local + 4 * domain->sync_interval < now)
1907           || (sync->sync_recv_time_local + 10 * GST_SECOND < now)) {
1908         timed_out = TRUE;
1909       }
1910
1911       if (timed_out) {
1912         GList *tmp = n->next;
1913         ptp_pending_sync_free (sync);
1914         g_queue_delete_link (&domain->pending_syncs, n);
1915         n = tmp;
1916       } else {
1917         n = n->next;
1918       }
1919     }
1920   }
1921
1922   return G_SOURCE_CONTINUE;
1923 }
1924
1925 static gpointer
1926 ptp_helper_main (gpointer data)
1927 {
1928   GSource *cleanup_source;
1929
1930   GST_DEBUG ("Starting PTP helper loop");
1931
1932   /* Check all 5 seconds, if we have to cleanup ANNOUNCE or pending syncs message */
1933   cleanup_source = g_timeout_source_new_seconds (5);
1934   g_source_set_priority (cleanup_source, G_PRIORITY_DEFAULT);
1935   g_source_set_callback (cleanup_source, (GSourceFunc) cleanup_cb, NULL, NULL);
1936   g_source_attach (cleanup_source, main_context);
1937   g_source_unref (cleanup_source);
1938
1939   g_main_loop_run (main_loop);
1940   GST_DEBUG ("Stopped PTP helper loop");
1941
1942   g_mutex_lock (&ptp_lock);
1943   ptp_clock_id.clock_identity = GST_PTP_CLOCK_ID_NONE;
1944   ptp_clock_id.port_number = 0;
1945   initted = FALSE;
1946   g_cond_signal (&ptp_cond);
1947   g_mutex_unlock (&ptp_lock);
1948
1949   return NULL;
1950 }
1951
1952 /**
1953  * gst_ptp_is_supported:
1954  *
1955  * Check if PTP clocks are generally supported on this system, and if previous
1956  * initializations did not fail.
1957  *
1958  * Returns: %TRUE if PTP clocks are generally supported on this system, and
1959  * previous initializations did not fail.
1960  *
1961  * Since: 1.6
1962  */
1963 gboolean
1964 gst_ptp_is_supported (void)
1965 {
1966   return supported;
1967 }
1968
1969 /**
1970  * gst_ptp_is_initialized:
1971  *
1972  * Check if the GStreamer PTP clock subsystem is initialized.
1973  *
1974  * Returns: %TRUE if the GStreamer PTP clock subsystem is intialized.
1975  *
1976  * Since: 1.6
1977  */
1978 gboolean
1979 gst_ptp_is_initialized (void)
1980 {
1981   return initted;
1982 }
1983
1984 /**
1985  * gst_ptp_init:
1986  * @clock_id: PTP clock id of this process' clock or %GST_PTP_CLOCK_ID_NONE
1987  * @interfaces: (transfer none) (array zero-terminated=1) (allow-none): network interfaces to run the clock on
1988  *
1989  * Initialize the GStreamer PTP subsystem and create a PTP ordinary clock in
1990  * slave-only mode for all domains on the given @interfaces with the
1991  * given @clock_id.
1992  *
1993  * If @clock_id is %GST_PTP_CLOCK_ID_NONE, a clock id is automatically
1994  * generated from the MAC address of the first network interface.
1995  *
1996  * This function is automatically called by gst_ptp_clock_new() with default
1997  * parameters if it wasn't called before.
1998  *
1999  * Returns: %TRUE if the GStreamer PTP clock subsystem could be initialized.
2000  *
2001  * Since: 1.6
2002  */
2003 gboolean
2004 gst_ptp_init (guint64 clock_id, gchar ** interfaces)
2005 {
2006   gboolean ret;
2007   const gchar *env;
2008   gchar **argv = NULL;
2009   gint argc, argc_c;
2010   gint fd_r, fd_w;
2011   GError *err = NULL;
2012   GSource *stdin_source;
2013
2014   GST_DEBUG_CATEGORY_INIT (ptp_debug, "ptp", 0, "PTP clock");
2015
2016   g_mutex_lock (&ptp_lock);
2017   if (!supported) {
2018     GST_ERROR ("PTP not supported");
2019     ret = FALSE;
2020     goto done;
2021   }
2022
2023   if (initted) {
2024     GST_DEBUG ("PTP already initialized");
2025     ret = TRUE;
2026     goto done;
2027   }
2028
2029   if (ptp_helper_pid) {
2030     GST_DEBUG ("PTP currently initializing");
2031     goto wait;
2032   }
2033
2034   if (!domain_stats_hooks_initted) {
2035     g_hook_list_init (&domain_stats_hooks, sizeof (GHook));
2036     domain_stats_hooks_initted = TRUE;
2037   }
2038
2039   argc = 1;
2040   if (clock_id != GST_PTP_CLOCK_ID_NONE)
2041     argc += 2;
2042   if (interfaces != NULL)
2043     argc += 2 * g_strv_length (interfaces);
2044
2045   argv = g_new0 (gchar *, argc + 2);
2046   argc_c = 0;
2047
2048   env = g_getenv ("GST_PTP_HELPER_1_0");
2049   if (env == NULL)
2050     env = g_getenv ("GST_PTP_HELPER");
2051   if (env != NULL && *env != '\0') {
2052     GST_LOG ("Trying GST_PTP_HELPER env var: %s", env);
2053     argv[argc_c++] = g_strdup (env);
2054   } else {
2055     argv[argc_c++] = g_strdup (GST_PTP_HELPER_INSTALLED);
2056   }
2057
2058   if (clock_id != GST_PTP_CLOCK_ID_NONE) {
2059     argv[argc_c++] = g_strdup ("-c");
2060     argv[argc_c++] = g_strdup_printf ("0x%016" G_GINT64_MODIFIER "x", clock_id);
2061   }
2062
2063   if (interfaces != NULL) {
2064     gchar **ptr = interfaces;
2065
2066     while (*ptr) {
2067       argv[argc_c++] = g_strdup ("-i");
2068       argv[argc_c++] = g_strdup (*ptr);
2069       ptr++;
2070     }
2071   }
2072
2073   main_context = g_main_context_new ();
2074   main_loop = g_main_loop_new (main_context, FALSE);
2075
2076   ptp_helper_thread =
2077       g_thread_try_new ("ptp-helper-thread", ptp_helper_main, NULL, &err);
2078   if (!ptp_helper_thread) {
2079     GST_ERROR ("Failed to start PTP helper thread: %s", err->message);
2080     g_clear_error (&err);
2081     ret = FALSE;
2082     goto done;
2083   }
2084
2085   if (!g_spawn_async_with_pipes (NULL, argv, NULL, 0, NULL, NULL,
2086           &ptp_helper_pid, &fd_w, &fd_r, NULL, &err)) {
2087     GST_ERROR ("Failed to start ptp helper process: %s", err->message);
2088     g_clear_error (&err);
2089     ret = FALSE;
2090     supported = FALSE;
2091     goto done;
2092   }
2093
2094   stdin_channel = g_io_channel_unix_new (fd_r);
2095   g_io_channel_set_encoding (stdin_channel, NULL, NULL);
2096   g_io_channel_set_buffered (stdin_channel, FALSE);
2097   g_io_channel_set_close_on_unref (stdin_channel, TRUE);
2098   stdin_source =
2099       g_io_create_watch (stdin_channel, G_IO_IN | G_IO_PRI | G_IO_HUP);
2100   g_source_set_priority (stdin_source, G_PRIORITY_DEFAULT);
2101   g_source_set_callback (stdin_source, (GSourceFunc) have_stdin_data_cb, NULL,
2102       NULL);
2103   g_source_attach (stdin_source, main_context);
2104   g_source_unref (stdin_source);
2105
2106   /* Create stdout channel */
2107   stdout_channel = g_io_channel_unix_new (fd_w);
2108   g_io_channel_set_encoding (stdout_channel, NULL, NULL);
2109   g_io_channel_set_close_on_unref (stdout_channel, TRUE);
2110   g_io_channel_set_buffered (stdout_channel, FALSE);
2111
2112   delay_req_rand = g_rand_new ();
2113   observation_system_clock =
2114       g_object_new (GST_TYPE_SYSTEM_CLOCK, "name", "ptp-observation-clock",
2115       NULL);
2116
2117   initted = TRUE;
2118
2119 wait:
2120   GST_DEBUG ("Waiting for PTP to be initialized");
2121
2122   while (ptp_clock_id.clock_identity == GST_PTP_CLOCK_ID_NONE && initted)
2123     g_cond_wait (&ptp_cond, &ptp_lock);
2124
2125   ret = initted;
2126   if (ret) {
2127     GST_DEBUG ("Initialized and got clock id 0x%016" G_GINT64_MODIFIER "x %u",
2128         ptp_clock_id.clock_identity, ptp_clock_id.port_number);
2129   } else {
2130     GST_ERROR ("Failed to initialize");
2131     supported = FALSE;
2132   }
2133
2134 done:
2135   g_strfreev (argv);
2136
2137   if (!ret) {
2138     if (ptp_helper_pid) {
2139 #ifndef G_OS_WIN32
2140       kill (ptp_helper_pid, SIGKILL);
2141       waitpid (ptp_helper_pid, NULL, 0);
2142 #else
2143       TerminateProcess (ptp_helper_pid, 1);
2144       WaitForSingleObject (ptp_helper_pid, INFINITE);
2145 #endif
2146       g_spawn_close_pid (ptp_helper_pid);
2147     }
2148     ptp_helper_pid = 0;
2149
2150     if (stdin_channel)
2151       g_io_channel_unref (stdin_channel);
2152     stdin_channel = NULL;
2153     if (stdout_channel)
2154       g_io_channel_unref (stdout_channel);
2155     stdout_channel = NULL;
2156
2157     if (main_loop && ptp_helper_thread) {
2158       g_main_loop_quit (main_loop);
2159       g_thread_join (ptp_helper_thread);
2160     }
2161     ptp_helper_thread = NULL;
2162     if (main_loop)
2163       g_main_loop_unref (main_loop);
2164     main_loop = NULL;
2165     if (main_context)
2166       g_main_context_unref (main_context);
2167     main_context = NULL;
2168
2169     if (delay_req_rand)
2170       g_rand_free (delay_req_rand);
2171     delay_req_rand = NULL;
2172
2173     if (observation_system_clock)
2174       gst_object_unref (observation_system_clock);
2175     observation_system_clock = NULL;
2176   }
2177
2178   g_mutex_unlock (&ptp_lock);
2179
2180   return ret;
2181 }
2182
2183 /**
2184  * gst_ptp_deinit:
2185  *
2186  * Deinitialize the GStreamer PTP subsystem and stop the PTP clock. If there
2187  * are any remaining GstPtpClock instances, they won't be further synchronized
2188  * to the PTP network clock.
2189  *
2190  * Since: 1.6
2191  */
2192 void
2193 gst_ptp_deinit (void)
2194 {
2195   GList *l, *m;
2196
2197   g_mutex_lock (&ptp_lock);
2198
2199   if (ptp_helper_pid) {
2200 #ifndef G_OS_WIN32
2201     kill (ptp_helper_pid, SIGKILL);
2202     waitpid (ptp_helper_pid, NULL, 0);
2203 #else
2204     TerminateProcess (ptp_helper_pid, 1);
2205     WaitForSingleObject (ptp_helper_pid, INFINITE);
2206 #endif
2207     g_spawn_close_pid (ptp_helper_pid);
2208   }
2209   ptp_helper_pid = 0;
2210
2211   if (stdin_channel)
2212     g_io_channel_unref (stdin_channel);
2213   stdin_channel = NULL;
2214   if (stdout_channel)
2215     g_io_channel_unref (stdout_channel);
2216   stdout_channel = NULL;
2217
2218   if (main_loop && ptp_helper_thread) {
2219     GThread *tmp = ptp_helper_thread;
2220     ptp_helper_thread = NULL;
2221     g_mutex_unlock (&ptp_lock);
2222     g_main_loop_quit (main_loop);
2223     g_thread_join (tmp);
2224     g_mutex_lock (&ptp_lock);
2225   }
2226   if (main_loop)
2227     g_main_loop_unref (main_loop);
2228   main_loop = NULL;
2229   if (main_context)
2230     g_main_context_unref (main_context);
2231   main_context = NULL;
2232
2233   if (delay_req_rand)
2234     g_rand_free (delay_req_rand);
2235   delay_req_rand = NULL;
2236   if (observation_system_clock)
2237     gst_object_unref (observation_system_clock);
2238   observation_system_clock = NULL;
2239
2240   for (l = domain_data; l; l = l->next) {
2241     PtpDomainData *domain = l->data;
2242
2243     for (m = domain->announce_senders; m; m = m->next) {
2244       PtpAnnounceSender *sender = m->data;
2245
2246       g_queue_foreach (&sender->announce_messages, (GFunc) g_free, NULL);
2247       g_queue_clear (&sender->announce_messages);
2248       g_free (sender);
2249     }
2250     g_list_free (domain->announce_senders);
2251
2252     g_queue_foreach (&domain->pending_syncs, (GFunc) ptp_pending_sync_free,
2253         NULL);
2254     g_queue_clear (&domain->pending_syncs);
2255     gst_object_unref (domain->domain_clock);
2256     g_free (domain);
2257   }
2258   g_list_free (domain_data);
2259   domain_data = NULL;
2260   g_list_foreach (domain_clocks, (GFunc) g_free, NULL);
2261   g_list_free (domain_clocks);
2262   domain_clocks = NULL;
2263
2264   ptp_clock_id.clock_identity = GST_PTP_CLOCK_ID_NONE;
2265   ptp_clock_id.port_number = 0;
2266
2267   initted = FALSE;
2268
2269   g_mutex_unlock (&ptp_lock);
2270 }
2271
2272 #define DEFAULT_DOMAIN 0
2273
2274 enum
2275 {
2276   PROP_0,
2277   PROP_DOMAIN,
2278   PROP_INTERNAL_CLOCK,
2279   PROP_MASTER_CLOCK_ID,
2280   PROP_GRANDMASTER_CLOCK_ID
2281 };
2282
2283 #define GST_PTP_CLOCK_GET_PRIVATE(obj)  \
2284   (G_TYPE_INSTANCE_GET_PRIVATE ((obj), GST_TYPE_PTP_CLOCK, GstPtpClockPrivate))
2285
2286 struct _GstPtpClockPrivate
2287 {
2288   guint domain;
2289   GstClock *domain_clock;
2290   gulong domain_stats_id;
2291 };
2292
2293 #define gst_ptp_clock_parent_class parent_class
2294 G_DEFINE_TYPE (GstPtpClock, gst_ptp_clock, GST_TYPE_SYSTEM_CLOCK);
2295
2296 static void gst_ptp_clock_set_property (GObject * object, guint prop_id,
2297     const GValue * value, GParamSpec * pspec);
2298 static void gst_ptp_clock_get_property (GObject * object, guint prop_id,
2299     GValue * value, GParamSpec * pspec);
2300 static void gst_ptp_clock_finalize (GObject * object);
2301
2302 static GstClockTime gst_ptp_clock_get_internal_time (GstClock * clock);
2303
2304 static void
2305 gst_ptp_clock_class_init (GstPtpClockClass * klass)
2306 {
2307   GObjectClass *gobject_class;
2308   GstClockClass *clock_class;
2309
2310   gobject_class = G_OBJECT_CLASS (klass);
2311   clock_class = GST_CLOCK_CLASS (klass);
2312
2313   g_type_class_add_private (klass, sizeof (GstPtpClockPrivate));
2314
2315   gobject_class->finalize = gst_ptp_clock_finalize;
2316   gobject_class->get_property = gst_ptp_clock_get_property;
2317   gobject_class->set_property = gst_ptp_clock_set_property;
2318
2319   g_object_class_install_property (gobject_class, PROP_DOMAIN,
2320       g_param_spec_uint ("domain", "Domain",
2321           "The PTP domain", 0, G_MAXUINT8,
2322           DEFAULT_DOMAIN,
2323           G_PARAM_READWRITE | G_PARAM_CONSTRUCT_ONLY | G_PARAM_STATIC_STRINGS));
2324
2325   g_object_class_install_property (gobject_class, PROP_INTERNAL_CLOCK,
2326       g_param_spec_object ("internal-clock", "Internal Clock",
2327           "Internal clock", GST_TYPE_CLOCK,
2328           G_PARAM_READABLE | G_PARAM_STATIC_STRINGS));
2329
2330   g_object_class_install_property (gobject_class, PROP_MASTER_CLOCK_ID,
2331       g_param_spec_uint64 ("master-clock-id", "Master Clock ID",
2332           "Master Clock ID", 0, G_MAXUINT64, 0,
2333           G_PARAM_READABLE | G_PARAM_STATIC_STRINGS));
2334
2335   g_object_class_install_property (gobject_class, PROP_GRANDMASTER_CLOCK_ID,
2336       g_param_spec_uint64 ("grandmaster-clock-id", "Grand Master Clock ID",
2337           "Grand Master Clock ID", 0, G_MAXUINT64, 0,
2338           G_PARAM_READABLE | G_PARAM_STATIC_STRINGS));
2339
2340   clock_class->get_internal_time = gst_ptp_clock_get_internal_time;
2341 }
2342
2343 static void
2344 gst_ptp_clock_init (GstPtpClock * self)
2345 {
2346   GstPtpClockPrivate *priv;
2347
2348   self->priv = priv = GST_PTP_CLOCK_GET_PRIVATE (self);
2349
2350   GST_OBJECT_FLAG_SET (self, GST_CLOCK_FLAG_CAN_SET_MASTER);
2351   GST_OBJECT_FLAG_SET (self, GST_CLOCK_FLAG_NEEDS_STARTUP_SYNC);
2352
2353   priv->domain = DEFAULT_DOMAIN;
2354 }
2355
2356 static gboolean
2357 gst_ptp_clock_ensure_domain_clock (GstPtpClock * self)
2358 {
2359   gboolean got_clock = TRUE;
2360
2361   if (G_UNLIKELY (!self->priv->domain_clock)) {
2362     g_mutex_lock (&domain_clocks_lock);
2363     if (!self->priv->domain_clock) {
2364       GList *l;
2365
2366       got_clock = FALSE;
2367
2368       for (l = domain_clocks; l; l = l->next) {
2369         PtpDomainData *clock_data = l->data;
2370
2371         if (clock_data->domain == self->priv->domain
2372             && clock_data->last_ptp_time != 0) {
2373           self->priv->domain_clock = clock_data->domain_clock;
2374           got_clock = TRUE;
2375           break;
2376         }
2377       }
2378     }
2379     g_mutex_unlock (&domain_clocks_lock);
2380     if (got_clock) {
2381       g_object_notify (G_OBJECT (self), "internal-clock");
2382       gst_clock_set_synced (GST_CLOCK (self), TRUE);
2383     }
2384   }
2385
2386   return got_clock;
2387 }
2388
2389 static gboolean
2390 gst_ptp_clock_stats_callback (guint8 domain, const GstStructure * stats,
2391     gpointer user_data)
2392 {
2393   GstPtpClock *self = user_data;
2394
2395   if (domain != self->priv->domain
2396       || !gst_structure_has_name (stats, GST_PTP_STATISTICS_TIME_UPDATED))
2397     return TRUE;
2398
2399   /* Let's set our internal clock */
2400   if (!gst_ptp_clock_ensure_domain_clock (self))
2401     return TRUE;
2402
2403   self->priv->domain_stats_id = 0;
2404
2405   return FALSE;
2406 }
2407
2408 static void
2409 gst_ptp_clock_set_property (GObject * object, guint prop_id,
2410     const GValue * value, GParamSpec * pspec)
2411 {
2412   GstPtpClock *self = GST_PTP_CLOCK (object);
2413
2414   switch (prop_id) {
2415     case PROP_DOMAIN:
2416       self->priv->domain = g_value_get_uint (value);
2417       gst_ptp_clock_ensure_domain_clock (self);
2418       if (!self->priv->domain_clock)
2419         self->priv->domain_stats_id =
2420             gst_ptp_statistics_callback_add (gst_ptp_clock_stats_callback, self,
2421             NULL);
2422       break;
2423     default:
2424       G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
2425       break;
2426   }
2427 }
2428
2429 static void
2430 gst_ptp_clock_get_property (GObject * object, guint prop_id,
2431     GValue * value, GParamSpec * pspec)
2432 {
2433   GstPtpClock *self = GST_PTP_CLOCK (object);
2434
2435   switch (prop_id) {
2436     case PROP_DOMAIN:
2437       g_value_set_uint (value, self->priv->domain);
2438       break;
2439     case PROP_INTERNAL_CLOCK:
2440       gst_ptp_clock_ensure_domain_clock (self);
2441       g_value_set_object (value, self->priv->domain_clock);
2442       break;
2443     case PROP_MASTER_CLOCK_ID:
2444     case PROP_GRANDMASTER_CLOCK_ID:{
2445       GList *l;
2446
2447       g_mutex_lock (&domain_clocks_lock);
2448       g_value_set_uint64 (value, 0);
2449
2450       for (l = domain_clocks; l; l = l->next) {
2451         PtpDomainData *clock_data = l->data;
2452
2453         if (clock_data->domain == self->priv->domain) {
2454           if (prop_id == PROP_MASTER_CLOCK_ID)
2455             g_value_set_uint64 (value,
2456                 clock_data->master_clock_identity.clock_identity);
2457           else
2458             g_value_set_uint64 (value, clock_data->grandmaster_identity);
2459           break;
2460         }
2461       }
2462       g_mutex_unlock (&domain_clocks_lock);
2463       break;
2464     }
2465     default:
2466       G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
2467       break;
2468   }
2469 }
2470
2471 static void
2472 gst_ptp_clock_finalize (GObject * object)
2473 {
2474   GstPtpClock *self = GST_PTP_CLOCK (object);
2475
2476   if (self->priv->domain_stats_id)
2477     gst_ptp_statistics_callback_remove (self->priv->domain_stats_id);
2478
2479   G_OBJECT_CLASS (gst_ptp_clock_parent_class)->finalize (object);
2480 }
2481
2482 static GstClockTime
2483 gst_ptp_clock_get_internal_time (GstClock * clock)
2484 {
2485   GstPtpClock *self = GST_PTP_CLOCK (clock);
2486
2487   gst_ptp_clock_ensure_domain_clock (self);
2488
2489   if (!self->priv->domain_clock) {
2490     GST_ERROR_OBJECT (self, "Domain %u has no clock yet and is not synced",
2491         self->priv->domain);
2492     return GST_CLOCK_TIME_NONE;
2493   }
2494
2495   return gst_clock_get_time (self->priv->domain_clock);
2496 }
2497
2498 /**
2499  * gst_ptp_clock_new:
2500  * @name: Name of the clock
2501  * @domain: PTP domain
2502  *
2503  * Creates a new PTP clock instance that exports the PTP time of the master
2504  * clock in @domain. This clock can be slaved to other clocks as needed.
2505  *
2506  * If gst_ptp_init() was not called before, this will call gst_ptp_init() with
2507  * default parameters.
2508  *
2509  * This clock only returns valid timestamps after it received the first
2510  * times from the PTP master clock on the network. Once this happens the
2511  * GstPtpClock::internal-clock property will become non-NULL. You can
2512  * check this with gst_clock_wait_for_sync(), the GstClock::synced signal and
2513  * gst_clock_is_synced().
2514  *
2515  * Since: 1.6
2516  */
2517 GstClock *
2518 gst_ptp_clock_new (const gchar * name, guint domain)
2519 {
2520   g_return_val_if_fail (name != NULL, NULL);
2521   g_return_val_if_fail (domain <= G_MAXUINT8, NULL);
2522
2523   if (!initted && !gst_ptp_init (GST_PTP_CLOCK_ID_NONE, NULL)) {
2524     GST_ERROR ("Failed to initialize PTP");
2525     return NULL;
2526   }
2527
2528   return g_object_new (GST_TYPE_PTP_CLOCK, "name", name, "domain", domain,
2529       NULL);
2530 }
2531
2532 typedef struct
2533 {
2534   guint8 domain;
2535   const GstStructure *stats;
2536 } DomainStatsMarshalData;
2537
2538 static void
2539 domain_stats_marshaller (GHook * hook, DomainStatsMarshalData * data)
2540 {
2541   GstPtpStatisticsCallback callback = (GstPtpStatisticsCallback) hook->func;
2542
2543   if (!callback (data->domain, data->stats, hook->data))
2544     g_hook_destroy (&domain_stats_hooks, hook->hook_id);
2545 }
2546
2547 static void
2548 emit_ptp_statistics (guint8 domain, const GstStructure * stats)
2549 {
2550   DomainStatsMarshalData data = { domain, stats };
2551
2552   g_mutex_lock (&ptp_lock);
2553   g_hook_list_marshal (&domain_stats_hooks, TRUE,
2554       (GHookMarshaller) domain_stats_marshaller, &data);
2555   g_mutex_unlock (&ptp_lock);
2556 }
2557
2558 /**
2559  * gst_ptp_statistics_callback_add:
2560  * @callback: GstPtpStatisticsCallback to call
2561  * @user_data: Data to pass to the callback
2562  * @destroy_data: GDestroyNotify to destroy the data
2563  *
2564  * Installs a new statistics callback for gathering PTP statistics. See
2565  * GstPtpStatisticsCallback for a list of statistics that are provided.
2566  *
2567  * Returns: Id for the callback that can be passed to
2568  * gst_ptp_statistics_callback_remove()
2569  *
2570  * Since: 1.6
2571  */
2572 gulong
2573 gst_ptp_statistics_callback_add (GstPtpStatisticsCallback callback,
2574     gpointer user_data, GDestroyNotify destroy_data)
2575 {
2576   GHook *hook;
2577
2578   g_mutex_lock (&ptp_lock);
2579
2580   if (!domain_stats_hooks_initted) {
2581     g_hook_list_init (&domain_stats_hooks, sizeof (GHook));
2582     domain_stats_hooks_initted = TRUE;
2583   }
2584
2585   hook = g_hook_alloc (&domain_stats_hooks);
2586   hook->func = callback;
2587   hook->data = user_data;
2588   hook->destroy = destroy_data;
2589   g_hook_prepend (&domain_stats_hooks, hook);
2590   g_atomic_int_add (&domain_stats_n_hooks, 1);
2591
2592   g_mutex_unlock (&ptp_lock);
2593
2594   return hook->hook_id;
2595 }
2596
2597 /**
2598  * gst_ptp_statistics_callback_remove:
2599  * @id: Callback id to remove
2600  *
2601  * Removes a PTP statistics callback that was previously added with
2602  * gst_ptp_statistics_callback_add().
2603  *
2604  * Since: 1.6
2605  */
2606 void
2607 gst_ptp_statistics_callback_remove (gulong id)
2608 {
2609   g_mutex_lock (&ptp_lock);
2610   if (g_hook_destroy (&domain_stats_hooks, id))
2611     g_atomic_int_add (&domain_stats_n_hooks, -1);
2612   g_mutex_unlock (&ptp_lock);
2613 }