Update EME browser tests to include EME WD

chrome/test/data/media/encrypted_media_utils.js

 // Copyright 2013 The Chromium Authors. All rights reserved.
 // Use of this source code is governed by a BSD-style license that can be
 // found in the LICENSE file.
 
 var keySystem = QueryString.keySystem;
 var mediaFile = QueryString.mediaFile;
 var mediaType = QueryString.mediaType || 'video/webm; codecs="vorbis, vp8"';
 var useMSE = QueryString.useMSE == 1;
+var usePrefixedEME = QueryString.usePrefixedEME == 1;
 var forceInvalidResponse = QueryString.forceInvalidResponse == 1;
 var sessionToLoad = QueryString.sessionToLoad;
 var licenseServerURL = QueryString.licenseServerURL;
 // Number of possible retries used to get a license from license server.
 // This is used to avoid server boot up delays since there is no direct way
 // to know if it is ready crbug.com/339289.
 var requestLicenseTries = 3;
 // Delay in ms between retries to get a license from license server.
 var licenseRequestRetryDelayMs = 3000;
 
@@ skipping 23 matching lines @@
 
 function hasPrefix(msg, prefix) {
   if (msg.length < prefix.length)
     return false;
   for (var i = 0; i < prefix.length; ++i) {
     if (String.fromCharCode(msg[i]) != prefix[i])
       return false;
   }
   return true;
 }
 

[ddorwin, 2014/03/04 21:18:48]

Can we say that these are copied from the layout test file? (Are they?)

[jrummell, 2014/03/04 23:55:49]

They are. Updated.

+// Encodes data into base64 string without trailing '='.

[ddorwin, 2014/03/04 21:18:48]

What you really want is a base64url encoding (though that may not be what Chrome
currently expects since the spec is not yet updated [1]).

Maybe we just need a TODO to update this when the implementation is updated.

The method would then be base64urlEncode.

[1] https://www.w3.org/Bugs/Public/show_bug.cgi?id=17682

[jrummell, 2014/03/04 23:55:49]

Done.

+function base64Encode(data)

[ddorwin, 2014/03/04 21:18:48]

|dataString|?

[jrummell, 2014/03/04 23:55:49]

This is a Uint8Array, not a string. Updated comment.

+{
+    var result = btoa(String.fromCharCode.apply(null, data));

[ddorwin, 2014/03/04 21:18:48]

What is the apply() call doing/solving?

[jrummell, 2014/03/04 23:55:49]

It appears to be converting the Uint8Array to a string.

+    return result.replace(/=+$/g, '');
+}
+
+// Creates a JWK from raw key ID and key.
+function createJWK(keyId, key)
+{
+    var jwk = "{\"kty\":\"oct\",\"kid\":\"";
+    jwk += base64Encode(keyId);
+    jwk += "\",\"k\":\"";
+    jwk += base64Encode(key);
+    jwk += "\"}";
+    return jwk;
+}
+
+// Creates a JWK Set from multiple JWKs.

[ddorwin, 2014/03/04 21:18:48]

... from an array of JWK(s).

[jrummell, 2014/03/04 23:55:49]

Done.

+function createJWKSet()
+{
+    var jwkSet = "{\"keys\":[";
+    for (var i = 0; i < arguments.length; i++) {
+        if (i != 0)
+            jwkSet += ",";
+        jwkSet += arguments[i];
+    }
+    jwkSet += "]}";
+    return jwkSet;
+}
+
 function isHeartbeatMessage(msg) {
   return hasPrefix(msg, HEART_BEAT_HEADER);
 }
 
 function isFileIOTestMessage(msg) {
   return hasPrefix(msg, FILE_IO_TEST_RESULT_HEADER);
 }
 
 function loadEncryptedMediaFromURL(video) {
-  return loadEncryptedMedia(video, mediaFile, keySystem, KEY, useMSE);
+  return loadEncryptedMedia(video, mediaFile, keySystem, KEY, useMSE,
+                            usePrefixedEME);
 }
 
 function loadEncryptedMedia(video, mediaFile, keySystem, key, useMSE,
-                            appendSourceCallbackFn) {
+                            usePrefixedEME, appendSourceCallbackFn) {
   var keyRequested = false;
   var sourceOpened = false;
+  var mediaKeys;
+  var mediaKeySession;
   // Add properties to enable verification that events occurred.
   video.receivedKeyAdded = false;
   video.receivedHeartbeat = false;
   video.isHeartbeatExpected = keySystem === EXTERNAL_CLEAR_KEY_KEY_SYSTEM;
   video.receivedKeyMessage = false;
 
   if (!(video && mediaFile && keySystem && key)) {
     failTest('Missing parameters in loadEncryptedMedia().');
     return;
   }
 
+  // Shared by prefixed EME and EME WD

[ddorwin, 2014/03/04 21:18:48]

ditto on "WD" in this file.

[jrummell, 2014/03/04 23:55:49]

Done.

   function onNeedKey(e) {
     if (keyRequested)
       return;
     keyRequested = true;
     console.log('onNeedKey', e);
 
     var initData = sessionToLoad ? stringToUint8Array(
         PREFIXED_API_LOAD_SESSION_HEADER + sessionToLoad) : e.initData;
     try {
-      video.webkitGenerateKeyRequest(keySystem, initData);
+      if (usePrefixedEME) {
+        video.webkitGenerateKeyRequest(keySystem, initData);
+      } else {
+        mediaKeySession = mediaKeys.createSession(e.contentType, initData);
+        mediaKeySession.addEventListener('message', onMessage);
+        mediaKeySession.addEventListener('error', function() {
+            setResultInTitle("KeyError");
+        });
+        mediaKeySession.addEventListener('ready', onReady);
+      }
     }
     catch(error) {
       setResultInTitle(error.name);
     }
   }
 
+  // Prefixed EME callbacks
   function onKeyAdded(e) {
     e.target.receivedKeyAdded = true;
   }
 
   function onKeyMessage(message) {
     video.receivedKeyMessage = true;
     if (!message.keySystem || message.keySystem != keySystem) {
       failTest('Message with unexpected keySystem: ' + message.keySystem);
       return;
     }
 
     if (!message.sessionId) {
       failTest('Message without a sessionId: ' + message.sessionId);
       return;
     }
 
     if (!message.message) {
       failTest('Message without a message content: ' + message.message);
       return;
     }
 
     if (isHeartbeatMessage(message.message)) {
       console.log('onKeyMessage - heartbeat', message);
       message.target.receivedHeartbeat = true;
-      verifyHeartbeatMessage(message);
+      verifyHeartbeatMessage(message.keySystem, message.defaultURL);
       return;
     }
 
     if (isFileIOTestMessage(message.message)) {
-      var success = getFileIOTestResult(message);
+      var success = getFileIOTestResult(message.keySystem, message);
       console.log('onKeyMessage - CDM file IO test: ' +
                   (success ? 'Success' : 'Fail'));
       if (success)
         setResultInTitle("FILEIOTESTSUCCESS");
       else
         setResultInTitle("FAILED");
       return;
     }
 
     // For FileIOTest key system, no need to start playback.
@@ skipping 22 matching lines @@
       requestLicense(message);
       return;
     }
     console.log('Respond to onKeyMessage with test key.');
     var initData = message.message;
     if (mediaType.indexOf('mp4') != -1)
       initData = KEY_ID; // Temporary hack for Clear Key in v0.1.
     video.webkitAddKey(keySystem, key, initData);
   }
 
-  function verifyHeartbeatMessage(message) {
+  // EME WD callbacks
+  function onReady(e) {
+    video.receivedKeyAdded = true;

[ddorwin, 2014/03/04 21:18:48]

Note: This will break when we remove ready. Maybe we'll just skip this for
unprefixed.
We'll also want to add receivedOpen at that time.

[jrummell, 2014/03/04 23:55:49]

encrypted_media_player.html checks for the flag being set. Fixed.

+  }
+
+  function onMessage(message) {

[ddorwin, 2014/03/04 21:18:48]

This function has a lot of duplicate code. How much is actually different other
than default/destinationURL? Can we try to reuse more of it?

[jrummell, 2014/03/04 23:55:49]

Also keySystem, update()/webKitAddkey(), using video/message.target. Not sure if
we care about the naming (onKeyMessage/onMessage). However, I combined them.

+    video.receivedKeyMessage = true;
+
+    if (!message.message) {
+      failTest('Message without a message content: ' + message.message);
+      return;
+    }
+
+    if (isHeartbeatMessage(message.message)) {
+      console.log('onMessage - heartbeat', message);
+      video.receivedHeartbeat = true;
+      verifyHeartbeatMessage(keySystem, message.destinationURL);
+      return;
+    }
+
+    if (isFileIOTestMessage(message.message)) {
+      var success = getFileIOTestResult(keySystem, message);
+      console.log('onMessage - CDM file IO test: ' +
+                  (success ? 'Success' : 'Fail'));
+      if (success)
+        setResultInTitle("FILEIOTESTSUCCESS");
+      else
+        setResultInTitle("FAILED");
+      return;
+    }
+
+    // For FileIOTest key system, no need to start playback.
+    if (mediaKeySession.keySystem == EXTERNAL_CLEAR_KEY_FILE_IO_TEST_KEY_SYSTEM)
+      return;
+
+    // No tested key system returns destinationURL in for key request messages.
+    if (message.destinationURL) {
+      failTest('Message unexpectedly has destinationURL: ' +
+               message.destinationURL);
+      return;
+    }
+
+    // When loading a session, no need to call update().
+    if (sessionToLoad)
+      return;
+
+    console.log('onMessage - key request', message);
+    if (forceInvalidResponse) {
+      console.log('Forcing an invalid onMessage response.');
+      var invalidData = new Uint8Array([0xAA]);
+      var jwkSet = stringToUint8Array(
+          createJWKSet(createJWK(invalidData, invalidData)));
+      mediaKeySession.update(jwkSet);
+      return;
+    }
+    // Check if should send request to locally running license server.
+    if (licenseServerURL) {
+      requestLicense(message);
+      return;
+    }
+    console.log('Respond to onMessage with test key.');
+    var initData = message.message;
+    if (mediaType.indexOf('mp4') != -1)
+      initData = KEY_ID; // Temporary hack for Clear Key in v0.1.
+    var jwkSet = stringToUint8Array(createJWKSet(createJWK(initData, key)));
+    mediaKeySession.update(jwkSet);
+  }
+

[ddorwin, 2014/03/04 21:18:48]

I skipped to here.

+  function verifyHeartbeatMessage(keySystem, url) {
     String.prototype.startsWith = function(prefix) {
       return this.indexOf(prefix) === 0;
     }
 
     function isExternalClearKey(keySystem) {
       return keySystem == EXTERNAL_CLEAR_KEY_KEY_SYSTEM ||
              keySystem.startsWith(EXTERNAL_CLEAR_KEY_KEY_SYSTEM + '.');
     }
 
     // Only External Clear Key sends a HEARTBEAT message.
-    if (!isExternalClearKey(message.keySystem)) {
-      failTest('Unexpected heartbeat from ' + message.keySystem);
+    if (!isExternalClearKey(keySystem)) {
+      failTest('Unexpected heartbeat from ' + keySystem);
       return;
     }
 
-    if (message.defaultURL != EXTERNAL_CLEAR_KEY_HEARTBEAT_URL) {
-      failTest('Heartbeat message with unexpected defaultURL: ' +
-               message.defaultURL);
+    if (url != EXTERNAL_CLEAR_KEY_HEARTBEAT_URL) {
+      failTest('Heartbeat message with unexpected URL: ' + url);
       return;
     }
   }
 
-  function getFileIOTestResult(e) {
+  function getFileIOTestResult(keySystem, e) {
     // Only External Clear Key sends a FILEIOTESTRESULT message.
-    if (e.keySystem != EXTERNAL_CLEAR_KEY_FILE_IO_TEST_KEY_SYSTEM) {
-      failTest('Unexpected CDM file IO test result from ' + e.keySystem);
+    if (keySystem != EXTERNAL_CLEAR_KEY_FILE_IO_TEST_KEY_SYSTEM) {
+      failTest('Unexpected CDM file IO test result from ' + keySystem);
       return false;
     }
 
     // The test result is either '0' or '1' appended to the header.
     if (e.message.length != FILE_IO_TEST_RESULT_HEADER.length + 1)
       return false;
 
     var result_index = FILE_IO_TEST_RESULT_HEADER.length;
     return String.fromCharCode(e.message[result_index]) == 1;
   }
 
-  video.addEventListener('webkitneedkey', onNeedKey);
-  video.addEventListener('webkitkeymessage', onKeyMessage);
-  video.addEventListener('webkitkeyerror', function() {
-      setResultInTitle("KeyError");
-  });
-  video.addEventListener('webkitkeyadded', onKeyAdded);
+  if (usePrefixedEME) {
+    video.addEventListener('webkitneedkey', onNeedKey);
+    video.addEventListener('webkitkeymessage', onKeyMessage);
+    video.addEventListener('webkitkeyerror', function() {
+        setResultInTitle("KeyError");
+    });
+    video.addEventListener('webkitkeyadded', onKeyAdded);
+  } else {
+    video.addEventListener('needkey', onNeedKey);
+  }
   installTitleEventHandler(video, 'error');
 
   if (useMSE) {
     var mediaSource = loadMediaSource(mediaFile, mediaType,
                                       appendSourceCallbackFn);
     video.src = window.URL.createObjectURL(mediaSource);
   } else {
     video.src = mediaFile;
   }
+  if (!usePrefixedEME) {
+    mediaKeys = new MediaKeys(keySystem);

[ddorwin, 2014/03/04 21:18:48]

nit: Any reason not to do this at 328?

[jrummell, 2014/03/04 23:55:49]

Unprefixed tests timeout if done at 328.

[ddorwin, 2014/03/05 19:04:36]

Bug! Please file. I assume it is the setMediaKeys call that causes this. Do all
key systems time out? I assume CK passes because we have tests for that, right?
We need to add some setMediaKeys tests here once we fix that bug.

[jrummell, 2014/03/05 23:13:23]

Opened http://crbug.com/349546

+    video.setMediaKeys(mediaKeys);
+  }
 }
 
 function getInitDataFromKeyId(keyID) {
   var init_key_id = new Uint8Array(keyID.length);
   for(var i = 0; i < keyID.length; i++) {
     init_key_id[i] = keyID.charCodeAt(i);
   }
   return init_key_id;
 }
 
@@ skipping 19 matching lines @@
                     licenseRequestRetryDelayMs + 'ms.');
         setTimeout(requestLicense, licenseRequestRetryDelayMs, message);
       }
       else
         failTest('Bad license server response: ' + this.response);
     }
   }
   console.log('license request message', message.message);
   xmlhttp.send(message.message);
 }