]> jfr.im git - yt-dlp.git/blob - README.md
[cleanup] Add keyword automatically to SearchIE descriptions
[yt-dlp.git] / README.md
1 <div align="center">
2
3 [![YT-DLP](https://raw.githubusercontent.com/yt-dlp/yt-dlp/master/.github/banner.svg)](#readme)
4
5 [![Release version](https://img.shields.io/github/v/release/yt-dlp/yt-dlp?color=blue&label=&style=for-the-badge)](https://github.com/yt-dlp/yt-dlp/releases/latest)
6 [![CI Status](https://img.shields.io/github/workflow/status/yt-dlp/yt-dlp/Core%20Tests/master?label=&style=for-the-badge)](https://github.com/yt-dlp/yt-dlp/actions)
7 [![License: Unlicense](https://img.shields.io/badge/-Unlicense-blue.svg?style=for-the-badge)](LICENSE)
8 [![Donate](https://img.shields.io/badge/_-Donate-red.svg?logo=githubsponsors&labelColor=555555&style=for-the-badge)](Collaborators.md#collaborators)
9 [![Supported Sites](https://img.shields.io/badge/-Supported_Sites-brightgreen.svg?style=for-the-badge)](supportedsites.md)
10 [![Discord](https://img.shields.io/discord/807245652072857610?color=blue&label=​&logo=discord&style=for-the-badge)](https://discord.gg/H5MNcFW63r)
11 [![Doc Status](https://readthedocs.org/projects/yt-dlp/badge/?version=latest&style=for-the-badge)](https://yt-dlp.readthedocs.io)
12 [![Commits](https://img.shields.io/github/commit-activity/m/yt-dlp/yt-dlp?label=commits&style=for-the-badge)](https://github.com/yt-dlp/yt-dlp/commits)
13 [![Last Commit](https://img.shields.io/github/last-commit/yt-dlp/yt-dlp/master?label=&style=for-the-badge)](https://github.com/yt-dlp/yt-dlp/commits)
14 [![Downloads](https://img.shields.io/github/downloads/yt-dlp/yt-dlp/total?style=for-the-badge&color=blue)](https://github.com/yt-dlp/yt-dlp/releases/latest)
15 [![PyPi Downloads](https://img.shields.io/pypi/dm/yt-dlp?label=PyPi&style=for-the-badge)](https://pypi.org/project/yt-dlp)
16
17 </div>
18
19 yt-dlp 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
20
21 * [NEW FEATURES](#new-features)
22 * [Differences in default behavior](#differences-in-default-behavior)
23 * [INSTALLATION](#installation)
24 * [Update](#update)
25 * [Release Files](#release-files)
26 * [Dependencies](#dependencies)
27 * [Compile](#compile)
28 * [USAGE AND OPTIONS](#usage-and-options)
29 * [General Options](#general-options)
30 * [Network Options](#network-options)
31 * [Geo-restriction](#geo-restriction)
32 * [Video Selection](#video-selection)
33 * [Download Options](#download-options)
34 * [Filesystem Options](#filesystem-options)
35 * [Thumbnail Options](#thumbnail-options)
36 * [Internet Shortcut Options](#internet-shortcut-options)
37 * [Verbosity and Simulation Options](#verbosity-and-simulation-options)
38 * [Workarounds](#workarounds)
39 * [Video Format Options](#video-format-options)
40 * [Subtitle Options](#subtitle-options)
41 * [Authentication Options](#authentication-options)
42 * [Post-processing Options](#post-processing-options)
43 * [SponsorBlock Options](#sponsorblock-options)
44 * [Extractor Options](#extractor-options)
45 * [CONFIGURATION](#configuration)
46 * [Authentication with .netrc file](#authentication-with-netrc-file)
47 * [OUTPUT TEMPLATE](#output-template)
48 * [Output template and Windows batch files](#output-template-and-windows-batch-files)
49 * [Output template examples](#output-template-examples)
50 * [FORMAT SELECTION](#format-selection)
51 * [Filtering Formats](#filtering-formats)
52 * [Sorting Formats](#sorting-formats)
53 * [Format Selection examples](#format-selection-examples)
54 * [MODIFYING METADATA](#modifying-metadata)
55 * [Modifying metadata examples](#modifying-metadata-examples)
56 * [EXTRACTOR ARGUMENTS](#extractor-arguments)
57 * [PLUGINS](#plugins)
58 * [EMBEDDING YT-DLP](#embedding-yt-dlp)
59 * [DEPRECATED OPTIONS](#deprecated-options)
60 * [CONTRIBUTING](CONTRIBUTING.md#contributing-to-yt-dlp)
61 * [Opening an Issue](CONTRIBUTING.md#opening-an-issue)
62 * [Developer Instructions](CONTRIBUTING.md#developer-instructions)
63 * [MORE](#more)
64 </div>
65
66
67 # NEW FEATURES
68 The major new features from the latest release of [blackjack4494/yt-dlc](https://github.com/blackjack4494/yt-dlc) are:
69
70 * **[SponsorBlock Integration](#sponsorblock-options)**: You can mark/remove sponsor sections in youtube videos by utilizing the [SponsorBlock](https://sponsor.ajay.app) API
71
72 * **[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 than what is possible by simply using `--format` ([examples](#format-selection-examples))
73
74 * **Merged with youtube-dl [commit/379f52a](https://github.com/ytdl-org/youtube-dl/commit/379f52a4954013767219d25099cce9e0f9401961)**: (v2021.06.06) 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)
75
76 * **Merged with animelover1984/youtube-dl**: You get most of the features and improvements from [animelover1984/youtube-dl](https://github.com/animelover1984/youtube-dl) including `--write-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.
77
78 * **Youtube improvements**:
79 * All Feeds (`:ytfav`, `:ytwatchlater`, `:ytsubs`, `:ythistory`, `:ytrec`) and private playlists supports downloading multiple pages of content
80 * Search (`ytsearch:`, `ytsearchdate:`), search URLs and in-channel search works
81 * Mixes supports downloading multiple pages of content
82 * Most (but not all) age-gated content can be downloaded without cookies
83 * Partial workaround for throttling issue
84 * Redirect channel's home URL automatically to `/video` to preserve the old behaviour
85 * `255kbps` audio is extracted (if available) from youtube music when premium cookies are given
86 * Youtube music Albums, channels etc can be downloaded ([except self-uploaded music](https://github.com/yt-dlp/yt-dlp/issues/723))
87
88 * **Cookies from browser**: Cookies can be automatically extracted from all major web browsers using `--cookies-from-browser BROWSER[:PROFILE]`
89
90 * **Split video by chapters**: Videos can be split into multiple files based on chapters using `--split-chapters`
91
92 * **Multi-threaded fragment downloads**: Download multiple fragments of m3u8/mpd videos in parallel. Use `--concurrent-fragments` (`-N`) option to set the number of threads used
93
94 * **Aria2c with HLS/DASH**: You can use `aria2c` as the external downloader for DASH(mpd) and HLS(m3u8) formats
95
96 * **New extractors**: AnimeLab, Philo MSO, Spectrum MSO, SlingTV MSO, Cablevision MSO, RCN MSO, Rcs, Gedi, bitwave.tv, mildom, audius, zee5, mtv.it, wimtv, pluto.tv, niconico users, discoveryplus.in, mediathek, NFHSNetwork, nebula, ukcolumn, whowatch, MxplayerShow, parlview (au), YoutubeWebArchive, fancode, Saitosan, ShemarooMe, telemundo, VootSeries, SonyLIVSeries, HotstarSeries, VidioPremier, VidioLive, RCTIPlus, TBS Live, douyin, pornflip, ParamountPlusSeries, ScienceChannel, Utreon, OpenRec, BandcampMusic, blackboardcollaborate, eroprofile albums, mirrativ, BannedVideo, bilibili categories, Epicon, filmmodu, GabTV, HungamaAlbum, ManotoTV, Niconico search, Patreon User, peloton, ProjectVeritas, radiko, StarTV, tiktok user, Tokentube, voicy, TV2HuSeries, biliintl, 17live, NewgroundsUser, peertube channel/playlist, ZenYandex, CAM4, CGTN, damtomo, gotostage, Koo, Mediaite, Mediaklikk, MuseScore, nzherald, Olympics replay, radlive, SovietsCloset, Streamanity, Theta, Chingari, ciscowebex, Gettr, GoPro, N1, Theta, Veo, Vupload, NovaPlay, SkyNewsAU, EUScreen, Gronkh, microsoftstream, on24, trovo channels
97
98 * **Fixed/improved extractors**: archive.org, roosterteeth.com, skyit, instagram, itv, SouthparkDe, spreaker, Vlive, akamai, ina, rumble, tennistv, amcnetworks, la7 podcasts, linuxacadamy, nitter, twitcasting, viu, crackle, curiositystream, mediasite, rmcdecouverte, sonyliv, tubi, tenplay, patreon, videa, yahoo, BravoTV, crunchyroll, RTP, viki, Hotstar, vidio, vimeo, mediaset, Mxplayer, nbcolympics, ParamountPlus, Newgrounds, SAML Verizon login, Hungama, afreecatv, aljazeera, ATV, bitchute, camtube, CDA, eroprofile, facebook, HearThisAtIE, iwara, kakao, Motherless, Nova, peertube, pornhub, reddit, tiktok, TV2, TV2Hu, tv5mondeplus, VH1, Viafree, XHamster, 9Now, AnimalPlanet, Arte, CBC, Chingari, comedycentral, DIYNetwork, niconico, dw, funimation, globo, HiDive, NDR, Nuvid, Oreilly, pbs, plutotv, reddit, redtube, soundcloud, SpankBang, VrtNU, bbc, Bilibili, LinkedInLearning, parliamentlive, PolskieRadio, Streamable, vidme, francetv, 7plus, tagesschau
99
100 * **Subtitle extraction from manifests**: Subtitles can be extracted from streaming media manifests. See [commit/be6202f](https://github.com/yt-dlp/yt-dlp/commit/be6202f12b97858b9d716e608394b51065d0419f) for details
101
102 * **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`)
103
104 * **Portable Configuration**: Configuration files are automatically loaded from the home and root directories. See [configuration](#configuration) for details
105
106 * **Output template improvements**: Output templates can now have date-time formatting, numeric offsets, object traversal etc. See [output template](#output-template) for details. Even more advanced operations can also be done with the help of `--parse-metadata` and `--replace-in-metadata`
107
108 * **Other new options**: `--print`, `--sleep-requests`, `--convert-thumbnails`, `--write-link`, `--force-download-archive`, `--force-overwrites`, `--break-on-reject` etc
109
110 * **Improvements**: Regex and other operators in `--match-filter`, multiple `--postprocessor-args` and `--downloader-args`, faster archive checking, more [format selection options](#format-selection) etc
111
112 * **Plugin extractors**: Extractors can be loaded from an external file. See [plugins](#plugins) for details
113
114 * **Self-updater**: The releases can be updated using `yt-dlp -U`
115
116
117 See [changelog](Changelog.md) or [commits](https://github.com/yt-dlp/yt-dlp/commits) for the full list of changes
118
119
120 **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
121
122 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](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.
123
124 ### Differences in default behavior
125
126 Some of yt-dlp's default options are different from that of youtube-dl and youtube-dlc.
127
128 * The options `--auto-number` (`-A`), `--title` (`-t`) and `--literal` (`-l`), no longer work. See [removed options](#Removed) for details
129 * `avconv` is not supported as as an alternative to `ffmpeg`
130 * The default [output template](#output-template) is `%(title)s [%(id)s].%(ext)s`. There is no real reason for this change. This was changed before yt-dlp was ever made public and now there are no plans to change it back to `%(title)s-%(id)s.%(ext)s`. Instead, you may use `--compat-options filename`
131 * The default [format sorting](#sorting-formats) is different from youtube-dl and prefers higher resolution and better codecs rather than higher bitrates. You can use the `--format-sort` option to change this to any order you prefer, or use `--compat-options format-sort` to use youtube-dl's sorting order
132 * The default format selector is `bv*+ba/b`. This means that if a combined video + audio format that is better than the best video-only format is found, the former will be prefered. Use `-f bv+ba/b` or `--compat-options format-spec` to revert this
133 * Unlike youtube-dlc, yt-dlp does not allow merging multiple audio/video streams into one file by default (since this conflicts with the use of `-f bv*+ba`). If needed, this feature must be enabled using `--audio-multistreams` and `--video-multistreams`. You can also use `--compat-options multistreams` to enable both
134 * `--ignore-errors` is enabled by default. Use `--abort-on-error` or `--compat-options abort-on-error` to abort on errors instead
135 * When writing metadata files such as thumbnails, description or infojson, the same information (if available) is also written for playlists. Use `--no-write-playlist-metafiles` or `--compat-options no-playlist-metafiles` to not write these files
136 * `--add-metadata` attaches the `infojson` to `mkv` files in addition to writing the metadata when used with `--write-infojson`. Use `--compat-options no-attach-info-json` to revert this
137 * `playlist_index` behaves differently when used with options like `--playlist-reverse` and `--playlist-items`. See [#302](https://github.com/yt-dlp/yt-dlp/issues/302) for details. You can use `--compat-options playlist-index` if you want to keep the earlier behavior
138 * The output of `-F` is listed in a new format. Use `--compat-options list-formats` to revert this
139 * All *experiences* of a funimation episode are considered as a single video. This behavior breaks existing archives. Use `--compat-options seperate-video-versions` to extract information from only the default player
140 * Youtube live chat (if available) is considered as a subtitle. Use `--sub-langs all,-live_chat` to download all subtitles except live chat. You can also use `--compat-options no-live-chat` to prevent live chat from downloading
141 * Youtube channel URLs are automatically redirected to `/video`. Append a `/featured` to the URL to download only the videos in the home page. If the channel does not have a videos tab, we try to download the equivalent `UU` playlist instead. Also, `/live` URLs raise an error if there are no live videos instead of silently downloading the entire channel. You may use `--compat-options no-youtube-channel-redirect` to revert all these redirections
142 * Unavailable videos are also listed for youtube playlists. Use `--compat-options no-youtube-unavailable-videos` to remove this
143 * If `ffmpeg` is used as the downloader, the downloading and merging of formats happen in a single step when possible. Use `--compat-options no-direct-merge` to revert this
144 * Thumbnail embedding in `mp4` is done with mutagen if possible. Use `--compat-options embed-thumbnail-atomicparsley` to force the use of AtomicParsley instead
145 * Some private fields such as filenames are removed by default from the infojson. Use `--no-clean-infojson` or `--compat-options no-clean-infojson` to revert this
146 * When `--embed-subs` and `--write-subs` are used together, the subtitles are written to disk and also embedded in the media file. You can use just `--embed-subs` to embed the subs and automatically delete the seperate file. See [#630 (comment)](https://github.com/yt-dlp/yt-dlp/issues/630#issuecomment-893659460) for more info. `--compat-options no-keep-subs` can be used to revert this.
147
148 For ease of use, a few more compat options are available:
149 * `--compat-options all`: Use all compat options
150 * `--compat-options youtube-dl`: Same as `--compat-options all,-multistreams`
151 * `--compat-options youtube-dlc`: Same as `--compat-options all,-no-live-chat,-no-youtube-channel-redirect`
152
153
154 # INSTALLATION
155 yt-dlp is not platform specific. So it should work on your Unix box, on Windows or on macOS
156
157 You can install yt-dlp using one of the following methods:
158 * Download [the binary](#release-files) from the [latest release](https://github.com/yt-dlp/yt-dlp/releases/latest)
159 * With Homebrew, `brew install yt-dlp/taps/yt-dlp`
160 * Use [PyPI package](https://pypi.org/project/yt-dlp): `python3 -m pip install --upgrade yt-dlp`
161 * Install master branch: `python3 -m pip3 install -U https://github.com/yt-dlp/yt-dlp/archive/master.zip`
162
163 Note that on some systems, you may need to use `py` or `python` instead of `python3`
164
165 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:
166
167 ```
168 sudo curl -L https://github.com/yt-dlp/yt-dlp/releases/latest/download/yt-dlp -o /usr/local/bin/yt-dlp
169 sudo chmod a+rx /usr/local/bin/yt-dlp
170 ```
171
172 ```
173 sudo wget https://github.com/yt-dlp/yt-dlp/releases/latest/download/yt-dlp -O /usr/local/bin/yt-dlp
174 sudo chmod a+rx /usr/local/bin/yt-dlp
175 ```
176
177 ```
178 sudo aria2c https://github.com/yt-dlp/yt-dlp/releases/latest/download/yt-dlp -o /usr/local/bin/yt-dlp
179 sudo chmod a+rx /usr/local/bin/yt-dlp
180 ```
181
182 macOS or Linux users that are using Homebrew (formerly known as Linuxbrew for Linux users) can also install it by:
183
184 ```
185 brew install yt-dlp/taps/yt-dlp
186 ```
187
188 ### UPDATE
189 You can use `yt-dlp -U` to update if you are using the provided release.
190 If you are using `pip`, simply re-run the same command that was used to install the program.
191 If you have installed using Homebrew, run `brew upgrade yt-dlp/taps/yt-dlp`
192
193 ### RELEASE FILES
194
195 #### Recommended
196
197 File|Description
198 :---|:---
199 [yt-dlp](https://github.com/yt-dlp/yt-dlp/releases/latest/download/yt-dlp)|Platform independant binary. Needs Python (Recommended for **UNIX-like systems**)
200 [yt-dlp.exe](https://github.com/yt-dlp/yt-dlp/releases/latest/download/yt-dlp.exe)|Windows (Win7 SP1+) standalone x64 binary (Recommended for **Windows**)
201
202 #### Alternatives
203
204 File|Description
205 :---|:---
206 [yt-dlp_macos](https://github.com/yt-dlp/yt-dlp/releases/latest/download/yt-dlp_macos)|MacOS (10.15+) standalone executable
207 [yt-dlp_x86.exe](https://github.com/yt-dlp/yt-dlp/releases/latest/download/yt-dlp_x86.exe)|Windows (Vista SP2+) standalone x86 (32bit) binary
208 [yt-dlp_min.exe](https://github.com/yt-dlp/yt-dlp/releases/latest/download/yt-dlp_min.exe)|Windows (Win7 SP1+) standalone x64 binary built with `py2exe`.<br/> Does not contain `pycryptodomex`, needs VC++14
209 [yt-dlp_win.zip](https://github.com/yt-dlp/yt-dlp/releases/latest/download/yt-dlp_win.zip)|Unpackaged windows executable (No auto-update)
210 [yt-dlp_macos.zip](https://github.com/yt-dlp/yt-dlp/releases/latest/download/yt-dlp_macos.zip)|Unpackaged MacOS (10.15+) executable (No auto-update)
211
212 #### Misc
213
214 File|Description
215 :---|:---
216 [yt-dlp.tar.gz](https://github.com/yt-dlp/yt-dlp/releases/latest/download/yt-dlp.tar.gz)|Source tarball. Also contains manpages, completions, etc
217 [SHA2-512SUMS](https://github.com/yt-dlp/yt-dlp/releases/latest/download/SHA2-512SUMS)|GNU-style SHA512 sums
218 [SHA2-256SUMS](https://github.com/yt-dlp/yt-dlp/releases/latest/download/SHA2-256SUMS)|GNU-style SHA256 sums
219
220 ### DEPENDENCIES
221 Python versions 3.6+ (CPython and PyPy) are supported. Other versions and implementations may or may not work correctly.
222
223 <!-- Python 3.5+ uses VC++14 and it is already embedded in the binary created
224 <!x-- https://www.microsoft.com/en-us/download/details.aspx?id=26999 --x>
225 On windows, [Microsoft Visual C++ 2010 SP1 Redistributable Package (x86)](https://download.microsoft.com/download/1/6/5/165255E7-1014-4D0A-B094-B6A430A6BFFC/vcredist_x86.exe) is also necessary to run yt-dlp. You probably already have this, but if the executable throws an error due to missing `MSVCR100.dll` you need to install it manually.
226 -->
227
228 While all the other dependancies are optional, `ffmpeg` and `ffprobe` are highly recommended
229 * [**ffmpeg** and **ffprobe**](https://www.ffmpeg.org) - Required for [merging seperate video and audio files](#format-selection) as well as for various [post-processing](#post-processing-options) tasks. Licence [depends on the build](https://www.ffmpeg.org/legal.html)
230 * [**mutagen**](https://github.com/quodlibet/mutagen) - For embedding thumbnail in certain formats. Licenced under [GPLv2+](https://github.com/quodlibet/mutagen/blob/master/COPYING)
231 * [**pycryptodomex**](https://github.com/Legrandin/pycryptodome) - For decrypting AES-128 HLS streams and various other data. Licenced under [BSD2](https://github.com/Legrandin/pycryptodome/blob/master/LICENSE.rst)
232 * [**websockets**](https://github.com/aaugustin/websockets) - For downloading over websocket. Licenced under [BSD3](https://github.com/aaugustin/websockets/blob/main/LICENSE)
233 * [**keyring**](https://github.com/jaraco/keyring) - For decrypting cookies of chromium-based browsers on Linux. Licenced under [MIT](https://github.com/jaraco/keyring/blob/main/LICENSE)
234 * [**AtomicParsley**](https://github.com/wez/atomicparsley) - For embedding thumbnail in mp4/m4a if mutagen is not present. Licenced under [GPLv2+](https://github.com/wez/atomicparsley/blob/master/COPYING)
235 * [**rtmpdump**](http://rtmpdump.mplayerhq.hu) - For downloading `rtmp` streams. ffmpeg will be used as a fallback. Licenced under [GPLv2+](http://rtmpdump.mplayerhq.hu)
236 * [**mplayer**](http://mplayerhq.hu/design7/info.html) or [**mpv**](https://mpv.io) - For downloading `rstp` streams. ffmpeg will be used as a fallback. Licenced under [GPLv2+](https://github.com/mpv-player/mpv/blob/master/Copyright)
237 * [**phantomjs**](https://github.com/ariya/phantomjs) - Used in extractors where javascript needs to be run. Licenced under [BSD3](https://github.com/ariya/phantomjs/blob/master/LICENSE.BSD)
238 * [**sponskrub**](https://github.com/faissaloo/SponSkrub) - For using the now **deprecated** [sponskrub options](#sponskrub-options). Licenced under [GPLv3+](https://github.com/faissaloo/SponSkrub/blob/master/LICENCE.md)
239 * Any external downloader that you want to use with `--downloader`
240
241 To use or redistribute the dependencies, you must agree to their respective licensing terms.
242
243 The windows releases are already built with the python interpreter, mutagen, pycryptodomex and websockets included.
244
245 **Note**: There are some regressions in newer ffmpeg versions that causes various issues when used alongside yt-dlp. Since ffmpeg is such an important dependancy, we provide [custom builds](https://github.com/yt-dlp/FFmpeg-Builds/wiki/Latest#latest-autobuilds) with patches for these issues at [yt-dlp/FFmpeg-Builds](https://github.com/yt-dlp/FFmpeg-Builds). See [the readme](https://github.com/yt-dlp/FFmpeg-Builds#patches-applied) for details on the specifc issues solved by these builds
246
247
248 ### COMPILE
249
250 **For Windows**:
251 To build the Windows executable, you must have pyinstaller (and optionally mutagen, pycryptodomex, websockets). Once you have all the necessary dependencies installed, (optionally) build lazy extractors using `devscripts/make_lazy_extractors.py`, and then just run `pyinst.py`. The executable will be built for the same architecture (32/64 bit) as the python used to build it.
252
253 py -m pip install -U pyinstaller -r requirements.txt
254 py devscripts/make_lazy_extractors.py
255 py pyinst.py
256
257 Note that pyinstaller [does not support](https://github.com/pyinstaller/pyinstaller#requirements-and-tested-platforms) Python installed from the Windows store without using a virtual environment
258
259 **For Unix**:
260 You will need the required build tools: `python`, `make` (GNU), `pandoc`, `zip`, `pytest`
261 Then simply run `make`. You can also run `make yt-dlp` instead to compile only the binary without updating any of the additional files
262
263 **Note**: In either platform, `devscripts/update-version.py` can be used to automatically update the version number
264
265 # USAGE AND OPTIONS
266
267 yt-dlp [OPTIONS] [--] URL [URL...]
268
269 `Ctrl+F` is your friend :D
270 <!-- Auto generated -->
271
272 ## General Options:
273 -h, --help Print this help text and exit
274 --version Print program version and exit
275 -U, --update Update this program to latest version. Make
276 sure that you have sufficient permissions
277 (run with sudo if needed)
278 -i, --ignore-errors Ignore download and postprocessing errors.
279 The download will be considered successfull
280 even if the postprocessing fails
281 --no-abort-on-error Continue with next video on download
282 errors; e.g. to skip unavailable videos in
283 a playlist (default)
284 --abort-on-error Abort downloading of further videos if an
285 error occurs (Alias: --no-ignore-errors)
286 --dump-user-agent Display the current user-agent and exit
287 --list-extractors List all supported extractors and exit
288 --extractor-descriptions Output descriptions of all supported
289 extractors and exit
290 --force-generic-extractor Force extraction to use the generic
291 extractor
292 --default-search PREFIX Use this prefix for unqualified URLs. For
293 example "gvsearch2:" downloads two videos
294 from google videos for the search term
295 "large apple". Use the value "auto" to let
296 yt-dlp guess ("auto_warning" to emit a
297 warning when guessing). "error" just throws
298 an error. The default value "fixup_error"
299 repairs broken URLs, but emits an error if
300 this is not possible instead of searching
301 --ignore-config, --no-config Disable loading any configuration files
302 except the one provided by --config-location.
303 When given inside a configuration
304 file, no further configuration files are
305 loaded. Additionally, (for backward
306 compatibility) if this option is found
307 inside the system configuration file, the
308 user configuration is not loaded
309 --config-location PATH Location of the main configuration file;
310 either the path to the config or its
311 containing directory
312 --flat-playlist Do not extract the videos of a playlist,
313 only list them
314 --no-flat-playlist Extract the videos of a playlist
315 --mark-watched Mark videos watched (even with --simulate).
316 Currently only supported for YouTube
317 --no-mark-watched Do not mark videos watched (default)
318 --no-colors Do not emit color codes in output
319 --compat-options OPTS Options that can help keep compatibility
320 with youtube-dl or youtube-dlc
321 configurations by reverting some of the
322 changes made in yt-dlp. See "Differences in
323 default behavior" for details
324
325 ## Network Options:
326 --proxy URL Use the specified HTTP/HTTPS/SOCKS proxy.
327 To enable SOCKS proxy, specify a proper
328 scheme. For example
329 socks5://127.0.0.1:1080/. Pass in an empty
330 string (--proxy "") for direct connection
331 --socket-timeout SECONDS Time to wait before giving up, in seconds
332 --source-address IP Client-side IP address to bind to
333 -4, --force-ipv4 Make all connections via IPv4
334 -6, --force-ipv6 Make all connections via IPv6
335
336 ## Geo-restriction:
337 --geo-verification-proxy URL Use this proxy to verify the IP address for
338 some geo-restricted sites. The default
339 proxy specified by --proxy (or none, if the
340 option is not present) is used for the
341 actual downloading
342 --geo-bypass Bypass geographic restriction via faking
343 X-Forwarded-For HTTP header
344 --no-geo-bypass Do not bypass geographic restriction via
345 faking X-Forwarded-For HTTP header
346 --geo-bypass-country CODE Force bypass geographic restriction with
347 explicitly provided two-letter ISO 3166-2
348 country code
349 --geo-bypass-ip-block IP_BLOCK Force bypass geographic restriction with
350 explicitly provided IP block in CIDR
351 notation
352
353 ## Video Selection:
354 --playlist-start NUMBER Playlist video to start at (default is 1)
355 --playlist-end NUMBER Playlist video to end at (default is last)
356 --playlist-items ITEM_SPEC Playlist video items to download. Specify
357 indices of the videos in the playlist
358 separated by commas like: "--playlist-items
359 1,2,5,8" if you want to download videos
360 indexed 1, 2, 5, 8 in the playlist. You can
361 specify range: "--playlist-items
362 1-3,7,10-13", it will download the videos
363 at index 1, 2, 3, 7, 10, 11, 12 and 13
364 --max-downloads NUMBER Abort after downloading NUMBER files
365 --min-filesize SIZE Do not download any videos smaller than
366 SIZE (e.g. 50k or 44.6m)
367 --max-filesize SIZE Do not download any videos larger than SIZE
368 (e.g. 50k or 44.6m)
369 --date DATE Download only videos uploaded in this date.
370 The date can be "YYYYMMDD" or in the format
371 "(now|today)[+-][0-9](day|week|month|year)(s)?"
372 --datebefore DATE Download only videos uploaded on or before
373 this date. The date formats accepted is the
374 same as --date
375 --dateafter DATE Download only videos uploaded on or after
376 this date. The date formats accepted is the
377 same as --date
378 --match-filter FILTER Generic video filter. Any field (see
379 "OUTPUT TEMPLATE") can be compared with a
380 number or a string using the operators
381 defined in "Filtering formats". You can
382 also simply specify a field to match if the
383 field is present and "!field" to check if
384 the field is not present. In addition,
385 Python style regular expression matching
386 can be done using "~=", and multiple
387 filters can be checked with "&". Use a "\"
388 to escape "&" or quotes if needed. Eg:
389 --match-filter "!is_live & like_count>?100
390 & description~='(?i)\bcats \& dogs\b'"
391 matches only videos that are not live, has
392 a like count more than 100 (or the like
393 field is not available), and also has a
394 description that contains the phrase "cats
395 & dogs" (ignoring case)
396 --no-match-filter Do not use generic video filter (default)
397 --no-playlist Download only the video, if the URL refers
398 to a video and a playlist
399 --yes-playlist Download the playlist, if the URL refers to
400 a video and a playlist
401 --age-limit YEARS Download only videos suitable for the given
402 age
403 --download-archive FILE Download only videos not listed in the
404 archive file. Record the IDs of all
405 downloaded videos in it
406 --break-on-existing Stop the download process when encountering
407 a file that is in the archive
408 --break-on-reject Stop the download process when encountering
409 a file that has been filtered out
410 --skip-playlist-after-errors N Number of allowed failures until the rest
411 of the playlist is skipped
412 --no-download-archive Do not use archive file (default)
413
414 ## Download Options:
415 -N, --concurrent-fragments N Number of fragments of a dash/hlsnative
416 video that should be download concurrently
417 (default is 1)
418 -r, --limit-rate RATE Maximum download rate in bytes per second
419 (e.g. 50K or 4.2M)
420 --throttled-rate RATE Minimum download rate in bytes per second
421 below which throttling is assumed and the
422 video data is re-extracted (e.g. 100K)
423 -R, --retries RETRIES Number of retries (default is 10), or
424 "infinite"
425 --fragment-retries RETRIES Number of retries for a fragment (default
426 is 10), or "infinite" (DASH, hlsnative and
427 ISM)
428 --skip-unavailable-fragments Skip unavailable fragments for DASH,
429 hlsnative and ISM (default)
430 (Alias: --no-abort-on-unavailable-fragment)
431 --abort-on-unavailable-fragment Abort downloading if a fragment is unavailable
432 (Alias: --no-skip-unavailable-fragments)
433 --keep-fragments Keep downloaded fragments on disk after
434 downloading is finished
435 --no-keep-fragments Delete downloaded fragments after
436 downloading is finished (default)
437 --buffer-size SIZE Size of download buffer (e.g. 1024 or 16K)
438 (default is 1024)
439 --resize-buffer The buffer size is automatically resized
440 from an initial value of --buffer-size
441 (default)
442 --no-resize-buffer Do not automatically adjust the buffer size
443 --http-chunk-size SIZE Size of a chunk for chunk-based HTTP
444 downloading (e.g. 10485760 or 10M) (default
445 is disabled). May be useful for bypassing
446 bandwidth throttling imposed by a webserver
447 (experimental)
448 --playlist-reverse Download playlist videos in reverse order
449 --no-playlist-reverse Download playlist videos in default order
450 (default)
451 --playlist-random Download playlist videos in random order
452 --xattr-set-filesize Set file xattribute ytdl.filesize with
453 expected file size
454 --hls-use-mpegts Use the mpegts container for HLS videos;
455 allowing some players to play the video
456 while downloading, and reducing the chance
457 of file corruption if download is
458 interrupted. This is enabled by default for
459 live streams
460 --no-hls-use-mpegts Do not use the mpegts container for HLS
461 videos. This is default when not
462 downloading live streams
463 --downloader [PROTO:]NAME Name or path of the external downloader to
464 use (optionally) prefixed by the protocols
465 (http, ftp, m3u8, dash, rstp, rtmp, mms) to
466 use it for. Currently supports native,
467 aria2c, avconv, axel, curl, ffmpeg, httpie,
468 wget (Recommended: aria2c). You can use
469 this option multiple times to set different
470 downloaders for different protocols. For
471 example, --downloader aria2c --downloader
472 "dash,m3u8:native" will use aria2c for
473 http/ftp downloads, and the native
474 downloader for dash/m3u8 downloads
475 (Alias: --external-downloader)
476 --downloader-args NAME:ARGS Give these arguments to the external
477 downloader. Specify the downloader name and
478 the arguments separated by a colon ":". For
479 ffmpeg, arguments can be passed to
480 different positions using the same syntax
481 as --postprocessor-args. You can use this
482 option multiple times to give different
483 arguments to different downloaders
484 (Alias: --external-downloader-args)
485
486 ## Filesystem Options:
487 -a, --batch-file FILE File containing URLs to download ('-' for
488 stdin), one URL per line. Lines starting
489 with '#', ';' or ']' are considered as
490 comments and ignored
491 --no-batch-file Do not read URLs from batch file (default)
492 -P, --paths [TYPES:]PATH The paths where the files should be
493 downloaded. Specify the type of file and
494 the path separated by a colon ":". All the
495 same types as --output are supported.
496 Additionally, you can also provide "home"
497 (default) and "temp" paths. All
498 intermediary files are first downloaded to
499 the temp path and then the final files are
500 moved over to the home path after download
501 is finished. This option is ignored if
502 --output is an absolute path
503 -o, --output [TYPES:]TEMPLATE Output filename template; see "OUTPUT
504 TEMPLATE" for details
505 --output-na-placeholder TEXT Placeholder value for unavailable meta
506 fields in output filename template
507 (default: "NA")
508 --restrict-filenames Restrict filenames to only ASCII
509 characters, and avoid "&" and spaces in
510 filenames
511 --no-restrict-filenames Allow Unicode characters, "&" and spaces in
512 filenames (default)
513 --windows-filenames Force filenames to be windows compatible
514 --no-windows-filenames Make filenames windows compatible only if
515 using windows (default)
516 --trim-filenames LENGTH Limit the filename length (excluding
517 extension) to the specified number of
518 characters
519 -w, --no-overwrites Do not overwrite any files
520 --force-overwrites Overwrite all video and metadata files.
521 This option includes --no-continue
522 --no-force-overwrites Do not overwrite the video, but overwrite
523 related files (default)
524 -c, --continue Resume partially downloaded files/fragments
525 (default)
526 --no-continue Do not resume partially downloaded
527 fragments. If the file is not fragmented,
528 restart download of the entire file
529 --part Use .part files instead of writing directly
530 into output file (default)
531 --no-part Do not use .part files - write directly
532 into output file
533 --mtime Use the Last-modified header to set the
534 file modification time (default)
535 --no-mtime Do not use the Last-modified header to set
536 the file modification time
537 --write-description Write video description to a .description
538 file
539 --no-write-description Do not write video description (default)
540 --write-info-json Write video metadata to a .info.json file
541 (this may contain personal information)
542 --no-write-info-json Do not write video metadata (default)
543 --write-playlist-metafiles Write playlist metadata in addition to the
544 video metadata when using --write-info-json,
545 --write-description etc. (default)
546 --no-write-playlist-metafiles Do not write playlist metadata when using
547 --write-info-json, --write-description etc.
548 --clean-infojson Remove some private fields such as
549 filenames from the infojson. Note that it
550 could still contain some personal
551 information (default)
552 --no-clean-infojson Write all fields to the infojson
553 --write-comments Retrieve video comments to be placed in the
554 infojson. The comments are fetched even
555 without this option if the extraction is
556 known to be quick (Alias: --get-comments)
557 --no-write-comments Do not retrieve video comments unless the
558 extraction is known to be quick
559 (Alias: --no-get-comments)
560 --load-info-json FILE JSON file containing the video information
561 (created with the "--write-info-json"
562 option)
563 --cookies FILE File to read cookies from and dump cookie
564 jar in
565 --no-cookies Do not read/dump cookies from/to file
566 (default)
567 --cookies-from-browser BROWSER[:PROFILE]
568 Load cookies from a user profile of the
569 given web browser. Currently supported
570 browsers are: brave, chrome, chromium,
571 edge, firefox, opera, safari, vivaldi. You
572 can specify the user profile name or
573 directory using "BROWSER:PROFILE_NAME" or
574 "BROWSER:PROFILE_PATH". If no profile is
575 given, the most recently accessed one is
576 used
577 --no-cookies-from-browser Do not load cookies from browser (default)
578 --cache-dir DIR Location in the filesystem where youtube-dl
579 can store some downloaded information (such
580 as client ids and signatures) permanently.
581 By default $XDG_CACHE_HOME/yt-dlp or
582 ~/.cache/yt-dlp
583 --no-cache-dir Disable filesystem caching
584 --rm-cache-dir Delete all filesystem cache files
585
586 ## Thumbnail Options:
587 --write-thumbnail Write thumbnail image to disk
588 --no-write-thumbnail Do not write thumbnail image to disk
589 (default)
590 --write-all-thumbnails Write all thumbnail image formats to disk
591 --list-thumbnails List available thumbnails of each video.
592 Simulate unless --no-simulate is used
593
594 ## Internet Shortcut Options:
595 --write-link Write an internet shortcut file, depending
596 on the current platform (.url, .webloc or
597 .desktop). The URL may be cached by the OS
598 --write-url-link Write a .url Windows internet shortcut. The
599 OS caches the URL based on the file path
600 --write-webloc-link Write a .webloc macOS internet shortcut
601 --write-desktop-link Write a .desktop Linux internet shortcut
602
603 ## Verbosity and Simulation Options:
604 -q, --quiet Activate quiet mode. If used with
605 --verbose, print the log to stderr
606 --no-warnings Ignore warnings
607 -s, --simulate Do not download the video and do not write
608 anything to disk
609 --no-simulate Download the video even if printing/listing
610 options are used
611 --ignore-no-formats-error Ignore "No video formats" error. Usefull
612 for extracting metadata even if the videos
613 are not actually available for download
614 (experimental)
615 --no-ignore-no-formats-error Throw error when no downloadable video
616 formats are found (default)
617 --skip-download Do not download the video but write all
618 related files (Alias: --no-download)
619 -O, --print TEMPLATE Quiet, but print the given fields for each
620 video. Simulate unless --no-simulate is
621 used. Either a field name or same syntax as
622 the output template can be used
623 -j, --dump-json Quiet, but print JSON information for each
624 video. Simulate unless --no-simulate is
625 used. See "OUTPUT TEMPLATE" for a
626 description of available keys
627 -J, --dump-single-json Quiet, but print JSON information for each
628 url or infojson passed. Simulate unless
629 --no-simulate is used. If the URL refers to
630 a playlist, the whole playlist information
631 is dumped in a single line
632 --force-write-archive Force download archive entries to be
633 written as far as no errors occur, even if
634 -s or another simulation option is used
635 (Alias: --force-download-archive)
636 --newline Output progress bar as new lines
637 --no-progress Do not print progress bar
638 --progress Show progress bar, even if in quiet mode
639 --console-title Display progress in console titlebar
640 --progress-template [TYPES:]TEMPLATE
641 Template for progress outputs, optionally
642 prefixed with one of "download:" (default),
643 "download-title:" (the console title),
644 "postprocess:", or "postprocess-title:".
645 The video's fields are accessible under the
646 "info" key and the progress attributes are
647 accessible under "progress" key. Eg:
648 --console-title --progress-template
649 "download-title:%(info.id)s-%(progress.eta)s"
650 -v, --verbose Print various debugging information
651 --dump-pages Print downloaded pages encoded using base64
652 to debug problems (very verbose)
653 --write-pages Write downloaded intermediary pages to
654 files in the current directory to debug
655 problems
656 --print-traffic Display sent and read HTTP traffic
657
658 ## Workarounds:
659 --encoding ENCODING Force the specified encoding (experimental)
660 --no-check-certificate Suppress HTTPS certificate validation
661 --prefer-insecure Use an unencrypted connection to retrieve
662 information about the video (Currently
663 supported only for YouTube)
664 --user-agent UA Specify a custom user agent
665 --referer URL Specify a custom referer, use if the video
666 access is restricted to one domain
667 --add-header FIELD:VALUE Specify a custom HTTP header and its value,
668 separated by a colon ":". You can use this
669 option multiple times
670 --bidi-workaround Work around terminals that lack
671 bidirectional text support. Requires bidiv
672 or fribidi executable in PATH
673 --sleep-requests SECONDS Number of seconds to sleep between requests
674 during data extraction
675 --sleep-interval SECONDS Number of seconds to sleep before each
676 download. This is the minimum time to sleep
677 when used along with --max-sleep-interval
678 (Alias: --min-sleep-interval)
679 --max-sleep-interval SECONDS Maximum number of seconds to sleep. Can
680 only be used along with --min-sleep-interval
681 --sleep-subtitles SECONDS Number of seconds to sleep before each
682 subtitle download
683
684 ## Video Format Options:
685 -f, --format FORMAT Video format code, see "FORMAT SELECTION"
686 for more details
687 -S, --format-sort SORTORDER Sort the formats by the fields given, see
688 "Sorting Formats" for more details
689 --S-force, --format-sort-force Force user specified sort order to have
690 precedence over all fields, see "Sorting
691 Formats" for more details
692 --no-format-sort-force Some fields have precedence over the user
693 specified sort order (default), see
694 "Sorting Formats" for more details
695 --video-multistreams Allow multiple video streams to be merged
696 into a single file
697 --no-video-multistreams Only one video stream is downloaded for
698 each output file (default)
699 --audio-multistreams Allow multiple audio streams to be merged
700 into a single file
701 --no-audio-multistreams Only one audio stream is downloaded for
702 each output file (default)
703 --prefer-free-formats Prefer video formats with free containers
704 over non-free ones of same quality. Use
705 with "-S ext" to strictly prefer free
706 containers irrespective of quality
707 --no-prefer-free-formats Don't give any special preference to free
708 containers (default)
709 --check-formats Check that the formats selected are
710 actually downloadable
711 --no-check-formats Do not check that the formats selected are
712 actually downloadable
713 -F, --list-formats List available formats of each video.
714 Simulate unless --no-simulate is used
715 --merge-output-format FORMAT If a merge is required (e.g.
716 bestvideo+bestaudio), output to given
717 container format. One of mkv, mp4, ogg,
718 webm, flv. Ignored if no merge is required
719
720 ## Subtitle Options:
721 --write-subs Write subtitle file
722 --no-write-subs Do not write subtitle file (default)
723 --write-auto-subs Write automatically generated subtitle file
724 (Alias: --write-automatic-subs)
725 --no-write-auto-subs Do not write auto-generated subtitles
726 (default) (Alias: --no-write-automatic-subs)
727 --list-subs List available subtitles of each video.
728 Simulate unless --no-simulate is used
729 --sub-format FORMAT Subtitle format, accepts formats
730 preference, for example: "srt" or
731 "ass/srt/best"
732 --sub-langs LANGS Languages of the subtitles to download (can
733 be regex) or "all" separated by commas.
734 (Eg: --sub-langs en.*,ja) You can prefix
735 the language code with a "-" to exempt it
736 from the requested languages. (Eg: --sub-
737 langs all,-live_chat) Use --list-subs for a
738 list of available language tags
739
740 ## Authentication Options:
741 -u, --username USERNAME Login with this account ID
742 -p, --password PASSWORD Account password. If this option is left
743 out, yt-dlp will ask interactively
744 -2, --twofactor TWOFACTOR Two-factor authentication code
745 -n, --netrc Use .netrc authentication data
746 --netrc-location PATH Location of .netrc authentication data;
747 either the path or its containing
748 directory. Defaults to ~/.netrc
749 --video-password PASSWORD Video password (vimeo, youku)
750 --ap-mso MSO Adobe Pass multiple-system operator (TV
751 provider) identifier, use --ap-list-mso for
752 a list of available MSOs
753 --ap-username USERNAME Multiple-system operator account login
754 --ap-password PASSWORD Multiple-system operator account password.
755 If this option is left out, yt-dlp will ask
756 interactively
757 --ap-list-mso List all supported multiple-system
758 operators
759
760 ## Post-Processing Options:
761 -x, --extract-audio Convert video files to audio-only files
762 (requires ffmpeg and ffprobe)
763 --audio-format FORMAT Specify audio format to convert the audio
764 to when -x is used. Currently supported
765 formats are: best (default) or one of
766 best|aac|flac|mp3|m4a|opus|vorbis|wav
767 --audio-quality QUALITY Specify ffmpeg audio quality, insert a
768 value between 0 (better) and 9 (worse) for
769 VBR or a specific bitrate like 128K
770 (default 5)
771 --remux-video FORMAT Remux the video into another container if
772 necessary (currently supported: mp4|mkv|flv
773 |webm|mov|avi|mp3|mka|m4a|ogg|opus). If
774 target container does not support the
775 video/audio codec, remuxing will fail. You
776 can specify multiple rules; Eg.
777 "aac>m4a/mov>mp4/mkv" will remux aac to
778 m4a, mov to mp4 and anything else to mkv.
779 --recode-video FORMAT Re-encode the video into another format if
780 re-encoding is necessary. The syntax and
781 supported formats are the same as --remux-video
782 --postprocessor-args NAME:ARGS Give these arguments to the postprocessors.
783 Specify the postprocessor/executable name
784 and the arguments separated by a colon ":"
785 to give the argument to the specified
786 postprocessor/executable. Supported PP are:
787 Merger, ModifyChapters, SplitChapters,
788 ExtractAudio, VideoRemuxer, VideoConvertor,
789 Metadata, EmbedSubtitle, EmbedThumbnail,
790 SubtitlesConvertor, ThumbnailsConvertor,
791 FixupStretched, FixupM4a, FixupM3u8,
792 FixupTimestamp and FixupDuration. The
793 supported executables are: AtomicParsley,
794 FFmpeg and FFprobe. You can also specify
795 "PP+EXE:ARGS" to give the arguments to the
796 specified executable only when being used
797 by the specified postprocessor.
798 Additionally, for ffmpeg/ffprobe, "_i"/"_o"
799 can be appended to the prefix optionally
800 followed by a number to pass the argument
801 before the specified input/output file. Eg:
802 --ppa "Merger+ffmpeg_i1:-v quiet". You can
803 use this option multiple times to give
804 different arguments to different
805 postprocessors. (Alias: --ppa)
806 -k, --keep-video Keep the intermediate video file on disk
807 after post-processing
808 --no-keep-video Delete the intermediate video file after
809 post-processing (default)
810 --post-overwrites Overwrite post-processed files (default)
811 --no-post-overwrites Do not overwrite post-processed files
812 --embed-subs Embed subtitles in the video (only for mp4,
813 webm and mkv videos)
814 --no-embed-subs Do not embed subtitles (default)
815 --embed-thumbnail Embed thumbnail in the video as cover art
816 --no-embed-thumbnail Do not embed thumbnail (default)
817 --embed-metadata Embed metadata to the video file. Also adds
818 chapters to file unless --no-add-chapters
819 is used (Alias: --add-metadata)
820 --no-embed-metadata Do not add metadata to file (default)
821 (Alias: --no-add-metadata)
822 --embed-chapters Add chapter markers to the video file
823 (Alias: --add-chapters)
824 --no-embed-chapters Do not add chapter markers (default)
825 (Alias: --no-add-chapters)
826 --parse-metadata FROM:TO Parse additional metadata like title/artist
827 from other fields; see "MODIFYING METADATA"
828 for details
829 --replace-in-metadata FIELDS REGEX REPLACE
830 Replace text in a metadata field using the
831 given regex. This option can be used
832 multiple times
833 --xattrs Write metadata to the video file's xattrs
834 (using dublin core and xdg standards)
835 --fixup POLICY Automatically correct known faults of the
836 file. One of never (do nothing), warn (only
837 emit a warning), detect_or_warn (the
838 default; fix file if we can, warn
839 otherwise), force (try fixing even if file
840 already exists
841 --ffmpeg-location PATH Location of the ffmpeg binary; either the
842 path to the binary or its containing
843 directory
844 --exec CMD Execute a command on the file after
845 downloading and post-processing. Same
846 syntax as the output template can be used
847 to pass any field as arguments to the
848 command. An additional field "filepath"
849 that contains the final path of the
850 downloaded file is also available. If no
851 fields are passed, %(filepath)q is appended
852 to the end of the command. This option can
853 be used multiple times
854 --no-exec Remove any previously defined --exec
855 --exec-before-download CMD Execute a command before the actual
856 download. The syntax is the same as --exec
857 but "filepath" is not available. This
858 option can be used multiple times
859 --no-exec-before-download Remove any previously defined
860 --exec-before-download
861 --convert-subs FORMAT Convert the subtitles to another format
862 (currently supported: srt|vtt|ass|lrc)
863 (Alias: --convert-subtitles)
864 --convert-thumbnails FORMAT Convert the thumbnails to another format
865 (currently supported: jpg|png)
866 --split-chapters Split video into multiple files based on
867 internal chapters. The "chapter:" prefix
868 can be used with "--paths" and "--output"
869 to set the output filename for the split
870 files. See "OUTPUT TEMPLATE" for details
871 --no-split-chapters Do not split video based on chapters
872 (default)
873 --remove-chapters REGEX Remove chapters whose title matches the
874 given regular expression. Time ranges
875 prefixed by a "*" can also be used in place
876 of chapters to remove the specified range.
877 Eg: --remove-chapters "*10:15-15:00"
878 --remove-chapters "intro". This option can
879 be used multiple times
880 --no-remove-chapters Do not remove any chapters from the file
881 (default)
882 --force-keyframes-at-cuts Force keyframes around the chapters before
883 removing/splitting them. Requires a
884 reencode and thus is very slow, but the
885 resulting video may have fewer artifacts
886 around the cuts
887 --no-force-keyframes-at-cuts Do not force keyframes around the chapters
888 when cutting/splitting (default)
889 --use-postprocessor NAME[:ARGS] The (case sensitive) name of plugin
890 postprocessors to be enabled, and
891 (optionally) arguments to be passed to it,
892 seperated by a colon ":". ARGS are a
893 semicolon ";" delimited list of NAME=VALUE.
894 The "when" argument determines when the
895 postprocessor is invoked. It can be one of
896 "pre_process" (after extraction),
897 "before_dl" (before video download),
898 "post_process" (after video download;
899 default) or "after_move" (after moving file
900 to their final locations). This option can
901 be used multiple times to add different
902 postprocessors
903
904 ## SponsorBlock Options:
905 Make chapter entries for, or remove various segments (sponsor,
906 introductions, etc.) from downloaded YouTube videos using the
907 [SponsorBlock API](https://sponsor.ajay.app)
908
909 --sponsorblock-mark CATS SponsorBlock categories to create chapters
910 for, separated by commas. Available
911 categories are all, sponsor, intro, outro,
912 selfpromo, interaction, preview,
913 music_offtopic. You can prefix the category
914 with a "-" to exempt it. See
915 https://wiki.sponsor.ajay.app/index.php/Segment_Categories
916 for description of the categories. Eg:
917 --sponsorblock-query all,-preview
918 --sponsorblock-remove CATS SponsorBlock categories to be removed from
919 the video file, separated by commas. If a
920 category is present in both mark and
921 remove, remove takes precedence. The syntax
922 and available categories are the same as
923 for --sponsorblock-mark
924 --sponsorblock-chapter-title TEMPLATE
925 The title template for SponsorBlock
926 chapters created by --sponsorblock-mark.
927 The same syntax as the output template is
928 used, but the only available fields are
929 start_time, end_time, category, categories,
930 name, category_names. Defaults to
931 "[SponsorBlock]: %(category_names)l"
932 --no-sponsorblock Disable both --sponsorblock-mark and
933 --sponsorblock-remove
934 --sponsorblock-api URL SponsorBlock API location, defaults to
935 https://sponsor.ajay.app
936
937 ## Extractor Options:
938 --extractor-retries RETRIES Number of retries for known extractor
939 errors (default is 3), or "infinite"
940 --allow-dynamic-mpd Process dynamic DASH manifests (default)
941 (Alias: --no-ignore-dynamic-mpd)
942 --ignore-dynamic-mpd Do not process dynamic DASH manifests
943 (Alias: --no-allow-dynamic-mpd)
944 --hls-split-discontinuity Split HLS playlists to different formats at
945 discontinuities such as ad breaks
946 --no-hls-split-discontinuity Do not split HLS playlists to different
947 formats at discontinuities such as ad
948 breaks (default)
949 --extractor-args KEY:ARGS Pass these arguments to the extractor. See
950 "EXTRACTOR ARGUMENTS" for details. You can
951 use this option multiple times to give
952 arguments for different extractors
953
954 # CONFIGURATION
955
956 You can configure yt-dlp by placing any supported command line option to a configuration file. The configuration is loaded from the following locations:
957
958 1. **Main Configuration**: The file given by `--config-location`
959 1. **Portable Configuration**: `yt-dlp.conf` in the same directory as the bundled binary. If you are running from source-code (`<root dir>/yt_dlp/__main__.py`), the root directory is used instead.
960 1. **Home Configuration**: `yt-dlp.conf` in the home path given by `-P "home:<path>"`, or in the current directory if no such path is given
961 1. **User Configuration**:
962 * `%XDG_CONFIG_HOME%/yt-dlp/config` (recommended on Linux/macOS)
963 * `%XDG_CONFIG_HOME%/yt-dlp.conf`
964 * `%APPDATA%/yt-dlp/config` (recommended on Windows)
965 * `%APPDATA%/yt-dlp/config.txt`
966 * `~/yt-dlp.conf`
967 * `~/yt-dlp.conf.txt`
968
969 `%XDG_CONFIG_HOME%` defaults to `~/.config` if undefined. On windows, `~` points to %HOME% if present, `%USERPROFILE%` (generally `C:\Users\<user name>`) or `%HOMEDRIVE%%HOMEPATH%`.
970 1. **System Configuration**: `/etc/yt-dlp.conf`
971
972 For example, with the following configuration file yt-dlp will always extract the audio, not copy the mtime, use a proxy and save all videos under `YouTube` directory in your home directory:
973 ```
974 # Lines starting with # are comments
975
976 # Always extract audio
977 -x
978
979 # Do not copy the mtime
980 --no-mtime
981
982 # Use this proxy
983 --proxy 127.0.0.1:3128
984
985 # Save all videos under YouTube directory in your home directory
986 -o ~/YouTube/%(title)s.%(ext)s
987 ```
988
989 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`.
990
991 You can use `--ignore-config` if you want to disable all configuration files for a particular yt-dlp 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.
992
993 ### Authentication with `.netrc` file
994
995 You may also want to configure automatic credentials storage for extractors that support authentication (by providing login and password with `--username` and `--password`) in order not to pass credentials as command line arguments on every yt-dlp execution and prevent tracking plain text passwords in the shell command history. You can achieve this using a [`.netrc` file](https://stackoverflow.com/tags/.netrc/info) on a per extractor basis. For that you will need to create a `.netrc` file in `--netrc-location` and restrict permissions to read/write by only you:
996 ```
997 touch $HOME/.netrc
998 chmod a-rwx,u+rw $HOME/.netrc
999 ```
1000 After that you can add credentials for an extractor in the following format, where *extractor* is the name of the extractor in lowercase:
1001 ```
1002 machine <extractor> login <username> password <password>
1003 ```
1004 For example:
1005 ```
1006 machine youtube login myaccount@gmail.com password my_youtube_password
1007 machine twitch login my_twitch_account_name password my_twitch_password
1008 ```
1009 To activate authentication with the `.netrc` file you should pass `--netrc` to yt-dlp or place it in the [configuration file](#configuration).
1010
1011 The default location of the .netrc file is `$HOME` (`~`) in UNIX. On Windows, it is `%HOME%` if present, `%USERPROFILE%` (generally `C:\Users\<user name>`) or `%HOMEDRIVE%%HOMEPATH%`
1012
1013 # OUTPUT TEMPLATE
1014
1015 The `-o` option is used to indicate a template for the output file names while `-P` option is used to specify the path each type of file should be saved to.
1016
1017 **tl;dr:** [navigate me to examples](#output-template-examples).
1018
1019 The simplest 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 and could break some post-processing).
1020
1021 It may however also 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/3/library/stdtypes.html#printf-style-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.
1022
1023 The field names themselves (the part inside the parenthesis) can also have some special formatting:
1024 1. **Object traversal**: The dictionaries and lists available in metadata can be traversed by using a `.` (dot) separator. You can also do python slicing using `:`. Eg: `%(tags.0)s`, `%(subtitles.en.-1.ext)s`, `%(id.3:7:-1)s`, `%(formats.:.format_id)s`. `%()s` refers to the entire infodict. Note that all the fields that become available using this method are not listed below. Use `-j` to see such fields
1025 1. **Addition**: Addition and subtraction of numeric fields can be done using `+` and `-` respectively. Eg: `%(playlist_index+10)03d`, `%(n_entries+1-playlist_index)d`
1026 1. **Date/time Formatting**: Date/time fields can be formatted according to [strftime formatting](https://docs.python.org/3/library/datetime.html#strftime-and-strptime-format-codes) by specifying it separated from the field name using a `>`. Eg: `%(duration>%H-%M-%S)s`, `%(upload_date>%Y-%m-%d)s`, `%(epoch-3600>%H-%M-%S)s`
1027 1. **Alternatives**: Alternate fields can be specified seperated with a `,`. Eg: `%(release_date>%Y,upload_date>%Y|Unknown)s`
1028 1. **Default**: A literal default value can be specified for when the field is empty using a `|` seperator. This overrides `--output-na-template`. Eg: `%(uploader|Unknown)s`
1029 1. **More Conversions**: In addition to the normal format types `diouxXeEfFgGcrs`, `B`, `j`, `l`, `q` can be used for converting to **B**ytes, **j**son, a comma seperated **l**ist (alternate form flag `#` makes it new line `\n` seperated) and a string **q**uoted for the terminal, respectively
1030 1. **Unicode normalization**: The format type `U` can be used for NFC [unicode normalization](https://docs.python.org/3/library/unicodedata.html#unicodedata.normalize). The alternate form flag (`#`) changes the normalization to NFD and the conversion flag `+` can be used for NFKC/NFKD compatibility equivalence normalization. Eg: `%(title)+.100U` is NFKC
1031
1032 To summarize, the general syntax for a field is:
1033 ```
1034 %(name[.keys][addition][>strf][,alternate][|default])[flags][width][.precision][length]type
1035 ```
1036
1037 Additionally, you can set different output templates for the various metadata files separately from the general output template by specifying the type of file followed by the template separated by a colon `:`. The different file types supported are `subtitle`, `thumbnail`, `description`, `annotation` (deprecated), `infojson`, `pl_thumbnail`, `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. If any of the templates (except default) is empty, that type of file will not be written. Eg: `--write-thumbnail -o "thumbnail:"` will write thumbnails only for playlists and not for video.
1038
1039 The available fields are:
1040
1041 - `id` (string): Video identifier
1042 - `title` (string): Video title
1043 - `url` (string): Video URL
1044 - `ext` (string): Video filename extension
1045 - `alt_title` (string): A secondary title of the video
1046 - `description` (string): The description of the video
1047 - `display_id` (string): An alternative identifier for the video
1048 - `uploader` (string): Full name of the video uploader
1049 - `license` (string): License name the video is licensed under
1050 - `creator` (string): The creator of the video
1051 - `timestamp` (numeric): UNIX timestamp of the moment the video became available
1052 - `upload_date` (string): Video upload date (YYYYMMDD)
1053 - `release_date` (string): The date (YYYYMMDD) when the video was released
1054 - `release_timestamp` (numeric): UNIX timestamp of the moment the video was released
1055 - `uploader_id` (string): Nickname or id of the video uploader
1056 - `channel` (string): Full name of the channel the video is uploaded on
1057 - `channel_id` (string): Id of the channel
1058 - `location` (string): Physical location where the video was filmed
1059 - `duration` (numeric): Length of the video in seconds
1060 - `duration_string` (string): Length of the video (HH:mm:ss)
1061 - `view_count` (numeric): How many users have watched the video on the platform
1062 - `like_count` (numeric): Number of positive ratings of the video
1063 - `dislike_count` (numeric): Number of negative ratings of the video
1064 - `repost_count` (numeric): Number of reposts of the video
1065 - `average_rating` (numeric): Average rating give by users, the scale used depends on the webpage
1066 - `comment_count` (numeric): Number of comments on the video (For some extractors, comments are only downloaded at the end, and so this field cannot be used)
1067 - `age_limit` (numeric): Age restriction for the video (years)
1068 - `live_status` (string): One of 'is_live', 'was_live', 'is_upcoming', 'not_live'
1069 - `is_live` (boolean): Whether this video is a live stream or a fixed-length video
1070 - `was_live` (boolean): Whether this video was originally a live stream
1071 - `playable_in_embed` (string): Whether this video is allowed to play in embedded players on other sites
1072 - `availability` (string): Whether the video is 'private', 'premium_only', 'subscriber_only', 'needs_auth', 'unlisted' or 'public'
1073 - `start_time` (numeric): Time in seconds where the reproduction should start, as specified in the URL
1074 - `end_time` (numeric): Time in seconds where the reproduction should end, as specified in the URL
1075 - `format` (string): A human-readable description of the format
1076 - `format_id` (string): Format code specified by `--format`
1077 - `format_note` (string): Additional info about the format
1078 - `width` (numeric): Width of the video
1079 - `height` (numeric): Height of the video
1080 - `resolution` (string): Textual description of width and height
1081 - `tbr` (numeric): Average bitrate of audio and video in KBit/s
1082 - `abr` (numeric): Average audio bitrate in KBit/s
1083 - `acodec` (string): Name of the audio codec in use
1084 - `asr` (numeric): Audio sampling rate in Hertz
1085 - `vbr` (numeric): Average video bitrate in KBit/s
1086 - `fps` (numeric): Frame rate
1087 - `dynamic_range` (string): The dynamic range of the video
1088 - `vcodec` (string): Name of the video codec in use
1089 - `container` (string): Name of the container format
1090 - `filesize` (numeric): The number of bytes, if known in advance
1091 - `filesize_approx` (numeric): An estimate for the number of bytes
1092 - `protocol` (string): The protocol that will be used for the actual download
1093 - `extractor` (string): Name of the extractor
1094 - `extractor_key` (string): Key name of the extractor
1095 - `epoch` (numeric): Unix epoch when creating the file
1096 - `autonumber` (numeric): Number that will be increased with each download, starting at `--autonumber-start`
1097 - `n_entries` (numeric): Total number of extracted items in the playlist
1098 - `playlist` (string): Name or id of the playlist that contains the video
1099 - `playlist_index` (numeric): Index of the video in the playlist padded with leading zeros according the final index
1100 - `playlist_autonumber` (numeric): Position of the video in the playlist download queue padded with leading zeros according to the total length of the playlist
1101 - `playlist_id` (string): Playlist identifier
1102 - `playlist_title` (string): Playlist title
1103 - `playlist_uploader` (string): Full name of the playlist uploader
1104 - `playlist_uploader_id` (string): Nickname or id of the playlist uploader
1105 - `webpage_url` (string): A URL to the video webpage which if given to yt-dlp should allow to get the same result again
1106 - `original_url` (string): The URL given by the user (or same as `webpage_url` for playlist entries)
1107
1108 Available for the video that belongs to some logical chapter or section:
1109
1110 - `chapter` (string): Name or title of the chapter the video belongs to
1111 - `chapter_number` (numeric): Number of the chapter the video belongs to
1112 - `chapter_id` (string): Id of the chapter the video belongs to
1113
1114 Available for the video that is an episode of some series or programme:
1115
1116 - `series` (string): Title of the series or programme the video episode belongs to
1117 - `season` (string): Title of the season the video episode belongs to
1118 - `season_number` (numeric): Number of the season the video episode belongs to
1119 - `season_id` (string): Id of the season the video episode belongs to
1120 - `episode` (string): Title of the video episode
1121 - `episode_number` (numeric): Number of the video episode within a season
1122 - `episode_id` (string): Id of the video episode
1123
1124 Available for the media that is a track or a part of a music album:
1125
1126 - `track` (string): Title of the track
1127 - `track_number` (numeric): Number of the track within an album or a disc
1128 - `track_id` (string): Id of the track
1129 - `artist` (string): Artist(s) of the track
1130 - `genre` (string): Genre(s) of the track
1131 - `album` (string): Title of the album the track belongs to
1132 - `album_type` (string): Type of the album
1133 - `album_artist` (string): List of all artists appeared on the album
1134 - `disc_number` (numeric): Number of the disc or other physical medium the track belongs to
1135 - `release_year` (numeric): Year (YYYY) when the album was released
1136
1137 Available for `chapter:` prefix when using `--split-chapters` for videos with internal chapters:
1138
1139 - `section_title` (string): Title of the chapter
1140 - `section_number` (numeric): Number of the chapter within the file
1141 - `section_start` (numeric): Start time of the chapter in seconds
1142 - `section_end` (numeric): End time of the chapter in seconds
1143
1144 Available only when used in `--print`:
1145
1146 - `urls` (string): The URLs of all requested formats, one in each line
1147 - `filename` (string): Name of the video file. Note that the actual filename may be different due to post-processing. Use `--exec echo` to get the name after all postprocessing is complete
1148
1149 Available only in `--sponsorblock-chapter-title`:
1150
1151 - `start_time` (numeric): Start time of the chapter in seconds
1152 - `end_time` (numeric): End time of the chapter in seconds
1153 - `categories` (list): The SponsorBlock categories the chapter belongs to
1154 - `category` (string): The smallest SponsorBlock category the chapter belongs to
1155 - `category_names` (list): Friendly names of the categories
1156 - `name` (string): Friendly name of the smallest category
1157
1158 Each aforementioned sequence when referenced in an output template will be replaced by the actual value corresponding to the sequence name. For example for `-o %(title)s-%(id)s.%(ext)s` and an mp4 video with title `yt-dlp test video` and id `BaW_jenozKc`, this will result in a `yt-dlp test video-BaW_jenozKc.mp4` file created in the current directory.
1159
1160 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).
1161
1162 **Tip**: Look at the `-j` output to identify which fields are available for the purticular URL
1163
1164 For numeric sequences you can use [numeric related formatting](https://docs.python.org/3/library/stdtypes.html#printf-style-string-formatting), for example, `%(view_count)05d` will result in a string with view count padded with zeros up to 5 characters, like in `00042`.
1165
1166 Output templates can also contain arbitrary hierarchical path, e.g. `-o '%(playlist)s/%(playlist_index)s - %(title)s.%(ext)s'` which will result in downloading each video in a directory corresponding to this path template. Any missing directory will be automatically created for you.
1167
1168 To use percent literals in an output template use `%%`. To output to stdout use `-o -`.
1169
1170 The current default template is `%(title)s [%(id)s].%(ext)s`.
1171
1172 In some cases, you don't want special characters such as 中, spaces, or &, such as when transferring the downloaded filename to a Windows system or the filename through an 8bit-unsafe channel. In these cases, add the `--restrict-filenames` flag to get a shorter title:
1173
1174 #### Output template and Windows batch files
1175
1176 If you are using an output template inside a Windows batch file then you must escape plain percent characters (`%`) by doubling, so that `-o "%(title)s-%(id)s.%(ext)s"` should become `-o "%%(title)s-%%(id)s.%%(ext)s"`. However you should not touch `%`'s that are not plain characters, e.g. environment variables for expansion should stay intact: `-o "C:\%HOMEPATH%\Desktop\%%(title)s.%%(ext)s"`.
1177
1178 #### Output template examples
1179
1180 Note that on Windows you need to use double quotes instead of single.
1181
1182 ```bash
1183 $ yt-dlp --get-filename -o '%(title)s.%(ext)s' BaW_jenozKc
1184 youtube-dl test video ''_ä↭𝕐.mp4 # All kinds of weird characters
1185
1186 $ yt-dlp --get-filename -o '%(title)s.%(ext)s' BaW_jenozKc --restrict-filenames
1187 youtube-dl_test_video_.mp4 # A simple file name
1188
1189 # Download YouTube playlist videos in separate directory indexed by video order in a playlist
1190 $ yt-dlp -o '%(playlist)s/%(playlist_index)s - %(title)s.%(ext)s' https://www.youtube.com/playlist?list=PLwiyx1dc3P2JR9N8gQaQN_BCvlSlap7re
1191
1192 # Download YouTube playlist videos in separate directories according to their uploaded year
1193 $ yt-dlp -o '%(upload_date>%Y)s/%(title)s.%(ext)s' https://www.youtube.com/playlist?list=PLwiyx1dc3P2JR9N8gQaQN_BCvlSlap7re
1194
1195 # Download all playlists of YouTube channel/user keeping each playlist in separate directory:
1196 $ yt-dlp -o '%(uploader)s/%(playlist)s/%(playlist_index)s - %(title)s.%(ext)s' https://www.youtube.com/user/TheLinuxFoundation/playlists
1197
1198 # Download Udemy course keeping each chapter in separate directory under MyVideos directory in your home
1199 $ yt-dlp -u user -p password -P '~/MyVideos' -o '%(playlist)s/%(chapter_number)s - %(chapter)s/%(title)s.%(ext)s' https://www.udemy.com/java-tutorial/
1200
1201 # Download entire series season keeping each series and each season in separate directory under C:/MyVideos
1202 $ yt-dlp -P "C:/MyVideos" -o "%(series)s/%(season_number)s - %(season)s/%(episode_number)s - %(episode)s.%(ext)s" https://videomore.ru/kino_v_detalayah/5_sezon/367617
1203
1204 # Stream the video being downloaded to stdout
1205 $ yt-dlp -o - BaW_jenozKc
1206 ```
1207
1208 # FORMAT SELECTION
1209
1210 By default, yt-dlp tries to download the best available quality if you **don't** pass any options.
1211 This is generally equivalent to using `-f bestvideo*+bestaudio/best`. However, if multiple audiostreams is enabled (`--audio-multistreams`), the default format changes to `-f bestvideo+bestaudio/best`. Similarly, if ffmpeg is unavailable, or if you use yt-dlp to stream to `stdout` (`-o -`), the default becomes `-f best/bestvideo+bestaudio`.
1212
1213 **Deprecation warning**: Latest versions of yt-dlp can stream multiple formats to the stdout simultaneously using ffmpeg. So, in future versions, the default for this will be set to `-f bv*+ba/b` similar to normal downloads. If you want to preserve the `-f b/bv+ba` setting, it is recommended to explicitly specify it in the configuration options.
1214
1215 The general syntax for format selection is `-f FORMAT` (or `--format FORMAT`) where `FORMAT` is a *selector expression*, i.e. an expression that describes format or formats you would like to download.
1216
1217 **tl;dr:** [navigate me to examples](#format-selection-examples).
1218
1219 The simplest case is requesting a specific format, for example with `-f 22` you can download the format with format code equal to 22. You can get the list of available format codes for particular video using `--list-formats` or `-F`. Note that these format codes are extractor specific.
1220
1221 You can also use a file extension (currently `3gp`, `aac`, `flv`, `m4a`, `mp3`, `mp4`, `ogg`, `wav`, `webm` are supported) to download the best quality format of a particular file extension served as a single file, e.g. `-f webm` will download the best quality format with the `webm` extension served as a single file.
1222
1223 You can also use special names to select particular edge case formats:
1224
1225 - `all`: Select all formats
1226 - `mergeall`: Select and merge all formats (Must be used with `--audio-multistreams`, `--video-multistreams` or both)
1227 - `b*`, `best*`: Select the best quality format irrespective of whether it contains video or audio
1228 - `w*`, `worst*`: Select the worst quality format irrespective of whether it contains video or audio
1229 - `b`, `best`: Select the best quality format that contains both video and audio. Equivalent to `best*[vcodec!=none][acodec!=none]`
1230 - `w`, `worst`: Select the worst quality format that contains both video and audio. Equivalent to `worst*[vcodec!=none][acodec!=none]`
1231 - `bv`, `bestvideo`: Select the best quality video-only format. Equivalent to `best*[acodec=none]`
1232 - `wv`, `worstvideo`: Select the worst quality video-only format. Equivalent to `worst*[acodec=none]`
1233 - `bv*`, `bestvideo*`: Select the best quality format that contains video. It may also contain audio. Equivalent to `best*[vcodec!=none]`
1234 - `wv*`, `worstvideo*`: Select the worst quality format that contains video. It may also contain audio. Equivalent to `worst*[vcodec!=none]`
1235 - `ba`, `bestaudio`: Select the best quality audio-only format. Equivalent to `best*[vcodec=none]`
1236 - `wa`, `worstaudio`: Select the worst quality audio-only format. Equivalent to `worst*[vcodec=none]`
1237 - `ba*`, `bestaudio*`: Select the best quality format that contains audio. It may also contain video. Equivalent to `best*[acodec!=none]`
1238 - `wa*`, `worstaudio*`: Select the worst quality format that contains audio. It may also contain video. Equivalent to `worst*[acodec!=none]`
1239
1240 For example, to download the worst quality video-only format you can use `-f worstvideo`. It is however recommended not to use `worst` and related options. When your format selector is `worst`, the format which is worst in all respects is selected. Most of the time, what you actually want is the video with the smallest filesize instead. So it is generally better to use `-f best -S +size,+br,+res,+fps` instead of `-f worst`. See [sorting formats](#sorting-formats) for more details.
1241
1242 You can select the n'th best format of a type by using `best<type>.<n>`. For example, `best.2` will select the 2nd best combined format. Similarly, `bv*.3` will select the 3rd best format that contains a video stream.
1243
1244 If you want to download multiple videos and they don't have the same formats available, you can specify the order of preference using slashes. Note that formats on the left hand side are preferred, for example `-f 22/17/18` will download format 22 if it's available, otherwise it will download format 17 if it's available, otherwise it will download format 18 if it's available, otherwise it will complain that no suitable formats are available for download.
1245
1246 If you want to download several formats of the same video use a comma as a separator, e.g. `-f 22,17,18` will download all these three formats, of course if they are available. Or a more sophisticated example combined with the precedence feature: `-f 136/137/mp4/bestvideo,140/m4a/bestaudio`.
1247
1248 You can merge the video and audio of multiple formats into a single file using `-f <format1>+<format2>+...` (requires ffmpeg installed), for example `-f bestvideo+bestaudio` will download the best video-only format, the best audio-only format and mux them together with ffmpeg.
1249
1250 **Deprecation warning**: Since the *below* described behavior is complex and counter-intuitive, this will be removed and multistreams will be enabled by default in the future. A new operator will be instead added to limit formats to single audio/video
1251
1252 Unless `--video-multistreams` is used, all formats with a video stream except the first one are ignored. Similarly, unless `--audio-multistreams` is used, all formats with an audio stream except the first one are ignored. For example, `-f bestvideo+best+bestaudio --video-multistreams --audio-multistreams` will download and merge all 3 given formats. The resulting file will have 2 video streams and 2 audio streams. But `-f bestvideo+best+bestaudio --no-video-multistreams` will download and merge only `bestvideo` and `bestaudio`. `best` is ignored since another format containing a video stream (`bestvideo`) has already been selected. The order of the formats is therefore important. `-f best+bestaudio --no-audio-multistreams` will download and merge both formats while `-f bestaudio+best --no-audio-multistreams` will ignore `best` and download only `bestaudio`.
1253
1254 ## Filtering Formats
1255
1256 You can also filter the video formats by putting a condition in brackets, as in `-f "best[height=720]"` (or `-f "[filesize>10M]"`).
1257
1258 The following numeric meta fields can be used with comparisons `<`, `<=`, `>`, `>=`, `=` (equals), `!=` (not equals):
1259
1260 - `filesize`: The number of bytes, if known in advance
1261 - `width`: Width of the video, if known
1262 - `height`: Height of the video, if known
1263 - `tbr`: Average bitrate of audio and video in KBit/s
1264 - `abr`: Average audio bitrate in KBit/s
1265 - `vbr`: Average video bitrate in KBit/s
1266 - `asr`: Audio sampling rate in Hertz
1267 - `fps`: Frame rate
1268
1269 Also filtering work for comparisons `=` (equals), `^=` (starts with), `$=` (ends with), `*=` (contains) and following string meta fields:
1270
1271 - `ext`: File extension
1272 - `acodec`: Name of the audio codec in use
1273 - `vcodec`: Name of the video codec in use
1274 - `container`: Name of the container format
1275 - `protocol`: The protocol that will be used for the actual download, lower-case (`http`, `https`, `rtsp`, `rtmp`, `rtmpe`, `mms`, `f4m`, `ism`, `http_dash_segments`, `m3u8`, or `m3u8_native`)
1276 - `format_id`: A short description of the format
1277 - `language`: Language code
1278
1279 Any string comparison may be prefixed with negation `!` in order to produce an opposite comparison, e.g. `!*=` (does not contain).
1280
1281 Note that none of the aforementioned meta fields are guaranteed to be present since this solely depends on the metadata obtained by particular extractor, i.e. the metadata offered by the website. Any other field made available by the extractor can also be used for filtering.
1282
1283 Formats for which the value is not known are excluded unless you put a question mark (`?`) after the operator. You can combine format filters, so `-f "[height<=?720][tbr>500]"` selects up to 720p videos (or videos where the height is not known) with a bitrate of at least 500 KBit/s. You can also use the filters with `all` to download all formats that satisfy the filter. For example, `-f "all[vcodec=none]"` selects all audio-only formats.
1284
1285 Format selectors can also be grouped using parentheses, for example if you want to download the best mp4 and webm formats with a height lower than 480 you can use `-f '(mp4,webm)[height<480]'`.
1286
1287 ## Sorting Formats
1288
1289 You can change the criteria for being considered the `best` by using `-S` (`--format-sort`). The general format for this is `--format-sort field1,field2...`.
1290
1291 The available fields are:
1292
1293 - `hasvid`: Gives priority to formats that has a video stream
1294 - `hasaud`: Gives priority to formats that has a audio stream
1295 - `ie_pref`: The format preference as given by the extractor
1296 - `lang`: Language preference as given by the extractor
1297 - `quality`: The quality of the format as given by the extractor
1298 - `source`: Preference of the source as given by the extractor
1299 - `proto`: Protocol used for download (`https`/`ftps` > `http`/`ftp` > `m3u8_native`/`m3u8` > `http_dash_segments`> `websocket_frag` > other > `mms`/`rtsp` > unknown > `f4f`/`f4m`)
1300 - `vcodec`: Video Codec (`av01` > `vp9.2` > `vp9` > `h265` > `h264` > `vp8` > `h263` > `theora` > other > unknown)
1301 - `acodec`: Audio Codec (`opus` > `vorbis` > `aac` > `mp4a` > `mp3` > `ac3` > `dts` > other > unknown)
1302 - `codec`: Equivalent to `vcodec,acodec`
1303 - `vext`: Video Extension (`mp4` > `webm` > `flv` > other > unknown). If `--prefer-free-formats` is used, `webm` is prefered.
1304 - `aext`: Audio Extension (`m4a` > `aac` > `mp3` > `ogg` > `opus` > `webm` > other > unknown). If `--prefer-free-formats` is used, the order changes to `opus` > `ogg` > `webm` > `m4a` > `mp3` > `aac`.
1305 - `ext`: Equivalent to `vext,aext`
1306 - `filesize`: Exact filesize, if know in advance. This will be unavailable for mu38 and DASH formats.
1307 - `fs_approx`: Approximate filesize calculated from the manifests
1308 - `size`: Exact filesize if available, otherwise approximate filesize
1309 - `height`: Height of video
1310 - `width`: Width of video
1311 - `res`: Video resolution, calculated as the smallest dimension.
1312 - `fps`: Framerate of video
1313 - `hdr`: The dynamic range of the video (`DV` > `HDR12` > `HDR10+` > `HDR10` > `HLG` > `SDR`)
1314 - `tbr`: Total average bitrate in KBit/s
1315 - `vbr`: Average video bitrate in KBit/s
1316 - `abr`: Average audio bitrate in KBit/s
1317 - `br`: Equivalent to using `tbr,vbr,abr`
1318 - `asr`: Audio sample rate in Hz
1319
1320 **Deprecation warning**: Many of these fields have (currently undocumented) aliases, that may be removed in a future version. It is recommended to use only the documented field names.
1321
1322 All fields, unless specified otherwise, are sorted in descending order. To reverse this, prefix the field with a `+`. Eg: `+res` prefers format with the smallest resolution. Additionally, you can suffix a preferred value for the fields, separated by a `:`. Eg: `res:720` prefers larger videos, but no larger than 720p and the smallest video if there are no videos less than 720p. For `codec` and `ext`, you can provide two preferred values, the first for video and the second for audio. Eg: `+codec:avc:m4a` (equivalent to `+vcodec:avc,+acodec:m4a`) sets the video codec preference to `h264` > `h265` > `vp9` > `vp9.2` > `av01` > `vp8` > `h263` > `theora` and audio codec preference to `mp4a` > `aac` > `vorbis` > `opus` > `mp3` > `ac3` > `dts`. You can also make the sorting prefer the nearest values to the provided by using `~` as the delimiter. Eg: `filesize~1G` prefers the format with filesize closest to 1 GiB.
1323
1324 The fields `hasvid` and `ie_pref` are always given highest priority in sorting, irrespective of the user-defined order. This behaviour can be changed by using `--format-sort-force`. Apart from these, the default order used is: `lang,quality,res,fps,hdr:12,codec:vp9.2,size,br,asr,proto,ext,hasaud,source,id`. The extractors may override this default order, but they cannot override the user-provided order.
1325
1326 Note that the default has `codec:vp9.2`; i.e. `av1` is not prefered. Similarly, the default for hdr is `hdr:12`; i.e. dolby vision is not prefered. These choices are made since DV and AV1 formats are not yet fully compatible with most devices. This may be changed in the future as more devices become capable of smoothly playing back these formats.
1327
1328 If your format selector is `worst`, the last item is selected after sorting. This means it will select the format that is worst in all respects. Most of the time, what you actually want is the video with the smallest filesize instead. So it is generally better to use `-f best -S +size,+br,+res,+fps`.
1329
1330 **Tip**: You can use the `-v -F` to see how the formats have been sorted (worst to best).
1331
1332 ## Format Selection examples
1333
1334 Note that on Windows you may need to use double quotes instead of single.
1335
1336 ```bash
1337 # Download and merge the best video-only format and the best audio-only format,
1338 # or download the best combined format if video-only format is not available
1339 $ yt-dlp -f 'bv+ba/b'
1340
1341 # Download best format that contains video,
1342 # and if it doesn't already have an audio stream, merge it with best audio-only format
1343 $ yt-dlp -f 'bv*+ba/b'
1344
1345 # Same as above
1346 $ yt-dlp
1347
1348 # Download the best video-only format and the best audio-only format without merging them
1349 # For this case, an output template should be used since
1350 # by default, bestvideo and bestaudio will have the same file name.
1351 $ yt-dlp -f 'bv,ba' -o '%(title)s.f%(format_id)s.%(ext)s'
1352
1353 # Download and merge the best format that has a video stream,
1354 # and all audio-only formats into one file
1355 $ yt-dlp -f 'bv*+mergeall[vcodec=none]' --audio-multistreams
1356
1357 # Download and merge the best format that has a video stream,
1358 # and the best 2 audio-only formats into one file
1359 $ yt-dlp -f 'bv*+ba+ba.2' --audio-multistreams
1360
1361
1362 # The following examples show the old method (without -S) of format selection
1363 # and how to use -S to achieve a similar but (generally) better result
1364
1365 # Download the worst video available (old method)
1366 $ yt-dlp -f 'wv*+wa/w'
1367
1368 # Download the best video available but with the smallest resolution
1369 $ yt-dlp -S '+res'
1370
1371 # Download the smallest video available
1372 $ yt-dlp -S '+size,+br'
1373
1374
1375
1376 # Download the best mp4 video available, or the best video if no mp4 available
1377 $ yt-dlp -f 'bv*[ext=mp4]+ba[ext=m4a]/b[ext=mp4] / bv*+ba/b'
1378
1379 # Download the best video with the best extension
1380 # (For video, mp4 > webm > flv. For audio, m4a > aac > mp3 ...)
1381 $ yt-dlp -S 'ext'
1382
1383
1384
1385 # Download the best video available but no better than 480p,
1386 # or the worst video if there is no video under 480p
1387 $ yt-dlp -f 'bv*[height<=480]+ba/b[height<=480] / wv*+ba/w'
1388
1389 # Download the best video available with the largest height but no better than 480p,
1390 # or the best video with the smallest resolution if there is no video under 480p
1391 $ yt-dlp -S 'height:480'
1392
1393 # Download the best video available with the largest resolution but no better than 480p,
1394 # or the best video with the smallest resolution if there is no video under 480p
1395 # Resolution is determined by using the smallest dimension.
1396 # So this works correctly for vertical videos as well
1397 $ yt-dlp -S 'res:480'
1398
1399
1400
1401 # Download the best video (that also has audio) but no bigger than 50 MB,
1402 # or the worst video (that also has audio) if there is no video under 50 MB
1403 $ yt-dlp -f 'b[filesize<50M] / w'
1404
1405 # Download largest video (that also has audio) but no bigger than 50 MB,
1406 # or the smallest video (that also has audio) if there is no video under 50 MB
1407 $ yt-dlp -f 'b' -S 'filesize:50M'
1408
1409 # Download best video (that also has audio) that is closest in size to 50 MB
1410 $ yt-dlp -f 'b' -S 'filesize~50M'
1411
1412
1413
1414 # Download best video available via direct link over HTTP/HTTPS protocol,
1415 # or the best video available via any protocol if there is no such video
1416 $ yt-dlp -f '(bv*+ba/b)[protocol^=http][protocol!*=dash] / (bv*+ba/b)'
1417
1418 # Download best video available via the best protocol
1419 # (https/ftps > http/ftp > m3u8_native > m3u8 > http_dash_segments ...)
1420 $ yt-dlp -S 'proto'
1421
1422
1423
1424 # Download the best video with h264 codec, or the best video if there is no such video
1425 $ yt-dlp -f '(bv*+ba/b)[vcodec^=avc1] / (bv*+ba/b)'
1426
1427 # Download the best video with best codec no better than h264,
1428 # or the best video with worst codec if there is no such video
1429 $ yt-dlp -S 'codec:h264'
1430
1431 # Download the best video with worst codec no worse than h264,
1432 # or the best video with best codec if there is no such video
1433 $ yt-dlp -S '+codec:h264'
1434
1435
1436
1437 # More complex examples
1438
1439 # Download the best video no better than 720p preferring framerate greater than 30,
1440 # or the worst video (still preferring framerate greater than 30) if there is no such video
1441 $ yt-dlp -f '((bv*[fps>30]/bv*)[height<=720]/(wv*[fps>30]/wv*)) + ba / (b[fps>30]/b)[height<=720]/(w[fps>30]/w)'
1442
1443 # Download the video with the largest resolution no better than 720p,
1444 # or the video with the smallest resolution available if there is no such video,
1445 # preferring larger framerate for formats with the same resolution
1446 $ yt-dlp -S 'res:720,fps'
1447
1448
1449
1450 # Download the video with smallest resolution no worse than 480p,
1451 # or the video with the largest resolution available if there is no such video,
1452 # preferring better codec and then larger total bitrate for the same resolution
1453 $ yt-dlp -S '+res:480,codec,br'
1454 ```
1455
1456 # MODIFYING METADATA
1457
1458 The metadata obtained the the extractors can be modified by using `--parse-metadata` and `--replace-in-metadata`
1459
1460 `--replace-in-metadata FIELDS REGEX REPLACE` is used to replace text in any metadata field using [python regular expression](https://docs.python.org/3/library/re.html#regular-expression-syntax). [Backreferences](https://docs.python.org/3/library/re.html?highlight=backreferences#re.sub) can be used in the replace string for advanced use.
1461
1462 The general syntax of `--parse-metadata FROM:TO` is to give the name of a field or an [output template](#output-template) to extract data from, and the format to interpret it as, separated by a colon `:`. Either a [python regular expression](https://docs.python.org/3/library/re.html#regular-expression-syntax) with named capture groups or a similar syntax to the [output template](#output-template) (only `%(field)s` formatting is supported) can be used for `TO`. The option can be used multiple times to parse and modify various fields.
1463
1464 Note that any field created by this can be used in the [output template](#output-template) and will also affect the media file's metadata added when using `--add-metadata`.
1465
1466 This option also has a few special uses:
1467 * You can download an additional URL based on the metadata of the currently downloaded video. To do this, set the field `additional_urls` to the URL that you want to download. Eg: `--parse-metadata "description:(?P<additional_urls>https?://www\.vimeo\.com/\d+)` will download the first vimeo video found in the description
1468 * You can use this to change the metadata that is embedded in the media file. To do this, set the value of the corresponding field with a `meta_` prefix. For example, any value you set to `meta_description` field will be added to the `description` field in the file. For example, you can use this to set a different "description" and "synopsis". Any value set to the `meta_` field will overwrite all default values.
1469
1470 For reference, these are the fields yt-dlp adds by default to the file metadata:
1471
1472 Metadata fields|From
1473 :---|:---
1474 `title`|`track` or `title`
1475 `date`|`upload_date`
1476 `description`, `synopsis`|`description`
1477 `purl`, `comment`|`webpage_url`
1478 `track`|`track_number`
1479 `artist`|`artist`, `creator`, `uploader` or `uploader_id`
1480 `genre`|`genre`
1481 `album`|`album`
1482 `album_artist`|`album_artist`
1483 `disc`|`disc_number`
1484 `show`|`series`
1485 `season_number`|`season_number`
1486 `episode_id`|`episode` or `episode_id`
1487 `episode_sort`|`episode_number`
1488 `language` of each stream|From the format's `language`
1489 **Note**: The file format may not support some of these fields
1490
1491
1492 ## Modifying metadata examples
1493
1494 Note that on Windows you may need to use double quotes instead of single.
1495
1496 ```bash
1497 # Interpret the title as "Artist - Title"
1498 $ yt-dlp --parse-metadata 'title:%(artist)s - %(title)s'
1499
1500 # Regex example
1501 $ yt-dlp --parse-metadata 'description:Artist - (?P<artist>.+)'
1502
1503 # Set title as "Series name S01E05"
1504 $ yt-dlp --parse-metadata '%(series)s S%(season_number)02dE%(episode_number)02d:%(title)s'
1505
1506 # Set "comment" field in video metadata using description instead of webpage_url
1507 $ yt-dlp --parse-metadata 'description:(?s)(?P<meta_comment>.+)' --add-metadata
1508
1509 # Replace all spaces and "_" in title and uploader with a `-`
1510 $ yt-dlp --replace-in-metadata 'title,uploader' '[ _]' '-'
1511
1512 ```
1513
1514 # EXTRACTOR ARGUMENTS
1515
1516 Some extractors accept additional arguments which can be passed using `--extractor-args KEY:ARGS`. `ARGS` is a `;` (semicolon) seperated string of `ARG=VAL1,VAL2`. Eg: `--extractor-args "youtube:player_client=android_agegate,web;include_live_dash" --extractor-args "funimation:version=uncut"`
1517
1518 The following extractors use this feature:
1519
1520 #### youtube
1521 * `skip`: `hls` or `dash` (or both) to skip download of the respective manifests
1522 * `player_client`: Clients to extract video data from. The main clients are `web`, `android`, `ios`, `mweb`. These also have `_music`, `_embedded`, `_agegate`, and `_creator` variants (Eg: `web_embedded`) (`mweb` has only `_agegate`). By default, `android,web` is used, but the agegate and creator variants are added as required for age-gated videos. Similarly the music variants are added for `music.youtube.com` urls. You can also use `all` to use all the clients
1523 * `player_skip`: Skip some network requests that are generally needed for robust extraction. One or more of `configs` (skip client configs), `webpage` (skip initial webpage), `js` (skip js player). While these options can help reduce the number of requests needed or avoid some rate-limiting, they could cause some issues. See [#860](https://github.com/yt-dlp/yt-dlp/pull/860) for more details
1524 * `include_live_dash`: Include live dash formats (These formats don't download properly)
1525 * `comment_sort`: `top` or `new` (default) - choose comment sorting mode (on YouTube's side)
1526 * `max_comments`: Maximum amount of comments to download (default all)
1527 * `max_comment_depth`: Maximum depth for nested comments. YouTube supports depths 1 or 2 (default)
1528
1529 #### youtubetab (YouTube playlists, channels, feeds, etc.)
1530 * `skip`: One or more of `webpage` (skip initial webpage download), `authcheck` (allow the download of playlists requiring authentication when no initial webpage is downloaded. This may cause unwanted behavior, see [#1122](https://github.com/yt-dlp/yt-dlp/pull/1122) for more details)
1531
1532 #### funimation
1533 * `language`: Languages to extract. Eg: `funimation:language=english,japanese`
1534 * `version`: The video version to extract - `uncut` or `simulcast`
1535
1536 #### vikichannel
1537 * `video_types`: Types of videos to download - one or more of `episodes`, `movies`, `clips`, `trailers`
1538
1539 NOTE: These options may be changed/removed in the future without concern for backward compatibility
1540
1541
1542 # PLUGINS
1543
1544 Plugins are loaded from `<root-dir>/ytdlp_plugins/<type>/__init__.py`; where `<root-dir>` is the directory of the binary (`<root-dir>/yt-dlp`), or the root directory of the module if you are running directly from source-code (`<root dir>/yt_dlp/__main__.py`). Plugins are currently not supported for the `pip` version
1545
1546 Plugins can be of `<type>`s `extractor` or `postprocessor`. Extractor plugins do not need to be enabled from the CLI and are automatically invoked when the input URL is suitable for it. Postprocessor plugins can be invoked using `--use-postprocessor NAME`.
1547
1548 See [ytdlp_plugins](ytdlp_plugins) for example plugins.
1549
1550 Note that **all** plugins are imported even if not invoked, and that **there are no checks** performed on plugin code. Use plugins at your own risk and only if you trust the code
1551
1552 If you are a plugin author, add [ytdlp-plugins](https://github.com/topics/ytdlp-plugins) as a topic to your repository for discoverability
1553
1554
1555
1556 # EMBEDDING YT-DLP
1557
1558 yt-dlp makes the best effort to be a good command-line program, and thus should be callable from any programming language.
1559
1560 Your program should avoid parsing the normal stdout since they may change in future versions. Instead they should use options such as `-J`, `--print`, `--progress-template`, `--exec` etc to create console output that you can reliably reproduce and parse.
1561
1562 From a Python program, you can embed yt-dlp in a more powerful fashion, like this:
1563
1564 ```python
1565 import yt_dlp
1566
1567 ydl_opts = {}
1568 with yt_dlp.YoutubeDL(ydl_opts) as ydl:
1569 ydl.download(['https://www.youtube.com/watch?v=BaW_jenozKc'])
1570 ```
1571
1572 Most likely, you'll want to use various options. For a list of options available, have a look at [`yt_dlp/YoutubeDL.py`](yt_dlp/YoutubeDL.py#L154-L452).
1573
1574 Here's a more complete example of a program that outputs only errors (and a short message after the download is finished), converts the video to an mp3 file, implements a custom postprocessor and prints the final info_dict as json:
1575
1576 ```python
1577 import json
1578
1579 import yt_dlp
1580 from yt_dlp.postprocessor.common import PostProcessor
1581
1582
1583 class MyLogger:
1584 def debug(self, msg):
1585 # For compatability with youtube-dl, both debug and info are passed into debug
1586 # You can distinguish them by the prefix '[debug] '
1587 if msg.startswith('[debug] '):
1588 pass
1589 else:
1590 self.info(msg)
1591
1592 def info(self, msg):
1593 pass
1594
1595 def warning(self, msg):
1596 pass
1597
1598 def error(self, msg):
1599 print(msg)
1600
1601
1602 class MyCustomPP(PostProcessor):
1603 def run(self, info):
1604 self.to_screen('Doing stuff')
1605 return [], info
1606
1607
1608 def my_hook(d):
1609 if d['status'] == 'finished':
1610 print('Done downloading, now converting ...')
1611
1612
1613 ydl_opts = {
1614 'format': 'bestaudio/best',
1615 'postprocessors': [{
1616 'key': 'FFmpegExtractAudio',
1617 'preferredcodec': 'mp3',
1618 'preferredquality': '192',
1619 }],
1620 'logger': MyLogger(),
1621 'progress_hooks': [my_hook],
1622 }
1623
1624 with yt_dlp.YoutubeDL(ydl_opts) as ydl:
1625 ydl.add_post_processor(MyCustomPP())
1626 info = ydl.extract_info('https://www.youtube.com/watch?v=BaW_jenozKc')
1627 print(json.dumps(ydl.sanitize_info(info)))
1628 ```
1629
1630 See the public functions in [`yt_dlp/YoutubeDL.py`](yt_dlp/YoutubeDL.py) for other available functions. Eg: `ydl.download`, `ydl.download_with_info_file`
1631
1632 **Tip**: If you are porting your code from youtube-dl to yt-dlp, one important point to look out for is that we do not guarantee the return value of `YoutubeDL.extract_info` to be json serializable, or even be a dictionary. It will be dictionary-like, but if you want to ensure it is a serializable dictionary, pass it through `YoutubeDL.sanitize_info` as shown in the example above
1633
1634
1635 # DEPRECATED OPTIONS
1636
1637 These are all the deprecated options and the current alternative to achieve the same effect
1638
1639 #### Redundant options
1640 While these options are redundant, they are still expected to be used due to their ease of use
1641
1642 --get-description --print description
1643 --get-duration --print duration_string
1644 --get-filename --print filename
1645 --get-format --print format
1646 --get-id --print id
1647 --get-thumbnail --print thumbnail
1648 -e, --get-title --print title
1649 -g, --get-url --print urls
1650 -j, --dump-json --print "%()j"
1651 --match-title REGEX --match-filter "title ~= (?i)REGEX"
1652 --reject-title REGEX --match-filter "title !~= (?i)REGEX"
1653 --min-views COUNT --match-filter "view_count >=? COUNT"
1654 --max-views COUNT --match-filter "view_count <=? COUNT"
1655
1656
1657 #### Not recommended
1658 While these options still work, their use is not recommended since there are other alternatives to achieve the same
1659
1660 --all-formats -f all
1661 --all-subs --sub-langs all --write-subs
1662 --print-json -j --no-simulate
1663 --autonumber-size NUMBER Use string formatting. Eg: %(autonumber)03d
1664 --autonumber-start NUMBER Use internal field formatting like %(autonumber+NUMBER)s
1665 --id -o "%(id)s.%(ext)s"
1666 --metadata-from-title FORMAT --parse-metadata "%(title)s:FORMAT"
1667 --hls-prefer-native --downloader "m3u8:native"
1668 --hls-prefer-ffmpeg --downloader "m3u8:ffmpeg"
1669 --list-formats-old --compat-options list-formats (Alias: --no-list-formats-as-table)
1670 --list-formats-as-table --compat-options -list-formats [Default] (Alias: --no-list-formats-old)
1671 --youtube-skip-dash-manifest --extractor-args "youtube:skip=dash" (Alias: --no-youtube-include-dash-manifest)
1672 --youtube-skip-hls-manifest --extractor-args "youtube:skip=hls" (Alias: --no-youtube-include-hls-manifest)
1673 --youtube-include-dash-manifest Default (Alias: --no-youtube-skip-dash-manifest)
1674 --youtube-include-hls-manifest Default (Alias: --no-youtube-skip-hls-manifest)
1675
1676
1677 #### Developer options
1678 These options are not intended to be used by the end-user
1679
1680 --test Download only part of video for testing extractors
1681 --youtube-print-sig-code For testing youtube signatures
1682 --allow-unplayable-formats List unplayable formats also
1683 --no-allow-unplayable-formats Default
1684
1685
1686 #### Old aliases
1687 These are aliases that are no longer documented for various reasons
1688
1689 --avconv-location --ffmpeg-location
1690 --cn-verification-proxy URL --geo-verification-proxy URL
1691 --dump-headers --print-traffic
1692 --dump-intermediate-pages --dump-pages
1693 --force-write-download-archive --force-write-archive
1694 --load-info --load-info-json
1695 --no-split-tracks --no-split-chapters
1696 --no-write-srt --no-write-subs
1697 --prefer-unsecure --prefer-insecure
1698 --rate-limit RATE --limit-rate RATE
1699 --split-tracks --split-chapters
1700 --srt-lang LANGS --sub-langs LANGS
1701 --trim-file-names LENGTH --trim-filenames LENGTH
1702 --write-srt --write-subs
1703 --yes-overwrites --force-overwrites
1704
1705 #### Sponskrub Options
1706 Support for [SponSkrub](https://github.com/faissaloo/SponSkrub) has been deprecated in favor of `--sponsorblock`
1707
1708 --sponskrub --sponsorblock-mark all
1709 --no-sponskrub --no-sponsorblock
1710 --sponskrub-cut --sponsorblock-remove all
1711 --no-sponskrub-cut --sponsorblock-remove -all
1712 --sponskrub-force Not applicable
1713 --no-sponskrub-force Not applicable
1714 --sponskrub-location Not applicable
1715 --sponskrub-args Not applicable
1716
1717 #### No longer supported
1718 These options may no longer work as intended
1719
1720 --prefer-avconv avconv is not officially supported by yt-dlp (Alias: --no-prefer-ffmpeg)
1721 --prefer-ffmpeg Default (Alias: --no-prefer-avconv)
1722 -C, --call-home Not implemented
1723 --no-call-home Default
1724 --include-ads No longer supported
1725 --no-include-ads Default
1726 --write-annotations No supported site has annotations now
1727 --no-write-annotations Default
1728
1729 #### Removed
1730 These options were deprecated since 2014 and have now been entirely removed
1731
1732 -A, --auto-number -o "%(autonumber)s-%(id)s.%(ext)s"
1733 -t, --title -o "%(title)s-%(id)s.%(ext)s"
1734 -l, --literal -o accepts literal names
1735
1736 # CONTRIBUTING
1737 See [CONTRIBUTING.md](CONTRIBUTING.md#contributing-to-yt-dlp) for instructions on [Opening an Issue](CONTRIBUTING.md#opening-an-issue) and [Contributing code to the project](CONTRIBUTING.md#developer-instructions)
1738
1739 # MORE
1740 For FAQ see the [youtube-dl README](https://github.com/ytdl-org/youtube-dl#faq)