[mirror] Download/Watch videos from video hostersgit clone https://hacktivis.me/git/mirror/youtube-dl.git

README.md (101042B)

  1. [![Build Status](https://github.com/ytdl-org/youtube-dl/workflows/CI/badge.svg)](https://github.com/ytdl-org/youtube-dl/actions?query=workflow%3ACI)
  2. youtube-dl - download videos from youtube.com or other video platforms
  3. - [INSTALLATION](#installation)
  4. - [DESCRIPTION](#description)
  5. - [OPTIONS](#options)
  6. - [CONFIGURATION](#configuration)
  7. - [OUTPUT TEMPLATE](#output-template)
  8. - [FORMAT SELECTION](#format-selection)
  9. - [VIDEO SELECTION](#video-selection)
  10. - [FAQ](#faq)
  11. - [DEVELOPER INSTRUCTIONS](#developer-instructions)
  12. - [EMBEDDING YOUTUBE-DL](#embedding-youtube-dl)
  13. - [BUGS](#bugs)
  14. - [COPYRIGHT](#copyright)
  16. To install it right away for all UNIX users (Linux, macOS, etc.), type:
  17. sudo curl -L https://yt-dl.org/downloads/latest/youtube-dl -o /usr/local/bin/youtube-dl
  18. sudo chmod a+rx /usr/local/bin/youtube-dl
  19. If you do not have curl, you can alternatively use a recent wget:
  20. sudo wget https://yt-dl.org/downloads/latest/youtube-dl -O /usr/local/bin/youtube-dl
  21. sudo chmod a+rx /usr/local/bin/youtube-dl
  22. Windows users can [download an .exe file](https://yt-dl.org/latest/youtube-dl.exe) and place it in any location on their [PATH](https://en.wikipedia.org/wiki/PATH_%28variable%29) except for `%SYSTEMROOT%\System32` (e.g. **do not** put in `C:\Windows\System32`).
  23. You can also use pip:
  24. sudo -H pip install --upgrade youtube-dl
  25. 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.
  26. macOS users can install youtube-dl with [Homebrew](https://brew.sh/):
  27. brew install youtube-dl
  28. Or with [MacPorts](https://www.macports.org/):
  29. sudo port install youtube-dl
  30. 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://ytdl-org.github.io/youtube-dl/download.html).
  32. **youtube-dl** 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.
  33. youtube-dl [OPTIONS] URL [URL...]
  34. # OPTIONS
  35. -h, --help Print this help text and exit
  36. --version Print program version and exit
  37. -U, --update Update this program to latest version.
  38. Make sure that you have sufficient
  39. permissions (run with sudo if needed)
  40. -i, --ignore-errors Continue on download errors, for
  41. example to skip unavailable videos in a
  42. playlist
  43. --abort-on-error Abort downloading of further videos (in
  44. the playlist or the command line) if an
  45. error occurs
  46. --dump-user-agent Display the current browser
  47. identification
  48. --list-extractors List all supported extractors
  49. --extractor-descriptions Output descriptions of all supported
  50. extractors
  51. --force-generic-extractor Force extraction to use the generic
  52. extractor
  53. --default-search PREFIX Use this prefix for unqualified URLs.
  54. For example "gvsearch2:" downloads two
  55. videos from google videos for youtube-
  56. dl "large apple". Use the value "auto"
  57. to let youtube-dl guess ("auto_warning"
  58. to emit a warning when guessing).
  59. "error" just throws an error. The
  60. default value "fixup_error" repairs
  61. broken URLs, but emits an error if this
  62. is not possible instead of searching.
  63. --ignore-config Do not read configuration files. When
  64. given in the global configuration file
  65. /etc/youtube-dl.conf: Do not read the
  66. user configuration in
  67. ~/.config/youtube-dl/config
  68. (%APPDATA%/youtube-dl/config.txt on
  69. Windows)
  70. --config-location PATH Location of the configuration file;
  71. either the path to the config or its
  72. containing directory.
  73. --flat-playlist Do not extract the videos of a
  74. playlist, only list them.
  75. --mark-watched Mark videos watched (YouTube only)
  76. --no-mark-watched Do not mark videos watched (YouTube
  77. only)
  78. --no-color Do not emit color codes in output
  79. ## Network Options:
  80. --proxy URL Use the specified HTTP/HTTPS/SOCKS
  81. proxy. To enable SOCKS proxy, specify a
  82. proper scheme. For example
  83. socks5:// Pass in an
  84. empty string (--proxy "") for direct
  85. connection
  86. --socket-timeout SECONDS Time to wait before giving up, in
  87. seconds
  88. --source-address IP Client-side IP address to bind to
  89. -4, --force-ipv4 Make all connections via IPv4
  90. -6, --force-ipv6 Make all connections via IPv6
  91. ## Geo Restriction:
  92. --geo-verification-proxy URL Use this proxy to verify the IP address
  93. for some geo-restricted sites. The
  94. default proxy specified by --proxy (or
  95. none, if the option is not present) is
  96. used for the actual downloading.
  97. --geo-bypass Bypass geographic restriction via
  98. faking X-Forwarded-For HTTP header
  99. --no-geo-bypass Do not bypass geographic restriction
  100. via faking X-Forwarded-For HTTP header
  101. --geo-bypass-country CODE Force bypass geographic restriction
  102. with explicitly provided two-letter ISO
  103. 3166-2 country code
  104. --geo-bypass-ip-block IP_BLOCK Force bypass geographic restriction
  105. with explicitly provided IP block in
  106. CIDR notation
  107. ## Video Selection:
  108. --playlist-start NUMBER Playlist video to start at (default is
  109. 1)
  110. --playlist-end NUMBER Playlist video to end at (default is
  111. last)
  112. --playlist-items ITEM_SPEC Playlist video items to download.
  113. Specify indices of the videos in the
  114. playlist separated by commas like: "--
  115. playlist-items 1,2,5,8" if you want to
  116. download videos indexed 1, 2, 5, 8 in
  117. the playlist. You can specify range: "
  118. --playlist-items 1-3,7,10-13", it will
  119. download the videos at index 1, 2, 3,
  120. 7, 10, 11, 12 and 13.
  121. --match-title REGEX Download only matching titles (regex or
  122. caseless sub-string)
  123. --reject-title REGEX Skip download for matching titles
  124. (regex or caseless sub-string)
  125. --max-downloads NUMBER Abort after downloading NUMBER files
  126. --min-filesize SIZE Do not download any videos smaller than
  127. SIZE (e.g. 50k or 44.6m)
  128. --max-filesize SIZE Do not download any videos larger than
  129. SIZE (e.g. 50k or 44.6m)
  130. --date DATE Download only videos uploaded in this
  131. date
  132. --datebefore DATE Download only videos uploaded on or
  133. before this date (i.e. inclusive)
  134. --dateafter DATE Download only videos uploaded on or
  135. after this date (i.e. inclusive)
  136. --min-views COUNT Do not download any videos with less
  137. than COUNT views
  138. --max-views COUNT Do not download any videos with more
  139. than COUNT views
  140. --match-filter FILTER Generic video filter. Specify any key
  141. (see the "OUTPUT TEMPLATE" for a list
  142. of available keys) to match if the key
  143. is present, !key to check if the key is
  144. not present, key > NUMBER (like
  145. "comment_count > 12", also works with
  146. >=, <, <=, !=, =) to compare against a
  147. number, key = 'LITERAL' (like "uploader
  148. = 'Mike Smith'", also works with !=) to
  149. match against a string literal and & to
  150. require multiple matches. Values which
  151. are not known are excluded unless you
  152. put a question mark (?) after the
  153. operator. For example, to only match
  154. videos that have been liked more than
  155. 100 times and disliked less than 50
  156. times (or the dislike functionality is
  157. not available at the given service),
  158. but who also have a description, use
  159. --match-filter "like_count > 100 &
  160. dislike_count <? 50 & description" .
  161. --no-playlist Download only the video, if the URL
  162. refers to a video and a playlist.
  163. --yes-playlist Download the playlist, if the URL
  164. refers to a video and a playlist.
  165. --age-limit YEARS Download only videos suitable for the
  166. given age
  167. --download-archive FILE Download only videos not listed in the
  168. archive file. Record the IDs of all
  169. downloaded videos in it.
  170. --include-ads Download advertisements as well
  171. (experimental)
  172. ## Download Options:
  173. -r, --limit-rate RATE Maximum download rate in bytes per
  174. second (e.g. 50K or 4.2M)
  175. -R, --retries RETRIES Number of retries (default is 10), or
  176. "infinite".
  177. --fragment-retries RETRIES Number of retries for a fragment
  178. (default is 10), or "infinite" (DASH,
  179. hlsnative and ISM)
  180. --skip-unavailable-fragments Skip unavailable fragments (DASH,
  181. hlsnative and ISM)
  182. --abort-on-unavailable-fragment Abort downloading when some fragment is
  183. not available
  184. --keep-fragments Keep downloaded fragments on disk after
  185. downloading is finished; fragments are
  186. erased by default
  187. --buffer-size SIZE Size of download buffer (e.g. 1024 or
  188. 16K) (default is 1024)
  189. --no-resize-buffer Do not automatically adjust the buffer
  190. size. By default, the buffer size is
  191. automatically resized from an initial
  192. value of SIZE.
  193. --http-chunk-size SIZE Size of a chunk for chunk-based HTTP
  194. downloading (e.g. 10485760 or 10M)
  195. (default is disabled). May be useful
  196. for bypassing bandwidth throttling
  197. imposed by a webserver (experimental)
  198. --playlist-reverse Download playlist videos in reverse
  199. order
  200. --playlist-random Download playlist videos in random
  201. order
  202. --xattr-set-filesize Set file xattribute ytdl.filesize with
  203. expected file size
  204. --hls-prefer-native Use the native HLS downloader instead
  205. of ffmpeg
  206. --hls-prefer-ffmpeg Use ffmpeg instead of the native HLS
  207. downloader
  208. --hls-use-mpegts Use the mpegts container for HLS
  209. videos, allowing to play the video
  210. while downloading (some players may not
  211. be able to play it)
  212. --external-downloader COMMAND Use the specified external downloader.
  213. Currently supports aria2c,avconv,axel,c
  214. url,ffmpeg,httpie,wget
  215. --external-downloader-args ARGS Give these arguments to the external
  216. downloader
  217. ## Filesystem Options:
  218. -a, --batch-file FILE File containing URLs to download ('-'
  219. for stdin), one URL per line. Lines
  220. starting with '#', ';' or ']' are
  221. considered as comments and ignored.
  222. --id Use only video ID in file name
  223. -o, --output TEMPLATE Output filename template, see the
  224. "OUTPUT TEMPLATE" for all the info
  225. --output-na-placeholder PLACEHOLDER Placeholder value for unavailable meta
  226. fields in output filename template
  227. (default is "NA")
  228. --autonumber-start NUMBER Specify the start value for
  229. %(autonumber)s (default is 1)
  230. --restrict-filenames Restrict filenames to only ASCII
  231. characters, and avoid "&" and spaces in
  232. filenames
  233. -w, --no-overwrites Do not overwrite files
  234. -c, --continue Force resume of partially downloaded
  235. files. By default, youtube-dl will
  236. resume downloads if possible.
  237. --no-continue Do not resume partially downloaded
  238. files (restart from beginning)
  239. --no-part Do not use .part files - write directly
  240. into output file
  241. --no-mtime Do not use the Last-modified header to
  242. set the file modification time
  243. --write-description Write video description to a
  244. .description file
  245. --write-info-json Write video metadata to a .info.json
  246. file
  247. --write-annotations Write video annotations to a
  248. .annotations.xml file
  249. --load-info-json FILE JSON file containing the video
  250. information (created with the "--write-
  251. info-json" option)
  252. --cookies FILE File to read cookies from and dump
  253. cookie jar in
  254. --cache-dir DIR Location in the filesystem where
  255. youtube-dl can store some downloaded
  256. information permanently. By default
  257. $XDG_CACHE_HOME/youtube-dl or
  258. ~/.cache/youtube-dl . At the moment,
  259. only YouTube player files (for videos
  260. with obfuscated signatures) are cached,
  261. but that may change.
  262. --no-cache-dir Disable filesystem caching
  263. --rm-cache-dir Delete all filesystem cache files
  264. ## Thumbnail Options:
  265. --write-thumbnail Write thumbnail image to disk
  266. --write-all-thumbnails Write all thumbnail image formats to
  267. disk
  268. --list-thumbnails Simulate and list all available
  269. thumbnail formats
  270. ## Verbosity / Simulation Options:
  271. -q, --quiet Activate quiet mode
  272. --no-warnings Ignore warnings
  273. -s, --simulate Do not download the video and do not
  274. write anything to disk
  275. --skip-download Do not download the video
  276. -g, --get-url Simulate, quiet but print URL
  277. -e, --get-title Simulate, quiet but print title
  278. --get-id Simulate, quiet but print id
  279. --get-thumbnail Simulate, quiet but print thumbnail URL
  280. --get-description Simulate, quiet but print video
  281. description
  282. --get-duration Simulate, quiet but print video length
  283. --get-filename Simulate, quiet but print output
  284. filename
  285. --get-format Simulate, quiet but print output format
  286. -j, --dump-json Simulate, quiet but print JSON
  287. information. See the "OUTPUT TEMPLATE"
  288. for a description of available keys.
  289. -J, --dump-single-json Simulate, quiet but print JSON
  290. information for each command-line
  291. argument. If the URL refers to a
  292. playlist, dump the whole playlist
  293. information in a single line.
  294. --print-json Be quiet and print the video
  295. information as JSON (video is still
  296. being downloaded).
  297. --newline Output progress bar as new lines
  298. --no-progress Do not print progress bar
  299. --console-title Display progress in console titlebar
  300. -v, --verbose Print various debugging information
  301. --dump-pages Print downloaded pages encoded using
  302. base64 to debug problems (very verbose)
  303. --write-pages Write downloaded intermediary pages to
  304. files in the current directory to debug
  305. problems
  306. --print-traffic Display sent and read HTTP traffic
  307. -C, --call-home Contact the youtube-dl server for
  308. debugging
  309. --no-call-home Do NOT contact the youtube-dl server
  310. for debugging
  311. ## Workarounds:
  312. --encoding ENCODING Force the specified encoding
  313. (experimental)
  314. --no-check-certificate Suppress HTTPS certificate validation
  315. --prefer-insecure Use an unencrypted connection to
  316. retrieve information about the video.
  317. (Currently supported only for YouTube)
  318. --user-agent UA Specify a custom user agent
  319. --referer URL Specify a custom referer, use if the
  320. video access is restricted to one
  321. domain
  322. --add-header FIELD:VALUE Specify a custom HTTP header and its
  323. value, separated by a colon ':'. You
  324. can use this option multiple times
  325. --bidi-workaround Work around terminals that lack
  326. bidirectional text support. Requires
  327. bidiv or fribidi executable in PATH
  328. --sleep-interval SECONDS Number of seconds to sleep before each
  329. download when used alone or a lower
  330. bound of a range for randomized sleep
  331. before each download (minimum possible
  332. number of seconds to sleep) when used
  333. along with --max-sleep-interval.
  334. --max-sleep-interval SECONDS Upper bound of a range for randomized
  335. sleep before each download (maximum
  336. possible number of seconds to sleep).
  337. Must only be used along with --min-
  338. sleep-interval.
  339. ## Video Format Options:
  340. -f, --format FORMAT Video format code, see the "FORMAT
  341. SELECTION" for all the info
  342. --all-formats Download all available video formats
  343. --prefer-free-formats Prefer free video formats unless a
  344. specific one is requested
  345. -F, --list-formats List all available formats of requested
  346. videos
  347. --youtube-skip-dash-manifest Do not download the DASH manifests and
  348. related data on YouTube videos
  349. --merge-output-format FORMAT If a merge is required (e.g.
  350. bestvideo+bestaudio), output to given
  351. container format. One of mkv, mp4, ogg,
  352. webm, flv. Ignored if no merge is
  353. required
  354. ## Subtitle Options:
  355. --write-sub Write subtitle file
  356. --write-auto-sub Write automatically generated subtitle
  357. file (YouTube only)
  358. --all-subs Download all the available subtitles of
  359. the video
  360. --list-subs List all available subtitles for the
  361. video
  362. --sub-format FORMAT Subtitle format, accepts formats
  363. preference, for example: "srt" or
  364. "ass/srt/best"
  365. --sub-lang LANGS Languages of the subtitles to download
  366. (optional) separated by commas, use
  367. --list-subs for available language tags
  368. ## Authentication Options:
  369. -u, --username USERNAME Login with this account ID
  370. -p, --password PASSWORD Account password. If this option is
  371. left out, youtube-dl will ask
  372. interactively.
  373. -2, --twofactor TWOFACTOR Two-factor authentication code
  374. -n, --netrc Use .netrc authentication data
  375. --video-password PASSWORD Video password (vimeo, youku)
  376. ## Adobe Pass Options:
  377. --ap-mso MSO Adobe Pass multiple-system operator (TV
  378. provider) identifier, use --ap-list-mso
  379. for a list of available MSOs
  380. --ap-username USERNAME Multiple-system operator account login
  381. --ap-password PASSWORD Multiple-system operator account
  382. password. If this option is left out,
  383. youtube-dl will ask interactively.
  384. --ap-list-mso List all supported multiple-system
  385. operators
  386. ## Post-processing Options:
  387. -x, --extract-audio Convert video files to audio-only files
  388. (requires ffmpeg/avconv and
  389. ffprobe/avprobe)
  390. --audio-format FORMAT Specify audio format: "best", "aac",
  391. "flac", "mp3", "m4a", "opus", "vorbis",
  392. or "wav"; "best" by default; No effect
  393. without -x
  394. --audio-quality QUALITY Specify ffmpeg/avconv audio quality,
  395. insert a value between 0 (better) and 9
  396. (worse) for VBR or a specific bitrate
  397. like 128K (default 5)
  398. --recode-video FORMAT Encode the video to another format if
  399. necessary (currently supported:
  400. mp4|flv|ogg|webm|mkv|avi)
  401. --postprocessor-args ARGS Give these arguments to the
  402. postprocessor
  403. -k, --keep-video Keep the video file on disk after the
  404. post-processing; the video is erased by
  405. default
  406. --no-post-overwrites Do not overwrite post-processed files;
  407. the post-processed files are
  408. overwritten by default
  409. --embed-subs Embed subtitles in the video (only for
  410. mp4, webm and mkv videos)
  411. --embed-thumbnail Embed thumbnail in the audio as cover
  412. art
  413. --add-metadata Write metadata to the video file
  414. --metadata-from-title FORMAT Parse additional metadata like song
  415. title / artist from the video title.
  416. The format syntax is the same as
  417. --output. Regular expression with named
  418. capture groups may also be used. The
  419. parsed parameters replace existing
  420. values. Example: --metadata-from-title
  421. "%(artist)s - %(title)s" matches a
  422. title like "Coldplay - Paradise".
  423. Example (regex): --metadata-from-title
  424. "(?P<artist>.+?) - (?P<title>.+)"
  425. --xattrs Write metadata to the video file's
  426. xattrs (using dublin core and xdg
  427. standards)
  428. --fixup POLICY Automatically correct known faults of
  429. the file. One of never (do nothing),
  430. warn (only emit a warning),
  431. detect_or_warn (the default; fix file
  432. if we can, warn otherwise)
  433. --prefer-avconv Prefer avconv over ffmpeg for running
  434. the postprocessors
  435. --prefer-ffmpeg Prefer ffmpeg over avconv for running
  436. the postprocessors (default)
  437. --ffmpeg-location PATH Location of the ffmpeg/avconv binary;
  438. either the path to the binary or its
  439. containing directory.
  440. --exec CMD Execute a command on the file after
  441. downloading and post-processing,
  442. similar to find's -exec syntax.
  443. Example: --exec 'adb push {}
  444. /sdcard/Music/ && rm {}'
  445. --convert-subs FORMAT Convert the subtitles to other format
  446. (currently supported: srt|ass|vtt|lrc)
  448. You can configure youtube-dl 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-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.
  449. 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:
  450. ```
  451. # Lines starting with # are comments
  452. # Always extract audio
  453. -x
  454. # Do not copy the mtime
  455. --no-mtime
  456. # Use this proxy
  457. --proxy
  458. # Save all videos under Movies directory in your home directory
  459. -o ~/Movies/%(title)s.%(ext)s
  460. ```
  461. 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`.
  462. You can use `--ignore-config` if you want to disable the configuration file for a particular youtube-dl run.
  463. You can also use `--config-location` if you want to use custom configuration file for a particular youtube-dl run.
  464. ### Authentication with `.netrc` file
  465. 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](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:
  466. ```
  467. touch $HOME/.netrc
  468. chmod a-rwx,u+rw $HOME/.netrc
  469. ```
  470. After that you can add credentials for an extractor in the following format, where *extractor* is the name of the extractor in lowercase:
  471. ```
  472. machine <extractor> login <login> password <password>
  473. ```
  474. For example:
  475. ```
  476. machine youtube login myaccount@gmail.com password my_youtube_password
  477. machine twitch login my_twitch_account_name password my_twitch_password
  478. ```
  479. To activate authentication with the `.netrc` file you should pass `--netrc` to youtube-dl or place it in the [configuration file](#configuration).
  480. On Windows you may also need to setup the `%HOME%` environment variable manually. For example:
  481. ```
  483. ```
  485. The `-o` option allows users to indicate a template for the output file names.
  486. **tl;dr:** [navigate me to examples](#output-template-examples).
  487. The basic usage is not to set any template arguments when downloading a single file, like in `youtube-dl -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:
  488. - `id` (string): Video identifier
  489. - `title` (string): Video title
  490. - `url` (string): Video URL
  491. - `ext` (string): Video filename extension
  492. - `alt_title` (string): A secondary title of the video
  493. - `display_id` (string): An alternative identifier for the video
  494. - `uploader` (string): Full name of the video uploader
  495. - `license` (string): License name the video is licensed under
  496. - `creator` (string): The creator of the video
  497. - `release_date` (string): The date (YYYYMMDD) when the video was released
  498. - `timestamp` (numeric): UNIX timestamp of the moment the video became available
  499. - `upload_date` (string): Video upload date (YYYYMMDD)
  500. - `uploader_id` (string): Nickname or id of the video uploader
  501. - `channel` (string): Full name of the channel the video is uploaded on
  502. - `channel_id` (string): Id of the channel
  503. - `location` (string): Physical location where the video was filmed
  504. - `duration` (numeric): Length of the video in seconds
  505. - `view_count` (numeric): How many users have watched the video on the platform
  506. - `like_count` (numeric): Number of positive ratings of the video
  507. - `dislike_count` (numeric): Number of negative ratings of the video
  508. - `repost_count` (numeric): Number of reposts of the video
  509. - `average_rating` (numeric): Average rating give by users, the scale used depends on the webpage
  510. - `comment_count` (numeric): Number of comments on the video
  511. - `age_limit` (numeric): Age restriction for the video (years)
  512. - `is_live` (boolean): Whether this video is a live stream or a fixed-length video
  513. - `start_time` (numeric): Time in seconds where the reproduction should start, as specified in the URL
  514. - `end_time` (numeric): Time in seconds where the reproduction should end, as specified in the URL
  515. - `format` (string): A human-readable description of the format
  516. - `format_id` (string): Format code specified by `--format`
  517. - `format_note` (string): Additional info about the format
  518. - `width` (numeric): Width of the video
  519. - `height` (numeric): Height of the video
  520. - `resolution` (string): Textual description of width and height
  521. - `tbr` (numeric): Average bitrate of audio and video in KBit/s
  522. - `abr` (numeric): Average audio bitrate in KBit/s
  523. - `acodec` (string): Name of the audio codec in use
  524. - `asr` (numeric): Audio sampling rate in Hertz
  525. - `vbr` (numeric): Average video bitrate in KBit/s
  526. - `fps` (numeric): Frame rate
  527. - `vcodec` (string): Name of the video codec in use
  528. - `container` (string): Name of the container format
  529. - `filesize` (numeric): The number of bytes, if known in advance
  530. - `filesize_approx` (numeric): An estimate for the number of bytes
  531. - `protocol` (string): The protocol that will be used for the actual download
  532. - `extractor` (string): Name of the extractor
  533. - `extractor_key` (string): Key name of the extractor
  534. - `epoch` (numeric): Unix epoch when creating the file
  535. - `autonumber` (numeric): Number that will be increased with each download, starting at `--autonumber-start`
  536. - `playlist` (string): Name or id of the playlist that contains the video
  537. - `playlist_index` (numeric): Index of the video in the playlist padded with leading zeros according to the total length of the playlist
  538. - `playlist_id` (string): Playlist identifier
  539. - `playlist_title` (string): Playlist title
  540. - `playlist_uploader` (string): Full name of the playlist uploader
  541. - `playlist_uploader_id` (string): Nickname or id of the playlist uploader
  542. Available for the video that belongs to some logical chapter or section:
  543. - `chapter` (string): Name or title of the chapter the video belongs to
  544. - `chapter_number` (numeric): Number of the chapter the video belongs to
  545. - `chapter_id` (string): Id of the chapter the video belongs to
  546. Available for the video that is an episode of some series or programme:
  547. - `series` (string): Title of the series or programme the video episode belongs to
  548. - `season` (string): Title of the season the video episode belongs to
  549. - `season_number` (numeric): Number of the season the video episode belongs to
  550. - `season_id` (string): Id of the season the video episode belongs to
  551. - `episode` (string): Title of the video episode
  552. - `episode_number` (numeric): Number of the video episode within a season
  553. - `episode_id` (string): Id of the video episode
  554. Available for the media that is a track or a part of a music album:
  555. - `track` (string): Title of the track
  556. - `track_number` (numeric): Number of the track within an album or a disc
  557. - `track_id` (string): Id of the track
  558. - `artist` (string): Artist(s) of the track
  559. - `genre` (string): Genre(s) of the track
  560. - `album` (string): Title of the album the track belongs to
  561. - `album_type` (string): Type of the album
  562. - `album_artist` (string): List of all artists appeared on the album
  563. - `disc_number` (numeric): Number of the disc or other physical medium the track belongs to
  564. - `release_year` (numeric): Year (YYYY) when the album was released
  565. Each aforementioned sequence when referenced in an output template will be replaced by the actual value corresponding to the sequence name. Note that some of the sequences are not guaranteed to be present since they depend on the metadata obtained by a particular extractor. Such sequences will be replaced with placeholder value provided with `--output-na-placeholder` (`NA` by default).
  566. For example for `-o %(title)s-%(id)s.%(ext)s` and an 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.
  567. For numeric sequences you can use numeric related formatting, for example, `%(view_count)05d` will result in a string with view count padded with zeros up to 5 characters, like in `00042`.
  568. Output templates can also contain arbitrary hierarchical path, e.g. `-o '%(playlist)s/%(playlist_index)s - %(title)s.%(ext)s'` which will result in downloading each video in a directory corresponding to this path template. Any missing directory will be automatically created for you.
  569. To use percent literals in an output template use `%%`. To output to stdout use `-o -`.
  570. The current default template is `%(title)s-%(id)s.%(ext)s`.
  571. 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.
  572. #### Output template and Windows batch files
  573. If you are using an output template inside a Windows batch file then you must escape plain percent characters (`%`) by doubling, so that `-o "%(title)s-%(id)s.%(ext)s"` should become `-o "%%(title)s-%%(id)s.%%(ext)s"`. However you should not touch `%`'s that are not plain characters, e.g. environment variables for expansion should stay intact: `-o "C:\%HOMEPATH%\Desktop\%%(title)s.%%(ext)s"`.
  574. #### Output template examples
  575. Note that on Windows you may need to use double quotes instead of single.
  576. ```bash
  577. $ youtube-dl --get-filename -o '%(title)s.%(ext)s' BaW_jenozKc
  578. youtube-dl test video ''_ä↭𝕐.mp4 # All kinds of weird characters
  579. $ youtube-dl --get-filename -o '%(title)s.%(ext)s' BaW_jenozKc --restrict-filenames
  580. youtube-dl_test_video_.mp4 # A simple file name
  581. # Download YouTube playlist videos in separate directory indexed by video order in a playlist
  582. $ youtube-dl -o '%(playlist)s/%(playlist_index)s - %(title)s.%(ext)s' https://www.youtube.com/playlist?list=PLwiyx1dc3P2JR9N8gQaQN_BCvlSlap7re
  583. # Download all playlists of YouTube channel/user keeping each playlist in separate directory:
  584. $ youtube-dl -o '%(uploader)s/%(playlist)s/%(playlist_index)s - %(title)s.%(ext)s' https://www.youtube.com/user/TheLinuxFoundation/playlists
  585. # Download Udemy course keeping each chapter in separate directory under MyVideos directory in your home
  586. $ 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/
  587. # Download entire series season keeping each series and each season in separate directory under C:/MyVideos
  588. $ youtube-dl -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
  589. # Stream the video being downloaded to stdout
  590. $ youtube-dl -o - BaW_jenozKc
  591. ```
  593. 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**.
  594. 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.
  595. 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.
  596. **tl;dr:** [navigate me to examples](#format-selection-examples).
  597. 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.
  598. You can also use a file extension (currently `3gp`, `aac`, `flv`, `m4a`, `mp3`, `mp4`, `ogg`, `wav`, `webm` are supported) to download the best quality format of a particular file extension served as a single file, e.g. `-f webm` will download the best quality format with the `webm` extension served as a single file.
  599. You can also use special names to select particular edge case formats:
  600. - `best`: Select the best quality format represented by a single file with video and audio.
  601. - `worst`: Select the worst quality format represented by a single file with video and audio.
  602. - `bestvideo`: Select the best quality video-only format (e.g. DASH video). May not be available.
  603. - `worstvideo`: Select the worst quality video-only format. May not be available.
  604. - `bestaudio`: Select the best quality audio only-format. May not be available.
  605. - `worstaudio`: Select the worst quality audio only-format. May not be available.
  606. For example, to download the worst quality video-only format you can use `-f worstvideo`.
  607. 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.
  608. If you want to download several formats of the same video use a comma as a separator, e.g. `-f 22,17,18` will download all these three formats, of course if they are available. Or a more sophisticated example combined with the precedence feature: `-f 136/137/mp4/bestvideo,140/m4a/bestaudio`.
  609. 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
  618. - `fps`: Frame rate
  619. Also filtering work for comparisons `=` (equals), `^=` (starts with), `$=` (ends with), `*=` (contains) and following string meta fields:
  620. - `ext`: File extension
  621. - `acodec`: Name of the audio codec in use
  622. - `vcodec`: Name of the video codec in use
  623. - `container`: Name of the container format
  624. - `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`)
  625. - `format_id`: A short description of the format
  626. - `language`: Language code
  627. Any string comparison may be prefixed with negation `!` in order to produce an opposite comparison, e.g. `!*=` (does not contain).
  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 the video hoster.
  629. 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.
  630. 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 the best video-only format, the best audio-only format and mux them together with ffmpeg/avconv.
  631. 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]'`.
  632. Since the end of April 2015 and version 2015.04.26, youtube-dl 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. 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.
  633. 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.
  634. #### Format selection examples
  635. Note that on Windows you may need to use double quotes instead of single.
  636. ```bash
  637. # Download best mp4 format available or any other best if no mp4 available
  638. $ youtube-dl -f 'bestvideo[ext=mp4]+bestaudio[ext=m4a]/best[ext=mp4]/best'
  639. # Download best format available but no better than 480p
  640. $ youtube-dl -f 'bestvideo[height<=480]+bestaudio/best[height<=480]'
  641. # Download best video only format but no bigger than 50 MB
  642. $ youtube-dl -f 'best[filesize<50M]'
  643. # Download best format available via direct link over HTTP/HTTPS protocol
  644. $ youtube-dl -f '(bestvideo+bestaudio/best)[protocol^=http]'
  645. # Download the best video format and the best audio format without merging them
  646. $ youtube-dl -f 'bestvideo,bestaudio' -o '%(title)s.f%(format_id)s.%(ext)s'
  647. ```
  648. Note that in the last example, an output template is recommended as bestvideo and bestaudio may have the same file name.
  650. Videos can be filtered by their upload date using the options `--date`, `--datebefore` or `--dateafter`. They accept dates in two formats:
  651. - Absolute dates: Dates in the format `YYYYMMDD`.
  652. - Relative dates: Dates in the format `(now|today)[+-][0-9](day|week|month|year)(s)?`
  653. Examples:
  654. ```bash
  655. # Download only the videos uploaded in the last 6 months
  656. $ youtube-dl --dateafter now-6months
  657. # Download only the videos uploaded on January 1, 1970
  658. $ youtube-dl --date 19700101
  659. $ # Download only the videos uploaded in the 200x decade
  660. $ youtube-dl --dateafter 20000101 --datebefore 20091231
  661. ```
  662. # FAQ
  663. ### How do I update youtube-dl?
  664. If you've followed [our manual installation instructions](https://ytdl-org.github.io/youtube-dl/download.html), you can simply run `youtube-dl -U` (or, on Linux, `sudo youtube-dl -U`).
  665. If you have used pip, a simple `sudo pip install -U youtube-dl` is sufficient to update.
  666. 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 https://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.
  667. 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
  668. sudo apt-get remove -y youtube-dl
  669. Afterwards, simply follow [our manual installation instructions](https://ytdl-org.github.io/youtube-dl/download.html):
  670. ```
  671. sudo wget https://yt-dl.org/downloads/latest/youtube-dl -O /usr/local/bin/youtube-dl
  672. sudo chmod a+rx /usr/local/bin/youtube-dl
  673. hash -r
  674. ```
  675. Again, from then on you'll be able to update with `sudo youtube-dl -U`.
  676. ### youtube-dl is extremely slow to start on Windows
  677. Add a file exclusion for `youtube-dl.exe` in Windows Defender settings.
  678. ### I'm getting an error `Unable to extract OpenGraph title` on YouTube playlists
  679. 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.
  680. 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 people](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.
  681. ### I'm getting an error when trying to use output template: `error: using output template conflicts with using title, video ID or auto number`
  682. 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.
  683. ### Do I always have to pass `-citw`?
  684. 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`.
  685. ### Can you please put the `-b` option back?
  686. 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.
  687. ### I get HTTP error 402 when trying to download a video. What's this?
  688. 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/ytdl-org/youtube-dl/issues/154), but at the moment, your best course of action is pointing a web browser to the youtube URL, solving the CAPTCHA, and restart youtube-dl.
  689. ### Do I need any other programs?
  690. 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.
  691. 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](https://mplayerhq.hu/) or [mpv](https://mpv.io/) to be installed.
  692. ### I have downloaded a video but how can I play it?
  693. Once the video is fully downloaded, use any video player, such as [mpv](https://mpv.io/), [vlc](https://www.videolan.org/) or [mplayer](https://www.mplayerhq.hu/).
  694. ### I extracted a video URL with `-g`, but it does not play on another machine / in my web browser.
  695. 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 and/or HTTP headers. 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. You can also get necessary cookies and HTTP headers from JSON output obtained with `--dump-json`.
  696. 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.
  697. 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.
  698. 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.
  699. ### ERROR: no fmt_url_map or conn information found in video info
  700. 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.
  701. ### ERROR: unable to download video
  702. 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.
  703. ### 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`
  704. 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).
  705. For example if your URL is https://www.youtube.com/watch?t=4&v=BaW_jenozKc you should end up with following command:
  706. ```youtube-dl 'https://www.youtube.com/watch?t=4&v=BaW_jenozKc'```
  707. or
  708. ```youtube-dl https://www.youtube.com/watch?t=4\&v=BaW_jenozKc```
  709. For Windows you have to use the double quotes:
  710. ```youtube-dl "https://www.youtube.com/watch?t=4&v=BaW_jenozKc"```
  711. ### ExtractorError: Could not find JS function u'OF'
  712. 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.
  713. ### HTTP Error 429: Too Many Requests or 402: Payment Required
  714. These two error codes indicate that the service is blocking your IP address because of overuse. Usually this is a soft block meaning that you can gain access again after solving CAPTCHA. Just open a browser and solve a CAPTCHA the service suggests you and after that [pass cookies](#how-do-i-pass-cookies-to-youtube-dl) to youtube-dl. Note that if your machine has multiple external IPs then you should also pass exactly the same IP you've used for solving CAPTCHA with [`--source-address`](#network-options). Also you may need to pass a `User-Agent` HTTP header of your browser with [`--user-agent`](#workarounds).
  715. If this is not the case (no CAPTCHA suggested to solve by the service) then you can 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.
  716. ### SyntaxError: Non-ASCII character
  717. The error
  718. File "youtube-dl", line 2
  719. SyntaxError: Non-ASCII character '\x93' ...
  720. means you're using an outdated version of Python. Please update to Python 2.6 or 2.7.
  721. ### What is this binary file? Where has the code gone?
  722. Since June 2012 ([#342](https://github.com/ytdl-org/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`.
  723. ### The exe throws an error due to missing `MSVCR100.dll`
  724. To run the exe you need to install first the [Microsoft Visual C++ 2010 Service Pack 1 Redistributable Package (x86)](https://download.microsoft.com/download/1/6/5/165255E7-1014-4D0A-B094-B6A430A6BFFC/vcredist_x86.exe).
  725. ### On Windows, how should I set up ffmpeg and youtube-dl? Where should I put the exe files?
  726. 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.
  727. 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.
  728. 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.
  729. ### How do I put downloads into a specific folder?
  730. 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).
  731. ### How do I download a video starting with a `-`?
  732. Either prepend `https://www.youtube.com/watch?v=` or separate the ID from the options with `--`:
  733. youtube-dl -- -wNyEUrxzFU
  734. youtube-dl "https://www.youtube.com/watch?v=-wNyEUrxzFU"
  735. ### How do I pass cookies to youtube-dl?
  736. Use the `--cookies` option, for example `--cookies /path/to/cookies/file.txt`.
  737. In order to extract cookies from browser use any conforming browser extension for exporting cookies. For example, [Get cookies.txt LOCALLY](https://chrome.google.com/webstore/detail/get-cookiestxt-locally/cclelndahbckbenkjhflpdbgdldlbecc) (for Chrome) or [cookies.txt](https://addons.mozilla.org/en-US/firefox/addon/cookies-txt/) (for Firefox).
  738. 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 and `LF` (`\n`) for Unix and Unix-like systems (Linux, macOS, etc.). `HTTP Error 400: Bad Request` when using `--cookies` is a good sign of invalid newline format.
  739. 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).
  740. ### How do I stream directly to media player?
  741. 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](https://www.videolan.org/) can be achieved with:
  742. youtube-dl -o - "https://www.youtube.com/watch?v=BaW_jenozKcj" | vlc -
  743. ### How do I download only new videos from a playlist?
  744. 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.
  745. For example, at first,
  746. youtube-dl --download-archive archive.txt "https://www.youtube.com/playlist?list=PLwiyx1dc3P2JR9N8gQaQN_BCvlSlap7re"
  747. will download the complete `PLwiyx1dc3P2JR9N8gQaQN_BCvlSlap7re` playlist and create a file `archive.txt`. Each subsequent run will only download new videos if any:
  748. youtube-dl --download-archive archive.txt "https://www.youtube.com/playlist?list=PLwiyx1dc3P2JR9N8gQaQN_BCvlSlap7re"
  749. ### Should I add `--hls-prefer-native` into my config?
  750. When youtube-dl detects an HLS video, it can download it either with the built-in downloader or ffmpeg. Since many HLS streams are slightly invalid and ffmpeg/youtube-dl each handle some invalid cases better than the other, there is an option to switch the downloader if needed.
  751. When youtube-dl knows that one particular downloader works better for a given website, that downloader will be picked. Otherwise, youtube-dl will pick the best downloader for general compatibility, which at the moment happens to be ffmpeg. This choice may change in future versions of youtube-dl, with improvements of the built-in downloader and/or ffmpeg.
  752. In particular, the generic extractor (used when your website is not in the [list of supported sites by youtube-dl](https://ytdl-org.github.io/youtube-dl/supportedsites.html) cannot mandate one specific downloader.
  753. If you put either `--hls-prefer-native` or `--hls-prefer-ffmpeg` into your configuration, a different subset of videos will fail to download correctly. Instead, it is much better to [file an issue](https://yt-dl.org/bug) or a pull request which details why the native or the ffmpeg HLS downloader is a better choice for your use case.
  754. ### Can you add support for this anime video site, or site which shows current movies for free?
  755. 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.
  756. 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.
  757. 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.
  758. ### How can I speed up work on my issue?
  759. (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:
  760. 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.
  761. 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.
  762. 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).
  763. 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`.
  764. ### How can I detect whether a given URL is supported by youtube-dl?
  765. 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 https://example.com/video/1234567 to https://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.
  766. 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.
  767. 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.
  768. # Why do I need to go through that much red tape when filing bugs?
  769. 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 already 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.
  770. 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.
  772. Most users do not need to build youtube-dl and can [download the builds](https://ytdl-org.github.io/youtube-dl/download.html) or get them from their distribution.
  773. To run youtube-dl as a developer, you don't need to build anything either. Simply execute
  774. python -m youtube_dl
  775. To run the test, simply invoke your favorite test runner, or execute a test file directly; any of the following work:
  776. python -m unittest discover
  777. python test/test_download.py
  778. nosetests
  779. For Python versions 3.6 and later, you can use [pynose](https://pypi.org/project/pynose/) to implement `nosetests`. The original [nose](https://pypi.org/project/nose/) has not been upgraded for 3.10 and later.
  780. See item 6 of [new extractor tutorial](#adding-support-for-a-new-site) for how to run extractor specific test cases.
  781. If you want to create a build of youtube-dl yourself, you'll need
  782. * python
  783. * make (only GNU make is supported)
  784. * pandoc
  785. * zip
  786. * nosetests
  787. ### Adding support for a new site
  788. If you want to add support for a new site, first of all **make sure** this site is **not dedicated to [copyright infringement](README.md#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**.
  789. After you have ensured this site is distributing its content legally, you can follow this quick list (assuming your service is called `yourextractor`):
  790. 1. [Fork this repository](https://github.com/ytdl-org/youtube-dl/fork)
  791. 2. Check out the source code with:
  792. git clone git@github.com:YOUR_GITHUB_USERNAME/youtube-dl.git
  793. 3. Start a new git branch with
  794. cd youtube-dl
  795. git checkout -b yourextractor
  796. 4. Start with this simple template and save it to `youtube_dl/extractor/yourextractor.py`:
  797. ```python
  798. # coding: utf-8
  799. from __future__ import unicode_literals
  800. from .common import InfoExtractor
  801. class YourExtractorIE(InfoExtractor):
  802. _VALID_URL = r'https?://(?:www\.)?yourextractor\.com/watch/(?P<id>[0-9]+)'
  803. _TEST = {
  804. 'url': 'https://yourextractor.com/watch/42',
  805. 'md5': 'TODO: md5 sum of the first 10241 bytes of the video file (use --test)',
  806. 'info_dict': {
  807. 'id': '42',
  808. 'ext': 'mp4',
  809. 'title': 'Video title goes here',
  810. 'thumbnail': r're:^https?://.*\.jpg$',
  811. # TODO more properties, either as:
  812. # * A value
  813. # * MD5 checksum; start the string with md5:
  814. # * A regular expression; start the string with re:
  815. # * Any Python type (for example int or float)
  816. }
  817. }
  818. def _real_extract(self, url):
  819. video_id = self._match_id(url)
  820. webpage = self._download_webpage(url, video_id)
  821. # TODO more code goes here, for example ...
  822. title = self._html_search_regex(r'<h1>(.+?)</h1>', webpage, 'title')
  823. return {
  824. 'id': video_id,
  825. 'title': title,
  826. 'description': self._og_search_description(webpage),
  827. 'uploader': self._search_regex(r'<div[^>]+id="uploader"[^>]*>([^<]+)<', webpage, 'uploader', fatal=False),
  828. # TODO more properties (see youtube_dl/extractor/common.py)
  829. }
  830. ```
  831. 5. Add an import in [`youtube_dl/extractor/extractors.py`](https://github.com/ytdl-org/youtube-dl/blob/master/youtube_dl/extractor/extractors.py).
  832. 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 (actually, test case) 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. Note:
  833. * the test names use the extractor class name **without the trailing `IE`**
  834. * tests with `only_matching` key in test's dict are not counted.
  835. 8. Have a look at [`youtube_dl/extractor/common.py`](https://github.com/ytdl-org/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/ytdl-org/youtube-dl/blob/7f41a598b3fba1bcab2817de64a08941200aa3c8/youtube_dl/extractor/common.py#L94-L303). Add tests and code for as many as you want.
  836. 9. Make sure your code follows [youtube-dl coding conventions](#youtube-dl-coding-conventions) and check the code with [flake8](https://flake8.pycqa.org/en/latest/index.html#quickstart):
  837. $ flake8 youtube_dl/extractor/yourextractor.py
  838. 9. Make sure your code works under all [Python](https://www.python.org/) versions claimed supported by youtube-dl, namely 2.6, 2.7, and 3.2+.
  839. 10. When the tests pass, [add](https://git-scm.com/docs/git-add) the new files and [commit](https://git-scm.com/docs/git-commit) them and [push](https://git-scm.com/docs/git-push) the result, like this:
  840. $ git add youtube_dl/extractor/extractors.py
  841. $ git add youtube_dl/extractor/yourextractor.py
  842. $ git commit -m '[yourextractor] Add new extractor'
  843. $ git push origin yourextractor
  844. 11. Finally, [create a pull request](https://help.github.com/articles/creating-a-pull-request). We'll then review and merge it.
  845. In any case, thank you very much for your contributions!
  846. ## youtube-dl coding conventions
  847. This section introduces guidelines for writing idiomatic, robust and future-proof extractor code.
  848. Extractors are very fragile by nature since they depend on the layout of the source data provided by 3rd party media hosters out of your control and this layout tends 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 dependency on the source's layout and even to make the code foresee potential future changes and be ready for that. This is important because it will allow the 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 a fix incorporated, all the previous versions become broken in all repositories and distros' packages that may not be so prompt in fetching the update from us. Needless to say, some non rolling release distros may never receive an update at all.
  849. ### Mandatory and optional metafields
  850. For extraction to work youtube-dl relies on metadata your extractor extracts and provides to youtube-dl expressed by an [information dictionary](https://github.com/ytdl-org/youtube-dl/blob/7f41a598b3fba1bcab2817de64a08941200aa3c8/youtube_dl/extractor/common.py#L94-L303) or simply *info dict*. Only the following meta fields in the *info dict* are considered mandatory for a successful extraction process by youtube-dl:
  851. - `id` (media identifier)
  852. - `title` (media title)
  853. - `url` (media download URL) or `formats`
  854. 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` as mandatory. Thus the aforementioned metafields are the critical data that the extraction does not make any sense without and if any of them fail to be extracted then the extractor is considered completely broken.
  855. [Any field](https://github.com/ytdl-org/youtube-dl/blob/7f41a598b3fba1bcab2817de64a08941200aa3c8/youtube_dl/extractor/common.py#L188-L303) apart from the aforementioned ones are considered **optional**. That means that extraction should be **tolerant** 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.
  856. #### Example
  857. Say you have some source dictionary `meta` that you've fetched as JSON with HTTP request and it has a key `summary`:
  858. ```python
  859. meta = self._download_json(url, video_id)
  860. ```
  861. Assume at this point `meta`'s layout is:
  862. ```python
  863. {
  864. ...
  865. "summary": "some fancy summary text",
  866. ...
  867. }
  868. ```
  869. Assume you want to extract `summary` and put it into the resulting info dict as `description`. Since `description` is an optional meta field you should be ready that this key may be missing from the `meta` dict, so that you should extract it like:
  870. ```python
  871. description = meta.get('summary') # correct
  872. ```
  873. and not like:
  874. ```python
  875. description = meta['summary'] # incorrect
  876. ```
  877. The latter will break extraction process with `KeyError` if `summary` disappears from `meta` at some later time but with the former approach extraction will just go ahead with `description` set to `None` which is perfectly fine (remember `None` is equivalent to the absence of data).
  878. Similarly, you should pass `fatal=False` when extracting optional data from a webpage with `_search_regex`, `_html_search_regex` or similar methods, for instance:
  879. ```python
  880. description = self._search_regex(
  881. r'<span[^>]+id="title"[^>]*>([^<]+)<',
  882. webpage, 'description', fatal=False)
  883. ```
  884. With `fatal` set to `False` if `_search_regex` fails to extract `description` it will emit a warning and continue extraction.
  885. You can also pass `default=<some fallback value>`, for example:
  886. ```python
  887. description = self._search_regex(
  888. r'<span[^>]+id="title"[^>]*>([^<]+)<',
  889. webpage, 'description', default=None)
  890. ```
  891. On failure this code will silently continue the extraction with `description` set to `None`. That is useful for metafields that may or may not be present.
  892. ### Provide fallbacks
  893. When extracting metadata try to do so from multiple sources. For example if `title` is present in several places, try extracting from at least some of them. This makes it more future-proof in case some of the sources become unavailable.
  894. #### Example
  895. Say `meta` from the previous example has a `title` and you are about to extract it. Since `title` is a mandatory meta field you should end up with something like:
  896. ```python
  897. title = meta['title']
  898. ```
  899. If `title` disappears from `meta` in future due to some changes on the hoster's side the extraction would fail since `title` is mandatory. That's expected.
  900. 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:
  901. ```python
  902. title = meta.get('title') or self._og_search_title(webpage)
  903. ```
  904. This code will try to extract from `meta` first and if it fails it will try extracting `og:title` from a `webpage`.
  905. ### Regular expressions
  906. #### Don't capture groups you don't use
  907. Capturing group must be an indication that it's used somewhere in the code. Any group that is not used must be non capturing.
  908. ##### Example
  909. Don't capture id attribute name here since you can't use it for anything anyway.
  910. Correct:
  911. ```python
  912. r'(?:id|ID)=(?P<id>\d+)'
  913. ```
  914. Incorrect:
  915. ```python
  916. r'(id|ID)=(?P<id>\d+)'
  917. ```
  918. #### Make regular expressions relaxed and flexible
  919. When using regular expressions try to write them fuzzy, relaxed and flexible, skipping insignificant parts that are more likely to change, allowing both single and double quotes for quoted values and so on.
  920. ##### Example
  921. Say you need to extract `title` from the following HTML code:
  922. ```html
  923. <span style="position: absolute; left: 910px; width: 90px; float: right; z-index: 9999;" class="title">some fancy title</span>
  924. ```
  925. The code for that task should look similar to:
  926. ```python
  927. title = self._search_regex(
  928. r'<span[^>]+class="title"[^>]*>([^<]+)', webpage, 'title')
  929. ```
  930. Or even better:
  931. ```python
  932. title = self._search_regex(
  933. r'<span[^>]+class=(["\'])title\1[^>]*>(?P<title>[^<]+)',
  934. webpage, 'title', group='title')
  935. ```
  936. Note how you tolerate potential changes in the `style` attribute's value or switch from using double quotes to single for `class` attribute:
  937. The code definitely should not look like:
  938. ```python
  939. title = self._search_regex(
  940. r'<span style="position: absolute; left: 910px; width: 90px; float: right; z-index: 9999;" class="title">(.*?)</span>',
  941. webpage, 'title', group='title')
  942. ```
  943. ### Long lines policy
  944. There is a soft limit to keep lines of code under 80 characters long. This means it should be respected if possible and if it does not make readability and code maintenance worse.
  945. For example, you should **never** split long string literals like URLs or some other often copied entities over multiple lines to fit this limit:
  946. Correct:
  947. ```python
  948. 'https://www.youtube.com/watch?v=FqZTN594JQw&list=PLMYEtVRpaqY00V9W81Cwmzp6N6vZqfUKD4'
  949. ```
  950. Incorrect:
  951. ```python
  952. 'https://www.youtube.com/watch?v=FqZTN594JQw&list='
  953. 'PLMYEtVRpaqY00V9W81Cwmzp6N6vZqfUKD4'
  954. ```
  955. ### Inline values
  956. Extracting variables is acceptable for reducing code duplication and improving readability of complex expressions. However, you should avoid extracting variables used only once and moving them to opposite parts of the extractor file, which makes reading the linear flow difficult.
  957. #### Example
  958. Correct:
  959. ```python
  960. title = self._html_search_regex(r'<title>([^<]+)</title>', webpage, 'title')
  961. ```
  962. Incorrect:
  963. ```python
  964. TITLE_RE = r'<title>([^<]+)</title>'
  965. # ...some lines of code...
  966. title = self._html_search_regex(TITLE_RE, webpage, 'title')
  967. ```
  968. ### Collapse fallbacks
  969. Multiple fallback values can quickly become unwieldy. Collapse multiple fallback values into a single expression via a list of patterns.
  970. #### Example
  971. Good:
  972. ```python
  973. description = self._html_search_meta(
  974. ['og:description', 'description', 'twitter:description'],
  975. webpage, 'description', default=None)
  976. ```
  977. Unwieldy:
  978. ```python
  979. description = (
  980. self._og_search_description(webpage, default=None)
  981. or self._html_search_meta('description', webpage, default=None)
  982. or self._html_search_meta('twitter:description', webpage, default=None))
  983. ```
  984. Methods supporting list of patterns are: `_search_regex`, `_html_search_regex`, `_og_search_property`, `_html_search_meta`.
  985. ### Trailing parentheses
  986. Always move trailing parentheses after the last argument.
  987. #### Example
  988. Correct:
  989. ```python
  990. lambda x: x['ResultSet']['Result'][0]['VideoUrlSet']['VideoUrl'],
  991. list)
  992. ```
  993. Incorrect:
  994. ```python
  995. lambda x: x['ResultSet']['Result'][0]['VideoUrlSet']['VideoUrl'],
  996. list,
  997. )
  998. ```
  999. ### Use convenience conversion and parsing functions
  1000. Wrap all extracted numeric data into safe functions from [`youtube_dl/utils.py`](https://github.com/ytdl-org/youtube-dl/blob/master/youtube_dl/utils.py): `int_or_none`, `float_or_none`. Use them for string to number conversions as well.
  1001. Use `url_or_none` for safe URL processing.
  1002. Use `traverse_obj` for safe metadata extraction from parsed JSON.
  1003. Use `unified_strdate` for uniform `upload_date` or any `YYYYMMDD` meta field extraction, `unified_timestamp` for uniform `timestamp` extraction, `parse_filesize` for `filesize` extraction, `parse_count` for count meta fields extraction, `parse_resolution`, `parse_duration` for `duration` extraction, `parse_age_limit` for `age_limit` extraction.
  1004. Explore [`youtube_dl/utils.py`](https://github.com/ytdl-org/youtube-dl/blob/master/youtube_dl/utils.py) for more useful convenience functions.
  1005. #### More examples
  1006. ##### Safely extract optional description from parsed JSON
  1007. When processing complex JSON, as often returned by site API requests or stashed in web pages for "hydration", you can use the `traverse_obj()` utility function to handle multiple fallback values and to ensure the expected type of metadata items. The function's docstring defines how the function works: also review usage in the codebase for more examples.
  1008. In this example, a text `description`, or `None`, is pulled from the `.result.video[0].summary` member of the parsed JSON `response`, if available.
  1009. ```python
  1010. description = traverse_obj(response, ('result', 'video', 0, 'summary', T(compat_str)))
  1011. ```
  1012. `T(...)` is a shorthand for a set literal; if you hate people who still run Python 2.6, `T(type_or_transformation)` could be written as a set literal `{type_or_transformation}`.
  1013. Some extractors use the older and less capable `try_get()` function in the same way.
  1014. ```python
  1015. description = try_get(response, lambda x: x['result']['video'][0]['summary'], compat_str)
  1016. ```
  1017. ##### Safely extract more optional metadata
  1018. In this example, various optional metadata values are extracted from the `.result.video[0]` member of the parsed JSON `response`, which is expected to be a JS object, parsed into a `dict`, with no crash if that isn't so, or if any of the target values are missing or invalid.
  1019. ```python
  1020. video = traverse_obj(response, ('result', 'video', 0, T(dict))) or {}
  1021. # formerly:
  1022. # video = try_get(response, lambda x: x['result']['video'][0], dict) or {}
  1023. description = video.get('summary')
  1024. duration = float_or_none(video.get('durationMs'), scale=1000)
  1025. view_count = int_or_none(video.get('views'))
  1026. ```
  1027. #### Safely extract nested lists
  1028. Suppose you've extracted JSON like this into a Python data structure named `media_json` using, say, the `_download_json()` or `_parse_json()` methods of `InfoExtractor`:
  1029. ```json
  1030. {
  1031. "title": "Example video",
  1032. "comment": "try extracting this",
  1033. "media": [{
  1034. "type": "bad",
  1035. "size": 320,
  1036. "url": "https://some.cdn.site/bad.mp4"
  1037. }, {
  1038. "type": "streaming",
  1039. "url": "https://some.cdn.site/hls.m3u8"
  1040. }, {
  1041. "type": "super",
  1042. "size": 1280,
  1043. "url": "https://some.cdn.site/good.webm"
  1044. }],
  1045. "moreStuff": "more values",
  1046. ...
  1047. }
  1048. ```
  1049. Then extractor code like this can collect the various fields of the JSON:
  1050. ```python
  1051. ...
  1052. from ..utils import (
  1053. determine_ext,
  1054. int_or_none,
  1055. T,
  1056. traverse_obj,
  1057. txt_or_none,
  1058. url_or_none,
  1059. )
  1060. ...
  1061. ...
  1062. info_dict = {}
  1063. # extract title and description if valid and not empty
  1064. info_dict.update(traverse_obj(media_json, {
  1065. 'title': ('title', T(txt_or_none)),
  1066. 'description': ('comment', T(txt_or_none)),
  1067. }))
  1068. # extract any recognisable media formats
  1069. fmts = []
  1070. # traverse into "media" list, extract `dict`s with desired keys
  1071. for fmt in traverse_obj(media_json, ('media', Ellipsis, {
  1072. 'format_id': ('type', T(txt_or_none)),
  1073. 'url': ('url', T(url_or_none)),
  1074. 'width': ('size', T(int_or_none)), })):
  1075. # bad `fmt` values were `None` and removed
  1076. if 'url' not in fmt:
  1077. continue
  1078. fmt_url = fmt['url'] # known to be valid URL
  1079. ext = determine_ext(fmt_url)
  1080. if ext == 'm3u8':
  1081. fmts.extend(self._extract_m3u8_formats(fmt_url, video_id, 'mp4', fatal=False))
  1082. else:
  1083. fmt['ext'] = ext
  1084. fmts.append(fmt)
  1085. # sort, raise if no formats
  1086. self._sort_formats(fmts)
  1087. info_dict['formats'] = fmts
  1088. ...
  1089. ```
  1090. The extractor raises an exception rather than random crashes if the JSON structure changes so that no formats are found.
  1092. 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/ytdl-org/youtube-dl/issues/new).
  1093. From a Python program, you can embed youtube-dl in a more powerful fashion, like this:
  1094. ```python
  1095. from __future__ import unicode_literals
  1096. import youtube_dl
  1097. ydl_opts = {}
  1098. with youtube_dl.YoutubeDL(ydl_opts) as ydl:
  1099. ydl.download(['https://www.youtube.com/watch?v=BaW_jenozKc'])
  1100. ```
  1101. 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/ytdl-org/youtube-dl/blob/3e4cedf9e8cd3157df2457df7274d0c842421945/youtube_dl/YoutubeDL.py#L137-L312). For a start, if you want to intercept youtube-dl's output, set a `logger` object.
  1102. 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:
  1103. ```python
  1104. from __future__ import unicode_literals
  1105. import youtube_dl
  1106. class MyLogger(object):
  1107. def debug(self, msg):
  1108. pass
  1109. def warning(self, msg):
  1110. pass
  1111. def error(self, msg):
  1112. print(msg)
  1113. def my_hook(d):
  1114. if d['status'] == 'finished':
  1115. print('Done downloading, now converting ...')
  1116. ydl_opts = {
  1117. 'format': 'bestaudio/best',
  1118. 'postprocessors': [{
  1119. 'key': 'FFmpegExtractAudio',
  1120. 'preferredcodec': 'mp3',
  1121. 'preferredquality': '192',
  1122. }],
  1123. 'logger': MyLogger(),
  1124. 'progress_hooks': [my_hook],
  1125. }
  1126. with youtube_dl.YoutubeDL(ydl_opts) as ydl:
  1127. ydl.download(['https://www.youtube.com/watch?v=BaW_jenozKc'])
  1128. ```
  1129. # BUGS
  1130. Bugs and suggestions should be reported in the issue tracker: <https://github.com/ytdl-org/youtube-dl/issues> (<https://yt-dl.org/bug> is an alias for this). Unless you were prompted to 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](https://webchat.freenode.net/?randomnick=1&channels=youtube-dl)).
  1131. ## Opening a bug report or suggestion
  1132. Be sure to follow instructions provided **below** and **in the issue tracker**. Complete the appropriate issue template fully. Consider whether your problem is covered by an existing issue: if so, follow the discussion there. Avoid commenting on existing duplicate issues as such comments do not add to the discussion of the issue and are liable to be treated as spam.
  1133. **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:
  1134. ```
  1135. $ youtube-dl -v <your command line>
  1136. [debug] System config: []
  1137. [debug] User config: []
  1138. [debug] Command-line args: [u'-v', u'https://www.youtube.com/watch?v=BaW_jenozKcj']
  1139. [debug] Encodings: locale cp1251, fs mbcs, out cp866, pref cp1251
  1140. [debug] youtube-dl version 2015.12.06
  1141. [debug] Git HEAD: 135392e
  1142. [debug] Python version 2.6.6 - Windows-2003Server-5.2.3790-SP2
  1143. [debug] exe versions: ffmpeg N-75573-g1d0487f, ffprobe N-75573-g1d0487f, rtmpdump 2.4
  1144. [debug] Proxy map: {}
  1145. ...
  1146. ```
  1147. **Do not post screenshots of verbose logs; only plain text is acceptable.**
  1148. 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.
  1149. Finally please review your issue to avoid various common mistakes (you can and should use this as a checklist) listed below.
  1150. ### Is the description of the issue itself sufficient?
  1151. We often get issue reports that are hard to understand. To avoid subsequent clarifications, and to assist participants who are not native English speakers, please elaborate on what feature you are requesting, or what bug you want to be fixed.
  1152. Make sure that it's obvious
  1153. - What the problem is
  1154. - How it could be fixed
  1155. - How your proposed solution would look
  1156. 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.
  1157. 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.
  1158. 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/).
  1159. **Site support requests must contain an example URL**. An example URL is a URL you might want to download, like `https://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. `https://www.youtube.com/`) is *not* an example URL.
  1160. ### Is the issue already documented?
  1161. 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/ytdl-org/youtube-dl/search?type=Issues) of this repository. Initially, at least, use the search term `-label:duplicate` to focus on active issues. 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.
  1162. ### Are you using the latest version?
  1163. 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.
  1164. ### Why are existing options not enough?
  1165. Before requesting a new feature, please have a quick peek at [the list of supported options](https://github.com/ytdl-org/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.
  1166. ### Is there enough context in your bug report?
  1167. 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).
  1168. 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.
  1169. ### Does the issue involve one problem, and one problem only?
  1170. 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.
  1171. 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, White house 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.
  1172. ### Is anyone going to need the feature?
  1173. 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.
  1174. ### Is your question about youtube-dl?
  1175. 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.
  1176. # COPYRIGHT
  1177. youtube-dl is released into the public domain by the copyright holders.
  1178. This README file was originally written by [Daniel Bolton](https://github.com/dbbolton) and is likewise released into the public domain.