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