1 youtube-dl - download videos from youtube.com or other video platforms
3 - [INSTALLATION](#installation)
4 - [DESCRIPTION](#description)
6 - [CONFIGURATION](#configuration)
7 - [OUTPUT TEMPLATE](#output-template)
8 - [FORMAT SELECTION](#format-selection)
9 - [VIDEO SELECTION](#video-selection)
11 - [DEVELOPER INSTRUCTIONS](#developer-instructions)
12 - [EMBEDDING YOUTUBE-DL](#embedding-youtube-dl)
14 - [COPYRIGHT](#copyright)
18 To install it right away for all UNIX users (Linux, OS X, etc.), type:
20 sudo curl -L https://yt-dl.org/downloads/latest/youtube-dl -o /usr/local/bin/youtube-dl
21 sudo chmod a+rx /usr/local/bin/youtube-dl
23 If you do not have curl, you can alternatively use a recent wget:
25 sudo wget https://yt-dl.org/downloads/latest/youtube-dl -O /usr/local/bin/youtube-dl
26 sudo chmod a+rx /usr/local/bin/youtube-dl
28 Windows users can [download an .exe file](https://yt-dl.org/latest/youtube-dl.exe) and place it in any location on their [PATH](http://en.wikipedia.org/wiki/PATH_%28variable%29) except for `%SYSTEMROOT%\System32` (e.g. **do not** put in `C:\Windows\System32`).
32 sudo pip install --upgrade youtube-dl
34 This command will update youtube-dl if you have already installed it. See the [pypi page](https://pypi.python.org/pypi/youtube_dl) for more information.
36 OS X users can install youtube-dl with [Homebrew](http://brew.sh/):
38 brew install youtube-dl
40 Or with [MacPorts](https://www.macports.org/):
42 sudo port install youtube-dl
44 Alternatively, refer to the [developer instructions](#developer-instructions) for how to check out and work with the git repository. For further options, including PGP signatures, see the [youtube-dl Download Page](https://rg3.github.io/youtube-dl/download.html).
47 **youtube-dl** is a command-line program to download videos from
48 YouTube.com and a few more sites. It requires the Python interpreter, version
49 2.6, 2.7, or 3.2+, and it is not platform specific. It should work on
50 your Unix box, on Windows or on Mac OS X. It is released to the public domain,
51 which means you can modify it, redistribute it or use it however you like.
53 youtube-dl [OPTIONS] URL [URL...]
56 -h, --help Print this help text and exit
57 --version Print program version and exit
58 -U, --update Update this program to latest version. Make
59 sure that you have sufficient permissions
60 (run with sudo if needed)
61 -i, --ignore-errors Continue on download errors, for example to
62 skip unavailable videos in a playlist
63 --abort-on-error Abort downloading of further videos (in the
64 playlist or the command line) if an error
66 --dump-user-agent Display the current browser identification
67 --list-extractors List all supported extractors
68 --extractor-descriptions Output descriptions of all supported
70 --force-generic-extractor Force extraction to use the generic
72 --default-search PREFIX Use this prefix for unqualified URLs. For
73 example "gvsearch2:" downloads two videos
74 from google videos for youtube-dl "large
75 apple". Use the value "auto" to let
76 youtube-dl guess ("auto_warning" to emit a
77 warning when guessing). "error" just throws
78 an error. The default value "fixup_error"
79 repairs broken URLs, but emits an error if
80 this is not possible instead of searching.
81 --ignore-config Do not read configuration files. When given
82 in the global configuration file
83 /etc/youtube-dl.conf: Do not read the user
84 configuration in ~/.config/youtube-
85 dl/config (%APPDATA%/youtube-dl/config.txt
87 --flat-playlist Do not extract the videos of a playlist,
89 --mark-watched Mark videos watched (YouTube only)
90 --no-mark-watched Do not mark videos watched (YouTube only)
91 --no-color Do not emit color codes in output
94 --proxy URL Use the specified HTTP/HTTPS/SOCKS proxy.
95 To enable experimental SOCKS proxy, specify
96 a proper scheme. For example
97 socks5://127.0.0.1:1080/. Pass in an empty
98 string (--proxy "") for direct connection
99 --socket-timeout SECONDS Time to wait before giving up, in seconds
100 --source-address IP Client-side IP address to bind to
102 -4, --force-ipv4 Make all connections via IPv4
104 -6, --force-ipv6 Make all connections via IPv6
106 --geo-verification-proxy URL Use this proxy to verify the IP address for
107 some geo-restricted sites. The default
108 proxy specified by --proxy (or none, if the
109 options is not present) is used for the
110 actual downloading. (experimental)
113 --playlist-start NUMBER Playlist video to start at (default is 1)
114 --playlist-end NUMBER Playlist video to end at (default is last)
115 --playlist-items ITEM_SPEC Playlist video items to download. Specify
116 indices of the videos in the playlist
117 separated by commas like: "--playlist-items
118 1,2,5,8" if you want to download videos
119 indexed 1, 2, 5, 8 in the playlist. You can
120 specify range: "--playlist-items
121 1-3,7,10-13", it will download the videos
122 at index 1, 2, 3, 7, 10, 11, 12 and 13.
123 --match-title REGEX Download only matching titles (regex or
125 --reject-title REGEX Skip download for matching titles (regex or
127 --max-downloads NUMBER Abort after downloading NUMBER files
128 --min-filesize SIZE Do not download any videos smaller than
129 SIZE (e.g. 50k or 44.6m)
130 --max-filesize SIZE Do not download any videos larger than SIZE
132 --date DATE Download only videos uploaded in this date
133 --datebefore DATE Download only videos uploaded on or before
134 this date (i.e. inclusive)
135 --dateafter DATE Download only videos uploaded on or after
136 this date (i.e. inclusive)
137 --min-views COUNT Do not download any videos with less than
139 --max-views COUNT Do not download any videos with more than
141 --match-filter FILTER Generic video filter (experimental).
142 Specify any key (see help for -o for a list
143 of available keys) to match if the key is
144 present, !key to check if the key is not
145 present,key > NUMBER (like "comment_count >
146 12", also works with >=, <, <=, !=, =) to
147 compare against a number, and & to require
148 multiple matches. Values which are not
149 known are excluded unless you put a
150 question mark (?) after the operator.For
151 example, to only match videos that have
152 been liked more than 100 times and disliked
153 less than 50 times (or the dislike
154 functionality is not available at the given
155 service), but who also have a description,
156 use --match-filter "like_count > 100 &
157 dislike_count <? 50 & description" .
158 --no-playlist Download only the video, if the URL refers
159 to a video and a playlist.
160 --yes-playlist Download the playlist, if the URL refers to
161 a video and a playlist.
162 --age-limit YEARS Download only videos suitable for the given
164 --download-archive FILE Download only videos not listed in the
165 archive file. Record the IDs of all
166 downloaded videos in it.
167 --include-ads Download advertisements as well
171 -r, --limit-rate RATE Maximum download rate in bytes per second
173 -R, --retries RETRIES Number of retries (default is 10), or
175 --fragment-retries RETRIES Number of retries for a fragment (default
176 is 10), or "infinite" (DASH only)
177 --buffer-size SIZE Size of download buffer (e.g. 1024 or 16K)
179 --no-resize-buffer Do not automatically adjust the buffer
180 size. By default, the buffer size is
181 automatically resized from an initial value
183 --playlist-reverse Download playlist videos in reverse order
184 --xattr-set-filesize Set file xattribute ytdl.filesize with
185 expected filesize (experimental)
186 --hls-prefer-native Use the native HLS downloader instead of
188 --hls-prefer-ffmpeg Use ffmpeg instead of the native HLS
190 --hls-use-mpegts Use the mpegts container for HLS videos,
191 allowing to play the video while
192 downloading (some players may not be able
194 --external-downloader COMMAND Use the specified external downloader.
196 aria2c,avconv,axel,curl,ffmpeg,httpie,wget
197 --external-downloader-args ARGS Give these arguments to the external
200 ## Filesystem Options:
201 -a, --batch-file FILE File containing URLs to download ('-' for
203 --id Use only video ID in file name
204 -o, --output TEMPLATE Output filename template, see the "OUTPUT
205 TEMPLATE" for all the info
206 --autonumber-size NUMBER Specify the number of digits in
207 %(autonumber)s when it is present in output
208 filename template or --auto-number option
210 --restrict-filenames Restrict filenames to only ASCII
211 characters, and avoid "&" and spaces in
213 -A, --auto-number [deprecated; use -o
214 "%(autonumber)s-%(title)s.%(ext)s" ] Number
215 downloaded files starting from 00000
216 -t, --title [deprecated] Use title in file name
218 -l, --literal [deprecated] Alias of --title
219 -w, --no-overwrites Do not overwrite files
220 -c, --continue Force resume of partially downloaded files.
221 By default, youtube-dl will resume
222 downloads if possible.
223 --no-continue Do not resume partially downloaded files
224 (restart from beginning)
225 --no-part Do not use .part files - write directly
227 --no-mtime Do not use the Last-modified header to set
228 the file modification time
229 --write-description Write video description to a .description
231 --write-info-json Write video metadata to a .info.json file
232 --write-annotations Write video annotations to a
233 .annotations.xml file
234 --load-info-json FILE JSON file containing the video information
235 (created with the "--write-info-json"
237 --cookies FILE File to read cookies from and dump cookie
239 --cache-dir DIR Location in the filesystem where youtube-dl
240 can store some downloaded information
241 permanently. By default
242 $XDG_CACHE_HOME/youtube-dl or
243 ~/.cache/youtube-dl . At the moment, only
244 YouTube player files (for videos with
245 obfuscated signatures) are cached, but that
247 --no-cache-dir Disable filesystem caching
248 --rm-cache-dir Delete all filesystem cache files
251 --write-thumbnail Write thumbnail image to disk
252 --write-all-thumbnails Write all thumbnail image formats to disk
253 --list-thumbnails Simulate and list all available thumbnail
256 ## Verbosity / Simulation Options:
257 -q, --quiet Activate quiet mode
258 --no-warnings Ignore warnings
259 -s, --simulate Do not download the video and do not write
261 --skip-download Do not download the video
262 -g, --get-url Simulate, quiet but print URL
263 -e, --get-title Simulate, quiet but print title
264 --get-id Simulate, quiet but print id
265 --get-thumbnail Simulate, quiet but print thumbnail URL
266 --get-description Simulate, quiet but print video description
267 --get-duration Simulate, quiet but print video length
268 --get-filename Simulate, quiet but print output filename
269 --get-format Simulate, quiet but print output format
270 -j, --dump-json Simulate, quiet but print JSON information.
271 See --output for a description of available
273 -J, --dump-single-json Simulate, quiet but print JSON information
274 for each command-line argument. If the URL
275 refers to a playlist, dump the whole
276 playlist information in a single line.
277 --print-json Be quiet and print the video information as
278 JSON (video is still being downloaded).
279 --newline Output progress bar as new lines
280 --no-progress Do not print progress bar
281 --console-title Display progress in console titlebar
282 -v, --verbose Print various debugging information
283 --dump-pages Print downloaded pages encoded using base64
284 to debug problems (very verbose)
285 --write-pages Write downloaded intermediary pages to
286 files in the current directory to debug
288 --print-traffic Display sent and read HTTP traffic
289 -C, --call-home Contact the youtube-dl server for debugging
290 --no-call-home Do NOT contact the youtube-dl server for
294 --encoding ENCODING Force the specified encoding (experimental)
295 --no-check-certificate Suppress HTTPS certificate validation
296 --prefer-insecure Use an unencrypted connection to retrieve
297 information about the video. (Currently
298 supported only for YouTube)
299 --user-agent UA Specify a custom user agent
300 --referer URL Specify a custom referer, use if the video
301 access is restricted to one domain
302 --add-header FIELD:VALUE Specify a custom HTTP header and its value,
303 separated by a colon ':'. You can use this
304 option multiple times
305 --bidi-workaround Work around terminals that lack
306 bidirectional text support. Requires bidiv
307 or fribidi executable in PATH
308 --sleep-interval SECONDS Number of seconds to sleep before each
309 download when used alone or a lower bound
310 of a range for randomized sleep before each
311 download (minimum possible number of
312 seconds to sleep) when used along with
313 --max-sleep-interval.
314 --max-sleep-interval SECONDS Upper bound of a range for randomized sleep
315 before each download (maximum possible
316 number of seconds to sleep). Must only be
317 used along with --min-sleep-interval.
319 ## Video Format Options:
320 -f, --format FORMAT Video format code, see the "FORMAT
321 SELECTION" for all the info
322 --all-formats Download all available video formats
323 --prefer-free-formats Prefer free video formats unless a specific
325 -F, --list-formats List all available formats of requested
327 --youtube-skip-dash-manifest Do not download the DASH manifests and
328 related data on YouTube videos
329 --merge-output-format FORMAT If a merge is required (e.g.
330 bestvideo+bestaudio), output to given
331 container format. One of mkv, mp4, ogg,
332 webm, flv. Ignored if no merge is required
335 --write-sub Write subtitle file
336 --write-auto-sub Write automatically generated subtitle file
338 --all-subs Download all the available subtitles of the
340 --list-subs List all available subtitles for the video
341 --sub-format FORMAT Subtitle format, accepts formats
342 preference, for example: "srt" or
344 --sub-lang LANGS Languages of the subtitles to download
345 (optional) separated by commas, use --list-
346 subs for available language tags
348 ## Authentication Options:
349 -u, --username USERNAME Login with this account ID
350 -p, --password PASSWORD Account password. If this option is left
351 out, youtube-dl will ask interactively.
352 -2, --twofactor TWOFACTOR Two-factor auth code
353 -n, --netrc Use .netrc authentication data
354 --video-password PASSWORD Video password (vimeo, smotri, youku)
356 ## Post-processing Options:
357 -x, --extract-audio Convert video files to audio-only files
358 (requires ffmpeg or avconv and ffprobe or
360 --audio-format FORMAT Specify audio format: "best", "aac",
361 "vorbis", "mp3", "m4a", "opus", or "wav";
363 --audio-quality QUALITY Specify ffmpeg/avconv audio quality, insert
364 a value between 0 (better) and 9 (worse)
365 for VBR or a specific bitrate like 128K
367 --recode-video FORMAT Encode the video to another format if
368 necessary (currently supported:
369 mp4|flv|ogg|webm|mkv|avi)
370 --postprocessor-args ARGS Give these arguments to the postprocessor
371 -k, --keep-video Keep the video file on disk after the post-
372 processing; the video is erased by default
373 --no-post-overwrites Do not overwrite post-processed files; the
374 post-processed files are overwritten by
376 --embed-subs Embed subtitles in the video (only for mp4,
378 --embed-thumbnail Embed thumbnail in the audio as cover art
379 --add-metadata Write metadata to the video file
380 --metadata-from-title FORMAT Parse additional metadata like song title /
381 artist from the video title. The format
382 syntax is the same as --output, the parsed
383 parameters replace existing values.
384 Additional templates: %(album)s,
385 %(artist)s. Example: --metadata-from-title
386 "%(artist)s - %(title)s" matches a title
387 like "Coldplay - Paradise"
388 --xattrs Write metadata to the video file's xattrs
389 (using dublin core and xdg standards)
390 --fixup POLICY Automatically correct known faults of the
391 file. One of never (do nothing), warn (only
392 emit a warning), detect_or_warn (the
393 default; fix file if we can, warn
395 --prefer-avconv Prefer avconv over ffmpeg for running the
396 postprocessors (default)
397 --prefer-ffmpeg Prefer ffmpeg over avconv for running the
399 --ffmpeg-location PATH Location of the ffmpeg/avconv binary;
400 either the path to the binary or its
401 containing directory.
402 --exec CMD Execute a command on the file after
403 downloading, similar to find's -exec
404 syntax. Example: --exec 'adb push {}
405 /sdcard/Music/ && rm {}'
406 --convert-subs FORMAT Convert the subtitles to other format
407 (currently supported: srt|ass|vtt)
411 You can configure youtube-dl by placing any supported command line option to a configuration file. On Linux and OS X, the system wide configuration file is located at `/etc/youtube-dl.conf` and the user wide configuration file at `~/.config/youtube-dl/config`. On Windows, the user wide configuration file locations are `%APPDATA%\youtube-dl\config.txt` or `C:\Users\<user name>\youtube-dl.conf`. Note that by default configuration file may not exist so you may need to create it yourself.
413 For example, with the following configuration file youtube-dl will always extract the audio, not copy the mtime, use a proxy and save all videos under `Movies` directory in your home directory:
415 # Lines starting with # are comments
417 # Always extract audio
420 # Do not copy the mtime
424 --proxy 127.0.0.1:3128
426 # Save all videos under Movies directory in your home directory
427 -o ~/Movies/%(title)s.%(ext)s
430 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`.
432 You can use `--ignore-config` if you want to disable the configuration file for a particular youtube-dl run.
434 ### Authentication with `.netrc` file
436 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-dl execution and prevent tracking plain text passwords in the shell command history. You can achieve this using a [`.netrc` file](http://stackoverflow.com/tags/.netrc/info) on per extractor basis. For that you will need to create a `.netrc` file in your `$HOME` and restrict permissions to read/write by you only:
439 chmod a-rwx,u+rw $HOME/.netrc
441 After that you can add credentials for extractor in the following format, where *extractor* is the name of extractor in lowercase:
443 machine <extractor> login <login> password <password>
447 machine youtube login myaccount@gmail.com password my_youtube_password
448 machine twitch login my_twitch_account_name password my_twitch_password
450 To activate authentication with the `.netrc` file you should pass `--netrc` to youtube-dl or place it in the [configuration file](#configuration).
452 On Windows you may also need to setup the `%HOME%` environment variable manually.
456 The `-o` option allows users to indicate a template for the output file names.
458 **tl;dr:** [navigate me to examples](#output-template-examples).
460 The basic usage is not to set any template arguments when downloading a single file, like in `youtube-dl -o funny_video.flv "http://some/video"`. However, it may contain special sequences that will be replaced when downloading each video. The special sequences have the format `%(NAME)s`. To clarify, that is a percent symbol followed by a name in parentheses, followed by a lowercase S. Allowed names are:
462 - `id`: Video identifier
463 - `title`: Video title
465 - `ext`: Video filename extension
466 - `alt_title`: A secondary title of the video
467 - `display_id`: An alternative identifier for the video
468 - `uploader`: Full name of the video uploader
469 - `license`: License name the video is licensed under
470 - `creator`: The creator of the video
471 - `release_date`: The date (YYYYMMDD) when the video was released
472 - `timestamp`: UNIX timestamp of the moment the video became available
473 - `upload_date`: Video upload date (YYYYMMDD)
474 - `uploader_id`: Nickname or id of the video uploader
475 - `location`: Physical location where the video was filmed
476 - `duration`: Length of the video in seconds
477 - `view_count`: How many users have watched the video on the platform
478 - `like_count`: Number of positive ratings of the video
479 - `dislike_count`: Number of negative ratings of the video
480 - `repost_count`: Number of reposts of the video
481 - `average_rating`: Average rating give by users, the scale used depends on the webpage
482 - `comment_count`: Number of comments on the video
483 - `age_limit`: Age restriction for the video (years)
484 - `format`: A human-readable description of the format
485 - `format_id`: Format code specified by `--format`
486 - `format_note`: Additional info about the format
487 - `width`: Width of the video
488 - `height`: Height of the video
489 - `resolution`: Textual description of width and height
490 - `tbr`: Average bitrate of audio and video in KBit/s
491 - `abr`: Average audio bitrate in KBit/s
492 - `acodec`: Name of the audio codec in use
493 - `asr`: Audio sampling rate in Hertz
494 - `vbr`: Average video bitrate in KBit/s
496 - `vcodec`: Name of the video codec in use
497 - `container`: Name of the container format
498 - `filesize`: The number of bytes, if known in advance
499 - `filesize_approx`: An estimate for the number of bytes
500 - `protocol`: The protocol that will be used for the actual download
501 - `extractor`: Name of the extractor
502 - `extractor_key`: Key name of the extractor
503 - `epoch`: Unix epoch when creating the file
504 - `autonumber`: Five-digit number that will be increased with each download, starting at zero
505 - `playlist`: Name or id of the playlist that contains the video
506 - `playlist_index`: Index of the video in the playlist padded with leading zeros according to the total length of the playlist
507 - `playlist_id`: Playlist identifier
508 - `playlist_title`: Playlist title
511 Available for the video that belongs to some logical chapter or section:
512 - `chapter`: Name or title of the chapter the video belongs to
513 - `chapter_number`: Number of the chapter the video belongs to
514 - `chapter_id`: Id of the chapter the video belongs to
516 Available for the video that is an episode of some series or programme:
517 - `series`: Title of the series or programme the video episode belongs to
518 - `season`: Title of the season the video episode belongs to
519 - `season_number`: Number of the season the video episode belongs to
520 - `season_id`: Id of the season the video episode belongs to
521 - `episode`: Title of the video episode
522 - `episode_number`: Number of the video episode within a season
523 - `episode_id`: Id of the video episode
525 Available for the media that is a track or a part of a music album:
526 - `track`: Title of the track
527 - `track_number`: Number of the track within an album or a disc
528 - `track_id`: Id of the track
529 - `artist`: Artist(s) of the track
530 - `genre`: Genre(s) of the track
531 - `album`: Title of the album the track belongs to
532 - `album_type`: Type of the album
533 - `album_artist`: List of all artists appeared on the album
534 - `disc_number`: Number of the disc or other physical medium the track belongs to
535 - `release_year`: Year (YYYY) when the album was released
537 Each aforementioned sequence when referenced in 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 particular extractor, such sequences will be replaced with `NA`.
539 For example for `-o %(title)s-%(id)s.%(ext)s` and mp4 video with title `youtube-dl test video` and id `BaW_jenozKcj` this will result in a `youtube-dl test video-BaW_jenozKcj.mp4` file created in the current directory.
541 Output template can also contain arbitrary hierarchical path, e.g. `-o '%(playlist)s/%(playlist_index)s - %(title)s.%(ext)s'` that will result in downloading each video in a directory corresponding to this path template. Any missing directory will be automatically created for you.
543 To specify percent literal in output template use `%%`. To output to stdout use `-o -`.
545 The current default template is `%(title)s-%(id)s.%(ext)s`.
547 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:
549 #### Output template and Windows batch files
551 If you are using 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"`.
553 #### Output template examples
555 Note on Windows you may need to use double quotes instead of single.
558 $ youtube-dl --get-filename -o '%(title)s.%(ext)s' BaW_jenozKc
559 youtube-dl test video ''_ä↭𝕐.mp4 # All kinds of weird characters
561 $ youtube-dl --get-filename -o '%(title)s.%(ext)s' BaW_jenozKc --restrict-filenames
562 youtube-dl_test_video_.mp4 # A simple file name
564 # Download YouTube playlist videos in separate directory indexed by video order in a playlist
565 $ youtube-dl -o '%(playlist)s/%(playlist_index)s - %(title)s.%(ext)s' https://www.youtube.com/playlist?list=PLwiyx1dc3P2JR9N8gQaQN_BCvlSlap7re
567 # Download all playlists of YouTube channel/user keeping each playlist in separate directory:
568 $ youtube-dl -o '%(uploader)s/%(playlist)s/%(playlist_index)s - %(title)s.%(ext)s' https://www.youtube.com/user/TheLinuxFoundation/playlists
570 # Download Udemy course keeping each chapter in separate directory under MyVideos directory in your home
571 $ youtube-dl -u user -p password -o '~/MyVideos/%(playlist)s/%(chapter_number)s - %(chapter)s/%(title)s.%(ext)s' https://www.udemy.com/java-tutorial/
573 # Download entire series season keeping each series and each season in separate directory under C:/MyVideos
574 $ youtube-dl -o "C:/MyVideos/%(series)s/%(season_number)s - %(season)s/%(episode_number)s - %(episode)s.%(ext)s" http://videomore.ru/kino_v_detalayah/5_sezon/367617
576 # Stream the video being downloaded to stdout
577 $ youtube-dl -o - BaW_jenozKc
582 By default youtube-dl 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-dl will guess it for you by **default**.
584 But 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.
586 The 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.
588 **tl;dr:** [navigate me to examples](#format-selection-examples).
590 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.
592 You can also use a file extension (currently `3gp`, `aac`, `flv`, `m4a`, `mp3`, `mp4`, `ogg`, `wav`, `webm` are supported) to download best quality format of particular file extension served as a single file, e.g. `-f webm` will download best quality format with `webm` extension served as a single file.
594 You can also use special names to select particular edge case format:
595 - `best`: Select best quality format represented by single file with video and audio
596 - `worst`: Select worst quality format represented by single file with video and audio
597 - `bestvideo`: Select best quality video only format (e.g. DASH video), may not be available
598 - `worstvideo`: Select worst quality video only format, may not be available
599 - `bestaudio`: Select best quality audio only format, may not be available
600 - `worstaudio`: Select worst quality audio only format, may not be available
602 For example, to download worst quality video only format you can use `-f worstvideo`.
604 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 slash is left-associative, i.e. 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.
606 If you want to download several formats of the same video use comma as a separator, e.g. `-f 22,17,18` will download all these three formats, of course if they are available. Or more sophisticated example combined with precedence feature `-f 136/137/mp4/bestvideo,140/m4a/bestaudio`.
608 You can also filter the video formats by putting a condition in brackets, as in `-f "best[height=720]"` (or `-f "[filesize>10M]"`).
610 The following numeric meta fields can be used with comparisons `<`, `<=`, `>`, `>=`, `=` (equals), `!=` (not equals):
611 - `filesize`: The number of bytes, if known in advance
612 - `width`: Width of the video, if known
613 - `height`: Height of the video, if known
614 - `tbr`: Average bitrate of audio and video in KBit/s
615 - `abr`: Average audio bitrate in KBit/s
616 - `vbr`: Average video bitrate in KBit/s
617 - `asr`: Audio sampling rate in Hertz
620 Also filtering work for comparisons `=` (equals), `!=` (not equals), `^=` (begins with), `$=` (ends with), `*=` (contains) and following string meta fields:
621 - `ext`: File extension
622 - `acodec`: Name of the audio codec in use
623 - `vcodec`: Name of the video codec in use
624 - `container`: Name of the container format
625 - `protocol`: The protocol that will be used for the actual download, lower-case. `http`, `https`, `rtsp`, `rtmp`, `rtmpe`, `m3u8`, or `m3u8_native`
626 - `format_id`: A short description of the format
628 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 video hoster.
630 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.
632 You can merge the video and audio of two formats into a single file using `-f <video-format>+<audio-format>` (requires ffmpeg or avconv installed), for example `-f bestvideo+bestaudio` will download best video only format, best audio only format and mux them together with ffmpeg/avconv.
634 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]'`.
636 Since the end of April 2015 and version 2015.04.26 youtube-dl uses `-f bestvideo+bestaudio/best` as default format selection (see [#5447](https://github.com/rg3/youtube-dl/issues/5447), [#5456](https://github.com/rg3/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. If you want to only download some DASH formats (for example if you are not interested in getting videos with a resolution higher than 1080p), you can add `-f bestvideo[height<=?1080]+bestaudio/best` to your configuration file. Note that if you use youtube-dl 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-dl 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.
638 If you want to preserve the old format selection behavior (prior to youtube-dl 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-dl.
640 #### Format selection examples
642 Note on Windows you may need to use double quotes instead of single.
645 # Download best mp4 format available or any other best if no mp4 available
646 $ youtube-dl -f 'bestvideo[ext=mp4]+bestaudio[ext=m4a]/best[ext=mp4]/best'
648 # Download best format available but not better that 480p
649 $ youtube-dl -f 'bestvideo[height<=480]+bestaudio/best[height<=480]'
651 # Download best video only format but no bigger that 50 MB
652 $ youtube-dl -f 'best[filesize<50M]'
654 # Download best format available via direct link over HTTP/HTTPS protocol
655 $ youtube-dl -f '(bestvideo+bestaudio/best)[protocol^=http]'
657 # Download the best video format and the best audio format without merging them
658 $ youtube-dl -f 'bestvideo,bestaudio' -o '%(title)s.f%(format_id)s.%(ext)s'
660 Note that in the last example, an output template is recommended as bestvideo and bestaudio may have the same file name.
665 Videos can be filtered by their upload date using the options `--date`, `--datebefore` or `--dateafter`. They accept dates in two formats:
667 - Absolute dates: Dates in the format `YYYYMMDD`.
668 - Relative dates: Dates in the format `(now|today)[+-][0-9](day|week|month|year)(s)?`
673 # Download only the videos uploaded in the last 6 months
674 $ youtube-dl --dateafter now-6months
676 # Download only the videos uploaded on January 1, 1970
677 $ youtube-dl --date 19700101
679 $ # Download only the videos uploaded in the 200x decade
680 $ youtube-dl --dateafter 20000101 --datebefore 20091231
685 ### How do I update youtube-dl?
687 If you've followed [our manual installation instructions](http://rg3.github.io/youtube-dl/download.html), you can simply run `youtube-dl -U` (or, on Linux, `sudo youtube-dl -U`).
689 If you have used pip, a simple `sudo pip install -U youtube-dl` is sufficient to update.
691 If you have installed youtube-dl using a package manager like *apt-get* or *yum*, use the standard system update mechanism to update. Note that distribution packages are often outdated. As a rule of thumb, youtube-dl releases at least once a month, and often weekly or even daily. Simply go to http://yt-dl.org/ to find out the current version. Unfortunately, there is nothing we youtube-dl developers can do if your distribution serves a really outdated version. You can (and should) complain to your distribution in their bugtracker or support forum.
693 As a last resort, you can also uninstall the version installed by your package manager and follow our manual installation instructions. For that, remove the distribution's package, with a line like
695 sudo apt-get remove -y youtube-dl
697 Afterwards, simply follow [our manual installation instructions](http://rg3.github.io/youtube-dl/download.html):
700 sudo wget https://yt-dl.org/latest/youtube-dl -O /usr/local/bin/youtube-dl
701 sudo chmod a+x /usr/local/bin/youtube-dl
705 Again, from then on you'll be able to update with `sudo youtube-dl -U`.
707 ### youtube-dl is extremely slow to start on Windows
709 Add a file exclusion for `youtube-dl.exe` in Windows Defender settings.
711 ### I'm getting an error `Unable to extract OpenGraph title` on YouTube playlists
713 YouTube changed their playlist format in March 2014 and later on, so you'll need at least youtube-dl 2014.07.25 to download all YouTube videos.
715 If you have installed youtube-dl with a package manager, pip, setup.py or a tarball, please use that to update. Note that Ubuntu packages do not seem to get updated anymore. Since we are not affiliated with Ubuntu, there is little we can do. Feel free to [report bugs](https://bugs.launchpad.net/ubuntu/+source/youtube-dl/+filebug) to the [Ubuntu packaging guys](mailto:ubuntu-motu@lists.ubuntu.com?subject=outdated%20version%20of%20youtube-dl) - all they have to do is update the package to a somewhat recent version. See above for a way to update.
717 ### I'm getting an error when trying to use output template: `error: using output template conflicts with using title, video ID or auto number`
719 Make sure you are not using `-o` with any of these options `-t`, `--title`, `--id`, `-A` or `--auto-number` set in command line or in a configuration file. Remove the latter if any.
721 ### Do I always have to pass `-citw`?
723 By default, youtube-dl intends to have the best options (incidentally, if you have a convincing case that these should be different, [please file an issue where you explain that](https://yt-dl.org/bug)). Therefore, it is unnecessary and sometimes harmful to copy long option strings from webpages. In particular, the only option out of `-citw` that is regularly useful is `-i`.
725 ### Can you please put the `-b` option back?
727 Most people asking this question are not aware that youtube-dl now defaults to downloading the highest available quality as reported by YouTube, which will be 1080p or 720p in some cases, so you no longer need the `-b` option. For some specific videos, maybe YouTube does not report them to be available in a specific high quality format you're interested in. In that case, simply request it with the `-f` option and youtube-dl will try to download it.
729 ### I get HTTP error 402 when trying to download a video. What's this?
731 Apparently YouTube requires you to pass a CAPTCHA test if you download too much. We're [considering to provide a way to let you solve the CAPTCHA](https://github.com/rg3/youtube-dl/issues/154), but at the moment, your best course of action is pointing a webbrowser to the youtube URL, solving the CAPTCHA, and restart youtube-dl.
733 ### Do I need any other programs?
735 youtube-dl works fine on its own on most sites. However, if you want to convert video/audio, you'll need [avconv](https://libav.org/) or [ffmpeg](https://www.ffmpeg.org/). On some sites - most notably YouTube - videos can be retrieved in a higher quality format without sound. youtube-dl will detect whether avconv/ffmpeg is present and automatically pick the best option.
737 Videos or video formats streamed via RTMP protocol can only be downloaded when [rtmpdump](https://rtmpdump.mplayerhq.hu/) is installed. Downloading MMS and RTSP videos requires either [mplayer](http://mplayerhq.hu/) or [mpv](https://mpv.io/) to be installed.
739 ### I have downloaded a video but how can I play it?
741 Once the video is fully downloaded, use any video player, such as [mpv](https://mpv.io/), [vlc](http://www.videolan.org/) or [mplayer](http://www.mplayerhq.hu/).
743 ### I extracted a video URL with `-g`, but it does not play on another machine / in my webbrowser.
745 It depends a lot on the service. In many cases, requests for the video (to download/play it) must come from the same IP address and with the same cookies. Use the `--cookies` option to write the required cookies into a file, and advise your downloader to read cookies from that file. Some sites also require a common user agent to be used, use `--dump-user-agent` to see the one in use by youtube-dl.
747 It may be beneficial to use IPv6; in some cases, the restrictions are only applied to IPv4. Some services (sometimes only for a subset of videos) do not restrict the video URL by IP address, cookie, or user-agent, but these are the exception rather than the rule.
749 Please bear in mind that some URL protocols are **not** supported by browsers out of the box, including RTMP. If you are using `-g`, your own downloader must support these as well.
751 If you want to play the video on a machine that is not running youtube-dl, you can relay the video content from the machine that runs youtube-dl. You can use `-o -` to let youtube-dl stream a video to stdout, or simply allow the player to download the files written by youtube-dl in turn.
753 ### ERROR: no fmt_url_map or conn information found in video info
755 YouTube has switched to a new video info format in July 2011 which is not supported by old versions of youtube-dl. See [above](#how-do-i-update-youtube-dl) for how to update youtube-dl.
757 ### ERROR: unable to download video
759 YouTube requires an additional signature since September 2012 which is not supported by old versions of youtube-dl. See [above](#how-do-i-update-youtube-dl) for how to update youtube-dl.
761 ### Video URL contains an ampersand and I'm getting some strange output `[1] 2839` or `'v' is not recognized as an internal or external command`
763 That's actually the output from your shell. Since ampersand is one of the special shell characters it's interpreted by the shell preventing you from passing the whole URL to youtube-dl. To disable your shell from interpreting the ampersands (or any other special characters) you have to either put the whole URL in quotes or escape them with a backslash (which approach will work depends on your shell).
765 For example if your URL is https://www.youtube.com/watch?t=4&v=BaW_jenozKc you should end up with following command:
767 ```youtube-dl 'https://www.youtube.com/watch?t=4&v=BaW_jenozKc'```
771 ```youtube-dl https://www.youtube.com/watch?t=4\&v=BaW_jenozKc```
773 For Windows you have to use the double quotes:
775 ```youtube-dl "https://www.youtube.com/watch?t=4&v=BaW_jenozKc"```
777 ### ExtractorError: Could not find JS function u'OF'
779 In February 2015, the new YouTube player contained a character sequence in a string that was misinterpreted by old versions of youtube-dl. See [above](#how-do-i-update-youtube-dl) for how to update youtube-dl.
781 ### HTTP Error 429: Too Many Requests or 402: Payment Required
783 These two error codes indicate that the service is blocking your IP address because of overuse. Contact the service and ask them to unblock your IP address, or - if you have acquired a whitelisted IP address already - use the [`--proxy` or `--source-address` options](#network-options) to select another IP address.
785 ### SyntaxError: Non-ASCII character
789 File "youtube-dl", line 2
790 SyntaxError: Non-ASCII character '\x93' ...
792 means you're using an outdated version of Python. Please update to Python 2.6 or 2.7.
794 ### What is this binary file? Where has the code gone?
796 Since June 2012 ([#342](https://github.com/rg3/youtube-dl/issues/342)) youtube-dl is packed as an executable zipfile, simply unzip it (might need renaming to `youtube-dl.zip` first on some systems) or clone the git repository, as laid out above. If you modify the code, you can run it by executing the `__main__.py` file. To recompile the executable, run `make youtube-dl`.
798 ### The exe throws an error due to missing `MSVCR100.dll`
800 To run the exe you need to install first the [Microsoft Visual C++ 2010 Redistributable Package (x86)](https://www.microsoft.com/en-US/download/details.aspx?id=5555).
802 ### On Windows, how should I set up ffmpeg and youtube-dl? Where should I put the exe files?
804 If you put youtube-dl and ffmpeg in the same directory that you're running the command from, it will work, but that's rather cumbersome.
806 To make a different directory work - either for ffmpeg, or for youtube-dl, or for both - simply create the directory (say, `C:\bin`, or `C:\Users\<User name>\bin`), put all the executables directly in there, and then [set your PATH environment variable](https://www.java.com/en/download/help/path.xml) to include that directory.
808 From then on, after restarting your shell, you will be able to access both youtube-dl and ffmpeg (and youtube-dl will be able to find ffmpeg) by simply typing `youtube-dl` or `ffmpeg`, no matter what directory you're in.
810 ### How do I put downloads into a specific folder?
812 Use the `-o` to specify an [output template](#output-template), for example `-o "/home/user/videos/%(title)s-%(id)s.%(ext)s"`. If you want this for all of your downloads, put the option into your [configuration file](#configuration).
814 ### How do I download a video starting with a `-`?
816 Either prepend `http://www.youtube.com/watch?v=` or separate the ID from the options with `--`:
818 youtube-dl -- -wNyEUrxzFU
819 youtube-dl "http://www.youtube.com/watch?v=-wNyEUrxzFU"
821 ### How do I pass cookies to youtube-dl?
823 Use the `--cookies` option, for example `--cookies /path/to/cookies/file.txt`.
825 In order to extract cookies from browser use any conforming browser extension for exporting cookies. For example, [cookies.txt](https://chrome.google.com/webstore/detail/cookiestxt/njabckikapfpffapmjgojcnbfjonfjfg) (for Chrome) or [Export Cookies](https://addons.mozilla.org/en-US/firefox/addon/export-cookies/) (for Firefox).
827 Note that the cookies file must be in Mozilla/Netscape format and the first line of the cookies file must be either `# HTTP Cookie File` or `# Netscape HTTP Cookie File`. Make sure you have correct [newline format](https://en.wikipedia.org/wiki/Newline) in the cookies file and convert newlines if necessary to correspond with your OS, namely `CRLF` (`\r\n`) for Windows, `LF` (`\n`) for Linux and `CR` (`\r`) for Mac OS. `HTTP Error 400: Bad Request` when using `--cookies` is a good sign of invalid newline format.
829 Passing cookies to youtube-dl is a good way to workaround login when a particular extractor does not implement it explicitly. Another use case is working around [CAPTCHA](https://en.wikipedia.org/wiki/CAPTCHA) some websites require you to solve in particular cases in order to get access (e.g. YouTube, CloudFlare).
831 ### How do I stream directly to media player?
833 You will first need to tell youtube-dl to stream media to stdout with `-o -`, and also tell your media player to read from stdin (it must be capable of this for streaming) and then pipe former to latter. For example, streaming to [vlc](http://www.videolan.org/) can be achieved with:
835 youtube-dl -o - "http://www.youtube.com/watch?v=BaW_jenozKcj" | vlc -
837 ### How do I download only new videos from a playlist?
839 Use download-archive feature. With this feature you should initially download the complete playlist with `--download-archive /path/to/download/archive/file.txt` that will record identifiers of all the videos in a special file. Each subsequent run with the same `--download-archive` will download only new videos and skip all videos that have been downloaded before. Note that only successful downloads are recorded in the file.
841 For example, at first,
843 youtube-dl --download-archive archive.txt "https://www.youtube.com/playlist?list=PLwiyx1dc3P2JR9N8gQaQN_BCvlSlap7re"
845 will download the complete `PLwiyx1dc3P2JR9N8gQaQN_BCvlSlap7re` playlist and create a file `archive.txt`. Each subsequent run will only download new videos if any:
847 youtube-dl --download-archive archive.txt "https://www.youtube.com/playlist?list=PLwiyx1dc3P2JR9N8gQaQN_BCvlSlap7re"
849 ### Can you add support for this anime video site, or site which shows current movies for free?
851 As a matter of policy (as well as legality), youtube-dl does not include support for services that specialize in infringing copyright. As a rule of thumb, if you cannot easily find a video that the service is quite obviously allowed to distribute (i.e. that has been uploaded by the creator, the creator's distributor, or is published under a free license), the service is probably unfit for inclusion to youtube-dl.
853 A note on the service that they don't host the infringing content, but just link to those who do, is evidence that the service should **not** be included into youtube-dl. The same goes for any DMCA note when the whole front page of the service is filled with videos they are not allowed to distribute. A "fair use" note is equally unconvincing if the service shows copyright-protected videos in full without authorization.
855 Support requests for services that **do** purchase the rights to distribute their content are perfectly fine though. If in doubt, you can simply include a source that mentions the legitimate purchase of content.
857 ### How can I speed up work on my issue?
859 (Also known as: Help, my important issue not being solved!) The youtube-dl core developer team is quite small. While we do our best to solve as many issues as possible, sometimes that can take quite a while. To speed up your issue, here's what you can do:
861 First of all, please do report the issue [at our issue tracker](https://yt-dl.org/bugs). That allows us to coordinate all efforts by users and developers, and serves as a unified point. Unfortunately, the youtube-dl project has grown too large to use personal email as an effective communication channel.
863 Please read the [bug reporting instructions](#bugs) below. A lot of bugs lack all the necessary information. If you can, offer proxy, VPN, or shell access to the youtube-dl developers. If you are able to, test the issue from multiple computers in multiple countries to exclude local censorship or misconfiguration issues.
865 If nobody is interested in solving your issue, you are welcome to take matters into your own hands and submit a pull request (or coerce/pay somebody else to do so).
867 Feel free to bump the issue from time to time by writing a small comment ("Issue is still present in youtube-dl version ...from France, but fixed from Belgium"), but please not more than once a month. Please do not declare your issue as `important` or `urgent`.
869 ### How can I detect whether a given URL is supported by youtube-dl?
871 For one, have a look at the [list of supported sites](docs/supportedsites.md). Note that it can sometimes happen that the site changes its URL scheme (say, from http://example.com/video/1234567 to http://example.com/v/1234567 ) and youtube-dl reports an URL of a service in that list as unsupported. In that case, simply report a bug.
873 It is *not* possible to detect whether a URL is supported or not. That's because youtube-dl contains a generic extractor which matches **all** URLs. You may be tempted to disable, exclude, or remove the generic extractor, but the generic extractor not only allows users to extract videos from lots of websites that embed a video from another service, but may also be used to extract video from a service that it's hosting itself. Therefore, we neither recommend nor support disabling, excluding, or removing the generic extractor.
875 If you want to find out whether a given URL is supported, simply call youtube-dl with it. If you get no videos back, chances are the URL is either not referring to a video or unsupported. You can find out which by examining the output (if you run youtube-dl on the console) or catching an `UnsupportedError` exception if you run it from a Python program.
877 # Why do I need to go through that much red tape when filing bugs?
879 Before we had the issue template, despite our extensive [bug reporting instructions](#bugs), about 80% of the issue reports we got were useless, for instance because people used ancient versions hundreds of releases old, because of simple syntactic errors (not in youtube-dl but in general shell usage), because the problem was alrady reported multiple times before, because people did not actually read an error message, even if it said "please install ffmpeg", because people did not mention the URL they were trying to download and many more simple, easy-to-avoid problems, many of whom were totally unrelated to youtube-dl.
881 youtube-dl is an open-source project manned by too few volunteers, so we'd rather spend time fixing bugs where we are certain none of those simple problems apply, and where we can be reasonably confident to be able to reproduce the issue without asking the reporter repeatedly. As such, the output of `youtube-dl -v YOUR_URL_HERE` is really all that's required to file an issue. The issue template also guides you through some basic steps you can do, such as checking that your version of youtube-dl is current.
883 # DEVELOPER INSTRUCTIONS
885 Most users do not need to build youtube-dl and can [download the builds](http://rg3.github.io/youtube-dl/download.html) or get them from their distribution.
887 To run youtube-dl as a developer, you don't need to build anything either. Simply execute
891 To run the test, simply invoke your favorite test runner, or execute a test file directly; any of the following work:
893 python -m unittest discover
894 python test/test_download.py
897 If you want to create a build of youtube-dl yourself, you'll need
900 * make (both GNU make and BSD make are supported)
905 ### Adding support for a new site
907 If you want to add support for a new site, first of all **make sure** this site is **not dedicated to [copyright infringement](#can-you-add-support-for-this-anime-video-site-or-site-which-shows-current-movies-for-free)**. youtube-dl does **not support** such sites thus pull requests adding support for them **will be rejected**.
909 After you have ensured this site is distributing it's content legally, you can follow this quick list (assuming your service is called `yourextractor`):
911 1. [Fork this repository](https://github.com/rg3/youtube-dl/fork)
912 2. Check out the source code with:
914 git clone git@github.com:YOUR_GITHUB_USERNAME/youtube-dl.git
916 3. Start a new git branch with
919 git checkout -b yourextractor
921 4. Start with this simple template and save it to `youtube_dl/extractor/yourextractor.py`:
925 from __future__ import unicode_literals
927 from .common import InfoExtractor
930 class YourExtractorIE(InfoExtractor):
931 _VALID_URL = r'https?://(?:www\.)?yourextractor\.com/watch/(?P<id>[0-9]+)'
933 'url': 'http://yourextractor.com/watch/42',
934 'md5': 'TODO: md5 sum of the first 10241 bytes of the video file (use --test)',
938 'title': 'Video title goes here',
939 'thumbnail': 're:^https?://.*\.jpg$',
940 # TODO more properties, either as:
942 # * MD5 checksum; start the string with md5:
943 # * A regular expression; start the string with re:
944 # * Any Python type (for example int or float)
948 def _real_extract(self, url):
949 video_id = self._match_id(url)
950 webpage = self._download_webpage(url, video_id)
952 # TODO more code goes here, for example ...
953 title = self._html_search_regex(r'<h1>(.+?)</h1>', webpage, 'title')
958 'description': self._og_search_description(webpage),
959 'uploader': self._search_regex(r'<div[^>]+id="uploader"[^>]*>([^<]+)<', webpage, 'uploader', fatal=False),
960 # TODO more properties (see youtube_dl/extractor/common.py)
963 5. Add an import in [`youtube_dl/extractor/extractors.py`](https://github.com/rg3/youtube-dl/blob/master/youtube_dl/extractor/extractors.py).
964 6. Run `python test/test_download.py TestDownload.test_YourExtractor`. This *should fail* at first, but you can continually re-run it until you're done. If you decide to add more than one test, then rename ``_TEST`` to ``_TESTS`` and make it into a list of dictionaries. The tests will then be named `TestDownload.test_YourExtractor`, `TestDownload.test_YourExtractor_1`, `TestDownload.test_YourExtractor_2`, etc.
965 7. Have a look at [`youtube_dl/extractor/common.py`](https://github.com/rg3/youtube-dl/blob/master/youtube_dl/extractor/common.py) for possible helper methods and a [detailed description of what your extractor should and may return](https://github.com/rg3/youtube-dl/blob/master/youtube_dl/extractor/common.py#L74-L252). Add tests and code for as many as you want.
966 8. Make sure your code follows [youtube-dl coding conventions](#youtube-dl-coding-conventions) and check the code with [flake8](https://pypi.python.org/pypi/flake8). Also make sure your code works under all [Python](http://www.python.org/) versions claimed supported by youtube-dl, namely 2.6, 2.7, and 3.2+.
967 9. When the tests pass, [add](http://git-scm.com/docs/git-add) the new files and [commit](http://git-scm.com/docs/git-commit) them and [push](http://git-scm.com/docs/git-push) the result, like this:
969 $ git add youtube_dl/extractor/extractors.py
970 $ git add youtube_dl/extractor/yourextractor.py
971 $ git commit -m '[yourextractor] Add new extractor'
972 $ git push origin yourextractor
974 10. Finally, [create a pull request](https://help.github.com/articles/creating-a-pull-request). We'll then review and merge it.
976 In any case, thank you very much for your contributions!
978 ## youtube-dl coding conventions
980 This section introduces a guide lines for writing idiomatic, robust and future-proof extractor code.
982 Extractors are very fragile by nature since they depend on the layout of the source data provided by 3rd party media hoster out of your control and this layout tend to change. As an extractor implementer your task is not only to write code that will extract media links and metadata correctly but also to minimize code dependency on source's layout changes and even to make the code foresee potential future changes and be ready for that. This is important because it will allow extractor not to break on minor layout changes thus keeping old youtube-dl versions working. Even though this breakage issue is easily fixed by emitting a new version of youtube-dl with fix incorporated all the previous version become broken in all repositories and distros' packages that may not be so prompt in fetching the update from us. Needless to say some may never receive an update at all that is possible for non rolling release distros.
984 ### Mandatory and optional metafields
986 For extraction to work youtube-dl relies on metadata your extractor extracts and provides to youtube-dl expressed by [information dictionary](https://github.com/rg3/youtube-dl/blob/master/youtube_dl/extractor/common.py#L75-L257) or simply *info dict*. Only the following meta fields in *info dict* are considered mandatory for successful extraction process by youtube-dl:
988 - `id` (media identifier)
989 - `title` (media title)
990 - `url` (media download URL) or `formats`
992 In fact only the last option is technically mandatory (i.e. if you can't figure out the download location of the media the extraction does not make any sense). But by convention youtube-dl also treats `id` and `title` to be mandatory. Thus aforementioned metafields are the critical data the extraction does not make any sense without and if any of them fail to be extracted then extractor is considered completely broken.
994 [Any field](https://github.com/rg3/youtube-dl/blob/master/youtube_dl/extractor/common.py#L149-L257) apart from the aforementioned ones are considered **optional**. That means that extraction should be **tolerate** to situations when sources for these fields can potentially be unavailable (even if they are always available at the moment) and **future-proof** in order not to break the extraction of general purpose mandatory fields.
998 Say you have some source dictionary `meta` that you've fetched as JSON with HTTP request and it has a key `summary`:
1001 meta = self._download_json(url, video_id)
1004 Assume at this point `meta`'s layout is:
1009 "summary": "some fancy summary text",
1014 Assume you want to extract `summary` and put into resulting info dict as `description`. Since `description` is optional metafield you should be ready that this key may be missing from the `meta` dict, so that you should extract it like:
1017 description = meta.get('summary') # correct
1023 description = meta['summary'] # incorrect
1026 The latter will break extraction process with `KeyError` if `summary` disappears from `meta` at some time later but with former approach extraction will just go ahead with `description` set to `None` that is perfectly fine (remember `None` is equivalent for absence of data).
1028 Similarly, you should pass `fatal=False` when extracting optional data from a webpage with `_search_regex`, `_html_search_regex` or similar methods, for instance:
1031 description = self._search_regex(
1032 r'<span[^>]+id="title"[^>]*>([^<]+)<',
1033 webpage, 'description', fatal=False)
1036 With `fatal` set to `False` if `_search_regex` fails to extract `description` it will emit a warning and continue extraction.
1038 You can also pass `default=<some fallback value>`, for example:
1041 description = self._search_regex(
1042 r'<span[^>]+id="title"[^>]*>([^<]+)<',
1043 webpage, 'description', default=None)
1046 On failure this code will silently continue the extraction with `description` set to `None`. That is useful for metafields that are known to may or may not be present.
1048 ### Provide fallbacks
1050 When extracting metadata try to provide several scenarios for that. For example if `title` is present in several places/sources try extracting from at least some of them. This would make it more future-proof in case some of the sources became unavailable.
1054 Say `meta` from previous example has a `title` and you are about to extract it. Since `title` is mandatory meta field you should end up with something like:
1057 title = meta['title']
1060 If `title` disappeares from `meta` in future due to some changes on hoster's side the extraction would fail since `title` is mandatory. That's expected.
1062 Assume that you have some another source you can extract `title` from, for example `og:title` HTML meta of a `webpage`. In this case you can provide a fallback scenario:
1065 title = meta.get('title') or self._og_search_title(webpage)
1068 This code will try to extract from `meta` first and if it fails it will try extracting `og:title` from a `webpage`.
1070 ### Make regular expressions flexible
1072 When using regular expressions try to write them fuzzy and flexible.
1076 Say you need to extract `title` from the following HTML code:
1079 <span style="position: absolute; left: 910px; width: 90px; float: right; z-index: 9999;" class="title">some fancy title</span>
1082 The code for that task should look similar to:
1085 title = self._search_regex(
1086 r'<span[^>]+class="title"[^>]*>([^<]+)', webpage, 'title')
1092 title = self._search_regex(
1093 r'<span[^>]+class=(["\'])title\1[^>]*>(?P<title>[^<]+)',
1094 webpage, 'title', group='title')
1097 Note how you tolerate potential changes in `style` attribute's value or switch from using double quotes to single for `class` attribute:
1099 The code definitely should not look like:
1102 title = self._search_regex(
1103 r'<span style="position: absolute; left: 910px; width: 90px; float: right; z-index: 9999;" class="title">(.*?)</span>',
1104 webpage, 'title', group='title')
1107 ### Use safe conversion functions
1109 Wrap all extracted numeric data into safe functions from `utils`: `int_or_none`, `float_or_none`. Use them for string to number conversions as well.
1111 # EMBEDDING YOUTUBE-DL
1113 youtube-dl makes the best effort to be a good command-line program, and thus should be callable from any programming language. If you encounter any problems parsing its output, feel free to [create a report](https://github.com/rg3/youtube-dl/issues/new).
1115 From a Python program, you can embed youtube-dl in a more powerful fashion, like this:
1118 from __future__ import unicode_literals
1122 with youtube_dl.YoutubeDL(ydl_opts) as ydl:
1123 ydl.download(['http://www.youtube.com/watch?v=BaW_jenozKc'])
1126 Most likely, you'll want to use various options. For a list of options available, have a look at [`youtube_dl/YoutubeDL.py`](https://github.com/rg3/youtube-dl/blob/master/youtube_dl/YoutubeDL.py#L128-L278). For a start, if you want to intercept youtube-dl's output, set a `logger` object.
1128 Here's a more complete example of a program that outputs only errors (and a short message after the download is finished), and downloads/converts the video to an mp3 file:
1131 from __future__ import unicode_literals
1135 class MyLogger(object):
1136 def debug(self, msg):
1139 def warning(self, msg):
1142 def error(self, msg):
1147 if d['status'] == 'finished':
1148 print('Done downloading, now converting ...')
1152 'format': 'bestaudio/best',
1153 'postprocessors': [{
1154 'key': 'FFmpegExtractAudio',
1155 'preferredcodec': 'mp3',
1156 'preferredquality': '192',
1158 'logger': MyLogger(),
1159 'progress_hooks': [my_hook],
1161 with youtube_dl.YoutubeDL(ydl_opts) as ydl:
1162 ydl.download(['http://www.youtube.com/watch?v=BaW_jenozKc'])
1167 Bugs and suggestions should be reported at: <https://github.com/rg3/youtube-dl/issues>. Unless you were prompted so or there is another pertinent reason (e.g. GitHub fails to accept the bug report), please do not send bug reports via personal email. For discussions, join us in the IRC channel [#youtube-dl](irc://chat.freenode.net/#youtube-dl) on freenode ([webchat](http://webchat.freenode.net/?randomnick=1&channels=youtube-dl)).
1169 **Please include the full output of youtube-dl when run with `-v`**, i.e. **add** `-v` flag to **your command line**, copy the **whole** output and post it in the issue body wrapped in \`\`\` for better formatting. It should look similar to this:
1171 $ youtube-dl -v <your command line>
1172 [debug] System config: []
1173 [debug] User config: []
1174 [debug] Command-line args: [u'-v', u'http://www.youtube.com/watch?v=BaW_jenozKcj']
1175 [debug] Encodings: locale cp1251, fs mbcs, out cp866, pref cp1251
1176 [debug] youtube-dl version 2015.12.06
1177 [debug] Git HEAD: 135392e
1178 [debug] Python version 2.6.6 - Windows-2003Server-5.2.3790-SP2
1179 [debug] exe versions: ffmpeg N-75573-g1d0487f, ffprobe N-75573-g1d0487f, rtmpdump 2.4
1180 [debug] Proxy map: {}
1183 **Do not post screenshots of verbose log only plain text is acceptable.**
1185 The output (including the first lines) contains important debugging information. Issues without the full output are often not reproducible and therefore do not get solved in short order, if ever.
1187 Please re-read your issue once again to avoid a couple of common mistakes (you can and should use this as a checklist):
1189 ### Is the description of the issue itself sufficient?
1191 We often get issue reports that we cannot really decipher. While in most cases we eventually get the required information after asking back multiple times, this poses an unnecessary drain on our resources. Many contributors, including myself, are also not native speakers, so we may misread some parts.
1193 So please elaborate on what feature you are requesting, or what bug you want to be fixed. Make sure that it's obvious
1195 - What the problem is
1196 - How it could be fixed
1197 - How your proposed solution would look like
1199 If your report is shorter than two lines, it is almost certainly missing some of these, which makes it hard for us to respond to it. We're often too polite to close the issue outright, but the missing info makes misinterpretation likely. As a committer myself, I often get frustrated by these issues, since the only possible way for me to move forward on them is to ask for clarification over and over.
1201 For bug reports, this means that your report should contain the *complete* output of youtube-dl when called with the `-v` flag. The error message you get for (most) bugs even says so, but you would not believe how many of our bug reports do not contain this information.
1203 If your server has multiple IPs or you suspect censorship, adding `--call-home` may be a good idea to get more diagnostics. If the error is `ERROR: Unable to extract ...` and you cannot reproduce it from multiple countries, add `--dump-pages` (warning: this will yield a rather large output, redirect it to the file `log.txt` by adding `>log.txt 2>&1` to your command-line) or upload the `.dump` files you get when you add `--write-pages` [somewhere](https://gist.github.com/).
1205 **Site support requests must contain an example URL**. An example URL is a URL you might want to download, like `http://www.youtube.com/watch?v=BaW_jenozKc`. There should be an obvious video present. Except under very special circumstances, the main page of a video service (e.g. `http://www.youtube.com/`) is *not* an example URL.
1207 ### Are you using the latest version?
1209 Before reporting any issue, type `youtube-dl -U`. This should report that you're up-to-date. About 20% of the reports we receive are already fixed, but people are using outdated versions. This goes for feature requests as well.
1211 ### Is the issue already documented?
1213 Make sure that someone has not already opened the issue you're trying to open. Search at the top of the window or browse the [GitHub Issues](https://github.com/rg3/youtube-dl/search?type=Issues) of this repository. If there is an issue, feel free to write something along the lines of "This affects me as well, with version 2015.01.01. Here is some more information on the issue: ...". While some issues may be old, a new post into them often spurs rapid activity.
1215 ### Why are existing options not enough?
1217 Before requesting a new feature, please have a quick peek at [the list of supported options](https://github.com/rg3/youtube-dl/blob/master/README.md#options). Many feature requests are for features that actually exist already! Please, absolutely do show off your work in the issue report and detail how the existing similar options do *not* solve your problem.
1219 ### Is there enough context in your bug report?
1221 People want to solve problems, and often think they do us a favor by breaking down their larger problems (e.g. wanting to skip already downloaded files) to a specific request (e.g. requesting us to look whether the file exists before downloading the info page). However, what often happens is that they break down the problem into two steps: One simple, and one impossible (or extremely complicated one).
1223 We are then presented with a very complicated request when the original problem could be solved far easier, e.g. by recording the downloaded video IDs in a separate file. To avoid this, you must include the greater context where it is non-obvious. In particular, every feature request that does not consist of adding support for a new site should contain a use case scenario that explains in what situation the missing feature would be useful.
1225 ### Does the issue involve one problem, and one problem only?
1227 Some of our users seem to think there is a limit of issues they can or should open. There is no limit of issues they can or should open. While it may seem appealing to be able to dump all your issues into one ticket, that means that someone who solves one of your issues cannot mark the issue as closed. Typically, reporting a bunch of issues leads to the ticket lingering since nobody wants to attack that behemoth, until someone mercifully splits the issue into multiple ones.
1229 In particular, every site support request issue should only pertain to services at one site (generally under a common domain, but always using the same backend technology). Do not request support for vimeo user videos, Whitehouse podcasts, and Google Plus pages in the same issue. Also, make sure that you don't post bug reports alongside feature requests. As a rule of thumb, a feature request does not include outputs of youtube-dl that are not immediately related to the feature at hand. Do not post reports of a network error alongside the request for a new video service.
1231 ### Is anyone going to need the feature?
1233 Only post features that you (or an incapacitated friend you can personally talk to) require. Do not post features because they seem like a good idea. If they are really useful, they will be requested by someone who requires them.
1235 ### Is your question about youtube-dl?
1237 It may sound strange, but some bug reports we receive are completely unrelated to youtube-dl and relate to a different or even the reporter's own application. Please make sure that you are actually using youtube-dl. If you are using a UI for youtube-dl, report the bug to the maintainer of the actual application providing the UI. On the other hand, if your UI for youtube-dl fails in some way you believe is related to youtube-dl, by all means, go ahead and report the bug.
1241 youtube-dl is released into the public domain by the copyright holders.
1243 This README file was originally written by [Daniel Bolton](https://github.com/dbbolton) and is likewise released into the public domain.
projects / youtube-dl / blob