Add an option for default clock sync URI

Applications which cannot control their manifests may need to specify a default clock sync URI for use when UTCTiming elements are missing. Closes #290 Change-Id: I5704b25d2d3199ceb932f8102490a9b3e8a27dac
shaka-project · May 4, 2016 · 0a3d6bd · 0a3d6bd
1 parent 2e19ebe
commit 0a3d6bd
Show file tree

Hide file tree

Showing 8 changed files with 38 additions and 8 deletions.
diff --git a/demo/asset_section.js b/demo/asset_section.js
@@ -113,6 +113,8 @@ shakaDemo.load = function() {
 
   var config = /** @type {shakaExtern.PlayerConfiguration} */(
       { abr: {}, drm: {}, manifest: { dash: {} } });
+  config.manifest.dash.clockSyncUri =
+      '//shaka-player-demo.appspot.com/time.txt';
 
   if (!asset) {
     // Use the custom fields.

diff --git a/externs/shaka/player.js b/externs/shaka/player.js
@@ -283,13 +283,18 @@ shakaExtern.DrmConfiguration;
 
 /**
  * @typedef {{
- *   customScheme: shakaExtern.DashContentProtectionCallback
+ *   customScheme: shakaExtern.DashContentProtectionCallback,
+ *   clockSyncUri: string
  * }}
  *
  * @property {shakaExtern.DashContentProtectionCallback} customScheme
  *   If given, invoked by a DASH manifest parser to interpret custom or
  *   non-standard DRM schemes found in the manifest.  The argument is a
  *   ContentProtection node.  Return null if not recognized.
+ * @property {string} clockSyncUri
+ *   A default clock sync URI to be used with live streams which do not
+ *   contain any clock sync information.  The "Date" header from this URI
+ *   will be used to determine the current time.
  *
  * @exportDoc
  */

diff --git a/lib/dash/dash_parser.js b/lib/dash/dash_parser.js
@@ -1064,10 +1064,27 @@ shaka.dash.DashParser.prototype.requestForTiming_ = function(uri, method) {
  * @private
  */
 shaka.dash.DashParser.prototype.parseUtcTiming_ = function(elems, isLive) {
+  var schemesAndValues = elems.map(function(elem) {
+    return {
+      scheme: elem.getAttribute('schemeIdUri'),
+      value: elem.getAttribute('value')
+    };
+  });
+
+  // If there's nothing specified in the manifest, but we have a default from
+  // the config, use that.
+  var clockSyncUri = this.config_.dash.clockSyncUri;
+  if (isLive && !schemesAndValues.length && clockSyncUri) {
+    schemesAndValues.push({
+      scheme: 'urn:mpeg:dash:utc:http-head:2014',
+      value: clockSyncUri
+    });
+  }
+
   var Functional = shaka.util.Functional;
-  return Functional.createFallbackPromiseChain(elems, function(elem) {
-    var scheme = elem.getAttribute('schemeIdUri');
-    var value = elem.getAttribute('value');
+  return Functional.createFallbackPromiseChain(schemesAndValues, function(sv) {
+    var scheme = sv.scheme;
+    var value = sv.value;
     switch (scheme) {
       // See DASH IOP Guidelines Section 4.7
       // http://goo.gl/CQFNJT

diff --git a/lib/player.js b/lib/player.js
@@ -1184,7 +1184,8 @@ shaka.Player.prototype.defaultConfig_ = function() {
           // in mergeConfigObjects_().
           // TODO: Find a better solution if possible.
           if (node) return null;
-        }
+        },
+        clockSyncUri: ''
       }
     },
     streaming: {

diff --git a/test/dash_parser_content_protection_unit.js b/test/dash_parser_content_protection_unit.js
@@ -37,7 +37,7 @@ describe('DashParser.ContentProtection', function() {
     var callback = opt_callback || function(node) { return null; };
     dashParser.configure({
       retryParameters: retry,
-      dash: { customScheme: callback }
+      dash: { clockSyncUri: '', customScheme: callback }
     });
     dashParser.start('http://example.com', netEngine, filterPeriod, fail)
         .then(function(actual) { expect(actual).toEqual(expected); })

diff --git a/test/dash_parser_live_unit.js b/test/dash_parser_live_unit.js
@@ -34,7 +34,7 @@ describe('DashParser.Live', function() {
     parser = new shaka.dash.DashParser();
     parser.configure({
       retryParameters: retry,
-      dash: { customScheme: function(node) { return null; } }
+      dash: { clockSyncUri: '', customScheme: function(node) { return null; } }
     });
   });
 

diff --git a/test/player_integration.js b/test/player_integration.js
@@ -183,6 +183,8 @@ describe('Player', function() {
 
         var config = { abr: {}, drm: {}, manifest: { dash: {} } };
         config.abr.enabled = false;
+        config.manifest.dash.clockSyncUri =
+            '//shaka-player-demo.appspot.com/time.txt';
         if (asset.licenseServers)
           config.drm.servers = asset.licenseServers;
         if (asset.drmCallback)

diff --git a/test/util/dash_parser_util.js b/test/util/dash_parser_util.js
@@ -27,7 +27,10 @@ shaka.test.Dash.makeDashParser = function() {
   var parser = new shaka.dash.DashParser();
   parser.configure({
     retryParameters: retry,
-    dash: { customScheme: function(node) { return null; } }
+    dash: {
+      customScheme: function(node) { return null; },
+      clockSyncUri: ''
+    }
   });
   return parser;
 };