]>
Commit | Line | Data |
---|---|---|
0647d925 | 1 | try: |
2 | import contextvars # noqa: F401 | |
3 | except Exception: | |
4 | raise Exception( | |
5 | f'You are using an unsupported version of Python. Only Python versions 3.7 and above are supported by yt-dlp') # noqa: F541 | |
a4bc4336 | 6 | |
235b3ba4 | 7 | __license__ = 'Public Domain' |
235b3ba4 | 8 | |
f2df4071 | 9 | import collections |
ac668111 | 10 | import getpass |
e9f4ccd1 | 11 | import itertools |
9e491463 | 12 | import optparse |
235b3ba4 | 13 | import os |
43820c03 | 14 | import re |
235b3ba4 | 15 | import sys |
235b3ba4 | 16 | |
ac668111 | 17 | from .compat import compat_shlex_quote |
f8271158 | 18 | from .cookies import SUPPORTED_BROWSERS, SUPPORTED_KEYRINGS |
7b2c3f47 | 19 | from .downloader.external import get_external_downloader |
560738f3 | 20 | from .extractor import list_extractor_classes |
f8271158 | 21 | from .extractor.adobepass import MSO_INFO |
d1b5f70b | 22 | from .options import parseOpts |
f8271158 | 23 | from .postprocessor import ( |
24 | FFmpegExtractAudioPP, | |
4f04be6a | 25 | FFmpegMergerPP, |
8dc59305 | 26 | FFmpegPostProcessor, |
f8271158 | 27 | FFmpegSubtitlesConvertorPP, |
28 | FFmpegThumbnailsConvertorPP, | |
29 | FFmpegVideoConvertorPP, | |
30 | FFmpegVideoRemuxerPP, | |
31 | MetadataFromFieldPP, | |
32 | MetadataParserPP, | |
8c25f81b | 33 | ) |
8372be74 | 34 | from .update import Updater |
8c25f81b | 35 | from .utils import ( |
f8271158 | 36 | NO_DEFAULT, |
62f6f1cb | 37 | POSTPROCESS_WHEN, |
a4fd0415 | 38 | DateRange, |
f304da8a | 39 | DownloadCancelled, |
a4fd0415 | 40 | DownloadError, |
d0d74b71 | 41 | FormatSorter, |
f8271158 | 42 | GeoUtils, |
7e88d7d7 | 43 | PlaylistEntries, |
f8271158 | 44 | SameFileError, |
45 | decodeOption, | |
5ec1b6b7 | 46 | download_range_func, |
590bc6f6 | 47 | expand_path, |
31c49255 | 48 | float_or_none, |
7b2c3f47 | 49 | format_field, |
31c49255 | 50 | int_or_none, |
347de493 | 51 | match_filter_func, |
64c464a1 | 52 | parse_bytes, |
2d9ec704 | 53 | parse_duration, |
a4fd0415 | 54 | preferredencoding, |
62e609ab | 55 | read_batch_urls, |
6b9e832d | 56 | read_stdin, |
df692c5a | 57 | render_table, |
e3946f98 | 58 | setproctitle, |
a4fd0415 | 59 | std_headers, |
8b7539d2 | 60 | traverse_obj, |
9e491463 | 61 | variadic, |
a4fd0415 | 62 | write_string, |
a4fd0415 | 63 | ) |
8222d8de | 64 | from .YoutubeDL import YoutubeDL |
a4fd0415 | 65 | |
da4db748 | 66 | _IN_CLI = False |
67 | ||
235b3ba4 | 68 | |
9e491463 | 69 | def _exit(status=0, *args): |
70 | for msg in args: | |
71 | sys.stderr.write(msg) | |
72 | raise SystemExit(status) | |
73 | ||
74 | ||
d1b5f70b | 75 | def get_urls(urls, batchfile, verbose): |
59ae15a5 | 76 | # Batch file verification |
62e609ab | 77 | batch_urls = [] |
d1b5f70b | 78 | if batchfile is not None: |
59ae15a5 | 79 | try: |
6b9e832d | 80 | batch_urls = read_batch_urls( |
81 | read_stdin('URLs') if batchfile == '-' | |
82 | else open(expand_path(batchfile), encoding='utf-8', errors='ignore')) | |
d1b5f70b | 83 | if verbose: |
a4bc4336 | 84 | write_string('[debug] Batch file urls: ' + repr(batch_urls) + '\n') |
86e5f3ed | 85 | except OSError: |
9e491463 | 86 | _exit(f'ERROR: batch file {batchfile} could not be read') |
c774b3c6 | 87 | _enc = preferredencoding() |
d1b5f70b | 88 | return [ |
89 | url.strip().decode(_enc, 'ignore') if isinstance(url, bytes) else url.strip() | |
90 | for url in batch_urls + urls] | |
59ae15a5 | 91 | |
d1b5f70b | 92 | |
93 | def print_extractor_information(opts, urls): | |
8dcce6a8 | 94 | out = '' |
59ae15a5 | 95 | if opts.list_extractors: |
71df9b7f | 96 | # Importing GenericIE is currently slow since it imports YoutubeIE |
97 | from .extractor.generic import GenericIE | |
98 | ||
82d02080 | 99 | urls = dict.fromkeys(urls, False) |
100 | for ie in list_extractor_classes(opts.age_limit): | |
8dcce6a8 | 101 | out += ie.IE_NAME + (' (CURRENTLY BROKEN)' if not ie.working() else '') + '\n' |
82d02080 | 102 | if ie == GenericIE: |
103 | matched_urls = [url for url, matched in urls.items() if not matched] | |
104 | else: | |
105 | matched_urls = tuple(filter(ie.suitable, urls.keys())) | |
106 | urls.update(dict.fromkeys(matched_urls, True)) | |
107 | out += ''.join(f' {url}\n' for url in matched_urls) | |
d1b5f70b | 108 | elif opts.list_extractor_descriptions: |
8dcce6a8 | 109 | _SEARCHES = ('cute kittens', 'slithering pythons', 'falling cat', 'angry poodle', 'purple fish', 'running tortoise', 'sleeping bunny', 'burping cow') |
110 | out = '\n'.join( | |
111 | ie.description(markdown=False, search_examples=_SEARCHES) | |
82d02080 | 112 | for ie in list_extractor_classes(opts.age_limit) if ie.working() and ie.IE_DESC is not False) |
d1b5f70b | 113 | elif opts.ap_list_mso: |
8dcce6a8 | 114 | out = 'Supported TV Providers:\n%s\n' % render_table( |
115 | ['mso', 'mso name'], | |
116 | [[mso_id, mso_info['name']] for mso_id, mso_info in MSO_INFO.items()]) | |
bd558525 | 117 | else: |
d1b5f70b | 118 | return False |
8dcce6a8 | 119 | write_string(out, out=sys.stdout) |
d1b5f70b | 120 | return True |
53ed7066 | 121 | |
19b824f6 | 122 | |
d1b5f70b | 123 | def set_compat_opts(opts): |
53ed7066 | 124 | def _unused_compat_opt(name): |
d1b5f70b | 125 | if name not in opts.compat_opts: |
53ed7066 | 126 | return False |
d1b5f70b | 127 | opts.compat_opts.discard(name) |
128 | opts.compat_opts.update(['*%s' % name]) | |
53ed7066 | 129 | return True |
130 | ||
e4f02757 | 131 | def set_default_compat(compat_name, opt_name, default=True, remove_compat=True): |
53ed7066 | 132 | attr = getattr(opts, opt_name) |
d1b5f70b | 133 | if compat_name in opts.compat_opts: |
53ed7066 | 134 | if attr is None: |
135 | setattr(opts, opt_name, not default) | |
136 | return True | |
137 | else: | |
138 | if remove_compat: | |
139 | _unused_compat_opt(compat_name) | |
140 | return False | |
141 | elif attr is None: | |
142 | setattr(opts, opt_name, default) | |
143 | return None | |
144 | ||
b1940459 | 145 | set_default_compat('abort-on-error', 'ignoreerrors', 'only_download') |
53ed7066 | 146 | set_default_compat('no-playlist-metafiles', 'allow_playlist_files') |
e4f02757 | 147 | set_default_compat('no-clean-infojson', 'clean_infojson') |
d1b5f70b | 148 | if 'no-attach-info-json' in opts.compat_opts: |
dac5df5a | 149 | if opts.embed_infojson: |
150 | _unused_compat_opt('no-attach-info-json') | |
151 | else: | |
152 | opts.embed_infojson = False | |
d1b5f70b | 153 | if 'format-sort' in opts.compat_opts: |
d0d74b71 | 154 | opts.format_sort.extend(FormatSorter.ytdl_default) |
53ed7066 | 155 | _video_multistreams_set = set_default_compat('multistreams', 'allow_multiple_video_streams', False, remove_compat=False) |
156 | _audio_multistreams_set = set_default_compat('multistreams', 'allow_multiple_audio_streams', False, remove_compat=False) | |
157 | if _video_multistreams_set is False and _audio_multistreams_set is False: | |
158 | _unused_compat_opt('multistreams') | |
d1b5f70b | 159 | if 'filename' in opts.compat_opts: |
160 | if opts.outtmpl.get('default') is None: | |
161 | opts.outtmpl.update({'default': '%(title)s-%(id)s.%(ext)s'}) | |
53ed7066 | 162 | else: |
163 | _unused_compat_opt('filename') | |
164 | ||
d1b5f70b | 165 | |
166 | def validate_options(opts): | |
167 | def validate(cndn, name, value=None, msg=None): | |
168 | if cndn: | |
169 | return True | |
170 | raise ValueError((msg or 'invalid {name} "{value}" given').format(name=name, value=value)) | |
171 | ||
172 | def validate_in(name, value, items, msg=None): | |
173 | return validate(value is None or value in items, name, value, msg) | |
174 | ||
175 | def validate_regex(name, value, regex): | |
176 | return validate(value is None or re.match(regex, value), name, value) | |
177 | ||
178 | def validate_positive(name, value, strict=False): | |
179 | return validate(value is None or value > 0 or (not strict and value == 0), | |
180 | name, value, '{name} "{value}" must be positive' + ('' if strict else ' or 0')) | |
181 | ||
182 | def validate_minmax(min_val, max_val, min_name, max_name=None): | |
183 | if max_val is None or min_val is None or max_val >= min_val: | |
184 | return | |
185 | if not max_name: | |
186 | min_name, max_name = f'min {min_name}', f'max {min_name}' | |
187 | raise ValueError(f'{max_name} "{max_val}" must be must be greater than or equal to {min_name} "{min_val}"') | |
188 | ||
189 | # Usernames and passwords | |
190 | validate(not opts.usenetrc or (opts.username is None and opts.password is None), | |
191 | '.netrc', msg='using {name} conflicts with giving username/password') | |
192 | validate(opts.password is None or opts.username is not None, 'account username', msg='{name} missing') | |
193 | validate(opts.ap_password is None or opts.ap_username is not None, | |
194 | 'TV Provider account username', msg='{name} missing') | |
195 | validate_in('TV Provider', opts.ap_mso, MSO_INFO, | |
196 | 'Unsupported {name} "{value}", use --ap-list-mso to get a list of supported TV Providers') | |
197 | ||
198 | # Numbers | |
199 | validate_positive('autonumber start', opts.autonumber_start) | |
200 | validate_positive('autonumber size', opts.autonumber_size, True) | |
201 | validate_positive('concurrent fragments', opts.concurrent_fragment_downloads, True) | |
202 | validate_positive('playlist start', opts.playliststart, True) | |
203 | if opts.playlistend != -1: | |
204 | validate_minmax(opts.playliststart, opts.playlistend, 'playlist start', 'playlist end') | |
205 | ||
206 | # Time ranges | |
207 | validate_positive('subtitles sleep interval', opts.sleep_interval_subtitles) | |
208 | validate_positive('requests sleep interval', opts.sleep_interval_requests) | |
209 | validate_positive('sleep interval', opts.sleep_interval) | |
210 | validate_positive('max sleep interval', opts.max_sleep_interval) | |
07ff290d | 211 | if opts.sleep_interval is None: |
d1b5f70b | 212 | validate( |
07ff290d | 213 | opts.max_sleep_interval is None, 'min sleep interval', |
d1b5f70b | 214 | msg='{name} must be specified; use --min-sleep-interval') |
07ff290d | 215 | elif opts.max_sleep_interval is None: |
216 | opts.max_sleep_interval = opts.sleep_interval | |
217 | else: | |
d1b5f70b | 218 | validate_minmax(opts.sleep_interval, opts.max_sleep_interval, 'sleep interval') |
219 | ||
220 | if opts.wait_for_video is not None: | |
221 | min_wait, max_wait, *_ = map(parse_duration, opts.wait_for_video.split('-', 1) + [None]) | |
222 | validate(min_wait is not None and not (max_wait is None and '-' in opts.wait_for_video), | |
223 | 'time range to wait for video', opts.wait_for_video) | |
224 | validate_minmax(min_wait, max_wait, 'time range to wait for video') | |
225 | opts.wait_for_video = (min_wait, max_wait) | |
226 | ||
227 | # Format sort | |
228 | for f in opts.format_sort: | |
d0d74b71 | 229 | validate_regex('format sorting', f, FormatSorter.regex) |
d1b5f70b | 230 | |
231 | # Postprocessor formats | |
fc61aff4 LL |
232 | validate_regex('merge output format', opts.merge_output_format, |
233 | r'({0})(/({0}))*'.format('|'.join(map(re.escape, FFmpegMergerPP.SUPPORTED_EXTS)))) | |
e0ab9854 | 234 | validate_regex('audio format', opts.audioformat, FFmpegExtractAudioPP.FORMAT_RE) |
d1b5f70b | 235 | validate_in('subtitle format', opts.convertsubtitles, FFmpegSubtitlesConvertorPP.SUPPORTED_EXTS) |
35faefee | 236 | validate_regex('thumbnail format', opts.convertthumbnails, FFmpegThumbnailsConvertorPP.FORMAT_RE) |
237 | validate_regex('recode video format', opts.recodevideo, FFmpegVideoConvertorPP.FORMAT_RE) | |
238 | validate_regex('remux video format', opts.remuxvideo, FFmpegVideoRemuxerPP.FORMAT_RE) | |
d1b5f70b | 239 | if opts.audioquality: |
240 | opts.audioquality = opts.audioquality.strip('k').strip('K') | |
241 | # int_or_none prevents inf, nan | |
242 | validate_positive('audio quality', int_or_none(float_or_none(opts.audioquality), default=0)) | |
243 | ||
244 | # Retries | |
245 | def parse_retries(name, value): | |
246 | if value is None: | |
247 | return None | |
248 | elif value in ('inf', 'infinite'): | |
249 | return float('inf') | |
250 | try: | |
251 | return int(value) | |
252 | except (TypeError, ValueError): | |
253 | validate(False, f'{name} retry count', value) | |
254 | ||
255 | opts.retries = parse_retries('download', opts.retries) | |
256 | opts.fragment_retries = parse_retries('fragment', opts.fragment_retries) | |
257 | opts.extractor_retries = parse_retries('extractor', opts.extractor_retries) | |
258 | opts.file_access_retries = parse_retries('file access', opts.file_access_retries) | |
259 | ||
23326151 | 260 | # Retry sleep function |
261 | def parse_sleep_func(expr): | |
262 | NUMBER_RE = r'\d+(?:\.\d+)?' | |
263 | op, start, limit, step, *_ = tuple(re.fullmatch( | |
c4a62b99 | 264 | rf'(?:(linear|exp)=)?({NUMBER_RE})(?::({NUMBER_RE})?)?(?::({NUMBER_RE}))?', |
23326151 | 265 | expr.strip()).groups()) + (None, None) |
266 | ||
267 | if op == 'exp': | |
268 | return lambda n: min(float(start) * (float(step or 2) ** n), float(limit or 'inf')) | |
269 | else: | |
270 | default_step = start if op or limit else 0 | |
271 | return lambda n: min(float(start) + float(step or default_step) * n, float(limit or 'inf')) | |
272 | ||
273 | for key, expr in opts.retry_sleep.items(): | |
274 | if not expr: | |
275 | del opts.retry_sleep[key] | |
276 | continue | |
277 | try: | |
278 | opts.retry_sleep[key] = parse_sleep_func(expr) | |
c4a62b99 | 279 | except AttributeError: |
280 | raise ValueError(f'invalid {key} retry sleep expression {expr!r}') | |
23326151 | 281 | |
d1b5f70b | 282 | # Bytes |
64c464a1 | 283 | def validate_bytes(name, value): |
d1b5f70b | 284 | if value is None: |
285 | return None | |
64c464a1 | 286 | numeric_limit = parse_bytes(value) |
d1b5f70b | 287 | validate(numeric_limit is not None, 'rate limit', value) |
288 | return numeric_limit | |
289 | ||
64c464a1 | 290 | opts.ratelimit = validate_bytes('rate limit', opts.ratelimit) |
291 | opts.throttledratelimit = validate_bytes('throttled rate limit', opts.throttledratelimit) | |
292 | opts.min_filesize = validate_bytes('min filesize', opts.min_filesize) | |
293 | opts.max_filesize = validate_bytes('max filesize', opts.max_filesize) | |
294 | opts.buffersize = validate_bytes('buffer size', opts.buffersize) | |
295 | opts.http_chunk_size = validate_bytes('http chunk size', opts.http_chunk_size) | |
d1b5f70b | 296 | |
297 | # Output templates | |
76a264ac | 298 | def validate_outtmpl(tmpl, msg): |
299 | err = YoutubeDL.validate_outtmpl(tmpl) | |
300 | if err: | |
d1b5f70b | 301 | raise ValueError(f'invalid {msg} "{tmpl}": {err}') |
76a264ac | 302 | |
303 | for k, tmpl in opts.outtmpl.items(): | |
819e0531 | 304 | validate_outtmpl(tmpl, f'{k} output template') |
ca30f449 | 305 | for type_, tmpl_list in opts.forceprint.items(): |
306 | for tmpl in tmpl_list: | |
307 | validate_outtmpl(tmpl, f'{type_} print template') | |
bb66c247 | 308 | for type_, tmpl_list in opts.print_to_file.items(): |
309 | for tmpl, file in tmpl_list: | |
d1b5f70b | 310 | validate_outtmpl(tmpl, f'{type_} print to file template') |
311 | validate_outtmpl(file, f'{type_} print to file filename') | |
7a340e0d | 312 | validate_outtmpl(opts.sponsorblock_chapter_title, 'SponsorBlock chapter title') |
819e0531 | 313 | for k, tmpl in opts.progress_template.items(): |
314 | k = f'{k[:-6]} console title' if '-title' in k else f'{k} progress' | |
315 | validate_outtmpl(tmpl, f'{k} template') | |
76a264ac | 316 | |
d1b5f70b | 317 | outtmpl_default = opts.outtmpl.get('default') |
318 | if outtmpl_default == '': | |
319 | opts.skip_download = None | |
320 | del opts.outtmpl['default'] | |
d1b5f70b | 321 | |
5ec1b6b7 | 322 | def parse_chapters(name, value): |
323 | chapters, ranges = [], [] | |
fc2ba496 | 324 | parse_timestamp = lambda x: float('inf') if x in ('inf', 'infinite') else parse_duration(x) |
5ec1b6b7 | 325 | for regex in value or []: |
326 | if regex.startswith('*'): | |
fc2ba496 L |
327 | for range_ in map(str.strip, regex[1:].split(',')): |
328 | mobj = range_ != '-' and re.fullmatch(r'([^-]+)?\s*-\s*([^-]+)?', range_) | |
329 | dur = mobj and (parse_timestamp(mobj.group(1) or '0'), parse_timestamp(mobj.group(2) or 'inf')) | |
330 | if None in (dur or [None]): | |
08e29b9f | 331 | raise ValueError(f'invalid {name} time range "{regex}". Must be of the form "*start-end"') |
fc2ba496 | 332 | ranges.append(dur) |
d1b5f70b | 333 | continue |
5ec1b6b7 | 334 | try: |
335 | chapters.append(re.compile(regex)) | |
336 | except re.error as err: | |
337 | raise ValueError(f'invalid {name} regex "{regex}" - {err}') | |
338 | return chapters, ranges | |
339 | ||
340 | opts.remove_chapters, opts.remove_ranges = parse_chapters('--remove-chapters', opts.remove_chapters) | |
341 | opts.download_ranges = download_range_func(*parse_chapters('--download-sections', opts.download_ranges)) | |
0202b52a | 342 | |
d1b5f70b | 343 | # Cookies from browser |
344 | if opts.cookiesfrombrowser: | |
9bd13fe5 | 345 | container = None |
825d3ce3 | 346 | mobj = re.fullmatch(r'''(?x) |
347 | (?P<name>[^+:]+) | |
348 | (?:\s*\+\s*(?P<keyring>[^:]+))? | |
935bac1e | 349 | (?:\s*:\s*(?!:)(?P<profile>.+?))? |
825d3ce3 | 350 | (?:\s*::\s*(?P<container>.+))? |
351 | ''', opts.cookiesfrombrowser) | |
d1b5f70b | 352 | if mobj is None: |
353 | raise ValueError(f'invalid cookies from browser arguments: {opts.cookiesfrombrowser}') | |
825d3ce3 | 354 | browser_name, keyring, profile, container = mobj.group('name', 'keyring', 'profile', 'container') |
d1b5f70b | 355 | browser_name = browser_name.lower() |
356 | if browser_name not in SUPPORTED_BROWSERS: | |
357 | raise ValueError(f'unsupported browser specified for cookies: "{browser_name}". ' | |
358 | f'Supported browsers are: {", ".join(sorted(SUPPORTED_BROWSERS))}') | |
359 | if keyring is not None: | |
360 | keyring = keyring.upper() | |
361 | if keyring not in SUPPORTED_KEYRINGS: | |
362 | raise ValueError(f'unsupported keyring specified for cookies: "{keyring}". ' | |
363 | f'Supported keyrings are: {", ".join(sorted(SUPPORTED_KEYRINGS))}') | |
d2c8aadf | 364 | opts.cookiesfrombrowser = (browser_name, profile, keyring, container) |
29c7a63d | 365 | |
d1b5f70b | 366 | # MetadataParser |
e9f4ccd1 | 367 | def metadataparser_actions(f): |
368 | if isinstance(f, str): | |
369 | cmd = '--parse-metadata %s' % compat_shlex_quote(f) | |
370 | try: | |
371 | actions = [MetadataFromFieldPP.to_action(f)] | |
372 | except Exception as err: | |
d1b5f70b | 373 | raise ValueError(f'{cmd} is invalid; {err}') |
e9f4ccd1 | 374 | else: |
375 | cmd = '--replace-in-metadata %s' % ' '.join(map(compat_shlex_quote, f)) | |
376 | actions = ((MetadataParserPP.Actions.REPLACE, x, *f[1:]) for x in f[0].split(',')) | |
377 | ||
378 | for action in actions: | |
379 | try: | |
380 | MetadataParserPP.validate_action(*action) | |
381 | except Exception as err: | |
d1b5f70b | 382 | raise ValueError(f'{cmd} is invalid; {err}') |
e9f4ccd1 | 383 | yield action |
384 | ||
5bfa4862 | 385 | if opts.metafromtitle is not None: |
fe74d5b5 | 386 | opts.parse_metadata.setdefault('pre_process', []).append('title:%s' % opts.metafromtitle) |
387 | opts.parse_metadata = { | |
388 | k: list(itertools.chain(*map(metadataparser_actions, v))) | |
389 | for k, v in opts.parse_metadata.items() | |
390 | } | |
5bfa4862 | 391 | |
d1b5f70b | 392 | # Other options |
7e88d7d7 | 393 | if opts.playlist_items is not None: |
394 | try: | |
395 | tuple(PlaylistEntries.parse_playlist_items(opts.playlist_items)) | |
396 | except Exception as err: | |
397 | raise ValueError(f'Invalid playlist-items {opts.playlist_items!r}: {err}') | |
398 | ||
d1b5f70b | 399 | geo_bypass_code = opts.geo_bypass_ip_block or opts.geo_bypass_country |
400 | if geo_bypass_code is not None: | |
401 | try: | |
402 | GeoUtils.random_ipv4(geo_bypass_code) | |
403 | except Exception: | |
404 | raise ValueError('unsupported geo-bypass country or ip-block') | |
ca30f449 | 405 | |
fe2ce85a | 406 | opts.match_filter = match_filter_func(opts.match_filter, opts.breaking_match_filter) |
525ef922 | 407 | |
d1b5f70b | 408 | if opts.download_archive is not None: |
409 | opts.download_archive = expand_path(opts.download_archive) | |
410 | ||
2b24afa6 | 411 | if opts.ffmpeg_location is not None: |
412 | opts.ffmpeg_location = expand_path(opts.ffmpeg_location) | |
413 | ||
d1b5f70b | 414 | if opts.user_agent is not None: |
415 | opts.headers.setdefault('User-Agent', opts.user_agent) | |
416 | if opts.referer is not None: | |
417 | opts.headers.setdefault('Referer', opts.referer) | |
f0884c8b | 418 | |
7a340e0d | 419 | if opts.no_sponsorblock: |
d1b5f70b | 420 | opts.sponsorblock_mark = opts.sponsorblock_remove = set() |
421 | ||
6d1b3489 | 422 | default_downloader = None |
7b2c3f47 | 423 | for proto, path in opts.external_downloader.items(): |
28163422 | 424 | if path == 'native': |
425 | continue | |
6d1b3489 | 426 | ed = get_external_downloader(path) |
427 | if ed is None: | |
7b2c3f47 | 428 | raise ValueError( |
429 | f'No such {format_field(proto, None, "%s ", ignore="default")}external downloader "{path}"') | |
6d1b3489 | 430 | elif ed and proto == 'default': |
431 | default_downloader = ed.get_basename() | |
432 | ||
d1b5f70b | 433 | warnings, deprecation_warnings = [], [] |
7a340e0d | 434 | |
d1b5f70b | 435 | # Common mistake: -f best |
436 | if opts.format == 'best': | |
437 | warnings.append('.\n '.join(( | |
438 | '"-f best" selects the best pre-merged format which is often not the best option', | |
439 | 'To let yt-dlp download and merge the best available formats, simply do not pass any format selection', | |
440 | 'If you know what you are doing and want only the best pre-merged format, use "-f b" instead to suppress this warning'))) | |
441 | ||
a44ca5a4 | 442 | # --(postprocessor/downloader)-args without name |
6d1b3489 | 443 | def report_args_compat(name, value, key1, key2=None, where=None): |
d1b5f70b | 444 | if key1 in value and key2 not in value: |
6d1b3489 | 445 | warnings.append(f'{name.title()} arguments given without specifying name. ' |
446 | f'The arguments will be given to {where or f"all {name}s"}') | |
d1b5f70b | 447 | return True |
448 | return False | |
449 | ||
6d1b3489 | 450 | if report_args_compat('external downloader', opts.external_downloader_args, |
451 | 'default', where=default_downloader) and default_downloader: | |
452 | # Compat with youtube-dl's behavior. See https://github.com/ytdl-org/youtube-dl/commit/49c5293014bc11ec8c009856cd63cffa6296c1e1 | |
453 | opts.external_downloader_args.setdefault(default_downloader, opts.external_downloader_args.pop('default')) | |
454 | ||
d1b5f70b | 455 | if report_args_compat('post-processor', opts.postprocessor_args, 'default-compat', 'default'): |
456 | opts.postprocessor_args['default'] = opts.postprocessor_args.pop('default-compat') | |
457 | opts.postprocessor_args.setdefault('sponskrub', []) | |
458 | ||
459 | def report_conflict(arg1, opt1, arg2='--allow-unplayable-formats', opt2='allow_unplayable_formats', | |
460 | val1=NO_DEFAULT, val2=NO_DEFAULT, default=False): | |
461 | if val2 is NO_DEFAULT: | |
462 | val2 = getattr(opts, opt2) | |
463 | if not val2: | |
464 | return | |
465 | ||
466 | if val1 is NO_DEFAULT: | |
467 | val1 = getattr(opts, opt1) | |
468 | if val1: | |
469 | warnings.append(f'{arg1} is ignored since {arg2} was given') | |
470 | setattr(opts, opt1, default) | |
471 | ||
472 | # Conflicting options | |
7e9a6125 | 473 | report_conflict('--playlist-reverse', 'playlist_reverse', '--playlist-random', 'playlist_random') |
474 | report_conflict('--playlist-reverse', 'playlist_reverse', '--lazy-playlist', 'lazy_playlist') | |
475 | report_conflict('--playlist-random', 'playlist_random', '--lazy-playlist', 'lazy_playlist') | |
da1d734f | 476 | report_conflict('--dateafter', 'dateafter', '--date', 'date', default=None) |
477 | report_conflict('--datebefore', 'datebefore', '--date', 'date', default=None) | |
3d3bb168 | 478 | report_conflict('--exec-before-download', 'exec_before_dl_cmd', |
479 | '"--exec before_dl:"', 'exec_cmd', val2=opts.exec_cmd.get('before_dl')) | |
d1b5f70b | 480 | report_conflict('--id', 'useid', '--output', 'outtmpl', val2=opts.outtmpl.get('default')) |
481 | report_conflict('--remux-video', 'remuxvideo', '--recode-video', 'recodevideo') | |
482 | report_conflict('--sponskrub', 'sponskrub', '--remove-chapters', 'remove_chapters') | |
483 | report_conflict('--sponskrub', 'sponskrub', '--sponsorblock-mark', 'sponsorblock_mark') | |
484 | report_conflict('--sponskrub', 'sponskrub', '--sponsorblock-remove', 'sponsorblock_remove') | |
19a03940 | 485 | report_conflict('--sponskrub-cut', 'sponskrub_cut', '--split-chapter', 'split_chapters', |
486 | val1=opts.sponskrub and opts.sponskrub_cut) | |
d1b5f70b | 487 | |
488 | # Conflicts with --allow-unplayable-formats | |
2fa669f7 | 489 | report_conflict('--embed-metadata', 'addmetadata') |
d1b5f70b | 490 | report_conflict('--embed-chapters', 'addchapters') |
491 | report_conflict('--embed-info-json', 'embed_infojson') | |
492 | report_conflict('--embed-subs', 'embedsubtitles') | |
493 | report_conflict('--embed-thumbnail', 'embedthumbnail') | |
494 | report_conflict('--extract-audio', 'extractaudio') | |
3d3bb168 | 495 | report_conflict('--fixup', 'fixup', val1=opts.fixup not in (None, 'never', 'ignore'), default='never') |
d1b5f70b | 496 | report_conflict('--recode-video', 'recodevideo') |
497 | report_conflict('--remove-chapters', 'remove_chapters', default=[]) | |
498 | report_conflict('--remux-video', 'remuxvideo') | |
499 | report_conflict('--sponskrub', 'sponskrub') | |
500 | report_conflict('--sponsorblock-remove', 'sponsorblock_remove', default=set()) | |
501 | report_conflict('--xattrs', 'xattrs') | |
502 | ||
503 | # Fully deprecated options | |
504 | def report_deprecation(val, old, new=None): | |
505 | if not val: | |
506 | return | |
507 | deprecation_warnings.append( | |
508 | f'{old} is deprecated and may be removed in a future version. Use {new} instead' if new | |
509 | else f'{old} is deprecated and may not work as expected') | |
510 | ||
511 | report_deprecation(opts.sponskrub, '--sponskrub', '--sponsorblock-mark or --sponsorblock-remove') | |
512 | report_deprecation(not opts.prefer_ffmpeg, '--prefer-avconv', 'ffmpeg') | |
513 | # report_deprecation(opts.include_ads, '--include-ads') # We may re-implement this in future | |
514 | # report_deprecation(opts.call_home, '--call-home') # We may re-implement this in future | |
515 | # report_deprecation(opts.writeannotations, '--write-annotations') # It's just that no website has it | |
516 | ||
517 | # Dependent options | |
da1d734f | 518 | opts.date = DateRange.day(opts.date) if opts.date else DateRange(opts.dateafter, opts.datebefore) |
519 | ||
d1b5f70b | 520 | if opts.exec_before_dl_cmd: |
521 | opts.exec_cmd['before_dl'] = opts.exec_before_dl_cmd | |
522 | ||
523 | if opts.useid: # --id is not deprecated in youtube-dl | |
524 | opts.outtmpl['default'] = '%(id)s.%(ext)s' | |
525 | ||
526 | if opts.overwrites: # --force-overwrites implies --no-continue | |
527 | opts.continue_dl = False | |
63ad4d43 | 528 | |
9222c381 | 529 | if (opts.addmetadata or opts.sponsorblock_mark) and opts.addchapters is None: |
d1b5f70b | 530 | # Add chapters when adding metadata or marking sponsors |
9222c381 | 531 | opts.addchapters = True |
532 | ||
d1b5f70b | 533 | if opts.extractaudio and not opts.keepvideo and opts.format is None: |
534 | # Do not unnecessarily download audio | |
535 | opts.format = 'bestaudio/best' | |
536 | ||
f2df4071 | 537 | if opts.getcomments and opts.writeinfojson is None and not opts.embed_infojson: |
d1b5f70b | 538 | # If JSON is not printed anywhere, but comments are requested, save it to file |
539 | if not opts.dumpjson or opts.print_json or opts.dump_single_json: | |
540 | opts.writeinfojson = True | |
541 | ||
542 | if opts.allsubtitles and not (opts.embedsubtitles or opts.writeautomaticsub): | |
543 | # --all-sub automatically sets --write-sub if --write-auto-sub is not given | |
544 | opts.writesubtitles = True | |
545 | ||
546 | if opts.addmetadata and opts.embed_infojson is None: | |
547 | # If embedding metadata and infojson is present, embed it | |
548 | opts.embed_infojson = 'if_exists' | |
549 | ||
550 | # Ask for passwords | |
551 | if opts.username is not None and opts.password is None: | |
ac668111 | 552 | opts.password = getpass.getpass('Type account password and press [Return]: ') |
d1b5f70b | 553 | if opts.ap_username is not None and opts.ap_password is None: |
ac668111 | 554 | opts.ap_password = getpass.getpass('Type TV provider account password and press [Return]: ') |
d1b5f70b | 555 | |
556 | return warnings, deprecation_warnings | |
557 | ||
558 | ||
559 | def get_postprocessors(opts): | |
560 | yield from opts.add_postprocessors | |
561 | ||
fe74d5b5 | 562 | for when, actions in opts.parse_metadata.items(): |
d1b5f70b | 563 | yield { |
564 | 'key': 'MetadataParser', | |
fe74d5b5 | 565 | 'actions': actions, |
566 | 'when': when | |
d1b5f70b | 567 | } |
568 | sponsorblock_query = opts.sponsorblock_mark | opts.sponsorblock_remove | |
7a340e0d | 569 | if sponsorblock_query: |
d1b5f70b | 570 | yield { |
7a340e0d NA |
571 | 'key': 'SponsorBlock', |
572 | 'categories': sponsorblock_query, | |
573 | 'api': opts.sponsorblock_api, | |
09b49e1f | 574 | 'when': 'after_filter' |
d1b5f70b | 575 | } |
56d868db | 576 | if opts.convertsubtitles: |
d1b5f70b | 577 | yield { |
56d868db | 578 | 'key': 'FFmpegSubtitlesConvertor', |
579 | 'format': opts.convertsubtitles, | |
56d868db | 580 | 'when': 'before_dl' |
d1b5f70b | 581 | } |
8fa43c73 | 582 | if opts.convertthumbnails: |
d1b5f70b | 583 | yield { |
8fa43c73 | 584 | 'key': 'FFmpegThumbnailsConvertor', |
585 | 'format': opts.convertthumbnails, | |
8fa43c73 | 586 | 'when': 'before_dl' |
d1b5f70b | 587 | } |
4f026faf | 588 | if opts.extractaudio: |
d1b5f70b | 589 | yield { |
4f026faf PH |
590 | 'key': 'FFmpegExtractAudio', |
591 | 'preferredcodec': opts.audioformat, | |
592 | 'preferredquality': opts.audioquality, | |
593 | 'nopostoverwrites': opts.nopostoverwrites, | |
d1b5f70b | 594 | } |
efe87a10 | 595 | if opts.remuxvideo: |
d1b5f70b | 596 | yield { |
efe87a10 FS |
597 | 'key': 'FFmpegVideoRemuxer', |
598 | 'preferedformat': opts.remuxvideo, | |
d1b5f70b | 599 | } |
4f026faf | 600 | if opts.recodevideo: |
d1b5f70b | 601 | yield { |
4f026faf PH |
602 | 'key': 'FFmpegVideoConvertor', |
603 | 'preferedformat': opts.recodevideo, | |
d1b5f70b | 604 | } |
7a340e0d | 605 | # If ModifyChapters is going to remove chapters, subtitles must already be in the container. |
4f026faf | 606 | if opts.embedsubtitles: |
d1b5f70b | 607 | keep_subs = 'no-keep-subs' not in opts.compat_opts |
608 | yield { | |
4f026faf | 609 | 'key': 'FFmpegEmbedSubtitle', |
56d868db | 610 | # already_have_subtitle = True prevents the file from being deleted after embedding |
d1b5f70b | 611 | 'already_have_subtitle': opts.writesubtitles and keep_subs |
612 | } | |
613 | if not opts.writeautomaticsub and keep_subs: | |
cffab0ee | 614 | opts.writesubtitles = True |
d1b5f70b | 615 | |
7a340e0d | 616 | # ModifyChapters must run before FFmpegMetadataPP |
7a340e0d | 617 | if opts.remove_chapters or sponsorblock_query: |
d1b5f70b | 618 | yield { |
7a340e0d | 619 | 'key': 'ModifyChapters', |
d1b5f70b | 620 | 'remove_chapters_patterns': opts.remove_chapters, |
7a340e0d | 621 | 'remove_sponsor_segments': opts.sponsorblock_remove, |
d1b5f70b | 622 | 'remove_ranges': opts.remove_ranges, |
7a340e0d NA |
623 | 'sponsorblock_chapter_title': opts.sponsorblock_chapter_title, |
624 | 'force_keyframes': opts.force_keyframes_at_cuts | |
d1b5f70b | 625 | } |
7a340e0d NA |
626 | # FFmpegMetadataPP should be run after FFmpegVideoConvertorPP and |
627 | # FFmpegExtractAudioPP as containers before conversion may not support | |
628 | # metadata (3gp, webm, etc.) | |
629 | # By default ffmpeg preserves metadata applicable for both | |
630 | # source and target containers. From this point the container won't change, | |
631 | # so metadata can be added here. | |
dac5df5a | 632 | if opts.addmetadata or opts.addchapters or opts.embed_infojson: |
d1b5f70b | 633 | yield { |
7a340e0d NA |
634 | 'key': 'FFmpegMetadata', |
635 | 'add_chapters': opts.addchapters, | |
636 | 'add_metadata': opts.addmetadata, | |
dac5df5a | 637 | 'add_infojson': opts.embed_infojson, |
d1b5f70b | 638 | } |
ee8dd27a | 639 | # Deprecated |
f4e4be19 | 640 | # This should be above EmbedThumbnail since sponskrub removes the thumbnail attachment |
641 | # but must be below EmbedSubtitle and FFmpegMetadata | |
642 | # See https://github.com/yt-dlp/yt-dlp/issues/204 , https://github.com/faissaloo/SponSkrub/issues/29 | |
a9e7f546 | 643 | # If opts.sponskrub is None, sponskrub is used, but it silently fails if the executable can't be found |
644 | if opts.sponskrub is not False: | |
d1b5f70b | 645 | yield { |
a9e7f546 | 646 | 'key': 'SponSkrub', |
647 | 'path': opts.sponskrub_path, | |
648 | 'args': opts.sponskrub_args, | |
649 | 'cut': opts.sponskrub_cut, | |
650 | 'force': opts.sponskrub_force, | |
651 | 'ignoreerror': opts.sponskrub is None, | |
ee8dd27a | 652 | '_from_cli': True, |
d1b5f70b | 653 | } |
f4e4be19 | 654 | if opts.embedthumbnail: |
d1b5f70b | 655 | yield { |
f4e4be19 | 656 | 'key': 'EmbedThumbnail', |
56d868db | 657 | # already_have_thumbnail = True prevents the file from being deleted after embedding |
acc0d6a4 | 658 | 'already_have_thumbnail': opts.writethumbnail |
d1b5f70b | 659 | } |
acc0d6a4 | 660 | if not opts.writethumbnail: |
f4e4be19 | 661 | opts.writethumbnail = True |
80c03fa9 | 662 | opts.outtmpl['pl_thumbnail'] = '' |
72755351 | 663 | if opts.split_chapters: |
d1b5f70b | 664 | yield { |
7a340e0d NA |
665 | 'key': 'FFmpegSplitChapters', |
666 | 'force_keyframes': opts.force_keyframes_at_cuts, | |
d1b5f70b | 667 | } |
72755351 | 668 | # XAttrMetadataPP should be run after post-processors that may change file contents |
669 | if opts.xattrs: | |
d1b5f70b | 670 | yield {'key': 'XAttrMetadata'} |
3b603dbd | 671 | if opts.concat_playlist != 'never': |
d1b5f70b | 672 | yield { |
3b603dbd | 673 | 'key': 'FFmpegConcat', |
674 | 'only_multi_video': opts.concat_playlist != 'always', | |
675 | 'when': 'playlist', | |
d1b5f70b | 676 | } |
1e43a6f7 | 677 | # Exec must be the last PP of each category |
1e43a6f7 | 678 | for when, exec_cmd in opts.exec_cmd.items(): |
d1b5f70b | 679 | yield { |
ad3dc496 | 680 | 'key': 'Exec', |
1e43a6f7 | 681 | 'exec_cmd': exec_cmd, |
1e43a6f7 | 682 | 'when': when, |
d1b5f70b | 683 | } |
1b77b347 | 684 | |
0d1bb027 | 685 | |
f2df4071 | 686 | ParsedOptions = collections.namedtuple('ParsedOptions', ('parser', 'options', 'urls', 'ydl_opts')) |
687 | ||
688 | ||
d1b5f70b | 689 | def parse_options(argv=None): |
f2df4071 | 690 | """@returns ParsedOptions(parser, opts, urls, ydl_opts)""" |
d1b5f70b | 691 | parser, opts, urls = parseOpts(argv) |
692 | urls = get_urls(urls, opts.batchfile, opts.verbose) | |
b8f6bbe6 | 693 | |
d1b5f70b | 694 | set_compat_opts(opts) |
695 | try: | |
696 | warnings, deprecation_warnings = validate_options(opts) | |
697 | except ValueError as err: | |
698 | parser.error(f'{err}\n') | |
1b77b347 | 699 | |
d1b5f70b | 700 | postprocessors = list(get_postprocessors(opts)) |
ee8dd27a | 701 | |
193fb150 | 702 | print_only = bool(opts.forceprint) and all(k not in opts.forceprint for k in POSTPROCESS_WHEN[3:]) |
62f6f1cb | 703 | any_getting = any(getattr(opts, k) for k in ( |
704 | 'dumpjson', 'dump_single_json', 'getdescription', 'getduration', 'getfilename', | |
705 | 'getformat', 'getid', 'getthumbnail', 'gettitle', 'geturl' | |
706 | )) | |
5712943b | 707 | opts.quiet = opts.quiet or any_getting or opts.print_json or bool(opts.forceprint) |
ee8dd27a | 708 | |
134c913c | 709 | playlist_pps = [pp for pp in postprocessors if pp.get('when') == 'playlist'] |
710 | write_playlist_infojson = (opts.writeinfojson and not opts.clean_infojson | |
711 | and opts.allow_playlist_files and opts.outtmpl.get('pl_infojson') != '') | |
712 | if not any(( | |
713 | opts.extract_flat, | |
714 | opts.dump_single_json, | |
715 | opts.forceprint.get('playlist'), | |
716 | opts.print_to_file.get('playlist'), | |
717 | write_playlist_infojson, | |
718 | )): | |
719 | if not playlist_pps: | |
720 | opts.extract_flat = 'discard' | |
721 | elif playlist_pps == [{'key': 'FFmpegConcat', 'only_multi_video': True, 'when': 'playlist'}]: | |
722 | opts.extract_flat = 'discard_in_playlist' | |
723 | ||
df692c5a | 724 | final_ext = ( |
81a23040 | 725 | opts.recodevideo if opts.recodevideo in FFmpegVideoConvertorPP.SUPPORTED_EXTS |
726 | else opts.remuxvideo if opts.remuxvideo in FFmpegVideoRemuxerPP.SUPPORTED_EXTS | |
35faefee | 727 | else opts.audioformat if (opts.extractaudio and opts.audioformat in FFmpegExtractAudioPP.SUPPORTED_EXTS) |
81a23040 | 728 | else None) |
f6d7624f | 729 | |
f2df4071 | 730 | return ParsedOptions(parser, opts, urls, { |
59ae15a5 | 731 | 'usenetrc': opts.usenetrc, |
0001fcb5 | 732 | 'netrc_location': opts.netrc_location, |
59ae15a5 PH |
733 | 'username': opts.username, |
734 | 'password': opts.password, | |
83317f69 | 735 | 'twofactor': opts.twofactor, |
c6c19746 | 736 | 'videopassword': opts.videopassword, |
797c636b | 737 | 'ap_mso': opts.ap_mso, |
1b6712ab RA |
738 | 'ap_username': opts.ap_username, |
739 | 'ap_password': opts.ap_password, | |
bb58c9ed | 740 | 'client_certificate': opts.client_certificate, |
741 | 'client_certificate_key': opts.client_certificate_key, | |
742 | 'client_certificate_password': opts.client_certificate_password, | |
5712943b | 743 | 'quiet': opts.quiet, |
ad8915b7 | 744 | 'no_warnings': opts.no_warnings, |
59ae15a5 PH |
745 | 'forceurl': opts.geturl, |
746 | 'forcetitle': opts.gettitle, | |
1a2adf3f | 747 | 'forceid': opts.getid, |
59ae15a5 PH |
748 | 'forcethumbnail': opts.getthumbnail, |
749 | 'forcedescription': opts.getdescription, | |
525ef922 | 750 | 'forceduration': opts.getduration, |
59ae15a5 PH |
751 | 'forcefilename': opts.getfilename, |
752 | 'forceformat': opts.getformat, | |
d2a1fad9 | 753 | 'forceprint': opts.forceprint, |
bb66c247 | 754 | 'print_to_file': opts.print_to_file, |
c0bdf32a | 755 | 'forcejson': opts.dumpjson or opts.print_json, |
63e0be34 | 756 | 'dump_single_json': opts.dump_single_json, |
2d30509f | 757 | 'force_write_download_archive': opts.force_write_download_archive, |
62f6f1cb | 758 | 'simulate': (print_only or any_getting or None) if opts.simulate is None else opts.simulate, |
1bdeb7be | 759 | 'skip_download': opts.skip_download, |
59ae15a5 | 760 | 'format': opts.format, |
63ad4d43 | 761 | 'allow_unplayable_formats': opts.allow_unplayable_formats, |
b7da73eb | 762 | 'ignore_no_formats_error': opts.ignore_no_formats_error, |
eb8a4433 | 763 | 'format_sort': opts.format_sort, |
764 | 'format_sort_force': opts.format_sort_force, | |
909d24dd | 765 | 'allow_multiple_video_streams': opts.allow_multiple_video_streams, |
766 | 'allow_multiple_audio_streams': opts.allow_multiple_audio_streams, | |
e8e73840 | 767 | 'check_formats': opts.check_formats, |
59ae15a5 | 768 | 'listformats': opts.listformats, |
76d321f6 | 769 | 'listformats_table': opts.listformats_table, |
486fb179 | 770 | 'outtmpl': opts.outtmpl, |
a820dc72 | 771 | 'outtmpl_na_placeholder': opts.outtmpl_na_placeholder, |
0202b52a | 772 | 'paths': opts.paths, |
213c31ae | 773 | 'autonumber_size': opts.autonumber_size, |
acbb2374 | 774 | 'autonumber_start': opts.autonumber_start, |
59ae15a5 | 775 | 'restrictfilenames': opts.restrictfilenames, |
c2934512 | 776 | 'windowsfilenames': opts.windowsfilenames, |
59ae15a5 | 777 | 'ignoreerrors': opts.ignoreerrors, |
d22dec74 | 778 | 'force_generic_extractor': opts.force_generic_extractor, |
fe7866d0 | 779 | 'allowed_extractors': opts.allowed_extractors or ['default'], |
59ae15a5 | 780 | 'ratelimit': opts.ratelimit, |
51d9739f | 781 | 'throttledratelimit': opts.throttledratelimit, |
0c3d0f51 | 782 | 'overwrites': opts.overwrites, |
52bb437e | 783 | 'retries': opts.retries, |
205a0654 | 784 | 'file_access_retries': opts.file_access_retries, |
52bb437e | 785 | 'fragment_retries': opts.fragment_retries, |
62bff2c1 | 786 | 'extractor_retries': opts.extractor_retries, |
23326151 | 787 | 'retry_sleep_functions': opts.retry_sleep, |
9603b660 | 788 | 'skip_unavailable_fragments': opts.skip_unavailable_fragments, |
0eee52f3 | 789 | 'keep_fragments': opts.keep_fragments, |
4cf1e5d2 | 790 | 'concurrent_fragment_downloads': opts.concurrent_fragment_downloads, |
59ae15a5 PH |
791 | 'buffersize': opts.buffersize, |
792 | 'noresizebuffer': opts.noresizebuffer, | |
ba515388 | 793 | 'http_chunk_size': opts.http_chunk_size, |
59ae15a5 | 794 | 'continuedl': opts.continue_dl, |
819e0531 | 795 | 'noprogress': opts.quiet if opts.noprogress is None else opts.noprogress, |
5717d91a | 796 | 'progress_with_newline': opts.progress_with_newline, |
819e0531 | 797 | 'progress_template': opts.progress_template, |
59ae15a5 PH |
798 | 'playliststart': opts.playliststart, |
799 | 'playlistend': opts.playlistend, | |
ff815fe6 | 800 | 'playlistreverse': opts.playlist_reverse, |
75822ca7 | 801 | 'playlistrandom': opts.playlist_random, |
7e9a6125 | 802 | 'lazy_playlist': opts.lazy_playlist, |
47192f92 | 803 | 'noplaylist': opts.noplaylist, |
d1b5f70b | 804 | 'logtostderr': opts.outtmpl.get('default') == '-', |
59ae15a5 PH |
805 | 'consoletitle': opts.consoletitle, |
806 | 'nopart': opts.nopart, | |
807 | 'updatetime': opts.updatetime, | |
808 | 'writedescription': opts.writedescription, | |
1fb07d10 | 809 | 'writeannotations': opts.writeannotations, |
f0884c8b | 810 | 'writeinfojson': opts.writeinfojson, |
1ea24129 | 811 | 'allow_playlist_files': opts.allow_playlist_files, |
75d43ca0 | 812 | 'clean_infojson': opts.clean_infojson, |
06167fbb | 813 | 'getcomments': opts.getcomments, |
acc0d6a4 | 814 | 'writethumbnail': opts.writethumbnail is True, |
815 | 'write_all_thumbnails': opts.writethumbnail == 'all', | |
732044af | 816 | 'writelink': opts.writelink, |
817 | 'writeurllink': opts.writeurllink, | |
818 | 'writewebloclink': opts.writewebloclink, | |
819 | 'writedesktoplink': opts.writedesktoplink, | |
59ae15a5 | 820 | 'writesubtitles': opts.writesubtitles, |
b004821f | 821 | 'writeautomaticsub': opts.writeautomaticsub, |
ae608b80 | 822 | 'allsubtitles': opts.allsubtitles, |
2a4093ea | 823 | 'listsubtitles': opts.listsubtitles, |
9e62bc44 | 824 | 'subtitlesformat': opts.subtitlesformat, |
d6e203b3 | 825 | 'subtitleslangs': opts.subtitleslangs, |
8271226a PH |
826 | 'matchtitle': decodeOption(opts.matchtitle), |
827 | 'rejecttitle': decodeOption(opts.rejecttitle), | |
59ae15a5 PH |
828 | 'max_downloads': opts.max_downloads, |
829 | 'prefer_free_formats': opts.prefer_free_formats, | |
bdc3fd2f | 830 | 'trim_file_name': opts.trim_file_name, |
59ae15a5 | 831 | 'verbose': opts.verbose, |
855703e5 | 832 | 'dump_intermediate_pages': opts.dump_intermediate_pages, |
d41e6efc | 833 | 'write_pages': opts.write_pages, |
f95b9dee | 834 | 'load_pages': opts.load_pages, |
8d5d3a5d | 835 | 'test': opts.test, |
7851b379 | 836 | 'keepvideo': opts.keepvideo, |
9e982f9e | 837 | 'min_filesize': opts.min_filesize, |
bd558525 | 838 | 'max_filesize': opts.max_filesize, |
5fe18bdb PH |
839 | 'min_views': opts.min_views, |
840 | 'max_views': opts.max_views, | |
d1b5f70b | 841 | 'daterange': opts.date, |
7f747732 | 842 | 'cachedir': opts.cachedir, |
f8061589 | 843 | 'youtube_print_sig_code': opts.youtube_print_sig_code, |
8dbe9899 | 844 | 'age_limit': opts.age_limit, |
d1b5f70b | 845 | 'download_archive': opts.download_archive, |
ea6e0c2b | 846 | 'break_on_existing': opts.break_on_existing, |
8b0d7497 | 847 | 'break_on_reject': opts.break_on_reject, |
b222c271 | 848 | 'break_per_url': opts.break_per_url, |
26e2805c | 849 | 'skip_playlist_after_errors': opts.skip_playlist_after_errors, |
dca08720 | 850 | 'cookiefile': opts.cookiefile, |
982ee69a | 851 | 'cookiesfrombrowser': opts.cookiesfrombrowser, |
f81c62a6 | 852 | 'legacyserverconnect': opts.legacy_server_connect, |
dca08720 | 853 | 'nocheckcertificate': opts.no_check_certificate, |
7e8c0af0 | 854 | 'prefer_insecure': opts.prefer_insecure, |
8300774c | 855 | 'enable_file_urls': opts.enable_file_urls, |
8b7539d2 | 856 | 'http_headers': opts.headers, |
c2e52508 | 857 | 'proxy': opts.proxy, |
6ad14cab | 858 | 'socket_timeout': opts.socket_timeout, |
0783b09b | 859 | 'bidi_workaround': opts.bidi_workaround, |
a0ddb8a2 | 860 | 'debug_printtraffic': opts.debug_printtraffic, |
76b1bd67 | 861 | 'prefer_ffmpeg': opts.prefer_ffmpeg, |
7b0817e8 | 862 | 'include_ads': opts.include_ads, |
04b4d394 | 863 | 'default_search': opts.default_search, |
78895bd3 | 864 | 'dynamic_mpd': opts.dynamic_mpd, |
5d3a0e79 | 865 | 'extractor_args': opts.extractor_args, |
4919603f | 866 | 'youtube_include_dash_manifest': opts.youtube_include_dash_manifest, |
78895bd3 | 867 | 'youtube_include_hls_manifest': opts.youtube_include_hls_manifest, |
62fec3b2 | 868 | 'encoding': opts.encoding, |
057a5206 | 869 | 'extract_flat': opts.extract_flat, |
adbc4ec4 | 870 | 'live_from_start': opts.live_from_start, |
f2ebc5c7 | 871 | 'wait_for_video': opts.wait_for_video, |
d77ab8e2 | 872 | 'mark_watched': opts.mark_watched, |
34c781a2 | 873 | 'merge_output_format': opts.merge_output_format, |
df692c5a | 874 | 'final_ext': final_ext, |
4f026faf | 875 | 'postprocessors': postprocessors, |
6271f1ca | 876 | 'fixup': opts.fixup, |
be4a824d | 877 | 'source_address': opts.source_address, |
58b1f00d | 878 | 'call_home': opts.call_home, |
1cf376f5 | 879 | 'sleep_interval_requests': opts.sleep_interval_requests, |
5f0d813d | 880 | 'sleep_interval': opts.sleep_interval, |
065bc354 | 881 | 'max_sleep_interval': opts.max_sleep_interval, |
0c9df79e | 882 | 'sleep_interval_subtitles': opts.sleep_interval_subtitles, |
222516d9 | 883 | 'external_downloader': opts.external_downloader, |
5ec1b6b7 | 884 | 'download_ranges': opts.download_ranges, |
885 | 'force_keyframes_at_cuts': opts.force_keyframes_at_cuts, | |
cfb56d1a | 886 | 'list_thumbnails': opts.list_thumbnails, |
c14e88f0 | 887 | 'playlist_items': opts.playlist_items, |
881e6a1f | 888 | 'xattr_set_filesize': opts.xattr_set_filesize, |
d1b5f70b | 889 | 'match_filter': opts.match_filter, |
7e5db8c9 | 890 | 'no_color': opts.no_color, |
73fac4e9 | 891 | 'ffmpeg_location': opts.ffmpeg_location, |
85729c51 | 892 | 'hls_prefer_native': opts.hls_prefer_native, |
7d106a65 | 893 | 'hls_use_mpegts': opts.hls_use_mpegts, |
310c2ed2 | 894 | 'hls_split_discontinuity': opts.hls_split_discontinuity, |
46ee996e | 895 | 'external_downloader_args': opts.external_downloader_args, |
45016689 | 896 | 'postprocessor_args': opts.postprocessor_args, |
91410c9b | 897 | 'cn_verification_proxy': opts.cn_verification_proxy, |
38cce791 | 898 | 'geo_verification_proxy': opts.geo_verification_proxy, |
0a840f58 S |
899 | 'geo_bypass': opts.geo_bypass, |
900 | 'geo_bypass_country': opts.geo_bypass_country, | |
5f95927a | 901 | 'geo_bypass_ip_block': opts.geo_bypass_ip_block, |
49a57e70 | 902 | '_warnings': warnings, |
ee8dd27a | 903 | '_deprecation_warnings': deprecation_warnings, |
d1b5f70b | 904 | 'compat_opts': opts.compat_opts, |
f2df4071 | 905 | }) |
59ae15a5 | 906 | |
d1b5f70b | 907 | |
908 | def _real_main(argv=None): | |
d1b5f70b | 909 | setproctitle('yt-dlp') |
910 | ||
911 | parser, opts, all_urls, ydl_opts = parse_options(argv) | |
912 | ||
913 | # Dump user agent | |
914 | if opts.dump_user_agent: | |
915 | ua = traverse_obj(opts.headers, 'User-Agent', casesense=False, default=std_headers['User-Agent']) | |
916 | write_string(f'{ua}\n', out=sys.stdout) | |
9e491463 | 917 | return |
d1b5f70b | 918 | |
919 | if print_extractor_information(opts, all_urls): | |
9e491463 | 920 | return |
d1b5f70b | 921 | |
6a7d3a0a | 922 | # We may need ffmpeg_location without having access to the YoutubeDL instance |
923 | # See https://github.com/yt-dlp/yt-dlp/issues/2191 | |
924 | if opts.ffmpeg_location: | |
925 | FFmpegPostProcessor._ffmpeg_location.set(opts.ffmpeg_location) | |
926 | ||
bdde425c | 927 | with YoutubeDL(ydl_opts) as ydl: |
8372be74 | 928 | pre_process = opts.update_self or opts.rm_cachedir |
f304da8a | 929 | actual_use = all_urls or opts.load_info_filename |
bdde425c | 930 | |
052421ff | 931 | if opts.rm_cachedir: |
a0e07d31 | 932 | ydl.cache.remove() |
052421ff | 933 | |
77df20f1 | 934 | updater = Updater(ydl, opts.update_self if isinstance(opts.update_self, str) else None) |
8372be74 | 935 | if opts.update_self and updater.update() and actual_use: |
936 | if updater.cmd: | |
937 | return updater.restart() | |
938 | # This code is reachable only for zip variant in py < 3.10 | |
939 | # It makes sense to exit here, but the old behavior is to continue | |
940 | ydl.report_warning('Restart yt-dlp to use the updated version') | |
941 | # return 100, 'ERROR: The program must exit for the update to complete' | |
e5813e53 | 942 | |
e5813e53 | 943 | if not actual_use: |
8372be74 | 944 | if pre_process: |
e79969b2 | 945 | return ydl._download_retcode |
59ae15a5 | 946 | |
7d4111ed | 947 | ydl.warn_if_short_id(sys.argv[1:] if argv is None else argv) |
adc0ae3c PH |
948 | parser.error( |
949 | 'You must provide at least one URL.\n' | |
7a5c1cfe | 950 | 'Type yt-dlp --help to see a list of all options.') |
7d4111ed | 951 | |
c487cf00 | 952 | parser.destroy() |
bdde425c | 953 | try: |
1dcc4c0c | 954 | if opts.load_info_filename is not None: |
ab1de9cb | 955 | if all_urls: |
956 | ydl.report_warning('URLs are ignored due to --load-info-json') | |
9e491463 | 957 | return ydl.download_with_info_file(expand_path(opts.load_info_filename)) |
1dcc4c0c | 958 | else: |
9e491463 | 959 | return ydl.download(all_urls) |
f304da8a | 960 | except DownloadCancelled: |
8b0d7497 | 961 | ydl.to_screen('Aborting remaining downloads') |
9e491463 | 962 | return 101 |
235b3ba4 | 963 | |
a27b9e8b | 964 | |
b8ad4f02 | 965 | def main(argv=None): |
d5d1df8a | 966 | global _IN_CLI |
967 | _IN_CLI = True | |
59ae15a5 | 968 | try: |
9e491463 | 969 | _exit(*variadic(_real_main(argv))) |
59ae15a5 | 970 | except DownloadError: |
9e491463 | 971 | _exit(1) |
aa9369a2 | 972 | except SameFileError as e: |
9e491463 | 973 | _exit(f'ERROR: {e}') |
59ae15a5 | 974 | except KeyboardInterrupt: |
9e491463 | 975 | _exit('\nERROR: Interrupted by user') |
aa9369a2 | 976 | except BrokenPipeError as e: |
cc3fa8d3 | 977 | # https://docs.python.org/3/library/signal.html#note-on-sigpipe |
978 | devnull = os.open(os.devnull, os.O_WRONLY) | |
979 | os.dup2(devnull, sys.stdout.fileno()) | |
9e491463 | 980 | _exit(f'\nERROR: {e}') |
981 | except optparse.OptParseError as e: | |
982 | _exit(2, f'\n{e}') | |
2bad0e5d | 983 | |
582be358 | 984 | |
82d02080 | 985 | from .extractor import gen_extractors, list_extractors |
21633673 | 986 | |
d1b5f70b | 987 | __all__ = [ |
988 | 'main', | |
989 | 'YoutubeDL', | |
990 | 'parse_options', | |
991 | 'gen_extractors', | |
992 | 'list_extractors', | |
993 | ] |