1 { lib, fetchurl, fetchpatch, buildPythonPackage
2 , zip, ffmpeg, rtmpdump, atomicparsley, pycryptodome, pandoc
3 # Pandoc is required to build the package's man page. Release tarballs contain a
4 # formatted man page already, though, it will still be installed. We keep the
5 # manpage argument in place in case someone wants to use this derivation to
6 # build a Git version of the tool that doesn't have the formatted man page
8 , generateManPage ? false
11 , hlsEncryptedSupport ? true
12 , installShellFiles, makeWrapper }:
14 buildPythonPackage rec {
17 # The websites youtube-dl deals with are a very moving target. That means that
18 # downloads break constantly. Because of that, updates should always be backported
19 # to the latest stable release.
20 version = "2021.12.17";
23 url = "https://yt-dl.org/downloads/${version}/${pname}-${version}.tar.gz";
24 sha256 = "sha256-nzuZyLd4RVFltFJfIVBehsf/Vl86wxnhlzPYEBlBNd8=";
28 # Fixes throttling on youtube.com by decoding a "n-parameter". Without the patch
29 # downloads are capped at about 80KiB/s. See, e.g.,
31 # https://github.com/ytdl-org/youtube-dl/issues/29326
33 # The patch comes from PR https://github.com/ytdl-org/youtube-dl/pull/30184#issuecomment-1025261055
34 # plus follow-up (1e677567) from https://github.com/ytdl-org/youtube-dl/pull/30582
36 name = "fix-youtube-dl-speed.patch";
37 url = "https://github.com/ytdl-org/youtube-dl/compare/57044eacebc6f2f3cd83c345e1b6e659a22e4773...1e677567cd083d43f55daef0cc74e5fa24575ae3.diff";
38 sha256 = "11s0j3w60r75xx20p0x2j3yc4d3yvz99r0572si8b5qd93lqs4pr";
40 # The above patch may fail to decode the n-parameter (if, say, YouTube is updated). Failure to decode
41 # it blocks the download instead of falling back to the throttled version. The patch below implements
42 # better fallback behaviour.
44 name = "avoid-crashing-if-nsig-decode-fails.patch";
45 url = "https://github.com/ytdl-org/youtube-dl/commit/41f0043983c831b7c0c3614340d2f66ec153087b.diff";
46 sha256 = "sha256-a72gWhBXCLjuBBD36PpZ5F/AHBdiBv4W8Wf9g4P/aBY=";
48 # YouTube changed the n-parameter format in April 2022, so decoder updates are required.
50 name = "fix-n-descrambling.patch";
51 url = "https://github.com/ytdl-org/youtube-dl/commit/a0068bd6bec16008bda7a39caecccbf84881c603.diff";
52 sha256 = "sha256-tSuEns4jputa2nOOo6JsFXpK3hvJ/+z1/ymcLsd3A6w=";
56 nativeBuildInputs = [ installShellFiles makeWrapper ];
57 buildInputs = [ zip ] ++ lib.optional generateManPage pandoc;
58 propagatedBuildInputs = lib.optional hlsEncryptedSupport pycryptodome;
60 # Ensure these utilities are available in $PATH:
61 # - ffmpeg: post-processing & transcoding support
62 # - rtmpdump: download files over RTMP
63 # - atomicparsley: embedding thumbnails
67 ++ lib.optional ffmpegSupport ffmpeg
68 ++ lib.optional rtmpSupport rtmpdump;
69 in [ ''--prefix PATH : "${lib.makeBinPath packagesToBinPath}"'' ];
72 "build_lazy_extractors"
76 installShellCompletion youtube-dl.zsh
83 homepage = "https://ytdl-org.github.io/youtube-dl/";
84 description = "Command-line tool to download videos from YouTube.com and other sites";
86 youtube-dl is a small, Python-based command-line program to download
87 videos from YouTube.com and a few more sites. youtube-dl is released to
88 the public domain, which means you can modify it, redistribute it or use
91 license = licenses.publicDomain;
92 maintainers = with maintainers; [ bluescreen303 fpletz ];
93 platforms = with platforms; linux ++ darwin;
94 mainProgram = "youtube-dl";
95 knownVulnerabilities = [
96 "youtube-dl is unmaintained, migrate to yt-dlp, if possible"