Merge pull request #1 from goatandsheep/init

init commit

Author: goatandsheep

README.md

@@ -1,16 +1,16 @@
-# WebVTT compiler parser and segmenter
+# Subrip (.srt) compiler parser and segmenter
 
-Compiles, parses WebVTT files, segments and generates HLS playlists for them.
+Compiles, parses Subrip files, segments and generates HLS playlists for them.
 
-[![CircleCI](https://circleci.com/gh/osk/node-webvtt.svg?style=svg)](https://circleci.com/gh/osk/node-webvtt)
+[![CircleCI](https://circleci.com/gh/goatandsheep/node-srt.svg?style=svg)](https://circleci.com/gh/goatandsheep/node-srt)
+
+This is a sister package to [osk/node-webvtt](https://github.com/osk/node-webvtt).
 
 ## Usage
 
-For a WebVTT file:
+For a Subrip file:
 
 ```text
-WEBVTT
-
 00:00:00.000 --> 00:00:01.000
 Hello world!
 
@@ -24,24 +24,24 @@ Foo
 Bar
 ```
 
-We can parse, segment and create HLS playlists, and compile back to WebVTT format:
+We can parse, segment and create HLS playlists, and compile back to Subrip format:
 
 ```javascript
-const webvtt = require('node-webvtt');
+const subrip = require('node-srt');
 
 const segmentDuration = 10; // default to 10
 const startOffset = 0; // Starting MPEG TS offset to be used in timestamp map, default 900000
 
-const parsed = webvtt.parse(input);
-const compile = webvtt.compile(input);
-const segmented = webvtt.parse(input, segmentDuration);
-const playlist = webvtt.hls.hlsSegmentPlaylist(input, segmentDuration);
-const segments = webvtt.hls.hlsSegment(input, segmentDuration, startOffset);
+const parsed = subrip.parse(input);
+const compile = subrip.compile(input);
+const segmented = subrip.parse(input, segmentDuration);
+const playlist = subrip.hls.hlsSegmentPlaylist(input, segmentDuration);
+const segments = subrip.hls.hlsSegment(input, segmentDuration, startOffset);
 ```
 
 ### Parsing
 
-Parses the WebVTT file and returns an object with `valid === true` if parsed correctly and an array of cues parsed.
+Parses the Subrip file and returns an object with `valid === true` if parsed correctly and an array of cues parsed.
 
 Each cue can have:
 
@@ -51,7 +51,7 @@ Each cue can have:
 * `text` - Text of the subtitle
 * `styles` - If any of the cue
 
-If the WebVTT file is invalid, the parser will throw a `ParserError` exception. So for safety, calls to `parse` should be in `try catch`.
+If the Subrip file is invalid, the parser will throw a `ParserError` exception. So for safety, calls to `parse` should be in `try catch`.
 
 For the above example we'd get:
 
@@ -124,21 +124,17 @@ result = {
 
 ### Metadata
 
-Some WebVTT strings may also contain lines of metadata after the initial `WEBVTT` line, for example:
+Some Subrip strings may also contain lines of metadata after the initial `WEBVTT` line, for example:
 
 ```text
-WEBVTT
-Kind: captions
-Language: en
-
 00:00:00.000 --> 00:00:01.000
 Hello world!
 ```
 
 By passing `{ meta: true }` to the `parse` method, these metadata will be returned as an object called `meta`. For example, parsing the above example:
 
 ```javascript
-parse(webvtt, { meta: true });
+parse(subrip, { meta: true });
 ```
 
 would return the following:
@@ -166,7 +162,7 @@ If no metadata is available, `meta` will be set to `null` in the result if the o
 
 ### Compiling
 
-Compiles JSON from the above format back into a WebVTT string. If a `meta` key is in the input,
+Compiles JSON from the above format back into a Subrip string. If a `meta` key is in the input,
 it will be compiled as well. The `meta` value must be an object and each key and value must be a string.
 
 If the object is missing any attributes, the compiler will throw a `CompilerError` exception. So
@@ -191,10 +187,6 @@ const input = {
 const result = compile(input);
 
 /*
-WEBVTT
-Kind: captions
-Language: en
-
 1
 00:02:15.001 --> 00:02:20.000
 Hello world
@@ -267,16 +259,16 @@ Creates a list of HLS segments for the subtitles, returning an array of them wit
 
 ## CLI
 
-For segmenting a WebVTT file quickly, you can use the included CLI tool:
+For segmenting a Subrip file quickly, you can use the included CLI tool:
 
 ```bash
-./webvtt-segment.js -v --target-duration 10 -o ./subs subs.vtt
+./subrip-segment.js -v --target-duration 10 -o ./subs subs.vtt
 ```
 
 ```bash
-$ ./webvtt-segment.js --help
+$ ./subrip-segment.js --help
 
-  Usage: webvtt-segment [options] <webvtt file>
+  Usage: subrip-segment [options] <subrip file>
 
   Options:
 

bin/webvtt-segment.js bin/subrip-segment.jsbin/webvtt-segment.js renamed to bin/subrip-segment.js

@@ -8,7 +8,7 @@ const program = require('commander');
 
 program
   .version('0.0.1')
-  .usage('[options] <webvtt file>')
+  .usage('[options] <subrip file>')
   .option('-t, --target-duration [duration]',
     'Target duration for each segment in secods, defaults to 10',
     parseInt,
@@ -24,7 +24,7 @@ const input = program.args;
 const t = program.targetDuration || 10;
 const outputDir = program.outputDirectory || './';
 
-log('Hi there! Let’s try and parse and segment a webvtt file, shall we');
+log('Hi there! Let’s try and parse and segment a subrip file, shall we');
 log(`Output directory is: ${outputDir}`);
 log(`Target duration is: ${t}`);
 

lib/compiler.js

@@ -29,22 +29,12 @@ function compile (input) {
     throw new CompilerError('Input must be valid');
   }
 
-  let output = 'WEBVTT\n';
-
-  if (input.meta) {
-    if (typeof input.meta !== 'object' || Array.isArray(input.meta)) {
-      throw new CompilerError('Metadata must be an object');
-    }
-
-    Object.entries(input.meta).forEach((i) => {
-      if (typeof i[1] !== 'string') {
-        throw new CompilerError(`Metadata value for "${i[0]}" must be string`);
-      }
-
-      output += `${i[0]}: ${i[1]}\n`;
-    });
+  if (input && (!input.cues || input.cues.length < 1)) {
+    return '';
   }
 
+  let output = '';
+
   let lastTime = null;
 
   input.cues.forEach((cue, index) => {
@@ -55,12 +45,11 @@ function compile (input) {
 
     lastTime = cue.start;
 
-    output += '\n';
     output += compileCue(cue);
-    output += '\n';
+    output += '\n\n';
   });
 
-  return output;
+  return output.slice(0, -1);
 }
 
 /**

lib/hls.js

@@ -13,8 +13,7 @@ function hlsSegment (input, segmentLength, startOffset) {
   const result = [];
   segments.forEach((seg, i) => {
 
-    const content = `WEBVTT
-X-TIMESTAMP-MAP=MPEGTS:${startOffset},LOCAL:00:00:00.000
+    const content = `X-TIMESTAMP-MAP=MPEGTS:${startOffset},LOCAL:00:00:00.000
 
 ${printableCues(seg.cues)}
 `;
@@ -49,7 +48,7 @@ function pad (num, n) {
 }
 
 function generateSegmentFilename (index) {
-  return `${index}.vtt`;
+  return `${index}.srt`;
 }
 
 function printableSegments (segments) {

lib/parser.js

@@ -18,7 +18,7 @@ function parse (input, options) {
     options = {};
   }
 
-  const { meta = false, strict = true } = options;
+  const { strict = true } = options;
 
   if (typeof input !== 'string') {
     throw new ParserError('Input must be a string');
@@ -29,59 +29,23 @@ function parse (input, options) {
   input = input.replace(/\r/g, '\n');
 
   const parts = input.split('\n\n');
-  const header = parts.shift();
-
-  if (!header.startsWith('WEBVTT')) {
-    throw new ParserError('Must start with "WEBVTT"');
-  }
-
-  const headerParts = header.split('\n');
-
-  const headerComments = headerParts[0].replace('WEBVTT', '');
-
-  if (headerComments.length > 0
-      && (headerComments[0] !== ' ' && headerComments[0] !== '\t')
-  ) {
-    throw new ParserError('Header comment must start with space or tab');
-  }
 
   // nothing of interests, return early
-  if (parts.length === 0 && headerParts.length === 1) {
+  if (parts.length === 0) {
     return { valid: true, strict, cues: [], errors: [] };
   }
 
-  if (!meta && headerParts.length > 1 && headerParts[1] !== '') {
-    throw new ParserError('Missing blank line after signature');
-  }
-
   const { cues, errors } = parseCues(parts, strict);
 
   if (strict && errors.length > 0) {
     throw errors[0];
   }
 
-  const headerMeta = meta ? parseMeta(headerParts) : null;
-
   const result = { valid: errors.length === 0, strict, cues, errors };
 
-  if (meta) {
-    result.meta = headerMeta;
-  }
-
   return result;
 }
 
-function parseMeta (headerParts) {
-  const meta = {};
-  headerParts.slice(1).forEach(header => {
-    const splitIdx = header.indexOf(':');
-    const key = header.slice(0, splitIdx).trim();
-    const value = header.slice(splitIdx + 1).trim();
-    meta[key] = value;
-  });
-  return Object.keys(meta).length > 0 ? meta : null;
-}
-
 function parseCues (cues, strict) {
   const errors = [];
 
@@ -145,6 +109,8 @@ function parseCue (cue, i, strict) {
       !validTimestamp(times[0]) ||
       !validTimestamp(times[1])) {
 
+    console.log('times', times);
+    console.log('lines', lines);
     throw new ParserError(`Invalid cue timestamp (cue #${i})`);
   }
 

package-lock.json

@@ -1,26 +1,26 @@
 {
-  "name": "node-webvtt",
+  "name": "node-srt",
   "version": "1.9.3",
-  "description": "WebVTT parser, compiler, and segmenter with HLS support",
+  "description": "SRT parser, compiler, and segmenter with HLS support",
   "main": "index.js",
   "scripts": {
     "eslint": "eslint *.js **/*.js",
     "test": "npm run eslint -s && nyc mocha -R dot"
   },
   "keywords": [
-    "webvtt",
-    "vtt",
     "segment",
     "hls",
     "subtitle",
     "closed",
-    "caption"
+    "caption",
+    "srt",
+    "subrip"
   ],
   "repository": {
     "type": "git",
-    "url": "git://github.com/osk/node-webvtt"
+    "url": "git://github.com/goatandsheep/node-srt"
   },
-  "author": "Ólafur Sverrir Kjartansson <kjarni@gmail.com>",
+  "author": "Kemal Ahmed <goatandsheep@gmail.com>",
   "license": "MIT",
   "devDependencies": {
     "chai": "^4.2.0",
@@ -40,7 +40,7 @@
     "index.js"
   ],
   "bin": {
-    "webvtt-segment": "./bin/webvtt-segment.js"
+    "subrip-segment": "./bin/subrip-segment.js"
   },
   "nyc": {
     "extension": [