]>
Commit | Line | Data |
---|---|---|
235b3ba4 PH |
1 | #!/usr/bin/env python |
2 | # -*- coding: utf-8 -*- | |
3 | ||
3906e6ce | 4 | __authors__ = ( |
59ae15a5 PH |
5 | 'Ricardo Garcia Gonzalez', |
6 | 'Danny Colligan', | |
7 | 'Benjamin Johnson', | |
8 | 'Vasyl\' Vavrychuk', | |
9 | 'Witold Baryluk', | |
10 | 'Paweł Paprota', | |
11 | 'Gergely Imreh', | |
12 | 'Rogério Brito', | |
13 | 'Philipp Hagemeister', | |
14 | 'Sören Schulze', | |
15 | 'Kevin Ngo', | |
16 | 'Ori Avtalion', | |
17 | 'shizeeg', | |
18 | 'Filippo Valsorda', | |
19 | 'Christian Albrecht', | |
88f6c78b | 20 | 'Dave Vasilevsky', |
2069acc6 | 21 | 'Jaime Marquínez Ferrándiz', |
fffec3b9 | 22 | 'Jeff Crouse', |
6aabe820 | 23 | 'Osama Khalid', |
e8600d69 | 24 | 'Michael Walter', |
95464f14 | 25 | 'M. Yasoob Ullah Khalid', |
0ae456f0 | 26 | 'Julien Fraichard', |
be74864a | 27 | 'Johny Mo Swag', |
df725153 | 28 | 'Axel Noack', |
ba7a1de0 | 29 | 'Albert Kim', |
4a55479f | 30 | 'Pierre Rudloff', |
085bea45 | 31 | 'Huarong Huo', |
ac4f319b | 32 | 'Ismael Mejía', |
2dad310e | 33 | 'Steffan \'Ruirize\' James', |
a623df4c | 34 | 'Andras Elso', |
b5bdc269 | 35 | 'Jelle van der Waa', |
d3793638 | 36 | 'Marcin Cieślak', |
0a120f74 | 37 | 'Anton Larionov', |
38b2db6a | 38 | 'Takuya Tsuchida', |
87968574 | 39 | 'Sergey M.', |
b83be81d | 40 | 'Michael Orlitzky', |
ba7a1de0 | 41 | ) |
235b3ba4 PH |
42 | |
43 | __license__ = 'Public Domain' | |
235b3ba4 | 44 | |
0d94f247 | 45 | import codecs |
c9ed14e6 | 46 | import getpass |
fd46a318 | 47 | import locale |
c9ed14e6 | 48 | import optparse |
235b3ba4 | 49 | import os |
0f818663 | 50 | import random |
235b3ba4 | 51 | import re |
c9ed14e6 | 52 | import shlex |
235b3ba4 | 53 | import sys |
235b3ba4 | 54 | |
c496ca96 | 55 | |
a4fd0415 | 56 | from .utils import ( |
a4fd0415 | 57 | compat_print, |
a4fd0415 PH |
58 | DateRange, |
59 | decodeOption, | |
1c088fa8 | 60 | get_term_width, |
a4fd0415 PH |
61 | DownloadError, |
62 | get_cachedir, | |
a4fd0415 | 63 | MaxDownloadsReached, |
a4fd0415 PH |
64 | preferredencoding, |
65 | SameFileError, | |
e3946f98 | 66 | setproctitle, |
a4fd0415 PH |
67 | std_headers, |
68 | write_string, | |
a4fd0415 | 69 | ) |
d5ed35b6 | 70 | from .update import update_self |
a4fd0415 PH |
71 | from .FileDownloader import ( |
72 | FileDownloader, | |
73 | ) | |
0824c28c | 74 | from .extractor import gen_extractors |
dca08720 | 75 | from .version import __version__ |
8222d8de | 76 | from .YoutubeDL import YoutubeDL |
a4fd0415 PH |
77 | from .PostProcessor import ( |
78 | FFmpegMetadataPP, | |
79 | FFmpegVideoConvertor, | |
80 | FFmpegExtractAudioPP, | |
81 | FFmpegEmbedSubtitlePP, | |
82 | ) | |
83 | ||
235b3ba4 | 84 | |
75b5c590 | 85 | def parseOpts(overrideArguments=None): |
fb27c229 | 86 | def _readOptions(filename_bytes, default=[]): |
59ae15a5 PH |
87 | try: |
88 | optionf = open(filename_bytes) | |
89 | except IOError: | |
fb27c229 | 90 | return default # silently skip if file is not present |
59ae15a5 | 91 | try: |
a0eaa341 PH |
92 | res = [] |
93 | for l in optionf: | |
94 | res += shlex.split(l, comments=True) | |
59ae15a5 PH |
95 | finally: |
96 | optionf.close() | |
97 | return res | |
98 | ||
99 | def _format_option_string(option): | |
100 | ''' ('-o', '--option') -> -o, --format METAVAR''' | |
101 | ||
102 | opts = [] | |
103 | ||
104 | if option._short_opts: | |
105 | opts.append(option._short_opts[0]) | |
106 | if option._long_opts: | |
107 | opts.append(option._long_opts[0]) | |
108 | if len(opts) > 1: | |
109 | opts.insert(1, ', ') | |
110 | ||
111 | if option.takes_value(): opts.append(' %s' % option.metavar) | |
112 | ||
113 | return "".join(opts) | |
114 | ||
d6e203b3 IM |
115 | def _comma_separated_values_options_callback(option, opt_str, value, parser): |
116 | setattr(parser.values, option.dest, value.split(',')) | |
117 | ||
920ef077 JMF |
118 | def _hide_login_info(opts): |
119 | opts = list(opts) | |
3126050c | 120 | for private_opt in ['-p', '--password', '-u', '--username', '--video-password']: |
920ef077 JMF |
121 | try: |
122 | i = opts.index(private_opt) | |
123 | opts[i+1] = '<PRIVATE>' | |
124 | except ValueError: | |
125 | pass | |
126 | return opts | |
127 | ||
59ae15a5 PH |
128 | max_width = 80 |
129 | max_help_position = 80 | |
130 | ||
131 | # No need to wrap help messages if we're on a wide console | |
1c088fa8 | 132 | columns = get_term_width() |
59ae15a5 PH |
133 | if columns: max_width = columns |
134 | ||
135 | fmt = optparse.IndentedHelpFormatter(width=max_width, max_help_position=max_help_position) | |
136 | fmt.format_option_strings = _format_option_string | |
137 | ||
138 | kw = { | |
139 | 'version' : __version__, | |
140 | 'formatter' : fmt, | |
141 | 'usage' : '%prog [options] url [url...]', | |
142 | 'conflict_handler' : 'resolve', | |
143 | } | |
144 | ||
145 | parser = optparse.OptionParser(**kw) | |
146 | ||
147 | # option groups | |
148 | general = optparse.OptionGroup(parser, 'General Options') | |
149 | selection = optparse.OptionGroup(parser, 'Video Selection') | |
150 | authentication = optparse.OptionGroup(parser, 'Authentication Options') | |
151 | video_format = optparse.OptionGroup(parser, 'Video Format Options') | |
505c28aa | 152 | subtitles = optparse.OptionGroup(parser, 'Subtitle Options') |
0beb3add | 153 | downloader = optparse.OptionGroup(parser, 'Download Options') |
59ae15a5 PH |
154 | postproc = optparse.OptionGroup(parser, 'Post-processing Options') |
155 | filesystem = optparse.OptionGroup(parser, 'Filesystem Options') | |
156 | verbosity = optparse.OptionGroup(parser, 'Verbosity / Simulation Options') | |
157 | ||
158 | general.add_option('-h', '--help', | |
159 | action='help', help='print this help text and exit') | |
160 | general.add_option('-v', '--version', | |
161 | action='version', help='print program version and exit') | |
162 | general.add_option('-U', '--update', | |
f631c331 | 163 | action='store_true', dest='update_self', help='update this program to latest version. Make sure that you have sufficient permissions (run with sudo if needed)') |
59ae15a5 | 164 | general.add_option('-i', '--ignore-errors', |
830dd194 | 165 | action='store_true', dest='ignoreerrors', help='continue on download errors, for example to to skip unavailable videos in a playlist', default=False) |
41fd7c7e PH |
166 | general.add_option('--abort-on-error', |
167 | action='store_false', dest='ignoreerrors', | |
168 | help='Abort downloading of further videos (in the playlist or the command line) if an error occurs') | |
59ae15a5 PH |
169 | general.add_option('--dump-user-agent', |
170 | action='store_true', dest='dump_user_agent', | |
171 | help='display the current browser identification', default=False) | |
172 | general.add_option('--user-agent', | |
173 | dest='user_agent', help='specify a custom user agent', metavar='UA') | |
28535652 | 174 | general.add_option('--referer', |
3820df01 JMF |
175 | dest='referer', help='specify a custom referer, use if the video access is restricted to one domain', |
176 | metavar='REF', default=None) | |
59ae15a5 PH |
177 | general.add_option('--list-extractors', |
178 | action='store_true', dest='list_extractors', | |
179 | help='List all supported extractors and the URLs they would handle', default=False) | |
62067cb9 | 180 | general.add_option('--extractor-descriptions', |
0f818663 PH |
181 | action='store_true', dest='list_extractor_descriptions', |
182 | help='Output descriptions of all supported extractors', default=False) | |
cf6758d2 PH |
183 | general.add_option( |
184 | '--proxy', dest='proxy', default=None, metavar='URL', | |
185 | help='Use the specified HTTP/HTTPS proxy. Pass in an empty string (--proxy "") for direct connection') | |
ea6d901e | 186 | general.add_option('--no-check-certificate', action='store_true', dest='no_check_certificate', default=False, help='Suppress HTTPS certificate validation.') |
7f747732 | 187 | general.add_option( |
cce722b7 | 188 | '--cache-dir', dest='cachedir', default=get_cachedir(), metavar='DIR', |
0f306583 | 189 | help='Location in the filesystem where youtube-dl can store some downloaded information permanently. By default $XDG_CACHE_HOME/youtube-dl or ~/.cache/youtube-dl .') |
7f747732 PH |
190 | general.add_option( |
191 | '--no-cache-dir', action='store_const', const=None, dest='cachedir', | |
192 | help='Disable filesystem caching') | |
6ad14cab PH |
193 | general.add_option( |
194 | '--socket-timeout', dest='socket_timeout', | |
195 | type=float, default=None, help=optparse.SUPPRESS_HELP) | |
0783b09b PH |
196 | general.add_option( |
197 | '--bidi-workaround', dest='bidi_workaround', action='store_true', | |
5d681e96 | 198 | help=u'Work around terminals that lack bidirectional text support. Requires bidiv or fribidi executable in PATH') |
0beb3add | 199 | |
59ae15a5 | 200 | |
a19fd00c PH |
201 | selection.add_option( |
202 | '--playlist-start', | |
203 | dest='playliststart', metavar='NUMBER', default=1, type=int, | |
204 | help='playlist video to start at (default is %default)') | |
205 | selection.add_option( | |
206 | '--playlist-end', | |
207 | dest='playlistend', metavar='NUMBER', default=None, type=int, | |
208 | help='playlist video to end at (default is last)') | |
59ae15a5 PH |
209 | selection.add_option('--match-title', dest='matchtitle', metavar='REGEX',help='download only matching titles (regex or caseless sub-string)') |
210 | selection.add_option('--reject-title', dest='rejecttitle', metavar='REGEX',help='skip download for matching titles (regex or caseless sub-string)') | |
0c75c3fa PH |
211 | selection.add_option('--max-downloads', metavar='NUMBER', |
212 | dest='max_downloads', type=int, default=None, | |
213 | help='Abort after downloading NUMBER files') | |
dbf2ba3d PH |
214 | selection.add_option('--min-filesize', metavar='SIZE', dest='min_filesize', help="Do not download any videos smaller than SIZE (e.g. 50k or 44.6m)", default=None) |
215 | selection.add_option('--max-filesize', metavar='SIZE', dest='max_filesize', help="Do not download any videos larger than SIZE (e.g. 50k or 44.6m)", default=None) | |
bd558525 JMF |
216 | selection.add_option('--date', metavar='DATE', dest='date', help='download only videos uploaded in this date', default=None) |
217 | selection.add_option('--datebefore', metavar='DATE', dest='datebefore', help='download only videos uploaded before this date', default=None) | |
218 | selection.add_option('--dateafter', metavar='DATE', dest='dateafter', help='download only videos uploaded after this date', default=None) | |
5fe18bdb PH |
219 | selection.add_option( |
220 | '--min-views', metavar='COUNT', dest='min_views', | |
221 | default=None, type=int, | |
222 | help="Do not download any videos with less than COUNT views",) | |
223 | selection.add_option( | |
224 | '--max-views', metavar='COUNT', dest='max_views', | |
225 | default=None, type=int, | |
226 | help="Do not download any videos with more than COUNT views",) | |
47192f92 | 227 | selection.add_option('--no-playlist', action='store_true', dest='noplaylist', help='download only the currently playing video', default=False) |
8dbe9899 PH |
228 | selection.add_option('--age-limit', metavar='YEARS', dest='age_limit', |
229 | help='download only videos suitable for the given age', | |
230 | default=None, type=int) | |
c1c9a79c PH |
231 | selection.add_option('--download-archive', metavar='FILE', |
232 | dest='download_archive', | |
36a826a5 | 233 | help='Download only videos not listed in the archive file. Record the IDs of all downloaded videos in it.') |
9e982f9e JC |
234 | |
235 | ||
59ae15a5 PH |
236 | authentication.add_option('-u', '--username', |
237 | dest='username', metavar='USERNAME', help='account username') | |
238 | authentication.add_option('-p', '--password', | |
239 | dest='password', metavar='PASSWORD', help='account password') | |
240 | authentication.add_option('-n', '--netrc', | |
241 | action='store_true', dest='usenetrc', help='use .netrc authentication data', default=False) | |
c6c19746 JMF |
242 | authentication.add_option('--video-password', |
243 | dest='videopassword', metavar='PASSWORD', help='video password (vimeo only)') | |
59ae15a5 PH |
244 | |
245 | ||
246 | video_format.add_option('-f', '--format', | |
dd82ffea | 247 | action='store', dest='format', metavar='FORMAT', default='best', |
9986238b | 248 | help='video format code, specify the order of preference using slashes: "-f 22/17/18". "-f mp4" and "-f flv" are also supported') |
59ae15a5 PH |
249 | video_format.add_option('--all-formats', |
250 | action='store_const', dest='format', help='download all available video formats', const='all') | |
251 | video_format.add_option('--prefer-free-formats', | |
252 | action='store_true', dest='prefer_free_formats', default=False, help='prefer free video formats unless a specific one is requested') | |
253 | video_format.add_option('--max-quality', | |
254 | action='store', dest='format_limit', metavar='FORMAT', help='highest quality format to download') | |
255 | video_format.add_option('-F', '--list-formats', | |
256 | action='store_true', dest='listformats', help='list all available formats (currently youtube only)') | |
505c28aa IM |
257 | |
258 | subtitles.add_option('--write-sub', '--write-srt', | |
59ae15a5 | 259 | action='store_true', dest='writesubtitles', |
953e32b2 | 260 | help='write subtitle file', default=False) |
505c28aa | 261 | subtitles.add_option('--write-auto-sub', '--write-automatic-sub', |
b004821f | 262 | action='store_true', dest='writeautomaticsub', |
953e32b2 | 263 | help='write automatic subtitle file (youtube only)', default=False) |
505c28aa | 264 | subtitles.add_option('--all-subs', |
ae608b80 | 265 | action='store_true', dest='allsubtitles', |
953e32b2 | 266 | help='downloads all the available subtitles of the video', default=False) |
505c28aa | 267 | subtitles.add_option('--list-subs', |
2a4093ea | 268 | action='store_true', dest='listsubtitles', |
953e32b2 | 269 | help='lists all available subtitles for the video', default=False) |
505c28aa | 270 | subtitles.add_option('--sub-format', |
c3ab8f86 | 271 | action='store', dest='subtitlesformat', metavar='FORMAT', |
953e32b2 | 272 | help='subtitle format (default=srt) ([sbv/vtt] youtube only)', default='srt') |
d6e203b3 IM |
273 | subtitles.add_option('--sub-lang', '--sub-langs', '--srt-lang', |
274 | action='callback', dest='subtitleslangs', metavar='LANGS', type='str', | |
275 | default=[], callback=_comma_separated_values_options_callback, | |
276 | help='languages of the subtitles to download (optional) separated by commas, use IETF language tags like \'en,pt\'') | |
59ae15a5 | 277 | |
0beb3add | 278 | downloader.add_option('-r', '--rate-limit', |
cd054fc4 | 279 | dest='ratelimit', metavar='LIMIT', help='maximum download rate in bytes per second (e.g. 50K or 4.2M)') |
0beb3add PH |
280 | downloader.add_option('-R', '--retries', |
281 | dest='retries', metavar='RETRIES', help='number of retries (default is %default)', default=10) | |
282 | downloader.add_option('--buffer-size', | |
cd054fc4 | 283 | dest='buffersize', metavar='SIZE', help='size of download buffer (e.g. 1024 or 16K) (default is %default)', default="1024") |
0beb3add PH |
284 | downloader.add_option('--no-resize-buffer', |
285 | action='store_true', dest='noresizebuffer', | |
286 | help='do not automatically adjust the buffer size. By default, the buffer size is automatically resized from an initial value of SIZE.', default=False) | |
287 | downloader.add_option('--test', action='store_true', dest='test', default=False, help=optparse.SUPPRESS_HELP) | |
288 | ||
59ae15a5 PH |
289 | verbosity.add_option('-q', '--quiet', |
290 | action='store_true', dest='quiet', help='activates quiet mode', default=False) | |
291 | verbosity.add_option('-s', '--simulate', | |
292 | action='store_true', dest='simulate', help='do not download the video and do not write anything to disk', default=False) | |
293 | verbosity.add_option('--skip-download', | |
294 | action='store_true', dest='skip_download', help='do not download the video', default=False) | |
295 | verbosity.add_option('-g', '--get-url', | |
296 | action='store_true', dest='geturl', help='simulate, quiet but print URL', default=False) | |
297 | verbosity.add_option('-e', '--get-title', | |
298 | action='store_true', dest='gettitle', help='simulate, quiet but print title', default=False) | |
1a2adf3f | 299 | verbosity.add_option('--get-id', |
300 | action='store_true', dest='getid', help='simulate, quiet but print id', default=False) | |
59ae15a5 PH |
301 | verbosity.add_option('--get-thumbnail', |
302 | action='store_true', dest='getthumbnail', | |
303 | help='simulate, quiet but print thumbnail URL', default=False) | |
304 | verbosity.add_option('--get-description', | |
305 | action='store_true', dest='getdescription', | |
306 | help='simulate, quiet but print video description', default=False) | |
525ef922 PH |
307 | verbosity.add_option('--get-duration', |
308 | action='store_true', dest='getduration', | |
309 | help='simulate, quiet but print video length', default=False) | |
59ae15a5 PH |
310 | verbosity.add_option('--get-filename', |
311 | action='store_true', dest='getfilename', | |
312 | help='simulate, quiet but print output filename', default=False) | |
313 | verbosity.add_option('--get-format', | |
314 | action='store_true', dest='getformat', | |
315 | help='simulate, quiet but print output format', default=False) | |
9d153818 MF |
316 | verbosity.add_option('-j', '--dump-json', |
317 | action='store_true', dest='dumpjson', | |
8694c600 | 318 | help='simulate, quiet but print JSON information', default=False) |
7311fef8 | 319 | verbosity.add_option('--newline', |
5717d91a | 320 | action='store_true', dest='progress_with_newline', help='output progress bar as new lines', default=False) |
59ae15a5 PH |
321 | verbosity.add_option('--no-progress', |
322 | action='store_true', dest='noprogress', help='do not print progress bar', default=False) | |
323 | verbosity.add_option('--console-title', | |
324 | action='store_true', dest='consoletitle', | |
325 | help='display progress in console titlebar', default=False) | |
326 | verbosity.add_option('-v', '--verbose', | |
327 | action='store_true', dest='verbose', help='print various debugging information', default=False) | |
855703e5 PH |
328 | verbosity.add_option('--dump-intermediate-pages', |
329 | action='store_true', dest='dump_intermediate_pages', default=False, | |
330 | help='print downloaded pages to debug problems(very verbose)') | |
d41e6efc PH |
331 | verbosity.add_option('--write-pages', |
332 | action='store_true', dest='write_pages', default=False, | |
06dcbb71 | 333 | help='Write downloaded intermediary pages to files in the current directory to debug problems') |
edf3e38e PH |
334 | verbosity.add_option('--youtube-print-sig-code', |
335 | action='store_true', dest='youtube_print_sig_code', default=False, | |
336 | help=optparse.SUPPRESS_HELP) | |
a0ddb8a2 PH |
337 | verbosity.add_option('--print-traffic', |
338 | dest='debug_printtraffic', action='store_true', default=False, | |
339 | help=optparse.SUPPRESS_HELP) | |
59ae15a5 | 340 | |
59ae15a5 | 341 | filesystem.add_option('-t', '--title', |
08b2ac74 | 342 | action='store_true', dest='usetitle', help='use title in file name (default)', default=False) |
59ae15a5 | 343 | filesystem.add_option('--id', |
08b2ac74 | 344 | action='store_true', dest='useid', help='use only video ID in file name', default=False) |
59ae15a5 PH |
345 | filesystem.add_option('-l', '--literal', |
346 | action='store_true', dest='usetitle', help='[deprecated] alias of --title', default=False) | |
347 | filesystem.add_option('-A', '--auto-number', | |
348 | action='store_true', dest='autonumber', | |
349 | help='number downloaded files starting from 00000', default=False) | |
350 | filesystem.add_option('-o', '--output', | |
74e3452b JMF |
351 | dest='outtmpl', metavar='TEMPLATE', |
352 | help=('output filename template. Use %(title)s to get the title, ' | |
353 | '%(uploader)s for the uploader name, %(uploader_id)s for the uploader nickname if different, ' | |
354 | '%(autonumber)s to get an automatically incremented number, ' | |
fdefe96b | 355 | '%(ext)s for the filename extension, ' |
b5936c00 JMF |
356 | '%(format)s for the format description (like "22 - 1280x720" or "HD"),' |
357 | '%(format_id)s for the unique id of the format (like Youtube\'s itags: "137"),' | |
fdefe96b | 358 | '%(upload_date)s for the upload date (YYYYMMDD), ' |
74e3452b JMF |
359 | '%(extractor)s for the provider (youtube, metacafe, etc), ' |
360 | '%(id)s for the video id , %(playlist)s for the playlist the video is in, ' | |
361 | '%(playlist_index)s for the position in the playlist and %% for a literal percent. ' | |
362 | 'Use - to output to stdout. Can also be used to download to a different directory, ' | |
363 | 'for example with -o \'/my/downloads/%(uploader)s/%(title)s-%(id)s.%(ext)s\' .')) | |
213c31ae SK |
364 | filesystem.add_option('--autonumber-size', |
365 | dest='autonumber_size', metavar='NUMBER', | |
2a9e9b21 | 366 | help='Specifies the number of digits in %(autonumber)s when it is present in output filename template or --auto-number option is given') |
59ae15a5 PH |
367 | filesystem.add_option('--restrict-filenames', |
368 | action='store_true', dest='restrictfilenames', | |
369 | help='Restrict filenames to only ASCII characters, and avoid "&" and spaces in filenames', default=False) | |
370 | filesystem.add_option('-a', '--batch-file', | |
371 | dest='batchfile', metavar='FILE', help='file containing URLs to download (\'-\' for stdin)') | |
1dcc4c0c JMF |
372 | filesystem.add_option('--load-info', |
373 | dest='load_info_filename', metavar='FILE', | |
374 | help='json file containing the video information (created with the "--write-json" option') | |
59ae15a5 PH |
375 | filesystem.add_option('-w', '--no-overwrites', |
376 | action='store_true', dest='nooverwrites', help='do not overwrite files', default=False) | |
377 | filesystem.add_option('-c', '--continue', | |
d4b7da84 | 378 | action='store_true', dest='continue_dl', help='force resume of partially downloaded files. By default, youtube-dl will resume downloads if possible.', default=True) |
59ae15a5 PH |
379 | filesystem.add_option('--no-continue', |
380 | action='store_false', dest='continue_dl', | |
381 | help='do not resume partially downloaded files (restart from beginning)') | |
382 | filesystem.add_option('--cookies', | |
383 | dest='cookiefile', metavar='FILE', help='file to read cookies from and dump cookie jar in') | |
384 | filesystem.add_option('--no-part', | |
385 | action='store_true', dest='nopart', help='do not use .part files', default=False) | |
386 | filesystem.add_option('--no-mtime', | |
387 | action='store_false', dest='updatetime', | |
388 | help='do not use the Last-modified header to set the file modification time', default=True) | |
389 | filesystem.add_option('--write-description', | |
390 | action='store_true', dest='writedescription', | |
391 | help='write video description to a .description file', default=False) | |
392 | filesystem.add_option('--write-info-json', | |
393 | action='store_true', dest='writeinfojson', | |
394 | help='write video metadata to a .info.json file', default=False) | |
1fb07d10 JG |
395 | filesystem.add_option('--write-annotations', |
396 | action='store_true', dest='writeannotations', | |
397 | help='write video annotations to a .annotation file', default=False) | |
11d9224e PH |
398 | filesystem.add_option('--write-thumbnail', |
399 | action='store_true', dest='writethumbnail', | |
400 | help='write thumbnail image to disk', default=False) | |
59ae15a5 PH |
401 | |
402 | ||
403 | postproc.add_option('-x', '--extract-audio', action='store_true', dest='extractaudio', default=False, | |
404 | help='convert video files to audio-only files (requires ffmpeg or avconv and ffprobe or avprobe)') | |
405 | postproc.add_option('--audio-format', metavar='FORMAT', dest='audioformat', default='best', | |
510e6f6d | 406 | help='"best", "aac", "vorbis", "mp3", "m4a", "opus", or "wav"; best by default') |
59ae15a5 PH |
407 | postproc.add_option('--audio-quality', metavar='QUALITY', dest='audioquality', default='5', |
408 | help='ffmpeg/avconv audio quality specification, insert a value between 0 (better) and 9 (worse) for VBR or a specific bitrate like 128K (default 5)') | |
7851b379 PH |
409 | postproc.add_option('--recode-video', metavar='FORMAT', dest='recodevideo', default=None, |
410 | help='Encode the video to another format if necessary (currently supported: mp4|flv|ogg|webm)') | |
59ae15a5 PH |
411 | postproc.add_option('-k', '--keep-video', action='store_true', dest='keepvideo', default=False, |
412 | help='keeps the video file on disk after the post-processing; the video is erased by default') | |
f0648fc1 BPG |
413 | postproc.add_option('--no-post-overwrites', action='store_true', dest='nopostoverwrites', default=False, |
414 | help='do not overwrite post-processed files; the post-processed files are overwritten by default') | |
d4051a8e JMF |
415 | postproc.add_option('--embed-subs', action='store_true', dest='embedsubtitles', default=False, |
416 | help='embed subtitles in the video (only for mp4 videos)') | |
bc4f2917 JMF |
417 | postproc.add_option('--add-metadata', action='store_true', dest='addmetadata', default=False, |
418 | help='add metadata to the files') | |
59ae15a5 PH |
419 | |
420 | ||
421 | parser.add_option_group(general) | |
422 | parser.add_option_group(selection) | |
0beb3add | 423 | parser.add_option_group(downloader) |
59ae15a5 PH |
424 | parser.add_option_group(filesystem) |
425 | parser.add_option_group(verbosity) | |
426 | parser.add_option_group(video_format) | |
505c28aa | 427 | parser.add_option_group(subtitles) |
59ae15a5 PH |
428 | parser.add_option_group(authentication) |
429 | parser.add_option_group(postproc) | |
430 | ||
75b5c590 PH |
431 | if overrideArguments is not None: |
432 | opts, args = parser.parse_args(overrideArguments) | |
433 | if opts.verbose: | |
7459e3a2 | 434 | write_string(u'[debug] Override config: ' + repr(overrideArguments) + '\n') |
59ae15a5 | 435 | else: |
1b753cb3 PH |
436 | systemConf = _readOptions('/etc/youtube-dl.conf') |
437 | ||
75b5c590 PH |
438 | xdg_config_home = os.environ.get('XDG_CONFIG_HOME') |
439 | if xdg_config_home: | |
fa556755 MO |
440 | userConfFile = os.path.join(xdg_config_home, 'youtube-dl', 'config') |
441 | if not os.path.isfile(userConfFile): | |
442 | userConfFile = os.path.join(xdg_config_home, 'youtube-dl.conf') | |
75b5c590 | 443 | else: |
fa556755 MO |
444 | userConfFile = os.path.join(os.path.expanduser('~'), '.config', 'youtube-dl', 'config') |
445 | if not os.path.isfile(userConfFile): | |
446 | userConfFile = os.path.join(os.path.expanduser('~'), '.config', 'youtube-dl.conf') | |
1b753cb3 PH |
447 | userConf = _readOptions(userConfFile, None) |
448 | ||
449 | if userConf is None: | |
450 | appdata_dir = os.environ.get('appdata') | |
451 | if appdata_dir: | |
452 | userConf = _readOptions( | |
453 | os.path.join(appdata_dir, 'youtube-dl', 'config'), | |
fb27c229 PH |
454 | default=None) |
455 | if userConf is None: | |
456 | userConf = _readOptions( | |
457 | os.path.join(appdata_dir, 'youtube-dl', 'config.txt'), | |
458 | default=None) | |
1b753cb3 PH |
459 | |
460 | if userConf is None: | |
fb27c229 | 461 | userConf = _readOptions( |
1b753cb3 | 462 | os.path.join(os.path.expanduser('~'), 'youtube-dl.conf'), |
fb27c229 PH |
463 | default=None) |
464 | if userConf is None: | |
465 | userConf = _readOptions( | |
466 | os.path.join(os.path.expanduser('~'), 'youtube-dl.conf.txt'), | |
467 | default=None) | |
1b753cb3 PH |
468 | |
469 | if userConf is None: | |
470 | userConf = [] | |
471 | ||
1865ed31 | 472 | commandLineConf = sys.argv[1:] |
75b5c590 PH |
473 | argv = systemConf + userConf + commandLineConf |
474 | opts, args = parser.parse_args(argv) | |
c76cb6d5 | 475 | if opts.verbose: |
7459e3a2 PH |
476 | write_string(u'[debug] System config: ' + repr(_hide_login_info(systemConf)) + '\n') |
477 | write_string(u'[debug] User config: ' + repr(_hide_login_info(userConf)) + '\n') | |
478 | write_string(u'[debug] Command-line args: ' + repr(_hide_login_info(commandLineConf)) + '\n') | |
fd46a318 PH |
479 | write_string(u'[debug] Encodings: locale %r, fs %r, out %r, pref: %r\n' % |
480 | (locale.getpreferredencoding(), sys.getfilesystemencoding(), sys.stdout.encoding, preferredencoding())) | |
8c42c506 | 481 | |
59ae15a5 | 482 | return parser, opts, args |
235b3ba4 | 483 | |
e3946f98 | 484 | |
b8ad4f02 | 485 | def _real_main(argv=None): |
0d94f247 PH |
486 | # Compatibility fixes for Windows |
487 | if sys.platform == 'win32': | |
488 | # https://github.com/rg3/youtube-dl/issues/820 | |
489 | codecs.register(lambda name: codecs.lookup('utf-8') if name == 'cp65001' else None) | |
490 | ||
e3946f98 PH |
491 | setproctitle(u'youtube-dl') |
492 | ||
b8ad4f02 | 493 | parser, opts, args = parseOpts(argv) |
59ae15a5 | 494 | |
59ae15a5 PH |
495 | # Set user agent |
496 | if opts.user_agent is not None: | |
497 | std_headers['User-Agent'] = opts.user_agent | |
1865ed31 | 498 | |
28535652 BH |
499 | # Set referer |
500 | if opts.referer is not None: | |
501 | std_headers['Referer'] = opts.referer | |
59ae15a5 PH |
502 | |
503 | # Dump user agent | |
504 | if opts.dump_user_agent: | |
93eb15c5 | 505 | compat_print(std_headers['User-Agent']) |
59ae15a5 PH |
506 | sys.exit(0) |
507 | ||
508 | # Batch file verification | |
509 | batchurls = [] | |
510 | if opts.batchfile is not None: | |
511 | try: | |
512 | if opts.batchfile == '-': | |
513 | batchfd = sys.stdin | |
514 | else: | |
515 | batchfd = open(opts.batchfile, 'r') | |
516 | batchurls = batchfd.readlines() | |
517 | batchurls = [x.strip() for x in batchurls] | |
518 | batchurls = [x for x in batchurls if len(x) > 0 and not re.search(r'^[#/;]', x)] | |
05afc96b | 519 | if opts.verbose: |
7459e3a2 | 520 | write_string(u'[debug] Batch file urls: ' + repr(batchurls) + u'\n') |
59ae15a5 PH |
521 | except IOError: |
522 | sys.exit(u'ERROR: batch file could not be read') | |
523 | all_urls = batchurls + args | |
524 | all_urls = [url.strip() for url in all_urls] | |
525 | ||
59ae15a5 PH |
526 | extractors = gen_extractors() |
527 | ||
528 | if opts.list_extractors: | |
7dba9cd0 | 529 | for ie in sorted(extractors, key=lambda ie: ie.IE_NAME.lower()): |
93eb15c5 | 530 | compat_print(ie.IE_NAME + (' (CURRENTLY BROKEN)' if not ie._WORKING else '')) |
1a2c3c0f | 531 | matchedUrls = [url for url in all_urls if ie.suitable(url)] |
59ae15a5 | 532 | for mu in matchedUrls: |
93eb15c5 | 533 | compat_print(u' ' + mu) |
59ae15a5 | 534 | sys.exit(0) |
0f818663 PH |
535 | if opts.list_extractor_descriptions: |
536 | for ie in sorted(extractors, key=lambda ie: ie.IE_NAME.lower()): | |
537 | if not ie._WORKING: | |
538 | continue | |
539 | desc = getattr(ie, 'IE_DESC', ie.IE_NAME) | |
15870e90 PH |
540 | if desc is False: |
541 | continue | |
0f818663 PH |
542 | if hasattr(ie, 'SEARCH_KEY'): |
543 | _SEARCHES = (u'cute kittens', u'slithering pythons', u'falling cat', u'angry poodle', u'purple fish', u'running tortoise') | |
544 | _COUNTS = (u'', u'5', u'10', u'all') | |
545 | desc += u' (Example: "%s%s:%s" )' % (ie.SEARCH_KEY, random.choice(_COUNTS), random.choice(_SEARCHES)) | |
546 | compat_print(desc) | |
547 | sys.exit(0) | |
548 | ||
59ae15a5 PH |
549 | |
550 | # Conflicting, missing and erroneous options | |
551 | if opts.usenetrc and (opts.username is not None or opts.password is not None): | |
552 | parser.error(u'using .netrc conflicts with giving username/password') | |
553 | if opts.password is not None and opts.username is None: | |
c6c19746 | 554 | parser.error(u' account username missing\n') |
59ae15a5 PH |
555 | if opts.outtmpl is not None and (opts.usetitle or opts.autonumber or opts.useid): |
556 | parser.error(u'using output template conflicts with using title, video ID or auto number') | |
557 | if opts.usetitle and opts.useid: | |
558 | parser.error(u'using title conflicts with using video ID') | |
559 | if opts.username is not None and opts.password is None: | |
560 | opts.password = getpass.getpass(u'Type account password and press return:') | |
561 | if opts.ratelimit is not None: | |
562 | numeric_limit = FileDownloader.parse_bytes(opts.ratelimit) | |
563 | if numeric_limit is None: | |
564 | parser.error(u'invalid rate limit specified') | |
565 | opts.ratelimit = numeric_limit | |
9e982f9e JC |
566 | if opts.min_filesize is not None: |
567 | numeric_limit = FileDownloader.parse_bytes(opts.min_filesize) | |
568 | if numeric_limit is None: | |
569 | parser.error(u'invalid min_filesize specified') | |
570 | opts.min_filesize = numeric_limit | |
571 | if opts.max_filesize is not None: | |
572 | numeric_limit = FileDownloader.parse_bytes(opts.max_filesize) | |
573 | if numeric_limit is None: | |
574 | parser.error(u'invalid max_filesize specified') | |
575 | opts.max_filesize = numeric_limit | |
59ae15a5 PH |
576 | if opts.retries is not None: |
577 | try: | |
578 | opts.retries = int(opts.retries) | |
dca08720 | 579 | except (TypeError, ValueError): |
59ae15a5 PH |
580 | parser.error(u'invalid retry count specified') |
581 | if opts.buffersize is not None: | |
582 | numeric_buffersize = FileDownloader.parse_bytes(opts.buffersize) | |
583 | if numeric_buffersize is None: | |
584 | parser.error(u'invalid buffer size specified') | |
585 | opts.buffersize = numeric_buffersize | |
a19fd00c PH |
586 | if opts.playliststart <= 0: |
587 | raise ValueError(u'Playlist start must be positive') | |
588 | if opts.playlistend not in (-1, None) and opts.playlistend < opts.playliststart: | |
589 | raise ValueError(u'Playlist end must be greater than playlist start') | |
59ae15a5 | 590 | if opts.extractaudio: |
510e6f6d | 591 | if opts.audioformat not in ['best', 'aac', 'mp3', 'm4a', 'opus', 'vorbis', 'wav']: |
59ae15a5 PH |
592 | parser.error(u'invalid audio format specified') |
593 | if opts.audioquality: | |
594 | opts.audioquality = opts.audioquality.strip('k').strip('K') | |
595 | if not opts.audioquality.isdigit(): | |
596 | parser.error(u'invalid audio quality specified') | |
7851b379 PH |
597 | if opts.recodevideo is not None: |
598 | if opts.recodevideo not in ['mp4', 'flv', 'webm', 'ogg']: | |
599 | parser.error(u'invalid video recode format specified') | |
bd558525 JMF |
600 | if opts.date is not None: |
601 | date = DateRange.day(opts.date) | |
602 | else: | |
603 | date = DateRange(opts.dateafter, opts.datebefore) | |
59ae15a5 | 604 | |
0b7f3118 JMF |
605 | # --all-sub automatically sets --write-sub if --write-auto-sub is not given |
606 | # this was the old behaviour if only --all-sub was given. | |
607 | if opts.allsubtitles and (opts.writeautomaticsub == False): | |
608 | opts.writesubtitles = True | |
609 | ||
5cb9c312 PH |
610 | if sys.version_info < (3,): |
611 | # In Python 2, sys.argv is a bytestring (also note http://bugs.python.org/issue2128 for Windows systems) | |
0be41ec2 PH |
612 | if opts.outtmpl is not None: |
613 | opts.outtmpl = opts.outtmpl.decode(preferredencoding()) | |
5cb9c312 PH |
614 | outtmpl =((opts.outtmpl is not None and opts.outtmpl) |
615 | or (opts.format == '-1' and opts.usetitle and u'%(title)s-%(id)s-%(format)s.%(ext)s') | |
616 | or (opts.format == '-1' and u'%(id)s-%(format)s.%(ext)s') | |
617 | or (opts.usetitle and opts.autonumber and u'%(autonumber)s-%(title)s-%(id)s.%(ext)s') | |
618 | or (opts.usetitle and u'%(title)s-%(id)s.%(ext)s') | |
619 | or (opts.useid and u'%(id)s.%(ext)s') | |
620 | or (opts.autonumber and u'%(autonumber)s-%(id)s.%(ext)s') | |
08b2ac74 | 621 | or u'%(title)s-%(id)s.%(ext)s') |
dca02c80 | 622 | if not os.path.splitext(outtmpl)[1] and opts.extractaudio: |
b61067fa | 623 | parser.error(u'Cannot download a video and extract audio into the same' |
dca02c80 JMF |
624 | u' file! Use "{0}.%(ext)s" instead of "{0}" as the output' |
625 | u' template'.format(outtmpl)) | |
29c7a63d | 626 | |
525ef922 PH |
627 | any_printing = opts.geturl or opts.gettitle or opts.getid or opts.getthumbnail or opts.getdescription or opts.getfilename or opts.getformat or opts.getduration or opts.dumpjson |
628 | ||
bdde425c | 629 | ydl_opts = { |
59ae15a5 PH |
630 | 'usenetrc': opts.usenetrc, |
631 | 'username': opts.username, | |
632 | 'password': opts.password, | |
c6c19746 | 633 | 'videopassword': opts.videopassword, |
525ef922 | 634 | 'quiet': (opts.quiet or any_printing), |
59ae15a5 PH |
635 | 'forceurl': opts.geturl, |
636 | 'forcetitle': opts.gettitle, | |
1a2adf3f | 637 | 'forceid': opts.getid, |
59ae15a5 PH |
638 | 'forcethumbnail': opts.getthumbnail, |
639 | 'forcedescription': opts.getdescription, | |
525ef922 | 640 | 'forceduration': opts.getduration, |
59ae15a5 PH |
641 | 'forcefilename': opts.getfilename, |
642 | 'forceformat': opts.getformat, | |
9d153818 | 643 | 'forcejson': opts.dumpjson, |
59ae15a5 | 644 | 'simulate': opts.simulate, |
525ef922 | 645 | 'skip_download': (opts.skip_download or opts.simulate or any_printing), |
59ae15a5 PH |
646 | 'format': opts.format, |
647 | 'format_limit': opts.format_limit, | |
648 | 'listformats': opts.listformats, | |
5cb9c312 | 649 | 'outtmpl': outtmpl, |
213c31ae | 650 | 'autonumber_size': opts.autonumber_size, |
59ae15a5 PH |
651 | 'restrictfilenames': opts.restrictfilenames, |
652 | 'ignoreerrors': opts.ignoreerrors, | |
653 | 'ratelimit': opts.ratelimit, | |
654 | 'nooverwrites': opts.nooverwrites, | |
655 | 'retries': opts.retries, | |
656 | 'buffersize': opts.buffersize, | |
657 | 'noresizebuffer': opts.noresizebuffer, | |
658 | 'continuedl': opts.continue_dl, | |
659 | 'noprogress': opts.noprogress, | |
5717d91a | 660 | 'progress_with_newline': opts.progress_with_newline, |
59ae15a5 PH |
661 | 'playliststart': opts.playliststart, |
662 | 'playlistend': opts.playlistend, | |
47192f92 | 663 | 'noplaylist': opts.noplaylist, |
59ae15a5 PH |
664 | 'logtostderr': opts.outtmpl == '-', |
665 | 'consoletitle': opts.consoletitle, | |
666 | 'nopart': opts.nopart, | |
667 | 'updatetime': opts.updatetime, | |
668 | 'writedescription': opts.writedescription, | |
1fb07d10 | 669 | 'writeannotations': opts.writeannotations, |
59ae15a5 | 670 | 'writeinfojson': opts.writeinfojson, |
11d9224e | 671 | 'writethumbnail': opts.writethumbnail, |
59ae15a5 | 672 | 'writesubtitles': opts.writesubtitles, |
b004821f | 673 | 'writeautomaticsub': opts.writeautomaticsub, |
ae608b80 | 674 | 'allsubtitles': opts.allsubtitles, |
2a4093ea | 675 | 'listsubtitles': opts.listsubtitles, |
9e62bc44 | 676 | 'subtitlesformat': opts.subtitlesformat, |
d6e203b3 | 677 | 'subtitleslangs': opts.subtitleslangs, |
8271226a PH |
678 | 'matchtitle': decodeOption(opts.matchtitle), |
679 | 'rejecttitle': decodeOption(opts.rejecttitle), | |
59ae15a5 PH |
680 | 'max_downloads': opts.max_downloads, |
681 | 'prefer_free_formats': opts.prefer_free_formats, | |
682 | 'verbose': opts.verbose, | |
855703e5 | 683 | 'dump_intermediate_pages': opts.dump_intermediate_pages, |
d41e6efc | 684 | 'write_pages': opts.write_pages, |
8d5d3a5d | 685 | 'test': opts.test, |
7851b379 | 686 | 'keepvideo': opts.keepvideo, |
9e982f9e | 687 | 'min_filesize': opts.min_filesize, |
bd558525 | 688 | 'max_filesize': opts.max_filesize, |
5fe18bdb PH |
689 | 'min_views': opts.min_views, |
690 | 'max_views': opts.max_views, | |
11d9224e | 691 | 'daterange': date, |
7f747732 | 692 | 'cachedir': opts.cachedir, |
f8061589 | 693 | 'youtube_print_sig_code': opts.youtube_print_sig_code, |
8dbe9899 | 694 | 'age_limit': opts.age_limit, |
c1c9a79c | 695 | 'download_archive': opts.download_archive, |
dca08720 PH |
696 | 'cookiefile': opts.cookiefile, |
697 | 'nocheckcertificate': opts.no_check_certificate, | |
c2e52508 | 698 | 'proxy': opts.proxy, |
6ad14cab | 699 | 'socket_timeout': opts.socket_timeout, |
0783b09b | 700 | 'bidi_workaround': opts.bidi_workaround, |
a0ddb8a2 | 701 | 'debug_printtraffic': opts.debug_printtraffic, |
bdde425c | 702 | } |
59ae15a5 | 703 | |
bdde425c | 704 | with YoutubeDL(ydl_opts) as ydl: |
dca08720 | 705 | ydl.print_debug_header() |
bdde425c PH |
706 | ydl.add_default_info_extractors() |
707 | ||
708 | # PostProcessors | |
709 | # Add the metadata pp first, the other pps will copy it | |
710 | if opts.addmetadata: | |
711 | ydl.add_post_processor(FFmpegMetadataPP()) | |
712 | if opts.extractaudio: | |
713 | ydl.add_post_processor(FFmpegExtractAudioPP(preferredcodec=opts.audioformat, preferredquality=opts.audioquality, nopostoverwrites=opts.nopostoverwrites)) | |
714 | if opts.recodevideo: | |
715 | ydl.add_post_processor(FFmpegVideoConvertor(preferedformat=opts.recodevideo)) | |
716 | if opts.embedsubtitles: | |
717 | ydl.add_post_processor(FFmpegEmbedSubtitlePP(subtitlesformat=opts.subtitlesformat)) | |
718 | ||
719 | # Update version | |
720 | if opts.update_self: | |
721 | update_self(ydl.to_screen, opts.verbose) | |
722 | ||
723 | # Maybe do nothing | |
1dcc4c0c | 724 | if (len(all_urls) < 1) and (opts.load_info_filename is None): |
bdde425c PH |
725 | if not opts.update_self: |
726 | parser.error(u'you must provide at least one URL') | |
727 | else: | |
728 | sys.exit() | |
59ae15a5 | 729 | |
bdde425c | 730 | try: |
1dcc4c0c JMF |
731 | if opts.load_info_filename is not None: |
732 | retcode = ydl.download_with_info_file(opts.load_info_filename) | |
733 | else: | |
734 | retcode = ydl.download(all_urls) | |
bdde425c PH |
735 | except MaxDownloadsReached: |
736 | ydl.to_screen(u'--max-download limit reached, aborting.') | |
737 | retcode = 101 | |
59ae15a5 | 738 | |
59ae15a5 | 739 | sys.exit(retcode) |
235b3ba4 | 740 | |
a27b9e8b | 741 | |
b8ad4f02 | 742 | def main(argv=None): |
59ae15a5 | 743 | try: |
b8ad4f02 | 744 | _real_main(argv) |
59ae15a5 PH |
745 | except DownloadError: |
746 | sys.exit(1) | |
747 | except SameFileError: | |
748 | sys.exit(u'ERROR: fixed output name but more than one file to download') | |
749 | except KeyboardInterrupt: | |
750 | sys.exit(u'\nERROR: Interrupted by user') |