export Caption

martinlindhe · martinlindhe · commit da526ac6a588 · 2017-05-09T22:58:32.000+02:00
diff --git a/caps.go b/caps.go
@@ -7,7 +7,7 @@ import (
 )
 
 // filterCapitalization converts "ALL CAPS" text into "Initial letter capped"
-func filterCapitalization(captions []caption) []caption {
+func filterCapitalization(captions []Caption) []Caption {
 
 	for _, cap := range captions {
 		for i, line := range cap.Text {
diff --git a/caps_test.go b/caps_test.go
@@ -8,14 +8,14 @@ import (
 
 func TestFilterCapitalization(t *testing.T) {
 
-	var in = []caption{{
+	in := []Caption{{
 		Seq:   1,
 		Start: makeTime(0, 0, 4, 630),
 		End:   makeTime(0, 0, 6, 18),
 		Text:  []string{"GO NINJA!", "NINJA GO!"},
 	}}
 
-	var expected = []caption{{
+	expected := []Caption{{
 		1,
 		makeTime(0, 0, 4, 630),
 		makeTime(0, 0, 6, 18),
diff --git a/caption.go b/caption.go
@@ -1,11 +1,24 @@
 package subtitles
 
-import "time"
+import (
+	"fmt"
+	"time"
+)
 
-// caption represents one subtitle block
-type caption struct {
+// Caption represents one subtitle block
+type Caption struct {
 	Seq   int
 	Start time.Time
 	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
+}
diff --git a/caption_test.go b/caption_test.go
@@ -8,12 +8,15 @@ import (
 
 func TestRenderTime(t *testing.T) {
 
-	cap := caption{
+	cap := Caption{
 		1,
 		makeTime(18, 40, 22, 110),
 		makeTime(18, 41, 20, 123),
 		[]string{"<i>Go ninja!</i>"},
 	}
 
-	assert.Equal(t, "18:40:22,110 --> 18:41:20,123", cap.srtTime())
+	assert.Equal(t, "1\n"+
+		"18:40:22,110 --> 18:41:20,123\n"+
+		"<i>Go ninja!</i>\n\n",
+		cap.AsSrt())
 }
diff --git a/cleaner.go b/cleaner.go
@@ -10,8 +10,7 @@ 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 captions []Caption
 
 	if looksLikeSrt(utf8) {
 		captions = parseSrt(utf8)
@@ -29,13 +28,12 @@ func CleanupSub(utf8 string, filterName string, keepAds bool, sync int) (string,
 	}
 
 	captions = filterSubs(captions, filterName)
-
 	out := renderSrt(captions)
 
 	return out, nil
 }
 
-func resyncSubs(subs []caption, sync int) []caption {
+func resyncSubs(subs []Caption, sync int) []Caption {
 
 	//	var res []caption
 	fmt.Printf("resyncing with %d\n", sync)
@@ -49,12 +47,8 @@ func resyncSubs(subs []caption, sync int) []caption {
 }
 
 // RemoveAds removes advertisement from the subtitles
-func removeAds(subs []caption) []caption {
-
-	var res []caption
-
+func removeAds(subs []Caption) (res []Caption) {
 	ads := []string{
-
 		// english:
 		"captions paid for by",
 		"english subtitles",
@@ -136,6 +130,5 @@ func removeAds(subs []caption) []caption {
 			seq++
 		}
 	}
-
-	return res
+	return
 }
diff --git a/cleaner_test.go b/cleaner_test.go
@@ -8,7 +8,7 @@ import (
 
 func TestRemoveAds(t *testing.T) {
 
-	var in = []caption{{
+	in := []Caption{{
 		1,
 		makeTime(0, 0, 4, 630),
 		makeTime(0, 0, 6, 18),
@@ -25,7 +25,7 @@ func TestRemoveAds(t *testing.T) {
 		[]string{"No ninja!"},
 	}}
 
-	var expected = []caption{{
+	expected := []Caption{{
 		1,
 		makeTime(0, 0, 4, 630),
 		makeTime(0, 0, 6, 18),
diff --git a/filter.go b/filter.go
@@ -5,8 +5,7 @@ import (
 )
 
 // filterSubs pass the captions through a filter function
-func filterSubs(captions []caption, filter string) []caption {
-
+func filterSubs(captions []Caption, filter string) []Caption {
 	if filter == "caps" {
 		return filterCapitalization(captions)
 	}
@@ -16,6 +15,5 @@ func filterSubs(captions []caption, filter string) []caption {
 	if filter != "none" {
 		fmt.Printf("Unrecognized filter name: %s\n", filter)
 	}
-
 	return captions
 }
diff --git a/html.go b/html.go
@@ -7,18 +7,15 @@ import (
 )
 
 // filterHTML removes all html tags from captions
-func filterHTML(captions []caption) []caption {
-
+func filterHTML(captions []Caption) []Caption {
 	for _, cap := range 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
 			}
 		}
 	}
-
 	return captions
 }
diff --git a/html_test.go b/html_test.go
@@ -8,14 +8,14 @@ import (
 
 func TestFilterHTML(t *testing.T) {
 
-	var in = []caption{{
+	in := []Caption{{
 		1,
 		makeTime(0, 0, 4, 630),
 		makeTime(0, 0, 6, 18),
 		[]string{"<b>GO NINJA!</b>", "NINJA&nbsp;GO!"},
 	}}
 
-	var expected = []caption{{
+	expected := []Caption{{
 		1,
 		makeTime(0, 0, 4, 630),
 		makeTime(0, 0, 6, 18),
diff --git a/parser.go b/parser.go
@@ -1,7 +1,7 @@
 package subtitles
 
 // parse tries to parse a subtitle from the data stream
-func parse(b []byte) []caption {
+func parse(b []byte) []Caption {
 
 	s := convertToUTF8(b)
 
diff --git a/srt.go b/srt.go
@@ -20,7 +20,7 @@ func looksLikeSrt(s string) bool {
 }
 
 // ParseSrt parses a .srt text into []Caption, assumes s is a clean utf8 string
-func parseSrt(s string) (res []caption) {
+func parseSrt(s string) (res []Caption) {
 	r1 := regexp.MustCompile("([0-9:.,]*) --> ([0-9:.,]*)")
 	lines := strings.Split(s, "\n")
 	outSeq := 1
@@ -37,7 +37,7 @@ func parseSrt(s string) (res []caption) {
 			continue
 		}
 
-		var o caption
+		var o Caption
 		o.Seq = outSeq
 
 		i++
@@ -130,35 +130,21 @@ func ParseTime(in string) (time.Time, error) {
 }
 
 // writeSrt prints a srt render to outFileName
-func writeSrt(subs []caption, outFileName string) error {
+func writeSrt(subs []Caption, outFileName string) error {
 	text := renderSrt(subs)
 	return ioutil.WriteFile(outFileName, []byte(text), 0644)
 }
 
 // renderSrt produces a text representation of the subtitles
-func renderSrt(subs []caption) (res string) {
+func renderSrt(subs []Caption) (res string) {
 	for _, sub := range subs {
-		res += renderCaptionAsSrt(sub)
+		res += sub.AsSrt()
 	}
 	return
 }
 
-func renderCaptionAsSrt(cap caption) string {
-	res := fmt.Sprintf("%d", cap.Seq) + eol +
-		cap.srtTime() + eol
-
-	for _, line := range cap.Text {
-		res += line + eol
-	}
-
-	return res + eol
-}
-
-func renderSrtTime(t time.Time) string {
+// SrtTime renders a timestamp for use in .srt
+func SrtTime(t time.Time) string {
 	res := t.Format("15:04:05.000")
 	return strings.Replace(res, ".", ",", 1)
 }
-
-func (cap caption) srtTime() string {
-	return renderSrtTime(cap.Start) + " --> " + renderSrtTime(cap.End)
-}
diff --git a/srt_test.go b/srt_test.go
@@ -40,7 +40,7 @@ func TestParseSrt(t *testing.T) {
 		"00:01:09,630 --> 00:01:11,005\n" +
 		"No ninja!\n"
 
-	var expected = []caption{{
+	expected := []Caption{{
 		1,
 		makeTime(0, 0, 4, 630),
 		makeTime(0, 0, 6, 18),
@@ -70,7 +70,7 @@ func TestParseSrtWithMacLinebreaks(t *testing.T) {
 		"00:01:09,630 --> 00:01:11,005\r" +
 		"No ninja!\r"
 
-	var expected = []caption{{
+	expected := []Caption{{
 		1,
 		makeTime(0, 0, 4, 630),
 		makeTime(0, 0, 6, 18),
@@ -101,7 +101,7 @@ func TestParseSrtSkipEmpty(t *testing.T) {
 		"00:01:09,630 --> 00:01:11,005\n" +
 		"No ninja!\n"
 
-	var expected = []caption{{
+	expected := []Caption{{
 		1,
 		makeTime(0, 0, 4, 630),
 		makeTime(0, 0, 6, 18),
@@ -123,7 +123,7 @@ func TestParseSrtCrlf(t *testing.T) {
 		"Go ninja!\r\n" +
 		"\r\n"
 
-	var expected = []caption{{
+	expected := []Caption{{
 		1,
 		makeTime(0, 0, 4, 630),
 		makeTime(0, 0, 6, 18),
@@ -143,7 +143,7 @@ func TestParseExtraLineBreak(t *testing.T) {
 		"Go ninja!\r\n" +
 		"\r\n"
 
-	var expected = []caption{{
+	expected := []Caption{{
 		1,
 		makeTime(0, 0, 4, 630),
 		makeTime(0, 0, 6, 18),
@@ -159,7 +159,7 @@ func TestParseWierdTimestamp(t *testing.T) {
 		"00:14:52.00 --> 00:14:57,500\r\n" +
 		"Go ninja!\r\n"
 
-	var expected = []caption{{
+	expected := []Caption{{
 		1,
 		makeTime(0, 14, 52, 0),
 		makeTime(0, 14, 57, 500),
@@ -179,7 +179,7 @@ func TestRenderSrt(t *testing.T) {
 		"00:01:09,630 --> 00:01:11,005\n" +
 		"No ninja!\n\n"
 
-	var in = []caption{{
+	in := []Caption{{
 		1,
 		makeTime(0, 0, 4, 630),
 		makeTime(0, 0, 6, 18),
@@ -199,7 +199,7 @@ func TestParseLatin1Srt(t *testing.T) {
 		"00:14:52.00 --> 00:14:57,500\r\n" +
 		"Hall\xe5 ninja!\r\n"
 
-	var expected = []caption{{
+	expected := []Caption{{
 		1,
 		makeTime(0, 14, 52, 0),
 		makeTime(0, 14, 57, 500),
@@ -228,7 +228,7 @@ func TestParseUTF16BESrt(t *testing.T) {
 		0, '\r', 0, '\n',
 	}
 
-	var expected = []caption{{
+	expected := []Caption{{
 		1,
 		makeTime(0, 0, 0, 0),
 		makeTime(0, 0, 0, 1),
@@ -257,7 +257,7 @@ func TestParseUTF16LESrt(t *testing.T) {
 		'\r', 0, '\n', 0,
 	}
 
-	var expected = []caption{{
+	expected := []Caption{{
 		1,
 		makeTime(0, 0, 0, 0),
 		makeTime(0, 0, 0, 1),
@@ -286,7 +286,7 @@ func TestParseUTF8BomSrt(t *testing.T) {
 		'\r', '\n',
 	}
 
-	var expected = []caption{{
+	expected := []Caption{{
 		1,
 		makeTime(0, 0, 0, 0),
 		makeTime(0, 0, 0, 1),
diff --git a/ssa.go b/ssa.go
diff --git a/ssa_test.go b/ssa_test.go

Original file line number	Diff line number	Diff line change
`@@ -7,7 +7,7 @@ import (`
`7`	`7`	`)`
`8`	`8`
`9`	`9`	`// filterCapitalization converts "ALL CAPS" text into "Initial letter capped"`
`10`		`-func filterCapitalization(captions []caption) []caption {`
	`10`	`+func filterCapitalization(captions []Caption) []Caption {`
`11`	`11`
`12`	`12`	`for _, cap := range captions {`
`13`	`13`	`for i, line := range cap.Text {`
Original file line number	Diff line number	Diff line change
`@@ -5,8 +5,7 @@ import (`
`5`	`5`	`)`
`6`	`6`
`7`	`7`	`// filterSubs pass the captions through a filter function`
`8`		`-func filterSubs(captions []caption, filter string) []caption {`
`9`		`-`
	`8`	`+func filterSubs(captions []Caption, filter string) []Caption {`
`10`	`9`	`if filter == "caps" {`
`11`	`10`	`return filterCapitalization(captions)`
`12`	`11`	`}`
`@@ -16,6 +15,5 @@ func filterSubs(captions []caption, filter string) []caption {`
`16`	`15`	`if filter != "none" {`
`17`	`16`	`fmt.Printf("Unrecognized filter name: %s\n", filter)`
`18`	`17`	`}`
`19`		`-`
`20`	`18`	`return captions`
`21`	`19`	`}`
Original file line number	Diff line number	Diff line change
`@@ -7,18 +7,15 @@ import (`
`7`	`7`	`)`
`8`	`8`
`9`	`9`	`// filterHTML removes all html tags from captions`
`10`		`-func filterHTML(captions []caption) []caption {`
`11`		`-`
	`10`	`+func filterHTML(captions []Caption) []Caption {`
`12`	`11`	`for _, cap := range captions {`
`13`	`12`	`for i, line := range cap.Text {`
`14`	`13`	`clean := sanitize.HTML(line)`
`15`		`-`
`16`	`14`	`if clean != cap.Text[i] {`
`17`	`15`	`log.Printf("[html] %s -> %s\n", cap.Text[i], clean)`
`18`	`16`	`cap.Text[i] = clean`
`19`	`17`	`}`
`20`	`18`	`}`
`21`	`19`	`}`
`22`		`-`
`23`	`20`	`return captions`
`24`	`21`	`}`