X-Git-Url: https://jfr.im/git/yt-dlp.git/blobdiff_plain/277d6ff5f2bd4f142429def30d01df264eb7c922..a515a78dd3e16b7854844829293ef4e9f3c62319:/README.md diff --git a/README.md b/README.md index 4501ba426..687e9c303 100644 --- a/README.md +++ b/README.md @@ -13,7 +13,7 @@ # YT-DLP A command-line program to download videos from youtube.com and many other [video platforms](supportedsites.md) -This is a fork of [youtube-dlc](https://github.com/blackjack4494/yt-dlc) which is inturn a fork of [youtube-dl](https://github.com/ytdl-org/youtube-dl) +This is a [youtube-dl](https://github.com/ytdl-org/youtube-dl) fork based on the now inactive [youtube-dlc](https://github.com/blackjack4494/yt-dlc). The main focus of this project is adding new features and patches while also keeping up to date with the original project * [NEW FEATURES](#new-features) * [INSTALLATION](#installation) @@ -47,6 +47,7 @@ # YT-DLP * [Sorting Formats](#sorting-formats) * [Format Selection examples](#format-selection-examples) * [PLUGINS](#plugins) +* [DEPRECATED OPTIONS](#deprecated-options) * [MORE](#more) @@ -57,7 +58,7 @@ # NEW FEATURES * **[Format Sorting](#sorting-formats)**: The default format sorting options have been changed so that higher resolution and better codecs will be now preferred instead of simply using larger bitrate. Furthermore, you can now specify the sort order using `-S`. This allows for much easier format selection that what is possible by simply using `--format` ([examples](#format-selection-examples)) -* **Merged with youtube-dl v2021.02.22**: You get all the latest features and patches of [youtube-dl](https://github.com/ytdl-org/youtube-dl) in addition to all the features of [youtube-dlc](https://github.com/blackjack4494/yt-dlc) +* **Merged with youtube-dl v2021.03.14**: You get all the latest features and patches of [youtube-dl](https://github.com/ytdl-org/youtube-dl) in addition to all the features of [youtube-dlc](https://github.com/blackjack4494/yt-dlc) * **Merged with animelover1984/youtube-dl**: You get most of the features and improvements from [animelover1984/youtube-dl](https://github.com/animelover1984/youtube-dl) including `--get-comments`, `BiliBiliSearch`, `BilibiliChannel`, Embedding thumbnail in mp4/ogg/opus, Playlist infojson etc. Note that the NicoNico improvements are not available. See [#31](https://github.com/yt-dlp/yt-dlp/pull/31) for details. @@ -66,17 +67,19 @@ # NEW FEATURES * Youtube search (`ytsearch:`, `ytsearchdate:`) along with Search URLs works correctly * Redirect channel's home URL automatically to `/video` to preserve the old behaviour +* **Split video by chapters**: Videos can be split into multiple files based on chapters using `--split-chapters` + +* **Multithreaded fragment downloads**: Fragment downloads can be natively multi-threaded. Use `--concurrent-fragments` (`-N`) option to set the number of threads used + * **Aria2c with HLS/DASH**: You can use aria2c as the external downloader for DASH(mpd) and HLS(m3u8) formats. No more slow ffmpeg/native downloads -* **New extractors**: AnimeLab, Philo MSO, Rcs, Gedi, bitwave.tv, mildom, audius, zee5 +* **New extractors**: AnimeLab, Philo MSO, Rcs, Gedi, bitwave.tv, mildom, audius, zee5, mtv.it, wimtv, pluto.tv * **Fixed extractors**: archive.org, roosterteeth.com, skyit, instagram, itv, SouthparkDe, spreaker, Vlive, tiktok, akamai, ina, rumble, tennistv -* **Plugin support**: Extractors can be loaded from an external file. See [plugins](#plugins) for details - -* **Multiple paths and output templates**: You can give different [output templates](#output-template) and download paths for different types of files. You can also set a temporary path where intermediary files are downloaded to. See [`--paths`](https://github.com/yt-dlp/yt-dlp/#:~:text=-P,%20--paths%20TYPE:PATH) for details +* **Plugin extractors**: Extractors can be loaded from an external file. See [plugins](#plugins) for details - +* **Multiple paths and output templates**: You can give different [output templates](#output-template) and download paths for different types of files. You can also set a temporary path where intermediary files are downloaded to using `--paths` (`-P`) * **Portable Configuration**: Configuration files are automatically loaded from the home and root directories. See [configuration](#configuration) for details @@ -103,6 +106,23 @@ # INSTALLATION * Use pip+git: `python -m pip install --upgrade git+https://github.com/yt-dlp/yt-dlp.git@release` * Install master branch: `python -m pip install --upgrade git+https://github.com/yt-dlp/yt-dlp` +UNIX users (Linux, macOS, BSD) can also install the [latest release](https://github.com/yt-dlp/yt-dlp/releases/latest) one of the following ways: + +``` +sudo curl -L https://github.com/yt-dlp/yt-dlp/releases/latest/download/yt-dlp -o /usr/local/bin/yt-dlp +sudo chmod a+rx /usr/local/bin/yt-dlp +``` + +``` +sudo wget https://github.com/yt-dlp/yt-dlp/releases/latest/download/yt-dlp -O /usr/local/bin/yt-dlp +sudo chmod a+rx /usr/local/bin/yt-dlp +``` + +``` +sudo aria2c https://github.com/yt-dlp/yt-dlp/releases/latest/download/yt-dlp -o /usr/local/bin/yt-dlp +sudo chmod a+rx /usr/local/bin/yt-dlp +``` + ### UPDATE Starting from version `2021.02.09`, you can use `yt-dlp -U` to update if you are using the provided release. If you are using `pip`, simply re-run the same command that was used to install the program. @@ -177,7 +197,7 @@ ## General Options: only list them --no-flat-playlist Extract the videos of a playlist --mark-watched Mark videos watched (YouTube only) - --no-mark-watched Do not mark videos watched + --no-mark-watched Do not mark videos watched (default) --no-colors Do not emit color codes in output ## Network Options: @@ -280,6 +300,8 @@ ## Video Selection: --no-include-ads Do not download advertisements (default) ## Download Options: + -N, --concurrent-fragments N Number of fragments to download + concurrently (default is 1) -r, --limit-rate RATE Maximum download rate in bytes per second (e.g. 50K or 4.2M) -R, --retries RETRIES Number of retries (default is 10), or @@ -402,6 +424,11 @@ ## Filesystem Options: --write-description etc. (default) --no-write-playlist-metafiles Do not write playlist metadata when using --write-info-json, --write-description etc. + --clean-infojson Remove some private fields such as + filenames from the infojson. Note that it + could still contain some personal + information (default) + --no-clean-infojson Write all fields to the infojson --get-comments Retrieve video comments to be placed in the .info.json file. The comments are fetched even without this option if the extraction @@ -445,7 +472,8 @@ ## Verbosity and Simulation Options: --no-warnings Ignore warnings -s, --simulate Do not download the video and do not write anything to disk - --skip-download Do not download the video + --skip-download Do not download the video but write all + related files (Alias: --no-download) -g, --get-url Simulate, quiet but print URL -e, --get-title Simulate, quiet but print title --get-id Simulate, quiet but print id @@ -482,7 +510,7 @@ ## Workarounds: --encoding ENCODING Force the specified encoding (experimental) --no-check-certificate Suppress HTTPS certificate validation --prefer-insecure Use an unencrypted connection to retrieve - information about the video. (Currently + information about the video (Currently supported only for YouTube) --user-agent UA Specify a custom user agent --referer URL Specify a custom referer, use if the video @@ -496,15 +524,11 @@ ## Workarounds: --sleep-requests SECONDS Number of seconds to sleep between requests during data extraction --sleep-interval SECONDS Number of seconds to sleep before each - download when used alone or a lower bound - of a range for randomized sleep before each - download (minimum possible number of - seconds to sleep) when used along with - --max-sleep-interval - --max-sleep-interval SECONDS Upper bound of a range for randomized sleep - before each download (maximum possible - number of seconds to sleep). Must only be - used along with --min-sleep-interval + download. This is the minimum time to sleep + when used along with --max-sleep-interval + (Alias: --min-sleep-interval) + --max-sleep-interval SECONDS Maximum number of seconds to sleep. Can + only be used along with --min-sleep-interval --sleep-subtitles SECONDS Number of seconds to sleep before each subtitle download @@ -554,16 +578,16 @@ ## Subtitle Options: --write-subs Write subtitle file --no-write-subs Do not write subtitle file (default) --write-auto-subs Write automatically generated subtitle file - (YouTube only) - --no-write-auto-subs Do not write automatically generated - subtitle file (default) + (Alias: --write-automatic-subs) + --no-write-auto-subs Do not write auto-generated subtitles + (default) (Alias: --no-write-automatic-subs) --all-subs Download all the available subtitles of the video --list-subs List all available subtitles for the video --sub-format FORMAT Subtitle format, accepts formats preference, for example: "srt" or "ass/srt/best" - --sub-lang LANGS Languages of the subtitles to download + --sub-langs LANGS Languages of the subtitles to download (optional) separated by commas, use --list- subs for available language tags @@ -624,11 +648,12 @@ ## Post-Processing Options: arguments to the specified executable only when being used by the specified postprocessor. Additionally, for - ffmpeg/ffprobe, a number can be appended to - the exe name seperated by "_i" to pass the - argument before the specified input file. - Eg: --ppa "Merger+ffmpeg_i1:-v quiet". You - can use this option multiple times to give + ffmpeg/ffprobe, "_i"/"_o" can be appended + to the prefix optionally followed by a + number to pass the argument before the + specified input/output file. Eg: --ppa + "Merger+ffmpeg_i1:-v quiet". You can use + this option multiple times to give different arguments to different postprocessors. (Alias: --ppa) -k, --keep-video Keep the intermediate video file on disk @@ -652,7 +677,7 @@ ## Post-Processing Options: similar syntax to the output template can also be used. The parsed parameters replace any existing values and can be use in - output templateThis option can be used + output template. This option can be used multiple times. Example: --parse-metadata "title:%(artist)s - %(title)s" matches a title like "Coldplay - Paradise". Example @@ -672,8 +697,16 @@ ## Post-Processing Options: downloading and post-processing, similar to find's -exec syntax. Example: --exec 'adb push {} /sdcard/Music/ && rm {}' - --convert-subs FORMAT Convert the subtitles to other format + --convert-subs FORMAT Convert the subtitles to another format (currently supported: srt|ass|vtt|lrc) + (Alias: --convert-subtitles) + --split-chapters Split video into multiple files based on + internal chapters. The "chapter:" prefix + can be used with "--paths" and "--output" + to set the output filename for the split + files. See "OUTPUT TEMPLATE" for details + --no-split-chapters Do not split video based on chapters + (default) ## SponSkrub (SponsorBlock) Options: [SponSkrub](https://github.com/yt-dlp/SponSkrub) is a utility to @@ -697,6 +730,8 @@ ## SponSkrub (SponsorBlock) Options: directory ## Extractor Options: + --extractor-retries RETRIES Number of retries for known extractor + errors (default is 3), or "infinite" --allow-dynamic-mpd Process dynamic DASH manifests (default) (Alias: --no-ignore-dynamic-mpd) --ignore-dynamic-mpd Do not process dynamic DASH manifests @@ -787,9 +822,9 @@ # OUTPUT TEMPLATE **tl;dr:** [navigate me to examples](#output-template-examples). -The basic usage of `-o` is not to set any template arguments when downloading a single file, like in `yt-dlp -o funny_video.flv "https://some/video"`. However, it may contain special sequences that will be replaced when downloading each video. The special sequences may be formatted according to [python string formatting operations](https://docs.python.org/2/library/stdtypes.html#string-formatting). For example, `%(NAME)s` or `%(NAME)05d`. To clarify, that is a percent symbol followed by a name in parentheses, followed by formatting operations. Date/time fields can also be formatted according to [strftime formatting](https://docs.python.org/3/library/datetime.html#strftime-and-strptime-format-codes) by specifying it inside the parantheses seperated from the field name using a `>`. For example, `%(duration>%H-%M-%S)s`. +The basic usage of `-o` is not to set any template arguments when downloading a single file, like in `yt-dlp -o funny_video.flv "https://some/video"` (hard-coding file extension like this is not recommended). However, it may contain special sequences that will be replaced when downloading each video. The special sequences may be formatted according to [python string formatting operations](https://docs.python.org/2/library/stdtypes.html#string-formatting). For example, `%(NAME)s` or `%(NAME)05d`. To clarify, that is a percent symbol followed by a name in parentheses, followed by formatting operations. Date/time fields can also be formatted according to [strftime formatting](https://docs.python.org/3/library/datetime.html#strftime-and-strptime-format-codes) by specifying it inside the parantheses seperated from the field name using a `>`. For example, `%(duration>%H-%M-%S)s`. -Additionally, you can set different output templates for the various metadata files seperately from the general output template by specifying the type of file followed by the template seperated by a colon ":". The different filetypes supported are `subtitle|thumbnail|description|annotation|infojson|pl_description|pl_infojson`. For example, `-o '%(title)s.%(ext)s' -o 'thumbnail:%(title)s\%(title)s.%(ext)s'` will put the thumbnails in a folder with the same name as the video. +Additionally, you can set different output templates for the various metadata files seperately from the general output template by specifying the type of file followed by the template seperated by a colon ":". The different filetypes supported are `subtitle`, `thumbnail`, `description`, `annotation`, `infojson`, `pl_description`, `pl_infojson`, `chapter`. For example, `-o '%(title)s.%(ext)s' -o 'thumbnail:%(title)s\%(title)s.%(ext)s'` will put the thumbnails in a folder with the same name as the video. The available fields are: @@ -798,6 +833,7 @@ # OUTPUT TEMPLATE - `url` (string): Video URL - `ext` (string): Video filename extension - `alt_title` (string): A secondary title of the video + - `description` (string): The description of the video - `display_id` (string): An alternative identifier for the video - `uploader` (string): Full name of the video uploader - `license` (string): License name the video is licensed under @@ -880,6 +916,13 @@ # OUTPUT TEMPLATE - `disc_number` (numeric): Number of the disc or other physical medium the track belongs to - `release_year` (numeric): Year (YYYY) when the album was released +Available when using `--split-chapters` for videos with internal chapters: + + - `section_title` (string): Title of the chapter + - `section_number` (numeric): Number of the chapter within the file + - `section_start` (numeric): Start time of the chapter in seconds + - `section_end` (numeric): End time of the chapter in seconds + Each aforementioned sequence when referenced in an output template will be replaced by the actual value corresponding to the sequence name. Note that some of the sequences are not guaranteed to be present since they depend on the metadata obtained by a particular extractor. Such sequences will be replaced with placeholder value provided with `--output-na-placeholder` (`NA` by default). For example for `-o %(title)s-%(id)s.%(ext)s` and an mp4 video with title `yt-dlp test video` and id `BaW_jenozKcj`, this will result in a `yt-dlp test video-BaW_jenozKcj.mp4` file created in the current directory. @@ -1159,5 +1202,39 @@ # PLUGINS **Note**: `` is the directory of the binary (`/yt-dlp`), or the root directory of the module if you are running directly from source-code (`/yt_dlp/__main__.py`) +# DEPRECATED OPTIONS + +These are all the deprecated options and the current alternative to achieve the same effect + + --cn-verification-proxy URL --geo-verification-proxy URL + --id -o "%(id)s.%(ext)s" + -A, --auto-number -o "%(autonumber)s-%(id)s.%(ext)s" + -t, --title -o "%(title)s-%(id)s.%(ext)s" + -l, --literal -o accepts literal names + --autonumber-size NUMBER Use string formatting. Eg: %(autonumber)03d + --metadata-from-title FORMAT --parse-metadata "title:FORMAT" + --prefer-avconv avconv is no longer officially supported (Alias: --no-prefer-ffmpeg) + --prefer-ffmpeg Default (Alias: --no-prefer-avconv) + --avconv-location avconv is no longer officially supported + -C, --call-home Not implemented + --no-call-home Default + --write-srt --write-subs + --no-write-srt --no-write-subs + --srt-lang LANGS --sub-langs LANGS + --prefer-unsecure --prefer-insecure + --rate-limit RATE --limit-rate RATE + --force-write-download-archive --force-write-archive + --dump-intermediate-pages --dump-pages + --dump-headers --print-traffic + --youtube-print-sig-code No longer supported + --trim-file-names LENGTH --trim-filenames LENGTH + --yes-overwrites --force-overwrites + --load-info --load-info-json + --split-tracks --split-chapters + --no-split-tracks --no-split-chapters + --sponskrub-args ARGS --ppa "sponskrub:ARGS" + --test Only used for testing extractors + + # MORE For FAQ, Developer Instructions etc., see the [original README](https://github.com/ytdl-org/youtube-dl#faq)