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