Compare commits

...

5 commits
v1.2.0 ... main

Author SHA1 Message Date
dd54e8cc49
add warnings for exceeding metadata character length
All checks were successful
/ build-linux-amd64 (push) Successful in 2m47s
2026-02-01 17:08:16 +00:00
9f32aedc3b
exclude dot-prefixed files from footage scan
All checks were successful
/ build-linux-amd64 (push) Successful in 3m18s
2026-01-31 18:10:39 +00:00
c52290392d
update README 2026-01-31 04:19:20 +00:00
51a1de845f
fix crummy ffprobe json output handling
All checks were successful
/ build-linux-amd64 (push) Successful in 1m35s
2026-01-31 04:04:32 +00:00
f4381f7cdc
real girls forget to pass pointers at 3am
All checks were successful
/ build-linux-amd64 (push) Successful in 1m10s
2026-01-31 03:22:17 +00:00
3 changed files with 85 additions and 35 deletions

View file

@ -14,8 +14,13 @@ I built this to greatly simplify the process of getting my full-quality livestre
$ vodular
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 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 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).
**IMPORTANT:** `config.toml` contains very sensitive credentials. Do not share this file with anyone.
3. Initialise a VOD directory:
@ -63,10 +68,11 @@ url = 'https://example.org'
```
## Templates
Template files can be created at `templates/title.txt`,
`template/description.txt`, and `templates/tags.txt` respectively. These
files can use Go's [text template format](https://pkg.go.dev/text/template) to
customise VOD metadata on upload.
There are three template files, `title.txt`, `description.txt`, and `tags.txt`,
which can be created in `/path/to/vodular/templates`. These templates can be
created and tweaked to customise your VOD metadata on upload. They are enhanced
with Go's [template format](https://pkg.go.dev/text/template) to inject
information provided in `metadata.toml`, and other neat functionality!
You can use the following data in templates:
- **`.Title`:** The title of the stream.

49
main.go
View file

@ -6,6 +6,7 @@ import (
"encoding/json"
"fmt"
"log"
"math"
"net/http"
"os"
"path"
@ -25,7 +26,9 @@ import (
//go:embed res/help.txt
var helpText string
const segmentExtension = "mkv"
const SEGMENT_EXTENSION = "mkv"
const MAX_TITLE_LEN = 100
const MAX_DESCRIPTION_LEN = 5000
func showHelp() {
fmt.Println(helpText)
@ -193,7 +196,7 @@ func main() {
}
// scan for VOD segments
vodFiles, err := scanner.ScanSegments(metadata.FootageDir, segmentExtension)
vodFiles, err := scanner.ScanSegments(metadata.FootageDir, SEGMENT_EXTENSION)
if err != nil {
log.Fatalf("Failed to fetch VOD filenames: %v", err)
os.Exit(1)
@ -201,7 +204,7 @@ func main() {
if len(vodFiles) == 0 {
log.Fatalf(
"Directory contained no VOD files (expecting .%s)",
segmentExtension,
SEGMENT_EXTENSION,
)
os.Exit(1)
}
@ -220,11 +223,6 @@ func main() {
log.Fatalf("Failed to build video template: %v", err)
os.Exit(1)
}
if verbose {
enc := json.NewEncoder(os.Stdout)
fmt.Printf("\nVideo template: ")
enc.Encode(video)
title, err := yt.BuildTemplate(video, templates.Title)
if err != nil {
log.Fatalf("Failed to build video title: %v", err)
@ -235,6 +233,25 @@ func main() {
log.Fatalf("Failed to build video description: %v", err)
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(
"\n================================\n\n" +
"< TITLE >\n%s\n\n" +
@ -247,18 +264,21 @@ func main() {
// concatenate VOD segments into full VOD
fullVodExists := func () bool {
// check if full VOD already exists with expected duration
if fullVodProbe, err := scanner.ProbeSegment(video.Filename); err != nil {
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(filename)
probe, err := scanner.ProbeSegment(path.Join(metadata.FootageDir, filename))
if err != nil { continue }
totalLength += probe.Format.Duration
}
return fullVodProbe.Format.Duration == totalLength
}
return false
return math.Abs(fullVodProbe.Format.Duration - totalLength) < float64(0.1)
}()
if !fullVodExists {
if fullVodExists {
log.Print("Full VOD appears to already exist- uploading this file...")
} else {
video.SizeBytes, err = vid.ConcatVideo(video, vodFiles, verbose)
if err != nil {
log.Fatalf("Failed to concatenate VOD segments: %v", err)
@ -313,6 +333,7 @@ func main() {
log.Print("Video uploaded successfully!")
// update metadata to reflect VOD is uploaded
// TODO: rather than a boolean flag, link to actual video
metadata.Uploaded = true
err = scanner.WriteMetadata(directory, metadata)
if err != nil {

View file

@ -4,6 +4,7 @@ import (
"encoding/json"
"os"
"path"
"strconv"
"strings"
"time"
@ -28,13 +29,13 @@ type (
Category *Category `toml:"category" comment:"(Optional) Category details, for additional credits."`
}
ffprobeFormat struct {
FFprobeFormat struct {
Duration float64 `json:"duration"`
Size int64 `json:"size"`
}
ffprobeOutput struct {
Format ffprobeFormat `json:"format"`
FFprobeOutput struct {
Format FFprobeFormat `json:"format"`
}
)
@ -50,6 +51,7 @@ func ScanSegments(directory string, extension string) ([]string, error) {
for _, item := range entries {
if item.IsDir() { continue }
if strings.HasPrefix(item.Name(), ".") { continue }
if !strings.HasSuffix(item.Name(), "." + extension) { continue }
if strings.HasSuffix(item.Name(), "-fullvod." + extension) { continue }
files = append(files, item.Name())
@ -58,15 +60,36 @@ func ScanSegments(directory string, extension string) ([]string, error) {
return files, nil
}
func ProbeSegment(filename string) (*ffprobeOutput, error) {
func ProbeSegment(filename string) (*FFprobeOutput, error) {
out, err := ffmpeg_go.Probe(filename)
if err != nil { return nil, err }
probe := ffprobeOutput{}
err = json.Unmarshal([]byte(out), probe)
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 }
return &probe, nil
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) {