Compare commits
No commits in common. "main" and "v1.0.0" have entirely different histories.
6 changed files with 40 additions and 136 deletions
|
|
@ -1,7 +1,7 @@
|
||||||
on:
|
on:
|
||||||
push:
|
push:
|
||||||
tags:
|
branches:
|
||||||
- 'v*'
|
- main
|
||||||
|
|
||||||
jobs:
|
jobs:
|
||||||
build-linux-amd64:
|
build-linux-amd64:
|
||||||
|
|
@ -24,5 +24,3 @@ jobs:
|
||||||
with:
|
with:
|
||||||
direction: upload
|
direction: upload
|
||||||
token: ${{ secrets.RELEASE_TOKEN }}
|
token: ${{ secrets.RELEASE_TOKEN }}
|
||||||
tag: ${{ env.GITHUB_REF_NAME }}
|
|
||||||
|
|
||||||
|
|
|
||||||
16
README.md
16
README.md
|
|
@ -14,13 +14,8 @@ I built this to greatly simplify the process of getting my full-quality livestre
|
||||||
$ vodular
|
$ vodular
|
||||||
New config file created (config.toml). Please edit this file before running again!
|
New config file created (config.toml). Please edit this file before running again!
|
||||||
```
|
```
|
||||||
The directory which holds your configuration file and templates varies,
|
|
||||||
depending on platform:
|
|
||||||
- **Linux:** `~/.config/vodular/templates`
|
|
||||||
- **macOS:** `~/Library/Application Support/vodular/templates`
|
|
||||||
- **Windows:** `%AppData%/vodular/templates`
|
|
||||||
|
|
||||||
2. Edit your configuration file as necessary (You will need to create a [YouTube Data API v3](https://developers.google.com/youtube/v3) service and provide its credentials here).
|
2. Edit configuration file as necessary (You will need to create a [YouTube Data API v3](https://developers.google.com/youtube/v3) service and provide its credentials here).
|
||||||
**IMPORTANT:** `config.toml` contains very sensitive credentials. Do not share this file with anyone.
|
**IMPORTANT:** `config.toml` contains very sensitive credentials. Do not share this file with anyone.
|
||||||
|
|
||||||
3. Initialise a VOD directory:
|
3. Initialise a VOD directory:
|
||||||
|
|
@ -68,11 +63,10 @@ url = 'https://example.org'
|
||||||
```
|
```
|
||||||
|
|
||||||
## Templates
|
## Templates
|
||||||
There are three template files, `title.txt`, `description.txt`, and `tags.txt`,
|
Template files can be created at `templates/title.txt`,
|
||||||
which can be created in `/path/to/vodular/templates`. These templates can be
|
`template/description.txt`, and `templates/tags.txt` respectively. These
|
||||||
created and tweaked to customise your VOD metadata on upload. They are enhanced
|
files can use Go's [text template format](https://pkg.go.dev/text/template) to
|
||||||
with Go's [template format](https://pkg.go.dev/text/template) to inject
|
customise VOD metadata on upload.
|
||||||
information provided in `metadata.toml`, and other neat functionality!
|
|
||||||
|
|
||||||
You can use the following data in templates:
|
You can use the following data in templates:
|
||||||
- **`.Title`:** The title of the stream.
|
- **`.Title`:** The title of the stream.
|
||||||
|
|
|
||||||
|
|
@ -33,7 +33,7 @@ var defaultConfig = Config{
|
||||||
},
|
},
|
||||||
}
|
}
|
||||||
|
|
||||||
var CONFIG_FILENAME string = "config.toml"
|
const CONFIG_FILENAME = "config.toml"
|
||||||
|
|
||||||
func ReadConfig(filename string) (*Config, error) {
|
func ReadConfig(filename string) (*Config, error) {
|
||||||
cfgBytes, err := os.ReadFile(filename)
|
cfgBytes, err := os.ReadFile(filename)
|
||||||
|
|
|
||||||
78
main.go
78
main.go
|
|
@ -6,7 +6,6 @@ import (
|
||||||
"encoding/json"
|
"encoding/json"
|
||||||
"fmt"
|
"fmt"
|
||||||
"log"
|
"log"
|
||||||
"math"
|
|
||||||
"net/http"
|
"net/http"
|
||||||
"os"
|
"os"
|
||||||
"path"
|
"path"
|
||||||
|
|
@ -26,34 +25,22 @@ import (
|
||||||
//go:embed res/help.txt
|
//go:embed res/help.txt
|
||||||
var helpText string
|
var helpText string
|
||||||
|
|
||||||
const SEGMENT_EXTENSION = "mkv"
|
const segmentExtension = "mkv"
|
||||||
const MAX_TITLE_LEN = 100
|
|
||||||
const MAX_DESCRIPTION_LEN = 5000
|
|
||||||
|
|
||||||
func showHelp() {
|
func showHelp() {
|
||||||
fmt.Println(helpText)
|
execSplits := strings.Split(os.Args[0], "/")
|
||||||
os.Exit(0)
|
execName := execSplits[len(execSplits) - 1]
|
||||||
|
fmt.Printf(helpText, execName)
|
||||||
}
|
}
|
||||||
|
|
||||||
func main() {
|
func main() {
|
||||||
// config
|
// config
|
||||||
userConfigDir, err := os.UserConfigDir()
|
|
||||||
if err != nil {
|
|
||||||
log.Fatalf("Could not determine user configuration directory: %v", err)
|
|
||||||
os.Exit(1)
|
|
||||||
}
|
|
||||||
config.CONFIG_FILENAME = path.Join(userConfigDir, "vodular", "config.toml")
|
|
||||||
cfg, err := config.ReadConfig(config.CONFIG_FILENAME)
|
cfg, err := config.ReadConfig(config.CONFIG_FILENAME)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
log.Fatalf("Failed to read config: %v", err)
|
log.Fatalf("Failed to read config: %v", err)
|
||||||
os.Exit(1)
|
os.Exit(1)
|
||||||
}
|
}
|
||||||
if cfg == nil {
|
if cfg == nil {
|
||||||
err = os.MkdirAll(path.Dir(config.CONFIG_FILENAME), 0750)
|
|
||||||
if err != nil {
|
|
||||||
log.Fatalf("Failed to create config directory: %v", err)
|
|
||||||
os.Exit(1)
|
|
||||||
}
|
|
||||||
err = config.GenerateConfig(config.CONFIG_FILENAME)
|
err = config.GenerateConfig(config.CONFIG_FILENAME)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
log.Fatalf("Failed to generate config: %v", err)
|
log.Fatalf("Failed to generate config: %v", err)
|
||||||
|
|
@ -70,6 +57,7 @@ func main() {
|
||||||
// arguments
|
// arguments
|
||||||
if len(os.Args) < 2 || os.Args[1] == "--help" || os.Args[1] == "-h" {
|
if len(os.Args) < 2 || os.Args[1] == "--help" || os.Args[1] == "-h" {
|
||||||
showHelp()
|
showHelp()
|
||||||
|
os.Exit(0)
|
||||||
}
|
}
|
||||||
|
|
||||||
var verbose bool = false
|
var verbose bool = false
|
||||||
|
|
@ -88,6 +76,7 @@ func main() {
|
||||||
fallthrough
|
fallthrough
|
||||||
case "--help":
|
case "--help":
|
||||||
showHelp()
|
showHelp()
|
||||||
|
os.Exit(0)
|
||||||
|
|
||||||
case "-v":
|
case "-v":
|
||||||
fallthrough
|
fallthrough
|
||||||
|
|
@ -154,7 +143,7 @@ func main() {
|
||||||
}
|
}
|
||||||
|
|
||||||
// good to have early on
|
// good to have early on
|
||||||
templates, err := yt.FetchTemplates(path.Join(userConfigDir, "vodular", "templates"))
|
templates, err := yt.FetchTemplates()
|
||||||
if err != nil {
|
if err != nil {
|
||||||
log.Fatalf("Failed to fetch templates: %v", err)
|
log.Fatalf("Failed to fetch templates: %v", err)
|
||||||
os.Exit(1)
|
os.Exit(1)
|
||||||
|
|
@ -196,7 +185,7 @@ func main() {
|
||||||
}
|
}
|
||||||
|
|
||||||
// scan for VOD segments
|
// scan for VOD segments
|
||||||
vodFiles, err := scanner.ScanSegments(metadata.FootageDir, SEGMENT_EXTENSION)
|
vodFiles, err := scanner.ScanSegments(metadata.FootageDir, segmentExtension)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
log.Fatalf("Failed to fetch VOD filenames: %v", err)
|
log.Fatalf("Failed to fetch VOD filenames: %v", err)
|
||||||
os.Exit(1)
|
os.Exit(1)
|
||||||
|
|
@ -204,7 +193,7 @@ func main() {
|
||||||
if len(vodFiles) == 0 {
|
if len(vodFiles) == 0 {
|
||||||
log.Fatalf(
|
log.Fatalf(
|
||||||
"Directory contained no VOD files (expecting .%s)",
|
"Directory contained no VOD files (expecting .%s)",
|
||||||
SEGMENT_EXTENSION,
|
segmentExtension,
|
||||||
)
|
)
|
||||||
os.Exit(1)
|
os.Exit(1)
|
||||||
}
|
}
|
||||||
|
|
@ -223,6 +212,11 @@ func main() {
|
||||||
log.Fatalf("Failed to build video template: %v", err)
|
log.Fatalf("Failed to build video template: %v", err)
|
||||||
os.Exit(1)
|
os.Exit(1)
|
||||||
}
|
}
|
||||||
|
if verbose {
|
||||||
|
enc := json.NewEncoder(os.Stdout)
|
||||||
|
fmt.Printf("\nVideo template: ")
|
||||||
|
enc.Encode(video)
|
||||||
|
|
||||||
title, err := yt.BuildTemplate(video, templates.Title)
|
title, err := yt.BuildTemplate(video, templates.Title)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
log.Fatalf("Failed to build video title: %v", err)
|
log.Fatalf("Failed to build video title: %v", err)
|
||||||
|
|
@ -233,58 +227,21 @@ func main() {
|
||||||
log.Fatalf("Failed to build video description: %v", err)
|
log.Fatalf("Failed to build video description: %v", err)
|
||||||
os.Exit(1)
|
os.Exit(1)
|
||||||
}
|
}
|
||||||
if len(title) > 100 {
|
|
||||||
log.Fatalf(
|
|
||||||
"Video title length exceeds %d characters (%d). YouTube may reject this!",
|
|
||||||
MAX_TITLE_LEN,
|
|
||||||
len(video.Title),
|
|
||||||
)
|
|
||||||
}
|
|
||||||
if len(description) > 5000 {
|
|
||||||
log.Fatalf(
|
|
||||||
"Video description length exceeds %d characters (%d). YouTube may reject this!",
|
|
||||||
MAX_DESCRIPTION_LEN,
|
|
||||||
len(description),
|
|
||||||
)
|
|
||||||
}
|
|
||||||
if verbose {
|
|
||||||
enc := json.NewEncoder(os.Stdout)
|
|
||||||
fmt.Printf("\nVideo template: ")
|
|
||||||
enc.Encode(video)
|
|
||||||
|
|
||||||
fmt.Printf(
|
fmt.Printf(
|
||||||
"\n================================\n\n" +
|
"\n================================\n" +
|
||||||
"< TITLE >\n%s\n\n" +
|
"TITLE:\n%s\n\n" +
|
||||||
"< DESCRIPTION >\n%s\n" +
|
"DESCRIPTION:\n%s\n" +
|
||||||
"\n================================\n",
|
"\n================================\n",
|
||||||
title, description,
|
title, description,
|
||||||
)
|
)
|
||||||
}
|
}
|
||||||
|
|
||||||
// concatenate VOD segments into full VOD
|
// concatenate VOD segments into full VOD
|
||||||
fullVodExists := func () bool {
|
|
||||||
// check if full VOD already exists with expected duration
|
|
||||||
fullVodProbe, err := scanner.ProbeSegment(video.Filename)
|
|
||||||
if err != nil { return false }
|
|
||||||
video.SizeBytes = fullVodProbe.Format.Size
|
|
||||||
var totalLength float64 = 0
|
|
||||||
|
|
||||||
for _, filename := range vodFiles {
|
|
||||||
probe, err := scanner.ProbeSegment(path.Join(metadata.FootageDir, filename))
|
|
||||||
if err != nil { continue }
|
|
||||||
totalLength += probe.Format.Duration
|
|
||||||
}
|
|
||||||
return math.Abs(fullVodProbe.Format.Duration - totalLength) < float64(0.1)
|
|
||||||
}()
|
|
||||||
if fullVodExists {
|
|
||||||
log.Print("Full VOD appears to already exist- uploading this file...")
|
|
||||||
} else {
|
|
||||||
video.SizeBytes, err = vid.ConcatVideo(video, vodFiles, verbose)
|
video.SizeBytes, err = vid.ConcatVideo(video, vodFiles, verbose)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
log.Fatalf("Failed to concatenate VOD segments: %v", err)
|
log.Fatalf("Failed to concatenate VOD segments: %v", err)
|
||||||
os.Exit(1)
|
os.Exit(1)
|
||||||
}
|
}
|
||||||
}
|
|
||||||
|
|
||||||
// youtube oauth flow
|
// youtube oauth flow
|
||||||
ctx := context.Background()
|
ctx := context.Background()
|
||||||
|
|
@ -333,7 +290,6 @@ func main() {
|
||||||
log.Print("Video uploaded successfully!")
|
log.Print("Video uploaded successfully!")
|
||||||
|
|
||||||
// update metadata to reflect VOD is uploaded
|
// update metadata to reflect VOD is uploaded
|
||||||
// TODO: rather than a boolean flag, link to actual video
|
|
||||||
metadata.Uploaded = true
|
metadata.Uploaded = true
|
||||||
err = scanner.WriteMetadata(directory, metadata)
|
err = scanner.WriteMetadata(directory, metadata)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
|
|
|
||||||
|
|
@ -1,15 +1,12 @@
|
||||||
package scanner
|
package scanner
|
||||||
|
|
||||||
import (
|
import (
|
||||||
"encoding/json"
|
|
||||||
"os"
|
"os"
|
||||||
"path"
|
"path"
|
||||||
"strconv"
|
|
||||||
"strings"
|
"strings"
|
||||||
"time"
|
"time"
|
||||||
|
|
||||||
"github.com/pelletier/go-toml/v2"
|
"github.com/pelletier/go-toml/v2"
|
||||||
ffmpeg_go "github.com/u2takey/ffmpeg-go"
|
|
||||||
)
|
)
|
||||||
|
|
||||||
type (
|
type (
|
||||||
|
|
@ -28,15 +25,6 @@ type (
|
||||||
Uploaded bool `toml:"uploaded"`
|
Uploaded bool `toml:"uploaded"`
|
||||||
Category *Category `toml:"category" comment:"(Optional) Category details, for additional credits."`
|
Category *Category `toml:"category" comment:"(Optional) Category details, for additional credits."`
|
||||||
}
|
}
|
||||||
|
|
||||||
FFprobeFormat struct {
|
|
||||||
Duration float64 `json:"duration"`
|
|
||||||
Size int64 `json:"size"`
|
|
||||||
}
|
|
||||||
|
|
||||||
FFprobeOutput struct {
|
|
||||||
Format FFprobeFormat `json:"format"`
|
|
||||||
}
|
|
||||||
)
|
)
|
||||||
|
|
||||||
const METADATA_FILENAME = "metadata.toml"
|
const METADATA_FILENAME = "metadata.toml"
|
||||||
|
|
@ -51,7 +39,6 @@ func ScanSegments(directory string, extension string) ([]string, error) {
|
||||||
|
|
||||||
for _, item := range entries {
|
for _, item := range entries {
|
||||||
if item.IsDir() { continue }
|
if item.IsDir() { continue }
|
||||||
if strings.HasPrefix(item.Name(), ".") { continue }
|
|
||||||
if !strings.HasSuffix(item.Name(), "." + extension) { continue }
|
if !strings.HasSuffix(item.Name(), "." + extension) { continue }
|
||||||
if strings.HasSuffix(item.Name(), "-fullvod." + extension) { continue }
|
if strings.HasSuffix(item.Name(), "-fullvod." + extension) { continue }
|
||||||
files = append(files, item.Name())
|
files = append(files, item.Name())
|
||||||
|
|
@ -60,38 +47,6 @@ func ScanSegments(directory string, extension string) ([]string, error) {
|
||||||
return files, nil
|
return files, nil
|
||||||
}
|
}
|
||||||
|
|
||||||
func ProbeSegment(filename string) (*FFprobeOutput, error) {
|
|
||||||
out, err := ffmpeg_go.Probe(filename)
|
|
||||||
if err != nil { return nil, err }
|
|
||||||
|
|
||||||
type (
|
|
||||||
RawFFprobeFormat struct {
|
|
||||||
// these being strings upsets me immensely
|
|
||||||
Duration string `json:"duration"`
|
|
||||||
Size string `json:"size"`
|
|
||||||
}
|
|
||||||
RawFFprobeOutput struct {
|
|
||||||
Format RawFFprobeFormat `json:"format"`
|
|
||||||
}
|
|
||||||
)
|
|
||||||
|
|
||||||
probe := RawFFprobeOutput{}
|
|
||||||
err = json.Unmarshal([]byte(out), &probe)
|
|
||||||
if err != nil { return nil, err }
|
|
||||||
|
|
||||||
duration, err := strconv.ParseFloat(probe.Format.Duration, 64)
|
|
||||||
if err != nil { return nil, err }
|
|
||||||
size, err := strconv.ParseInt(probe.Format.Size, 10, 0)
|
|
||||||
if err != nil { return nil, err }
|
|
||||||
|
|
||||||
return &FFprobeOutput{
|
|
||||||
Format: FFprobeFormat{
|
|
||||||
Duration: duration,
|
|
||||||
Size: size,
|
|
||||||
},
|
|
||||||
}, nil
|
|
||||||
}
|
|
||||||
|
|
||||||
func ReadMetadata(directory string) (*Metadata, error) {
|
func ReadMetadata(directory string) (*Metadata, error) {
|
||||||
metadata := &Metadata{}
|
metadata := &Metadata{}
|
||||||
file, err := os.OpenFile(
|
file, err := os.OpenFile(
|
||||||
|
|
|
||||||
|
|
@ -113,6 +113,11 @@ var videoYtCategory = map[CategoryType]string {
|
||||||
CATEGORY_ENTERTAINMENT: YT_CATEGORY_ENTERTAINMENT,
|
CATEGORY_ENTERTAINMENT: YT_CATEGORY_ENTERTAINMENT,
|
||||||
}
|
}
|
||||||
|
|
||||||
|
var templateDir = "templates"
|
||||||
|
var tagsPath = path.Join(templateDir, "tags.txt")
|
||||||
|
var titlePath = path.Join(templateDir, "title.txt")
|
||||||
|
var descriptionPath = path.Join(templateDir, "description.txt")
|
||||||
|
|
||||||
const defaultTitleTemplate =
|
const defaultTitleTemplate =
|
||||||
"{{.Title}} - {{FormatTime .Date \"02 Jan 2006\"}}"
|
"{{.Title}} - {{FormatTime .Date \"02 Jan 2006\"}}"
|
||||||
const defaultDescriptionTemplate =
|
const defaultDescriptionTemplate =
|
||||||
|
|
@ -130,13 +135,9 @@ var templateFuncs = template.FuncMap{
|
||||||
},
|
},
|
||||||
}
|
}
|
||||||
|
|
||||||
func FetchTemplates(templateDir string) (*Template, error) {
|
func FetchTemplates() (*Template, error) {
|
||||||
tmpl := Template{}
|
tmpl := Template{}
|
||||||
|
|
||||||
var tagsPath = path.Join(templateDir, "tags.txt")
|
|
||||||
var titlePath = path.Join(templateDir, "title.txt")
|
|
||||||
var descriptionPath = path.Join(templateDir, "description.txt")
|
|
||||||
|
|
||||||
// tags
|
// tags
|
||||||
if tagsFile, err := os.ReadFile(tagsPath); err == nil {
|
if tagsFile, err := os.ReadFile(tagsPath); err == nil {
|
||||||
tmpl.Tags = strings.Split(string(tagsFile), "\n")
|
tmpl.Tags = strings.Split(string(tagsFile), "\n")
|
||||||
|
|
|
||||||
Loading…
Add table
Add a link
Reference in a new issue