Public | Automated Build

Last pushed: 3 days ago
Short Description
youtube-dl HTTP service
Full Description

youtube-dl HTTP service

HTTP service for youtube-dl that downloads media for
requested URL and transmuxes and transcodes to requested format if needed.

I personally use it to create audio only versions of videos from various
site like youtube, vimeo etc.

Docker image supports all default native ffmpeg decoders and can encoding to:

Format name Container Audio codecs Video codecs
mp3 mp3 mp3
m4a mov, m4a, 3gp, mj2 aac
ogg ogg vorbis, opus
flac flac flac
wav wav pcm_s16le
mp4 mov, m4a, 3gp, mj2 aac, mp3, vorbis h264, h265
webm webm, matroska vorbis, opus vp8, vp9
mkv matroska aac, mp3, vorbis, opus, flac h264, vp8, h265, vp9, theora

See formats.json for more details.

Usage

Run with docker

Pull mwader/ydls or build image using Dockerfile. Run a container that publishes container TCP port 8080 somehow.

docker run --rm -p 8080:8080 mwader/ydls

Build and install yourself

Run go get github.com/wader/ydls/cmd/... This will install ydls-server and
ydls-get. Make sure you have ffmpeg, youtube-dl, rtmpdump and mplayer
installed and in path.

Copy and edit formats.json to match your ffmpeg builds
supported formats and codecs.

Start with ydls-server -formats /path/to/formats.json and it default will listen
on port 8080.

Endpoints

Download and make sure media is in specified format:
GET /<format>/<URL-not-encoded>
GET /?format=<format>&url=<URL-encoded>

Download in best format:
GET /<URL-not-encoded>
GET /?url=<URL-encoded>

format depends on formats.json.

URL is any URL that youtube-dl can handle.
If schema is missing http:// is assumed.

When passing url as query parameter it is possible to use acodec and vcodec to
force which codec to use.

The idea with endpoints supporting URL-not-encoded is to be able to simply
prepend the URL with the ydls URL by hand without doing any encoding (for example in
the browser location bar).

Examples:

Download and make sure media is in mp3 format:
http://ydls-host/mp3/https://www.youtube.com/watch?v=cF1zJYkBW4A

Download using query parameters and make sure media is in mp3 format:
http://ydls-host/?format=mp3&url=https%3A%2F%2Fwww.youtube.com%2Fwatch%3Fv%3DcF1zJYkBW4A

Download and make sure media is in webm format:
http://ydls-host/webm/https://www.youtube.com/watch?v=cF1zJYkBW4A

Download in best format:
http://ydls-host/https://www.youtube.com/watch?v=cF1zJYkBW4A

Formats config

[
  {
    "Name": "", // Format name in endpoint
    "Formats": [], // Valid container formats. First in list is used for muxing
    "FormatFlags": [], // Global format flags
    // Zero or more valid audio codecs. First in list is used if transcoding is needed
    "ACodecs": {
      "Codec": "", // Codec name
      "CodecFlags": [], // Codec flags
      "FormatFlags": [] // Format flags
    },
    // Zero or more valid video codecs. First in list is used if transcoding is needed
    "VCodecs": {
      "Codec": "", // Codec name
      "CodecFlags": [], // Codec flags
      "FormatFlags": [] // Format flags
    },
    "Prepend": "", // Can currently be "id3v2" to append ID3v2 tag
    "Ext": "", // Filename extension
    "MIMEType": "" // MIME type
  },
  // More formats...
]

Tricks and known issues

For some formats the transcoded file might have zero length or duration as transcoding is done
while streaming. This is usually not a problem for most players.

Download with curl and save to filename provided by response header:

curl -OJ http://ydls-host/mp3/https://www.youtube.com/watch?v=cF1zJYkBW4A

Docker image can download from command line. This will download in mp3 format
to current directory:

docker run --rm -v "$PWD:/root" -w /root --user=root mwader/ydls https://www.youtube.com/watch?v=cF1zJYkBW4A mp3

youtube-dl URL can point to a plain media file.

If you run the service using some cloud services you might run into geo-restriction
issues with some sites like youtube.

Development

When fiddling with ffmpeg and youtube-dl related code I usually do this:

docker build -t ydls .
docker build -f _dev/Dockerfile.dev -t ydls-dev .
docker run --rm -ti --entrypoint bash -v "$PWD:/go/src/github.com/wader/ydls" -w /go/src/github.com/wader/ydls ydls-dev

Then inside dev conatiner:

go run cmd/ydls-get/main.go -formats ./formats.json ...

TODO

  • youtubedl info, just url no formats?
  • X-Remote IP header?
  • seccomp and chroot things

License

ydls is licensed under the MIT license. See LICENSE for the full license text.

Docker Pull Command
Owner
mwader
Source Repository

Comments (0)