https://github.com/weizhenye/ass
A lightweight JavaScript ASS subtitle renderer
https://github.com/weizhenye/ass
ass subtitle
Last synced: 5 months ago
JSON representation
A lightweight JavaScript ASS subtitle renderer
- Host: GitHub
- URL: https://github.com/weizhenye/ass
- Owner: weizhenye
- License: mit
- Created: 2014-02-16T11:44:46.000Z (over 11 years ago)
- Default Branch: master
- Last Pushed: 2025-03-09T13:31:12.000Z (7 months ago)
- Last Synced: 2025-05-14T18:04:39.182Z (5 months ago)
- Topics: ass, subtitle
- Language: JavaScript
- Homepage: https://ass.js.org
- Size: 587 KB
- Stars: 589
- Watchers: 23
- Forks: 85
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# ASS.js
[](https://github.com/weizhenye/ASS/actions)
[](https://codecov.io/gh/weizhenye/ASS)
[](https://github.com/weizhenye/assjs/blob/master/LICENSE)
[](https://bundlephobia.com/result?p=assjs)
・
Online Demo
・
ASS specs (zh-Hans)
・
ass-compiler
・
ASS.js renders ASS subtitles on HTML5 video, with [almost full ASS features](https://github.com/weizhenye/ASS/wiki/Differences-with-Specs).
It's lightweight and suitable for web, **60x** smaller than WebAssembly solutions:
| | Solution | Size |
| - | - | - |
| ASS.js | DOM | 
| [JavascriptSubtitlesOctopus](https://github.com/libass/JavascriptSubtitlesOctopus) | WebAssembly |    |
| [JASSUB](https://github.com/ThaUnknown/jassub) | WebAssembly |    |
WebAssembly solutions also requires to set fallback font to avoid CJK characters turning into tofu, it's a huge cost for web. In ASS.js font fallback is handled by browser, it just works.
However compared to WebAssembly solutions, it's almost impossible for DOM to render exactly same result in every pixels as VSFilter or libass, ASS.js will provide best efforts to accurate rendering.
## Installation
[](https://www.npmjs.com/package/assjs)
[](https://www.jsdelivr.com/package/npm/assjs)
[](https://unpkg.com/assjs/)
```bash
npm install assjs
```
ASS.js can be used as a JavaScript module:
```html
import ASS from '/path/to/assjs/dist/ass.min.js';
```
or a classic script:
```html
console.log(window.ASS);
```
## Usage
```html
```
```js
import ASS from 'assjs';
const content = await fetch('/path/to/example.ass').then((res) => res.text());
const ass = new ASS(content, document.querySelector('#video'), {
container: document.querySelector('#ass-container'),
});
```
`new ASS()` will append several elements to the container, and sync the render area's size with the video element. **You should set styles yourself to make sure the container is overlap on the video and match the position.** For example:
```html
```
If you click the native fullscreen button in video element, only `` will be fullscreened, so ASS will not show. You should use a custom button and call `document.querySelector('#player').requestFullscreen()` to ensure ASS is contained.
## API
#### Initialization
```js
const ass = new ASS(content, video, {
// Subtitles will display in the container.
container: document.getElementById('my-container'),
// see resampling API below
resampling: 'video_width',
});
```
#### Show
```js
ass.show();
```
#### Hide
```js
ass.hide();
```
#### Destroy
```js
ass.destroy();
```
#### Delay
```js
// Subtitles will be 5s later
ass.delay = 5;
// Subtitles will be 3s earlier
ass.delay = -3;
```
#### Resampling
When script resolution(PlayResX and PlayResY) don't match the video resolution, this API defines how it behaves. However, drawings and clips will be always depending on script origin resolution.
There are four valid values, we suppose video resolution is 1280x720 and script resolution is 640x480 in following situations:
* `video_width`: Script resolution will set to video resolution based on video width. Script resolution will set to 640x360, and scale = 1280 / 640 = 2.
* `video_height`(__default__): Script resolution will set to video resolution based on video height. Script resolution will set to 853.33x480, and scale = 720 / 480 = 1.5.
* `script_width`: Script resolution will not change but scale is based on script width. So scale = 1280 / 640 = 2. This may causes top and bottom subs disappear from video area.
* `script_height`: Script resolution will not change but scale is based on script height. So scale = 720 / 480 = 1.5. Script area will be centered in video area.
```js
ass.resampling = 'video_width';
```
## Browser Compatibility
ASS.js uses many Web APIs to render subtitles, some features will be disabled if you use a old browser.
| Feature | Web API | Chrome | Firefox | Safari |
| - | - | - | - | - |
| Auto resize | [ResizeObserver](https://caniuse.com/resizeobserver) | 64 | 69 | 13.1 |
| `\[i]clip` | [clip-path](https://caniuse.com/css-clip-path) and [path()](https://caniuse.com/mdn-css_types_basic-shape_path) | 88 | 97 | 13.1 |
| Animations (`\t`) | [registerProperty()](https://caniuse.com/mdn-api_css_registerproperty_static) | 78 | 128 | 16.4 |
| accel in `\t` | [linear()](https://caniuse.com/mdn-css_types_easing-function_linear-function) | 113 | 112 | 17.2 |
| `\q0` | [text-wrap: balance](https://caniuse.com/css-text-wrap-balance) | 114 | 121 | 17.5 |
| BorderStyle=3 with `\bord0` | [@container](https://caniuse.com/mdn-css_at-rules_container_style_queries_for_custom_properties) | 111 | - | 18.0 |
| `\blur` with `\bord0` | [round()](https://caniuse.com/mdn-css_types_round) | 125 | 118 | 15.4 |