shaka-player 3.1.3 → 3.2.2

package/lib/cea/cea708_service.js

@@ -18,12 +18,12 @@ goog.require('shaka.util.Error');
  */
 shaka.cea.Cea708Service = class {
   /**
-   * @param {!number} serviceNumber
+   * @param {number} serviceNumber
    */
   constructor(serviceNumber) {
     /**
      * Number for this specific service (1 - 63).
-     * @private {!number}
+     * @private {number}
      */
     this.serviceNumber_ = serviceNumber;
 
@@ -84,7 +84,7 @@ shaka.cea.Cea708Service = class {
 
   /**
    * Handles G0 group data.
-   * @param {!number} controlCode
+   * @param {number} controlCode
    * @private
    */
   handleG0_(controlCode) {
@@ -102,7 +102,7 @@ shaka.cea.Cea708Service = class {
 
   /**
    * Handles G1 group data.
-   * @param {!number} controlCode
+   * @param {number} controlCode
    * @private
    */
   handleG1_(controlCode) {
@@ -115,7 +115,7 @@ shaka.cea.Cea708Service = class {
 
   /**
    * Handles G2 group data.
-   * @param {!number} controlCode
+   * @param {number} controlCode
    * @private
    */
   handleG2_(controlCode) {
@@ -134,7 +134,7 @@ shaka.cea.Cea708Service = class {
 
   /**
    * Handles G3 group data.
-   * @param {!number} controlCode
+   * @param {number} controlCode
    * @private
    */
   handleG3_(controlCode) {
@@ -155,8 +155,8 @@ shaka.cea.Cea708Service = class {
 
   /**
    * Handles C0 group data.
-   * @param {!number} controlCode
-   * @param {!number} pts
+   * @param {number} controlCode
+   * @param {number} pts
    * @return {?shaka.cea.ICaptionDecoder.ClosedCaption}
    * @private
    */
@@ -206,8 +206,8 @@ shaka.cea.Cea708Service = class {
    * Processes C1 group data.
    * These are caption commands.
    * @param {!shaka.cea.DtvccPacket} dtvccPacket
-   * @param {!number} captionCommand
-   * @param {!number} pts in seconds
+   * @param {number} captionCommand
+   * @param {number} pts in seconds
    * @return {?shaka.cea.ICaptionDecoder.ClosedCaption}
    * @throws {!shaka.util.Error} a possible out-of-range buffer read.
    * @private
@@ -255,7 +255,7 @@ shaka.cea.Cea708Service = class {
   /**
    * Handles C2 group data.
    * @param {!shaka.cea.DtvccPacket} dtvccPacket
-   * @param {!number} controlCode
+   * @param {number} controlCode
    * @private
    */
   handleC2_(dtvccPacket, controlCode) {
@@ -273,7 +273,7 @@ shaka.cea.Cea708Service = class {
   /**
    * Handles C3 group data.
    * @param {!shaka.cea.DtvccPacket} dtvccPacket
-   * @param {!number} controlCode
+   * @param {number} controlCode
    * @private
    */
   handleC3_(dtvccPacket, controlCode) {
@@ -287,7 +287,7 @@ shaka.cea.Cea708Service = class {
   }
 
   /**
-   * @param {!number} windowNum
+   * @param {number} windowNum
    * @private
    */
   setCurrentWindow_(windowNum) {
@@ -300,8 +300,8 @@ shaka.cea.Cea708Service = class {
 
   /**
    * Yields each non-null window specified in the 8-bit bitmap.
-   * @param {!number} bitmap 8 bits corresponding to each of the 8 windows.
-   * @return {!Iterable.<!number>}
+   * @param {number} bitmap 8 bits corresponding to each of the 8 windows.
+   * @return {!Iterable.<number>}
    * @private
    */
   * getSpecifiedWindowIds_(bitmap) {
@@ -315,8 +315,8 @@ shaka.cea.Cea708Service = class {
   }
 
   /**
-   * @param {!number} windowsBitmap
-   * @param {!number} pts
+   * @param {number} windowsBitmap
+   * @param {number} pts
    * @return {?shaka.cea.ICaptionDecoder.ClosedCaption}
    * @private
    */
@@ -336,8 +336,8 @@ shaka.cea.Cea708Service = class {
   }
 
   /**
-   * @param {!number} windowsBitmap
-   * @param {!number} pts
+   * @param {number} windowsBitmap
+   * @param {number} pts
    * @private
    */
   displayWindows_(windowsBitmap, pts) {
@@ -353,8 +353,8 @@ shaka.cea.Cea708Service = class {
   }
 
   /**
-   * @param {!number} windowsBitmap
-   * @param {!number} pts
+   * @param {number} windowsBitmap
+   * @param {number} pts
    * @return {?shaka.cea.ICaptionDecoder.ClosedCaption}
    * @private
    */
@@ -374,8 +374,8 @@ shaka.cea.Cea708Service = class {
   }
 
   /**
-   * @param {!number} windowsBitmap
-   * @param {!number} pts
+   * @param {number} windowsBitmap
+   * @param {number} pts
    * @return {?shaka.cea.ICaptionDecoder.ClosedCaption}
    * @private
    */
@@ -399,8 +399,8 @@ shaka.cea.Cea708Service = class {
   }
 
   /**
-   * @param {!number} windowsBitmap
-   * @param {!number} pts
+   * @param {number} windowsBitmap
+   * @param {number} pts
    * @return {?shaka.cea.ICaptionDecoder.ClosedCaption}
    * @private
    */
@@ -422,7 +422,7 @@ shaka.cea.Cea708Service = class {
   /**
    * Emits anything currently present in any of the windows, and then
    * deletes all windows, cancels all delays, reinitializes the service.
-   * @param {!number} pts
+   * @param {number} pts
    * @return {?shaka.cea.ICaptionDecoder.ClosedCaption}
    * @private
    */
@@ -559,8 +559,8 @@ shaka.cea.Cea708Service = class {
 
   /**
    * @param {!shaka.cea.DtvccPacket} dtvccPacket
-   * @param {!number} windowNum
-   * @param {!number} pts
+   * @param {number} windowNum
+   * @param {number} pts
    * @throws {!shaka.util.Error}
    * @private
    */
@@ -612,10 +612,10 @@ shaka.cea.Cea708Service = class {
 
   /**
    * Maps 64 possible CEA-708 colors to 8 CSS colors.
-   * @param {!number} red value from 0-3
-   * @param {!number} green value from 0-3
-   * @param {!number} blue value from 0-3
-   * @return {!string}
+   * @param {number} red value from 0-3
+   * @param {number} green value from 0-3
+   * @param {number} blue value from 0-3
+   * @return {string}
    * @private
    */
   rgbColorToHex_(red, green, blue) {
@@ -636,34 +636,34 @@ shaka.cea.Cea708Service = class {
 };
 
 /**
- * @private @const {!number}
+ * @private @const {number}
  */
 shaka.cea.Cea708Service.ASCII_BACKSPACE = 0x08;
 
 /**
- * @private @const {!number}
+ * @private @const {number}
  */
 shaka.cea.Cea708Service.ASCII_FORM_FEED = 0x0c;
 
 /**
- * @private @const {!number}
+ * @private @const {number}
  */
 shaka.cea.Cea708Service.ASCII_CARRIAGE_RETURN = 0x0d;
 
 /**
- * @private @const {!number}
+ * @private @const {number}
  */
 shaka.cea.Cea708Service.ASCII_HOR_CARRIAGE_RETURN = 0x0e;
 
 /**
  * For extended control codes in block_data on CEA-708, byte 1 is 0x10.
- * @private @const {!number}
+ * @private @const {number}
  */
 shaka.cea.Cea708Service.EXT_CEA708_CTRL_CODE_BYTE1 = 0x10;
 
 /**
  * Holds characters mapping for bytes that are G2 control codes.
- * @private @const {!Map<!number, !string>}
+ * @private @const {!Map<number, string>}
  */
 shaka.cea.Cea708Service.G2Charset = new Map([
   [0x20, ' '], [0x21, '\xa0'], [0x25, '…'], [0x2a, 'Š'], [0x2c, 'Œ'],
@@ -675,7 +675,7 @@ shaka.cea.Cea708Service.G2Charset = new Map([
 
 /**
  * An array of 8 colors that 64 colors can be quantized to. Order here matters.
- * @private @const {!Array<!string>}
+ * @private @const {!Array<string>}
  */
 shaka.cea.Cea708Service.Colors = [
   'black', 'blue', 'green', 'cyan',
@@ -691,12 +691,12 @@ shaka.cea.Cea708Service.Colors = [
  *   order: number
  * }}
  *
- * @property {!number} pts
+ * @property {number} pts
  *   Presentation timestamp (in second) at which this packet was received.
- * @property {!number} type
+ * @property {number} type
  *   Type of the byte. Either 2 or 3, DTVCC Packet Data or a DTVCC Packet Start.
- * @property {!number} value The byte containing data relevant to the packet.
- * @property {!number} order
+ * @property {number} value The byte containing data relevant to the packet.
+ * @property {number} order
  *   A number indicating the order this packet was received in a sequence
  *   of packets. Used to break ties in a stable sorting algorithm
  */

package/lib/cea/cea708_window.js

@@ -18,38 +18,38 @@ goog.require('shaka.util.Functional');
  */
 shaka.cea.Cea708Window = class {
   /**
-   * @param {!number} windowNum
+   * @param {number} windowNum
    */
   constructor(windowNum) {
     /**
      * A number from 0 - 7 indicating the window number in the
      * service that owns this window.
-     * @private {!number}
+     * @private {number}
      */
     this.windowNum_ = windowNum;
 
     /**
      * Indicates whether this window is visible.
-     * @private {!boolean}
+     * @private {boolean}
      */
     this.visible_ = false;
 
     /**
      * Indicates whether the horizontal and vertical anchors coordinates specify
      * a percentage of the screen, or physical coordinates on the screen.
-     * @private {!boolean}
+     * @private {boolean}
      */
     this.relativeToggle_ = false;
 
     /**
      * Horizontal anchor. Loosely corresponds to a WebVTT viewport X anchor.
-     * @private {!number}
+     * @private {number}
      */
     this.horizontalAnchor_ = 0;
 
     /**
      * Vertical anchor. Loosely corresponds to a WebVTT viewport Y anchor.
-     * @private {!number}
+     * @private {number}
      */
     this.verticalAnchor_ = 0;
 
@@ -62,19 +62,19 @@ shaka.cea.Cea708Window = class {
      * 6________7________8
      * Diagram is valid as per CEA-708-E section 8.4.4.
      * Each of these locations corresponds to a WebVTT region's "region anchor".
-     * @private {!number}
+     * @private {number}
      */
     this.anchorId_ = 0;
 
     /**
      * Indicates the number of rows in this window's buffer/memory.
-     * @private {!number}
+     * @private {number}
      */
     this.rowCount_ = 0;
 
     /**
      * Indicates the number of columns in this window's buffer/memory.
-     * @private {!number}
+     * @private {number}
      */
     this.colCount_ = 0;
 
@@ -92,43 +92,43 @@ shaka.cea.Cea708Window = class {
     this.memory_ = [];
 
     /**
-     * @private {!number}
+     * @private {number}
      */
     this.startTime_ = 0;
 
     /**
      * Row that the current pen is pointing at.
-     * @private {!number}
+     * @private {number}
      */
     this.row_ = 0;
 
     /**
      * Column that the current pen is pointing at.
-     * @private {!number}
+     * @private {number}
      */
     this.col_ = 0;
 
     /**
      * Indicates whether the current pen position is italicized.
-     * @private {!boolean}
+     * @private {boolean}
      */
     this.italics_ = false;
 
     /**
      * Indicates whether the current pen position is underlined.
-     * @private {!boolean}
+     * @private {boolean}
      */
     this.underline_ = false;
 
     /**
      * Indicates the text color at the current pen position.
-     * @private {!string}
+     * @private {string}
      */
     this.textColor_ = shaka.cea.CeaUtils.DEFAULT_TXT_COLOR;
 
     /**
      * Indicates the background color at the current pen position.
-     * @private {!string}
+     * @private {string}
      */
     this.backgroundColor_ = shaka.cea.CeaUtils.DEFAULT_BG_COLOR;
 
@@ -141,13 +141,13 @@ shaka.cea.Cea708Window = class {
   }
 
   /**
-   * @param {!boolean} visible
-   * @param {!number} verticalAnchor
-   * @param {!number} horizontalAnchor
-   * @param {!number} anchorId
-   * @param {!boolean} relativeToggle
-   * @param {!number} rowCount
-   * @param {!number} colCount
+   * @param {boolean} visible
+   * @param {number} verticalAnchor
+   * @param {number} horizontalAnchor
+   * @param {number} anchorId
+   * @param {boolean} relativeToggle
+   * @param {number} rowCount
+   * @param {number} colCount
    */
   defineWindow(visible, verticalAnchor, horizontalAnchor, anchorId,
       relativeToggle, rowCount, colCount) {
@@ -185,7 +185,7 @@ shaka.cea.Cea708Window = class {
 
   /**
    * Sets the unicode value for a char at the current pen location.
-   * @param {!string} char
+   * @param {string} char
    */
   setCharacter(char) {
     // Check if the pen is out of bounds.
@@ -238,7 +238,7 @@ shaka.cea.Cea708Window = class {
   }
 
   /**
-   * @return {!boolean}
+   * @return {boolean}
    */
   isVisible() {
     return this.visible_;
@@ -246,7 +246,7 @@ shaka.cea.Cea708Window = class {
 
   /**
    * Moves up <count> rows in the buffer.
-   * @param {!number} count
+   * @param {number} count
    * @private
    */
   moveUpRows_(count) {
@@ -286,8 +286,8 @@ shaka.cea.Cea708Window = class {
   }
 
   /**
-   * @param {!number} endTime
-   * @param {!number} serviceNumber Number of the service emitting this caption.
+   * @param {number} endTime
+   * @param {number} serviceNumber Number of the service emitting this caption.
    * @return {?shaka.cea.ICaptionDecoder.ClosedCaption}
    */
   forceEmit(endTime, serviceNumber) {
@@ -318,8 +318,8 @@ shaka.cea.Cea708Window = class {
   }
 
   /**
-   * @param {!number} row
-   * @param {!number} col
+   * @param {number} row
+   * @param {number} col
    */
   setPenLocation(row, col) {
     this.row_ = row;
@@ -327,28 +327,28 @@ shaka.cea.Cea708Window = class {
   }
 
   /**
-   * @param {!string} backgroundColor
+   * @param {string} backgroundColor
    */
   setPenBackgroundColor(backgroundColor) {
     this.backgroundColor_ = backgroundColor;
   }
 
   /**
-   * @param {!string} textColor
+   * @param {string} textColor
    */
   setPenTextColor(textColor) {
     this.textColor_ = textColor;
   }
 
   /**
-   * @param {!boolean} underline
+   * @param {boolean} underline
    */
   setPenUnderline(underline) {
     this.underline_ = underline;
   }
 
   /**
-   * @param {!boolean} italics
+   * @param {boolean} italics
    */
   setPenItalics(italics) {
     this.italics_ = italics;
@@ -394,7 +394,7 @@ shaka.cea.Cea708Window = class {
 
   /**
    * Sets the start time for the cue to be emitted.
-   * @param {!number} pts
+   * @param {number} pts
    */
   setStartTime(pts) {
     this.startTime_ = pts;
@@ -403,7 +403,7 @@ shaka.cea.Cea708Window = class {
 
 /**
  * Caption type.
- * @const @enum {!number}
+ * @const @enum {number}
  */
 shaka.cea.Cea708Window.TextJustification = {
   LEFT: 0,
@@ -415,12 +415,12 @@ shaka.cea.Cea708Window.TextJustification = {
 /**
  * Can be indexed 0-31 for 4:3 format, and 0-41 for 16:9 formats.
  * Thus the absolute maximum is 42 columns for the 16:9 format.
- * @private @const {!number}
+ * @private @const {number}
  */
 shaka.cea.Cea708Window.MAX_COLS = 42;
 
 /**
  * Maximum of 15 rows that can be indexed from 0 to 14.
- * @private @const {!number}
+ * @private @const {number}
  */
 shaka.cea.Cea708Window.MAX_ROWS = 15;

package/lib/cea/cea_decoder.js

@@ -6,15 +6,14 @@
 
 goog.provide('shaka.cea.CeaDecoder');
 
-goog.require('shaka.cea.Cea708Service');
 goog.require('shaka.cea.Cea608DataChannel');
+goog.require('shaka.cea.Cea708Service');
 goog.require('shaka.cea.DtvccPacketBuilder');
 goog.require('shaka.cea.ICaptionDecoder');
 goog.require('shaka.log');
 goog.require('shaka.util.DataViewReader');
 goog.require('shaka.util.Error');
 goog.requireType('shaka.cea.DtvccPacket');
-goog.requireType('shaka.cea.ICaptionDecoder.ClosedCaption');
 
 
 /**
@@ -44,13 +43,13 @@ shaka.cea.CeaDecoder = class {
 
     /**
      * Number of consecutive bad frames decoded on CEA-608.
-     * @private {!number}
+     * @private {number}
      */
     this.badFrames_ = 0;
 
     /**
      * A map containing the stream for each mode.
-     * @private {!Map<!string, !shaka.cea.Cea608DataChannel>}
+     * @private {!Map<string, !shaka.cea.Cea608DataChannel>}
      */
     this.cea608ModeToStream_ = new Map([
       ['CC1', new shaka.cea.Cea608DataChannel(0, 0)], // F1 + C1 -> CC1
@@ -61,20 +60,20 @@ shaka.cea.CeaDecoder = class {
 
     /**
      * The current channel that is active on CEA-608 field 1.
-     * @private {!number}
+     * @private {number}
      */
     this.currentField1Channel_ = 0;
 
     /**
      * The current channel that is active on CEA-608 field 2.
-     * @private {!number}
+     * @private {number}
      */
     this.currentField2Channel_ = 0;
 
     /**
      * Map of service number to CEA-708 services, initially empty. Since there
      * can be up to 63 services, they are created dynamically only when needed.
-     * @private {!Map<!number, shaka.cea.Cea708Service>}
+     * @private {!Map<number, shaka.cea.Cea708Service>}
      */
     this.serviceNumberToService_ = new Map();
 
@@ -361,8 +360,8 @@ shaka.cea.CeaDecoder = class {
 
   /**
    * Checks if a byte has odd parity (Odd number of 1s in binary).
-   * @param {!number} byte
-   * @return {!boolean} True if the byte has odd parity.
+   * @param {number} byte
+   * @return {boolean} True if the byte has odd parity.
    * @private
    */
   isOddParity_(byte) {
@@ -377,29 +376,29 @@ shaka.cea.CeaDecoder = class {
 
 /**
  * itu_t_35_provider_code for ATSC user_data
- * @private @const {!number}
+ * @private @const {number}
  */
 shaka.cea.CeaDecoder.ATSC_PROVIDER_CODE = 0x0031;
 
 /**
  * When provider is ATSC user data, the ATSC_user_identifier code
  * for ATSC1_data is "GA94" (0x47413934)
- * @private @const {!number}
+ * @private @const {number}
  */
 shaka.cea.CeaDecoder.ATSC1_USER_IDENTIFIER = 0x47413934;
 
 /**
- * @private @const {!number}
+ * @private @const {number}
  */
 shaka.cea.CeaDecoder.NTSC_CC_FIELD_1 = 0;
 
 /**
- * @private @const {!number}
+ * @private @const {number}
  */
 shaka.cea.CeaDecoder.NTSC_CC_FIELD_2 = 1;
 
 /**
  * 0xB5 is USA's code (Rec. ITU-T T.35)
- * @private @const {!number}
+ * @private @const {number}
  */
 shaka.cea.CeaDecoder.USA_COUNTRY_CODE = 0xb5;