mirror of
https://github.com/stashapp/stash.git
synced 2025-12-17 12:24:38 +03:00
Caption support (#2462)
Co-authored-by: WithoutPants <53250216+WithoutPants@users.noreply.github.com>
This commit is contained in:
cj
537
vendor/github.com/asticode/go-astisub/webvtt.go
generated
vendored
Normal file
537
vendor/github.com/asticode/go-astisub/webvtt.go
generated
vendored
Normal file
@@ -0,0 +1,537 @@
|
||||
package astisub
|
||||
|
||||
import (
|
||||
"bufio"
|
||||
"bytes"
|
||||
"errors"
|
||||
"fmt"
|
||||
"io"
|
||||
"regexp"
|
||||
"sort"
|
||||
"strconv"
|
||||
"strings"
|
||||
"time"
|
||||
|
||||
"golang.org/x/net/html"
|
||||
)
|
||||
|
||||
// https://www.w3.org/TR/webvtt1/
|
||||
|
||||
// Constants
|
||||
const (
|
||||
webvttBlockNameComment = "comment"
|
||||
webvttBlockNameRegion = "region"
|
||||
webvttBlockNameStyle = "style"
|
||||
webvttBlockNameText = "text"
|
||||
webvttTimeBoundariesSeparator = " --> "
|
||||
webvttTimestampMap = "X-TIMESTAMP-MAP"
|
||||
)
|
||||
|
||||
// Vars
|
||||
var (
|
||||
bytesWebVTTItalicEndTag = []byte("</i>")
|
||||
bytesWebVTTItalicStartTag = []byte("<i>")
|
||||
bytesWebVTTTimeBoundariesSeparator = []byte(webvttTimeBoundariesSeparator)
|
||||
webVTTRegexpStartTag = regexp.MustCompile(`(<v([\.\w]*)([\s\w]+)+>)`)
|
||||
)
|
||||
|
||||
// parseDurationWebVTT parses a .vtt duration
|
||||
func parseDurationWebVTT(i string) (time.Duration, error) {
|
||||
return parseDuration(i, ".", 3)
|
||||
}
|
||||
|
||||
// https://tools.ietf.org/html/rfc8216#section-3.5
|
||||
// Eg., `X-TIMESTAMP-MAP=LOCAL:00:00:00.000,MPEGTS:900000` => 10s
|
||||
// `X-TIMESTAMP-MAP=LOCAL:00:00:00.000,MPEGTS:180000` => 2s
|
||||
func parseTimestampMapWebVTT(line string) (timeOffset time.Duration, err error) {
|
||||
splits := strings.Split(line, "=")
|
||||
if len(splits) <= 1 {
|
||||
err = fmt.Errorf("astisub: invalid X-TIMESTAMP-MAP, no '=' found")
|
||||
return
|
||||
}
|
||||
right := splits[1]
|
||||
|
||||
var local time.Duration
|
||||
var mpegts int64
|
||||
for _, split := range strings.Split(right, ",") {
|
||||
splits := strings.SplitN(split, ":", 2)
|
||||
if len(splits) <= 1 {
|
||||
err = fmt.Errorf("astisub: invalid X-TIMESTAMP-MAP, part %q didn't contain ':'", right)
|
||||
return
|
||||
}
|
||||
|
||||
switch strings.ToLower(strings.TrimSpace(splits[0])) {
|
||||
case "local":
|
||||
local, err = parseDurationWebVTT(splits[1])
|
||||
if err != nil {
|
||||
err = fmt.Errorf("astisub: parsing webvtt duration failed: %w", err)
|
||||
return
|
||||
}
|
||||
case "mpegts":
|
||||
mpegts, err = strconv.ParseInt(splits[1], 10, 0)
|
||||
if err != nil {
|
||||
err = fmt.Errorf("astisub: parsing int %s failed: %w", splits[1], err)
|
||||
return
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
timeOffset = time.Duration(mpegts)*time.Second/90000 - local
|
||||
return
|
||||
}
|
||||
|
||||
// ReadFromWebVTT parses a .vtt content
|
||||
// TODO Tags (u, i, b)
|
||||
// TODO Class
|
||||
func ReadFromWebVTT(i io.Reader) (o *Subtitles, err error) {
|
||||
// Init
|
||||
o = NewSubtitles()
|
||||
var scanner = bufio.NewScanner(i)
|
||||
var line string
|
||||
var lineNum int
|
||||
|
||||
// Skip the header
|
||||
for scanner.Scan() {
|
||||
lineNum++
|
||||
line = scanner.Text()
|
||||
line = strings.TrimPrefix(line, string(BytesBOM))
|
||||
if fs := strings.Fields(line); len(fs) > 0 && fs[0] == "WEBVTT" {
|
||||
break
|
||||
}
|
||||
}
|
||||
|
||||
// Scan
|
||||
var item = &Item{}
|
||||
var blockName string
|
||||
var comments []string
|
||||
var index int
|
||||
var timeOffset time.Duration
|
||||
|
||||
for scanner.Scan() {
|
||||
// Fetch line
|
||||
line = strings.TrimSpace(scanner.Text())
|
||||
lineNum++
|
||||
|
||||
switch {
|
||||
// Comment
|
||||
case strings.HasPrefix(line, "NOTE "):
|
||||
blockName = webvttBlockNameComment
|
||||
comments = append(comments, strings.TrimPrefix(line, "NOTE "))
|
||||
// Empty line
|
||||
case len(line) == 0:
|
||||
// Reset block name
|
||||
blockName = ""
|
||||
// Region
|
||||
case strings.HasPrefix(line, "Region: "):
|
||||
// Add region styles
|
||||
var r = &Region{InlineStyle: &StyleAttributes{}}
|
||||
for _, part := range strings.Split(strings.TrimPrefix(line, "Region: "), " ") {
|
||||
// Split on "="
|
||||
var split = strings.Split(part, "=")
|
||||
if len(split) <= 1 {
|
||||
err = fmt.Errorf("astisub: line %d: Invalid region style %s", lineNum, part)
|
||||
return
|
||||
}
|
||||
|
||||
// Switch on key
|
||||
switch split[0] {
|
||||
case "id":
|
||||
r.ID = split[1]
|
||||
case "lines":
|
||||
if r.InlineStyle.WebVTTLines, err = strconv.Atoi(split[1]); err != nil {
|
||||
err = fmt.Errorf("atoi of %s failed: %w", split[1], err)
|
||||
return
|
||||
}
|
||||
case "regionanchor":
|
||||
r.InlineStyle.WebVTTRegionAnchor = split[1]
|
||||
case "scroll":
|
||||
r.InlineStyle.WebVTTScroll = split[1]
|
||||
case "viewportanchor":
|
||||
r.InlineStyle.WebVTTViewportAnchor = split[1]
|
||||
case "width":
|
||||
r.InlineStyle.WebVTTWidth = split[1]
|
||||
}
|
||||
}
|
||||
r.InlineStyle.propagateWebVTTAttributes()
|
||||
|
||||
// Add region
|
||||
o.Regions[r.ID] = r
|
||||
// Style
|
||||
case strings.HasPrefix(line, "STYLE"):
|
||||
blockName = webvttBlockNameStyle
|
||||
// Time boundaries
|
||||
case strings.Contains(line, webvttTimeBoundariesSeparator):
|
||||
// Set block name
|
||||
blockName = webvttBlockNameText
|
||||
|
||||
// Init new item
|
||||
item = &Item{
|
||||
Comments: comments,
|
||||
Index: index,
|
||||
InlineStyle: &StyleAttributes{},
|
||||
}
|
||||
|
||||
// Reset index
|
||||
index = 0
|
||||
|
||||
// Split line on time boundaries
|
||||
var left = strings.Split(line, webvttTimeBoundariesSeparator)
|
||||
|
||||
// Split line on space to get remaining of time data
|
||||
var right = strings.Split(left[1], " ")
|
||||
|
||||
// Parse time boundaries
|
||||
if item.StartAt, err = parseDurationWebVTT(left[0]); err != nil {
|
||||
err = fmt.Errorf("astisub: line %d: parsing webvtt duration %s failed: %w", lineNum, left[0], err)
|
||||
return
|
||||
}
|
||||
if item.EndAt, err = parseDurationWebVTT(right[0]); err != nil {
|
||||
err = fmt.Errorf("astisub: line %d: parsing webvtt duration %s failed: %w", lineNum, right[0], err)
|
||||
return
|
||||
}
|
||||
|
||||
// Parse style
|
||||
if len(right) > 1 {
|
||||
// Add styles
|
||||
for index := 1; index < len(right); index++ {
|
||||
// Empty
|
||||
if right[index] == "" {
|
||||
continue
|
||||
}
|
||||
|
||||
// Split line on ":"
|
||||
var split = strings.Split(right[index], ":")
|
||||
if len(split) <= 1 {
|
||||
err = fmt.Errorf("astisub: line %d: Invalid inline style '%s'", lineNum, right[index])
|
||||
return
|
||||
}
|
||||
|
||||
// Switch on key
|
||||
switch split[0] {
|
||||
case "align":
|
||||
item.InlineStyle.WebVTTAlign = split[1]
|
||||
case "line":
|
||||
item.InlineStyle.WebVTTLine = split[1]
|
||||
case "position":
|
||||
item.InlineStyle.WebVTTPosition = split[1]
|
||||
case "region":
|
||||
if _, ok := o.Regions[split[1]]; !ok {
|
||||
err = fmt.Errorf("astisub: line %d: Unknown region %s", lineNum, split[1])
|
||||
return
|
||||
}
|
||||
item.Region = o.Regions[split[1]]
|
||||
case "size":
|
||||
item.InlineStyle.WebVTTSize = split[1]
|
||||
case "vertical":
|
||||
item.InlineStyle.WebVTTVertical = split[1]
|
||||
}
|
||||
}
|
||||
}
|
||||
item.InlineStyle.propagateWebVTTAttributes()
|
||||
|
||||
// Reset comments
|
||||
comments = []string{}
|
||||
|
||||
// Append item
|
||||
o.Items = append(o.Items, item)
|
||||
|
||||
case strings.HasPrefix(line, webvttTimestampMap):
|
||||
if len(item.Lines) > 0 {
|
||||
err = errors.New("astisub: found timestamp map after processing subtitle items")
|
||||
return
|
||||
}
|
||||
|
||||
timeOffset, err = parseTimestampMapWebVTT(line)
|
||||
if err != nil {
|
||||
err = fmt.Errorf("astisub: parsing webvtt timestamp map failed: %w", err)
|
||||
return
|
||||
}
|
||||
|
||||
// Text
|
||||
default:
|
||||
// Switch on block name
|
||||
switch blockName {
|
||||
case webvttBlockNameComment:
|
||||
comments = append(comments, line)
|
||||
case webvttBlockNameStyle:
|
||||
// TODO Do something with the style
|
||||
case webvttBlockNameText:
|
||||
// Parse line
|
||||
if l := parseTextWebVTT(line); len(l.Items) > 0 {
|
||||
item.Lines = append(item.Lines, l)
|
||||
}
|
||||
default:
|
||||
// This is the ID
|
||||
index, _ = strconv.Atoi(line)
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
if timeOffset > 0 {
|
||||
o.Add(timeOffset)
|
||||
}
|
||||
return
|
||||
}
|
||||
|
||||
// parseTextWebVTT parses the input line to fill the Line
|
||||
func parseTextWebVTT(i string) (o Line) {
|
||||
// Create tokenizer
|
||||
tr := html.NewTokenizer(strings.NewReader(i))
|
||||
|
||||
// Loop
|
||||
italic := false
|
||||
for {
|
||||
// Get next tag
|
||||
t := tr.Next()
|
||||
|
||||
// Process error
|
||||
if err := tr.Err(); err != nil {
|
||||
break
|
||||
}
|
||||
|
||||
switch t {
|
||||
case html.EndTagToken:
|
||||
// Parse italic
|
||||
if bytes.Equal(tr.Raw(), bytesWebVTTItalicEndTag) {
|
||||
italic = false
|
||||
continue
|
||||
}
|
||||
case html.StartTagToken:
|
||||
// Parse voice name
|
||||
if matches := webVTTRegexpStartTag.FindStringSubmatch(string(tr.Raw())); len(matches) > 3 {
|
||||
if s := strings.TrimSpace(matches[3]); s != "" {
|
||||
o.VoiceName = s
|
||||
}
|
||||
continue
|
||||
}
|
||||
|
||||
// Parse italic
|
||||
if bytes.Equal(tr.Raw(), bytesWebVTTItalicStartTag) {
|
||||
italic = true
|
||||
continue
|
||||
}
|
||||
case html.TextToken:
|
||||
if s := strings.TrimSpace(string(tr.Raw())); s != "" {
|
||||
// Get style attribute
|
||||
var sa *StyleAttributes
|
||||
if italic {
|
||||
sa = &StyleAttributes{
|
||||
WebVTTItalics: italic,
|
||||
}
|
||||
sa.propagateWebVTTAttributes()
|
||||
}
|
||||
|
||||
// Append item
|
||||
o.Items = append(o.Items, LineItem{
|
||||
InlineStyle: sa,
|
||||
Text: s,
|
||||
})
|
||||
}
|
||||
}
|
||||
}
|
||||
return
|
||||
}
|
||||
|
||||
// formatDurationWebVTT formats a .vtt duration
|
||||
func formatDurationWebVTT(i time.Duration) string {
|
||||
return formatDuration(i, ".", 3)
|
||||
}
|
||||
|
||||
// WriteToWebVTT writes subtitles in .vtt format
|
||||
func (s Subtitles) WriteToWebVTT(o io.Writer) (err error) {
|
||||
// Do not write anything if no subtitles
|
||||
if len(s.Items) == 0 {
|
||||
err = ErrNoSubtitlesToWrite
|
||||
return
|
||||
}
|
||||
|
||||
// Add header
|
||||
var c []byte
|
||||
c = append(c, []byte("WEBVTT\n\n")...)
|
||||
|
||||
// Add regions
|
||||
var k []string
|
||||
for _, region := range s.Regions {
|
||||
k = append(k, region.ID)
|
||||
}
|
||||
sort.Strings(k)
|
||||
for _, id := range k {
|
||||
c = append(c, []byte("Region: id="+s.Regions[id].ID)...)
|
||||
if s.Regions[id].InlineStyle.WebVTTLines != 0 {
|
||||
c = append(c, bytesSpace...)
|
||||
c = append(c, []byte("lines="+strconv.Itoa(s.Regions[id].InlineStyle.WebVTTLines))...)
|
||||
} else if s.Regions[id].Style != nil && s.Regions[id].Style.InlineStyle != nil && s.Regions[id].Style.InlineStyle.WebVTTLines != 0 {
|
||||
c = append(c, bytesSpace...)
|
||||
c = append(c, []byte("lines="+strconv.Itoa(s.Regions[id].Style.InlineStyle.WebVTTLines))...)
|
||||
}
|
||||
if s.Regions[id].InlineStyle.WebVTTRegionAnchor != "" {
|
||||
c = append(c, bytesSpace...)
|
||||
c = append(c, []byte("regionanchor="+s.Regions[id].InlineStyle.WebVTTRegionAnchor)...)
|
||||
} else if s.Regions[id].Style != nil && s.Regions[id].Style.InlineStyle != nil && s.Regions[id].Style.InlineStyle.WebVTTRegionAnchor != "" {
|
||||
c = append(c, bytesSpace...)
|
||||
c = append(c, []byte("regionanchor="+s.Regions[id].Style.InlineStyle.WebVTTRegionAnchor)...)
|
||||
}
|
||||
if s.Regions[id].InlineStyle.WebVTTScroll != "" {
|
||||
c = append(c, bytesSpace...)
|
||||
c = append(c, []byte("scroll="+s.Regions[id].InlineStyle.WebVTTScroll)...)
|
||||
} else if s.Regions[id].Style != nil && s.Regions[id].Style.InlineStyle != nil && s.Regions[id].Style.InlineStyle.WebVTTScroll != "" {
|
||||
c = append(c, bytesSpace...)
|
||||
c = append(c, []byte("scroll="+s.Regions[id].Style.InlineStyle.WebVTTScroll)...)
|
||||
}
|
||||
if s.Regions[id].InlineStyle.WebVTTViewportAnchor != "" {
|
||||
c = append(c, bytesSpace...)
|
||||
c = append(c, []byte("viewportanchor="+s.Regions[id].InlineStyle.WebVTTViewportAnchor)...)
|
||||
} else if s.Regions[id].Style != nil && s.Regions[id].Style.InlineStyle != nil && s.Regions[id].Style.InlineStyle.WebVTTViewportAnchor != "" {
|
||||
c = append(c, bytesSpace...)
|
||||
c = append(c, []byte("viewportanchor="+s.Regions[id].Style.InlineStyle.WebVTTViewportAnchor)...)
|
||||
}
|
||||
if s.Regions[id].InlineStyle.WebVTTWidth != "" {
|
||||
c = append(c, bytesSpace...)
|
||||
c = append(c, []byte("width="+s.Regions[id].InlineStyle.WebVTTWidth)...)
|
||||
} else if s.Regions[id].Style != nil && s.Regions[id].Style.InlineStyle != nil && s.Regions[id].Style.InlineStyle.WebVTTWidth != "" {
|
||||
c = append(c, bytesSpace...)
|
||||
c = append(c, []byte("width="+s.Regions[id].Style.InlineStyle.WebVTTWidth)...)
|
||||
}
|
||||
c = append(c, bytesLineSeparator...)
|
||||
}
|
||||
if len(s.Regions) > 0 {
|
||||
c = append(c, bytesLineSeparator...)
|
||||
}
|
||||
|
||||
// Loop through subtitles
|
||||
for index, item := range s.Items {
|
||||
// Add comments
|
||||
if len(item.Comments) > 0 {
|
||||
c = append(c, []byte("NOTE ")...)
|
||||
for _, comment := range item.Comments {
|
||||
c = append(c, []byte(comment)...)
|
||||
c = append(c, bytesLineSeparator...)
|
||||
}
|
||||
c = append(c, bytesLineSeparator...)
|
||||
}
|
||||
|
||||
// Add time boundaries
|
||||
c = append(c, []byte(strconv.Itoa(index+1))...)
|
||||
c = append(c, bytesLineSeparator...)
|
||||
c = append(c, []byte(formatDurationWebVTT(item.StartAt))...)
|
||||
c = append(c, bytesWebVTTTimeBoundariesSeparator...)
|
||||
c = append(c, []byte(formatDurationWebVTT(item.EndAt))...)
|
||||
|
||||
// Add styles
|
||||
if item.InlineStyle != nil {
|
||||
if item.InlineStyle.WebVTTAlign != "" {
|
||||
c = append(c, bytesSpace...)
|
||||
c = append(c, []byte("align:"+item.InlineStyle.WebVTTAlign)...)
|
||||
} else if item.Style != nil && item.Style.InlineStyle != nil && item.Style.InlineStyle.WebVTTAlign != "" {
|
||||
c = append(c, bytesSpace...)
|
||||
c = append(c, []byte("align:"+item.Style.InlineStyle.WebVTTAlign)...)
|
||||
}
|
||||
if item.InlineStyle.WebVTTLine != "" {
|
||||
c = append(c, bytesSpace...)
|
||||
c = append(c, []byte("line:"+item.InlineStyle.WebVTTLine)...)
|
||||
} else if item.Style != nil && item.Style.InlineStyle != nil && item.Style.InlineStyle.WebVTTLine != "" {
|
||||
c = append(c, bytesSpace...)
|
||||
c = append(c, []byte("line:"+item.Style.InlineStyle.WebVTTLine)...)
|
||||
}
|
||||
if item.InlineStyle.WebVTTPosition != "" {
|
||||
c = append(c, bytesSpace...)
|
||||
c = append(c, []byte("position:"+item.InlineStyle.WebVTTPosition)...)
|
||||
} else if item.Style != nil && item.Style.InlineStyle != nil && item.Style.InlineStyle.WebVTTPosition != "" {
|
||||
c = append(c, bytesSpace...)
|
||||
c = append(c, []byte("position:"+item.Style.InlineStyle.WebVTTPosition)...)
|
||||
}
|
||||
if item.Region != nil {
|
||||
c = append(c, bytesSpace...)
|
||||
c = append(c, []byte("region:"+item.Region.ID)...)
|
||||
}
|
||||
if item.InlineStyle.WebVTTSize != "" {
|
||||
c = append(c, bytesSpace...)
|
||||
c = append(c, []byte("size:"+item.InlineStyle.WebVTTSize)...)
|
||||
} else if item.Style != nil && item.Style.InlineStyle != nil && item.Style.InlineStyle.WebVTTSize != "" {
|
||||
c = append(c, bytesSpace...)
|
||||
c = append(c, []byte("size:"+item.Style.InlineStyle.WebVTTSize)...)
|
||||
}
|
||||
if item.InlineStyle.WebVTTVertical != "" {
|
||||
c = append(c, bytesSpace...)
|
||||
c = append(c, []byte("vertical:"+item.InlineStyle.WebVTTVertical)...)
|
||||
} else if item.Style != nil && item.Style.InlineStyle != nil && item.Style.InlineStyle.WebVTTVertical != "" {
|
||||
c = append(c, bytesSpace...)
|
||||
c = append(c, []byte("vertical:"+item.Style.InlineStyle.WebVTTVertical)...)
|
||||
}
|
||||
}
|
||||
|
||||
// Add new line
|
||||
c = append(c, bytesLineSeparator...)
|
||||
|
||||
// Loop through lines
|
||||
for _, l := range item.Lines {
|
||||
c = append(c, l.webVTTBytes()...)
|
||||
}
|
||||
|
||||
// Add new line
|
||||
c = append(c, bytesLineSeparator...)
|
||||
}
|
||||
|
||||
// Remove last new line
|
||||
c = c[:len(c)-1]
|
||||
|
||||
// Write
|
||||
if _, err = o.Write(c); err != nil {
|
||||
err = fmt.Errorf("astisub: writing failed: %w", err)
|
||||
return
|
||||
}
|
||||
return
|
||||
}
|
||||
|
||||
func (l Line) webVTTBytes() (c []byte) {
|
||||
if l.VoiceName != "" {
|
||||
c = append(c, []byte("<v "+l.VoiceName+">")...)
|
||||
}
|
||||
for idx, li := range l.Items {
|
||||
c = append(c, li.webVTTBytes()...)
|
||||
// condition to avoid adding space as the last character.
|
||||
if idx < len(l.Items)-1 {
|
||||
c = append(c, []byte(" ")...)
|
||||
}
|
||||
}
|
||||
c = append(c, bytesLineSeparator...)
|
||||
return
|
||||
}
|
||||
|
||||
func (li LineItem) webVTTBytes() (c []byte) {
|
||||
// Get color
|
||||
var color string
|
||||
if li.InlineStyle != nil && li.InlineStyle.TTMLColor != nil {
|
||||
color = cssColor(*li.InlineStyle.TTMLColor)
|
||||
}
|
||||
|
||||
// Get italics
|
||||
i := li.InlineStyle != nil && li.InlineStyle.WebVTTItalics
|
||||
|
||||
// Append
|
||||
if color != "" {
|
||||
c = append(c, []byte("<c."+color+">")...)
|
||||
}
|
||||
if i {
|
||||
c = append(c, []byte("<i>")...)
|
||||
}
|
||||
c = append(c, []byte(li.Text)...)
|
||||
if i {
|
||||
c = append(c, []byte("</i>")...)
|
||||
}
|
||||
if color != "" {
|
||||
c = append(c, []byte("</c>")...)
|
||||
}
|
||||
return
|
||||
}
|
||||
|
||||
func cssColor(rgb string) string {
|
||||
colors := map[string]string{
|
||||
"#00ffff": "cyan", // narrator, thought
|
||||
"#ffff00": "yellow", // out of vision
|
||||
"#ff0000": "red", // noises
|
||||
"#ff00ff": "magenta", // song
|
||||
"#00ff00": "lime", // foreign speak
|
||||
}
|
||||
return colors[strings.ToLower(rgb)] // returning the empty string is ok
|
||||
}
|
||||
Reference in New Issue
Block a user