123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503 |
- /*! @name m3u8-parser @version 6.0.0 @license Apache-2.0 */
- import Stream from '@videojs/vhs-utils/es/stream.js';
- import _extends from '@babel/runtime/helpers/extends';
- import decodeB64ToUint8Array from '@videojs/vhs-utils/es/decode-b64-to-uint8-array.js';
- /**
- * @file m3u8/line-stream.js
- */
- /**
- * A stream that buffers string input and generates a `data` event for each
- * line.
- *
- * @class LineStream
- * @extends Stream
- */
- class LineStream extends Stream {
- constructor() {
- super();
- this.buffer = '';
- }
- /**
- * Add new data to be parsed.
- *
- * @param {string} data the text to process
- */
- push(data) {
- let nextNewline;
- this.buffer += data;
- nextNewline = this.buffer.indexOf('\n');
- for (; nextNewline > -1; nextNewline = this.buffer.indexOf('\n')) {
- this.trigger('data', this.buffer.substring(0, nextNewline));
- this.buffer = this.buffer.substring(nextNewline + 1);
- }
- }
- }
- const TAB = String.fromCharCode(0x09);
- const parseByterange = function (byterangeString) {
- // optionally match and capture 0+ digits before `@`
- // optionally match and capture 0+ digits after `@`
- const match = /([0-9.]*)?@?([0-9.]*)?/.exec(byterangeString || '');
- const result = {};
- if (match[1]) {
- result.length = parseInt(match[1], 10);
- }
- if (match[2]) {
- result.offset = parseInt(match[2], 10);
- }
- return result;
- };
- /**
- * "forgiving" attribute list psuedo-grammar:
- * attributes -> keyvalue (',' keyvalue)*
- * keyvalue -> key '=' value
- * key -> [^=]*
- * value -> '"' [^"]* '"' | [^,]*
- */
- const attributeSeparator = function () {
- const key = '[^=]*';
- const value = '"[^"]*"|[^,]*';
- const keyvalue = '(?:' + key + ')=(?:' + value + ')';
- return new RegExp('(?:^|,)(' + keyvalue + ')');
- };
- /**
- * Parse attributes from a line given the separator
- *
- * @param {string} attributes the attribute line to parse
- */
- const parseAttributes = function (attributes) {
- const result = {};
- if (!attributes) {
- return result;
- } // split the string using attributes as the separator
- const attrs = attributes.split(attributeSeparator());
- let i = attrs.length;
- let attr;
- while (i--) {
- // filter out unmatched portions of the string
- if (attrs[i] === '') {
- continue;
- } // split the key and value
- attr = /([^=]*)=(.*)/.exec(attrs[i]).slice(1); // trim whitespace and remove optional quotes around the value
- attr[0] = attr[0].replace(/^\s+|\s+$/g, '');
- attr[1] = attr[1].replace(/^\s+|\s+$/g, '');
- attr[1] = attr[1].replace(/^['"](.*)['"]$/g, '$1');
- result[attr[0]] = attr[1];
- }
- return result;
- };
- /**
- * A line-level M3U8 parser event stream. It expects to receive input one
- * line at a time and performs a context-free parse of its contents. A stream
- * interpretation of a manifest can be useful if the manifest is expected to
- * be too large to fit comfortably into memory or the entirety of the input
- * is not immediately available. Otherwise, it's probably much easier to work
- * with a regular `Parser` object.
- *
- * Produces `data` events with an object that captures the parser's
- * interpretation of the input. That object has a property `tag` that is one
- * of `uri`, `comment`, or `tag`. URIs only have a single additional
- * property, `line`, which captures the entirety of the input without
- * interpretation. Comments similarly have a single additional property
- * `text` which is the input without the leading `#`.
- *
- * Tags always have a property `tagType` which is the lower-cased version of
- * the M3U8 directive without the `#EXT` or `#EXT-X-` prefix. For instance,
- * `#EXT-X-MEDIA-SEQUENCE` becomes `media-sequence` when parsed. Unrecognized
- * tags are given the tag type `unknown` and a single additional property
- * `data` with the remainder of the input.
- *
- * @class ParseStream
- * @extends Stream
- */
- class ParseStream extends Stream {
- constructor() {
- super();
- this.customParsers = [];
- this.tagMappers = [];
- }
- /**
- * Parses an additional line of input.
- *
- * @param {string} line a single line of an M3U8 file to parse
- */
- push(line) {
- let match;
- let event; // strip whitespace
- line = line.trim();
- if (line.length === 0) {
- // ignore empty lines
- return;
- } // URIs
- if (line[0] !== '#') {
- this.trigger('data', {
- type: 'uri',
- uri: line
- });
- return;
- } // map tags
- const newLines = this.tagMappers.reduce((acc, mapper) => {
- const mappedLine = mapper(line); // skip if unchanged
- if (mappedLine === line) {
- return acc;
- }
- return acc.concat([mappedLine]);
- }, [line]);
- newLines.forEach(newLine => {
- for (let i = 0; i < this.customParsers.length; i++) {
- if (this.customParsers[i].call(this, newLine)) {
- return;
- }
- } // Comments
- if (newLine.indexOf('#EXT') !== 0) {
- this.trigger('data', {
- type: 'comment',
- text: newLine.slice(1)
- });
- return;
- } // strip off any carriage returns here so the regex matching
- // doesn't have to account for them.
- newLine = newLine.replace('\r', ''); // Tags
- match = /^#EXTM3U/.exec(newLine);
- if (match) {
- this.trigger('data', {
- type: 'tag',
- tagType: 'm3u'
- });
- return;
- }
- match = /^#EXTINF:([0-9\.]*)?,?(.*)?$/.exec(newLine);
- if (match) {
- event = {
- type: 'tag',
- tagType: 'inf'
- };
- if (match[1]) {
- event.duration = parseFloat(match[1]);
- }
- if (match[2]) {
- event.title = match[2];
- }
- this.trigger('data', event);
- return;
- }
- match = /^#EXT-X-TARGETDURATION:([0-9.]*)?/.exec(newLine);
- if (match) {
- event = {
- type: 'tag',
- tagType: 'targetduration'
- };
- if (match[1]) {
- event.duration = parseInt(match[1], 10);
- }
- this.trigger('data', event);
- return;
- }
- match = /^#EXT-X-VERSION:([0-9.]*)?/.exec(newLine);
- if (match) {
- event = {
- type: 'tag',
- tagType: 'version'
- };
- if (match[1]) {
- event.version = parseInt(match[1], 10);
- }
- this.trigger('data', event);
- return;
- }
- match = /^#EXT-X-MEDIA-SEQUENCE:(\-?[0-9.]*)?/.exec(newLine);
- if (match) {
- event = {
- type: 'tag',
- tagType: 'media-sequence'
- };
- if (match[1]) {
- event.number = parseInt(match[1], 10);
- }
- this.trigger('data', event);
- return;
- }
- match = /^#EXT-X-DISCONTINUITY-SEQUENCE:(\-?[0-9.]*)?/.exec(newLine);
- if (match) {
- event = {
- type: 'tag',
- tagType: 'discontinuity-sequence'
- };
- if (match[1]) {
- event.number = parseInt(match[1], 10);
- }
- this.trigger('data', event);
- return;
- }
- match = /^#EXT-X-PLAYLIST-TYPE:(.*)?$/.exec(newLine);
- if (match) {
- event = {
- type: 'tag',
- tagType: 'playlist-type'
- };
- if (match[1]) {
- event.playlistType = match[1];
- }
- this.trigger('data', event);
- return;
- }
- match = /^#EXT-X-BYTERANGE:(.*)?$/.exec(newLine);
- if (match) {
- event = _extends(parseByterange(match[1]), {
- type: 'tag',
- tagType: 'byterange'
- });
- this.trigger('data', event);
- return;
- }
- match = /^#EXT-X-ALLOW-CACHE:(YES|NO)?/.exec(newLine);
- if (match) {
- event = {
- type: 'tag',
- tagType: 'allow-cache'
- };
- if (match[1]) {
- event.allowed = !/NO/.test(match[1]);
- }
- this.trigger('data', event);
- return;
- }
- match = /^#EXT-X-MAP:(.*)$/.exec(newLine);
- if (match) {
- event = {
- type: 'tag',
- tagType: 'map'
- };
- if (match[1]) {
- const attributes = parseAttributes(match[1]);
- if (attributes.URI) {
- event.uri = attributes.URI;
- }
- if (attributes.BYTERANGE) {
- event.byterange = parseByterange(attributes.BYTERANGE);
- }
- }
- this.trigger('data', event);
- return;
- }
- match = /^#EXT-X-STREAM-INF:(.*)$/.exec(newLine);
- if (match) {
- event = {
- type: 'tag',
- tagType: 'stream-inf'
- };
- if (match[1]) {
- event.attributes = parseAttributes(match[1]);
- if (event.attributes.RESOLUTION) {
- const split = event.attributes.RESOLUTION.split('x');
- const resolution = {};
- if (split[0]) {
- resolution.width = parseInt(split[0], 10);
- }
- if (split[1]) {
- resolution.height = parseInt(split[1], 10);
- }
- event.attributes.RESOLUTION = resolution;
- }
- if (event.attributes.BANDWIDTH) {
- event.attributes.BANDWIDTH = parseInt(event.attributes.BANDWIDTH, 10);
- }
- if (event.attributes['FRAME-RATE']) {
- event.attributes['FRAME-RATE'] = parseFloat(event.attributes['FRAME-RATE']);
- }
- if (event.attributes['PROGRAM-ID']) {
- event.attributes['PROGRAM-ID'] = parseInt(event.attributes['PROGRAM-ID'], 10);
- }
- }
- this.trigger('data', event);
- return;
- }
- match = /^#EXT-X-MEDIA:(.*)$/.exec(newLine);
- if (match) {
- event = {
- type: 'tag',
- tagType: 'media'
- };
- if (match[1]) {
- event.attributes = parseAttributes(match[1]);
- }
- this.trigger('data', event);
- return;
- }
- match = /^#EXT-X-ENDLIST/.exec(newLine);
- if (match) {
- this.trigger('data', {
- type: 'tag',
- tagType: 'endlist'
- });
- return;
- }
- match = /^#EXT-X-DISCONTINUITY/.exec(newLine);
- if (match) {
- this.trigger('data', {
- type: 'tag',
- tagType: 'discontinuity'
- });
- return;
- }
- match = /^#EXT-X-PROGRAM-DATE-TIME:(.*)$/.exec(newLine);
- if (match) {
- event = {
- type: 'tag',
- tagType: 'program-date-time'
- };
- if (match[1]) {
- event.dateTimeString = match[1];
- event.dateTimeObject = new Date(match[1]);
- }
- this.trigger('data', event);
- return;
- }
- match = /^#EXT-X-KEY:(.*)$/.exec(newLine);
- if (match) {
- event = {
- type: 'tag',
- tagType: 'key'
- };
- if (match[1]) {
- event.attributes = parseAttributes(match[1]); // parse the IV string into a Uint32Array
- if (event.attributes.IV) {
- if (event.attributes.IV.substring(0, 2).toLowerCase() === '0x') {
- event.attributes.IV = event.attributes.IV.substring(2);
- }
- event.attributes.IV = event.attributes.IV.match(/.{8}/g);
- event.attributes.IV[0] = parseInt(event.attributes.IV[0], 16);
- event.attributes.IV[1] = parseInt(event.attributes.IV[1], 16);
- event.attributes.IV[2] = parseInt(event.attributes.IV[2], 16);
- event.attributes.IV[3] = parseInt(event.attributes.IV[3], 16);
- event.attributes.IV = new Uint32Array(event.attributes.IV);
- }
- }
- this.trigger('data', event);
- return;
- }
- match = /^#EXT-X-START:(.*)$/.exec(newLine);
- if (match) {
- event = {
- type: 'tag',
- tagType: 'start'
- };
- if (match[1]) {
- event.attributes = parseAttributes(match[1]);
- event.attributes['TIME-OFFSET'] = parseFloat(event.attributes['TIME-OFFSET']);
- event.attributes.PRECISE = /YES/.test(event.attributes.PRECISE);
- }
- this.trigger('data', event);
- return;
- }
- match = /^#EXT-X-CUE-OUT-CONT:(.*)?$/.exec(newLine);
- if (match) {
- event = {
- type: 'tag',
- tagType: 'cue-out-cont'
- };
- if (match[1]) {
- event.data = match[1];
- } else {
- event.data = '';
- }
- this.trigger('data', event);
- return;
- }
- match = /^#EXT-X-CUE-OUT:(.*)?$/.exec(newLine);
- if (match) {
- event = {
- type: 'tag',
- tagType: 'cue-out'
- };
- if (match[1]) {
- event.data = match[1];
- } else {
- event.data = '';
- }
- this.trigger('data', event);
- return;
- }
- match = /^#EXT-X-CUE-IN:(.*)?$/.exec(newLine);
- if (match) {
- event = {
- type: 'tag',
- tagType: 'cue-in'
- };
- if (match[1]) {
- event.data = match[1];
- } else {
- event.data = '';
- }
- this.trigger('data', event);
- return;
- }
- match = /^#EXT-X-SKIP:(.*)$/.exec(newLine);
- if (match && match[1]) {
- event = {
- type: 'tag',
- tagType: 'skip'
- };
- event.attributes = parseAttributes(match[1]);
- if (event.attributes.hasOwnProperty('SKIPPED-SEGMENTS')) {
- event.attributes['SKIPPED-SEGMENTS'] = parseInt(event.attributes['SKIPPED-SEGMENTS'], 10);
- }
- if (event.attributes.hasOwnProperty('RECENTLY-REMOVED-DATERANGES')) {
- event.attributes['RECENTLY-REMOVED-DATERANGES'] = event.attributes['RECENTLY-REMOVED-DATERANGES'].split(TAB);
- }
- this.trigger('data', event);
- return;
- }
- match = /^#EXT-X-PART:(.*)$/.exec(newLine);
- if (match && match[1]) {
- event = {
- type: 'tag',
- tagType: 'part'
- };
- event.attributes = parseAttributes(match[1]);
- ['DURATION'].forEach(function (key) {
- if (event.attributes.hasOwnProperty(key)) {
- event.attributes[key] = parseFloat(event.attributes[key]);
- }
- });
- ['INDEPENDENT', 'GAP'].forEach(function (key) {
- if (event.attributes.hasOwnProperty(key)) {
- event.attributes[key] = /YES/.test(event.attributes[key]);
- }
- });
- if (event.attributes.hasOwnProperty('BYTERANGE')) {
- event.attributes.byterange = parseByterange(event.attributes.BYTERANGE);
- }
- this.trigger('data', event);
- return;
- }
- match = /^#EXT-X-SERVER-CONTROL:(.*)$/.exec(newLine);
- if (match && match[1]) {
- event = {
- type: 'tag',
- tagType: 'server-control'
- };
- event.attributes = parseAttributes(match[1]);
- ['CAN-SKIP-UNTIL', 'PART-HOLD-BACK', 'HOLD-BACK'].forEach(function (key) {
- if (event.attributes.hasOwnProperty(key)) {
- event.attributes[key] = parseFloat(event.attributes[key]);
- }
- });
- ['CAN-SKIP-DATERANGES', 'CAN-BLOCK-RELOAD'].forEach(function (key) {
- if (event.attributes.hasOwnProperty(key)) {
- event.attributes[key] = /YES/.test(event.attributes[key]);
- }
- });
- this.trigger('data', event);
- return;
- }
- match = /^#EXT-X-PART-INF:(.*)$/.exec(newLine);
- if (match && match[1]) {
- event = {
- type: 'tag',
- tagType: 'part-inf'
- };
- event.attributes = parseAttributes(match[1]);
- ['PART-TARGET'].forEach(function (key) {
- if (event.attributes.hasOwnProperty(key)) {
- event.attributes[key] = parseFloat(event.attributes[key]);
- }
- });
- this.trigger('data', event);
- return;
- }
- match = /^#EXT-X-PRELOAD-HINT:(.*)$/.exec(newLine);
- if (match && match[1]) {
- event = {
- type: 'tag',
- tagType: 'preload-hint'
- };
- event.attributes = parseAttributes(match[1]);
- ['BYTERANGE-START', 'BYTERANGE-LENGTH'].forEach(function (key) {
- if (event.attributes.hasOwnProperty(key)) {
- event.attributes[key] = parseInt(event.attributes[key], 10);
- const subkey = key === 'BYTERANGE-LENGTH' ? 'length' : 'offset';
- event.attributes.byterange = event.attributes.byterange || {};
- event.attributes.byterange[subkey] = event.attributes[key]; // only keep the parsed byterange object.
- delete event.attributes[key];
- }
- });
- this.trigger('data', event);
- return;
- }
- match = /^#EXT-X-RENDITION-REPORT:(.*)$/.exec(newLine);
- if (match && match[1]) {
- event = {
- type: 'tag',
- tagType: 'rendition-report'
- };
- event.attributes = parseAttributes(match[1]);
- ['LAST-MSN', 'LAST-PART'].forEach(function (key) {
- if (event.attributes.hasOwnProperty(key)) {
- event.attributes[key] = parseInt(event.attributes[key], 10);
- }
- });
- this.trigger('data', event);
- return;
- } // unknown tag type
- this.trigger('data', {
- type: 'tag',
- data: newLine.slice(4)
- });
- });
- }
- /**
- * Add a parser for custom headers
- *
- * @param {Object} options a map of options for the added parser
- * @param {RegExp} options.expression a regular expression to match the custom header
- * @param {string} options.customType the custom type to register to the output
- * @param {Function} [options.dataParser] function to parse the line into an object
- * @param {boolean} [options.segment] should tag data be attached to the segment object
- */
- addParser({
- expression,
- customType,
- dataParser,
- segment
- }) {
- if (typeof dataParser !== 'function') {
- dataParser = line => line;
- }
- this.customParsers.push(line => {
- const match = expression.exec(line);
- if (match) {
- this.trigger('data', {
- type: 'custom',
- data: dataParser(line),
- customType,
- segment
- });
- return true;
- }
- });
- }
- /**
- * Add a custom header mapper
- *
- * @param {Object} options
- * @param {RegExp} options.expression a regular expression to match the custom header
- * @param {Function} options.map function to translate tag into a different tag
- */
- addTagMapper({
- expression,
- map
- }) {
- const mapFn = line => {
- if (expression.test(line)) {
- return map(line);
- }
- return line;
- };
- this.tagMappers.push(mapFn);
- }
- }
- const camelCase = str => str.toLowerCase().replace(/-(\w)/g, a => a[1].toUpperCase());
- const camelCaseKeys = function (attributes) {
- const result = {};
- Object.keys(attributes).forEach(function (key) {
- result[camelCase(key)] = attributes[key];
- });
- return result;
- }; // set SERVER-CONTROL hold back based upon targetDuration and partTargetDuration
- // we need this helper because defaults are based upon targetDuration and
- // partTargetDuration being set, but they may not be if SERVER-CONTROL appears before
- // target durations are set.
- const setHoldBack = function (manifest) {
- const {
- serverControl,
- targetDuration,
- partTargetDuration
- } = manifest;
- if (!serverControl) {
- return;
- }
- const tag = '#EXT-X-SERVER-CONTROL';
- const hb = 'holdBack';
- const phb = 'partHoldBack';
- const minTargetDuration = targetDuration && targetDuration * 3;
- const minPartDuration = partTargetDuration && partTargetDuration * 2;
- if (targetDuration && !serverControl.hasOwnProperty(hb)) {
- serverControl[hb] = minTargetDuration;
- this.trigger('info', {
- message: `${tag} defaulting HOLD-BACK to targetDuration * 3 (${minTargetDuration}).`
- });
- }
- if (minTargetDuration && serverControl[hb] < minTargetDuration) {
- this.trigger('warn', {
- message: `${tag} clamping HOLD-BACK (${serverControl[hb]}) to targetDuration * 3 (${minTargetDuration})`
- });
- serverControl[hb] = minTargetDuration;
- } // default no part hold back to part target duration * 3
- if (partTargetDuration && !serverControl.hasOwnProperty(phb)) {
- serverControl[phb] = partTargetDuration * 3;
- this.trigger('info', {
- message: `${tag} defaulting PART-HOLD-BACK to partTargetDuration * 3 (${serverControl[phb]}).`
- });
- } // if part hold back is too small default it to part target duration * 2
- if (partTargetDuration && serverControl[phb] < minPartDuration) {
- this.trigger('warn', {
- message: `${tag} clamping PART-HOLD-BACK (${serverControl[phb]}) to partTargetDuration * 2 (${minPartDuration}).`
- });
- serverControl[phb] = minPartDuration;
- }
- };
- /**
- * A parser for M3U8 files. The current interpretation of the input is
- * exposed as a property `manifest` on parser objects. It's just two lines to
- * create and parse a manifest once you have the contents available as a string:
- *
- * ```js
- * var parser = new m3u8.Parser();
- * parser.push(xhr.responseText);
- * ```
- *
- * New input can later be applied to update the manifest object by calling
- * `push` again.
- *
- * The parser attempts to create a usable manifest object even if the
- * underlying input is somewhat nonsensical. It emits `info` and `warning`
- * events during the parse if it encounters input that seems invalid or
- * requires some property of the manifest object to be defaulted.
- *
- * @class Parser
- * @extends Stream
- */
- class Parser extends Stream {
- constructor() {
- super();
- this.lineStream = new LineStream();
- this.parseStream = new ParseStream();
- this.lineStream.pipe(this.parseStream);
- /* eslint-disable consistent-this */
- const self = this;
- /* eslint-enable consistent-this */
- const uris = [];
- let currentUri = {}; // if specified, the active EXT-X-MAP definition
- let currentMap; // if specified, the active decryption key
- let key;
- let hasParts = false;
- const noop = function () {};
- const defaultMediaGroups = {
- 'AUDIO': {},
- 'VIDEO': {},
- 'CLOSED-CAPTIONS': {},
- 'SUBTITLES': {}
- }; // This is the Widevine UUID from DASH IF IOP. The same exact string is
- // used in MPDs with Widevine encrypted streams.
- const widevineUuid = 'urn:uuid:edef8ba9-79d6-4ace-a3c8-27dcd51d21ed'; // group segments into numbered timelines delineated by discontinuities
- let currentTimeline = 0; // the manifest is empty until the parse stream begins delivering data
- this.manifest = {
- allowCache: true,
- discontinuityStarts: [],
- segments: []
- }; // keep track of the last seen segment's byte range end, as segments are not required
- // to provide the offset, in which case it defaults to the next byte after the
- // previous segment
- let lastByterangeEnd = 0; // keep track of the last seen part's byte range end.
- let lastPartByterangeEnd = 0;
- this.on('end', () => {
- // only add preloadSegment if we don't yet have a uri for it.
- // and we actually have parts/preloadHints
- if (currentUri.uri || !currentUri.parts && !currentUri.preloadHints) {
- return;
- }
- if (!currentUri.map && currentMap) {
- currentUri.map = currentMap;
- }
- if (!currentUri.key && key) {
- currentUri.key = key;
- }
- if (!currentUri.timeline && typeof currentTimeline === 'number') {
- currentUri.timeline = currentTimeline;
- }
- this.manifest.preloadSegment = currentUri;
- }); // update the manifest with the m3u8 entry from the parse stream
- this.parseStream.on('data', function (entry) {
- let mediaGroup;
- let rendition;
- ({
- tag() {
- // switch based on the tag type
- (({
- version() {
- if (entry.version) {
- this.manifest.version = entry.version;
- }
- },
- 'allow-cache'() {
- this.manifest.allowCache = entry.allowed;
- if (!('allowed' in entry)) {
- this.trigger('info', {
- message: 'defaulting allowCache to YES'
- });
- this.manifest.allowCache = true;
- }
- },
- byterange() {
- const byterange = {};
- if ('length' in entry) {
- currentUri.byterange = byterange;
- byterange.length = entry.length;
- if (!('offset' in entry)) {
- /*
- * From the latest spec (as of this writing):
- * https://tools.ietf.org/html/draft-pantos-http-live-streaming-23#section-4.3.2.2
- *
- * Same text since EXT-X-BYTERANGE's introduction in draft 7:
- * https://tools.ietf.org/html/draft-pantos-http-live-streaming-07#section-3.3.1)
- *
- * "If o [offset] is not present, the sub-range begins at the next byte
- * following the sub-range of the previous media segment."
- */
- entry.offset = lastByterangeEnd;
- }
- }
- if ('offset' in entry) {
- currentUri.byterange = byterange;
- byterange.offset = entry.offset;
- }
- lastByterangeEnd = byterange.offset + byterange.length;
- },
- endlist() {
- this.manifest.endList = true;
- },
- inf() {
- if (!('mediaSequence' in this.manifest)) {
- this.manifest.mediaSequence = 0;
- this.trigger('info', {
- message: 'defaulting media sequence to zero'
- });
- }
- if (!('discontinuitySequence' in this.manifest)) {
- this.manifest.discontinuitySequence = 0;
- this.trigger('info', {
- message: 'defaulting discontinuity sequence to zero'
- });
- }
- if (entry.duration > 0) {
- currentUri.duration = entry.duration;
- }
- if (entry.duration === 0) {
- currentUri.duration = 0.01;
- this.trigger('info', {
- message: 'updating zero segment duration to a small value'
- });
- }
- this.manifest.segments = uris;
- },
- key() {
- if (!entry.attributes) {
- this.trigger('warn', {
- message: 'ignoring key declaration without attribute list'
- });
- return;
- } // clear the active encryption key
- if (entry.attributes.METHOD === 'NONE') {
- key = null;
- return;
- }
- if (!entry.attributes.URI) {
- this.trigger('warn', {
- message: 'ignoring key declaration without URI'
- });
- return;
- }
- if (entry.attributes.KEYFORMAT === 'com.apple.streamingkeydelivery') {
- this.manifest.contentProtection = this.manifest.contentProtection || {}; // TODO: add full support for this.
- this.manifest.contentProtection['com.apple.fps.1_0'] = {
- attributes: entry.attributes
- };
- return;
- }
- if (entry.attributes.KEYFORMAT === 'com.microsoft.playready') {
- this.manifest.contentProtection = this.manifest.contentProtection || {}; // TODO: add full support for this.
- this.manifest.contentProtection['com.microsoft.playready'] = {
- uri: entry.attributes.URI
- };
- return;
- } // check if the content is encrypted for Widevine
- // Widevine/HLS spec: https://storage.googleapis.com/wvdocs/Widevine_DRM_HLS.pdf
- if (entry.attributes.KEYFORMAT === widevineUuid) {
- const VALID_METHODS = ['SAMPLE-AES', 'SAMPLE-AES-CTR', 'SAMPLE-AES-CENC'];
- if (VALID_METHODS.indexOf(entry.attributes.METHOD) === -1) {
- this.trigger('warn', {
- message: 'invalid key method provided for Widevine'
- });
- return;
- }
- if (entry.attributes.METHOD === 'SAMPLE-AES-CENC') {
- this.trigger('warn', {
- message: 'SAMPLE-AES-CENC is deprecated, please use SAMPLE-AES-CTR instead'
- });
- }
- if (entry.attributes.URI.substring(0, 23) !== 'data:text/plain;base64,') {
- this.trigger('warn', {
- message: 'invalid key URI provided for Widevine'
- });
- return;
- }
- if (!(entry.attributes.KEYID && entry.attributes.KEYID.substring(0, 2) === '0x')) {
- this.trigger('warn', {
- message: 'invalid key ID provided for Widevine'
- });
- return;
- } // if Widevine key attributes are valid, store them as `contentProtection`
- // on the manifest to emulate Widevine tag structure in a DASH mpd
- this.manifest.contentProtection = this.manifest.contentProtection || {};
- this.manifest.contentProtection['com.widevine.alpha'] = {
- attributes: {
- schemeIdUri: entry.attributes.KEYFORMAT,
- // remove '0x' from the key id string
- keyId: entry.attributes.KEYID.substring(2)
- },
- // decode the base64-encoded PSSH box
- pssh: decodeB64ToUint8Array(entry.attributes.URI.split(',')[1])
- };
- return;
- }
- if (!entry.attributes.METHOD) {
- this.trigger('warn', {
- message: 'defaulting key method to AES-128'
- });
- } // setup an encryption key for upcoming segments
- key = {
- method: entry.attributes.METHOD || 'AES-128',
- uri: entry.attributes.URI
- };
- if (typeof entry.attributes.IV !== 'undefined') {
- key.iv = entry.attributes.IV;
- }
- },
- 'media-sequence'() {
- if (!isFinite(entry.number)) {
- this.trigger('warn', {
- message: 'ignoring invalid media sequence: ' + entry.number
- });
- return;
- }
- this.manifest.mediaSequence = entry.number;
- },
- 'discontinuity-sequence'() {
- if (!isFinite(entry.number)) {
- this.trigger('warn', {
- message: 'ignoring invalid discontinuity sequence: ' + entry.number
- });
- return;
- }
- this.manifest.discontinuitySequence = entry.number;
- currentTimeline = entry.number;
- },
- 'playlist-type'() {
- if (!/VOD|EVENT/.test(entry.playlistType)) {
- this.trigger('warn', {
- message: 'ignoring unknown playlist type: ' + entry.playlist
- });
- return;
- }
- this.manifest.playlistType = entry.playlistType;
- },
- map() {
- currentMap = {};
- if (entry.uri) {
- currentMap.uri = entry.uri;
- }
- if (entry.byterange) {
- currentMap.byterange = entry.byterange;
- }
- if (key) {
- currentMap.key = key;
- }
- },
- 'stream-inf'() {
- this.manifest.playlists = uris;
- this.manifest.mediaGroups = this.manifest.mediaGroups || defaultMediaGroups;
- if (!entry.attributes) {
- this.trigger('warn', {
- message: 'ignoring empty stream-inf attributes'
- });
- return;
- }
- if (!currentUri.attributes) {
- currentUri.attributes = {};
- }
- _extends(currentUri.attributes, entry.attributes);
- },
- media() {
- this.manifest.mediaGroups = this.manifest.mediaGroups || defaultMediaGroups;
- if (!(entry.attributes && entry.attributes.TYPE && entry.attributes['GROUP-ID'] && entry.attributes.NAME)) {
- this.trigger('warn', {
- message: 'ignoring incomplete or missing media group'
- });
- return;
- } // find the media group, creating defaults as necessary
- const mediaGroupType = this.manifest.mediaGroups[entry.attributes.TYPE];
- mediaGroupType[entry.attributes['GROUP-ID']] = mediaGroupType[entry.attributes['GROUP-ID']] || {};
- mediaGroup = mediaGroupType[entry.attributes['GROUP-ID']]; // collect the rendition metadata
- rendition = {
- default: /yes/i.test(entry.attributes.DEFAULT)
- };
- if (rendition.default) {
- rendition.autoselect = true;
- } else {
- rendition.autoselect = /yes/i.test(entry.attributes.AUTOSELECT);
- }
- if (entry.attributes.LANGUAGE) {
- rendition.language = entry.attributes.LANGUAGE;
- }
- if (entry.attributes.URI) {
- rendition.uri = entry.attributes.URI;
- }
- if (entry.attributes['INSTREAM-ID']) {
- rendition.instreamId = entry.attributes['INSTREAM-ID'];
- }
- if (entry.attributes.CHARACTERISTICS) {
- rendition.characteristics = entry.attributes.CHARACTERISTICS;
- }
- if (entry.attributes.FORCED) {
- rendition.forced = /yes/i.test(entry.attributes.FORCED);
- } // insert the new rendition
- mediaGroup[entry.attributes.NAME] = rendition;
- },
- discontinuity() {
- currentTimeline += 1;
- currentUri.discontinuity = true;
- this.manifest.discontinuityStarts.push(uris.length);
- },
- 'program-date-time'() {
- if (typeof this.manifest.dateTimeString === 'undefined') {
- // PROGRAM-DATE-TIME is a media-segment tag, but for backwards
- // compatibility, we add the first occurence of the PROGRAM-DATE-TIME tag
- // to the manifest object
- // TODO: Consider removing this in future major version
- this.manifest.dateTimeString = entry.dateTimeString;
- this.manifest.dateTimeObject = entry.dateTimeObject;
- }
- currentUri.dateTimeString = entry.dateTimeString;
- currentUri.dateTimeObject = entry.dateTimeObject;
- },
- targetduration() {
- if (!isFinite(entry.duration) || entry.duration < 0) {
- this.trigger('warn', {
- message: 'ignoring invalid target duration: ' + entry.duration
- });
- return;
- }
- this.manifest.targetDuration = entry.duration;
- setHoldBack.call(this, this.manifest);
- },
- start() {
- if (!entry.attributes || isNaN(entry.attributes['TIME-OFFSET'])) {
- this.trigger('warn', {
- message: 'ignoring start declaration without appropriate attribute list'
- });
- return;
- }
- this.manifest.start = {
- timeOffset: entry.attributes['TIME-OFFSET'],
- precise: entry.attributes.PRECISE
- };
- },
- 'cue-out'() {
- currentUri.cueOut = entry.data;
- },
- 'cue-out-cont'() {
- currentUri.cueOutCont = entry.data;
- },
- 'cue-in'() {
- currentUri.cueIn = entry.data;
- },
- 'skip'() {
- this.manifest.skip = camelCaseKeys(entry.attributes);
- this.warnOnMissingAttributes_('#EXT-X-SKIP', entry.attributes, ['SKIPPED-SEGMENTS']);
- },
- 'part'() {
- hasParts = true; // parts are always specifed before a segment
- const segmentIndex = this.manifest.segments.length;
- const part = camelCaseKeys(entry.attributes);
- currentUri.parts = currentUri.parts || [];
- currentUri.parts.push(part);
- if (part.byterange) {
- if (!part.byterange.hasOwnProperty('offset')) {
- part.byterange.offset = lastPartByterangeEnd;
- }
- lastPartByterangeEnd = part.byterange.offset + part.byterange.length;
- }
- const partIndex = currentUri.parts.length - 1;
- this.warnOnMissingAttributes_(`#EXT-X-PART #${partIndex} for segment #${segmentIndex}`, entry.attributes, ['URI', 'DURATION']);
- if (this.manifest.renditionReports) {
- this.manifest.renditionReports.forEach((r, i) => {
- if (!r.hasOwnProperty('lastPart')) {
- this.trigger('warn', {
- message: `#EXT-X-RENDITION-REPORT #${i} lacks required attribute(s): LAST-PART`
- });
- }
- });
- }
- },
- 'server-control'() {
- const attrs = this.manifest.serverControl = camelCaseKeys(entry.attributes);
- if (!attrs.hasOwnProperty('canBlockReload')) {
- attrs.canBlockReload = false;
- this.trigger('info', {
- message: '#EXT-X-SERVER-CONTROL defaulting CAN-BLOCK-RELOAD to false'
- });
- }
- setHoldBack.call(this, this.manifest);
- if (attrs.canSkipDateranges && !attrs.hasOwnProperty('canSkipUntil')) {
- this.trigger('warn', {
- message: '#EXT-X-SERVER-CONTROL lacks required attribute CAN-SKIP-UNTIL which is required when CAN-SKIP-DATERANGES is set'
- });
- }
- },
- 'preload-hint'() {
- // parts are always specifed before a segment
- const segmentIndex = this.manifest.segments.length;
- const hint = camelCaseKeys(entry.attributes);
- const isPart = hint.type && hint.type === 'PART';
- currentUri.preloadHints = currentUri.preloadHints || [];
- currentUri.preloadHints.push(hint);
- if (hint.byterange) {
- if (!hint.byterange.hasOwnProperty('offset')) {
- // use last part byterange end or zero if not a part.
- hint.byterange.offset = isPart ? lastPartByterangeEnd : 0;
- if (isPart) {
- lastPartByterangeEnd = hint.byterange.offset + hint.byterange.length;
- }
- }
- }
- const index = currentUri.preloadHints.length - 1;
- this.warnOnMissingAttributes_(`#EXT-X-PRELOAD-HINT #${index} for segment #${segmentIndex}`, entry.attributes, ['TYPE', 'URI']);
- if (!hint.type) {
- return;
- } // search through all preload hints except for the current one for
- // a duplicate type.
- for (let i = 0; i < currentUri.preloadHints.length - 1; i++) {
- const otherHint = currentUri.preloadHints[i];
- if (!otherHint.type) {
- continue;
- }
- if (otherHint.type === hint.type) {
- this.trigger('warn', {
- message: `#EXT-X-PRELOAD-HINT #${index} for segment #${segmentIndex} has the same TYPE ${hint.type} as preload hint #${i}`
- });
- }
- }
- },
- 'rendition-report'() {
- const report = camelCaseKeys(entry.attributes);
- this.manifest.renditionReports = this.manifest.renditionReports || [];
- this.manifest.renditionReports.push(report);
- const index = this.manifest.renditionReports.length - 1;
- const required = ['LAST-MSN', 'URI'];
- if (hasParts) {
- required.push('LAST-PART');
- }
- this.warnOnMissingAttributes_(`#EXT-X-RENDITION-REPORT #${index}`, entry.attributes, required);
- },
- 'part-inf'() {
- this.manifest.partInf = camelCaseKeys(entry.attributes);
- this.warnOnMissingAttributes_('#EXT-X-PART-INF', entry.attributes, ['PART-TARGET']);
- if (this.manifest.partInf.partTarget) {
- this.manifest.partTargetDuration = this.manifest.partInf.partTarget;
- }
- setHoldBack.call(this, this.manifest);
- }
- })[entry.tagType] || noop).call(self);
- },
- uri() {
- currentUri.uri = entry.uri;
- uris.push(currentUri); // if no explicit duration was declared, use the target duration
- if (this.manifest.targetDuration && !('duration' in currentUri)) {
- this.trigger('warn', {
- message: 'defaulting segment duration to the target duration'
- });
- currentUri.duration = this.manifest.targetDuration;
- } // annotate with encryption information, if necessary
- if (key) {
- currentUri.key = key;
- }
- currentUri.timeline = currentTimeline; // annotate with initialization segment information, if necessary
- if (currentMap) {
- currentUri.map = currentMap;
- } // reset the last byterange end as it needs to be 0 between parts
- lastPartByterangeEnd = 0; // prepare for the next URI
- currentUri = {};
- },
- comment() {// comments are not important for playback
- },
- custom() {
- // if this is segment-level data attach the output to the segment
- if (entry.segment) {
- currentUri.custom = currentUri.custom || {};
- currentUri.custom[entry.customType] = entry.data; // if this is manifest-level data attach to the top level manifest object
- } else {
- this.manifest.custom = this.manifest.custom || {};
- this.manifest.custom[entry.customType] = entry.data;
- }
- }
- })[entry.type].call(self);
- });
- }
- warnOnMissingAttributes_(identifier, attributes, required) {
- const missing = [];
- required.forEach(function (key) {
- if (!attributes.hasOwnProperty(key)) {
- missing.push(key);
- }
- });
- if (missing.length) {
- this.trigger('warn', {
- message: `${identifier} lacks required attribute(s): ${missing.join(', ')}`
- });
- }
- }
- /**
- * Parse the input string and update the manifest object.
- *
- * @param {string} chunk a potentially incomplete portion of the manifest
- */
- push(chunk) {
- this.lineStream.push(chunk);
- }
- /**
- * Flush any remaining input. This can be handy if the last line of an M3U8
- * manifest did not contain a trailing newline but the file has been
- * completely received.
- */
- end() {
- // flush any buffered input
- this.lineStream.push('\n');
- this.trigger('end');
- }
- /**
- * Add an additional parser for non-standard tags
- *
- * @param {Object} options a map of options for the added parser
- * @param {RegExp} options.expression a regular expression to match the custom header
- * @param {string} options.type the type to register to the output
- * @param {Function} [options.dataParser] function to parse the line into an object
- * @param {boolean} [options.segment] should tag data be attached to the segment object
- */
- addParser(options) {
- this.parseStream.addParser(options);
- }
- /**
- * Add a custom header mapper
- *
- * @param {Object} options
- * @param {RegExp} options.expression a regular expression to match the custom header
- * @param {Function} options.map function to translate tag into a different tag
- */
- addTagMapper(options) {
- this.parseStream.addTagMapper(options);
- }
- }
- export { LineStream, ParseStream, Parser };
|