ebml.js 4.0.1 → 4.1.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ebml.js",
-  "version": "4.0.1",
+  "version": "4.1.0",
   "description": "ebml parser",
   "main": "src/index.js",
   "maintainers": [

package/src/decoder.js

@@ -1,301 +1,347 @@
-const { Transform } = require('stream');
-const tools = require('./tools');
-const schema = require('./schema');
-const { debugLog } = require('./debug-log');
-
-const debug = debugLog('ebml:decoder');
-
-const STATE_TAG = 1;
-const STATE_SIZE = 2;
-const STATE_CONTENT = 3;
-
-class EbmlDecoder extends Transform {
-  /**
-   * @property
-   * @private
-   * @type {Buffer}
-   */
-  mBuffer = null;
-
-  /**
-   * @private
-   * @property
-   * @readonly
-   */
-  mTagStack = [];
-
-  /**
-   * @property
-   * @private
-   * @type {Number}
-   */
-  mState = STATE_TAG;
-
-  /**
-   * @property
-   * @private
-   * @type {Number}
-   */
-  mCursor = 0;
-
-  /**
-   * @property
-   * @private
-   * @type {Number}
-   */
-  mTotal = 0;
-
-  /**
-   * @constructor
-   * @param {Object} options The options to be passed along to the super class
-   */
-  constructor(options = {}) {
-    super({ ...options, readableObjectMode: true });
-  }
-
-  get buffer() {
-    return this.mBuffer;
-  }
-
-  get cursor() {
-    return this.mCursor;
-  }
-
-  get state() {
-    return this.mState;
-  }
-
-  get tagStack() {
-    return this.mTagStack;
-  }
-
-  get total() {
-    return this.mTotal;
-  }
-
-  set buffer(buffer) {
-    this.mBuffer = buffer;
-  }
-
-  /**
-   * @param {number} cursor
-   */
-  set cursor(cursor) {
-    this.mCursor = cursor;
-  }
-
-  set state(state) {
-    this.mState = state;
-  }
-
-  set total(total) {
-    this.mTotal = total;
-  }
-
-  _transform(chunk, enc, done) {
-    if (!this.buffer) {
-      this.buffer = Buffer.from(chunk);
-    } else {
-      this.buffer = tools.concatenate(this.buffer, Buffer.from(chunk));
-    }
-
-    while (this.cursor < this.buffer.length) {
-      if (this.state === STATE_TAG && !this.readTag()) {
-        break;
-      }
-      if (this.state === STATE_SIZE && !this.readSize()) {
-        break;
-      }
-      if (this.state === STATE_CONTENT && !this.readContent()) {
-        break;
-      }
-    }
-
-    done();
-  }
-
-  static getSchemaInfo(tag) {
-    if (Number.isInteger(tag) && schema.has(tag)) {
-      return schema.get(tag);
-    }
-    const tagStr = `0x${tag.toString(16).toUpperCase()}`
-    const unknown = {
-      type: null,
-      name: `unknown-${tagStr}`,
-      description: `${tagStr}`,
-      level: -1,
-      minver: -1,
-      multiple: false,
-      webm: false,
-    };
-    schema.set(tag, unknown)
-    console.warn('[SCHEMA]', 'unknown tag:', tagStr)
-    return unknown
-  }
-
-  readTag() {
-    /* istanbul ignore if */
-    if (debug.enabled) {
-      debug('parsing tag');
-    }
-
-    if (this.cursor >= this.buffer.length) {
-      /* istanbul ignore if */
-      if (debug.enabled) {
-        debug('waiting for more data');
-      }
-      return false;
-    }
-
-    const start = this.total;
-    const tag = tools.readVint(this.buffer, this.cursor);
-
-    if (tag == null) {
-      /* istanbul ignore if */
-      if (debug.enabled) {
-        debug('waiting for more data');
-      }
-
-      return false;
-    }
-
-    const tagStr = tools.readHexString(
-      this.buffer,
-      this.cursor,
-      this.cursor + tag.length,
-    );
-    const tagNum = Number.parseInt(tagStr, 16);
-    this.cursor += tag.length;
-    this.total += tag.length;
-    this.state = STATE_SIZE;
-
-    const tagObj = {
-      tag: tag.value,
-      tagStr,
-      type: EbmlDecoder.getSchemaInfo(tagNum).type,
-      name: EbmlDecoder.getSchemaInfo(tagNum).name,
-      start,
-      end: start + tag.length,
-    };
-
-    this.tagStack.push(tagObj);
-    /* istanbul ignore if */
-    if (debug.enabled) {
-      debug(`read tag: ${tagStr}`);
-    }
-
-    return true;
-  }
-
-  readSize() {
-    const tagObj = this.tagStack[this.tagStack.length - 1];
-
-    /* istanbul ignore if */
-    if (debug.enabled) {
-      debug(`parsing size for tag: ${tagObj.tagStr}`);
-    }
-
-    if (this.cursor >= this.buffer.length) {
-      /* istanbul ignore if */
-      if (debug.enabled) {
-        debug('waiting for more data');
-      }
-
-      return false;
-    }
-
-    const size = tools.readVint(this.buffer, this.cursor);
-
-    if (size == null) {
-      /* istanbul ignore if */
-      if (debug.enabled) {
-        debug('waiting for more data');
-      }
-
-      return false;
-    }
-
-    this.cursor += size.length;
-    this.total += size.length;
-    this.state = STATE_CONTENT;
-    tagObj.dataSize = size.value;
-
-    // unknown size
-    if (size.value === -1) {
-      tagObj.end = -1;
-    } else {
-      tagObj.end += size.value + size.length;
-    }
-    /* istanbul ignore if */
-    if (debug.enabled) {
-      debug(`read size: ${size.value}`);
-    }
-
-    return true;
-  }
-
-  readContent() {
-    const { tagStr, type, dataSize, ...rest } = this.tagStack[this.tagStack.length - 1];
-
-    /* istanbul ignore if */
-    if (debug.enabled) {
-      debug(`parsing content for tag: ${tagStr}`);
-    }
-
-    if (type === 'm') {
-      /* istanbul ignore if */
-      if (debug.enabled) {
-        debug('content should be tags');
-      }
-      this.push(['start', { tagStr, type, dataSize, ...rest }]);
-      this.state = STATE_TAG;
-
-      return true;
-    }
-
-    if (this.buffer.length < this.cursor + dataSize) {
-      /* istanbul ignore if */
-      if (debug.enabled) {
-        debug(`got: ${this.buffer.length}`);
-        debug(`need: ${this.cursor + dataSize}`);
-        debug('waiting for more data');
-      }
-
-      return false;
-    }
-
-    const data = this.buffer.subarray(this.cursor, this.cursor + dataSize);
-    this.total += dataSize;
-    this.state = STATE_TAG;
-    this.buffer = this.buffer.subarray(this.cursor + dataSize);
-    this.cursor = 0;
-
-    this.tagStack.pop(); // remove the object from the stack
-
-    this.push([
-      'tag',
-      tools.readDataFromTag(
-        { tagStr, type, dataSize, ...rest },
-        Buffer.from(data),
-      ),
-    ]);
-
-    while (this.tagStack.length > 0) {
-      const topEle = this.tagStack[this.tagStack.length - 1];
-      if (this.total < topEle.end) {
-        break;
-      }
-      this.push(['end', topEle]);
-      this.tagStack.pop();
-    }
-
-    /* istanbul ignore if */
-    if (debug.enabled) {
-      debug(`read data: ${data.toString('hex')}`);
-    }
-
-    return true;
-  }
-}
-
-module.exports = EbmlDecoder
+const { Transform } = require('stream');
+const tools = require('./tools');
+const schema = require('./schema');
+const { debugLog } = require('./debug-log');
+
+const debug = debugLog('ebml:decoder');
+
+const STATE_TAG = 1;
+const STATE_SIZE = 2;
+const STATE_CONTENT = 3;
+
+class EbmlDecoder extends Transform {
+  /**
+   * @property
+   * @private
+   * @type {Buffer}
+   */
+  mBuffer = null;
+
+  /**
+   * @private
+   * @property
+   * @readonly
+   */
+  mTagStack = [];
+
+  /**
+   * @property
+   * @private
+   * @type {Number}
+   */
+  mState = STATE_TAG;
+
+  /**
+   * @property
+   * @private
+   * @type {Number}
+   */
+  mCursor = 0;
+
+  /**
+   * @property
+   * @private
+   * @type {Number}
+   */
+  mTotal = 0;
+
+  /** @private */
+  mIsLive = false
+
+  /**
+   * @constructor
+   * @param {{ isLive?: boolean }} options The options to be passed along to the super class
+   */
+  constructor(options = {}) {
+    super({ ...options, readableObjectMode: true });
+    this.mIsLive = options ? options.isLive : false
+  }
+
+  get isLive() {
+    return this.mIsLive;
+  }
+
+  get buffer() {
+    return this.mBuffer;
+  }
+
+  get cursor() {
+    return this.mCursor;
+  }
+
+  get state() {
+    return this.mState;
+  }
+
+  get tagStack() {
+    return this.mTagStack;
+  }
+
+  get total() {
+    return this.mTotal;
+  }
+
+  set buffer(buffer) {
+    this.mBuffer = buffer;
+  }
+
+  /**
+   * @param {number} cursor
+   */
+  set cursor(cursor) {
+    this.mCursor = cursor;
+  }
+
+  set state(state) {
+    this.mState = state;
+  }
+
+  set total(total) {
+    this.mTotal = total;
+  }
+
+  _transform(chunk, enc, done) {
+    if (!this.buffer) {
+      this.buffer = Buffer.from(chunk);
+    } else {
+      this.buffer = tools.concatenate(this.buffer, Buffer.from(chunk));
+    }
+
+    while (this.cursor < this.buffer.length) {
+      if (this.state === STATE_TAG && !this.readTag()) {
+        break;
+      }
+      if (this.state === STATE_SIZE && !this.readSize()) {
+        break;
+      }
+      if (this.state === STATE_CONTENT && !this.readContent()) {
+        break;
+      }
+    }
+
+    done();
+  }
+
+  static getSchemaInfo(tag) {
+    if (Number.isInteger(tag) && schema.has(tag)) {
+      return schema.get(tag);
+    }
+    const tagStr = `0x${tag.toString(16).toUpperCase()}`
+    const unknown = {
+      type: null,
+      name: `unknown-${tagStr}`,
+      description: `${tagStr}`,
+      level: -1,
+      minver: -1,
+      multiple: false,
+      webm: false,
+    };
+    schema.set(tag, unknown)
+    console.warn('[SCHEMA]', 'unknown tag:', tagStr)
+    return unknown
+  }
+
+  readTag() {
+    /* istanbul ignore if */
+    if (debug.enabled) {
+      debug('parsing tag');
+    }
+
+    if (this.cursor >= this.buffer.length) {
+      /* istanbul ignore if */
+      if (debug.enabled) {
+        debug('waiting for more data');
+      }
+      return false;
+    }
+
+    if (this.isLive && !this.findTagStart()) {
+      return false
+    }
+
+    const start = this.total;
+    const tag = tools.readVint(this.buffer, this.cursor);
+
+    if (tag == null) {
+      /* istanbul ignore if */
+      if (debug.enabled) {
+        debug('waiting for more data');
+      }
+
+      return false;
+    }
+
+    const tagStr = tools.readHexString(
+      this.buffer,
+      this.cursor,
+      this.cursor + tag.length,
+    );
+    const tagNum = Number.parseInt(tagStr, 16);
+    this.cursor += tag.length;
+    this.total += tag.length;
+    this.state = STATE_SIZE;
+
+    const tagObj = {
+      tag: tag.value,
+      tagStr,
+      type: EbmlDecoder.getSchemaInfo(tagNum).type,
+      name: EbmlDecoder.getSchemaInfo(tagNum).name,
+      start,
+      end: start + tag.length,
+    };
+
+    this.tagStack.push(tagObj);
+    /* istanbul ignore if */
+    if (debug.enabled) {
+      debug(`read tag: ${tagStr}`);
+    }
+
+    return true;
+  }
+
+  /** @private */
+  findTagStart() {
+    while (this.cursor < this.buffer.length) {
+      try {
+        const tag = tools.readVint(this.buffer, this.cursor);
+        if (tag == null) {
+          return false
+        }
+        const tagStr = tools.readHexString(
+          this.buffer,
+          this.cursor,
+          this.cursor + tag.length,
+        );
+        const tagNum = Number.parseInt(tagStr, 16);
+        const tagName = EbmlDecoder.getSchemaInfo(tagNum).name
+        if (tagName && tagName.startsWith('unknown')) {
+          this.cursor += 1
+          continue
+        }
+        if (this.cursor > 0 && !this.total) {
+          this.buffer = this.buffer.subarray(this.cursor)
+          this.cursor = 0
+        }
+        return true
+      } catch (e) {
+        if (!e.message.startsWith('Unrepresentable length')) {
+          throw e
+        }
+        this.cursor += 1
+      }
+    }
+    return false
+  }
+
+  readSize() {
+    const tagObj = this.tagStack[this.tagStack.length - 1];
+
+    /* istanbul ignore if */
+    if (debug.enabled) {
+      debug(`parsing size for tag: ${tagObj.tagStr}`);
+    }
+
+    if (this.cursor >= this.buffer.length) {
+      /* istanbul ignore if */
+      if (debug.enabled) {
+        debug('waiting for more data');
+      }
+
+      return false;
+    }
+
+    const size = tools.readVint(this.buffer, this.cursor);
+
+    if (size == null) {
+      /* istanbul ignore if */
+      if (debug.enabled) {
+        debug('waiting for more data');
+      }
+
+      return false;
+    }
+
+    this.cursor += size.length;
+    this.total += size.length;
+    this.state = STATE_CONTENT;
+    tagObj.dataSize = size.value;
+
+    // unknown size
+    if (size.value === -1) {
+      tagObj.end = -1;
+    } else {
+      tagObj.end += size.value + size.length;
+    }
+    /* istanbul ignore if */
+    if (debug.enabled) {
+      debug(`read size: ${size.value}`);
+    }
+
+    return true;
+  }
+
+  readContent() {
+    const { tagStr, type, dataSize, ...rest } = this.tagStack[this.tagStack.length - 1];
+
+    /* istanbul ignore if */
+    if (debug.enabled) {
+      debug(`parsing content for tag: ${tagStr}`);
+    }
+
+    if (type === 'm') {
+      /* istanbul ignore if */
+      if (debug.enabled) {
+        debug('content should be tags');
+      }
+      this.push(['start', { tagStr, type, dataSize, ...rest }]);
+      this.state = STATE_TAG;
+
+      return true;
+    }
+
+    if (this.buffer.length < this.cursor + dataSize) {
+      /* istanbul ignore if */
+      if (debug.enabled) {
+        debug(`got: ${this.buffer.length}`);
+        debug(`need: ${this.cursor + dataSize}`);
+        debug('waiting for more data');
+      }
+
+      return false;
+    }
+
+    const data = this.buffer.subarray(this.cursor, this.cursor + dataSize);
+    this.total += dataSize;
+    this.state = STATE_TAG;
+    this.buffer = this.buffer.subarray(this.cursor + dataSize);
+    this.cursor = 0;
+
+    this.tagStack.pop(); // remove the object from the stack
+
+    this.push([
+      'tag',
+      tools.readDataFromTag(
+        { tagStr, type, dataSize, ...rest },
+        Buffer.from(data),
+      ),
+    ]);
+
+    while (this.tagStack.length > 0) {
+      const topEle = this.tagStack[this.tagStack.length - 1];
+      if (this.total < topEle.end) {
+        break;
+      }
+      this.push(['end', topEle]);
+      this.tagStack.pop();
+    }
+
+    /* istanbul ignore if */
+    if (debug.enabled) {
+      debug(`read data: ${data.toString('hex')}`);
+    }
+
+    return true;
+  }
+}
+
+module.exports = EbmlDecoder