https://github.com/tpaschalis/gophersub
(Rough, WIP) Go library and command-line utility to work with subtitle files.
https://github.com/tpaschalis/gophersub
go golang golang-library srt subtitles webvtt
Last synced: about 1 year ago
JSON representation
(Rough, WIP) Go library and command-line utility to work with subtitle files.
- Host: GitHub
- URL: https://github.com/tpaschalis/gophersub
- Owner: tpaschalis
- License: mit
- Created: 2019-05-03T11:58:19.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2019-06-03T19:52:45.000Z (about 7 years ago)
- Last Synced: 2025-02-09T04:45:42.094Z (over 1 year ago)
- Topics: go, golang, golang-library, srt, subtitles, webvtt
- Language: Go
- Homepage:
- Size: 143 KB
- Stars: 4
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Roadmap: roadmap.md
Awesome Lists containing this project
README
# gophersub
Go library and command-line utility to work with subtitle files.
gophersub aims to be a powerful library, that makes working with subtitle files a breeze!!
## Features
* Works with SubRip `.srt` (and WebVTT `.vtt` soon!) files
* Designed with modularity and extensibility in mind
* Extensively tested using Table-Driven Tests. Always at >95% coverage
* Easy to work with, either as an imported package or a command-line application (soon!)
Most of the actions you might expect from such a tool are already implemented!
Timeshifting, pacing, searching, adding and deleting new subs, getting practical information (such as running time, or average characters-per-minute)
## Roadmap
Since starting the 'project' I've been jotting down my brainstorming, and created a notepad of ideas that I'd like to implement in the future. All these ideas are available [roadmap.md](/roadmap.md). You're more than welcome to take a look, and propose new ones!
***Currently working on :***
- [ ] WebVTT support
- [ ] Modularize/Split code
- [ ] Add cli support
- [ ] Run SQL Queries
## Examples
```go
got := ParseSRTFile("game-of-thorns-s01e01.srt")
ts := time.Duration(2 * time.Second)
// Subtitle files can be timeshifted
got = TimeshiftSubtitle(got, ts)
// And also their 'pace can be adjusted, eg. to match video playing at 1.5x speed
got, err = PaceSubtitleFile(got, 1.5)
// Subtitles are available for searching, even using Regular Expressions
mentionsOfJon, err := SearchSubtitleFile(got, "Jon")
mentionsOfJD, err := SearchSubtitleFiles(got, "Jon|Dany")
// Along with other common actions, such as adding new subtitles, or deleting unwanted ones
got, err = RemoveSubtitle(got, 10)
got, err = AddSubtitle(got, "5m2.120s", "5m3.302s", "SPOILER ALERT!")
// Save the edited subtitle file
err = ToSRTFile(got, "exports/got-s01e01.srt")
// Subtitle File information is available, such as
// detected overlaps, characters-per-minute, total running time etc
PrintSubfileInfo(got)
// The library can try some optimizations, such as serializing the subtitle indices, removing illegal HTML tags or ...
```
## Prerequisites
* Go >= 1.12
* `go-cmp`(https://github.com/google/go-cmp/) to compare structs, in place of reflection
go-cmp is used to compare structs, in place of reflection and can be installed by running
```
go get -u github.com/google/go-cmp/cmp
```
The library requires at least Go 1.12. Most of the functionality was developed using the standard library, and conscious steps to avoid complicated dependencies
github.com/google/go-cmp/cmp
## Installation
## Logo Information
The logo is homemade. The gopher comes from [egonelbre's repo](https://github.com/egonelbre/gophers) and while the television icon is made by [Freepik](https://www.freepik.com/) from www.flaticon.com.