Skip to content

weizhenye/ass-compiler

Repository files navigation

ass-compiler

GitHub Action Codecov License NPM Version jsDelivr File size

Parses and compiles ASS subtitle format to easy-to-use data structure.

Online Viewer

Installation

npm install ass-compiler

Usage

You can use parse or compile as your need.

import { parse, stringify, compile, decompile } from 'ass-compiler'; // ASS file content const text = ` [Script Info] ; ... `; // parse just turn ASS text into JSON const parsedASS = parse(text); const stringifiedText = stringify(parsedASS); // compile will get rid of invalid tags, merge duplicated tags, transform drawings, etc. const compiledASS = compile(text, options); const decompiledText = decompile(compiledASS);

options

{ // Used for default values if it's not in `[Script Info]` section. defaultInfo: { PlayResX: 1280, PlayResY: 720, }, // A Style named `Default` will be automatic generated by options.defaultStyle // if it is not exists in `[V4+ Style]` section. defaultStyle: { Name: 'Default', Fontname: 'Arial', Fontsize: '20', PrimaryColour: '&H00FFFFFF&', SecondaryColour: '&H000000FF&', OutlineColour: '&H00000000&', BackColour: '&H00000000&', Bold: '0', Italic: '0', Underline: '0', StrikeOut: '0', ScaleX: '100', ScaleY: '100', Spacing: '0', Angle: '0', BorderStyle: '1', Outline: '2', Shadow: '2', Alignment: '2', MarginL: '10', MarginR: '10', MarginV: '10', Encoding: '1', }, }

For details of data structure, please use the online viewer.

About

Parses and compiles ASS subtitle format to easy-to-use data structure

Topics

Resources

License

Stars

Watchers

Forks

Packages

 
 
 

Contributors