refactor and export api

Author: martinlindhe

LICENSE

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2015 Martin Lindhe
+Copyright (c) 2015-2017 Martin Lindhe
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.md

@@ -15,10 +15,31 @@ WARNING: The API is unstable, work in progress!
 go get -u github.com/martinlindhe/subtitles
 ```
 
+# Example - convert srt to vtt
 
-# Example
+```go
+in := "1\n" +
+    "00:00:04,630 --> 00:00:06,018\n" +
+    "Go ninja!\n" +
+    "\n" +
+    "1\n" +
+    "00:01:09,630 --> 00:01:11,005\n" +
+    "No ninja!\n"
+
+res, _ := NewFromSRT(in)
+
+// Output: WEBVTT
+//
+// 00:00:04.630 --> 00:00:06.018
+// Go ninja!
+//
+// 00:01:09.630 --> 00:01:11.005
+// No ninja!
+fmt.Println(res.AsVTT())
+```
+
+# Example - download subtitle from thesubdb.com
 
-Fetch subtitle from thesubdb.com:
 ```go
 f, _ := os.Open(fileName)
 defer f.Close()

caption.go

@@ -1,7 +1,6 @@
 package subtitles
 
 import (
-	"fmt"
 	"time"
 )
 
@@ -12,13 +11,3 @@ type Caption struct {
 	End   time.Time
 	Text  []string
 }
-
-// AsSrt renders the caption as srt
-func (cap Caption) AsSrt() string {
-	res := fmt.Sprintf("%d", cap.Seq) + eol +
-		SrtTime(cap.Start) + " --> " + SrtTime(cap.End) + eol
-	for _, line := range cap.Text {
-		res += line + eol
-	}
-	return res + eol
-}

caption_test.go

@@ -18,5 +18,5 @@ func TestRenderTime(t *testing.T) {
 	assert.Equal(t, "1\n"+
 		"18:40:22,110 --> 18:41:20,123\n"+
 		"<i>Go ninja!</i>\n\n",
-		cap.AsSrt())
+		cap.AsSRT())
 }

cleaner.go

@@ -1,7 +1,6 @@
 package subtitles
 
 import (
-	"fmt"
 	"strings"
 	"time"
 
@@ -10,44 +9,45 @@ import (
 
 // CleanupSub parses .srt or .ssa, performs cleanup and renders to a .srt, returning a string. caller is responsible for passing UTF8 string
 func CleanupSub(utf8 string, filterName string, keepAds bool, sync int) (string, error) {
-	var captions []Caption
+	var subtitle Subtitle
+	var err error
 
 	if looksLikeSrt(utf8) {
-		captions = parseSrt(utf8)
+		subtitle, err = NewFromSRT(utf8)
 	} else {
 		// falls back on .ssa decoding, for now
-		captions = parseSsa(utf8)
+		subtitle, err = NewFromSSA(utf8)
+	}
+	if err != nil {
+		return "", err
 	}
 
 	if !keepAds {
-		captions = removeAds(captions)
+		subtitle.removeAds()
 	}
 
 	if sync != 0 {
-		captions = resyncSubs(captions, sync)
+		subtitle.resyncSubs(sync)
 	}
 
-	captions = filterSubs(captions, filterName)
-	out := renderSrt(captions)
+	subtitle.filterSubs(filterName)
+	out := subtitle.AsSRT()
 
 	return out, nil
 }
 
-func resyncSubs(subs []Caption, sync int) []Caption {
-
-	//	var res []caption
-	fmt.Printf("resyncing with %d\n", sync)
-
-	for i := range subs {
-		subs[i].Start = subs[i].Start.Add(time.Duration(sync) * time.Millisecond)
-		subs[i].End = subs[i].End.Add(time.Duration(sync) * time.Millisecond)
+func (subtitle *Subtitle) resyncSubs(sync int) {
+	// log.Printf("resyncing with %d\n", sync)
+	for i := range subtitle.Captions {
+		subtitle.Captions[i].Start = subtitle.Captions[i].Start.
+			Add(time.Duration(sync) * time.Millisecond)
+		subtitle.Captions[i].End = subtitle.Captions[i].End.
+			Add(time.Duration(sync) * time.Millisecond)
 	}
-
-	return subs
 }
 
 // RemoveAds removes advertisement from the subtitles
-func removeAds(subs []Caption) (res []Caption) {
+func (subtitle *Subtitle) removeAds() *Subtitle {
 	ads := []string{
 		// english:
 		"captions paid for by",
@@ -109,7 +109,8 @@ func removeAds(subs []Caption) (res []Caption) {
 	}
 
 	seq := 1
-	for orgSeq, sub := range subs {
+	res := []Caption{}
+	for orgSeq, sub := range subtitle.Captions {
 
 		isAd := false
 
@@ -130,5 +131,6 @@ func removeAds(subs []Caption) (res []Caption) {
 			seq++
 		}
 	}
-	return
+	subtitle.Captions = res
+	return subtitle
 }

cleaner_test.go

@@ -8,7 +8,7 @@ import (
 
 func TestRemoveAds(t *testing.T) {
 
-	in := []Caption{{
+	in := Subtitle{[]Caption{{
 		1,
 		MakeTime(0, 0, 4, 630),
 		MakeTime(0, 0, 6, 18),
@@ -23,9 +23,9 @@ func TestRemoveAds(t *testing.T) {
 		MakeTime(0, 1, 9, 630),
 		MakeTime(0, 1, 11, 005),
 		[]string{"No ninja!"},
-	}}
+	}}}
 
-	expected := []Caption{{
+	expected := Subtitle{[]Caption{{
 		1,
 		MakeTime(0, 0, 4, 630),
 		MakeTime(0, 0, 6, 18),
@@ -35,7 +35,7 @@ func TestRemoveAds(t *testing.T) {
 		MakeTime(0, 1, 9, 630),
 		MakeTime(0, 1, 11, 005),
 		[]string{"No ninja!"},
-	}}
+	}}}
 
-	assert.Equal(t, expected, removeAds(in))
+	assert.Equal(t, &expected, in.removeAds())
 }

filter.go

@@ -5,15 +5,14 @@ import (
 )
 
 // filterSubs pass the captions through a filter function
-func filterSubs(captions []Caption, filter string) []Caption {
+func (subtitle *Subtitle) filterSubs(filter string) {
 	if filter == "caps" {
-		return filterCapitalization(captions)
+		subtitle.filterCapitalization()
 	}
 	if filter == "html" {
-		return filterHTML(captions)
+		subtitle.filterHTML()
 	}
 	if filter != "none" {
 		fmt.Printf("Unrecognized filter name: %s\n", filter)
 	}
-	return captions
 }

caps.go renamed to filter_caps.go

@@ -7,34 +7,28 @@ import (
 )
 
 // filterCapitalization converts "ALL CAPS" text into "Initial letter capped"
-func filterCapitalization(captions []Caption) []Caption {
-
-	for _, cap := range captions {
+func (subtitle *Subtitle) filterCapitalization() *Subtitle {
+	for _, cap := range subtitle.Captions {
 		for i, line := range cap.Text {
 
 			clean := ucFirst(line)
-
 			if clean != cap.Text[i] {
 				log.Printf("[caps] %s -> %s\n", cap.Text[i], clean)
-				cap.Text[i] = clean
+				cap.Text[i] = clean // XXX updated?!
 			}
 		}
 	}
-
-	return captions
+	return subtitle
 }
 
 func ucFirst(s string) string {
-
 	res := ""
-
 	for i, c := range s {
 		if i == 0 {
 			res += strings.ToUpper(string(c))
 		} else {
 			res += strings.ToLower(string(c))
 		}
 	}
-
 	return res
 }

caps_test.go renamed to filter_caps_test.go

@@ -8,19 +8,19 @@ import (
 
 func TestFilterCapitalization(t *testing.T) {
 
-	in := []Caption{{
+	in := Subtitle{Captions: []Caption{{
 		Seq:   1,
 		Start: MakeTime(0, 0, 4, 630),
 		End:   MakeTime(0, 0, 6, 18),
 		Text:  []string{"GO NINJA!", "NINJA GO!"},
-	}}
+	}}}
 
-	expected := []Caption{{
+	expected := Subtitle{[]Caption{{
 		1,
 		MakeTime(0, 0, 4, 630),
 		MakeTime(0, 0, 6, 18),
 		[]string{"Go ninja!", "Ninja go!"},
-	}}
+	}}}
 
-	assert.Equal(t, expected, filterCapitalization(in))
+	assert.Equal(t, &expected, in.filterCapitalization())
 }

html.go renamed to filter_html.go

@@ -7,15 +7,15 @@ import (
 )
 
 // filterHTML removes all html tags from captions
-func filterHTML(captions []Caption) []Caption {
-	for _, cap := range captions {
+func (subtitle *Subtitle) filterHTML() *Subtitle {
+	for _, cap := range subtitle.Captions {
 		for i, line := range cap.Text {
 			clean := sanitize.HTML(line)
 			if clean != cap.Text[i] {
 				log.Printf("[html] %s -> %s\n", cap.Text[i], clean)
-				cap.Text[i] = clean
+				cap.Text[i] = clean // XXX works?!
 			}
 		}
 	}
-	return captions
+	return subtitle
 }