1 Commits

6 changed files with 82 additions and 579 deletions

View File

@ -1,10 +1,6 @@
name: Build on push and PRs name: Build on push and PRs
on: on: [push,pull_request]
push:
branches:
- "master"
pull_request:
jobs: jobs:
build: build:

View File

@ -1,9 +1,9 @@
# bump: golang /GOLANG_VERSION=([\d.]+)/ docker:golang|^1 # bump: golang /GOLANG_VERSION=([\d.]+)/ docker:golang|^1
# bump: golang link "Release notes" https://golang.org/doc/devel/release.html # bump: golang link "Release notes" https://golang.org/doc/devel/release.html
ARG GOLANG_VERSION=1.23.0 ARG GOLANG_VERSION=1.20.5
# bump: yt-dlp /YT_DLP=([\d.-]+)/ https://github.com/yt-dlp/yt-dlp.git|/^\d/|sort # bump: yt-dlp /YT_DLP=([\d.-]+)/ https://github.com/yt-dlp/yt-dlp.git|/^\d/|sort
# bump: yt-dlp link "Release notes" https://github.com/yt-dlp/yt-dlp/releases/tag/$LATEST # bump: yt-dlp link "Release notes" https://github.com/yt-dlp/yt-dlp/releases/tag/$LATEST
ARG YT_DLP=2024.08.06 ARG YT_DLP=2023.06.21
FROM golang:$GOLANG_VERSION AS base FROM golang:$GOLANG_VERSION AS base
ARG YT_DLP ARG YT_DLP
@ -12,8 +12,7 @@ RUN \
apt-get update -q && \ apt-get update -q && \
apt-get install -y -q python-is-python3 && \ apt-get install -y -q python-is-python3 && \
curl -L https://github.com/yt-dlp/yt-dlp/releases/download/$YT_DLP/yt-dlp -o /usr/local/bin/yt-dlp && \ curl -L https://github.com/yt-dlp/yt-dlp/releases/download/$YT_DLP/yt-dlp -o /usr/local/bin/yt-dlp && \
chmod a+x /usr/local/bin/yt-dlp && \ chmod a+x /usr/local/bin/yt-dlp
apt-get install -y ffmpeg
FROM base AS dev FROM base AS dev

View File

@ -1,19 +1,18 @@
## goutubedl ## goutubedl
Go wrapper for Go wrapper for [youtube-dl](https://github.com/ytdl-org/youtube-dl) and [yt-dlp](https://github.com/yt-dlp/yt-dlp), currently tested and
[youtube-dl](https://github.com/ytdl-org/youtube-dl) and developed using yt-dlp.
[yt-dlp](https://github.com/yt-dlp/yt-dlp).
Currently only tested and developed using yt-dlp.
API documentation can be found at [godoc.org](https://pkg.go.dev/github.com/wader/goutubedl?tab=doc). API documentation can be found at [godoc.org](https://pkg.go.dev/github.com/wader/goutubedl?tab=doc).
See [yt-dlp documentation](https://github.com/yt-dlp/yt-dlp) for how to See [yt-dlp documentation](https://github.com/yt-dlp/yt-dlp) for how to
install and what is recommended to install in addition to yt-dl. install and what is recommended to install in addition to youtube-dl.
goutubedl default uses `PATH` to find `youtube-dl` or `yt-dlp` (in that order) but can be configured with the goutubedl default uses `PATH` to find youtube-dl but it can be configured with the `goutubedl.Path`
`goutubedl.Path` variable. variable. Default is currently `youtube-dl` for backwards compability. If your using yt-dlp you
probably want to set it to `yt-dlp`.
Due to the nature of and frequent updates of yt-dl only the latest version is tested. Due to the nature and frequent updates of youtube-dl only the latest version
But it seems to work well with older versions also. is tested. But it seems to work well with older versions also.
### Usage ### Usage
@ -53,20 +52,10 @@ func main() {
See [goutubedl cmd tool](cmd/goutubedl/main.go) or [ydls](https://github.com/wader/ydls) See [goutubedl cmd tool](cmd/goutubedl/main.go) or [ydls](https://github.com/wader/ydls)
for usage examples. for usage examples.
### Default options and cache
#### .netrc
goutubedl by default uses `--netrc` to use `~/.netrc` authentication data.
#### Cache directory
yt-dlp stores various extractor session data to speed up things in `${XDG_CACHE_HOME}/yt-dlp` (usually `~/.cache/yt-dlp`). You might want to preverse this directory if your running things in ephemeral conatiners etc.
### Development ### Development
```sh ```sh
docker build --target dev -t goutubedl-dev . docker build -t goutubedl-dev .
docker run --rm -ti -v "$PWD:$PWD" -w "$PWD" goutubedl-dev docker run --rm -ti -v "$PWD:$PWD" -w "$PWD" goutubedl-dev
go test -v -race -cover go test -v -race -cover
``` ```

View File

@ -7,7 +7,6 @@ import (
"io" "io"
"log" "log"
"os" "os"
"os/exec"
"github.com/wader/goutubedl" "github.com/wader/goutubedl"
) )
@ -25,11 +24,7 @@ func main() {
result, err := goutubedl.New( result, err := goutubedl.New(
context.Background(), context.Background(),
flag.Arg(0), flag.Arg(0),
goutubedl.Options{ goutubedl.Options{Type: optType, DebugLog: log.Default()},
Type: optType,
DebugLog: log.Default(),
StderrFn: func(cmd *exec.Cmd) io.Writer { return os.Stderr },
},
) )
if err != nil { if err != nil {
log.Fatal(err) log.Fatal(err)

View File

@ -9,6 +9,7 @@ import (
"errors" "errors"
"fmt" "fmt"
"io" "io"
"io/ioutil"
"net/http" "net/http"
"os" "os"
"os/exec" "os/exec"
@ -17,22 +18,8 @@ import (
"strings" "strings"
) )
// Path to youtube-dl binary. If not set look for "youtube-dl" then "yt-dlp" in PATH. // Path to youtube-dl binary. Default look for "youtube-dl" in PATH.
var Path = "" var Path = "youtube-dl"
func ProbePath() string {
if Path != "" {
return Path
}
for _, n := range []string{"youtube-dl", "yt-dlp"} {
if p, err := exec.LookPath(n); err == nil {
return p
}
}
return "youtube-dl"
}
// Printer is something that can print // Printer is something that can print
type Printer interface { type Printer interface {
@ -128,7 +115,7 @@ type Info struct {
WebpageURL string `json:"webpage_url"` WebpageURL string `json:"webpage_url"`
Description string `json:"description"` Description string `json:"description"`
Thumbnail string `json:"thumbnail"` Thumbnail string `json:"thumbnail"`
// don't unmarshal, populated from image thumbnail file // not unmarshalled, populated from image thumbnail file
ThumbnailBytes []byte `json:"-"` ThumbnailBytes []byte `json:"-"`
Thumbnails []Thumbnail `json:"thumbnails"` Thumbnails []Thumbnail `json:"thumbnails"`
@ -179,7 +166,7 @@ type Subtitle struct {
URL string `json:"url"` URL string `json:"url"`
Ext string `json:"ext"` Ext string `json:"ext"`
Language string `json:"-"` Language string `json:"-"`
// don't unmarshal, populated from subtitle file // not unmarshalled, populated from subtitle file
Bytes []byte `json:"-"` Bytes []byte `json:"-"`
} }
@ -204,44 +191,32 @@ const (
TypeSingle TypeSingle
// TypePlaylist playlist with multiple tracks, files etc // TypePlaylist playlist with multiple tracks, files etc
TypePlaylist TypePlaylist
// TypeChannel channel containing one or more playlists, which will be flattened
TypeChannel
) )
var TypeFromString = map[string]Type{ var TypeFromString = map[string]Type{
"any": TypeAny, "any": TypeAny,
"single": TypeSingle, "single": TypeSingle,
"playlist": TypePlaylist, "playlist": TypePlaylist,
"channel": TypeChannel,
} }
// Options for New() // Options for New()
type Options struct { type Options struct {
Type Type Type Type
PlaylistStart uint // --playlist-start PlaylistStart uint // --playlist-start
PlaylistEnd uint // --playlist-end PlaylistEnd uint // --playlist-end
Downloader string // --downloader Downloader string // --downloader
DownloadThumbnail bool DownloadThumbnail bool
DownloadSubtitles bool DownloadSubtitles bool
DownloadSections string // --download-sections ProxyUrl string // --proxy URL http://host:port or socks5://host:port
ProxyUrl string // --proxy URL http://host:port or socks5://host:port DebugLog Printer
UseIPV4 bool // -4 Make all connections via IPv4 StderrFn func(cmd *exec.Cmd) io.Writer // if not nil, function to get Writer for stderr
CookiesFromBrowser string // --cookies-from-browser BROWSER[:FOLDER] HTTPClient *http.Client // Client for download thumbnail and subtitles (nil use http.DefaultClient)
DebugLog Printer
StderrFn func(cmd *exec.Cmd) io.Writer // if not nil, function to get Writer for stderr
HTTPClient *http.Client // Client for download thumbnail and subtitles (nil use http.DefaultClient)
MergeOutputFormat string // --merge-output-format
SortingFormat string // --format-sort
// Set to true if you don't want to use the result.Info structure after the goutubedl.New() call,
// so the given URL will be downloaded in a single pass in the DownloadResult.Download() call.
noInfoDownload bool
} }
// Version of youtube-dl. // Version of youtube-dl.
// Might be a good idea to call at start to assert that youtube-dl can be found. // Might be a good idea to call at start to assert that youtube-dl can be found.
func Version(ctx context.Context) (string, error) { func Version(ctx context.Context) (string, error) {
cmd := exec.CommandContext(ctx, ProbePath(), "--version") cmd := exec.CommandContext(ctx, Path, "--version")
versionBytes, cmdErr := cmd.Output() versionBytes, cmdErr := cmd.Output()
if cmdErr != nil { if cmdErr != nil {
return "", cmdErr return "", cmdErr
@ -250,35 +225,12 @@ func Version(ctx context.Context) (string, error) {
return strings.TrimSpace(string(versionBytes)), nil return strings.TrimSpace(string(versionBytes)), nil
} }
// Downloads given URL using the given options and filter (usually a format id or quality designator).
// If filter is empty, then youtube-dl will use its default format selector.
func Download(
ctx context.Context,
rawURL string,
options Options,
filter string,
) (*DownloadResult, error) {
options.noInfoDownload = true
d, err := New(ctx, rawURL, options)
if err != nil {
return nil, err
}
return d.Download(ctx, filter)
}
// New downloads metadata for URL // New downloads metadata for URL
func New(ctx context.Context, rawURL string, options Options) (result Result, err error) { func New(ctx context.Context, rawURL string, options Options) (result Result, err error) {
if options.DebugLog == nil { if options.DebugLog == nil {
options.DebugLog = nopPrinter{} options.DebugLog = nopPrinter{}
} }
if options.noInfoDownload {
return Result{
RawURL: rawURL,
Options: options,
}, nil
}
info, rawJSON, err := infoFromURL(ctx, rawURL, options) info, rawJSON, err := infoFromURL(ctx, rawURL, options)
if err != nil { if err != nil {
return Result{}, err return Result{}, err
@ -289,53 +241,35 @@ func New(ctx context.Context, rawURL string, options Options) (result Result, er
return Result{ return Result{
Info: info, Info: info,
RawURL: rawURL,
RawJSON: rawJSONCopy, RawJSON: rawJSONCopy,
Options: options, Options: options,
}, nil }, nil
} }
func infoFromURL( func infoFromURL(ctx context.Context, rawURL string, options Options) (info Info, rawJSON []byte, err error) {
ctx context.Context,
rawURL string,
options Options,
) (info Info, rawJSON []byte, err error) {
cmd := exec.CommandContext( cmd := exec.CommandContext(
ctx, ctx,
ProbePath(), Path,
// see comment below about ignoring errors for playlists // see comment below about ignoring errors for playlists
"--ignore-errors", "--ignore-errors",
// TODO: deprecated in yt-dlp?
"--no-call-home", "--no-call-home",
// use safer output filenmaes "--no-cache-dir",
// TODO: needed? "--skip-download",
"--restrict-filenames", "--restrict-filenames",
// use .netrc authentication data // provide URL via stdin for security, youtube-dl has some run command args
"--netrc",
// provide url via stdin for security, youtube-dl has some run command args
"--batch-file", "-", "--batch-file", "-",
// dump info json "-J",
"--dump-single-json",
) )
if options.ProxyUrl != "" { if options.ProxyUrl != "" {
cmd.Args = append(cmd.Args, "--proxy", options.ProxyUrl) cmd.Args = append(cmd.Args, "--proxy", options.ProxyUrl)
} }
if options.UseIPV4 {
cmd.Args = append(cmd.Args, "-4")
}
if options.Downloader != "" { if options.Downloader != "" {
cmd.Args = append(cmd.Args, "--downloader", options.Downloader) cmd.Args = append(cmd.Args, "--downloader", options.Downloader)
} }
if options.CookiesFromBrowser != "" { if options.Type == TypePlaylist {
cmd.Args = append(cmd.Args, "--cookies-from-browser", options.CookiesFromBrowser)
}
switch options.Type {
case TypePlaylist, TypeChannel:
cmd.Args = append(cmd.Args, "--yes-playlist") cmd.Args = append(cmd.Args, "--yes-playlist")
if options.PlaylistStart > 0 { if options.PlaylistStart > 0 {
@ -348,7 +282,7 @@ func infoFromURL(
"--playlist-end", strconv.Itoa(int(options.PlaylistEnd)), "--playlist-end", strconv.Itoa(int(options.PlaylistEnd)),
) )
} }
case TypeSingle: } else {
if options.DownloadSubtitles { if options.DownloadSubtitles {
cmd.Args = append(cmd.Args, cmd.Args = append(cmd.Args,
"--all-subs", "--all-subs",
@ -357,18 +291,14 @@ func infoFromURL(
cmd.Args = append(cmd.Args, cmd.Args = append(cmd.Args,
"--no-playlist", "--no-playlist",
) )
case TypeAny:
break
default:
return Info{}, nil, fmt.Errorf("unhandled options type value: %d", options.Type)
} }
tempPath, _ := os.MkdirTemp("", "ydls") tempPath, _ := ioutil.TempDir("", "ydls")
defer os.RemoveAll(tempPath) defer os.RemoveAll(tempPath)
stdoutBuf := &bytes.Buffer{} stdoutBuf := &bytes.Buffer{}
stderrBuf := &bytes.Buffer{} stderrBuf := &bytes.Buffer{}
stderrWriter := io.Discard stderrWriter := ioutil.Discard
if options.StderrFn != nil { if options.StderrFn != nil {
stderrWriter = options.StderrFn(cmd) stderrWriter = options.StderrFn(cmd)
} }
@ -442,7 +372,7 @@ func infoFromURL(
if options.DownloadThumbnail && info.Thumbnail != "" { if options.DownloadThumbnail && info.Thumbnail != "" {
resp, respErr := get(info.Thumbnail) resp, respErr := get(info.Thumbnail)
if respErr == nil { if respErr == nil {
buf, _ := io.ReadAll(resp.Body) buf, _ := ioutil.ReadAll(resp.Body)
resp.Body.Close() resp.Body.Close()
info.ThumbnailBytes = buf info.ThumbnailBytes = buf
} }
@ -459,7 +389,7 @@ func infoFromURL(
for i, subtitle := range subtitles { for i, subtitle := range subtitles {
resp, respErr := get(subtitle.URL) resp, respErr := get(subtitle.URL)
if respErr == nil { if respErr == nil {
buf, _ := io.ReadAll(resp.Body) buf, _ := ioutil.ReadAll(resp.Body)
resp.Body.Close() resp.Body.Close()
subtitles[i].Bytes = buf subtitles[i].Bytes = buf
} }
@ -468,31 +398,15 @@ func infoFromURL(
} }
// as we ignore errors for playlists some entries might show up as null // as we ignore errors for playlists some entries might show up as null
// if options.Type == TypePlaylist {
// note: instead of doing full recursion, we assume entries in var filteredEntrise []Info
// playlists and channels are at most 2 levels deep, and we just
// collect entries from both levels.
//
// the following cases have not been tested:
//
// - entries that are more than 2 levels deep (will be missed)
// - the ability to restrict entries to a single level (we include both levels)
if options.Type == TypePlaylist || options.Type == TypeChannel {
var filteredEntries []Info
for _, e := range info.Entries { for _, e := range info.Entries {
if e.Type == "playlist" { if e.ID == "" {
for _, ee := range e.Entries {
if ee.ID == "" {
continue
}
filteredEntries = append(filteredEntries, ee)
}
continue continue
} else if e.ID != "" {
filteredEntries = append(filteredEntries, e)
} }
filteredEntrise = append(filteredEntrise, e)
} }
info.Entries = filteredEntries info.Entries = filteredEntrise
} }
return info, stdoutBuf.Bytes(), nil return info, stdoutBuf.Bytes(), nil
@ -501,7 +415,6 @@ func infoFromURL(
// Result metadata for a URL // Result metadata for a URL
type Result struct { type Result struct {
Info Info Info Info
RawURL string
RawJSON []byte // saved raw JSON. Used later when downloading RawJSON []byte // saved raw JSON. Used later when downloading
Options Options // options passed to New Options Options // options passed to New
} }
@ -512,53 +425,24 @@ type DownloadResult struct {
waitCh chan struct{} waitCh chan struct{}
} }
// Download format matched by filter (usually a format id or quality designator). // Download format matched by filter (usually a format id or "best").
// If filter is empty, then youtube-dl will use its default format selector. // Filter should not be a combine filter like "1+2" as then youtube-dl
// It's a shortcut of DownloadWithOptions where the options use the default value // won't write to stdout.
func (result Result) Download(ctx context.Context, filter string) (*DownloadResult, error) { func (result Result) Download(ctx context.Context, filter string) (*DownloadResult, error) {
return result.DownloadWithOptions(ctx, DownloadOptions{
Filter: filter,
})
}
type DownloadOptions struct {
// Download format matched by filter (usually a format id or quality designator).
// If filter is empty, then youtube-dl will use its default format selector.
Filter string
// The index of the entry to download from the playlist that would be
// passed to youtube-dl via --playlist-items. The index value starts at 1
PlaylistIndex int
}
func (result Result) DownloadWithOptions(
ctx context.Context,
options DownloadOptions,
) (*DownloadResult, error) {
debugLog := result.Options.DebugLog debugLog := result.Options.DebugLog
if !result.Options.noInfoDownload { if result.Info.Type == "playlist" || result.Info.Type == "multi_video" {
if (result.Info.Type == "playlist" || return nil, fmt.Errorf("can't download a playlist")
result.Info.Type == "multi_video" ||
result.Info.Type == "channel") &&
options.PlaylistIndex == 0 {
return nil, fmt.Errorf(
"can't download a playlist when the playlist index options is not set",
)
}
} }
tempPath, tempErr := os.MkdirTemp("", "ydls") tempPath, tempErr := ioutil.TempDir("", "ydls")
if tempErr != nil { if tempErr != nil {
return nil, tempErr return nil, tempErr
} }
jsonTempPath := path.Join(tempPath, "info.json")
var jsonTempPath string if err := ioutil.WriteFile(jsonTempPath, result.RawJSON, 0600); err != nil {
if !result.Options.noInfoDownload { os.RemoveAll(tempPath)
jsonTempPath = path.Join(tempPath, "info.json") return nil, err
if err := os.WriteFile(jsonTempPath, result.RawJSON, 0600); err != nil {
os.RemoveAll(tempPath)
return nil, err
}
} }
dr := &DownloadResult{ dr := &DownloadResult{
@ -567,60 +451,19 @@ func (result Result) DownloadWithOptions(
cmd := exec.CommandContext( cmd := exec.CommandContext(
ctx, ctx,
ProbePath(), Path,
// see comment below about ignoring errors for playlists
"--ignore-errors",
// TODO: deprecated in yt-dlp?
"--no-call-home", "--no-call-home",
// use non-fancy progress bar "--no-cache-dir",
"--ignore-errors",
"--newline", "--newline",
// use safer output filenmaes
// TODO: needed?
"--restrict-filenames", "--restrict-filenames",
// use .netrc authentication data "--load-info", jsonTempPath,
"--netrc", "-o", "-",
// write to stdout
"--output", "-",
) )
if result.Options.noInfoDownload {
// provide URL via stdin for security, youtube-dl has some run command args
cmd.Args = append(cmd.Args, "--batch-file", "-")
cmd.Stdin = bytes.NewBufferString(result.RawURL + "\n")
if result.Options.Type == TypePlaylist {
cmd.Args = append(cmd.Args, "--yes-playlist")
if result.Options.PlaylistStart > 0 {
cmd.Args = append(cmd.Args,
"--playlist-start", strconv.Itoa(int(result.Options.PlaylistStart)),
)
}
if result.Options.PlaylistEnd > 0 {
cmd.Args = append(cmd.Args,
"--playlist-end", strconv.Itoa(int(result.Options.PlaylistEnd)),
)
}
} else {
cmd.Args = append(cmd.Args,
"--no-playlist",
)
}
} else {
cmd.Args = append(cmd.Args, "--load-info", jsonTempPath)
}
// force IPV4 Usage
if result.Options.UseIPV4 {
cmd.Args = append(cmd.Args, "-4")
}
// don't need to specify if direct as there is only one // don't need to specify if direct as there is only one
// also seems to be issues when using filter with generic extractor // also seems to be issues when using filter with generic extractor
if !result.Info.Direct && options.Filter != "" { if !result.Info.Direct {
cmd.Args = append(cmd.Args, "-f", options.Filter) cmd.Args = append(cmd.Args, "-f", filter)
}
if options.PlaylistIndex > 0 {
cmd.Args = append(cmd.Args, "--playlist-items", fmt.Sprint(options.PlaylistIndex))
} }
if result.Options.ProxyUrl != "" { if result.Options.ProxyUrl != "" {
@ -631,38 +474,16 @@ func (result Result) DownloadWithOptions(
cmd.Args = append(cmd.Args, "--downloader", result.Options.Downloader) cmd.Args = append(cmd.Args, "--downloader", result.Options.Downloader)
} }
if result.Options.DownloadSections != "" {
cmd.Args = append(cmd.Args, "--download-sections", result.Options.DownloadSections)
}
if result.Options.CookiesFromBrowser != "" {
cmd.Args = append(cmd.Args, "--cookies-from-browser", result.Options.CookiesFromBrowser)
}
if result.Options.MergeOutputFormat != "" {
cmd.Args = append(cmd.Args,
"--merge-output-format", result.Options.MergeOutputFormat,
)
}
if result.Options.SortingFormat != "" {
cmd.Args = append(cmd.Args,
"--format-sort", result.Options.SortingFormat,
)
}
cmd.Dir = tempPath cmd.Dir = tempPath
var stdoutW io.WriteCloser var w io.WriteCloser
var stderrW io.WriteCloser dr.reader, w = io.Pipe()
var stderrR io.Reader
dr.reader, stdoutW = io.Pipe() stderrWriter := ioutil.Discard
stderrR, stderrW = io.Pipe()
optStderrWriter := io.Discard
if result.Options.StderrFn != nil { if result.Options.StderrFn != nil {
optStderrWriter = result.Options.StderrFn(cmd) stderrWriter = result.Options.StderrFn(cmd)
} }
cmd.Stdout = stdoutW cmd.Stdout = w
cmd.Stderr = io.MultiWriter(optStderrWriter, stderrW) cmd.Stderr = stderrWriter
debugLog.Print("cmd", " ", cmd.Args) debugLog.Print("cmd", " ", cmd.Args)
if err := cmd.Start(); err != nil { if err := cmd.Start(); err != nil {
@ -672,32 +493,12 @@ func (result Result) DownloadWithOptions(
go func() { go func() {
_ = cmd.Wait() _ = cmd.Wait()
stdoutW.Close() w.Close()
stderrW.Close()
os.RemoveAll(tempPath) os.RemoveAll(tempPath)
close(dr.waitCh) close(dr.waitCh)
}() }()
// blocks return until yt-dlp is downloading or has errored return dr, nil
ytErrCh := make(chan error)
go func() {
stderrLineScanner := bufio.NewScanner(stderrR)
for stderrLineScanner.Scan() {
const downloadPrefix = "[download]"
const errorPrefix = "ERROR: "
line := stderrLineScanner.Text()
if strings.HasPrefix(line, downloadPrefix) {
break
} else if strings.HasPrefix(line, errorPrefix) {
ytErrCh <- errors.New(line[len(errorPrefix):])
return
}
}
ytErrCh <- nil
_, _ = io.Copy(io.Discard, stderrR)
}()
return dr, <-ytErrCh
} }
func (dr *DownloadResult) Read(p []byte) (n int, err error) { func (dr *DownloadResult) Read(p []byte) (n int, err error) {

View File

@ -7,12 +7,9 @@ import (
"bytes" "bytes"
"context" "context"
"encoding/json" "encoding/json"
"fmt"
"io" "io"
"os"
"os/exec" "os/exec"
"regexp" "regexp"
"strconv"
"strings" "strings"
"testing" "testing"
@ -21,12 +18,14 @@ import (
"github.com/wader/osleaktest" "github.com/wader/osleaktest"
) )
const ( func init() {
testVideoRawURL = "https://www.youtube.com/watch?v=C0DPdy98e4c" // we're using yt-dlp at the moment
playlistRawURL = "https://soundcloud.com/mattheis/sets/kindred-phenomena" goutubedl.Path = "yt-dlp"
channelRawURL = "https://www.youtube.com/channel/UCHDm-DKoMyJxKVgwGmuTaQA" }
subtitlesTestVideoRawURL = "https://www.youtube.com/watch?v=QRS8MkLhQmM"
) const testVideoRawURL = "https://www.youtube.com/watch?v=C0DPdy98e4c"
const playlistRawURL = "https://soundcloud.com/mattheis/sets/kindred-phenomena"
const subtitlesTestVideoRawURL = "https://www.youtube.com/watch?v=QRS8MkLhQmM"
func leakChecks(t *testing.T) func() { func leakChecks(t *testing.T) func() {
leakFn := leaktest.Check(t) leakFn := leaktest.Check(t)
@ -100,45 +99,13 @@ func TestDownload(t *testing.T) {
} }
} }
func TestDownloadWithoutInfo(t *testing.T) {
defer leakChecks(t)()
stderrBuf := &bytes.Buffer{}
dr, err := goutubedl.Download(context.Background(), testVideoRawURL, goutubedl.Options{
StderrFn: func(cmd *exec.Cmd) io.Writer {
return stderrBuf
},
}, "")
if err != nil {
t.Fatal(err)
}
downloadBuf := &bytes.Buffer{}
n, err := io.Copy(downloadBuf, dr)
if err != nil {
t.Fatal(err)
}
dr.Close()
if n != int64(downloadBuf.Len()) {
t.Errorf("copy n not equal to download buffer: %d!=%d", n, downloadBuf.Len())
}
if n < 10000 {
t.Errorf("should have copied at least 10000 bytes: %d", n)
}
if !strings.Contains(stderrBuf.String(), "Destination") {
t.Errorf("did not find expected log message on stderr: %q", stderrBuf.String())
}
}
func TestParseInfo(t *testing.T) { func TestParseInfo(t *testing.T) {
for _, c := range []struct { for _, c := range []struct {
url string url string
expectedTitle string expectedTitle string
}{ }{
{"https://soundcloud.com/avalonemerson/avalon-emerson-live-at-printworks-london-march-2017", "Avalon Emerson Live at Printworks London 2017"}, {"https://soundcloud.com/avalonemerson/avalon-emerson-live-at-printworks-london-march-2017", "Avalon Emerson Live at Printworks London 2017"},
{"https://www.infoq.com/presentations/Simple-Made-Easy", "Simple Made Easy - InfoQ"}, {"https://www.infoq.com/presentations/Simple-Made-Easy", "Simple Made Easy"},
{"https://www.youtube.com/watch?v=uVYWQJ5BB_w", "A Radiolab Producer on the Making of a Podcast"}, {"https://www.youtube.com/watch?v=uVYWQJ5BB_w", "A Radiolab Producer on the Making of a Podcast"},
} { } {
t.Run(c.url, func(t *testing.T) { t.Run(c.url, func(t *testing.T) {
@ -220,38 +187,6 @@ func TestPlaylist(t *testing.T) {
} }
} }
func TestChannel(t *testing.T) {
defer leakChecks(t)()
ydlResult, ydlResultErr := goutubedl.New(
context.Background(),
channelRawURL,
goutubedl.Options{
Type: goutubedl.TypeChannel,
DownloadThumbnail: false,
},
)
if ydlResultErr != nil {
t.Errorf("failed to download: %s", ydlResultErr)
}
expectedTitle := "Simon Yapp"
if ydlResult.Info.Title != expectedTitle {
t.Errorf("expected title %q got %q", expectedTitle, ydlResult.Info.Title)
}
expectedEntries := 5
if len(ydlResult.Info.Entries) != expectedEntries {
t.Errorf("expected %d entries got %d", expectedEntries, len(ydlResult.Info.Entries))
}
expectedTitleOne := "#RNLI Shoreham #LifeBoat demo of launch."
if ydlResult.Info.Entries[0].Title != expectedTitleOne {
t.Errorf("expected title %q got %q", expectedTitleOne, ydlResult.Info.Entries[0].Title)
}
}
func TestUnsupportedURL(t *testing.T) { func TestUnsupportedURL(t *testing.T) {
defer leaktest.Check(t)() defer leaktest.Check(t)()
@ -318,73 +253,6 @@ func TestSubtitles(t *testing.T) {
} }
} }
func TestDownloadSections(t *testing.T) {
defer leakChecks(t)()
fileName := "durationTestingFile"
duration := 5
cmd := exec.Command("ffmpeg", "-version")
_, err := cmd.Output()
if err != nil {
t.Errorf("failed to check ffmpeg installed: %s", err)
}
ydlResult, ydlResultErr := goutubedl.New(
context.Background(),
"https://www.youtube.com/watch?v=OyuL5biOQ94",
goutubedl.Options{
DownloadSections: fmt.Sprintf("*0:0-0:%d", duration),
})
if ydlResult.Options.DownloadSections != "*0:0-0:5" {
t.Errorf("failed to setup --download-sections")
}
if ydlResultErr != nil {
t.Errorf("failed to download: %s", ydlResultErr)
}
dr, err := ydlResult.Download(context.Background(), "best")
if err != nil {
t.Fatal(err)
}
f, err := os.Create(fileName)
if err != nil {
t.Fatal(err)
}
defer f.Close()
_, err = io.Copy(f, dr)
if err != nil {
t.Fatal(err)
}
cmd = exec.Command("ffprobe", "-v", "quiet", "-show_entries", "format=duration", fileName)
stdout, err := cmd.Output()
if err != nil {
t.Fatal(err)
}
var gotDurationString string
output := string(stdout)
for _, line := range strings.Split(output, "\n") {
if strings.Contains(line, "duration") {
if d, found := strings.CutPrefix(line, "duration="); found {
gotDurationString = d
}
}
}
gotDuration, err := strconv.ParseFloat(gotDurationString, 32)
if err != nil {
t.Fatal(err)
}
seconds := int(gotDuration)
if seconds != duration {
t.Fatalf("did not get expected duration of %d, but got %d", duration, seconds)
}
dr.Close()
}
func TestErrorNotAPlaylist(t *testing.T) { func TestErrorNotAPlaylist(t *testing.T) {
defer leakChecks(t)() defer leakChecks(t)()
@ -433,148 +301,3 @@ func TestOptionDownloader(t *testing.T) {
} }
dr.Close() dr.Close()
} }
func TestInvalidOptionTypeField(t *testing.T) {
defer leakChecks(t)()
_, err := goutubedl.New(context.Background(), playlistRawURL, goutubedl.Options{
Type: 42,
})
if err == nil {
t.Error("should have failed")
}
}
func TestDownloadPlaylistEntry(t *testing.T) {
defer leakChecks(t)()
// Download file by specifying the playlist index
stderrBuf := &bytes.Buffer{}
r, err := goutubedl.New(context.Background(), playlistRawURL, goutubedl.Options{
StderrFn: func(cmd *exec.Cmd) io.Writer {
return stderrBuf
},
})
if err != nil {
t.Fatal(err)
}
expectedTitle := "Kindred Phenomena"
if r.Info.Title != expectedTitle {
t.Errorf("expected title %q got %q", expectedTitle, r.Info.Title)
}
expectedEntries := 8
if len(r.Info.Entries) != expectedEntries {
t.Errorf("expected %d entries got %d", expectedEntries, len(r.Info.Entries))
}
expectedTitleOne := "B1 Mattheis - Ben M"
playlistIndex := 2
if r.Info.Entries[playlistIndex].Title != expectedTitleOne {
t.Errorf("expected title %q got %q", expectedTitleOne, r.Info.Entries[playlistIndex].Title)
}
dr, err := r.DownloadWithOptions(context.Background(), goutubedl.DownloadOptions{
PlaylistIndex: int(r.Info.Entries[playlistIndex].PlaylistIndex),
Filter: r.Info.Entries[playlistIndex].Formats[0].FormatID,
})
if err != nil {
t.Fatal(err)
}
playlistBuf := &bytes.Buffer{}
n, err := io.Copy(playlistBuf, dr)
if err != nil {
t.Fatal(err)
}
dr.Close()
if n != int64(playlistBuf.Len()) {
t.Errorf("copy n not equal to download buffer: %d!=%d", n, playlistBuf.Len())
}
if n < 10000 {
t.Errorf("should have copied at least 10000 bytes: %d", n)
}
if !strings.Contains(stderrBuf.String(), "Destination") {
t.Errorf("did not find expected log message on stderr: %q", stderrBuf.String())
}
// Download the same file but with the direct link
url := "https://soundcloud.com/mattheis/b1-mattheis-ben-m"
stderrBuf = &bytes.Buffer{}
r, err = goutubedl.New(context.Background(), url, goutubedl.Options{
StderrFn: func(cmd *exec.Cmd) io.Writer {
return stderrBuf
},
})
if err != nil {
t.Fatal(err)
}
if r.Info.Title != expectedTitleOne {
t.Errorf("expected title %q got %q", expectedTitleOne, r.Info.Title)
}
expectedEntries = 0
if len(r.Info.Entries) != expectedEntries {
t.Errorf("expected %d entries got %d", expectedEntries, len(r.Info.Entries))
}
dr, err = r.Download(context.Background(), r.Info.Formats[0].FormatID)
if err != nil {
t.Fatal(err)
}
directLinkBuf := &bytes.Buffer{}
n, err = io.Copy(directLinkBuf, dr)
if err != nil {
t.Fatal(err)
}
dr.Close()
if n != int64(directLinkBuf.Len()) {
t.Errorf("copy n not equal to download buffer: %d!=%d", n, directLinkBuf.Len())
}
if n < 10000 {
t.Errorf("should have copied at least 10000 bytes: %d", n)
}
if !strings.Contains(stderrBuf.String(), "Destination") {
t.Errorf("did not find expected log message on stderr: %q", stderrBuf.String())
}
if directLinkBuf.Len() != playlistBuf.Len() {
t.Errorf("not the same content size between the playlist index entry and the direct link entry: %d != %d", playlistBuf.Len(), directLinkBuf.Len())
}
if !bytes.Equal(directLinkBuf.Bytes(), playlistBuf.Bytes()) {
t.Error("not the same content between the playlist index entry and the direct link entry")
}
}
func TestFormatDownloadError(t *testing.T) {
defer leaktest.Check(t)()
ydl, ydlErr := goutubedl.New(
context.Background(),
"https://www.reddit.com/r/newsbabes/s/92rflI0EB0",
goutubedl.Options{},
)
if ydlErr != nil {
// reddit seems to not like github action hosts
if strings.Contains(ydlErr.Error(), "HTTPError 403: Blocked") {
t.Skip()
}
t.Error(ydlErr)
}
// no pre-muxed audio/video format available
_, ytDlErr := ydl.Download(context.Background(), "best")
expectedErr := "Requested format is not available"
if ydlErr != nil && !strings.Contains(ytDlErr.Error(), expectedErr) {
t.Errorf("expected error prefix %q got %q", expectedErr, ytDlErr.Error())
}
}