]> jfr.im git - yt-dlp.git/blame - README.md
Changed repo name to yt-dlp
[yt-dlp.git] / README.md
CommitLineData
d9d045e2 1# YT-DLP
2
b2f70ae7 3<!-- See: https://github.com/marketplace/actions/dynamic-badges -->
4[![Release Version](https://img.shields.io/endpoint?url=https://gist.githubusercontent.com/pukkandan/c69cb23c3c5b3316248e52022790aa57/raw/version.json&color=brightgreen)](https://github.com/pukkandan/yt-dlc/releases/latest)
c76eb41b 5[![License: Unlicense](https://img.shields.io/badge/License-Unlicense-blue.svg)](https://github.com/pukkandan/yt-dlc/blob/master/LICENSE)
0c0ff18f 6[![Core Status](https://github.com/pukkandan/yt-dlc/workflows/Core%20Test/badge.svg?branch=master)](https://github.com/pukkandan/yt-dlc/actions?query=workflow%3ACore)
7[![CI Status](https://github.com/pukkandan/yt-dlc/workflows/Full%20Test/badge.svg?branch=master)](https://github.com/pukkandan/yt-dlc/actions?query=workflow%3AFull)
c76eb41b 8
d9d045e2 9A command-line program to download videos from youtube.com and many other [video platforms](docs/supportedsites.md)
c76eb41b 10
50865ca8 11This is a fork of [youtube-dlc](https://github.com/blackjack4494/yt-dlc) which is inturn a fork of [youtube-dl](https://github.com/ytdl-org/youtube-dl)
5c0e5bc4 12
034b6215 13* [NEW FEATURES](#new-features)
c76eb41b 14* [INSTALLATION](#installation)
15 * [UPDATE](#update)
16 * [COMPILE](#compile)
c76eb41b 17* [DESCRIPTION](#description)
18* [OPTIONS](#options)
50865ca8 19 * [Network Options](#network-options)
20 * [Geo Restriction](#geo-restriction)
21 * [Video Selection](#video-selection)
22 * [Download Options](#download-options)
23 * [Filesystem Options](#filesystem-options)
24 * [Thumbnail images](#thumbnail-images)
25 * [Internet Shortcut Options](#internet-shortcut-options)
26 * [Verbosity / Simulation Options](#verbosity--simulation-options)
27 * [Workarounds](#workarounds)
28 * [Video Format Options](#video-format-options)
29 * [Subtitle Options](#subtitle-options)
30 * [Authentication Options](#authentication-options)
31 * [Adobe Pass Options](#adobe-pass-options)
32 * [Post-processing Options](#post-processing-options)
034b6215 33 * [SponSkrub Options (SponsorBlock)](#sponSkrub-options-sponsorblock)
50865ca8 34 * [Extractor Options](#extractor-options)
c76eb41b 35* [CONFIGURATION](#configuration)
50865ca8 36 * [Authentication with .netrc file](#authentication-with-netrc-file)
c76eb41b 37* [OUTPUT TEMPLATE](#output-template)
50865ca8 38 * [Output template and Windows batch files](#output-template-and-windows-batch-files)
39 * [Output template examples](#output-template-examples)
c76eb41b 40* [FORMAT SELECTION](#format-selection)
50865ca8 41 * [Filtering Formats](#filtering-formats)
42 * [Sorting Formats](#sorting-formats)
43 * [Format Selection examples](#format-selection-examples)
c76eb41b 44* [VIDEO SELECTION](#video-selection-1)
45* [MORE](#more)
50865ca8 46
47
034b6215 48# NEW FEATURES
f20f5fe5 49The major new features from the latest release of [blackjack4494/yt-dlc](https://github.com/blackjack4494/yt-dlc) are:
034b6215 50
f20f5fe5 51* **[SponSkrub Integration](#sponSkrub-options-sponsorblock)**: You can use [SponSkrub](https://github.com/faissaloo/SponSkrub) to mark/remove sponsor sections in youtube videos by utilizing the [SponsorBlock](https://sponsor.ajay.app) API
034b6215 52
f20f5fe5 53* **[Format Sorting](#sorting-format)**: The default format sorting options have been changed so that higher resolution and better codecs will be now prefered instead of simply using larger bitrate. Furthermore, you can now specify the sort order using `-S`. This allows for much easier format selection that what is possible by simply using `--format` ([examples](#format-selection-examples))
034b6215 54
f20f5fe5 55* Merged with youtube-dl **v2020.01.08**: 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)
034b6215 56
f5546c0b 57* **Youtube improvements**:
58 * All Youtube Feeds (`:ytfav`, `:ytwatchlater`, `:ytsubs`, `:ythistory`, `:ytrec`) works correctly and support downloading multiple pages of content
59 * Youtube search works correctly (`ytsearch:`, `ytsearchdate:`) along with Search URLs
f20f5fe5 60 * Redirect channel's home URL automatically to `/video` to preserve the old behaviour
61
62* **New extractors**: AnimeLab, Rcs, Gedi, bitwave.tv
63
64* **Fixed extractors**: archive.org, skyit, instagram, itv, SouthparkDe, spreaker, Vlive, tiktok, akamai, ina
65
66* **New options**: `--list-formats-as-table`, `--write-link`, `--force-download-archive` etc
034b6215 67
6fd35a11 68and many other features and patches. See [changelog](Changelog.md) or [commits](https://github.com/pukkandan/yt-dlc/commits) for the full list of changes
a26c99ac 69
70
f20f5fe5 71**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
72
73If you are coming from [youtube-dl](https://github.com/ytdl-org/youtube-dl), the amount of changes are very large. Compare [options](#options) and [supported sites](docs/supportedsites.md) with youtube-dl's to get an idea of the massive number of features/patches [youtube-dlc](https://github.com/blackjack4494/yt-dlc) has accumulated.
74
75
d19bb9c0 76# INSTALLATION
50865ca8 77
c76eb41b 78To use the latest version, simply download and run the [latest release](https://github.com/pukkandan/yt-dlc/releases/latest).
79Currently, there is no support for any package managers.
d19bb9c0 80
471115db
TOH
81If you want to install the current master branch
82
c76eb41b 83 python -m pip install git+https://github.com/pukkandan/yt-dlc
5f326cf5 84
c76eb41b 85### UPDATE
86**DO NOT UPDATE using `-U` !** instead download binaries again
5f326cf5 87
c76eb41b 88### COMPILE
5f326cf5 89
c76eb41b 90**For Windows**:
b96a939b 91To build the Windows executable yourself (without version info!)
d19bb9c0 92
9ab41610 93 python -m pip install --upgrade pyinstaller
cefecac1 94 pyinstaller.exe youtube_dlc\__main__.py --onefile --name youtube-dlc
8f1aaa97 95
9ab41610 96Or simply execute the `make_win.bat` if pyinstaller is installed.
5f326cf5
TOH
97There will be a `youtube-dlc.exe` in `/dist`
98
b96a939b
TOH
99New way to build Windows is to use `python pyinst.py` (please use python3 64Bit)
100For 32Bit Version use a 32Bit Version of python (3 preferred here as well) and run `python pyinst32.py`
101
c76eb41b 102**For Unix**:
5f326cf5
TOH
103You will need the required build tools
104python, make (GNU), pandoc, zip, nosetests
105Then simply type this
106
107 make
108
d19bb9c0 109
cfcec693 110# DESCRIPTION
f5546c0b 111**youtube-dlc** is a command-line program to download videos from youtube.com many other [video platforms](docs/supportedsites.md). It requires the Python interpreter, version 2.6, 2.7, or 3.2+, and it is not platform specific. It should work on your Unix box, on Windows or on macOS. It is released to the public domain, which means you can modify it, redistribute it or use it however you like.
6bcd846b 112
f5546c0b 113 youtube-dlc [OPTIONS] [--] URL [URL...]
b50e3bc6 114
c76eb41b 115
cfcec693 116# OPTIONS
c2b5f311 117`Ctrl+F` is your friend :D
c76eb41b 118<!-- Autogenerated -->
c2b5f311 119
c76eb41b 120## General Options:
1dc2726f
PH
121 -h, --help Print this help text and exit
122 --version Print program version and exit
c76eb41b 123 -U, --update [BROKEN] Update this program to latest
124 version. Make sure that you have sufficient
125 permissions (run with sudo if needed)
c4af7684
PH
126 -i, --ignore-errors Continue on download errors, for example to
127 skip unavailable videos in a playlist
91ebc640 128 (default) (Same as --no-abort-on-error)
6623ac34 129 --abort-on-error Abort downloading of further videos if an
130 error occurs (Same as --no-ignore-errors)
1dc2726f 131 --dump-user-agent Display the current browser identification
4b9f9010 132 --list-extractors List all supported extractors
c4af7684
PH
133 --extractor-descriptions Output descriptions of all supported
134 extractors
135 --force-generic-extractor Force extraction to use the generic
136 extractor
137 --default-search PREFIX Use this prefix for unqualified URLs. For
138 example "gvsearch2:" downloads two videos
6623ac34 139 from google videos for youtube-dl "large
c4af7684 140 apple". Use the value "auto" to let
6623ac34 141 youtube-dl guess ("auto_warning" to emit a
c4af7684
PH
142 warning when guessing). "error" just throws
143 an error. The default value "fixup_error"
144 repairs broken URLs, but emits an error if
145 this is not possible instead of searching.
6623ac34 146 --ignore-config, --no-config Do not read configuration files. When given
82674236 147 in the global configuration file
6623ac34 148 /etc/youtube-dl.conf: Do not read the user
c4af7684 149 configuration in ~/.config/youtube-
6623ac34 150 dl/config (%APPDATA%/youtube-dl/config.txt
151 on Windows)
dc48a354
S
152 --config-location PATH Location of the configuration file; either
153 the path to the config or its containing
154 directory.
c4af7684
PH
155 --flat-playlist Do not extract the videos of a playlist,
156 only list them.
6623ac34 157 --flat-videos Do not resolve the video urls
158 --no-flat-playlist Extract the videos of a playlist
bdf7f139 159 --mark-watched Mark videos watched (YouTube only)
c76eb41b 160 --no-mark-watched Do not mark videos watched
1dc2726f 161 --no-color Do not emit color codes in output
08c1d0d3 162
149f05c7 163## Network Options:
28b4f736 164 --proxy URL Use the specified HTTP/HTTPS/SOCKS proxy.
0934c9d4
S
165 To enable SOCKS proxy, specify a proper
166 scheme. For example
28b4f736
PH
167 socks5://127.0.0.1:1080/. Pass in an empty
168 string (--proxy "") for direct connection
149f05c7 169 --socket-timeout SECONDS Time to wait before giving up, in seconds
c4af7684 170 --source-address IP Client-side IP address to bind to
c4af7684 171 -4, --force-ipv4 Make all connections via IPv4
c4af7684 172 -6, --force-ipv6 Make all connections via IPv6
8c6c88c7
S
173
174## Geo Restriction:
c25f1a9b
S
175 --geo-verification-proxy URL Use this proxy to verify the IP address for
176 some geo-restricted sites. The default
177 proxy specified by --proxy (or none, if the
7550ea50 178 option is not present) is used for the
4d2fdb07 179 actual downloading.
8c6c88c7 180 --geo-bypass Bypass geographic restriction via faking
0934c9d4 181 X-Forwarded-For HTTP header
8c6c88c7
S
182 --no-geo-bypass Do not bypass geographic restriction via
183 faking X-Forwarded-For HTTP header
8c6c88c7
S
184 --geo-bypass-country CODE Force bypass geographic restriction with
185 explicitly provided two-letter ISO 3166-2
0934c9d4 186 country code
9e18bb4c
S
187 --geo-bypass-ip-block IP_BLOCK Force bypass geographic restriction with
188 explicitly provided IP block in CIDR
0934c9d4 189 notation
149f05c7 190
cfcec693 191## Video Selection:
1dc2726f
PH
192 --playlist-start NUMBER Playlist video to start at (default is 1)
193 --playlist-end NUMBER Playlist video to end at (default is last)
c4af7684
PH
194 --playlist-items ITEM_SPEC Playlist video items to download. Specify
195 indices of the videos in the playlist
196 separated by commas like: "--playlist-items
197 1,2,5,8" if you want to download videos
198 indexed 1, 2, 5, 8 in the playlist. You can
199 specify range: "--playlist-items
200 1-3,7,10-13", it will download the videos
201 at index 1, 2, 3, 7, 10, 11, 12 and 13.
202 --match-title REGEX Download only matching titles (regex or
203 caseless sub-string)
204 --reject-title REGEX Skip download for matching titles (regex or
205 caseless sub-string)
780083db 206 --max-downloads NUMBER Abort after downloading NUMBER files
c4af7684
PH
207 --min-filesize SIZE Do not download any videos smaller than
208 SIZE (e.g. 50k or 44.6m)
209 --max-filesize SIZE Do not download any videos larger than SIZE
210 (e.g. 50k or 44.6m)
6623ac34 211 --date DATE Download only videos uploaded in this date.
212 The date can be "YYYYMMDD" or in the format
213 "(now|today)[+-][0-9](day|week|month|year)(s)?"
c4af7684 214 --datebefore DATE Download only videos uploaded on or before
c76eb41b 215 this date. The date formats accepted is the
216 same as --date
c4af7684 217 --dateafter DATE Download only videos uploaded on or after
c76eb41b 218 this date. The date formats accepted is the
219 same as --date
c4af7684
PH
220 --min-views COUNT Do not download any videos with less than
221 COUNT views
222 --max-views COUNT Do not download any videos with more than
223 COUNT views
4d2fdb07 224 --match-filter FILTER Generic video filter. Specify any key (see
cb1e6d89
S
225 the "OUTPUT TEMPLATE" for a list of
226 available keys) to match if the key is
227 present, !key to check if the key is not
228 present, key > NUMBER (like "comment_count
229 > 12", also works with >=, <, <=, !=, =) to
230 compare against a number, key = 'LITERAL'
231 (like "uploader = 'Mike Smith'", also works
232 with !=) to match against a string literal
233 and & to require multiple matches. Values
234 which are not known are excluded unless you
235 put a question mark (?) after the operator.
236 For example, to only match videos that have
8c6c88c7
S
237 been liked more than 100 times and disliked
238 less than 50 times (or the dislike
239 functionality is not available at the given
240 service), but who also have a description,
241 use --match-filter "like_count > 100 &
242 dislike_count <? 50 & description" .
c76eb41b 243 --no-match-filter Do not use generic video filter (default)
c4af7684
PH
244 --no-playlist Download only the video, if the URL refers
245 to a video and a playlist.
246 --yes-playlist Download the playlist, if the URL refers to
247 a video and a playlist.
248 --age-limit YEARS Download only videos suitable for the given
249 age
250 --download-archive FILE Download only videos not listed in the
251 archive file. Record the IDs of all
252 downloaded videos in it.
ea6e0c2b 253 --break-on-existing Stop the download process after attempting
254 to download a file that's in the archive.
c76eb41b 255 --no-download-archive Do not use archive file (default)
256 --include-ads Download advertisements as well
257 (experimental)
6623ac34 258 --no-include-ads Do not download advertisements (default)
6bcd846b 259
d5a62e4f 260## Download Options:
5e3856a2 261 -r, --limit-rate RATE Maximum download rate in bytes per second
c4af7684
PH
262 (e.g. 50K or 4.2M)
263 -R, --retries RETRIES Number of retries (default is 10), or
264 "infinite".
0be8314d 265 --fragment-retries RETRIES Number of retries for a fragment (default
b56e41a7
S
266 is 10), or "infinite" (DASH, hlsnative and
267 ISM)
6623ac34 268 --skip-unavailable-fragments Skip unavailable fragments for DASH,
269 hlsnative and ISM (default)
270 (Same as --no-abort-on-unavailable-fragment)
271 --abort-on-unavailable-fragment Abort downloading if a fragment is unavailable
272 (Same as --no-skip-unavailable-fragments)
a82f4184 273 --keep-fragments Keep downloaded fragments on disk after
6623ac34 274 downloading is finished
c76eb41b 275 --no-keep-fragments Delete downloaded fragments after
276 downloading is finished (default)
c4af7684
PH
277 --buffer-size SIZE Size of download buffer (e.g. 1024 or 16K)
278 (default is 1024)
c76eb41b 279 --resize-buffer The buffer size is automatically resized
280 from an initial value of --buffer-size
281 (default)
282 --no-resize-buffer Do not automatically adjust the buffer size
db157d2a
S
283 --http-chunk-size SIZE Size of a chunk for chunk-based HTTP
284 downloading (e.g. 10485760 or 10M) (default
285 is disabled). May be useful for bypassing
286 bandwidth throttling imposed by a webserver
287 (experimental)
2101f5d4 288 --playlist-reverse Download playlist videos in reverse order
6623ac34 289 --no-playlist-reverse Download playlist videos in default order
c76eb41b 290 (default)
31487eb9 291 --playlist-random Download playlist videos in random order
c4af7684 292 --xattr-set-filesize Set file xattribute ytdl.filesize with
0934c9d4 293 expected file size
c4af7684 294 --hls-prefer-native Use the native HLS downloader instead of
8b38f2ac
PH
295 ffmpeg
296 --hls-prefer-ffmpeg Use ffmpeg instead of the native HLS
297 downloader
a69bee47
PH
298 --hls-use-mpegts Use the mpegts container for HLS videos,
299 allowing to play the video while
300 downloading (some players may not be able
301 to play it)
c4af7684
PH
302 --external-downloader COMMAND Use the specified external downloader.
303 Currently supports
6bb26669 304 aria2c,avconv,axel,curl,ffmpeg,httpie,wget
c4af7684
PH
305 --external-downloader-args ARGS Give these arguments to the external
306 downloader
d5a62e4f 307
cfcec693 308## Filesystem Options:
c4af7684 309 -a, --batch-file FILE File containing URLs to download ('-' for
e8dfecb3
S
310 stdin), one URL per line. Lines starting
311 with '#', ';' or ']' are considered as
312 comments and ignored.
bd1bcd3e 313 -o, --output TEMPLATE Output filename template, see the "OUTPUT
c76eb41b 314 TEMPLATE" for details
4d2fdb07
S
315 --autonumber-start NUMBER Specify the start value for %(autonumber)s
316 (default is 1)
c4af7684
PH
317 --restrict-filenames Restrict filenames to only ASCII
318 characters, and avoid "&" and spaces in
319 filenames
c76eb41b 320 --no-restrict-filenames Allow Unicode characters, "&" and spaces in
321 filenames (default)
1dc2726f 322 -w, --no-overwrites Do not overwrite files
6623ac34 323 -c, --continue Resume partially downloaded files (default)
c76eb41b 324 --no-continue Restart download of partially downloaded
325 files from beginning
326 --part Use .part files instead of writing directly
6623ac34 327 into output file (default)
c4af7684
PH
328 --no-part Do not use .part files - write directly
329 into output file
c76eb41b 330 --mtime Use the Last-modified header to set the
331 file modification time (default)
c4af7684
PH
332 --no-mtime Do not use the Last-modified header to set
333 the file modification time
334 --write-description Write video description to a .description
335 file
6623ac34 336 --no-write-description Do not write video description (default)
1dc2726f 337 --write-info-json Write video metadata to a .info.json file
6623ac34 338 --no-write-info-json Do not write video metadata (default)
c4af7684
PH
339 --write-annotations Write video annotations to a
340 .annotations.xml file
6623ac34 341 --no-write-annotations Do not write video annotations (default)
d845622b 342 --load-info-json FILE JSON file containing the video information
c4af7684
PH
343 (created with the "--write-info-json"
344 option)
345 --cookies FILE File to read cookies from and dump cookie
346 jar in
6623ac34 347 --no-cookies Do not read/dump cookies (default)
348 --cache-dir DIR Location in the filesystem where youtube-dl
349 can store some downloaded information
82674236 350 permanently. By default
6623ac34 351 $XDG_CACHE_HOME/youtube-dl or
352 ~/.cache/youtube-dl . At the moment, only
82674236
S
353 YouTube player files (for videos with
354 obfuscated signatures) are cached, but that
355 may change.
36f35428
PH
356 --no-cache-dir Disable filesystem caching
357 --rm-cache-dir Delete all filesystem cache files
c76eb41b 358 --trim-file-name LENGTH Limit the filename length (extension
bc30d1e0 359 excluded)
6bcd846b 360
c76eb41b 361## Thumbnail Images:
1dc2726f 362 --write-thumbnail Write thumbnail image to disk
6623ac34 363 --no-write-thumbnail Do not write thumbnail image to disk
c76eb41b 364 (default)
1dc2726f 365 --write-all-thumbnails Write all thumbnail image formats to disk
c4af7684
PH
366 --list-thumbnails Simulate and list all available thumbnail
367 formats
2b1bd292 368
732044af 369## Internet Shortcut Options:
370 --write-link Write an internet shortcut file, depending on
371 the current platform (.url/.webloc/.desktop).
372 The URL may be cached by the OS.
6623ac34 373 --write-url-link Write a Windows .url internet shortcut file.
374 (The OS caches the URL based on the file path)
375 --write-webloc-link Write a .webloc macOS internet shortcut file
376 --write-desktop-link Write a .desktop Linux internet shortcut file
732044af 377
cfcec693 378## Verbosity / Simulation Options:
1dc2726f 379 -q, --quiet Activate quiet mode
6c072e7d 380 --no-warnings Ignore warnings
c4af7684
PH
381 -s, --simulate Do not download the video and do not write
382 anything to disk
1dc2726f
PH
383 --skip-download Do not download the video
384 -g, --get-url Simulate, quiet but print URL
385 -e, --get-title Simulate, quiet but print title
386 --get-id Simulate, quiet but print id
387 --get-thumbnail Simulate, quiet but print thumbnail URL
388 --get-description Simulate, quiet but print video description
389 --get-duration Simulate, quiet but print video length
390 --get-filename Simulate, quiet but print output filename
391 --get-format Simulate, quiet but print output format
c4af7684 392 -j, --dump-json Simulate, quiet but print JSON information.
cb1e6d89
S
393 See the "OUTPUT TEMPLATE" for a description
394 of available keys.
c4af7684
PH
395 -J, --dump-single-json Simulate, quiet but print JSON information
396 for each command-line argument. If the URL
397 refers to a playlist, dump the whole
398 playlist information in a single line.
399 --print-json Be quiet and print the video information as
400 JSON (video is still being downloaded).
2d30509f 401 --force-write-archive Force download archive entries to be written
402 as far as no errors occur, even if -s or
403 another simulation switch is used.
404 (Same as --force-download-archive)
1dc2726f
PH
405 --newline Output progress bar as new lines
406 --no-progress Do not print progress bar
407 --console-title Display progress in console titlebar
408 -v, --verbose Print various debugging information
c4af7684
PH
409 --dump-pages Print downloaded pages encoded using base64
410 to debug problems (very verbose)
411 --write-pages Write downloaded intermediary pages to
412 files in the current directory to debug
413 problems
780083db 414 --print-traffic Display sent and read HTTP traffic
6623ac34 415 -C, --call-home Contact the youtube-dlc server for debugging
416 --no-call-home Do not contact the youtube-dlc server for
417 debugging (default)
6bcd846b 418
36f35428
PH
419## Workarounds:
420 --encoding ENCODING Force the specified encoding (experimental)
1dc2726f 421 --no-check-certificate Suppress HTTPS certificate validation
c4af7684 422 --prefer-insecure Use an unencrypted connection to retrieve
05a7ffb1
S
423 information about the video. (Currently
424 supported only for YouTube)
1dc2726f 425 --user-agent UA Specify a custom user agent
c4af7684
PH
426 --referer URL Specify a custom referer, use if the video
427 access is restricted to one domain
428 --add-header FIELD:VALUE Specify a custom HTTP header and its value,
429 separated by a colon ':'. You can use this
430 option multiple times
431 --bidi-workaround Work around terminals that lack
432 bidirectional text support. Requires bidiv
433 or fribidi executable in PATH
434 --sleep-interval SECONDS Number of seconds to sleep before each
b1ce2ba1
S
435 download when used alone or a lower bound
436 of a range for randomized sleep before each
437 download (minimum possible number of
438 seconds to sleep) when used along with
439 --max-sleep-interval.
440 --max-sleep-interval SECONDS Upper bound of a range for randomized sleep
441 before each download (maximum possible
442 number of seconds to sleep). Must only be
443 used along with --min-sleep-interval.
c76eb41b 444 --sleep-subtitles SECONDS Enforce sleep interval on subtitles as well
36f35428 445
cfcec693 446## Video Format Options:
eb8a4433 447 -f, --format FORMAT Video format code, see "FORMAT SELECTION"
448 for more details
449 -S, --format-sort SORTORDER Sort the formats by the fields given, see
450 "Sorting Formats" for more details
451 --S-force, --format-sort-force Force user specified sort order to have
452 precedence over all fields, see "Sorting
453 Formats" for more details
454 --no-format-sort-force Some fields have precedence over the user
c76eb41b 455 specified sort order (default), see
456 "Sorting Formats" for more details
457 --video-multistreams Allow multiple video streams to be merged
458 into a single file
459 --no-video-multistreams Only one video stream is downloaded for
460 each output file (default)
461 --audio-multistreams Allow multiple audio streams to be merged
462 into a single file
463 --no-audio-multistreams Only one audio stream is downloaded for
464 each output file (default)
1dc2726f 465 --all-formats Download all available video formats
6fd35a11 466 --prefer-free-formats Prefer free video formats over non-free
467 formats of same quality
535d7b68 468 -F, --list-formats List all available formats of requested
bb6ac836 469 videos
91ebc640 470 --list-formats-as-table Present the output of -F in a more tabular
471 form (default)
6623ac34 472 (Same as --no-list-formats-as-table)
c76eb41b 473 --list-formats-old Present the output of -F in the old form
6623ac34 474 --youtube-include-dash-manifest Download the DASH manifests and related data
475 on YouTube videos (default)
476 (Same as --no-youtube-skip-dash-manifest)
c76eb41b 477 --youtube-skip-dash-manifest Do not download the DASH manifests and
78895bd3 478 related data on YouTube videos
c76eb41b 479 (Same as --no-youtube-include-dash-manifest)
6623ac34 480 --youtube-include-hls-manifest Download the HLS manifests and related data
481 on YouTube videos (default)
482 (Same as --no-youtube-skip-hls-manifest)
c76eb41b 483 --youtube-skip-hls-manifest Do not download the HLS manifests and
484 related data on YouTube videos
485 (Same as --no-youtube-include-hls-manifest)
c4af7684
PH
486 --merge-output-format FORMAT If a merge is required (e.g.
487 bestvideo+bestaudio), output to given
488 container format. One of mkv, mp4, ogg,
489 webm, flv. Ignored if no merge is required
8ae7be3e
PH
490
491## Subtitle Options:
c76eb41b 492 --write-subs Write subtitle file
493 --no-write-subs Do not write subtitle file (default)
494 --write-auto-subs Write automatically generated subtitle file
741dd8ea 495 (YouTube only)
c76eb41b 496 --no-write-auto-subs Do not write automatically generated
6623ac34 497 subtitle file (default)
c4af7684
PH
498 --all-subs Download all the available subtitles of the
499 video
1dc2726f 500 --list-subs List all available subtitles for the video
c4af7684
PH
501 --sub-format FORMAT Subtitle format, accepts formats
502 preference, for example: "srt" or
503 "ass/srt/best"
504 --sub-lang LANGS Languages of the subtitles to download
f733b053
PH
505 (optional) separated by commas, use --list-
506 subs for available language tags
6bcd846b 507
cfcec693 508## Authentication Options:
1dc2726f 509 -u, --username USERNAME Login with this account ID
c4af7684 510 -p, --password PASSWORD Account password. If this option is left
cefecac1 511 out, youtube-dlc will ask interactively.
dc48a354 512 -2, --twofactor TWOFACTOR Two-factor authentication code
1dc2726f 513 -n, --netrc Use .netrc authentication data
29f7c58a 514 --video-password PASSWORD Video password (vimeo, youku)
6bcd846b 515
f5e008d1
S
516## Adobe Pass Options:
517 --ap-mso MSO Adobe Pass multiple-system operator (TV
909d24dd 518 provider) identifier, use --ap-list-mso for
519 a list of available MSOs
f5e008d1
S
520 --ap-username USERNAME Multiple-system operator account login
521 --ap-password PASSWORD Multiple-system operator account password.
e3671279
U
522 If this option is left out, youtube-dlc
523 will ask interactively.
f5e008d1
S
524 --ap-list-mso List all supported multiple-system
525 operators
526
c76eb41b 527## Post-Processing Options:
c4af7684
PH
528 -x, --extract-audio Convert video files to audio-only files
529 (requires ffmpeg or avconv and ffprobe or
530 avprobe)
531 --audio-format FORMAT Specify audio format: "best", "aac",
7d539ee1
S
532 "flac", "mp3", "m4a", "opus", "vorbis", or
533 "wav"; "best" by default; No effect without
534 -x
c4af7684
PH
535 --audio-quality QUALITY Specify ffmpeg/avconv audio quality, insert
536 a value between 0 (better) and 9 (worse)
537 for VBR or a specific bitrate like 128K
538 (default 5)
c76eb41b 539 --remux-video FORMAT Remux the video into another container if
540 necessary (currently supported: mp4|mkv).
541 If target container does not support the
542 video/audio codec, remuxing will fail
543 --recode-video FORMAT Re-encode the video into another format if
544 re-encoding is necessary (currently
545 supported: mp4|flv|ogg|webm|mkv|avi)
1b77b347 546 --postprocessor-args NAME:ARGS Give these arguments to the postprocessors.
547 Specify the postprocessor name and the
548 arguments separated by a colon ':' to give
549 the argument to only the specified
550 postprocessor. Supported names are
551 ExtractAudio, VideoRemuxer, VideoConvertor,
552 EmbedSubtitle, Metadata, Merger,
553 FixupStretched, FixupM4a, FixupM3u8,
554 SubtitlesConvertor, SponSkrub and Default.
555 You can use this option multiple times to
556 give different arguments to different
557 postprocessors
c76eb41b 558 -k, --keep-video Keep the intermediate video file on disk
6623ac34 559 after post-processing
c76eb41b 560 --no-keep-video Delete the intermediate video file after
6623ac34 561 post-processing (default)
562 --post-overwrites Overwrite post-processed files (default)
563 --no-post-overwrites Do not overwrite post-processed files
0be8314d
PH
564 --embed-subs Embed subtitles in the video (only for mp4,
565 webm and mkv videos)
c76eb41b 566 --no-embed-subs Do not embed subtitles (default)
1dc2726f 567 --embed-thumbnail Embed thumbnail in the audio as cover art
6623ac34 568 --no-embed-thumbnail Do not embed thumbnail (default)
1dc2726f 569 --add-metadata Write metadata to the video file
6623ac34 570 --no-add-metadata Do not write metadata (default)
c4af7684
PH
571 --metadata-from-title FORMAT Parse additional metadata like song title /
572 artist from the video title. The format
6f3c632c
S
573 syntax is the same as --output. Regular
574 expression with named capture groups may
575 also be used. The parsed parameters replace
576 existing values. Example: --metadata-from-
577 title "%(artist)s - %(title)s" matches a
578 title like "Coldplay - Paradise". Example
579 (regex): --metadata-from-title
580 "(?P<artist>.+?) - (?P<title>.+)"
c4af7684
PH
581 --xattrs Write metadata to the video file's xattrs
582 (using dublin core and xdg standards)
583 --fixup POLICY Automatically correct known faults of the
584 file. One of never (do nothing), warn (only
585 emit a warning), detect_or_warn (the
586 default; fix file if we can, warn
587 otherwise)
588 --prefer-avconv Prefer avconv over ffmpeg for running the
6623ac34 589 postprocessors (Same as --no-prefer-ffmpeg)
689af496
S
590 --prefer-ffmpeg Prefer ffmpeg over avconv for running the
591 postprocessors (default)
6623ac34 592 (Same as --no-prefer-avconv)
c4af7684
PH
593 --ffmpeg-location PATH Location of the ffmpeg/avconv binary;
594 either the path to the binary or its
595 containing directory.
596 --exec CMD Execute a command on the file after
00a41ca4
S
597 downloading and post-processing, similar to
598 find's -exec syntax. Example: --exec 'adb
599 push {} /sdcard/Music/ && rm {}'
7de81fcc 600 --convert-subs FORMAT Convert the subtitles to other format
9fc41bcb 601 (currently supported: srt|ass|vtt|lrc)
6bcd846b 602
c76eb41b 603## [SponSkrub](https://github.com/faissaloo/SponSkrub) Options ([SponsorBlock](https://sponsor.ajay.app)):
604 --sponskrub Use sponskrub to mark sponsored sections
605 with the data available in SponsorBlock
606 API. This is enabled by default if the
607 sponskrub binary exists (Youtube only)
608 --no-sponskrub Do not use sponskrub
a9e7f546 609 --sponskrub-cut Cut out the sponsor sections instead of
610 simply marking them
6623ac34 611 --no-sponskrub-cut Simply mark the sponsor sections, not cut
612 them out (default)
c76eb41b 613 --sponskrub-force Run sponskrub even if the video was already
614 downloaded
6623ac34 615 --no-sponskrub-force Do not cut out the sponsor sections if the
616 video was already downloaded (default)
c76eb41b 617 --sponskrub-location PATH Location of the sponskrub binary; either
618 the path to the binary or its containing
619 directory.
a9e7f546 620
78895bd3 621## Extractor Options:
17cb02d0 622 --ignore-dynamic-mpd Do not process dynamic DASH manifests
6623ac34 623 (Same as --no-allow-dynamic-mpd)
624 --allow-dynamic-mpd Process dynamic DASH manifests (default)
625 (Same as --no-ignore-dynamic-mpd)
17cb02d0 626
b7770046
U
627# CONFIGURATION
628
629You can configure youtube-dlc by placing any supported command line option to a configuration file. On Linux and macOS, the system wide configuration file is located at `/etc/youtube-dlc.conf` and the user wide configuration file at `~/.config/youtube-dlc/config`. On Windows, the user wide configuration file locations are `%APPDATA%\youtube-dlc\config.txt` or `C:\Users\<user name>\youtube-dlc.conf`. Note that by default configuration file may not exist so you may need to create it yourself.
630
631For example, with the following configuration file youtube-dlc will always extract the audio, not copy the mtime, use a proxy and save all videos under `Movies` directory in your home directory:
632```
633# Lines starting with # are comments
634
635# Always extract audio
636-x
637
638# Do not copy the mtime
639--no-mtime
640
641# Use this proxy
642--proxy 127.0.0.1:3128
643
644# Save all videos under Movies directory in your home directory
645-o ~/Movies/%(title)s.%(ext)s
646```
647
648Note 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`.
649
650You can use `--ignore-config` if you want to disable the configuration file for a particular youtube-dlc run.
651
652You can also use `--config-location` if you want to use custom configuration file for a particular youtube-dlc run.
653
654### Authentication with `.netrc` file
655
656You 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 youtube-dlc 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 your `$HOME` and restrict permissions to read/write by only you:
657```
658touch $HOME/.netrc
659chmod a-rwx,u+rw $HOME/.netrc
660```
661After that you can add credentials for an extractor in the following format, where *extractor* is the name of the extractor in lowercase:
662```
663machine <extractor> login <login> password <password>
664```
665For example:
666```
667machine youtube login myaccount@gmail.com password my_youtube_password
668machine twitch login my_twitch_account_name password my_twitch_password
669```
670To activate authentication with the `.netrc` file you should pass `--netrc` to youtube-dlc or place it in the [configuration file](#configuration).
671
672On Windows you may also need to setup the `%HOME%` environment variable manually. For example:
673```
674set HOME=%USERPROFILE%
675```
676
677# OUTPUT TEMPLATE
678
679The `-o` option allows users to indicate a template for the output file names.
680
681**tl;dr:** [navigate me to examples](#output-template-examples).
682
683The basic usage is not to set any template arguments when downloading a single file, like in `youtube-dlc -o funny_video.flv "https://some/video"`. However, it may contain special sequences that will be replaced when downloading each video. The special sequences may be formatted according to [python string formatting operations](https://docs.python.org/2/library/stdtypes.html#string-formatting). For example, `%(NAME)s` or `%(NAME)05d`. To clarify, that is a percent symbol followed by a name in parentheses, followed by formatting operations. Allowed names along with sequence type are:
684
685 - `id` (string): Video identifier
686 - `title` (string): Video title
687 - `url` (string): Video URL
688 - `ext` (string): Video filename extension
689 - `alt_title` (string): A secondary title of the video
690 - `display_id` (string): An alternative identifier for the video
691 - `uploader` (string): Full name of the video uploader
692 - `license` (string): License name the video is licensed under
693 - `creator` (string): The creator of the video
694 - `release_date` (string): The date (YYYYMMDD) when the video was released
695 - `timestamp` (numeric): UNIX timestamp of the moment the video became available
696 - `upload_date` (string): Video upload date (YYYYMMDD)
697 - `uploader_id` (string): Nickname or id of the video uploader
698 - `channel` (string): Full name of the channel the video is uploaded on
699 - `channel_id` (string): Id of the channel
700 - `location` (string): Physical location where the video was filmed
701 - `duration` (numeric): Length of the video in seconds
dbbbe555 702 - `duration_string` (string): Length of the video (HH-mm-ss)
b7770046
U
703 - `view_count` (numeric): How many users have watched the video on the platform
704 - `like_count` (numeric): Number of positive ratings of the video
705 - `dislike_count` (numeric): Number of negative ratings of the video
706 - `repost_count` (numeric): Number of reposts of the video
707 - `average_rating` (numeric): Average rating give by users, the scale used depends on the webpage
708 - `comment_count` (numeric): Number of comments on the video
709 - `age_limit` (numeric): Age restriction for the video (years)
710 - `is_live` (boolean): Whether this video is a live stream or a fixed-length video
711 - `start_time` (numeric): Time in seconds where the reproduction should start, as specified in the URL
712 - `end_time` (numeric): Time in seconds where the reproduction should end, as specified in the URL
713 - `format` (string): A human-readable description of the format
714 - `format_id` (string): Format code specified by `--format`
715 - `format_note` (string): Additional info about the format
716 - `width` (numeric): Width of the video
717 - `height` (numeric): Height of the video
718 - `resolution` (string): Textual description of width and height
719 - `tbr` (numeric): Average bitrate of audio and video in KBit/s
720 - `abr` (numeric): Average audio bitrate in KBit/s
721 - `acodec` (string): Name of the audio codec in use
722 - `asr` (numeric): Audio sampling rate in Hertz
723 - `vbr` (numeric): Average video bitrate in KBit/s
724 - `fps` (numeric): Frame rate
725 - `vcodec` (string): Name of the video codec in use
726 - `container` (string): Name of the container format
727 - `filesize` (numeric): The number of bytes, if known in advance
728 - `filesize_approx` (numeric): An estimate for the number of bytes
729 - `protocol` (string): The protocol that will be used for the actual download
730 - `extractor` (string): Name of the extractor
731 - `extractor_key` (string): Key name of the extractor
732 - `epoch` (numeric): Unix epoch when creating the file
733 - `autonumber` (numeric): Number that will be increased with each download, starting at `--autonumber-start`
734 - `playlist` (string): Name or id of the playlist that contains the video
735 - `playlist_index` (numeric): Index of the video in the playlist padded with leading zeros according to the total length of the playlist
736 - `playlist_id` (string): Playlist identifier
737 - `playlist_title` (string): Playlist title
738 - `playlist_uploader` (string): Full name of the playlist uploader
739 - `playlist_uploader_id` (string): Nickname or id of the playlist uploader
740
741Available for the video that belongs to some logical chapter or section:
742
743 - `chapter` (string): Name or title of the chapter the video belongs to
744 - `chapter_number` (numeric): Number of the chapter the video belongs to
745 - `chapter_id` (string): Id of the chapter the video belongs to
746
747Available for the video that is an episode of some series or programme:
748
749 - `series` (string): Title of the series or programme the video episode belongs to
750 - `season` (string): Title of the season the video episode belongs to
751 - `season_number` (numeric): Number of the season the video episode belongs to
752 - `season_id` (string): Id of the season the video episode belongs to
753 - `episode` (string): Title of the video episode
754 - `episode_number` (numeric): Number of the video episode within a season
755 - `episode_id` (string): Id of the video episode
756
757Available for the media that is a track or a part of a music album:
758
759 - `track` (string): Title of the track
760 - `track_number` (numeric): Number of the track within an album or a disc
761 - `track_id` (string): Id of the track
762 - `artist` (string): Artist(s) of the track
763 - `genre` (string): Genre(s) of the track
764 - `album` (string): Title of the album the track belongs to
765 - `album_type` (string): Type of the album
766 - `album_artist` (string): List of all artists appeared on the album
767 - `disc_number` (numeric): Number of the disc or other physical medium the track belongs to
768 - `release_year` (numeric): Year (YYYY) when the album was released
769
770Each aforementioned sequence when referenced in an output template will be replaced by the actual value corresponding to the sequence name. Note that some of the sequences are not guaranteed to be present since they depend on the metadata obtained by a particular extractor. Such sequences will be replaced with `NA`.
771
772For example for `-o %(title)s-%(id)s.%(ext)s` and an mp4 video with title `youtube-dlc test video` and id `BaW_jenozKcj`, this will result in a `youtube-dlc test video-BaW_jenozKcj.mp4` file created in the current directory.
773
774For numeric sequences you can use numeric related formatting, for example, `%(view_count)05d` will result in a string with view count padded with zeros up to 5 characters, like in `00042`.
775
776Output 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.
777
778To use percent literals in an output template use `%%`. To output to stdout use `-o -`.
779
91ebc640 780The current default template is `%(title)s [%(id)s].%(ext)s`.
b7770046
U
781
782In 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:
783
784#### Output template and Windows batch files
785
786If 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"`.
787
788#### Output template examples
789
790Note that on Windows you may need to use double quotes instead of single.
791
792```bash
793$ youtube-dlc --get-filename -o '%(title)s.%(ext)s' BaW_jenozKc
794youtube-dlc test video ''_ä↭𝕐.mp4 # All kinds of weird characters
795
796$ youtube-dlc --get-filename -o '%(title)s.%(ext)s' BaW_jenozKc --restrict-filenames
797youtube-dlc_test_video_.mp4 # A simple file name
798
799# Download YouTube playlist videos in separate directory indexed by video order in a playlist
800$ youtube-dlc -o '%(playlist)s/%(playlist_index)s - %(title)s.%(ext)s' https://www.youtube.com/playlist?list=PLwiyx1dc3P2JR9N8gQaQN_BCvlSlap7re
801
802# Download all playlists of YouTube channel/user keeping each playlist in separate directory:
803$ youtube-dlc -o '%(uploader)s/%(playlist)s/%(playlist_index)s - %(title)s.%(ext)s' https://www.youtube.com/user/TheLinuxFoundation/playlists
804
805# Download Udemy course keeping each chapter in separate directory under MyVideos directory in your home
806$ youtube-dlc -u user -p password -o '~/MyVideos/%(playlist)s/%(chapter_number)s - %(chapter)s/%(title)s.%(ext)s' https://www.udemy.com/java-tutorial/
807
808# Download entire series season keeping each series and each season in separate directory under C:/MyVideos
809$ youtube-dlc -o "C:/MyVideos/%(series)s/%(season_number)s - %(season)s/%(episode_number)s - %(episode)s.%(ext)s" https://videomore.ru/kino_v_detalayah/5_sezon/367617
810
811# Stream the video being downloaded to stdout
812$ youtube-dlc -o - BaW_jenozKc
813```
814
815# FORMAT SELECTION
816
c2b5f311 817By default, youtube-dlc tries to download the best available quality if you **don't** pass any options.
91ebc640 818This 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 and avconv are unavailable, or if you use youtube-dlc to stream to `stdout` (`-o -`), the default becomes `-f best/bestvideo+bestaudio`.
b7770046 819
c2b5f311 820The 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.
b7770046
U
821
822**tl;dr:** [navigate me to examples](#format-selection-examples).
823
824The 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.
825
826You 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.
827
828You can also use special names to select particular edge case formats:
829
909d24dd 830 - `b*`, `best*`: Select the best quality format irrespective of whether it contains video or audio.
831 - `w*`, `worst*`: Select the worst quality format irrespective of whether it contains video or audio.
909d24dd 832 - `b`, `best`: Select the best quality format that contains both video and audio. Equivalent to `best*[vcodec!=none][acodec!=none]`
833 - `w`, `worst`: Select the worst quality format that contains both video and audio. Equivalent to `worst*[vcodec!=none][acodec!=none]`
909d24dd 834 - `bv`, `bestvideo`: Select the best quality video-only format. Equivalent to `best*[acodec=none]`
835 - `wv`, `worstvideo`: Select the worst quality video-only format. Equivalent to `worst*[acodec=none]`
909d24dd 836 - `bv*`, `bestvideo*`: Select the best quality format that contains video. It may also contain audio. Equivalent to `best*[vcodec!=none]`
837 - `wv*`, `worstvideo*`: Select the worst quality format that contains video. It may also contain audio. Equivalent to `worst*[vcodec!=none]`
909d24dd 838 - `ba`, `bestaudio`: Select the best quality audio-only format. Equivalent to `best*[vcodec=none]`
839 - `wa`, `worstaudio`: Select the worst quality audio-only format. Equivalent to `worst*[vcodec=none]`
909d24dd 840 - `ba*`, `bestaudio*`: Select the best quality format that contains audio. It may also contain video. Equivalent to `best*[acodec!=none]`
841 - `wa*`, `worstaudio*`: Select the worst quality format that contains audio. It may also contain video. Equivalent to `worst*[acodec!=none]`
b7770046 842
c2b5f311 843For example, to download the worst quality video-only format you can use `-f worstvideo`. It is however recomended to never actually 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.
b7770046 844
eb8a4433 845If 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.
b7770046
U
846
847If 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`.
848
909d24dd 849You can merge the video and audio of multiple formats into a single file using `-f <format1>+<format2>+...` (requires ffmpeg or avconv installed), for example `-f bestvideo+bestaudio` will download the best video-only format, the best audio-only format and mux them together with ffmpeg/avconv. If `--no-video-multistreams` is used, all formats with a video stream except the first one are ignored. Similarly, if `--no-audio-multistreams` is used, all formats with an audio stream except the first one are ignored. For example, `-f bestvideo+best+bestaudio` 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`.
eb8a4433 850
851## Filtering Formats
852
b7770046
U
853You can also filter the video formats by putting a condition in brackets, as in `-f "best[height=720]"` (or `-f "[filesize>10M]"`).
854
855The following numeric meta fields can be used with comparisons `<`, `<=`, `>`, `>=`, `=` (equals), `!=` (not equals):
856
857 - `filesize`: The number of bytes, if known in advance
858 - `width`: Width of the video, if known
859 - `height`: Height of the video, if known
860 - `tbr`: Average bitrate of audio and video in KBit/s
861 - `abr`: Average audio bitrate in KBit/s
862 - `vbr`: Average video bitrate in KBit/s
863 - `asr`: Audio sampling rate in Hertz
864 - `fps`: Frame rate
865
866Also filtering work for comparisons `=` (equals), `^=` (starts with), `$=` (ends with), `*=` (contains) and following string meta fields:
867
868 - `ext`: File extension
869 - `acodec`: Name of the audio codec in use
870 - `vcodec`: Name of the video codec in use
871 - `container`: Name of the container format
872 - `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`)
873 - `format_id`: A short description of the format
29f7c58a 874 - `language`: Language code
b7770046
U
875
876Any string comparison may be prefixed with negation `!` in order to produce an opposite comparison, e.g. `!*=` (does not contain).
877
f96bff99 878Note 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 video hoster. Any other field made available by the extractor can also be used for filtering.
b7770046
U
879
880Formats 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.
881
b7770046
U
882Format 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]'`.
883
eb8a4433 884## Sorting Formats
885
886You can change the criteria for being considered the `best` by using `-S` (`--format-sort`). The general format for this is `--format-sort field1,field2...`. The available fields are:
887
888 - `video`, `has_video`: Gives priority to formats that has a video stream
889 - `audio`, `has_audio`: Gives priority to formats that has a audio stream
890 - `extractor`, `preference`, `extractor_preference`: The format preference as given by the extractor
891 - `lang`, `language_preference`: Language preference as given by the extractor
892 - `quality`: The quality of the format. This is a metadata field available in some websites
893 - `source`, `source_preference`: Preference of the source as given by the extractor
894 - `proto`, `protocol`: Protocol used for download (`https`/`ftps` > `http`/`ftp` > `m3u8-native` > `m3u8` > `http-dash-segments` > other > `mms`/`rtsp` > unknown > `f4f`/`f4m`)
7fd86ce1 895 - `vcodec`, `video_codec`: Video Codec (`vp9` > `h265` > `h264` > `vp8` > `h263` > `theora` > other > unknown)
eb8a4433 896 - `acodec`, `audio_codec`: Audio Codec (`opus` > `vorbis` > `aac` > `mp4a` > `mp3` > `ac3` > `dts` > other > unknown)
897 - `codec`: Equivalent to `vcodec,acodec`
c76eb41b 898 - `vext`, `video_ext`: Video Extension (`mp4` > `webm` > `flv` > other > unknown). If `--prefer-free-formats` is used, `webm` is prefered.
eb8a4433 899 - `aext`, `audio_ext`: 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`.
900 - `ext`, `extension`: Equivalent to `vext,aext`
901 - `filesize`: Exact filesize, if know in advance. This will be unavailable for mu38 and DASH formats.
2af884ff 902 - `filesize_approx`: Approximate filesize calculated from the manifests
eb8a4433 903 - `size`, `filesize_estimate`: Exact filesize if available, otherwise approximate filesize
904 - `height`: Height of video
905 - `width`: Width of video
906 - `res`, `dimension`: Video resolution, calculated as the smallest dimension.
907 - `fps`, `framerate`: Framerate of video
908 - `tbr`, `total_bitrate`: Total average bitrate in KBit/s
909 - `vbr`, `video_bitrate`: Average video bitrate in KBit/s
910 - `abr`, `audio_bitrate`: Average audio bitrate in KBit/s
911 - `br`, `bitrate`: Equivalent to using `tbr,vbr,abr`
912 - `samplerate`, `asr`: Audio sample rate in Hz
913
7fd86ce1 914Note that any other **numerical** field made available by the extractor can also be used. All fields, unless specified otherwise, are sorted in decending order. To reverse this, prefix the field with a `+`. Eg: `+res` prefers format with the smallest resolution. Additionally, you can suffix a prefered value for the fields, seperated 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 prefered 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` > `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.
eb8a4433 915
2af884ff 916The fields `has_video`, `extractor`, `lang`, `quality` are always given highest priority in sorting, irrespective of the user-defined order. This behaviour can be changed by using `--force-format-sort`. Apart from these, the default order used is: `res,fps,codec,size,br,asr,proto,ext,has_audio,source,format_id`. Note that the extractors may override this default order, but they cannot override the user-provided order.
eb8a4433 917
918If your format selector is `worst`, the last item is selected after sorting. This means it will select the format that is worst in all repects. 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`.
919
920**Tip**: You can use the `-v -F` to see how the formats have been sorted (worst to best).
921
eb8a4433 922## Format Selection examples
b7770046
U
923
924Note that on Windows you may need to use double quotes instead of single.
925
926```bash
909d24dd 927# Download and merge the best best video-only format and the best audio-only format,
928# or download the best combined format if video-only format is not available
2af884ff 929$ youtube-dlc -f 'bv+ba/b'
909d24dd 930
931# Download best format that contains video,
932# and if it doesn't already have an audio stream, merge it with best audio-only format
2af884ff 933$ youtube-dlc -f 'bv*+ba/b'
934
935# Same as above
936$ youtube-dlc
909d24dd 937
6fd35a11 938# Download the best video-only format and the best audio-only format without merging them
939# For this case, an output template should be used since
940# by default, bestvideo and bestaudio will have the same file name.
941$ youtube-dlc -f 'bv,ba' -o '%(title)s.f%(format_id)s.%(ext)s'
909d24dd 942
943
6fd35a11 944
945# The following examples show the old method (without -S) of format selection
946# and how to use -S to achieve a similar but better result
947
948# Download the worst video available (old method)
2af884ff 949$ youtube-dlc -f 'wv*+wa/w'
eb8a4433 950
951# Download the best video available but with the smallest resolution
952$ youtube-dlc -S '+res'
953
954# Download the smallest video available
955$ youtube-dlc -S '+size,+bitrate'
956
957
909d24dd 958
eb8a4433 959# Download the best mp4 video available, or the best video if no mp4 available
2af884ff 960$ youtube-dlc -f 'bv*[ext=mp4]+ba[ext=m4a]/b[ext=mp4] / bv*+ba/b'
eb8a4433 961
962# Download the best video with the best extension
963# (For video, mp4 > webm > flv. For audio, m4a > aac > mp3 ...)
964$ youtube-dlc -S 'ext'
965
966
909d24dd 967
eb8a4433 968# Download the best video available but no better than 480p,
969# or the worst video if there is no video under 480p
2af884ff 970$ youtube-dlc -f 'bv*[height<=480]+ba/b[height<=480] / wv*+ba/w'
b7770046 971
eb8a4433 972# Download the best video available with the largest height but no better than 480p,
973# or the best video with the smallest resolution if there is no video under 480p
974$ youtube-dlc -S 'height:480'
b7770046 975
eb8a4433 976# Download the best video available with the largest resolution but no better than 480p,
977# or the best video with the smallest resolution if there is no video under 480p
978# Resolution is determined by using the smallest dimension.
979# So this works correctly for vertical videos as well
980$ youtube-dlc -S 'res:480'
b7770046 981
b7770046 982
909d24dd 983
eb8a4433 984# Download the best video (that also has audio) but no bigger than 50 MB,
985# or the worst video (that also has audio) if there is no video under 50 MB
2af884ff 986$ youtube-dlc -f 'b[filesize<50M] / w'
eb8a4433 987
988# Download largest video (that also has audio) but no bigger than 50 MB,
989# or the smallest video (that also has audio) if there is no video under 50 MB
2af884ff 990$ youtube-dlc -f 'b' -S 'filesize:50M'
eb8a4433 991
992# Download best video (that also has audio) that is closest in size to 50 MB
2af884ff 993$ youtube-dlc -f 'b' -S 'filesize~50M'
eb8a4433 994
995
909d24dd 996
eb8a4433 997# Download best video available via direct link over HTTP/HTTPS protocol,
998# or the best video available via any protocol if there is no such video
2af884ff 999$ youtube-dlc -f '(bv*+ba/b)[protocol^=http][protocol!*=dash] / (bv*+ba/b)'
eb8a4433 1000
1001# Download best video available via the best protocol
1002# (https/ftps > http/ftp > m3u8_native > m3u8 > http_dash_segments ...)
1003$ youtube-dlc -S 'protocol'
1004
1005
909d24dd 1006
eb8a4433 1007# Download the best video with h264 codec, or the best video if there is no such video
2af884ff 1008$ youtube-dlc -f '(bv*+ba/b)[vcodec^=avc1] / (bv*+ba/b)'
eb8a4433 1009
1010# Download the best video with best codec no better than h264,
1011# or the best video with worst codec if there is no such video
1012$ youtube-dlc -S 'codec:h264'
1013
1014# Download the best video with worst codec no worse than h264,
1015# or the best video with best codec if there is no such video
1016$ youtube-dlc -S '+codec:h264'
1017
1018
1019
1020# More complex examples
1021
1022# Download the best video no better than 720p prefering framerate greater than 30,
2af884ff 1023# or the worst video (still prefering framerate greater than 30) if there is no such video
1024$ youtube-dlc -f '((bv*[fps>30]/bv*)[height<=720]/(wv*[fps>30]/wv*)) + ba / (b[fps>30]/b)[height<=720]/(w[fps>30]/w)'
eb8a4433 1025
1026# Download the video with the largest resolution no better than 720p,
1027# or the video with the smallest resolution available if there is no such video,
1028# prefering larger framerate for formats with the same resolution
1029$ youtube-dlc -S 'res:720,fps'
1030
1031
909d24dd 1032
eb8a4433 1033# Download the video with smallest resolution no worse than 480p,
1034# or the video with the largest resolution available if there is no such video,
1035# prefering better codec and then larger total bitrate for the same resolution
1036$ youtube-dlc -S '+res:480,codec,br'
b7770046 1037```
eb8a4433 1038
b7770046
U
1039
1040
b7770046 1041
b7770046 1042
c2b5f311 1043# MORE
2af884ff 1044For FAQ, Developer Instructions etc., see the [original README](https://github.com/ytdl-org/youtube-dl)