X-Git-Url: https://jfr.im/git/yt-dlp.git/blobdiff_plain/a26c99ac13e307bdfe7889739777b022866d2cff..c69911e4c1b41b05a5b366e512ca8cf6ece72093:/README.md diff --git a/README.md b/README.md index 670c07d39..e7f3762bf 100644 --- a/README.md +++ b/README.md @@ -1,16 +1,19 @@ -[![Build Status](https://github.com/pukkandan/yt-dlc/workflows/CI/badge.svg?branch=master)](https://github.com/pukkandan/yt-dlc/actions?query=workflow%3ACI) -[![Release Version](https://img.shields.io/badge/Release-2021.01.07-1-brightgreen)](https://github.com/pukkandan/yt-dlc/releases/latest) -[![License: Unlicense](https://img.shields.io/badge/License-Unlicense-blue.svg)](https://github.com/pukkandan/yt-dlc/blob/master/LICENSE) +# YT-DLP -youtube-dlc - download videos from youtube.com and many other [video platforms](docs/supportedsites.md) + +[![Release Version](https://img.shields.io/endpoint?url=https://gist.githubusercontent.com/pukkandan/c69cb23c3c5b3316248e52022790aa57/raw/version.json&color=brightgreen)](https://github.com/pukkandan/yt-dlp/releases/latest) +[![License: Unlicense](https://img.shields.io/badge/License-Unlicense-blue.svg)](https://github.com/pukkandan/yt-dlp/blob/master/LICENSE) +[![Core Status](https://github.com/pukkandan/yt-dlp/workflows/Core%20Test/badge.svg?branch=master)](https://github.com/pukkandan/yt-dlp/actions?query=workflow%3ACore) +[![CI Status](https://github.com/pukkandan/yt-dlp/workflows/Full%20Test/badge.svg?branch=master)](https://github.com/pukkandan/yt-dlp/actions?query=workflow%3AFull) + +A command-line program to download videos from youtube.com and many other [video platforms](docs/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) -* [CHANGES FROM YOUTUBE-DLC](#changes) +* [NEW FEATURES](#new-features) * [INSTALLATION](#installation) - * [UPDATE](#update) - * [COMPILE](#compile) -* [YOUTUBE-DLC](#youtube-dlc) + * [Update](#update) + * [Compile](#compile) * [DESCRIPTION](#description) * [OPTIONS](#options) * [Network Options](#network-options) @@ -27,7 +30,7 @@ * [Authentication Options](#authentication-options) * [Adobe Pass Options](#adobe-pass-options) * [Post-processing Options](#post-processing-options) - * [SponSkrub Options (SponsorBlock)](#sponskrub-options-sponsorblock) + * [SponSkrub (SponsorBlock) Options](#sponskrub-sponsorblock-options) * [Extractor Options](#extractor-options) * [CONFIGURATION](#configuration) * [Authentication with .netrc file](#authentication-with-netrc-file) @@ -38,69 +41,49 @@ * [Filtering Formats](#filtering-formats) * [Sorting Formats](#sorting-formats) * [Format Selection examples](#format-selection-examples) -* [VIDEO SELECTION](#video-selection-1) * [MORE](#more) -# CHANGES -See [commits](https://github.com/pukkandan/yt-dlc/commits) for more details - -### 2021.01.05 -* **Format Sort:** Added `--format-sort` (`-S`), `--format-sort-force` (`--S-force`) - See [Sorting Formats](#sorting-formats) for details -* **Format Selection:** See [Format Selection](#format-selection) for details - * New format selectors: `best*`, `worst*`, `bestvideo*`, `bestaudio*`, `worstvideo*`, `worstaudio*` - * Changed video format sorting to show video only files and video+audio files together. - * Added `--video-multistreams`, `--no-video-multistreams`, `--audio-multistreams`, `--no-audio-multistreams` - * Added `b`,`w`,`v`,`a` as alias for `best`, `worst`, `video` and `audio` respectively -* **Shortcut Options:** Added `--write-link`, `--write-url-link`, `--write-webloc-link`, `--write-desktop-link` by @h-h-h-h - See [Internet Shortcut Options](#internet-shortcut-options) for details -* **Sponskrub integration:** Added `--sponskrub`, `--sponskrub-cut`, `--sponskrub-force`, `--sponskrub-location`, `--sponskrub-args` - See [SponSkrub Options](#sponskrub-options-sponsorblock) for details -* Added `--force-download-archive` (`--force-write-archive`) by by h-h-h-h -* Added `--list-formats-as-table`, `--list-formats-old` -* **Negative Options:** Makes it possible to negate boolean options by adding a `no-` to the switch - * Added `--no-ignore-dynamic-mpd`, `--no-allow-dynamic-mpd`, `--allow-dynamic-mpd`, `--youtube-include-hls-manifest`, `--no-youtube-include-hls-manifest`, `--no-youtube-skip-hls-manifest`, `--no-download`, `--no-download-archive`, `--resize-buffer`, `--part`, `--mtime`, `--no-keep-fragments`, `--no-cookies`, `--no-write-annotations`, `--no-write-info-json`, `--no-write-description`, `--no-write-thumbnail`, `--youtube-include-dash-manifest`, `--post-overwrites`, `--no-keep-video`, `--no-embed-subs`, `--no-embed-thumbnail`, `--no-add-metadata`, `--no-include-ads`, `--no-write-sub`, `--no-write-auto-sub`, `--no-playlist-reverse`, `--no-restrict-filenames`, `--youtube-include-dash-manifest`, `--no-format-sort-force`, `--flat-videos`, `--no-list-formats-as-table`, `--no-sponskrub`, `--no-sponskrub-cut`, `--no-sponskrub-force` - * Renamed: `--write-subs`, `--no-write-subs`, `--no-write-auto-subs`, `--write-auto-subs`. Note that these can still be used without the ending "s" -* Relaxed validation for format filters so that any arbitrary field can be used -* Fix for embedding thumbnail in mp3 by @pauldubois98 -* Make Twitch Video ID output from Playlist and VOD extractor same. This is only a temporary fix -* **Merge youtube-dl:** Upto [2020.01.03](https://github.com/ytdl-org/youtube-dl/commit/8e953dcbb10a1a42f4e12e4e132657cb0100a1f8) - See [blackjack4494/yt-dlc#280](https://github.com/blackjack4494/yt-dlc/pull/280) for details -* Cleaned up the fork for public use - -### 2021.01.05-1 -* **Changed defaults:** - * Enabled `--ignore` - * Disabled `--video-multistreams` and `--audio-multistreams` - * Changed default format selection to `bv*+ba/b` when `--audio-multistreams` is disabled - * Changed default format sort order to `res,fps,codec,size,br,asr,proto,ext,has_audio,source,format_id` - * Changed `webm` to be more preferable than `flv` in format sorting - * Changed default output template to `%(title)s [%(id)s].%(ext)s` - * Enabled `--list-formats-as-table` - -### 2021.01.07 -* Removed priority of `av01` codec in `-S` since most devices don't support it yet -* Added `duration_string` to be used in `--output` -* Created First Release - -### 2021.01.07-1 -* [Akamai] fix by @nixxo -* [Tiktok] fix extractor by @GreyAlien502 -* [vlive] add support for playlists by @kyuyeunk -* [youtube_live_chat] make sure playerOffsetMs is positive by @siikamiika -* Ignore extra data streams in ffmpeg by @jbruchon -* Allow passing different arguments to different postprocessors using `--postprocessor-args` -* Deprecated `--sponskrub-args`. The same can now be done using `--postprocessor-args "sponskrub:"` +# NEW FEATURES +The major new features from the latest release of [blackjack4494/yt-dlc](https://github.com/blackjack4494/yt-dlc) are: +* **[SponSkrub Integration](#sponskrub-sponsorblock-options)**: You can use [SponSkrub](https://github.com/pukkandan/SponSkrub) to mark/remove sponsor sections in youtube videos by utilizing the [SponsorBlock](https://sponsor.ajay.app) API -# INSTALLATION +* **[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.01.16**: 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) + +* **Youtube improvements**: + * All Youtube Feeds (`:ytfav`, `:ytwatchlater`, `:ytsubs`, `:ythistory`, `:ytrec`) works correctly and support downloading multiple pages of content + * Youtube search works correctly (`ytsearch:`, `ytsearchdate:`) along with Search URLs + * Redirect channel's home URL automatically to `/video` to preserve the old behaviour + +* **New extractors**: Trovo.live, AnimeLab, Philo MSO, Rcs, Gedi, bitwave.tv + +* **Fixed extractors**: archive.org, roosterteeth.com, skyit, instagram, itv, SouthparkDe, spreaker, Vlive, tiktok, akamai, ina + +* **New options**: `--list-formats-as-table`, `--write-link`, `--force-download-archive`, `--force-overwrites`, `--break-on-reject` etc + +* **Improvements**: Multiple `--postprocessor-args`, `%(duration_string)s` in `-o`, faster archive checking, more [format selection options](#format-selection) etc + +See [changelog](Changelog.md) or [commits](https://github.com/pukkandan/yt-dlp/commits) for the full list of changes -To use the latest version, simply download and run the [latest release](https://github.com/pukkandan/yt-dlc/releases/latest). -Currently, there is no support for any package managers. -If you want to install the current master branch +**PS**: Some of these changes are already in youtube-dlc, but are still unreleased. See [this](Changelog.md#unreleased-changes-in-blackjack4494yt-dlc) for details - python -m pip install git+https://github.com/pukkandan/yt-dlc +If you are coming from [youtube-dl](https://github.com/ytdl-org/youtube-dl), the amount of changes are very large. Compare [options](#options) and [supported sites](docs/supportedsites.md) with youtube-dl's to get an idea of the massive number of features/patches [youtube-dlc](https://github.com/blackjack4494/yt-dlc) has accumulated. + + +# INSTALLATION + +You can install yt-dlp using one of the following methods: +* Use [PyPI package](https://pypi.org/project/yt-dlp/): `python -m pip install --upgrade yt-dlp` +* Download the binary from the [latest release](https://github.com/pukkandan/yt-dlp/releases/latest) +* Use pip+git: `python -m pip install --upgrade git+https://github.com/pukkandan/yt-dlp.git@release` +* Install master branch: `python -m pip install --upgrade git+https://github.com/pukkandan/yt-dlp` ### UPDATE -**DO NOT UPDATE using `-U` !** instead download binaries again +`-U` does not work. Simply repeat the install process to update. ### COMPILE @@ -125,9 +108,9 @@ ### COMPILE # DESCRIPTION -**youtube-dlc** is a command-line program to download videos from YouTube.com and a few more sites. It requires the Python interpreter, version 2.6, 2.7, or 3.2+, and it is not platform specific. It should work on your Unix box, on Windows or on macOS. It is released to the public domain, which means you can modify it, redistribute it or use it however you like. +**youtube-dlc** is a command-line program to download videos from youtube.com many other [video platforms](docs/supportedsites.md). It requires the Python interpreter, version 2.6, 2.7, or 3.2+, and it is not platform specific. It should work on your Unix box, on Windows or on macOS. It is released to the public domain, which means you can modify it, redistribute it or use it however you like. - youtube-dlc [OPTIONS] URL [URL...] + youtube-dlc [OPTIONS] [--] URL [URL...] # OPTIONS @@ -142,9 +125,9 @@ ## General Options: permissions (run with sudo if needed) -i, --ignore-errors Continue on download errors, for example to skip unavailable videos in a playlist - (default) (Same as --no-abort-on-error) - --abort-on-error Abort downloading of further videos if an - error occurs (Same as --no-ignore-errors) + (default) (Alias: --no-abort-on-error) + --abort-on-error Abort downloading of further videos if an + error occurs (Alias: --no-ignore-errors) --dump-user-agent Display the current browser identification --list-extractors List all supported extractors --extractor-descriptions Output descriptions of all supported @@ -159,23 +142,25 @@ ## General Options: warning when guessing). "error" just throws an error. The default value "fixup_error" repairs broken URLs, but emits an error if - this is not possible instead of searching. - --ignore-config, --no-config Do not read configuration files. When given - in the global configuration file - /etc/youtube-dl.conf: Do not read the user - configuration in ~/.config/youtube- - dl/config (%APPDATA%/youtube-dl/config.txt - on Windows) + this is not possible instead of searching + --ignore-config, --no-config Disable loading any configuration files + except the one provided by --config-location. + When given inside a configuration + file, no further configuration files are + loaded. Additionally, (for backward + compatibility) if this option is found + inside the system configuration file, the + user configuration is not loaded --config-location PATH Location of the configuration file; either the path to the config or its containing - directory. + directory --flat-playlist Do not extract the videos of a playlist, - only list them. + only list them --flat-videos Do not resolve the video urls --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-color Do not emit color codes in output + --no-colors Do not emit color codes in output ## Network Options: --proxy URL Use the specified HTTP/HTTPS/SOCKS proxy. @@ -193,7 +178,7 @@ ## Geo Restriction: some geo-restricted sites. The default proxy specified by --proxy (or none, if the option is not present) is used for the - actual downloading. + actual downloading --geo-bypass Bypass geographic restriction via faking X-Forwarded-For HTTP header --no-geo-bypass Do not bypass geographic restriction via @@ -215,7 +200,7 @@ ## Video Selection: indexed 1, 2, 5, 8 in the playlist. You can specify range: "--playlist-items 1-3,7,10-13", it will download the videos - at index 1, 2, 3, 7, 10, 11, 12 and 13. + at index 1, 2, 3, 7, 10, 11, 12 and 13 --match-title REGEX Download only matching titles (regex or caseless sub-string) --reject-title REGEX Skip download for matching titles (regex or @@ -239,36 +224,38 @@ ## Video Selection: --max-views COUNT Do not download any videos with more than COUNT views --match-filter FILTER Generic video filter. Specify any key (see - the "OUTPUT TEMPLATE" for a list of - available keys) to match if the key is - present, !key to check if the key is not - present, key > NUMBER (like "comment_count - > 12", also works with >=, <, <=, !=, =) to - compare against a number, key = 'LITERAL' - (like "uploader = 'Mike Smith'", also works - with !=) to match against a string literal - and & to require multiple matches. Values - which are not known are excluded unless you - put a question mark (?) after the operator. - For example, to only match videos that have + "OUTPUT TEMPLATE" for a list of available + keys) to match if the key is present, !key + to check if the key is not present, + key>NUMBER (like "comment_count > 12", also + works with >=, <, <=, !=, =) to compare + against a number, key = 'LITERAL' (like + "uploader = 'Mike Smith'", also works with + !=) to match against a string literal and & + to require multiple matches. Values which + are not known are excluded unless you put a + question mark (?) after the operator. For + example, to only match videos that have been liked more than 100 times and disliked less than 50 times (or the dislike functionality is not available at the given service), but who also have a description, use --match-filter "like_count > 100 & - dislike_count \youtube-dlc.conf`. Note that by default configuration file may not exist so you may need to create it yourself. +You can configure youtube-dlc by placing any supported command line option to a configuration file. The configuration is loaded from the following locations: -For example, with the following configuration file youtube-dlc will always extract the audio, not copy the mtime, use a proxy and save all videos under `Movies` directory in your home directory: +1. The file given by `--config-location` +1. **Portable Configuration**: `yt-dlp.conf` or `youtube-dlc.conf` in the same directory as the bundled binary. If you are running from source-code (`/youtube_dlc/__main__.py`), the root directory is used instead. +1. **User Configuration**: + * `%XDG_CONFIG_HOME%/yt-dlp/config` (recommended on Linux/macOS) + * `%XDG_CONFIG_HOME%/yt-dlp.conf` + * `%APPDATA%/yt-dlp/config` (recommended on Windows) + * `%APPDATA%/yt-dlp/config.txt` + * `~/yt-dlp.conf` + * `~/yt-dlp.conf.txt` + + If none of these files are found, the search is performed again by replacing `yt-dlp` with `youtube-dlc`. Note that `~` points to `C:\Users\` on windows. Also, `%XDG_CONFIG_HOME%` defaults to `~/.config` if undefined +1. **System Configuration**: `/etc/yt-dlp.conf` or `/etc/youtube-dlc.conf` + +For example, with the following configuration file youtube-dlc will always extract the audio, not copy the mtime, use a proxy and save all videos under `YouTube` directory in your home directory: ``` # Lines starting with # are comments @@ -659,15 +674,13 @@ # Do not copy the mtime # Use this proxy --proxy 127.0.0.1:3128 -# Save all videos under Movies directory in your home directory --o ~/Movies/%(title)s.%(ext)s +# Save all videos under YouTube directory in your home directory +-o ~/YouTube/%(title)s.%(ext)s ``` -Note that options in configuration file are just the same options aka switches used in regular command line calls thus there **must be no whitespace** after `-` or `--`, e.g. `-o` or `--proxy` but not `- o` or `-- proxy`. +Note that options in configuration file are just the same options aka switches used in regular command line calls; thus there **must be no whitespace** after `-` or `--`, e.g. `-o` or `--proxy` but not `- o` or `-- proxy`. -You can use `--ignore-config` if you want to disable the configuration file for a particular youtube-dlc run. - -You can also use `--config-location` if you want to use custom configuration file for a particular youtube-dlc run. +You can use `--ignore-config` if you want to disable all configuration files for a particular youtube-dlc run. If `--ignore-config` is found inside any configuration file, no further configuration will be loaded. For example, having the option in the portable configuration file prevents loading of user and system configurations. Additionally, (for backward compatibility) if `--ignore-config` is found inside the system configuration file, the user configuration is not loaded. ### Authentication with `.netrc` file @@ -953,9 +966,17 @@ # and if it doesn't already have an audio stream, merge it with best audio-only # Same as above $ youtube-dlc +# Download the best video-only format and the best audio-only format without merging them +# For this case, an output template should be used since +# by default, bestvideo and bestaudio will have the same file name. +$ youtube-dlc -f 'bv,ba' -o '%(title)s.f%(format_id)s.%(ext)s' + -# Download the worst video available +# The following examples show the old method (without -S) of format selection +# and how to use -S to achieve a similar but better result + +# Download the worst video available (old method) $ youtube-dlc -f 'wv*+wa/w' # Download the best video available but with the smallest resolution @@ -1014,13 +1035,6 @@ # (https/ftps > http/ftp > m3u8_native > m3u8 > http_dash_segments ...) -# Download the best video-only format and the best audio-only format without merging them -# For this case, an output template should be used since -# by default, bestvideo and bestaudio will have the same file name. -$ youtube-dlc -f 'bv,ba' -o '%(title)s.f%(format_id)s.%(ext)s' - - - # Download the best video with h264 codec, or the best video if there is no such video $ youtube-dlc -f '(bv*+ba/b)[vcodec^=avc1] / (bv*+ba/b)'