Source: lib/media/content_workarounds.js

  1. /*! @license
  2.  * Shaka Player
  3.  * Copyright 2016 Google LLC
  4.  * SPDX-License-Identifier: Apache-2.0
  5.  */
  7. goog.provide('shaka.media.ContentWorkarounds');
  9. goog.require('goog.asserts');
  10. goog.require('shaka.log');
  11. goog.require('shaka.util.BufferUtils');
  12. goog.require('shaka.util.Error');
  13. goog.require('shaka.util.Lazy');
  14. goog.require('shaka.util.Mp4Parser');
  15. goog.require('shaka.util.Platform');
  16. goog.require('shaka.util.Uint8ArrayUtils');
  19. /**
  20.  * @summary
  21.  * A collection of methods to work around content issues on various platforms.
  22.  */
  23. shaka.media.ContentWorkarounds = class {
  24.   /**
  25.    * Transform the init segment into a new init segment buffer that indicates
  26.    * encryption.  If the init segment already indicates encryption, return the
  27.    * original init segment.
  28.    *
  29.    * Should only be called for MP4 init segments, and only on platforms that
  30.    * need this workaround.
  31.    *
  32.    * @param {!BufferSource} initSegmentBuffer
  33.    * @param {?string} uri
  34.    * @return {!Uint8Array}
  35.    * @see https://github.com/shaka-project/shaka-player/issues/2759
  36.    */
  37.   static fakeEncryption(initSegmentBuffer, uri) {
  38.     const ContentWorkarounds = shaka.media.ContentWorkarounds;
  39.     const initSegment = shaka.util.BufferUtils.toUint8(initSegmentBuffer);
  40.     let modifiedInitSegment = initSegment;
  41.     let isEncrypted = false;
  42.     /** @type {shaka.extern.ParsedBox} */
  43.     let stsdBox;
  44.     const ancestorBoxes = [];
  46.     const onSimpleAncestorBox = (box) => {
  47.       ancestorBoxes.push(box);
  48.       shaka.util.Mp4Parser.children(box);
  49.     };
  51.     const onEncryptionMetadataBox = (box) => {
  52.       isEncrypted = true;
  53.     };
  55.     // Multiplexed content could have multiple boxes that we need to modify.
  56.     // Add to this array in order of box offset.  This will be important later,
  57.     // when we process the boxes.
  58.     /** @type {!Array.<{box: shaka.extern.ParsedBox, newType: number}>} */
  59.     const boxesToModify = [];
  61.     new shaka.util.Mp4Parser()
  62.         .box('moov', onSimpleAncestorBox)
  63.         .box('trak', onSimpleAncestorBox)
  64.         .box('mdia', onSimpleAncestorBox)
  65.         .box('minf', onSimpleAncestorBox)
  66.         .box('stbl', onSimpleAncestorBox)
  67.         .fullBox('stsd', (box) => {
  68.           stsdBox = box;
  69.           ancestorBoxes.push(box);
  70.           shaka.util.Mp4Parser.sampleDescription(box);
  71.         })
  72.         .fullBox('encv', onEncryptionMetadataBox)
  73.         .fullBox('enca', onEncryptionMetadataBox)
  74.         .fullBox('dvav', (box) => {
  75.           boxesToModify.push({
  76.             box,
  77.             newType: ContentWorkarounds.BOX_TYPE_ENCV_,
  78.           });
  79.         })
  80.         .fullBox('dva1', (box) => {
  81.           boxesToModify.push({
  82.             box,
  83.             newType: ContentWorkarounds.BOX_TYPE_ENCV_,
  84.           });
  85.         })
  86.         .fullBox('dvh1', (box) => {
  87.           boxesToModify.push({
  88.             box,
  89.             newType: ContentWorkarounds.BOX_TYPE_ENCV_,
  90.           });
  91.         })
  92.         .fullBox('dvhe', (box) => {
  93.           boxesToModify.push({
  94.             box,
  95.             newType: ContentWorkarounds.BOX_TYPE_ENCV_,
  96.           });
  97.         })
  98.         .fullBox('hev1', (box) => {
  99.           boxesToModify.push({
  100.             box,
  101.             newType: ContentWorkarounds.BOX_TYPE_ENCV_,
  102.           });
  103.         })
  104.         .fullBox('hvc1', (box) => {
  105.           boxesToModify.push({
  106.             box,
  107.             newType: ContentWorkarounds.BOX_TYPE_ENCV_,
  108.           });
  109.         })
  110.         .fullBox('avc1', (box) => {
  111.           boxesToModify.push({
  112.             box,
  113.             newType: ContentWorkarounds.BOX_TYPE_ENCV_,
  114.           });
  115.         })
  116.         .fullBox('avc3', (box) => {
  117.           boxesToModify.push({
  118.             box,
  119.             newType: ContentWorkarounds.BOX_TYPE_ENCV_,
  120.           });
  121.         })
  122.         .fullBox('ac-3', (box) => {
  123.           boxesToModify.push({
  124.             box,
  125.             newType: ContentWorkarounds.BOX_TYPE_ENCA_,
  126.           });
  127.         })
  128.         .fullBox('ec-3', (box) => {
  129.           boxesToModify.push({
  130.             box,
  131.             newType: ContentWorkarounds.BOX_TYPE_ENCA_,
  132.           });
  133.         })
  134.         .fullBox('ac-4', (box) => {
  135.           boxesToModify.push({
  136.             box,
  137.             newType: ContentWorkarounds.BOX_TYPE_ENCA_,
  138.           });
  139.         })
  140.         .fullBox('mp4a', (box) => {
  141.           boxesToModify.push({
  142.             box,
  143.             newType: ContentWorkarounds.BOX_TYPE_ENCA_,
  144.           });
  145.         }).parse(initSegment);
  147.     if (isEncrypted) {
  148.       shaka.log.debug('Init segment already indicates encryption.');
  149.       return initSegment;
  150.     }
  152.     if (boxesToModify.length == 0 || !stsdBox) {
  153.       shaka.log.error('Failed to find boxes needed to fake encryption!');
  154.       shaka.log.v2('Failed init segment (hex):',
  155.           shaka.util.Uint8ArrayUtils.toHex(initSegment));
  156.       throw new shaka.util.Error(
  157.           shaka.util.Error.Severity.CRITICAL,
  158.           shaka.util.Error.Category.MEDIA,
  159.           shaka.util.Error.Code.CONTENT_TRANSFORMATION_FAILED,
  160.           uri);
  161.     }
  163.     // Modify boxes in order from largest offset to smallest, so that earlier
  164.     // boxes don't have their offsets changed before we process them.
  165.     boxesToModify.reverse();  // in place!
  166.     for (const workItem of boxesToModify) {
  167.       const insertedBoxType =
  168.           shaka.util.Mp4Parser.typeToString(workItem.newType);
  169.       shaka.log.debug(`Inserting "${insertedBoxType}" box into init segment.`);
  170.       modifiedInitSegment = ContentWorkarounds.insertEncryptionMetadata_(
  171.           modifiedInitSegment, stsdBox, workItem.box, ancestorBoxes,
  172.           workItem.newType);
  173.     }
  175.     // Edge Windows needs the unmodified init segment to be appended after the
  176.     // patched one, otherwise video element throws following error:
  177.     // CHUNK_DEMUXER_ERROR_APPEND_FAILED: Sample encryption info is not
  178.     // available.
  179.     if (shaka.util.Platform.isEdge() && shaka.util.Platform.isWindows()) {
  180.       const doubleInitSegment = new Uint8Array(initSegment.byteLength +
  181.         modifiedInitSegment.byteLength);
  182.       doubleInitSegment.set(modifiedInitSegment);
  183.       doubleInitSegment.set(initSegment, modifiedInitSegment.byteLength);
  184.       return doubleInitSegment;
  185.     }
  187.     return modifiedInitSegment;
  188.   }
  190.   /**
  191.    * Insert an encryption metadata box ("encv" or "enca" box) into the MP4 init
  192.    * segment, based on the source box ("mp4a", "avc1", etc).  Returns a new
  193.    * buffer containing the modified init segment.
  194.    *
  195.    * @param {!Uint8Array} initSegment
  196.    * @param {shaka.extern.ParsedBox} stsdBox
  197.    * @param {shaka.extern.ParsedBox} sourceBox
  198.    * @param {!Array.<shaka.extern.ParsedBox>} ancestorBoxes
  199.    * @param {number} metadataBoxType
  200.    * @return {!Uint8Array}
  201.    * @private
  202.    */
  203.   static insertEncryptionMetadata_(
  204.       initSegment, stsdBox, sourceBox, ancestorBoxes, metadataBoxType) {
  205.     const ContentWorkarounds = shaka.media.ContentWorkarounds;
  206.     const metadataBoxArray = ContentWorkarounds.createEncryptionMetadata_(
  207.         initSegment, sourceBox, metadataBoxType);
  209.     // Construct a new init segment array with room for the encryption metadata
  210.     // box we're adding.
  211.     const newInitSegment =
  212.         new Uint8Array(initSegment.byteLength + metadataBoxArray.byteLength);
  214.     // For Xbox One & Edge, we cut and insert at the start of the source box.
  215.     // For other platforms, we cut and insert at the end of the source box. It's
  216.     // not clear why this is necessary on Xbox One, but it seems to be evidence
  217.     // of another bug in the firmware implementation of MediaSource & EME.
  218.     const cutPoint =
  219.       (shaka.util.Platform.isXboxOne() || shaka.util.Platform.isEdge()) ?
  220.         sourceBox.start :
  221.         sourceBox.start + sourceBox.size;
  223.     // The data before the cut point will be copied to the same location as
  224.     // before.  The data after that will be appended after the added metadata
  225.     // box.
  226.     const beforeData = initSegment.subarray(0, cutPoint);
  227.     const afterData = initSegment.subarray(cutPoint);
  229.     newInitSegment.set(beforeData);
  230.     newInitSegment.set(metadataBoxArray, cutPoint);
  231.     newInitSegment.set(afterData, cutPoint + metadataBoxArray.byteLength);
  233.     // The parents up the chain from the encryption metadata box need their
  234.     // sizes adjusted to account for the added box.  These offsets should not be
  235.     // changed, because they should all be within the first section we copy.
  236.     for (const box of ancestorBoxes) {
  237.       goog.asserts.assert(box.start < cutPoint,
  238.           'Ancestor MP4 box found in the wrong location!  ' +
  239.           'Modified init segment will not make sense!');
  240.       ContentWorkarounds.updateBoxSize_(
  241.           newInitSegment, box.start, box.size + metadataBoxArray.byteLength);
  242.     }
  244.     // Add one to the sample entries field of the "stsd" box.  This is a 4-byte
  245.     // field just past the box header.
  246.     const stsdBoxView = shaka.util.BufferUtils.toDataView(
  247.         newInitSegment, stsdBox.start);
  248.     const stsdBoxHeaderSize = shaka.util.Mp4Parser.headerSize(stsdBox);
  249.     const numEntries = stsdBoxView.getUint32(stsdBoxHeaderSize);
  250.     stsdBoxView.setUint32(stsdBoxHeaderSize, numEntries + 1);
  252.     return newInitSegment;
  253.   }
  255.   /**
  256.    * Create an encryption metadata box ("encv" or "enca" box), based on the
  257.    * source box ("mp4a", "avc1", etc).  Returns a new buffer containing the
  258.    * encryption metadata box.
  259.    *
  260.    * @param {!Uint8Array} initSegment
  261.    * @param {shaka.extern.ParsedBox} sourceBox
  262.    * @param {number} metadataBoxType
  263.    * @return {!Uint8Array}
  264.    * @private
  265.    */
  266.   static createEncryptionMetadata_(initSegment, sourceBox, metadataBoxType) {
  267.     const ContentWorkarounds = shaka.media.ContentWorkarounds;
  268.     const sinfBoxArray = ContentWorkarounds.CANNED_SINF_BOX_.value();
  270.     // Create a subarray which points to the source box data.
  271.     const sourceBoxArray = initSegment.subarray(
  272.         /* start= */ sourceBox.start,
  273.         /* end= */ sourceBox.start + sourceBox.size);
  275.     // Create a view on the source box array.
  276.     const sourceBoxView = shaka.util.BufferUtils.toDataView(sourceBoxArray);
  278.     // Create an array to hold the new encryption metadata box, which is based
  279.     // on the source box.
  280.     const metadataBoxArray = new Uint8Array(
  281.         sourceBox.size + sinfBoxArray.byteLength);
  283.     // Copy the source box into the new array.
  284.     metadataBoxArray.set(sourceBoxArray, /* targetOffset= */ 0);
  286.     // Change the box type.
  287.     const metadataBoxView = shaka.util.BufferUtils.toDataView(metadataBoxArray);
  288.     metadataBoxView.setUint32(
  289.         ContentWorkarounds.BOX_TYPE_OFFSET_, metadataBoxType);
  291.     // Append the "sinf" box to the encryption metadata box.
  292.     metadataBoxArray.set(sinfBoxArray, /* targetOffset= */ sourceBox.size);
  294.     // Update the "sinf" box's format field (in the child "frma" box) to reflect
  295.     // the format of the original source box.
  296.     const sourceBoxType = sourceBoxView.getUint32(
  297.         ContentWorkarounds.BOX_TYPE_OFFSET_);
  298.     metadataBoxView.setUint32(
  299.         sourceBox.size + ContentWorkarounds.CANNED_SINF_BOX_FORMAT_OFFSET_,
  300.         sourceBoxType);
  302.     // Now update the encryption metadata box size.
  303.     ContentWorkarounds.updateBoxSize_(
  304.         metadataBoxArray, /* boxStart= */ 0, metadataBoxArray.byteLength);
  306.     return metadataBoxArray;
  307.   }
  309.   /**
  310.    * Modify an MP4 box's size field in-place.
  311.    *
  312.    * @param {!Uint8Array} dataArray
  313.    * @param {number} boxStart The start position of the box in dataArray.
  314.    * @param {number} newBoxSize The new size of the box.
  315.    * @private
  316.    */
  317.   static updateBoxSize_(dataArray, boxStart, newBoxSize) {
  318.     const ContentWorkarounds = shaka.media.ContentWorkarounds;
  319.     const boxView = shaka.util.BufferUtils.toDataView(dataArray, boxStart);
  320.     const sizeField = boxView.getUint32(ContentWorkarounds.BOX_SIZE_OFFSET_);
  321.     if (sizeField == 0) { // Means "the rest of the box".
  322.       // No adjustment needed for this box.
  323.     } else if (sizeField == 1) { // Means "use 64-bit size box".
  324.       // Set the 64-bit int in two 32-bit parts.
  325.       // The high bits should definitely be 0 in practice, but we're being
  326.       // thorough here.
  327.       boxView.setUint32(ContentWorkarounds.BOX_SIZE_64_OFFSET_,
  328.           newBoxSize >> 32);
  329.       boxView.setUint32(ContentWorkarounds.BOX_SIZE_64_OFFSET_ + 4,
  330.           newBoxSize & 0xffffffff);
  331.     } else { // Normal 32-bit size field.
  332.       // Not checking the size of the value here, since a box larger than 4GB is
  333.       // unrealistic.
  334.       boxView.setUint32(ContentWorkarounds.BOX_SIZE_OFFSET_, newBoxSize);
  335.     }
  336.   }
  337. };
  339. /**
  340.  * A canned "sinf" box for use when adding fake encryption metadata to init
  341.  * segments.
  342.  *
  343.  * @const {!shaka.util.Lazy.<!Uint8Array>}
  344.  * @private
  345.  * @see https://github.com/shaka-project/shaka-player/issues/2759
  346.  */
  347. shaka.media.ContentWorkarounds.CANNED_SINF_BOX_ =
  348.     new shaka.util.Lazy(() => new Uint8Array([
  349.       // sinf box
  350.       // Size: 0x50 = 80
  351.       0x00, 0x00, 0x00, 0x50,
  353.       // Type: sinf
  354.       0x73, 0x69, 0x6e, 0x66,
  356.       // Children of sinf...
  358.       // frma box
  359.       // Size: 0x0c = 12
  360.       0x00, 0x00, 0x00, 0x0c,
  362.       // Type: frma (child of sinf)
  363.       0x66, 0x72, 0x6d, 0x61,
  365.       // Format: filled in later based on the source box ("avc1", "mp4a", etc)
  366.       0x00, 0x00, 0x00, 0x00,
  367.       // end of frma box
  369.       // schm box
  370.       // Size: 0x14 = 20
  371.       0x00, 0x00, 0x00, 0x14,
  373.       // Type: schm (child of sinf)
  374.       0x73, 0x63, 0x68, 0x6d,
  376.       // Version: 0, Flags: 0
  377.       0x00, 0x00, 0x00, 0x00,
  379.       // Scheme: cenc
  380.       0x63, 0x65, 0x6e, 0x63,
  382.       // Scheme version: 1.0
  383.       0x00, 0x01, 0x00, 0x00,
  384.       // end of schm box
  386.       // schi box
  387.       // Size: 0x28 = 40
  388.       0x00, 0x00, 0x00, 0x28,
  390.       // Type: schi (child of sinf)
  391.       0x73, 0x63, 0x68, 0x69,
  393.       // Children of schi...
  395.       // tenc box
  396.       // Size: 0x20 = 32
  397.       0x00, 0x00, 0x00, 0x20,
  399.       // Type: tenc (child of schi)
  400.       0x74, 0x65, 0x6e, 0x63,
  402.       // Version: 0, Flags: 0
  403.       0x00, 0x00, 0x00, 0x00,
  405.       // Reserved fields
  406.       0x00, 0x00,
  408.       // Default protected: true
  409.       0x01,
  411.       // Default per-sample IV size: 8
  412.       0x08,
  414.       // Default key ID: all zeros (dummy)
  415.       0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
  416.       0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
  417.       // end of tenc box
  419.       // end of schi box
  421.       // end of sinf box
  422.     ]));
  424. /**
  425.  * The location of the format field in the "frma" box inside the canned "sinf"
  426.  * box above.
  427.  *
  428.  * @const {number}
  429.  * @private
  430.  */
  431. shaka.media.ContentWorkarounds.CANNED_SINF_BOX_FORMAT_OFFSET_ = 0x10;
  433. /**
  434.  * Offset to a box's size field.
  435.  *
  436.  * @const {number}
  437.  * @private
  438.  */
  439. shaka.media.ContentWorkarounds.BOX_SIZE_OFFSET_ = 0;
  441. /**
  442.  * Offset to a box's type field.
  443.  *
  444.  * @const {number}
  445.  * @private
  446.  */
  447. shaka.media.ContentWorkarounds.BOX_TYPE_OFFSET_ = 4;
  449. /**
  450.  * Offset to a box's 64-bit size field, if it has one.
  451.  *
  452.  * @const {number}
  453.  * @private
  454.  */
  455. shaka.media.ContentWorkarounds.BOX_SIZE_64_OFFSET_ = 8;
  457. /**
  458.  * Box type for "encv".
  459.  *
  460.  * @const {number}
  461.  * @private
  462.  */
  463. shaka.media.ContentWorkarounds.BOX_TYPE_ENCV_ = 0x656e6376;
  465. /**
  466.  * Box type for "enca".
  467.  *
  468.  * @const {number}
  469.  * @private
  470.  */
  471. shaka.media.ContentWorkarounds.BOX_TYPE_ENCA_ = 0x656e6361;