caption-stream.js 52 KB
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684 1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 1726 1727 1728 1729 1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 1741 1742 1743 1744 1745 1746 1747 1748 1749 1750 1751 1752 1753 1754 1755 1756 1757 1758 1759 1760 1761 1762 1763 1764 1765 1766 1767 1768 1769 1770 1771 1772 1773 1774 1775 1776 1777 1778 1779 1780 1781 1782 1783 1784 1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800 1801 1802 1803 1804 1805 1806 1807 1808 1809 1810 1811 1812 1813 1814 1815 1816 1817 1818 1819 1820 1821 1822 1823 1824 1825 1826 1827 1828 1829 1830 1831 1832 1833 1834 1835 1836 1837 1838 1839 1840 1841 1842 1843 1844 1845 1846 1847 1848 1849 1850 1851 1852 1853 1854 1855 1856 1857 1858 1859 1860 1861 1862 1863 1864 1865 1866 1867 1868 1869 1870 1871 1872 1873 1874 1875 1876 1877 1878 1879 1880 1881 1882 1883 1884 1885 1886 1887
/**
 * mux.js
 *
 * Copyright (c) Brightcove
 * Licensed Apache-2.0 https://github.com/videojs/mux.js/blob/master/LICENSE
 *
 * Reads in-band caption information from a video elementary
 * stream. Captions must follow the CEA-708 standard for injection
 * into an MPEG-2 transport streams.
 * @see https://en.wikipedia.org/wiki/CEA-708
 * @see https://www.gpo.gov/fdsys/pkg/CFR-2007-title47-vol1/pdf/CFR-2007-title47-vol1-sec15-119.pdf
 */
'use strict'; // -----------------
// Link To Transport
// -----------------

var Stream = require('../utils/stream');

var cea708Parser = require('../tools/caption-packet-parser');

var CaptionStream = function CaptionStream(options) {
  options = options || {};
  CaptionStream.prototype.init.call(this); // parse708captions flag, default to true

  this.parse708captions_ = typeof options.parse708captions === 'boolean' ? options.parse708captions : true;
  this.captionPackets_ = [];
  this.ccStreams_ = [new Cea608Stream(0, 0), // eslint-disable-line no-use-before-define
  new Cea608Stream(0, 1), // eslint-disable-line no-use-before-define
  new Cea608Stream(1, 0), // eslint-disable-line no-use-before-define
  new Cea608Stream(1, 1) // eslint-disable-line no-use-before-define
  ];

  if (this.parse708captions_) {
    this.cc708Stream_ = new Cea708Stream({
      captionServices: options.captionServices
    }); // eslint-disable-line no-use-before-define
  }

  this.reset(); // forward data and done events from CCs to this CaptionStream

  this.ccStreams_.forEach(function (cc) {
    cc.on('data', this.trigger.bind(this, 'data'));
    cc.on('partialdone', this.trigger.bind(this, 'partialdone'));
    cc.on('done', this.trigger.bind(this, 'done'));
  }, this);

  if (this.parse708captions_) {
    this.cc708Stream_.on('data', this.trigger.bind(this, 'data'));
    this.cc708Stream_.on('partialdone', this.trigger.bind(this, 'partialdone'));
    this.cc708Stream_.on('done', this.trigger.bind(this, 'done'));
  }
};

CaptionStream.prototype = new Stream();

CaptionStream.prototype.push = function (event) {
  var sei, userData, newCaptionPackets; // only examine SEI NALs

  if (event.nalUnitType !== 'sei_rbsp') {
    return;
  } // parse the sei


  sei = cea708Parser.parseSei(event.escapedRBSP); // no payload data, skip

  if (!sei.payload) {
    return;
  } // ignore everything but user_data_registered_itu_t_t35


  if (sei.payloadType !== cea708Parser.USER_DATA_REGISTERED_ITU_T_T35) {
    return;
  } // parse out the user data payload


  userData = cea708Parser.parseUserData(sei); // ignore unrecognized userData

  if (!userData) {
    return;
  } // Sometimes, the same segment # will be downloaded twice. To stop the
  // caption data from being processed twice, we track the latest dts we've
  // received and ignore everything with a dts before that. However, since
  // data for a specific dts can be split across packets on either side of
  // a segment boundary, we need to make sure we *don't* ignore the packets
  // from the *next* segment that have dts === this.latestDts_. By constantly
  // tracking the number of packets received with dts === this.latestDts_, we
  // know how many should be ignored once we start receiving duplicates.


  if (event.dts < this.latestDts_) {
    // We've started getting older data, so set the flag.
    this.ignoreNextEqualDts_ = true;
    return;
  } else if (event.dts === this.latestDts_ && this.ignoreNextEqualDts_) {
    this.numSameDts_--;

    if (!this.numSameDts_) {
      // We've received the last duplicate packet, time to start processing again
      this.ignoreNextEqualDts_ = false;
    }

    return;
  } // parse out CC data packets and save them for later


  newCaptionPackets = cea708Parser.parseCaptionPackets(event.pts, userData);
  this.captionPackets_ = this.captionPackets_.concat(newCaptionPackets);

  if (this.latestDts_ !== event.dts) {
    this.numSameDts_ = 0;
  }

  this.numSameDts_++;
  this.latestDts_ = event.dts;
};

CaptionStream.prototype.flushCCStreams = function (flushType) {
  this.ccStreams_.forEach(function (cc) {
    return flushType === 'flush' ? cc.flush() : cc.partialFlush();
  }, this);
};

CaptionStream.prototype.flushStream = function (flushType) {
  // make sure we actually parsed captions before proceeding
  if (!this.captionPackets_.length) {
    this.flushCCStreams(flushType);
    return;
  } // In Chrome, the Array#sort function is not stable so add a
  // presortIndex that we can use to ensure we get a stable-sort


  this.captionPackets_.forEach(function (elem, idx) {
    elem.presortIndex = idx;
  }); // sort caption byte-pairs based on their PTS values

  this.captionPackets_.sort(function (a, b) {
    if (a.pts === b.pts) {
      return a.presortIndex - b.presortIndex;
    }

    return a.pts - b.pts;
  });
  this.captionPackets_.forEach(function (packet) {
    if (packet.type < 2) {
      // Dispatch packet to the right Cea608Stream
      this.dispatchCea608Packet(packet);
    } else {
      // Dispatch packet to the Cea708Stream
      this.dispatchCea708Packet(packet);
    }
  }, this);
  this.captionPackets_.length = 0;
  this.flushCCStreams(flushType);
};

CaptionStream.prototype.flush = function () {
  return this.flushStream('flush');
}; // Only called if handling partial data


CaptionStream.prototype.partialFlush = function () {
  return this.flushStream('partialFlush');
};

CaptionStream.prototype.reset = function () {
  this.latestDts_ = null;
  this.ignoreNextEqualDts_ = false;
  this.numSameDts_ = 0;
  this.activeCea608Channel_ = [null, null];
  this.ccStreams_.forEach(function (ccStream) {
    ccStream.reset();
  });
}; // From the CEA-608 spec:

/*
 * When XDS sub-packets are interleaved with other services, the end of each sub-packet shall be followed
 * by a control pair to change to a different service. When any of the control codes from 0x10 to 0x1F is
 * used to begin a control code pair, it indicates the return to captioning or Text data. The control code pair
 * and subsequent data should then be processed according to the FCC rules. It may be necessary for the
 * line 21 data encoder to automatically insert a control code pair (i.e. RCL, RU2, RU3, RU4, RDC, or RTD)
 * to switch to captioning or Text.
*/
// With that in mind, we ignore any data between an XDS control code and a
// subsequent closed-captioning control code.


CaptionStream.prototype.dispatchCea608Packet = function (packet) {
  // NOTE: packet.type is the CEA608 field
  if (this.setsTextOrXDSActive(packet)) {
    this.activeCea608Channel_[packet.type] = null;
  } else if (this.setsChannel1Active(packet)) {
    this.activeCea608Channel_[packet.type] = 0;
  } else if (this.setsChannel2Active(packet)) {
    this.activeCea608Channel_[packet.type] = 1;
  }

  if (this.activeCea608Channel_[packet.type] === null) {
    // If we haven't received anything to set the active channel, or the
    // packets are Text/XDS data, discard the data; we don't want jumbled
    // captions
    return;
  }

  this.ccStreams_[(packet.type << 1) + this.activeCea608Channel_[packet.type]].push(packet);
};

CaptionStream.prototype.setsChannel1Active = function (packet) {
  return (packet.ccData & 0x7800) === 0x1000;
};

CaptionStream.prototype.setsChannel2Active = function (packet) {
  return (packet.ccData & 0x7800) === 0x1800;
};

CaptionStream.prototype.setsTextOrXDSActive = function (packet) {
  return (packet.ccData & 0x7100) === 0x0100 || (packet.ccData & 0x78fe) === 0x102a || (packet.ccData & 0x78fe) === 0x182a;
};

CaptionStream.prototype.dispatchCea708Packet = function (packet) {
  if (this.parse708captions_) {
    this.cc708Stream_.push(packet);
  }
}; // ----------------------
// Session to Application
// ----------------------
// This hash maps special and extended character codes to their
// proper Unicode equivalent. The first one-byte key is just a
// non-standard character code. The two-byte keys that follow are
// the extended CEA708 character codes, along with the preceding
// 0x10 extended character byte to distinguish these codes from
// non-extended character codes. Every CEA708 character code that
// is not in this object maps directly to a standard unicode
// character code.
// The transparent space and non-breaking transparent space are
// technically not fully supported since there is no code to
// make them transparent, so they have normal non-transparent
// stand-ins.
// The special closed caption (CC) character isn't a standard
// unicode character, so a fairly similar unicode character was
// chosen in it's place.


var CHARACTER_TRANSLATION_708 = {
  0x7f: 0x266a,
  // ♪
  0x1020: 0x20,
  // Transparent Space
  0x1021: 0xa0,
  // Nob-breaking Transparent Space
  0x1025: 0x2026,
  // …
  0x102a: 0x0160,
  // Š
  0x102c: 0x0152,
  // Œ
  0x1030: 0x2588,
  // █
  0x1031: 0x2018,
  // ‘
  0x1032: 0x2019,
  // ’
  0x1033: 0x201c,
  // “
  0x1034: 0x201d,
  // ”
  0x1035: 0x2022,
  // •
  0x1039: 0x2122,
  // ™
  0x103a: 0x0161,
  // š
  0x103c: 0x0153,
  // œ
  0x103d: 0x2120,
  // ℠
  0x103f: 0x0178,
  // Ÿ
  0x1076: 0x215b,
  // ⅛
  0x1077: 0x215c,
  // ⅜
  0x1078: 0x215d,
  // ⅝
  0x1079: 0x215e,
  // ⅞
  0x107a: 0x23d0,
  // ⏐
  0x107b: 0x23a4,
  // ⎤
  0x107c: 0x23a3,
  // ⎣
  0x107d: 0x23af,
  // ⎯
  0x107e: 0x23a6,
  // ⎦
  0x107f: 0x23a1,
  // ⎡
  0x10a0: 0x3138 // ㄸ (CC char)

};

var get708CharFromCode = function get708CharFromCode(code) {
  var newCode = CHARACTER_TRANSLATION_708[code] || code;

  if (code & 0x1000 && code === newCode) {
    // Invalid extended code
    return '';
  }

  return String.fromCharCode(newCode);
};

var within708TextBlock = function within708TextBlock(b) {
  return 0x20 <= b && b <= 0x7f || 0xa0 <= b && b <= 0xff;
};

var Cea708Window = function Cea708Window(windowNum) {
  this.windowNum = windowNum;
  this.reset();
};

Cea708Window.prototype.reset = function () {
  this.clearText();
  this.pendingNewLine = false;
  this.winAttr = {};
  this.penAttr = {};
  this.penLoc = {};
  this.penColor = {}; // These default values are arbitrary,
  // defineWindow will usually override them

  this.visible = 0;
  this.rowLock = 0;
  this.columnLock = 0;
  this.priority = 0;
  this.relativePositioning = 0;
  this.anchorVertical = 0;
  this.anchorHorizontal = 0;
  this.anchorPoint = 0;
  this.rowCount = 1;
  this.virtualRowCount = this.rowCount + 1;
  this.columnCount = 41;
  this.windowStyle = 0;
  this.penStyle = 0;
};

Cea708Window.prototype.getText = function () {
  return this.rows.join('\n');
};

Cea708Window.prototype.clearText = function () {
  this.rows = [''];
  this.rowIdx = 0;
};

Cea708Window.prototype.newLine = function (pts) {
  if (this.rows.length >= this.virtualRowCount && typeof this.beforeRowOverflow === 'function') {
    this.beforeRowOverflow(pts);
  }

  if (this.rows.length > 0) {
    this.rows.push('');
    this.rowIdx++;
  } // Show all virtual rows since there's no visible scrolling


  while (this.rows.length > this.virtualRowCount) {
    this.rows.shift();
    this.rowIdx--;
  }
};

Cea708Window.prototype.isEmpty = function () {
  if (this.rows.length === 0) {
    return true;
  } else if (this.rows.length === 1) {
    return this.rows[0] === '';
  }

  return false;
};

Cea708Window.prototype.addText = function (text) {
  this.rows[this.rowIdx] += text;
};

Cea708Window.prototype.backspace = function () {
  if (!this.isEmpty()) {
    var row = this.rows[this.rowIdx];
    this.rows[this.rowIdx] = row.substr(0, row.length - 1);
  }
};

var Cea708Service = function Cea708Service(serviceNum, encoding, stream) {
  this.serviceNum = serviceNum;
  this.text = '';
  this.currentWindow = new Cea708Window(-1);
  this.windows = [];
  this.stream = stream; // Try to setup a TextDecoder if an `encoding` value was provided

  if (typeof encoding === 'string') {
    this.createTextDecoder(encoding);
  }
};
/**
 * Initialize service windows
 * Must be run before service use
 *
 * @param  {Integer}  pts               PTS value
 * @param  {Function} beforeRowOverflow Function to execute before row overflow of a window
 */


Cea708Service.prototype.init = function (pts, beforeRowOverflow) {
  this.startPts = pts;

  for (var win = 0; win < 8; win++) {
    this.windows[win] = new Cea708Window(win);

    if (typeof beforeRowOverflow === 'function') {
      this.windows[win].beforeRowOverflow = beforeRowOverflow;
    }
  }
};
/**
 * Set current window of service to be affected by commands
 *
 * @param  {Integer} windowNum Window number
 */


Cea708Service.prototype.setCurrentWindow = function (windowNum) {
  this.currentWindow = this.windows[windowNum];
};
/**
 * Try to create a TextDecoder if it is natively supported
 */


Cea708Service.prototype.createTextDecoder = function (encoding) {
  if (typeof TextDecoder === 'undefined') {
    this.stream.trigger('log', {
      level: 'warn',
      message: 'The `encoding` option is unsupported without TextDecoder support'
    });
  } else {
    try {
      this.textDecoder_ = new TextDecoder(encoding);
    } catch (error) {
      this.stream.trigger('log', {
        level: 'warn',
        message: 'TextDecoder could not be created with ' + encoding + ' encoding. ' + error
      });
    }
  }
};

var Cea708Stream = function Cea708Stream(options) {
  options = options || {};
  Cea708Stream.prototype.init.call(this);
  var self = this;
  var captionServices = options.captionServices || {};
  var captionServiceEncodings = {};
  var serviceProps; // Get service encodings from captionServices option block

  Object.keys(captionServices).forEach(function (serviceName) {
    serviceProps = captionServices[serviceName];

    if (/^SERVICE/.test(serviceName)) {
      captionServiceEncodings[serviceName] = serviceProps.encoding;
    }
  });
  this.serviceEncodings = captionServiceEncodings;
  this.current708Packet = null;
  this.services = {};

  this.push = function (packet) {
    if (packet.type === 3) {
      // 708 packet start
      self.new708Packet();
      self.add708Bytes(packet);
    } else {
      if (self.current708Packet === null) {
        // This should only happen at the start of a file if there's no packet start.
        self.new708Packet();
      }

      self.add708Bytes(packet);
    }
  };
};

Cea708Stream.prototype = new Stream();
/**
 * Push current 708 packet, create new 708 packet.
 */

Cea708Stream.prototype.new708Packet = function () {
  if (this.current708Packet !== null) {
    this.push708Packet();
  }

  this.current708Packet = {
    data: [],
    ptsVals: []
  };
};
/**
 * Add pts and both bytes from packet into current 708 packet.
 */


Cea708Stream.prototype.add708Bytes = function (packet) {
  var data = packet.ccData;
  var byte0 = data >>> 8;
  var byte1 = data & 0xff; // I would just keep a list of packets instead of bytes, but it isn't clear in the spec
  // that service blocks will always line up with byte pairs.

  this.current708Packet.ptsVals.push(packet.pts);
  this.current708Packet.data.push(byte0);
  this.current708Packet.data.push(byte1);
};
/**
 * Parse completed 708 packet into service blocks and push each service block.
 */


Cea708Stream.prototype.push708Packet = function () {
  var packet708 = this.current708Packet;
  var packetData = packet708.data;
  var serviceNum = null;
  var blockSize = null;
  var i = 0;
  var b = packetData[i++];
  packet708.seq = b >> 6;
  packet708.sizeCode = b & 0x3f; // 0b00111111;

  for (; i < packetData.length; i++) {
    b = packetData[i++];
    serviceNum = b >> 5;
    blockSize = b & 0x1f; // 0b00011111

    if (serviceNum === 7 && blockSize > 0) {
      // Extended service num
      b = packetData[i++];
      serviceNum = b;
    }

    this.pushServiceBlock(serviceNum, i, blockSize);

    if (blockSize > 0) {
      i += blockSize - 1;
    }
  }
};
/**
 * Parse service block, execute commands, read text.
 *
 * Note: While many of these commands serve important purposes,
 * many others just parse out the parameters or attributes, but
 * nothing is done with them because this is not a full and complete
 * implementation of the entire 708 spec.
 *
 * @param  {Integer} serviceNum Service number
 * @param  {Integer} start      Start index of the 708 packet data
 * @param  {Integer} size       Block size
 */


Cea708Stream.prototype.pushServiceBlock = function (serviceNum, start, size) {
  var b;
  var i = start;
  var packetData = this.current708Packet.data;
  var service = this.services[serviceNum];

  if (!service) {
    service = this.initService(serviceNum, i);
  }

  for (; i < start + size && i < packetData.length; i++) {
    b = packetData[i];

    if (within708TextBlock(b)) {
      i = this.handleText(i, service);
    } else if (b === 0x18) {
      i = this.multiByteCharacter(i, service);
    } else if (b === 0x10) {
      i = this.extendedCommands(i, service);
    } else if (0x80 <= b && b <= 0x87) {
      i = this.setCurrentWindow(i, service);
    } else if (0x98 <= b && b <= 0x9f) {
      i = this.defineWindow(i, service);
    } else if (b === 0x88) {
      i = this.clearWindows(i, service);
    } else if (b === 0x8c) {
      i = this.deleteWindows(i, service);
    } else if (b === 0x89) {
      i = this.displayWindows(i, service);
    } else if (b === 0x8a) {
      i = this.hideWindows(i, service);
    } else if (b === 0x8b) {
      i = this.toggleWindows(i, service);
    } else if (b === 0x97) {
      i = this.setWindowAttributes(i, service);
    } else if (b === 0x90) {
      i = this.setPenAttributes(i, service);
    } else if (b === 0x91) {
      i = this.setPenColor(i, service);
    } else if (b === 0x92) {
      i = this.setPenLocation(i, service);
    } else if (b === 0x8f) {
      service = this.reset(i, service);
    } else if (b === 0x08) {
      // BS: Backspace
      service.currentWindow.backspace();
    } else if (b === 0x0c) {
      // FF: Form feed
      service.currentWindow.clearText();
    } else if (b === 0x0d) {
      // CR: Carriage return
      service.currentWindow.pendingNewLine = true;
    } else if (b === 0x0e) {
      // HCR: Horizontal carriage return
      service.currentWindow.clearText();
    } else if (b === 0x8d) {
      // DLY: Delay, nothing to do
      i++;
    } else if (b === 0x8e) {// DLC: Delay cancel, nothing to do
    } else if (b === 0x03) {// ETX: End Text, don't need to do anything
    } else if (b === 0x00) {// Padding
    } else {// Unknown command
      }
  }
};
/**
 * Execute an extended command
 *
 * @param  {Integer} i        Current index in the 708 packet
 * @param  {Service} service  The service object to be affected
 * @return {Integer}          New index after parsing
 */


Cea708Stream.prototype.extendedCommands = function (i, service) {
  var packetData = this.current708Packet.data;
  var b = packetData[++i];

  if (within708TextBlock(b)) {
    i = this.handleText(i, service, {
      isExtended: true
    });
  } else {// Unknown command
  }

  return i;
};
/**
 * Get PTS value of a given byte index
 *
 * @param  {Integer} byteIndex  Index of the byte
 * @return {Integer}            PTS
 */


Cea708Stream.prototype.getPts = function (byteIndex) {
  // There's 1 pts value per 2 bytes
  return this.current708Packet.ptsVals[Math.floor(byteIndex / 2)];
};
/**
 * Initializes a service
 *
 * @param  {Integer} serviceNum Service number
 * @return {Service}            Initialized service object
 */


Cea708Stream.prototype.initService = function (serviceNum, i) {
  var serviceName = 'SERVICE' + serviceNum;
  var self = this;
  var serviceName;
  var encoding;

  if (serviceName in this.serviceEncodings) {
    encoding = this.serviceEncodings[serviceName];
  }

  this.services[serviceNum] = new Cea708Service(serviceNum, encoding, self);
  this.services[serviceNum].init(this.getPts(i), function (pts) {
    self.flushDisplayed(pts, self.services[serviceNum]);
  });
  return this.services[serviceNum];
};
/**
 * Execute text writing to current window
 *
 * @param  {Integer} i        Current index in the 708 packet
 * @param  {Service} service  The service object to be affected
 * @return {Integer}          New index after parsing
 */


Cea708Stream.prototype.handleText = function (i, service, options) {
  var isExtended = options && options.isExtended;
  var isMultiByte = options && options.isMultiByte;
  var packetData = this.current708Packet.data;
  var extended = isExtended ? 0x1000 : 0x0000;
  var currentByte = packetData[i];
  var nextByte = packetData[i + 1];
  var win = service.currentWindow;
  var char;
  var charCodeArray; // Use the TextDecoder if one was created for this service

  if (service.textDecoder_ && !isExtended) {
    if (isMultiByte) {
      charCodeArray = [currentByte, nextByte];
      i++;
    } else {
      charCodeArray = [currentByte];
    }

    char = service.textDecoder_.decode(new Uint8Array(charCodeArray));
  } else {
    char = get708CharFromCode(extended | currentByte);
  }

  if (win.pendingNewLine && !win.isEmpty()) {
    win.newLine(this.getPts(i));
  }

  win.pendingNewLine = false;
  win.addText(char);
  return i;
};
/**
 * Handle decoding of multibyte character
 *
 * @param  {Integer} i        Current index in the 708 packet
 * @param  {Service} service  The service object to be affected
 * @return {Integer}          New index after parsing
 */


Cea708Stream.prototype.multiByteCharacter = function (i, service) {
  var packetData = this.current708Packet.data;
  var firstByte = packetData[i + 1];
  var secondByte = packetData[i + 2];

  if (within708TextBlock(firstByte) && within708TextBlock(secondByte)) {
    i = this.handleText(++i, service, {
      isMultiByte: true
    });
  } else {// Unknown command
  }

  return i;
};
/**
 * Parse and execute the CW# command.
 *
 * Set the current window.
 *
 * @param  {Integer} i        Current index in the 708 packet
 * @param  {Service} service  The service object to be affected
 * @return {Integer}          New index after parsing
 */


Cea708Stream.prototype.setCurrentWindow = function (i, service) {
  var packetData = this.current708Packet.data;
  var b = packetData[i];
  var windowNum = b & 0x07;
  service.setCurrentWindow(windowNum);
  return i;
};
/**
 * Parse and execute the DF# command.
 *
 * Define a window and set it as the current window.
 *
 * @param  {Integer} i        Current index in the 708 packet
 * @param  {Service} service  The service object to be affected
 * @return {Integer}          New index after parsing
 */


Cea708Stream.prototype.defineWindow = function (i, service) {
  var packetData = this.current708Packet.data;
  var b = packetData[i];
  var windowNum = b & 0x07;
  service.setCurrentWindow(windowNum);
  var win = service.currentWindow;
  b = packetData[++i];
  win.visible = (b & 0x20) >> 5; // v

  win.rowLock = (b & 0x10) >> 4; // rl

  win.columnLock = (b & 0x08) >> 3; // cl

  win.priority = b & 0x07; // p

  b = packetData[++i];
  win.relativePositioning = (b & 0x80) >> 7; // rp

  win.anchorVertical = b & 0x7f; // av

  b = packetData[++i];
  win.anchorHorizontal = b; // ah

  b = packetData[++i];
  win.anchorPoint = (b & 0xf0) >> 4; // ap

  win.rowCount = b & 0x0f; // rc

  b = packetData[++i];
  win.columnCount = b & 0x3f; // cc

  b = packetData[++i];
  win.windowStyle = (b & 0x38) >> 3; // ws

  win.penStyle = b & 0x07; // ps
  // The spec says there are (rowCount+1) "virtual rows"

  win.virtualRowCount = win.rowCount + 1;
  return i;
};
/**
 * Parse and execute the SWA command.
 *
 * Set attributes of the current window.
 *
 * @param  {Integer} i        Current index in the 708 packet
 * @param  {Service} service  The service object to be affected
 * @return {Integer}          New index after parsing
 */


Cea708Stream.prototype.setWindowAttributes = function (i, service) {
  var packetData = this.current708Packet.data;
  var b = packetData[i];
  var winAttr = service.currentWindow.winAttr;
  b = packetData[++i];
  winAttr.fillOpacity = (b & 0xc0) >> 6; // fo

  winAttr.fillRed = (b & 0x30) >> 4; // fr

  winAttr.fillGreen = (b & 0x0c) >> 2; // fg

  winAttr.fillBlue = b & 0x03; // fb

  b = packetData[++i];
  winAttr.borderType = (b & 0xc0) >> 6; // bt

  winAttr.borderRed = (b & 0x30) >> 4; // br

  winAttr.borderGreen = (b & 0x0c) >> 2; // bg

  winAttr.borderBlue = b & 0x03; // bb

  b = packetData[++i];
  winAttr.borderType += (b & 0x80) >> 5; // bt

  winAttr.wordWrap = (b & 0x40) >> 6; // ww

  winAttr.printDirection = (b & 0x30) >> 4; // pd

  winAttr.scrollDirection = (b & 0x0c) >> 2; // sd

  winAttr.justify = b & 0x03; // j

  b = packetData[++i];
  winAttr.effectSpeed = (b & 0xf0) >> 4; // es

  winAttr.effectDirection = (b & 0x0c) >> 2; // ed

  winAttr.displayEffect = b & 0x03; // de

  return i;
};
/**
 * Gather text from all displayed windows and push a caption to output.
 *
 * @param  {Integer} i        Current index in the 708 packet
 * @param  {Service} service  The service object to be affected
 */


Cea708Stream.prototype.flushDisplayed = function (pts, service) {
  var displayedText = []; // TODO: Positioning not supported, displaying multiple windows will not necessarily
  // display text in the correct order, but sample files so far have not shown any issue.

  for (var winId = 0; winId < 8; winId++) {
    if (service.windows[winId].visible && !service.windows[winId].isEmpty()) {
      displayedText.push(service.windows[winId].getText());
    }
  }

  service.endPts = pts;
  service.text = displayedText.join('\n\n');
  this.pushCaption(service);
  service.startPts = pts;
};
/**
 * Push a caption to output if the caption contains text.
 *
 * @param  {Service} service  The service object to be affected
 */


Cea708Stream.prototype.pushCaption = function (service) {
  if (service.text !== '') {
    this.trigger('data', {
      startPts: service.startPts,
      endPts: service.endPts,
      text: service.text,
      stream: 'cc708_' + service.serviceNum
    });
    service.text = '';
    service.startPts = service.endPts;
  }
};
/**
 * Parse and execute the DSW command.
 *
 * Set visible property of windows based on the parsed bitmask.
 *
 * @param  {Integer} i        Current index in the 708 packet
 * @param  {Service} service  The service object to be affected
 * @return {Integer}          New index after parsing
 */


Cea708Stream.prototype.displayWindows = function (i, service) {
  var packetData = this.current708Packet.data;
  var b = packetData[++i];
  var pts = this.getPts(i);
  this.flushDisplayed(pts, service);

  for (var winId = 0; winId < 8; winId++) {
    if (b & 0x01 << winId) {
      service.windows[winId].visible = 1;
    }
  }

  return i;
};
/**
 * Parse and execute the HDW command.
 *
 * Set visible property of windows based on the parsed bitmask.
 *
 * @param  {Integer} i        Current index in the 708 packet
 * @param  {Service} service  The service object to be affected
 * @return {Integer}          New index after parsing
 */


Cea708Stream.prototype.hideWindows = function (i, service) {
  var packetData = this.current708Packet.data;
  var b = packetData[++i];
  var pts = this.getPts(i);
  this.flushDisplayed(pts, service);

  for (var winId = 0; winId < 8; winId++) {
    if (b & 0x01 << winId) {
      service.windows[winId].visible = 0;
    }
  }

  return i;
};
/**
 * Parse and execute the TGW command.
 *
 * Set visible property of windows based on the parsed bitmask.
 *
 * @param  {Integer} i        Current index in the 708 packet
 * @param  {Service} service  The service object to be affected
 * @return {Integer}          New index after parsing
 */


Cea708Stream.prototype.toggleWindows = function (i, service) {
  var packetData = this.current708Packet.data;
  var b = packetData[++i];
  var pts = this.getPts(i);
  this.flushDisplayed(pts, service);

  for (var winId = 0; winId < 8; winId++) {
    if (b & 0x01 << winId) {
      service.windows[winId].visible ^= 1;
    }
  }

  return i;
};
/**
 * Parse and execute the CLW command.
 *
 * Clear text of windows based on the parsed bitmask.
 *
 * @param  {Integer} i        Current index in the 708 packet
 * @param  {Service} service  The service object to be affected
 * @return {Integer}          New index after parsing
 */


Cea708Stream.prototype.clearWindows = function (i, service) {
  var packetData = this.current708Packet.data;
  var b = packetData[++i];
  var pts = this.getPts(i);
  this.flushDisplayed(pts, service);

  for (var winId = 0; winId < 8; winId++) {
    if (b & 0x01 << winId) {
      service.windows[winId].clearText();
    }
  }

  return i;
};
/**
 * Parse and execute the DLW command.
 *
 * Re-initialize windows based on the parsed bitmask.
 *
 * @param  {Integer} i        Current index in the 708 packet
 * @param  {Service} service  The service object to be affected
 * @return {Integer}          New index after parsing
 */


Cea708Stream.prototype.deleteWindows = function (i, service) {
  var packetData = this.current708Packet.data;
  var b = packetData[++i];
  var pts = this.getPts(i);
  this.flushDisplayed(pts, service);

  for (var winId = 0; winId < 8; winId++) {
    if (b & 0x01 << winId) {
      service.windows[winId].reset();
    }
  }

  return i;
};
/**
 * Parse and execute the SPA command.
 *
 * Set pen attributes of the current window.
 *
 * @param  {Integer} i        Current index in the 708 packet
 * @param  {Service} service  The service object to be affected
 * @return {Integer}          New index after parsing
 */


Cea708Stream.prototype.setPenAttributes = function (i, service) {
  var packetData = this.current708Packet.data;
  var b = packetData[i];
  var penAttr = service.currentWindow.penAttr;
  b = packetData[++i];
  penAttr.textTag = (b & 0xf0) >> 4; // tt

  penAttr.offset = (b & 0x0c) >> 2; // o

  penAttr.penSize = b & 0x03; // s

  b = packetData[++i];
  penAttr.italics = (b & 0x80) >> 7; // i

  penAttr.underline = (b & 0x40) >> 6; // u

  penAttr.edgeType = (b & 0x38) >> 3; // et

  penAttr.fontStyle = b & 0x07; // fs

  return i;
};
/**
 * Parse and execute the SPC command.
 *
 * Set pen color of the current window.
 *
 * @param  {Integer} i        Current index in the 708 packet
 * @param  {Service} service  The service object to be affected
 * @return {Integer}          New index after parsing
 */


Cea708Stream.prototype.setPenColor = function (i, service) {
  var packetData = this.current708Packet.data;
  var b = packetData[i];
  var penColor = service.currentWindow.penColor;
  b = packetData[++i];
  penColor.fgOpacity = (b & 0xc0) >> 6; // fo

  penColor.fgRed = (b & 0x30) >> 4; // fr

  penColor.fgGreen = (b & 0x0c) >> 2; // fg

  penColor.fgBlue = b & 0x03; // fb

  b = packetData[++i];
  penColor.bgOpacity = (b & 0xc0) >> 6; // bo

  penColor.bgRed = (b & 0x30) >> 4; // br

  penColor.bgGreen = (b & 0x0c) >> 2; // bg

  penColor.bgBlue = b & 0x03; // bb

  b = packetData[++i];
  penColor.edgeRed = (b & 0x30) >> 4; // er

  penColor.edgeGreen = (b & 0x0c) >> 2; // eg

  penColor.edgeBlue = b & 0x03; // eb

  return i;
};
/**
 * Parse and execute the SPL command.
 *
 * Set pen location of the current window.
 *
 * @param  {Integer} i        Current index in the 708 packet
 * @param  {Service} service  The service object to be affected
 * @return {Integer}          New index after parsing
 */


Cea708Stream.prototype.setPenLocation = function (i, service) {
  var packetData = this.current708Packet.data;
  var b = packetData[i];
  var penLoc = service.currentWindow.penLoc; // Positioning isn't really supported at the moment, so this essentially just inserts a linebreak

  service.currentWindow.pendingNewLine = true;
  b = packetData[++i];
  penLoc.row = b & 0x0f; // r

  b = packetData[++i];
  penLoc.column = b & 0x3f; // c

  return i;
};
/**
 * Execute the RST command.
 *
 * Reset service to a clean slate. Re-initialize.
 *
 * @param  {Integer} i        Current index in the 708 packet
 * @param  {Service} service  The service object to be affected
 * @return {Service}          Re-initialized service
 */


Cea708Stream.prototype.reset = function (i, service) {
  var pts = this.getPts(i);
  this.flushDisplayed(pts, service);
  return this.initService(service.serviceNum, i);
}; // This hash maps non-ASCII, special, and extended character codes to their
// proper Unicode equivalent. The first keys that are only a single byte
// are the non-standard ASCII characters, which simply map the CEA608 byte
// to the standard ASCII/Unicode. The two-byte keys that follow are the CEA608
// character codes, but have their MSB bitmasked with 0x03 so that a lookup
// can be performed regardless of the field and data channel on which the
// character code was received.


var CHARACTER_TRANSLATION = {
  0x2a: 0xe1,
  // á
  0x5c: 0xe9,
  // é
  0x5e: 0xed,
  // í
  0x5f: 0xf3,
  // ó
  0x60: 0xfa,
  // ú
  0x7b: 0xe7,
  // ç
  0x7c: 0xf7,
  // ÷
  0x7d: 0xd1,
  // Ñ
  0x7e: 0xf1,
  // ñ
  0x7f: 0x2588,
  // █
  0x0130: 0xae,
  // ®
  0x0131: 0xb0,
  // °
  0x0132: 0xbd,
  // ½
  0x0133: 0xbf,
  // ¿
  0x0134: 0x2122,
  // ™
  0x0135: 0xa2,
  // ¢
  0x0136: 0xa3,
  // £
  0x0137: 0x266a,
  // ♪
  0x0138: 0xe0,
  // à
  0x0139: 0xa0,
  //
  0x013a: 0xe8,
  // è
  0x013b: 0xe2,
  // â
  0x013c: 0xea,
  // ê
  0x013d: 0xee,
  // î
  0x013e: 0xf4,
  // ô
  0x013f: 0xfb,
  // û
  0x0220: 0xc1,
  // Á
  0x0221: 0xc9,
  // É
  0x0222: 0xd3,
  // Ó
  0x0223: 0xda,
  // Ú
  0x0224: 0xdc,
  // Ü
  0x0225: 0xfc,
  // ü
  0x0226: 0x2018,
  // ‘
  0x0227: 0xa1,
  // ¡
  0x0228: 0x2a,
  // *
  0x0229: 0x27,
  // '
  0x022a: 0x2014,
  // —
  0x022b: 0xa9,
  // ©
  0x022c: 0x2120,
  // ℠
  0x022d: 0x2022,
  // •
  0x022e: 0x201c,
  // “
  0x022f: 0x201d,
  // ”
  0x0230: 0xc0,
  // À
  0x0231: 0xc2,
  // Â
  0x0232: 0xc7,
  // Ç
  0x0233: 0xc8,
  // È
  0x0234: 0xca,
  // Ê
  0x0235: 0xcb,
  // Ë
  0x0236: 0xeb,
  // ë
  0x0237: 0xce,
  // Î
  0x0238: 0xcf,
  // Ï
  0x0239: 0xef,
  // ï
  0x023a: 0xd4,
  // Ô
  0x023b: 0xd9,
  // Ù
  0x023c: 0xf9,
  // ù
  0x023d: 0xdb,
  // Û
  0x023e: 0xab,
  // «
  0x023f: 0xbb,
  // »
  0x0320: 0xc3,
  // Ã
  0x0321: 0xe3,
  // ã
  0x0322: 0xcd,
  // Í
  0x0323: 0xcc,
  // Ì
  0x0324: 0xec,
  // ì
  0x0325: 0xd2,
  // Ò
  0x0326: 0xf2,
  // ò
  0x0327: 0xd5,
  // Õ
  0x0328: 0xf5,
  // õ
  0x0329: 0x7b,
  // {
  0x032a: 0x7d,
  // }
  0x032b: 0x5c,
  // \
  0x032c: 0x5e,
  // ^
  0x032d: 0x5f,
  // _
  0x032e: 0x7c,
  // |
  0x032f: 0x7e,
  // ~
  0x0330: 0xc4,
  // Ä
  0x0331: 0xe4,
  // ä
  0x0332: 0xd6,
  // Ö
  0x0333: 0xf6,
  // ö
  0x0334: 0xdf,
  // ß
  0x0335: 0xa5,
  // ¥
  0x0336: 0xa4,
  // ¤
  0x0337: 0x2502,
  // │
  0x0338: 0xc5,
  // Å
  0x0339: 0xe5,
  // å
  0x033a: 0xd8,
  // Ø
  0x033b: 0xf8,
  // ø
  0x033c: 0x250c,
  // ┌
  0x033d: 0x2510,
  // ┐
  0x033e: 0x2514,
  // └
  0x033f: 0x2518 // ┘

};

var getCharFromCode = function getCharFromCode(code) {
  if (code === null) {
    return '';
  }

  code = CHARACTER_TRANSLATION[code] || code;
  return String.fromCharCode(code);
}; // the index of the last row in a CEA-608 display buffer


var BOTTOM_ROW = 14; // This array is used for mapping PACs -> row #, since there's no way of
// getting it through bit logic.

var ROWS = [0x1100, 0x1120, 0x1200, 0x1220, 0x1500, 0x1520, 0x1600, 0x1620, 0x1700, 0x1720, 0x1000, 0x1300, 0x1320, 0x1400, 0x1420]; // CEA-608 captions are rendered onto a 34x15 matrix of character
// cells. The "bottom" row is the last element in the outer array.

var createDisplayBuffer = function createDisplayBuffer() {
  var result = [],
      i = BOTTOM_ROW + 1;

  while (i--) {
    result.push('');
  }

  return result;
};

var Cea608Stream = function Cea608Stream(field, dataChannel) {
  Cea608Stream.prototype.init.call(this);
  this.field_ = field || 0;
  this.dataChannel_ = dataChannel || 0;
  this.name_ = 'CC' + ((this.field_ << 1 | this.dataChannel_) + 1);
  this.setConstants();
  this.reset();

  this.push = function (packet) {
    var data, swap, char0, char1, text; // remove the parity bits

    data = packet.ccData & 0x7f7f; // ignore duplicate control codes; the spec demands they're sent twice

    if (data === this.lastControlCode_) {
      this.lastControlCode_ = null;
      return;
    } // Store control codes


    if ((data & 0xf000) === 0x1000) {
      this.lastControlCode_ = data;
    } else if (data !== this.PADDING_) {
      this.lastControlCode_ = null;
    }

    char0 = data >>> 8;
    char1 = data & 0xff;

    if (data === this.PADDING_) {
      return;
    } else if (data === this.RESUME_CAPTION_LOADING_) {
      this.mode_ = 'popOn';
    } else if (data === this.END_OF_CAPTION_) {
      // If an EOC is received while in paint-on mode, the displayed caption
      // text should be swapped to non-displayed memory as if it was a pop-on
      // caption. Because of that, we should explicitly switch back to pop-on
      // mode
      this.mode_ = 'popOn';
      this.clearFormatting(packet.pts); // if a caption was being displayed, it's gone now

      this.flushDisplayed(packet.pts); // flip memory

      swap = this.displayed_;
      this.displayed_ = this.nonDisplayed_;
      this.nonDisplayed_ = swap; // start measuring the time to display the caption

      this.startPts_ = packet.pts;
    } else if (data === this.ROLL_UP_2_ROWS_) {
      this.rollUpRows_ = 2;
      this.setRollUp(packet.pts);
    } else if (data === this.ROLL_UP_3_ROWS_) {
      this.rollUpRows_ = 3;
      this.setRollUp(packet.pts);
    } else if (data === this.ROLL_UP_4_ROWS_) {
      this.rollUpRows_ = 4;
      this.setRollUp(packet.pts);
    } else if (data === this.CARRIAGE_RETURN_) {
      this.clearFormatting(packet.pts);
      this.flushDisplayed(packet.pts);
      this.shiftRowsUp_();
      this.startPts_ = packet.pts;
    } else if (data === this.BACKSPACE_) {
      if (this.mode_ === 'popOn') {
        this.nonDisplayed_[this.row_] = this.nonDisplayed_[this.row_].slice(0, -1);
      } else {
        this.displayed_[this.row_] = this.displayed_[this.row_].slice(0, -1);
      }
    } else if (data === this.ERASE_DISPLAYED_MEMORY_) {
      this.flushDisplayed(packet.pts);
      this.displayed_ = createDisplayBuffer();
    } else if (data === this.ERASE_NON_DISPLAYED_MEMORY_) {
      this.nonDisplayed_ = createDisplayBuffer();
    } else if (data === this.RESUME_DIRECT_CAPTIONING_) {
      if (this.mode_ !== 'paintOn') {
        // NOTE: This should be removed when proper caption positioning is
        // implemented
        this.flushDisplayed(packet.pts);
        this.displayed_ = createDisplayBuffer();
      }

      this.mode_ = 'paintOn';
      this.startPts_ = packet.pts; // Append special characters to caption text
    } else if (this.isSpecialCharacter(char0, char1)) {
      // Bitmask char0 so that we can apply character transformations
      // regardless of field and data channel.
      // Then byte-shift to the left and OR with char1 so we can pass the
      // entire character code to `getCharFromCode`.
      char0 = (char0 & 0x03) << 8;
      text = getCharFromCode(char0 | char1);
      this[this.mode_](packet.pts, text);
      this.column_++; // Append extended characters to caption text
    } else if (this.isExtCharacter(char0, char1)) {
      // Extended characters always follow their "non-extended" equivalents.
      // IE if a "è" is desired, you'll always receive "eè"; non-compliant
      // decoders are supposed to drop the "è", while compliant decoders
      // backspace the "e" and insert "è".
      // Delete the previous character
      if (this.mode_ === 'popOn') {
        this.nonDisplayed_[this.row_] = this.nonDisplayed_[this.row_].slice(0, -1);
      } else {
        this.displayed_[this.row_] = this.displayed_[this.row_].slice(0, -1);
      } // Bitmask char0 so that we can apply character transformations
      // regardless of field and data channel.
      // Then byte-shift to the left and OR with char1 so we can pass the
      // entire character code to `getCharFromCode`.


      char0 = (char0 & 0x03) << 8;
      text = getCharFromCode(char0 | char1);
      this[this.mode_](packet.pts, text);
      this.column_++; // Process mid-row codes
    } else if (this.isMidRowCode(char0, char1)) {
      // Attributes are not additive, so clear all formatting
      this.clearFormatting(packet.pts); // According to the standard, mid-row codes
      // should be replaced with spaces, so add one now

      this[this.mode_](packet.pts, ' ');
      this.column_++;

      if ((char1 & 0xe) === 0xe) {
        this.addFormatting(packet.pts, ['i']);
      }

      if ((char1 & 0x1) === 0x1) {
        this.addFormatting(packet.pts, ['u']);
      } // Detect offset control codes and adjust cursor

    } else if (this.isOffsetControlCode(char0, char1)) {
      // Cursor position is set by indent PAC (see below) in 4-column
      // increments, with an additional offset code of 1-3 to reach any
      // of the 32 columns specified by CEA-608. So all we need to do
      // here is increment the column cursor by the given offset.
      this.column_ += char1 & 0x03; // Detect PACs (Preamble Address Codes)
    } else if (this.isPAC(char0, char1)) {
      // There's no logic for PAC -> row mapping, so we have to just
      // find the row code in an array and use its index :(
      var row = ROWS.indexOf(data & 0x1f20); // Configure the caption window if we're in roll-up mode

      if (this.mode_ === 'rollUp') {
        // This implies that the base row is incorrectly set.
        // As per the recommendation in CEA-608(Base Row Implementation), defer to the number
        // of roll-up rows set.
        if (row - this.rollUpRows_ + 1 < 0) {
          row = this.rollUpRows_ - 1;
        }

        this.setRollUp(packet.pts, row);
      }

      if (row !== this.row_) {
        // formatting is only persistent for current row
        this.clearFormatting(packet.pts);
        this.row_ = row;
      } // All PACs can apply underline, so detect and apply
      // (All odd-numbered second bytes set underline)


      if (char1 & 0x1 && this.formatting_.indexOf('u') === -1) {
        this.addFormatting(packet.pts, ['u']);
      }

      if ((data & 0x10) === 0x10) {
        // We've got an indent level code. Each successive even number
        // increments the column cursor by 4, so we can get the desired
        // column position by bit-shifting to the right (to get n/2)
        // and multiplying by 4.
        this.column_ = ((data & 0xe) >> 1) * 4;
      }

      if (this.isColorPAC(char1)) {
        // it's a color code, though we only support white, which
        // can be either normal or italicized. white italics can be
        // either 0x4e or 0x6e depending on the row, so we just
        // bitwise-and with 0xe to see if italics should be turned on
        if ((char1 & 0xe) === 0xe) {
          this.addFormatting(packet.pts, ['i']);
        }
      } // We have a normal character in char0, and possibly one in char1

    } else if (this.isNormalChar(char0)) {
      if (char1 === 0x00) {
        char1 = null;
      }

      text = getCharFromCode(char0);
      text += getCharFromCode(char1);
      this[this.mode_](packet.pts, text);
      this.column_ += text.length;
    } // finish data processing

  };
};

Cea608Stream.prototype = new Stream(); // Trigger a cue point that captures the current state of the
// display buffer

Cea608Stream.prototype.flushDisplayed = function (pts) {
  var content = this.displayed_ // remove spaces from the start and end of the string
  .map(function (row, index) {
    try {
      return row.trim();
    } catch (e) {
      // Ordinarily, this shouldn't happen. However, caption
      // parsing errors should not throw exceptions and
      // break playback.
      this.trigger('log', {
        level: 'warn',
        message: 'Skipping a malformed 608 caption at index ' + index + '.'
      });
      return '';
    }
  }, this) // combine all text rows to display in one cue
  .join('\n') // and remove blank rows from the start and end, but not the middle
  .replace(/^\n+|\n+$/g, '');

  if (content.length) {
    this.trigger('data', {
      startPts: this.startPts_,
      endPts: pts,
      text: content,
      stream: this.name_
    });
  }
};
/**
 * Zero out the data, used for startup and on seek
 */


Cea608Stream.prototype.reset = function () {
  this.mode_ = 'popOn'; // When in roll-up mode, the index of the last row that will
  // actually display captions. If a caption is shifted to a row
  // with a lower index than this, it is cleared from the display
  // buffer

  this.topRow_ = 0;
  this.startPts_ = 0;
  this.displayed_ = createDisplayBuffer();
  this.nonDisplayed_ = createDisplayBuffer();
  this.lastControlCode_ = null; // Track row and column for proper line-breaking and spacing

  this.column_ = 0;
  this.row_ = BOTTOM_ROW;
  this.rollUpRows_ = 2; // This variable holds currently-applied formatting

  this.formatting_ = [];
};
/**
 * Sets up control code and related constants for this instance
 */


Cea608Stream.prototype.setConstants = function () {
  // The following attributes have these uses:
  // ext_ :    char0 for mid-row codes, and the base for extended
  //           chars (ext_+0, ext_+1, and ext_+2 are char0s for
  //           extended codes)
  // control_: char0 for control codes, except byte-shifted to the
  //           left so that we can do this.control_ | CONTROL_CODE
  // offset_:  char0 for tab offset codes
  //
  // It's also worth noting that control codes, and _only_ control codes,
  // differ between field 1 and field2. Field 2 control codes are always
  // their field 1 value plus 1. That's why there's the "| field" on the
  // control value.
  if (this.dataChannel_ === 0) {
    this.BASE_ = 0x10;
    this.EXT_ = 0x11;
    this.CONTROL_ = (0x14 | this.field_) << 8;
    this.OFFSET_ = 0x17;
  } else if (this.dataChannel_ === 1) {
    this.BASE_ = 0x18;
    this.EXT_ = 0x19;
    this.CONTROL_ = (0x1c | this.field_) << 8;
    this.OFFSET_ = 0x1f;
  } // Constants for the LSByte command codes recognized by Cea608Stream. This
  // list is not exhaustive. For a more comprehensive listing and semantics see
  // http://www.gpo.gov/fdsys/pkg/CFR-2010-title47-vol1/pdf/CFR-2010-title47-vol1-sec15-119.pdf
  // Padding


  this.PADDING_ = 0x0000; // Pop-on Mode

  this.RESUME_CAPTION_LOADING_ = this.CONTROL_ | 0x20;
  this.END_OF_CAPTION_ = this.CONTROL_ | 0x2f; // Roll-up Mode

  this.ROLL_UP_2_ROWS_ = this.CONTROL_ | 0x25;
  this.ROLL_UP_3_ROWS_ = this.CONTROL_ | 0x26;
  this.ROLL_UP_4_ROWS_ = this.CONTROL_ | 0x27;
  this.CARRIAGE_RETURN_ = this.CONTROL_ | 0x2d; // paint-on mode

  this.RESUME_DIRECT_CAPTIONING_ = this.CONTROL_ | 0x29; // Erasure

  this.BACKSPACE_ = this.CONTROL_ | 0x21;
  this.ERASE_DISPLAYED_MEMORY_ = this.CONTROL_ | 0x2c;
  this.ERASE_NON_DISPLAYED_MEMORY_ = this.CONTROL_ | 0x2e;
};
/**
 * Detects if the 2-byte packet data is a special character
 *
 * Special characters have a second byte in the range 0x30 to 0x3f,
 * with the first byte being 0x11 (for data channel 1) or 0x19 (for
 * data channel 2).
 *
 * @param  {Integer} char0 The first byte
 * @param  {Integer} char1 The second byte
 * @return {Boolean}       Whether the 2 bytes are an special character
 */


Cea608Stream.prototype.isSpecialCharacter = function (char0, char1) {
  return char0 === this.EXT_ && char1 >= 0x30 && char1 <= 0x3f;
};
/**
 * Detects if the 2-byte packet data is an extended character
 *
 * Extended characters have a second byte in the range 0x20 to 0x3f,
 * with the first byte being 0x12 or 0x13 (for data channel 1) or
 * 0x1a or 0x1b (for data channel 2).
 *
 * @param  {Integer} char0 The first byte
 * @param  {Integer} char1 The second byte
 * @return {Boolean}       Whether the 2 bytes are an extended character
 */


Cea608Stream.prototype.isExtCharacter = function (char0, char1) {
  return (char0 === this.EXT_ + 1 || char0 === this.EXT_ + 2) && char1 >= 0x20 && char1 <= 0x3f;
};
/**
 * Detects if the 2-byte packet is a mid-row code
 *
 * Mid-row codes have a second byte in the range 0x20 to 0x2f, with
 * the first byte being 0x11 (for data channel 1) or 0x19 (for data
 * channel 2).
 *
 * @param  {Integer} char0 The first byte
 * @param  {Integer} char1 The second byte
 * @return {Boolean}       Whether the 2 bytes are a mid-row code
 */


Cea608Stream.prototype.isMidRowCode = function (char0, char1) {
  return char0 === this.EXT_ && char1 >= 0x20 && char1 <= 0x2f;
};
/**
 * Detects if the 2-byte packet is an offset control code
 *
 * Offset control codes have a second byte in the range 0x21 to 0x23,
 * with the first byte being 0x17 (for data channel 1) or 0x1f (for
 * data channel 2).
 *
 * @param  {Integer} char0 The first byte
 * @param  {Integer} char1 The second byte
 * @return {Boolean}       Whether the 2 bytes are an offset control code
 */


Cea608Stream.prototype.isOffsetControlCode = function (char0, char1) {
  return char0 === this.OFFSET_ && char1 >= 0x21 && char1 <= 0x23;
};
/**
 * Detects if the 2-byte packet is a Preamble Address Code
 *
 * PACs have a first byte in the range 0x10 to 0x17 (for data channel 1)
 * or 0x18 to 0x1f (for data channel 2), with the second byte in the
 * range 0x40 to 0x7f.
 *
 * @param  {Integer} char0 The first byte
 * @param  {Integer} char1 The second byte
 * @return {Boolean}       Whether the 2 bytes are a PAC
 */


Cea608Stream.prototype.isPAC = function (char0, char1) {
  return char0 >= this.BASE_ && char0 < this.BASE_ + 8 && char1 >= 0x40 && char1 <= 0x7f;
};
/**
 * Detects if a packet's second byte is in the range of a PAC color code
 *
 * PAC color codes have the second byte be in the range 0x40 to 0x4f, or
 * 0x60 to 0x6f.
 *
 * @param  {Integer} char1 The second byte
 * @return {Boolean}       Whether the byte is a color PAC
 */


Cea608Stream.prototype.isColorPAC = function (char1) {
  return char1 >= 0x40 && char1 <= 0x4f || char1 >= 0x60 && char1 <= 0x7f;
};
/**
 * Detects if a single byte is in the range of a normal character
 *
 * Normal text bytes are in the range 0x20 to 0x7f.
 *
 * @param  {Integer} char  The byte
 * @return {Boolean}       Whether the byte is a normal character
 */


Cea608Stream.prototype.isNormalChar = function (char) {
  return char >= 0x20 && char <= 0x7f;
};
/**
 * Configures roll-up
 *
 * @param  {Integer} pts         Current PTS
 * @param  {Integer} newBaseRow  Used by PACs to slide the current window to
 *                               a new position
 */


Cea608Stream.prototype.setRollUp = function (pts, newBaseRow) {
  // Reset the base row to the bottom row when switching modes
  if (this.mode_ !== 'rollUp') {
    this.row_ = BOTTOM_ROW;
    this.mode_ = 'rollUp'; // Spec says to wipe memories when switching to roll-up

    this.flushDisplayed(pts);
    this.nonDisplayed_ = createDisplayBuffer();
    this.displayed_ = createDisplayBuffer();
  }

  if (newBaseRow !== undefined && newBaseRow !== this.row_) {
    // move currently displayed captions (up or down) to the new base row
    for (var i = 0; i < this.rollUpRows_; i++) {
      this.displayed_[newBaseRow - i] = this.displayed_[this.row_ - i];
      this.displayed_[this.row_ - i] = '';
    }
  }

  if (newBaseRow === undefined) {
    newBaseRow = this.row_;
  }

  this.topRow_ = newBaseRow - this.rollUpRows_ + 1;
}; // Adds the opening HTML tag for the passed character to the caption text,
// and keeps track of it for later closing


Cea608Stream.prototype.addFormatting = function (pts, format) {
  this.formatting_ = this.formatting_.concat(format);
  var text = format.reduce(function (text, format) {
    return text + '<' + format + '>';
  }, '');
  this[this.mode_](pts, text);
}; // Adds HTML closing tags for current formatting to caption text and
// clears remembered formatting


Cea608Stream.prototype.clearFormatting = function (pts) {
  if (!this.formatting_.length) {
    return;
  }

  var text = this.formatting_.reverse().reduce(function (text, format) {
    return text + '</' + format + '>';
  }, '');
  this.formatting_ = [];
  this[this.mode_](pts, text);
}; // Mode Implementations


Cea608Stream.prototype.popOn = function (pts, text) {
  var baseRow = this.nonDisplayed_[this.row_]; // buffer characters

  baseRow += text;
  this.nonDisplayed_[this.row_] = baseRow;
};

Cea608Stream.prototype.rollUp = function (pts, text) {
  var baseRow = this.displayed_[this.row_];
  baseRow += text;
  this.displayed_[this.row_] = baseRow;
};

Cea608Stream.prototype.shiftRowsUp_ = function () {
  var i; // clear out inactive rows

  for (i = 0; i < this.topRow_; i++) {
    this.displayed_[i] = '';
  }

  for (i = this.row_ + 1; i < BOTTOM_ROW + 1; i++) {
    this.displayed_[i] = '';
  } // shift displayed rows up


  for (i = this.topRow_; i < this.row_; i++) {
    this.displayed_[i] = this.displayed_[i + 1];
  } // clear out the bottom row


  this.displayed_[this.row_] = '';
};

Cea608Stream.prototype.paintOn = function (pts, text) {
  var baseRow = this.displayed_[this.row_];
  baseRow += text;
  this.displayed_[this.row_] = baseRow;
}; // exports


module.exports = {
  CaptionStream: CaptionStream,
  Cea608Stream: Cea608Stream,
  Cea708Stream: Cea708Stream
};