@alessmicrosystems/mpegts.js 1.8.1

package/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -0,0 +1,158 @@
+mpegts.js  [![npm](https://img.shields.io/npm/v/mpegts.js.svg?style=flat)](https://www.npmjs.com/package/mpegts.js)
+======
+[日本語](README_ja.md)  [中文说明](README_zh.md)
+
+HTML5 MPEG2-TS stream player written in TypeScript & JavaScript.
+
+mpegts.js is optimized for low-latency live stream playback, such as DVB/ISDB television or surveillance cameras.
+
+This project is based on [flv.js](https://github.com/bilibili/flv.js).
+
+## Overview
+mpegts.js works by transmuxing MPEG2-TS stream into ISO BMFF (Fragmented MP4) segments, followed by feeding mp4 segments into an HTML5 `<video>` element through [Media Source Extensions][] API.
+
+[Media Source Extensions]: https://w3c.github.io/media-source/
+
+## News
+- **v1.8.0**
+
+    Support working on **iOS Safari** with iOS 17.1+ through Apple's [ManagedMediaSource API](https://github.com/w3c/media-source/issues/320)
+
+    Great performance improvements by supporting [MSE in Workers](https://github.com/w3c/media-source/issues/175) on Chrome, Safari 18 (includes iOS)
+
+    Introduced support for [AV1 over MPEG-TS](https://aomediacodec.github.io/av1-mpeg2-ts/)
+
+    Introduced support for AV1 over HTTP-FLV defined in [Enhanced RTMP](https://github.com/veovera/enhanced-rtmp)
+
+    Support chasing live latency more smoothly by changing playback rate
+
+    Introduced ATSC EAC-3 audio codec in MPEG-TS
+
+    Support Opus and FLAC audio codec over HTTP-FLV (Enhanced RTMP)
+
+- **v1.7.3**
+
+    Introduced [Enhanced RTMP] with HEVC support for FLV.
+
+    Introduced Opus and ATSC AC-3 audio codec support for MPEG-TS.
+
+    Introduced LOAS AAC support for MPEG-TS.
+
+- **v1.7.0**
+
+    Introduced H.265/HEVC over MPEG-TS/FLV support.
+
+[Enhanced RTMP]: https://github.com/veovera/enhanced-rtmp
+## Demo
+[http://xqq.github.io/mpegts.js/demo/](http://xqq.github.io/mpegts.js/demo/)
+
+[demo with aribb24.js](http://xqq.github.io/mpegts.js/demo/arib.html)
+
+## Features
+- Playback for MPEG2-TS stream with H.264/H.265 + AAC codec transported in http(s) or WebSocket
+- Playback for FLV stream with H.264/H.265 + AAC codec transported in http(s) or WebSocket
+- Extremely low latency of less than 1 second in the best case
+- Playback for `.m2ts` file like BDAV/BDMV with 192 bytes TS packet, or 204 bytes TS packet
+- Support handling dynamic codec parameters change (e.g. video resolution change)
+- Support Chrome, FireFox, Safari, Edge (Old or Chromium) or any Chromium-based browsers
+- Support chasing latency automatically for internal buffer of HTMLMediaElement
+- Low CPU overhead and low memory usage (JS heap takes about 10MiB for each instance)
+- Support extracting PES private data (stream_type=0x06) like ARIB B24 subtitles (with [aribb24.js][])
+- Support Timed ID3 Metadata (stream_type=0x15) callback (TIMED_ID3_METADATA_ARRIVED)
+
+[aribb24.js]: https://github.com/monyone/aribb24.js
+
+## CORS
+If you use standalone video server for MPEG2-TS stream, `Access-Control-Allow-Origin` header must be configured correctly on video server for cross-origin resource fetching.
+
+See [cors.md](docs/cors.md) for more details.
+
+## Installation
+```bash
+npm install --save mpegts.js
+```
+
+## Build
+```bash
+npm install                 # install dev-dependencies
+npm install -g webpack-cli  # install build tool
+npm run build               # packaged & minimized js will be emitted in dist folder
+```
+
+[cnpm](https://github.com/cnpm/cnpm) mirror is recommended if you are in Mainland China.
+
+## Getting Started
+```html
+<script src="mpegts.js"></script>
+<video id="videoElement"></video>
+<script>
+    if (mpegts.getFeatureList().mseLivePlayback) {
+        var videoElement = document.getElementById('videoElement');
+        var player = mpegts.createPlayer({
+            type: 'mse',  // could also be mpegts, m2ts, flv
+            isLive: true,
+            url: 'http://example.com/live/livestream.ts'
+        });
+        player.attachMediaElement(videoElement);
+        player.load();
+        player.play();
+    }
+</script>
+```
+mpegts.js could be tested with [Simple Realtime Server](https://github.com/ossrs/srs/).
+
+## TODO
+- MPEG2-TS static file playback (seeking is not supported now)
+
+## Limitations
+- mpeg2video is not supported
+- HTTP MPEG2-TS live stream could not work on old browsers like IE11
+- mpegts.js is not usable on iOS version 17.0 or older caused by the banning of [Media Source Extensions][] (available on iPadOS), iOS 17.1 works through Managed Media Source API
+
+## Features inherited from flv.js
+- FLV container with H.264 + AAC / MP3 codec playback
+- Multipart segmented video playback
+- HTTP FLV low latency live stream playback
+- FLV over WebSocket live stream playback
+- Compatible with Chrome, FireFox, Safari 10, IE11 and Edge
+- Extremely low overhead, and hardware accelerated by your browser!
+
+## FLV playback limitations
+- MP3 audio codec is currently not working on IE11 / Edge
+- HTTP FLV live stream is not currently working on all browsers, see [livestream.md](docs/livestream.md)
+
+## FLV Multipart playback
+You only have to provide a playlist for `MediaDataSource`. See [multipart.md](docs/multipart.md)
+
+## Livestream playback
+See [livestream.md](docs/livestream.md)
+
+## API and Configuration
+See [api.md](docs/api.md)
+
+## Debug
+```bash
+npm install                 # install dev-dependencies
+npm install -g webpack-cli  # install build tool
+npm run build:debug         # packaged & minimized js will be emitted in dist folder
+```
+
+## Design
+See [design.md](docs/design.md)
+
+## License
+```
+Copyright (C) 2021 magicxqq. All Rights Reserved.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+```

package/README_ja.md

@@ -0,0 +1,153 @@
+mpegts.js  [![npm](https://img.shields.io/npm/v/mpegts.js.svg?style=flat)](https://www.npmjs.com/package/mpegts.js)
+======
+MPEG2-TS ストリームを HTML5 上で再生するビデオプレーヤーです。
+
+mpegts.js はライブ配信に対し、低遅延再生のために最適化しています。DVB/ISDB のテレビチャンネルや監視カメラの映像等を低遅延で再生可能になります。
+
+mpegts.js は [flv.js](https://github.com/bilibili/flv.js) を基づいて作ってきたものです。
+
+## Overview
+mpegts.js は、JavaScript で MPEG2-TS ストリームを解析しながら、映像と音声のデータを ISO BMFF (fmp4) フォーマットのフラグメントにリマックスして、[Media Source Extensions][] を通じて `<video>` 要素に提供することで再生することにしています。
+
+[Media Source Extensions]: https://w3c.github.io/media-source/
+
+## News
+- **v1.8.0**
+
+    **iOS Safari**（iOS 17.1+）での動作をサポートし、Apple の [ManagedMediaSource API](https://github.com/w3c/media-source/issues/320) を使用
+
+    [MSE in Workers](https://github.com/w3c/media-source/issues/175) 利用により、パフォーマンスが大幅に向上：Chrome と Safari 18（iOS 含む）対応
+
+    [AV1 over MPEG-TS](https://aomediacodec.github.io/av1-mpeg2-ts/) をサポート
+
+    [Enhanced RTMP](https://github.com/veovera/enhanced-rtmp) の定義による AV1 over HTTP-FLV をサポート
+
+    再生速度を動的に変更することで、ライブ遅延の追従をよりスムーズにできる
+
+    MPEG-TS に ATSC EAC-3 音声サポートを追加
+
+    HTTP-FLV（Enhanced RTMP）で Opus および FLAC 音声サポートを追加
+
+- **v1.7.3**
+
+    [Enhanced RTMP](https://github.com/veovera/enhanced-rtmp) における FLV での HEVC 転送の仕様をサポート
+
+    MPEG-TS に Opus および ATSC AC-3 音声コーデックのサポートを追加
+
+    MPEG-TS に LOAS AAC 再生のサポートを追加
+
+- **v1.7.0**
+
+    H.265/HEVC 再生のサポートを追加（FLV および MPEG-TS の両方で対応）
+
+
+## Demo
+[http://xqq.github.io/mpegts.js/demo/](http://xqq.github.io/mpegts.js/demo/)
+
+[demo with aribb24.js](http://xqq.github.io/mpegts.js/demo/arib.html)
+
+## Features
+- http(s) または WebSocket で伝送する H.264 + AAC の MPEG2-TS ストリームが再生可能
+- 最良の場合は 1 秒以内の低遅延が達成可能
+- TS packet が 192 bytes の `.m2ts` ファイル（BDAV/BDMV）、または 204 bytes も再生可能
+- 動的パラメータ切り替えが可能 （例えば、映像解像度が途中に切り替わっても再生します）
+- Chrome, FireFox, Safari, Edge (Old or Chromium) または Chromium-based ブラウザで実行可能
+- HTMLMediaElement 内部バッファーの遅延を追いかける機能
+- 低い CPU 使用率とメモリ使用量 （1つのインスタンスが概ね 10MiB のメモリかかります）
+- ARIB-B24 字幕等の PES private data (stream_type=0x06) が抽出可能 （[aribb24.js][] と共同運用可能）
+- Timed ID3 Metadata (stream_type=0x15) のコールバック支援 (TIMED_ID3_METADATA_ARRIVED)
+
+[aribb24.js]: https://github.com/monyone/aribb24.js
+
+## CORS
+MPEG2-TS ストリームが別のサーバー上にある場合、`Access-Control-Allow-Origin` は必須です。
+
+[cors.md](docs/cors.md) を参照してください。
+
+## Installation
+```bash
+npm install --save mpegts.js
+```
+
+## Build
+```bash
+npm install                 # install dev-dependencies
+npm install -g webpack-cli  # install build tool
+npm run build               # packaged & minimized js will be emitted in dist folder
+```
+
+## Getting Started
+```html
+<script src="mpegts.js"></script>
+<video id="videoElement"></video>
+<script>
+    if (mpegts.getFeatureList().mseLivePlayback) {
+        var videoElement = document.getElementById('videoElement');
+        var player = mpegts.createPlayer({
+            type: 'mse',  // could also be mpegts, m2ts, flv
+            isLive: true,
+            url: 'http://example.com/live/livestream.ts'
+        });
+        player.attachMediaElement(videoElement);
+        player.load();
+        player.play();
+    }
+</script>
+```
+[Simple Realtime Server](https://github.com/ossrs/srs/) を用いて mpegts.js をテストすることができます。
+
+## TODO
+- 静的 MPEG2-TS ファイルの再生 （現時点ではシークできません）
+
+## Limitations
+- mpeg2video はサポートしていません。映像は H.264 であることが求められます
+- IE11 などの古いブラウザでは、HTTP MPEG2-TS がライブ視聴できません
+- iOS では、[Media Source Extensions][] が禁じられたため使えませんが、iPadOS では使用可能
+
+## Features inherited from flv.js
+- H.264 + AAC/MP3 codec の FLV ファイルが再生可能
+- マルチパットな複数の FLV ファイルも一緒に再生可能
+- HTTP FLV のライブストリームが低遅延で再生可能
+- WebSocket で伝送する FLV ストリームも再生可能
+- Chrome, FireFox, Safari 10, IE11 and Edge のブラウザで実行可能
+- ブラウザによる hardware accelerated があるためコストは非常に低い
+
+## FLV playback limitations
+- MP3 audio codec は IE11 / Edge でサポートされていません
+- HTTP FLV のライブストリームは一部のブラウザで再生できません。[livestream.md](docs/livestream.md) を参照
+
+## FLV Multipart playback
+[multipart.md](docs/multipart.md) を参照
+
+## Livestream playback
+[livestream.md](docs/livestream.md) を参照
+
+## API and Configuration
+[api.md](docs/api.md) を参照
+
+## Debug
+```bash
+npm install                 # install dev-dependencies
+npm install -g webpack-cli  # install build tool
+npm run build:debug         # packaged & minimized js will be emitted in dist folder
+```
+
+## Design
+[design.md](docs/design.md) を参照
+
+## License
+```
+Copyright (C) 2021 magicxqq. All Rights Reserved.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+```

package/README_zh.md

@@ -0,0 +1,157 @@
+mpegts.js  [![npm](https://img.shields.io/npm/v/mpegts.js.svg?style=flat)](https://www.npmjs.com/package/mpegts.js)
+======
+[日本語](README_ja.md)
+
+mpegts.js 是在 HTML5 上直接播放 MPEG2-TS 流的播放器，针对低延迟直播优化，可用于 DVB/ISDB 数字电视流或监控摄像头等的低延迟回放。
+
+mpegts.js 基于 [flv.js](https://github.com/bilibili/flv.js) 改造而来。
+
+## Overview
+mpegts.js 通过在 JavaScript 中渐进化解析 MPEG2-TS 流并实时转封装为 ISO BMFF (Fragmented MP4)，然后通过 [Media Source Extensions][] 把音视频数据喂入 HTML5 `<video>` 元素。
+
+[Media Source Extensions]: https://w3c.github.io/media-source/
+
+## News
+- **v1.8.0**
+
+    支持在 **iOS Safari**（iOS 17.1+）上运行，使用 Apple [ManagedMediaSource API](https://github.com/w3c/media-source/issues/320)
+
+    通过使用 [MSE in Workers](https://github.com/w3c/media-source/issues/175) 来显著提升性能（适用于 Chrome 和 Safari 18，包括 iOS）
+
+    支持 [AV1 over MPEG-TS](https://aomediacodec.github.io/av1-mpeg2-ts/)
+
+    支持 AV1 over HTTP-FLV，定义于 [Enhanced RTMP](https://github.com/veovera/enhanced-rtmp)
+
+    支持更平滑的直播延迟追赶（通过动态改变播放速率）
+
+    MPEG-TS 新增 ATSC EAC-3 音频支持
+
+    HTTP-FLV（Enhanced RTMP）新增 Opus 和 FLAC 音频支持
+
+- **v1.7.3**
+
+    支持 [Enhanced RTMP] 中关于 FLV 传输 HEVC 的规范
+
+    MPEG-TS 新增了对 Opus 和 ATSC AC-3 音频编码支持
+
+    MPEG-TS 新增了 LOAS AAC 播放支持
+
+- **v1.7.0**
+
+    H.265/HEVC 播放支持（FLV 或 MPEG-TS 均已支持）
+
+[Enhanced RTMP]: https://github.com/veovera/enhanced-rtmp
+
+## Demo
+[http://xqq.github.io/mpegts.js/demo/](http://xqq.github.io/mpegts.js/demo/)
+
+[demo with aribb24.js](http://xqq.github.io/mpegts.js/demo/arib.html)
+
+## Features
+- 回放 http(s) 或 WebSocket 上承载的 H.264/H.265 + AAC 编码的 MPEG2-TS 流
+- 回放 http(s) 或 WebSocket 上承载的 H.264/H.265 + AAC 编码的 FLV 流
+- 超低延迟，最佳情况延迟可低达 1 秒以内
+- 回放 TS packet 为 192 字节的 `.m2ts` 文件（BDAV/BDMV）或 204 字节的 TS 流
+- 支持动态编码参数切换，如视频分辨率动态变化
+- 支持 Chrome, FireFox, Safari, Edge (Old or Chromium) 或任何基于 Chromium 的浏览器
+- 支持对 HTMLMediaElement 内部缓冲的自动延迟追赶
+- 极低的 CPU 使用率和内存使用量（单个实例约使用 JS 堆 10MiB）
+- 支持 PES private data 回调 (stream_type=0x06)，如 ARIB B24 字幕 （可配合 [aribb24.js][]）
+- 支持 Timed ID3 Metadata (stream_type=0x15) 回调 (TIMED_ID3_METADATA_ARRIVED)
+
+[aribb24.js]: https://github.com/monyone/aribb24.js
+
+## CORS
+若在与页面不同的独立的服务器串流，必须设置 CORS 的 `Access-Control-Allow-Origin` 头。
+
+参阅 [cors.md](docs/cors.md)。
+
+## Installation
+```bash
+npm install --save mpegts.js
+```
+
+## Build
+```bash
+npm install                 # install dev-dependencies
+npm install -g webpack-cli  # install build tool
+npm run build               # packaged & minimized js will be emitted in dist folder
+```
+
+若在中国大陆可尝试 [cnpm](https://github.com/cnpm/cnpm) 镜像。
+
+## Getting Started
+```html
+<script src="mpegts.js"></script>
+<video id="videoElement"></video>
+<script>
+    if (mpegts.getFeatureList().mseLivePlayback) {
+        var videoElement = document.getElementById('videoElement');
+        var player = mpegts.createPlayer({
+            type: 'mse',  // could also be mpegts, m2ts, flv
+            isLive: true,
+            url: 'http://example.com/live/livestream.ts'
+        });
+        player.attachMediaElement(videoElement);
+        player.load();
+        player.play();
+    }
+</script>
+```
+可使用 [Simple Realtime Server](https://github.com/ossrs/srs/) 来测试 mpegts.js。
+
+## TODO
+- MPEG2-TS 静态文件回放 （目前还不支持 seek）
+
+## Limitations
+- 不支持 mpeg2video
+- IE11 等旧浏览器不支持 HTTP MPEG2-TS/FLV 直播流回放
+- iOS 由于屏蔽了 [Media Source Extensions][] 因而无法使用，但在 iPadOS 上可用
+
+## Features inherited from flv.js
+- H.264 + AAC / MP3 编码的 FLV 文件回放
+- 多分段 FLV 视频无缝播放
+- HTTP FLV 低延迟直播流回放
+- FLV over WebSocket 直播流回放
+- 兼容 Chrome, FireFox, Safari 10, IE11, Edge
+- 超低开销并且由你的浏览器硬件加速
+
+## FLV playback limitations
+- MP3 编码在 IE11 和旧版 Edge 上不受支持
+- HTTP FLV 直播不支持部分旧浏览器，参阅 [livestream.md](docs/livestream.md)
+
+## FLV Multipart playback
+多段播放需要在 `MediaDataSource` 中提供文件列表。参阅 [multipart.md](docs/multipart.md)
+
+## Livestream playback
+参阅 [livestream.md](docs/livestream.md)
+
+## API and Configuration
+参阅 [api.md](docs/api.md)
+
+## Debug
+```bash
+npm install                 # install dev-dependencies
+npm install -g webpack-cli  # install build tool
+npm run build:debug         # packaged & minimized js will be emitted in dist folder
+```
+
+## Design
+参阅 [design.md](docs/design.md)
+
+## License
+```
+Copyright (C) 2021 magicxqq. All Rights Reserved.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+```