]>
Raphaƫl G. Git Repositories - youtubedl/blob - youtube_dl/YoutubeDL.py
2 # -*- coding: utf-8 -*-
4 from __future__
import absolute_import
, unicode_literals
33 compat_get_terminal_size
,
38 compat_urllib_request
,
58 PerRequestProxyHandler
,
68 UnavailableVideoError
,
79 from . cache
import Cache
80 from . extractor
import get_info_extractor
, gen_extractors
81 from . downloader
import get_suitable_downloader
82 from . downloader
. rtmp
import rtmpdump_version
83 from . postprocessor
import (
85 FFmpegFixupStretchedPP
,
90 from . version
import __version__
93 class YoutubeDL ( object ):
96 YoutubeDL objects are the ones responsible of downloading the
97 actual video file and writing it to disk if the user has requested
98 it, among some other tasks. In most cases there should be one per
99 program. As, given a video URL, the downloader doesn't know how to
100 extract all the needed information, task that InfoExtractors do, it
101 has to pass the URL to one of them.
103 For this, YoutubeDL objects have a method that allows
104 InfoExtractors to be registered in a given order. When it is passed
105 a URL, the YoutubeDL object handles it to the first InfoExtractor it
106 finds that reports being able to handle it. The InfoExtractor extracts
107 all the information about the video or videos the URL refers to, and
108 YoutubeDL process the extracted information, possibly using a File
109 Downloader to download the video.
111 YoutubeDL objects accept a lot of parameters. In order not to saturate
112 the object constructor with arguments, it receives a dictionary of
113 options instead. These options are available through the params
114 attribute for the InfoExtractors to use. The YoutubeDL also
115 registers itself as the downloader in charge for the InfoExtractors
116 that are added to it, so this is a "mutual registration".
120 username: Username for authentication purposes.
121 password: Password for authentication purposes.
122 videopassword: Password for accessing a video.
123 usenetrc: Use netrc for authentication instead.
124 verbose: Print additional info to stdout.
125 quiet: Do not print messages to stdout.
126 no_warnings: Do not print out anything for warnings.
127 forceurl: Force printing final URL.
128 forcetitle: Force printing title.
129 forceid: Force printing ID.
130 forcethumbnail: Force printing thumbnail URL.
131 forcedescription: Force printing description.
132 forcefilename: Force printing final filename.
133 forceduration: Force printing duration.
134 forcejson: Force printing info_dict as JSON.
135 dump_single_json: Force printing the info_dict of the whole playlist
136 (or video) as a single JSON line.
137 simulate: Do not download the video files.
138 format: Video format code. See options.py for more information.
139 outtmpl: Template for output names.
140 restrictfilenames: Do not allow "&" and spaces in file names
141 ignoreerrors: Do not stop on download errors.
142 force_generic_extractor: Force downloader to use the generic extractor
143 nooverwrites: Prevent overwriting files.
144 playliststart: Playlist item to start at.
145 playlistend: Playlist item to end at.
146 playlist_items: Specific indices of playlist to download.
147 playlistreverse: Download playlist items in reverse order.
148 matchtitle: Download only matching titles.
149 rejecttitle: Reject downloads for matching titles.
150 logger: Log messages to a logging.Logger instance.
151 logtostderr: Log messages to stderr instead of stdout.
152 writedescription: Write the video description to a .description file
153 writeinfojson: Write the video description to a .info.json file
154 writeannotations: Write the video annotations to a .annotations.xml file
155 writethumbnail: Write the thumbnail image to a file
156 write_all_thumbnails: Write all thumbnail formats to files
157 writesubtitles: Write the video subtitles to a file
158 writeautomaticsub: Write the automatic subtitles to a file
159 allsubtitles: Downloads all the subtitles of the video
160 (requires writesubtitles or writeautomaticsub)
161 listsubtitles: Lists all available subtitles for the video
162 subtitlesformat: The format code for subtitles
163 subtitleslangs: List of languages of the subtitles to download
164 keepvideo: Keep the video file after post-processing
165 daterange: A DateRange object, download only if the upload_date is in the range.
166 skip_download: Skip the actual download of the video file
167 cachedir: Location of the cache files in the filesystem.
168 False to disable filesystem cache.
169 noplaylist: Download single video instead of a playlist if in doubt.
170 age_limit: An integer representing the user's age in years.
171 Unsuitable videos for the given age are skipped.
172 min_views: An integer representing the minimum view count the video
173 must have in order to not be skipped.
174 Videos without view count information are always
175 downloaded. None for no limit.
176 max_views: An integer representing the maximum view count.
177 Videos that are more popular than that are not
179 Videos without view count information are always
180 downloaded. None for no limit.
181 download_archive: File name of a file where all downloads are recorded.
182 Videos already present in the file are not downloaded
184 cookiefile: File name where cookies should be read from and dumped to.
185 nocheckcertificate:Do not verify SSL certificates
186 prefer_insecure: Use HTTP instead of HTTPS to retrieve information.
187 At the moment, this is only supported by YouTube.
188 proxy: URL of the proxy server to use
189 cn_verification_proxy: URL of the proxy to use for IP address verification
190 on Chinese sites. (Experimental)
191 socket_timeout: Time to wait for unresponsive hosts, in seconds
192 bidi_workaround: Work around buggy terminals without bidirectional text
193 support, using fridibi
194 debug_printtraffic:Print out sent and received HTTP traffic
195 include_ads: Download ads as well
196 default_search: Prepend this string if an input url is not valid.
197 'auto' for elaborate guessing
198 encoding: Use this encoding instead of the system-specified.
199 extract_flat: Do not resolve URLs, return the immediate result.
200 Pass in 'in_playlist' to only show this behavior for
202 postprocessors: A list of dictionaries, each with an entry
203 * key: The name of the postprocessor. See
204 youtube_dl/postprocessor/__init__.py for a list.
205 as well as any further keyword arguments for the
207 progress_hooks: A list of functions that get called on download
208 progress, with a dictionary with the entries
209 * status: One of "downloading", "error", or "finished".
210 Check this first and ignore unknown values.
212 If status is one of "downloading", or "finished", the
213 following properties may also be present:
214 * filename: The final filename (always present)
215 * tmpfilename: The filename we're currently writing to
216 * downloaded_bytes: Bytes on disk
217 * total_bytes: Size of the whole file, None if unknown
218 * total_bytes_estimate: Guess of the eventual file size,
220 * elapsed: The number of seconds since download started.
221 * eta: The estimated time in seconds, None if unknown
222 * speed: The download speed in bytes/second, None if
224 * fragment_index: The counter of the currently
225 downloaded video fragment.
226 * fragment_count: The number of fragments (= individual
227 files that will be merged)
229 Progress hooks are guaranteed to be called at least once
230 (with status "finished") if the download is successful.
231 merge_output_format: Extension to use when merging formats.
232 fixup: Automatically correct known faults of the file.
234 - "never": do nothing
235 - "warn": only emit a warning
236 - "detect_or_warn": check whether we can do anything
237 about it, warn otherwise (default)
238 source_address: (Experimental) Client-side IP address to bind to.
239 call_home: Boolean, true iff we are allowed to contact the
240 youtube-dl servers for debugging.
241 sleep_interval: Number of seconds to sleep before each download.
242 listformats: Print an overview of available video formats and exit.
243 list_thumbnails: Print a table of all thumbnails and exit.
244 match_filter: A function that gets called with the info_dict of
246 If it returns a message, the video is ignored.
247 If it returns None, the video is downloaded.
248 match_filter_func in utils.py is one example for this.
249 no_color: Do not emit color codes in output.
251 The following options determine which downloader is picked:
252 external_downloader: Executable of the external downloader to call.
253 None or unset for standard (built-in) downloader.
254 hls_prefer_native: Use the native HLS downloader instead of ffmpeg/avconv.
256 The following parameters are not used by YoutubeDL itself, they are used by
257 the downloader (see youtube_dl/downloader/common.py):
258 nopart, updatetime, buffersize, ratelimit, min_filesize, max_filesize, test,
259 noresizebuffer, retries, continuedl, noprogress, consoletitle,
260 xattr_set_filesize, external_downloader_args.
262 The following options are used by the post processors:
263 prefer_ffmpeg: If True, use ffmpeg instead of avconv if both are available,
264 otherwise prefer avconv.
265 postprocessor_args: A list of additional command-line arguments for the
272 _download_retcode
= None
273 _num_downloads
= None
276 def __init__ ( self
, params
= None , auto_init
= True ):
277 """Create a FileDownloader object with the given options."""
281 self
._ ies
_ instances
= {}
283 self
._ progress
_ hooks
= []
284 self
._ download
_ retcode
= 0
285 self
._ num
_ downloads
= 0
286 self
._ screen
_ file
= [ sys
. stdout
, sys
. stderr
][ params
. get ( 'logtostderr' , False )]
287 self
._ err
_ file
= sys
. stderr
289 self
. cache
= Cache ( self
)
291 if params
. get ( 'bidi_workaround' , False ):
294 master
, slave
= pty
. openpty ()
295 width
= compat_get_terminal_size (). columns
299 width_args
= [ '-w' , str ( width
)]
301 stdin
= subprocess
. PIPE
,
303 stderr
= self
._ err
_ file
)
305 self
._ output
_ process
= subprocess
. Popen (
306 [ 'bidiv' ] + width_args
, ** sp_kwargs
309 self
._ output
_ process
= subprocess
. Popen (
310 [ 'fribidi' , '-c' , 'UTF-8' ] + width_args
, ** sp_kwargs
)
311 self
._ output
_ channel
= os
. fdopen ( master
, 'rb' )
312 except OSError as ose
:
314 self
. report_warning ( 'Could not find fribidi executable, ignoring --bidi-workaround . Make sure that fribidi is an executable file in one of the directories in your $PATH.' )
318 if ( sys
. version_info
>= ( 3 ,) and sys
. platform
!= 'win32' and
319 sys
. getfilesystemencoding () in [ 'ascii' , 'ANSI_X3.4-1968' ] and
320 not params
. get ( 'restrictfilenames' , False )):
321 # On Python 3, the Unicode filesystem API will throw errors (#1474)
323 'Assuming --restrict-filenames since file system encoding '
324 'cannot encode all characters. '
325 'Set the LC_ALL environment variable to fix this.' )
326 self
. params
[ 'restrictfilenames' ] = True
328 if isinstance ( params
. get ( 'outtmpl' ), bytes ):
330 'Parameter outtmpl is bytes, but should be a unicode string. '
331 'Put from __future__ import unicode_literals at the top of your code file or consider switching to Python 3.x.' )
336 self
. print_debug_header ()
337 self
. add_default_info_extractors ()
339 for pp_def_raw
in self
. params
. get ( 'postprocessors' , []):
340 pp_class
= get_postprocessor ( pp_def_raw
[ 'key' ])
341 pp_def
= dict ( pp_def_raw
)
343 pp
= pp_class ( self
, ** compat_kwargs ( pp_def
))
344 self
. add_post_processor ( pp
)
346 for ph
in self
. params
. get ( 'progress_hooks' , []):
347 self
. add_progress_hook ( ph
)
349 def warn_if_short_id ( self
, argv
):
350 # short YouTube ID starting with dash?
352 i
for i
, a
in enumerate ( argv
)
353 if re
. match ( r
'^-[0-9A-Za-z_-] {10} $' , a
)]
357 [ a
for i
, a
in enumerate ( argv
) if i
not in idxs
] +
358 [ '--' ] + [ argv
[ i
] for i
in idxs
]
361 'Long argument string detected. '
362 'Use -- to separate parameters and URLs, like this: \n %s \n ' %
363 args_to_str ( correct_argv
))
365 def add_info_extractor ( self
, ie
):
366 """Add an InfoExtractor object to the end of the list."""
368 self
._ ies
_ instances
[ ie
. ie_key ()] = ie
369 ie
. set_downloader ( self
)
371 def get_info_extractor ( self
, ie_key
):
373 Get an instance of an IE with name ie_key, it will try to get one from
374 the _ies list, if there's no instance it will create a new one and add
375 it to the extractor list.
377 ie
= self
._ ies
_ instances
. get ( ie_key
)
379 ie
= get_info_extractor ( ie_key
)()
380 self
. add_info_extractor ( ie
)
383 def add_default_info_extractors ( self
):
385 Add the InfoExtractors returned by gen_extractors to the end of the list
387 for ie
in gen_extractors ():
388 self
. add_info_extractor ( ie
)
390 def add_post_processor ( self
, pp
):
391 """Add a PostProcessor object to the end of the chain."""
393 pp
. set_downloader ( self
)
395 def add_progress_hook ( self
, ph
):
396 """Add the progress hook (currently only for the file downloader)"""
397 self
._ progress
_ hooks
. append ( ph
)
399 def _bidi_workaround ( self
, message
):
400 if not hasattr ( self
, '_output_channel' ):
403 assert hasattr ( self
, '_output_process' )
404 assert isinstance ( message
, compat_str
)
405 line_count
= message
. count ( ' \n ' ) + 1
406 self
._ output
_ process
. stdin
. write (( message
+ ' \n ' ). encode ( 'utf-8' ))
407 self
._ output
_ process
. stdin
. flush ()
408 res
= '' . join ( self
._ output
_ channel
. readline (). decode ( 'utf-8' )
409 for _
in range ( line_count
))
410 return res
[:- len ( ' \n ' )]
412 def to_screen ( self
, message
, skip_eol
= False ):
413 """Print message to stdout if not in quiet mode."""
414 return self
. to_stdout ( message
, skip_eol
, check_quiet
= True )
416 def _write_string ( self
, s
, out
= None ):
417 write_string ( s
, out
= out
, encoding
= self
. params
. get ( 'encoding' ))
419 def to_stdout ( self
, message
, skip_eol
= False , check_quiet
= False ):
420 """Print message to stdout if not in quiet mode."""
421 if self
. params
. get ( 'logger' ):
422 self
. params
[ 'logger' ]. debug ( message
)
423 elif not check_quiet
or not self
. params
. get ( 'quiet' , False ):
424 message
= self
._ bidi
_ workaround
( message
)
425 terminator
= [ ' \n ' , '' ][ skip_eol
]
426 output
= message
+ terminator
428 self
._ write
_ string
( output
, self
._ screen
_ file
)
430 def to_stderr ( self
, message
):
431 """Print message to stderr."""
432 assert isinstance ( message
, compat_str
)
433 if self
. params
. get ( 'logger' ):
434 self
. params
[ 'logger' ]. error ( message
)
436 message
= self
._ bidi
_ workaround
( message
)
437 output
= message
+ ' \n '
438 self
._ write
_ string
( output
, self
._ err
_ file
)
440 def to_console_title ( self
, message
):
441 if not self
. params
. get ( 'consoletitle' , False ):
443 if os
. name
== 'nt' and ctypes
. windll
. kernel32
. GetConsoleWindow ():
444 # c_wchar_p() might not be necessary if `message` is
445 # already of type unicode()
446 ctypes
. windll
. kernel32
. SetConsoleTitleW ( ctypes
. c_wchar_p ( message
))
447 elif 'TERM' in os
. environ
:
448 self
._ write
_ string
( ' \033 ]0; %s \007 ' % message
, self
._ screen
_ file
)
450 def save_console_title ( self
):
451 if not self
. params
. get ( 'consoletitle' , False ):
453 if 'TERM' in os
. environ
:
454 # Save the title on stack
455 self
._ write
_ string
( ' \033 [22;0t' , self
._ screen
_ file
)
457 def restore_console_title ( self
):
458 if not self
. params
. get ( 'consoletitle' , False ):
460 if 'TERM' in os
. environ
:
461 # Restore the title from stack
462 self
._ write
_ string
( ' \033 [23;0t' , self
._ screen
_ file
)
465 self
. save_console_title ()
468 def __exit__ ( self
, * args
):
469 self
. restore_console_title ()
471 if self
. params
. get ( 'cookiefile' ) is not None :
472 self
. cookiejar
. save ()
474 def trouble ( self
, message
= None , tb
= None ):
475 """Determine action to take when a download problem appears.
477 Depending on if the downloader has been configured to ignore
478 download errors or not, this method may throw an exception or
479 not when errors are found, after printing the message.
481 tb, if given, is additional traceback information.
483 if message
is not None :
484 self
. to_stderr ( message
)
485 if self
. params
. get ( 'verbose' ):
487 if sys
. exc_info ()[ 0 ]: # if .trouble has been called from an except block
489 if hasattr ( sys
. exc_info ()[ 1 ], 'exc_info' ) and sys
. exc_info ()[ 1 ]. exc_info
[ 0 ]:
490 tb
+= '' . join ( traceback
. format_exception (* sys
. exc_info ()[ 1 ]. exc_info
))
491 tb
+= compat_str ( traceback
. format_exc ())
493 tb_data
= traceback
. format_list ( traceback
. extract_stack ())
494 tb
= '' . join ( tb_data
)
496 if not self
. params
. get ( 'ignoreerrors' , False ):
497 if sys
. exc_info ()[ 0 ] and hasattr ( sys
. exc_info ()[ 1 ], 'exc_info' ) and sys
. exc_info ()[ 1 ]. exc_info
[ 0 ]:
498 exc_info
= sys
. exc_info ()[ 1 ]. exc_info
500 exc_info
= sys
. exc_info ()
501 raise DownloadError ( message
, exc_info
)
502 self
._ download
_ retcode
= 1
504 def report_warning ( self
, message
):
506 Print the message to stderr, it will be prefixed with 'WARNING:'
507 If stderr is a tty file the 'WARNING:' will be colored
509 if self
. params
. get ( 'logger' ) is not None :
510 self
. params
[ 'logger' ]. warning ( message
)
512 if self
. params
. get ( 'no_warnings' ):
514 if not self
. params
. get ( 'no_color' ) and self
._ err
_ file
. isatty () and os
. name
!= 'nt' :
515 _msg_header
= ' \033 [0;33mWARNING: \033 [0m'
517 _msg_header
= 'WARNING:'
518 warning_message
= ' %s %s ' % ( _msg_header
, message
)
519 self
. to_stderr ( warning_message
)
521 def report_error ( self
, message
, tb
= None ):
523 Do the same as trouble, but prefixes the message with 'ERROR:', colored
524 in red if stderr is a tty file.
526 if not self
. params
. get ( 'no_color' ) and self
._ err
_ file
. isatty () and os
. name
!= 'nt' :
527 _msg_header
= ' \033 [0;31mERROR: \033 [0m'
529 _msg_header
= 'ERROR:'
530 error_message
= ' %s %s ' % ( _msg_header
, message
)
531 self
. trouble ( error_message
, tb
)
533 def report_file_already_downloaded ( self
, file_name
):
534 """Report file has already been fully downloaded."""
536 self
. to_screen ( '[download] %s has already been downloaded' % file_name
)
537 except UnicodeEncodeError :
538 self
. to_screen ( '[download] The file has already been downloaded' )
540 def prepare_filename ( self
, info_dict
):
541 """Generate the output filename."""
543 template_dict
= dict ( info_dict
)
545 template_dict
[ 'epoch' ] = int ( time
. time ())
546 autonumber_size
= self
. params
. get ( 'autonumber_size' )
547 if autonumber_size
is None :
549 autonumber_templ
= ' %0 ' + str ( autonumber_size
) + 'd'
550 template_dict
[ 'autonumber' ] = autonumber_templ
% self
._ num
_ downloads
551 if template_dict
. get ( 'playlist_index' ) is not None :
552 template_dict
[ 'playlist_index' ] = ' %0 *d' % ( len ( str ( template_dict
[ 'n_entries' ])), template_dict
[ 'playlist_index' ])
553 if template_dict
. get ( 'resolution' ) is None :
554 if template_dict
. get ( 'width' ) and template_dict
. get ( 'height' ):
555 template_dict
[ 'resolution' ] = ' %dx%d ' % ( template_dict
[ 'width' ], template_dict
[ 'height' ])
556 elif template_dict
. get ( 'height' ):
557 template_dict
[ 'resolution' ] = ' %s p' % template_dict
[ 'height' ]
558 elif template_dict
. get ( 'width' ):
559 template_dict
[ 'resolution' ] = '?x %d ' % template_dict
[ 'width' ]
561 sanitize
= lambda k
, v
: sanitize_filename (
563 restricted
= self
. params
. get ( 'restrictfilenames' ),
565 template_dict
= dict (( k
, sanitize ( k
, v
))
566 for k
, v
in template_dict
. items ()
568 template_dict
= collections
. defaultdict ( lambda : 'NA' , template_dict
)
570 outtmpl
= sanitize_path ( self
. params
. get ( 'outtmpl' , DEFAULT_OUTTMPL
))
571 tmpl
= compat_expanduser ( outtmpl
)
572 filename
= tmpl
% template_dict
573 # Temporary fix for #4787
574 # 'Treat' all problem characters by passing filename through preferredencoding
575 # to workaround encoding issues with subprocess on python2 @ Windows
576 if sys
. version_info
< ( 3 , 0 ) and sys
. platform
== 'win32' :
577 filename
= encodeFilename ( filename
, True ). decode ( preferredencoding ())
579 except ValueError as err
:
580 self
. report_error ( 'Error in output template: ' + str ( err
) + ' (encoding: ' + repr ( preferredencoding ()) + ')' )
583 def _match_entry ( self
, info_dict
, incomplete
):
584 """ Returns None iff the file should be downloaded """
586 video_title
= info_dict
. get ( 'title' , info_dict
. get ( 'id' , 'video' ))
587 if 'title' in info_dict
:
588 # This can happen when we're just evaluating the playlist
589 title
= info_dict
[ 'title' ]
590 matchtitle
= self
. params
. get ( 'matchtitle' , False )
592 if not re
. search ( matchtitle
, title
, re
. IGNORECASE
):
593 return '"' + title
+ '" title did not match pattern "' + matchtitle
+ '"'
594 rejecttitle
= self
. params
. get ( 'rejecttitle' , False )
596 if re
. search ( rejecttitle
, title
, re
. IGNORECASE
):
597 return '"' + title
+ '" title matched reject pattern "' + rejecttitle
+ '"'
598 date
= info_dict
. get ( 'upload_date' , None )
600 dateRange
= self
. params
. get ( 'daterange' , DateRange ())
601 if date
not in dateRange
:
602 return ' %s upload date is not in range %s ' % ( date_from_str ( date
). isoformat (), dateRange
)
603 view_count
= info_dict
. get ( 'view_count' , None )
604 if view_count
is not None :
605 min_views
= self
. params
. get ( 'min_views' )
606 if min_views
is not None and view_count
< min_views
:
607 return 'Skipping %s , because it has not reached minimum view count ( %d / %d )' % ( video_title
, view_count
, min_views
)
608 max_views
= self
. params
. get ( 'max_views' )
609 if max_views
is not None and view_count
> max_views
:
610 return 'Skipping %s , because it has exceeded the maximum view count ( %d / %d )' % ( video_title
, view_count
, max_views
)
611 if age_restricted ( info_dict
. get ( 'age_limit' ), self
. params
. get ( 'age_limit' )):
612 return 'Skipping " %s " because it is age restricted' % video_title
613 if self
. in_download_archive ( info_dict
):
614 return ' %s has already been recorded in archive' % video_title
617 match_filter
= self
. params
. get ( 'match_filter' )
618 if match_filter
is not None :
619 ret
= match_filter ( info_dict
)
626 def add_extra_info ( info_dict
, extra_info
):
627 '''Set the keys from extra_info in info dict if they are missing'''
628 for key
, value
in extra_info
. items ():
629 info_dict
. setdefault ( key
, value
)
631 def extract_info ( self
, url
, download
= True , ie_key
= None , extra_info
={},
632 process
= True , force_generic_extractor
= False ):
634 Returns a list with a dictionary for each video we find.
635 If 'download', also downloads the videos.
636 extra_info is a dict containing the extra values to add to each result
639 if not ie_key
and force_generic_extractor
:
643 ies
= [ self
. get_info_extractor ( ie_key
)]
648 if not ie
. suitable ( url
):
652 self
. report_warning ( 'The program functionality for this site has been marked as broken, '
653 'and will probably not work.' )
656 ie_result
= ie
. extract ( url
)
657 if ie_result
is None : # Finished already (backwards compatibility; listformats and friends should be moved here)
659 if isinstance ( ie_result
, list ):
660 # Backwards compatibility: old IE result format
662 '_type' : 'compat_list' ,
663 'entries' : ie_result
,
665 self
. add_default_extra_info ( ie_result
, ie
, url
)
667 return self
. process_ie_result ( ie_result
, download
, extra_info
)
670 except ExtractorError
as de
: # An error we somewhat expected
671 self
. report_error ( compat_str ( de
), de
. format_traceback ())
673 except MaxDownloadsReached
:
675 except Exception as e
:
676 if self
. params
. get ( 'ignoreerrors' , False ):
677 self
. report_error ( compat_str ( e
), tb
= compat_str ( traceback
. format_exc ()))
682 self
. report_error ( 'no suitable InfoExtractor for URL %s ' % url
)
684 def add_default_extra_info ( self
, ie_result
, ie
, url
):
685 self
. add_extra_info ( ie_result
, {
686 'extractor' : ie
. IE_NAME
,
688 'webpage_url_basename' : url_basename ( url
),
689 'extractor_key' : ie
. ie_key (),
692 def process_ie_result ( self
, ie_result
, download
= True , extra_info
={}):
694 Take the result of the ie(may be modified) and resolve all unresolved
695 references (URLs, playlist items).
697 It will also download the videos if 'download'.
698 Returns the resolved ie_result.
701 result_type
= ie_result
. get ( '_type' , 'video' )
703 if result_type
in ( 'url' , 'url_transparent' ):
704 extract_flat
= self
. params
. get ( 'extract_flat' , False )
705 if (( extract_flat
== 'in_playlist' and 'playlist' in extra_info
) or
706 extract_flat
is True ):
707 if self
. params
. get ( 'forcejson' , False ):
708 self
. to_stdout ( json
. dumps ( ie_result
))
711 if result_type
== 'video' :
712 self
. add_extra_info ( ie_result
, extra_info
)
713 return self
. process_video_result ( ie_result
, download
= download
)
714 elif result_type
== 'url' :
715 # We have to add extra_info to the results because it may be
716 # contained in a playlist
717 return self
. extract_info ( ie_result
[ 'url' ],
719 ie_key
= ie_result
. get ( 'ie_key' ),
720 extra_info
= extra_info
)
721 elif result_type
== 'url_transparent' :
722 # Use the information from the embedding page
723 info
= self
. extract_info (
724 ie_result
[ 'url' ], ie_key
= ie_result
. get ( 'ie_key' ),
725 extra_info
= extra_info
, download
= False , process
= False )
727 force_properties
= dict (
728 ( k
, v
) for k
, v
in ie_result
. items () if v
is not None )
729 for f
in ( '_type' , 'url' ):
730 if f
in force_properties
:
731 del force_properties
[ f
]
732 new_result
= info
. copy ()
733 new_result
. update ( force_properties
)
735 assert new_result
. get ( '_type' ) != 'url_transparent'
737 return self
. process_ie_result (
738 new_result
, download
= download
, extra_info
= extra_info
)
739 elif result_type
== 'playlist' or result_type
== 'multi_video' :
740 # We process each entry in the playlist
741 playlist
= ie_result
. get ( 'title' , None ) or ie_result
. get ( 'id' , None )
742 self
. to_screen ( '[download] Downloading playlist: %s ' % playlist
)
744 playlist_results
= []
746 playliststart
= self
. params
. get ( 'playliststart' , 1 ) - 1
747 playlistend
= self
. params
. get ( 'playlistend' , None )
748 # For backwards compatibility, interpret -1 as whole list
749 if playlistend
== - 1 :
752 playlistitems_str
= self
. params
. get ( 'playlist_items' , None )
754 if playlistitems_str
is not None :
755 def iter_playlistitems ( format
):
756 for string_segment
in format
. split ( ',' ):
757 if '-' in string_segment
:
758 start
, end
= string_segment
. split ( '-' )
759 for item
in range ( int ( start
), int ( end
) + 1 ):
762 yield int ( string_segment
)
763 playlistitems
= iter_playlistitems ( playlistitems_str
)
765 ie_entries
= ie_result
[ 'entries' ]
766 if isinstance ( ie_entries
, list ):
767 n_all_entries
= len ( ie_entries
)
770 ie_entries
[ i
- 1 ] for i
in playlistitems
771 if - n_all_entries
<= i
- 1 < n_all_entries
]
773 entries
= ie_entries
[ playliststart
: playlistend
]
774 n_entries
= len ( entries
)
776 "[ %s ] playlist %s : Collected %d video ids (downloading %d of them)" %
777 ( ie_result
[ 'extractor' ], playlist
, n_all_entries
, n_entries
))
778 elif isinstance ( ie_entries
, PagedList
):
781 for item
in playlistitems
:
782 entries
. extend ( ie_entries
. getslice (
786 entries
= ie_entries
. getslice (
787 playliststart
, playlistend
)
788 n_entries
= len ( entries
)
790 "[ %s ] playlist %s : Downloading %d videos" %
791 ( ie_result
[ 'extractor' ], playlist
, n_entries
))
794 entry_list
= list ( ie_entries
)
795 entries
= [ entry_list
[ i
- 1 ] for i
in playlistitems
]
797 entries
= list ( itertools
. islice (
798 ie_entries
, playliststart
, playlistend
))
799 n_entries
= len ( entries
)
801 "[ %s ] playlist %s : Downloading %d videos" %
802 ( ie_result
[ 'extractor' ], playlist
, n_entries
))
804 if self
. params
. get ( 'playlistreverse' , False ):
805 entries
= entries
[::- 1 ]
807 for i
, entry
in enumerate ( entries
, 1 ):
808 self
. to_screen ( '[download] Downloading video %s of %s ' % ( i
, n_entries
))
810 'n_entries' : n_entries
,
811 'playlist' : playlist
,
812 'playlist_id' : ie_result
. get ( 'id' ),
813 'playlist_title' : ie_result
. get ( 'title' ),
814 'playlist_index' : i
+ playliststart
,
815 'extractor' : ie_result
[ 'extractor' ],
816 'webpage_url' : ie_result
[ 'webpage_url' ],
817 'webpage_url_basename' : url_basename ( ie_result
[ 'webpage_url' ]),
818 'extractor_key' : ie_result
[ 'extractor_key' ],
821 reason
= self
._ match
_ entry
( entry
, incomplete
= True )
822 if reason
is not None :
823 self
. to_screen ( '[download] ' + reason
)
826 entry_result
= self
. process_ie_result ( entry
,
829 playlist_results
. append ( entry_result
)
830 ie_result
[ 'entries' ] = playlist_results
832 elif result_type
== 'compat_list' :
834 'Extractor %s returned a compat_list result. '
835 'It needs to be updated.' % ie_result
. get ( 'extractor' ))
841 'extractor' : ie_result
[ 'extractor' ],
842 'webpage_url' : ie_result
[ 'webpage_url' ],
843 'webpage_url_basename' : url_basename ( ie_result
[ 'webpage_url' ]),
844 'extractor_key' : ie_result
[ 'extractor_key' ],
848 ie_result
[ 'entries' ] = [
849 self
. process_ie_result ( _fixup ( r
), download
, extra_info
)
850 for r
in ie_result
[ 'entries' ]
854 raise Exception ( 'Invalid result type: %s ' % result_type
)
856 def _apply_format_filter ( self
, format_spec
, available_formats
):
857 " Returns a tuple of the remaining format_spec and filtered formats "
867 operator_rex
= re
. compile ( r
'''(?x)\s*\[
868 (?P<key>width|height|tbr|abr|vbr|asr|filesize|fps)
869 \s*(?P<op> %s )(?P<none_inclusive>\s*\?)?\s*
870 (?P<value>[0-9.]+(?:[kKmMgGtTpPeEzZyY]i?[Bb]?)?)
872 ''' % '|' . join ( map ( re
. escape
, OPERATORS
. keys ())))
873 m
= operator_rex
. search ( format_spec
)
876 comparison_value
= int ( m
. group ( 'value' ))
878 comparison_value
= parse_filesize ( m
. group ( 'value' ))
879 if comparison_value
is None :
880 comparison_value
= parse_filesize ( m
. group ( 'value' ) + 'B' )
881 if comparison_value
is None :
883 'Invalid value %r in format specification %r ' % (
884 m
. group ( 'value' ), format_spec
))
885 op
= OPERATORS
[ m
. group ( 'op' )]
892 str_operator_rex
= re
. compile ( r
'''(?x)\s*\[
893 \s*(?P<key>ext|acodec|vcodec|container|protocol)
894 \s*(?P<op> %s )(?P<none_inclusive>\s*\?)?
895 \s*(?P<value>[a-zA-Z0-9_-]+)
897 ''' % '|' . join ( map ( re
. escape
, STR_OPERATORS
. keys ())))
898 m
= str_operator_rex
. search ( format_spec
)
900 comparison_value
= m
. group ( 'value' )
901 op
= STR_OPERATORS
[ m
. group ( 'op' )]
904 raise ValueError ( 'Invalid format specification %r ' % format_spec
)
907 actual_value
= f
. get ( m
. group ( 'key' ))
908 if actual_value
is None :
909 return m
. group ( 'none_inclusive' )
910 return op ( actual_value
, comparison_value
)
911 new_formats
= [ f
for f
in available_formats
if _filter ( f
)]
913 new_format_spec
= format_spec
[:- len ( m
. group ( 0 ))]
914 if not new_format_spec
:
915 new_format_spec
= 'best'
917 return ( new_format_spec
, new_formats
)
919 def select_format ( self
, format_spec
, available_formats
):
920 while format_spec
. endswith ( ']' ):
921 format_spec
, available_formats
= self
._ apply
_ format
_ filter
(
922 format_spec
, available_formats
)
923 if not available_formats
:
926 if format_spec
in [ 'best' , 'worst' , None ]:
927 format_idx
= 0 if format_spec
== 'worst' else - 1
928 audiovideo_formats
= [
929 f
for f
in available_formats
930 if f
. get ( 'vcodec' ) != 'none' and f
. get ( 'acodec' ) != 'none' ]
931 if audiovideo_formats
:
932 return audiovideo_formats
[ format_idx
]
933 # for audio only (soundcloud) or video only (imgur) urls, select the best/worst audio format
934 elif ( all ( f
. get ( 'acodec' ) != 'none' for f
in available_formats
) or
935 all ( f
. get ( 'vcodec' ) != 'none' for f
in available_formats
)):
936 return available_formats
[ format_idx
]
937 elif format_spec
== 'bestaudio' :
939 f
for f
in available_formats
940 if f
. get ( 'vcodec' ) == 'none' ]
942 return audio_formats
[- 1 ]
943 elif format_spec
== 'worstaudio' :
945 f
for f
in available_formats
946 if f
. get ( 'vcodec' ) == 'none' ]
948 return audio_formats
[ 0 ]
949 elif format_spec
== 'bestvideo' :
951 f
for f
in available_formats
952 if f
. get ( 'acodec' ) == 'none' ]
954 return video_formats
[- 1 ]
955 elif format_spec
== 'worstvideo' :
957 f
for f
in available_formats
958 if f
. get ( 'acodec' ) == 'none' ]
960 return video_formats
[ 0 ]
962 extensions
= [ 'mp4' , 'flv' , 'webm' , '3gp' , 'm4a' , 'mp3' , 'ogg' , 'aac' , 'wav' ]
963 if format_spec
in extensions
:
964 filter_f
= lambda f
: f
[ 'ext' ] == format_spec
966 filter_f
= lambda f
: f
[ 'format_id' ] == format_spec
967 matches
= list ( filter ( filter_f
, available_formats
))
972 def _calc_headers ( self
, info_dict
):
973 res
= std_headers
. copy ()
975 add_headers
= info_dict
. get ( 'http_headers' )
977 res
. update ( add_headers
)
979 cookies
= self
._ calc
_ cookies
( info_dict
)
981 res
[ 'Cookie' ] = cookies
985 def _calc_cookies ( self
, info_dict
):
986 pr
= compat_urllib_request
. Request ( info_dict
[ 'url' ])
987 self
. cookiejar
. add_cookie_header ( pr
)
988 return pr
. get_header ( 'Cookie' )
990 def process_video_result ( self
, info_dict
, download
= True ):
991 assert info_dict
. get ( '_type' , 'video' ) == 'video'
993 if 'id' not in info_dict
:
994 raise ExtractorError ( 'Missing "id" field in extractor result' )
995 if 'title' not in info_dict
:
996 raise ExtractorError ( 'Missing "title" field in extractor result' )
998 if 'playlist' not in info_dict
:
999 # It isn't part of a playlist
1000 info_dict
[ 'playlist' ] = None
1001 info_dict
[ 'playlist_index' ] = None
1003 thumbnails
= info_dict
. get ( 'thumbnails' )
1004 if thumbnails
is None :
1005 thumbnail
= info_dict
. get ( 'thumbnail' )
1007 info_dict
[ 'thumbnails' ] = thumbnails
= [{ 'url' : thumbnail
}]
1009 thumbnails
. sort ( key
= lambda t
: (
1010 t
. get ( 'preference' ), t
. get ( 'width' ), t
. get ( 'height' ),
1011 t
. get ( 'id' ), t
. get ( 'url' )))
1012 for i
, t
in enumerate ( thumbnails
):
1013 if t
. get ( 'width' ) and t
. get ( 'height' ):
1014 t
[ 'resolution' ] = ' %dx%d ' % ( t
[ 'width' ], t
[ 'height' ])
1015 if t
. get ( 'id' ) is None :
1018 if thumbnails
and 'thumbnail' not in info_dict
:
1019 info_dict
[ 'thumbnail' ] = thumbnails
[- 1 ][ 'url' ]
1021 if 'display_id' not in info_dict
and 'id' in info_dict
:
1022 info_dict
[ 'display_id' ] = info_dict
[ 'id' ]
1024 if info_dict
. get ( 'upload_date' ) is None and info_dict
. get ( 'timestamp' ) is not None :
1025 # Working around out-of-range timestamp values (e.g. negative ones on Windows,
1026 # see http://bugs.python.org/issue1646728)
1028 upload_date
= datetime
. datetime
. utcfromtimestamp ( info_dict
[ 'timestamp' ])
1029 info_dict
[ 'upload_date' ] = upload_date
. strftime ( '%Y%m %d ' )
1030 except ( ValueError , OverflowError , OSError ):
1033 if self
. params
. get ( 'listsubtitles' , False ):
1034 if 'automatic_captions' in info_dict
:
1035 self
. list_subtitles ( info_dict
[ 'id' ], info_dict
. get ( 'automatic_captions' ), 'automatic captions' )
1036 self
. list_subtitles ( info_dict
[ 'id' ], info_dict
. get ( 'subtitles' ), 'subtitles' )
1038 info_dict
[ 'requested_subtitles' ] = self
. process_subtitles (
1039 info_dict
[ 'id' ], info_dict
. get ( 'subtitles' ),
1040 info_dict
. get ( 'automatic_captions' ))
1042 # We now pick which formats have to be downloaded
1043 if info_dict
. get ( 'formats' ) is None :
1044 # There's only one format available
1045 formats
= [ info_dict
]
1047 formats
= info_dict
[ 'formats' ]
1050 raise ExtractorError ( 'No video formats found!' )
1054 # We check that all the formats have the format and format_id fields
1055 for i
, format
in enumerate ( formats
):
1056 if 'url' not in format
:
1057 raise ExtractorError ( 'Missing "url" key in result (index %d )' % i
)
1059 if format
. get ( 'format_id' ) is None :
1060 format
[ 'format_id' ] = compat_str ( i
)
1061 format_id
= format
[ 'format_id' ]
1062 if format_id
not in formats_dict
:
1063 formats_dict
[ format_id
] = []
1064 formats_dict
[ format_id
]. append ( format
)
1066 # Make sure all formats have unique format_id
1067 for format_id
, ambiguous_formats
in formats_dict
. items ():
1068 if len ( ambiguous_formats
) > 1 :
1069 for i
, format
in enumerate ( ambiguous_formats
):
1070 format
[ 'format_id' ] = ' %s-%d ' % ( format_id
, i
)
1072 for i
, format
in enumerate ( formats
):
1073 if format
. get ( 'format' ) is None :
1074 format
[ 'format' ] = ' {id} - {res}{note} ' . format (
1075 id = format
[ 'format_id' ],
1076 res
= self
. format_resolution ( format
),
1077 note
= ' ( {0} )' . format ( format
[ 'format_note' ]) if format
. get ( 'format_note' ) is not None else '' ,
1079 # Automatically determine file extension if missing
1080 if 'ext' not in format
:
1081 format
[ 'ext' ] = determine_ext ( format
[ 'url' ]). lower ()
1082 # Add HTTP headers, so that external programs can use them from the
1084 full_format_info
= info_dict
. copy ()
1085 full_format_info
. update ( format
)
1086 format
[ 'http_headers' ] = self
._ calc
_ headers
( full_format_info
)
1088 # TODO Central sorting goes here
1090 if formats
[ 0 ] is not info_dict
:
1091 # only set the 'formats' fields if the original info_dict list them
1092 # otherwise we end up with a circular reference, the first (and unique)
1093 # element in the 'formats' field in info_dict is info_dict itself,
1094 # wich can't be exported to json
1095 info_dict
[ 'formats' ] = formats
1096 if self
. params
. get ( 'listformats' ):
1097 self
. list_formats ( info_dict
)
1099 if self
. params
. get ( 'list_thumbnails' ):
1100 self
. list_thumbnails ( info_dict
)
1103 req_format
= self
. params
. get ( 'format' )
1104 if req_format
is None :
1105 req_format_list
= []
1106 if ( self
. params
. get ( 'outtmpl' , DEFAULT_OUTTMPL
) != '-' and
1107 info_dict
[ 'extractor' ] in [ 'youtube' , 'ted' ]):
1108 merger
= FFmpegMergerPP ( self
)
1109 if merger
. available
and merger
. can_merge ():
1110 req_format_list
. append ( 'bestvideo+bestaudio' )
1111 req_format_list
. append ( 'best' )
1112 req_format
= '/' . join ( req_format_list
)
1113 formats_to_download
= []
1114 if req_format
== 'all' :
1115 formats_to_download
= formats
1117 for rfstr
in req_format
. split ( ',' ):
1118 # We can accept formats requested in the format: 34/5/best, we pick
1119 # the first that is available, starting from left
1120 req_formats
= rfstr
. split ( '/' )
1121 for rf
in req_formats
:
1122 if re
. match ( r
'.+?\+.+?' , rf
) is not None :
1123 # Two formats have been requested like '137+139'
1124 format_1
, format_2
= rf
. split ( '+' )
1125 formats_info
= ( self
. select_format ( format_1
, formats
),
1126 self
. select_format ( format_2
, formats
))
1127 if all ( formats_info
):
1128 # The first format must contain the video and the
1130 if formats_info
[ 0 ]. get ( 'vcodec' ) == 'none' :
1131 self
. report_error ( 'The first format must '
1132 'contain the video, try using '
1133 '"-f %s+%s "' % ( format_2
, format_1
))
1136 formats_info
[ 0 ][ 'ext' ]
1137 if self
. params
. get ( 'merge_output_format' ) is None
1138 else self
. params
[ 'merge_output_format' ])
1140 'requested_formats' : formats_info
,
1141 'format' : ' %s+%s ' % ( formats_info
[ 0 ]. get ( 'format' ),
1142 formats_info
[ 1 ]. get ( 'format' )),
1143 'format_id' : ' %s+%s ' % ( formats_info
[ 0 ]. get ( 'format_id' ),
1144 formats_info
[ 1 ]. get ( 'format_id' )),
1145 'width' : formats_info
[ 0 ]. get ( 'width' ),
1146 'height' : formats_info
[ 0 ]. get ( 'height' ),
1147 'resolution' : formats_info
[ 0 ]. get ( 'resolution' ),
1148 'fps' : formats_info
[ 0 ]. get ( 'fps' ),
1149 'vcodec' : formats_info
[ 0 ]. get ( 'vcodec' ),
1150 'vbr' : formats_info
[ 0 ]. get ( 'vbr' ),
1151 'stretched_ratio' : formats_info
[ 0 ]. get ( 'stretched_ratio' ),
1152 'acodec' : formats_info
[ 1 ]. get ( 'acodec' ),
1153 'abr' : formats_info
[ 1 ]. get ( 'abr' ),
1157 selected_format
= None
1159 selected_format
= self
. select_format ( rf
, formats
)
1160 if selected_format
is not None :
1161 formats_to_download
. append ( selected_format
)
1163 if not formats_to_download
:
1164 raise ExtractorError ( 'requested format not available' ,
1168 if len ( formats_to_download
) > 1 :
1169 self
. to_screen ( '[info] %s : downloading video in %s formats' % ( info_dict
[ 'id' ], len ( formats_to_download
)))
1170 for format
in formats_to_download
:
1171 new_info
= dict ( info_dict
)
1172 new_info
. update ( format
)
1173 self
. process_info ( new_info
)
1174 # We update the info dict with the best quality format (backwards compatibility)
1175 info_dict
. update ( formats_to_download
[- 1 ])
1178 def process_subtitles ( self
, video_id
, normal_subtitles
, automatic_captions
):
1179 """Select the requested subtitles and their format"""
1181 if normal_subtitles
and self
. params
. get ( 'writesubtitles' ):
1182 available_subs
. update ( normal_subtitles
)
1183 if automatic_captions
and self
. params
. get ( 'writeautomaticsub' ):
1184 for lang
, cap_info
in automatic_captions
. items ():
1185 if lang
not in available_subs
:
1186 available_subs
[ lang
] = cap_info
1188 if ( not self
. params
. get ( 'writesubtitles' ) and not
1189 self
. params
. get ( 'writeautomaticsub' ) or not
1193 if self
. params
. get ( 'allsubtitles' , False ):
1194 requested_langs
= available_subs
. keys ()
1196 if self
. params
. get ( 'subtitleslangs' , False ):
1197 requested_langs
= self
. params
. get ( 'subtitleslangs' )
1198 elif 'en' in available_subs
:
1199 requested_langs
= [ 'en' ]
1201 requested_langs
= [ list ( available_subs
. keys ())[ 0 ]]
1203 formats_query
= self
. params
. get ( 'subtitlesformat' , 'best' )
1204 formats_preference
= formats_query
. split ( '/' ) if formats_query
else []
1206 for lang
in requested_langs
:
1207 formats
= available_subs
. get ( lang
)
1209 self
. report_warning ( ' %s subtitles not available for %s ' % ( lang
, video_id
))
1211 for ext
in formats_preference
:
1215 matches
= list ( filter ( lambda f
: f
[ 'ext' ] == ext
, formats
))
1221 self
. report_warning (
1222 'No subtitle format found matching " %s " for language %s , '
1223 'using %s ' % ( formats_query
, lang
, f
[ 'ext' ]))
1227 def process_info ( self
, info_dict
):
1228 """Process a single resolved IE result."""
1230 assert info_dict
. get ( '_type' , 'video' ) == 'video'
1232 max_downloads
= self
. params
. get ( 'max_downloads' )
1233 if max_downloads
is not None :
1234 if self
._ num
_ downloads
>= int ( max_downloads
):
1235 raise MaxDownloadsReached ()
1237 info_dict
[ 'fulltitle' ] = info_dict
[ 'title' ]
1238 if len ( info_dict
[ 'title' ]) > 200 :
1239 info_dict
[ 'title' ] = info_dict
[ 'title' ][: 197 ] + '...'
1241 if 'format' not in info_dict
:
1242 info_dict
[ 'format' ] = info_dict
[ 'ext' ]
1244 reason
= self
._ match
_ entry
( info_dict
, incomplete
= False )
1245 if reason
is not None :
1246 self
. to_screen ( '[download] ' + reason
)
1249 self
._ num
_ downloads
+= 1
1251 info_dict
[ '_filename' ] = filename
= self
. prepare_filename ( info_dict
)
1254 if self
. params
. get ( 'forcetitle' , False ):
1255 self
. to_stdout ( info_dict
[ 'fulltitle' ])
1256 if self
. params
. get ( 'forceid' , False ):
1257 self
. to_stdout ( info_dict
[ 'id' ])
1258 if self
. params
. get ( 'forceurl' , False ):
1259 if info_dict
. get ( 'requested_formats' ) is not None :
1260 for f
in info_dict
[ 'requested_formats' ]:
1261 self
. to_stdout ( f
[ 'url' ] + f
. get ( 'play_path' , '' ))
1263 # For RTMP URLs, also include the playpath
1264 self
. to_stdout ( info_dict
[ 'url' ] + info_dict
. get ( 'play_path' , '' ))
1265 if self
. params
. get ( 'forcethumbnail' , False ) and info_dict
. get ( 'thumbnail' ) is not None :
1266 self
. to_stdout ( info_dict
[ 'thumbnail' ])
1267 if self
. params
. get ( 'forcedescription' , False ) and info_dict
. get ( 'description' ) is not None :
1268 self
. to_stdout ( info_dict
[ 'description' ])
1269 if self
. params
. get ( 'forcefilename' , False ) and filename
is not None :
1270 self
. to_stdout ( filename
)
1271 if self
. params
. get ( 'forceduration' , False ) and info_dict
. get ( 'duration' ) is not None :
1272 self
. to_stdout ( formatSeconds ( info_dict
[ 'duration' ]))
1273 if self
. params
. get ( 'forceformat' , False ):
1274 self
. to_stdout ( info_dict
[ 'format' ])
1275 if self
. params
. get ( 'forcejson' , False ):
1276 self
. to_stdout ( json
. dumps ( info_dict
))
1278 # Do nothing else if in simulate mode
1279 if self
. params
. get ( 'simulate' , False ):
1282 if filename
is None :
1286 dn
= os
. path
. dirname ( sanitize_path ( encodeFilename ( filename
)))
1287 if dn
and not os
. path
. exists ( dn
):
1289 except ( OSError , IOError ) as err
:
1290 self
. report_error ( 'unable to create directory ' + compat_str ( err
))
1293 if self
. params
. get ( 'writedescription' , False ):
1294 descfn
= replace_extension ( filename
, 'description' , info_dict
. get ( 'ext' ))
1295 if self
. params
. get ( 'nooverwrites' , False ) and os
. path
. exists ( encodeFilename ( descfn
)):
1296 self
. to_screen ( '[info] Video description is already present' )
1297 elif info_dict
. get ( 'description' ) is None :
1298 self
. report_warning ( 'There \' s no description to write.' )
1301 self
. to_screen ( '[info] Writing video description to: ' + descfn
)
1302 with io
. open ( encodeFilename ( descfn
), 'w' , encoding
= 'utf-8' ) as descfile
:
1303 descfile
. write ( info_dict
[ 'description' ])
1304 except ( OSError , IOError ):
1305 self
. report_error ( 'Cannot write description file ' + descfn
)
1308 if self
. params
. get ( 'writeannotations' , False ):
1309 annofn
= replace_extension ( filename
, 'annotations.xml' , info_dict
. get ( 'ext' ))
1310 if self
. params
. get ( 'nooverwrites' , False ) and os
. path
. exists ( encodeFilename ( annofn
)):
1311 self
. to_screen ( '[info] Video annotations are already present' )
1314 self
. to_screen ( '[info] Writing video annotations to: ' + annofn
)
1315 with io
. open ( encodeFilename ( annofn
), 'w' , encoding
= 'utf-8' ) as annofile
:
1316 annofile
. write ( info_dict
[ 'annotations' ])
1317 except ( KeyError , TypeError ):
1318 self
. report_warning ( 'There are no annotations to write.' )
1319 except ( OSError , IOError ):
1320 self
. report_error ( 'Cannot write annotations file: ' + annofn
)
1323 subtitles_are_requested
= any ([ self
. params
. get ( 'writesubtitles' , False ),
1324 self
. params
. get ( 'writeautomaticsub' )])
1326 if subtitles_are_requested
and info_dict
. get ( 'requested_subtitles' ):
1327 # subtitles download errors are already managed as troubles in relevant IE
1328 # that way it will silently go on when used with unsupporting IE
1329 subtitles
= info_dict
[ 'requested_subtitles' ]
1330 ie
= self
. get_info_extractor ( info_dict
[ 'extractor_key' ])
1331 for sub_lang
, sub_info
in subtitles
. items ():
1332 sub_format
= sub_info
[ 'ext' ]
1333 if sub_info
. get ( 'data' ) is not None :
1334 sub_data
= sub_info
[ 'data' ]
1337 sub_data
= ie
._ download
_ webpage
(
1338 sub_info
[ 'url' ], info_dict
[ 'id' ], note
= False )
1339 except ExtractorError
as err
:
1340 self
. report_warning ( 'Unable to download subtitle for " %s ": %s ' %
1341 ( sub_lang
, compat_str ( err
. cause
)))
1344 sub_filename
= subtitles_filename ( filename
, sub_lang
, sub_format
)
1345 if self
. params
. get ( 'nooverwrites' , False ) and os
. path
. exists ( encodeFilename ( sub_filename
)):
1346 self
. to_screen ( '[info] Video subtitle %s . %s is already_present' % ( sub_lang
, sub_format
))
1348 self
. to_screen ( '[info] Writing video subtitles to: ' + sub_filename
)
1349 with io
. open ( encodeFilename ( sub_filename
), 'w' , encoding
= 'utf-8' ) as subfile
:
1350 subfile
. write ( sub_data
)
1351 except ( OSError , IOError ):
1352 self
. report_error ( 'Cannot write subtitles file ' + sub_filename
)
1355 if self
. params
. get ( 'writeinfojson' , False ):
1356 infofn
= replace_extension ( filename
, 'info.json' , info_dict
. get ( 'ext' ))
1357 if self
. params
. get ( 'nooverwrites' , False ) and os
. path
. exists ( encodeFilename ( infofn
)):
1358 self
. to_screen ( '[info] Video description metadata is already present' )
1360 self
. to_screen ( '[info] Writing video description metadata as JSON to: ' + infofn
)
1362 write_json_file ( self
. filter_requested_info ( info_dict
), infofn
)
1363 except ( OSError , IOError ):
1364 self
. report_error ( 'Cannot write metadata to JSON file ' + infofn
)
1367 self
._ write
_ thumbnails
( info_dict
, filename
)
1369 if not self
. params
. get ( 'skip_download' , False ):
1372 fd
= get_suitable_downloader ( info
, self
. params
)( self
, self
. params
)
1373 for ph
in self
._ progress
_ hooks
:
1374 fd
. add_progress_hook ( ph
)
1375 if self
. params
. get ( 'verbose' ):
1376 self
. to_stdout ( '[debug] Invoking downloader on %r ' % info
. get ( 'url' ))
1377 return fd
. download ( name
, info
)
1379 if info_dict
. get ( 'requested_formats' ) is not None :
1382 merger
= FFmpegMergerPP ( self
)
1383 if not merger
. available
:
1385 self
. report_warning ( 'You have requested multiple '
1386 'formats but ffmpeg or avconv are not installed.'
1387 ' The formats won \' t be merged.' )
1389 postprocessors
= [ merger
]
1391 def compatible_formats ( formats
):
1392 video
, audio
= formats
1394 video_ext
, audio_ext
= audio
. get ( 'ext' ), video
. get ( 'ext' )
1395 if video_ext
and audio_ext
:
1397 ( 'mp3' , 'mp4' , 'm4a' , 'm4p' , 'm4b' , 'm4r' , 'm4v' ),
1400 for exts
in COMPATIBLE_EXTS
:
1401 if video_ext
in exts
and audio_ext
in exts
:
1403 # TODO: Check acodec/vcodec
1406 filename_real_ext
= os
. path
. splitext ( filename
)[ 1 ][ 1 :]
1408 os
. path
. splitext ( filename
)[ 0 ]
1409 if filename_real_ext
== info_dict
[ 'ext' ]
1411 requested_formats
= info_dict
[ 'requested_formats' ]
1412 if self
. params
. get ( 'merge_output_format' ) is None and not compatible_formats ( requested_formats
):
1413 info_dict
[ 'ext' ] = 'mkv'
1414 self
. report_warning (
1415 'Requested formats are incompatible for merge and will be merged into mkv.' )
1416 # Ensure filename always has a correct extension for successful merge
1417 filename
= ' %s . %s ' % ( filename_wo_ext
, info_dict
[ 'ext' ])
1418 if os
. path
. exists ( encodeFilename ( filename
)):
1420 '[download] %s has already been downloaded and '
1421 'merged' % filename
)
1423 for f
in requested_formats
:
1424 new_info
= dict ( info_dict
)
1426 fname
= self
. prepare_filename ( new_info
)
1427 fname
= prepend_extension ( fname
, 'f %s ' % f
[ 'format_id' ], new_info
[ 'ext' ])
1428 downloaded
. append ( fname
)
1429 partial_success
= dl ( fname
, new_info
)
1430 success
= success
and partial_success
1431 info_dict
[ '__postprocessors' ] = postprocessors
1432 info_dict
[ '__files_to_merge' ] = downloaded
1434 # Just a single file
1435 success
= dl ( filename
, info_dict
)
1436 except ( compat_urllib_error
. URLError
, compat_http_client
. HTTPException
, socket
. error
) as err
:
1437 self
. report_error ( 'unable to download video data: %s ' % str ( err
))
1439 except ( OSError , IOError ) as err
:
1440 raise UnavailableVideoError ( err
)
1441 except ( ContentTooShortError
, ) as err
:
1442 self
. report_error ( 'content too short (expected %s bytes and served %s )' % ( err
. expected
, err
. downloaded
))
1447 fixup_policy
= self
. params
. get ( 'fixup' )
1448 if fixup_policy
is None :
1449 fixup_policy
= 'detect_or_warn'
1451 stretched_ratio
= info_dict
. get ( 'stretched_ratio' )
1452 if stretched_ratio
is not None and stretched_ratio
!= 1 :
1453 if fixup_policy
== 'warn' :
1454 self
. report_warning ( ' %s : Non-uniform pixel ratio ( %s )' % (
1455 info_dict
[ 'id' ], stretched_ratio
))
1456 elif fixup_policy
== 'detect_or_warn' :
1457 stretched_pp
= FFmpegFixupStretchedPP ( self
)
1458 if stretched_pp
. available
:
1459 info_dict
. setdefault ( '__postprocessors' , [])
1460 info_dict
[ '__postprocessors' ]. append ( stretched_pp
)
1462 self
. report_warning (
1463 ' %s : Non-uniform pixel ratio ( %s ). Install ffmpeg or avconv to fix this automatically.' % (
1464 info_dict
[ 'id' ], stretched_ratio
))
1466 assert fixup_policy
in ( 'ignore' , 'never' )
1468 if info_dict
. get ( 'requested_formats' ) is None and info_dict
. get ( 'container' ) == 'm4a_dash' :
1469 if fixup_policy
== 'warn' :
1470 self
. report_warning ( ' %s : writing DASH m4a. Only some players support this container.' % (
1472 elif fixup_policy
== 'detect_or_warn' :
1473 fixup_pp
= FFmpegFixupM4aPP ( self
)
1474 if fixup_pp
. available
:
1475 info_dict
. setdefault ( '__postprocessors' , [])
1476 info_dict
[ '__postprocessors' ]. append ( fixup_pp
)
1478 self
. report_warning (
1479 ' %s : writing DASH m4a. Only some players support this container. Install ffmpeg or avconv to fix this automatically.' % (
1482 assert fixup_policy
in ( 'ignore' , 'never' )
1485 self
. post_process ( filename
, info_dict
)
1486 except ( PostProcessingError
) as err
:
1487 self
. report_error ( 'postprocessing: %s ' % str ( err
))
1489 self
. record_download_archive ( info_dict
)
1491 def download ( self
, url_list
):
1492 """Download a given list of URLs."""
1493 outtmpl
= self
. params
. get ( 'outtmpl' , DEFAULT_OUTTMPL
)
1494 if ( len ( url_list
) > 1 and
1495 '%' not in outtmpl
and
1496 self
. params
. get ( 'max_downloads' ) != 1 ):
1497 raise SameFileError ( outtmpl
)
1499 for url
in url_list
:
1501 # It also downloads the videos
1502 res
= self
. extract_info (
1503 url
, force_generic_extractor
= self
. params
. get ( 'force_generic_extractor' , False ))
1504 except UnavailableVideoError
:
1505 self
. report_error ( 'unable to download video' )
1506 except MaxDownloadsReached
:
1507 self
. to_screen ( '[info] Maximum number of downloaded files reached.' )
1510 if self
. params
. get ( 'dump_single_json' , False ):
1511 self
. to_stdout ( json
. dumps ( res
))
1513 return self
._ download
_ retcode
1515 def download_with_info_file ( self
, info_filename
):
1516 with contextlib
. closing ( fileinput
. FileInput (
1517 [ info_filename
], mode
= 'r' ,
1518 openhook
= fileinput
. hook_encoded ( 'utf-8' ))) as f
:
1519 # FileInput doesn't have a read method, we can't call json.load
1520 info
= self
. filter_requested_info ( json
. loads ( ' \n ' . join ( f
)))
1522 self
. process_ie_result ( info
, download
= True )
1523 except DownloadError
:
1524 webpage_url
= info
. get ( 'webpage_url' )
1525 if webpage_url
is not None :
1526 self
. report_warning ( 'The info failed to download, trying with " %s "' % webpage_url
)
1527 return self
. download ([ webpage_url
])
1530 return self
._ download
_ retcode
1533 def filter_requested_info ( info_dict
):
1535 ( k
, v
) for k
, v
in info_dict
. items ()
1536 if k
not in [ 'requested_formats' , 'requested_subtitles' ])
1538 def post_process ( self
, filename
, ie_info
):
1539 """Run all the postprocessors on the given file."""
1540 info
= dict ( ie_info
)
1541 info
[ 'filepath' ] = filename
1543 if ie_info
. get ( '__postprocessors' ) is not None :
1544 pps_chain
. extend ( ie_info
[ '__postprocessors' ])
1545 pps_chain
. extend ( self
._ pps
)
1546 for pp
in pps_chain
:
1547 files_to_delete
= []
1549 files_to_delete
, info
= pp
. run ( info
)
1550 except PostProcessingError
as e
:
1551 self
. report_error ( e
. msg
)
1552 if files_to_delete
and not self
. params
. get ( 'keepvideo' , False ):
1553 for old_filename
in files_to_delete
:
1554 self
. to_screen ( 'Deleting original file %s (pass -k to keep)' % old_filename
)
1556 os
. remove ( encodeFilename ( old_filename
))
1557 except ( IOError , OSError ):
1558 self
. report_warning ( 'Unable to remove downloaded original file' )
1560 def _make_archive_id ( self
, info_dict
):
1561 # Future-proof against any change in case
1562 # and backwards compatibility with prior versions
1563 extractor
= info_dict
. get ( 'extractor_key' )
1564 if extractor
is None :
1565 if 'id' in info_dict
:
1566 extractor
= info_dict
. get ( 'ie_key' ) # key in a playlist
1567 if extractor
is None :
1568 return None # Incomplete video information
1569 return extractor
. lower () + ' ' + info_dict
[ 'id' ]
1571 def in_download_archive ( self
, info_dict
):
1572 fn
= self
. params
. get ( 'download_archive' )
1576 vid_id
= self
._ make
_ archive
_ id
( info_dict
)
1578 return False # Incomplete video information
1581 with locked_file ( fn
, 'r' , encoding
= 'utf-8' ) as archive_file
:
1582 for line
in archive_file
:
1583 if line
. strip () == vid_id
:
1585 except IOError as ioe
:
1586 if ioe
. errno
!= errno
. ENOENT
:
1590 def record_download_archive ( self
, info_dict
):
1591 fn
= self
. params
. get ( 'download_archive' )
1594 vid_id
= self
._ make
_ archive
_ id
( info_dict
)
1596 with locked_file ( fn
, 'a' , encoding
= 'utf-8' ) as archive_file
:
1597 archive_file
. write ( vid_id
+ ' \n ' )
1600 def format_resolution ( format
, default
= 'unknown' ):
1601 if format
. get ( 'vcodec' ) == 'none' :
1603 if format
. get ( 'resolution' ) is not None :
1604 return format
[ 'resolution' ]
1605 if format
. get ( 'height' ) is not None :
1606 if format
. get ( 'width' ) is not None :
1607 res
= ' %sx%s ' % ( format
[ 'width' ], format
[ 'height' ])
1609 res
= ' %s p' % format
[ 'height' ]
1610 elif format
. get ( 'width' ) is not None :
1611 res
= '?x %d ' % format
[ 'width' ]
1616 def _format_note ( self
, fdict
):
1618 if fdict
. get ( 'ext' ) in [ 'f4f' , 'f4m' ]:
1619 res
+= '(unsupported) '
1620 if fdict
. get ( 'format_note' ) is not None :
1621 res
+= fdict
[ 'format_note' ] + ' '
1622 if fdict
. get ( 'tbr' ) is not None :
1623 res
+= '%4dk ' % fdict
[ 'tbr' ]
1624 if fdict
. get ( 'container' ) is not None :
1627 res
+= ' %s container' % fdict
[ 'container' ]
1628 if ( fdict
. get ( 'vcodec' ) is not None and
1629 fdict
. get ( 'vcodec' ) != 'none' ):
1632 res
+= fdict
[ 'vcodec' ]
1633 if fdict
. get ( 'vbr' ) is not None :
1635 elif fdict
. get ( 'vbr' ) is not None and fdict
. get ( 'abr' ) is not None :
1637 if fdict
. get ( 'vbr' ) is not None :
1638 res
+= '%4dk' % fdict
[ 'vbr' ]
1639 if fdict
. get ( 'fps' ) is not None :
1640 res
+= ', %sf ps' % fdict
[ 'fps' ]
1641 if fdict
. get ( 'acodec' ) is not None :
1644 if fdict
[ 'acodec' ] == 'none' :
1647 res
+= ' %- 5s' % fdict
[ 'acodec' ]
1648 elif fdict
. get ( 'abr' ) is not None :
1652 if fdict
. get ( 'abr' ) is not None :
1653 res
+= '@%3dk' % fdict
[ 'abr' ]
1654 if fdict
. get ( 'asr' ) is not None :
1655 res
+= ' (%5dHz)' % fdict
[ 'asr' ]
1656 if fdict
. get ( 'filesize' ) is not None :
1659 res
+= format_bytes ( fdict
[ 'filesize' ])
1660 elif fdict
. get ( 'filesize_approx' ) is not None :
1663 res
+= '~' + format_bytes ( fdict
[ 'filesize_approx' ])
1666 def list_formats ( self
, info_dict
):
1667 formats
= info_dict
. get ( 'formats' , [ info_dict
])
1669 [ f
[ 'format_id' ], f
[ 'ext' ], self
. format_resolution ( f
), self
._ format
_ note
( f
)]
1671 if f
. get ( 'preference' ) is None or f
[ 'preference' ] >= - 1000 ]
1672 if len ( formats
) > 1 :
1673 table
[- 1 ][- 1 ] += ( ' ' if table
[- 1 ][- 1 ] else '' ) + '(best)'
1675 header_line
= [ 'format code' , 'extension' , 'resolution' , 'note' ]
1677 '[info] Available formats for %s : \n %s ' %
1678 ( info_dict
[ 'id' ], render_table ( header_line
, table
)))
1680 def list_thumbnails ( self
, info_dict
):
1681 thumbnails
= info_dict
. get ( 'thumbnails' )
1683 tn_url
= info_dict
. get ( 'thumbnail' )
1685 thumbnails
= [{ 'id' : '0' , 'url' : tn_url
}]
1688 '[info] No thumbnails present for %s ' % info_dict
[ 'id' ])
1692 '[info] Thumbnails for %s :' % info_dict
[ 'id' ])
1693 self
. to_screen ( render_table (
1694 [ 'ID' , 'width' , 'height' , 'URL' ],
1695 [[ t
[ 'id' ], t
. get ( 'width' , 'unknown' ), t
. get ( 'height' , 'unknown' ), t
[ 'url' ]] for t
in thumbnails
]))
1697 def list_subtitles ( self
, video_id
, subtitles
, name
= 'subtitles' ):
1699 self
. to_screen ( ' %s has no %s ' % ( video_id
, name
))
1702 'Available %s for %s :' % ( name
, video_id
))
1703 self
. to_screen ( render_table (
1704 [ 'Language' , 'formats' ],
1705 [[ lang
, ', ' . join ( f
[ 'ext' ] for f
in reversed ( formats
))]
1706 for lang
, formats
in subtitles
. items ()]))
1708 def urlopen ( self
, req
):
1709 """ Start an HTTP download """
1711 # According to RFC 3986, URLs can not contain non-ASCII characters, however this is not
1712 # always respected by websites, some tend to give out URLs with non percent-encoded
1713 # non-ASCII characters (see telemb.py, ard.py [#3412])
1714 # urllib chokes on URLs with non-ASCII characters (see http://bugs.python.org/issue3991)
1715 # To work around aforementioned issue we will replace request's original URL with
1716 # percent-encoded one
1717 req_is_string
= isinstance ( req
, compat_basestring
)
1718 url
= req
if req_is_string
else req
. get_full_url ()
1719 url_escaped
= escape_url ( url
)
1721 # Substitute URL if any change after escaping
1722 if url
!= url_escaped
:
1726 req_type
= HEADRequest
if req
. get_method () == 'HEAD' else compat_urllib_request
. Request
1728 url_escaped
, data
= req
. data
, headers
= req
. headers
,
1729 origin_req_host
= req
. origin_req_host
, unverifiable
= req
. unverifiable
)
1731 return self
._ opener
. open ( req
, timeout
= self
._ socket
_ timeout
)
1733 def print_debug_header ( self
):
1734 if not self
. params
. get ( 'verbose' ):
1737 if type ( '' ) is not compat_str
:
1738 # Python 2.6 on SLES11 SP1 (https://github.com/rg3/youtube-dl/issues/3326)
1739 self
. report_warning (
1740 'Your Python is broken! Update to a newer and supported version' )
1742 stdout_encoding
= getattr (
1743 sys
. stdout
, 'encoding' , 'missing ( %s )' % type ( sys
. stdout
) .__ name
__ )
1745 '[debug] Encodings: locale %s , fs %s , out %s , pref %s \n ' % (
1746 locale
. getpreferredencoding (),
1747 sys
. getfilesystemencoding (),
1749 self
. get_encoding ()))
1750 write_string ( encoding_str
, encoding
= None )
1752 self
._ write
_ string
( '[debug] youtube-dl version ' + __version__
+ ' \n ' )
1754 sp
= subprocess
. Popen (
1755 [ 'git' , 'rev-parse' , '--short' , 'HEAD' ],
1756 stdout
= subprocess
. PIPE
, stderr
= subprocess
. PIPE
,
1757 cwd
= os
. path
. dirname ( os
. path
. abspath ( __file__
)))
1758 out
, err
= sp
. communicate ()
1759 out
= out
. decode (). strip ()
1760 if re
. match ( '[0-9a-f]+' , out
):
1761 self
._ write
_ string
( '[debug] Git HEAD: ' + out
+ ' \n ' )
1767 self
._ write
_ string
( '[debug] Python version %s - %s \n ' % (
1768 platform
. python_version (), platform_name ()))
1770 exe_versions
= FFmpegPostProcessor
. get_versions ( self
)
1771 exe_versions
[ 'rtmpdump' ] = rtmpdump_version ()
1772 exe_str
= ', ' . join (
1774 for exe
, v
in sorted ( exe_versions
. items ())
1779 self
._ write
_ string
( '[debug] exe versions: %s \n ' % exe_str
)
1782 for handler
in self
._ opener
. handlers
:
1783 if hasattr ( handler
, 'proxies' ):
1784 proxy_map
. update ( handler
. proxies
)
1785 self
._ write
_ string
( '[debug] Proxy map: ' + compat_str ( proxy_map
) + ' \n ' )
1787 if self
. params
. get ( 'call_home' , False ):
1788 ipaddr
= self
. urlopen ( 'https://yt-dl.org/ip' ). read (). decode ( 'utf-8' )
1789 self
._ write
_ string
( '[debug] Public IP address: %s \n ' % ipaddr
)
1790 latest_version
= self
. urlopen (
1791 'https://yt-dl.org/latest/version' ). read (). decode ( 'utf-8' )
1792 if version_tuple ( latest_version
) > version_tuple ( __version__
):
1793 self
. report_warning (
1794 'You are using an outdated version (newest version: %s )! '
1795 'See https://yt-dl.org/update if you need help updating.' %
1798 def _setup_opener ( self
):
1799 timeout_val
= self
. params
. get ( 'socket_timeout' )
1800 self
._ socket
_ timeout
= 600 if timeout_val
is None else float ( timeout_val
)
1802 opts_cookiefile
= self
. params
. get ( 'cookiefile' )
1803 opts_proxy
= self
. params
. get ( 'proxy' )
1805 if opts_cookiefile
is None :
1806 self
. cookiejar
= compat_cookiejar
. CookieJar ()
1808 self
. cookiejar
= compat_cookiejar
. MozillaCookieJar (
1810 if os
. access ( opts_cookiefile
, os
. R_OK
):
1811 self
. cookiejar
. load ()
1813 cookie_processor
= compat_urllib_request
. HTTPCookieProcessor (
1815 if opts_proxy
is not None :
1816 if opts_proxy
== '' :
1819 proxies
= { 'http' : opts_proxy
, 'https' : opts_proxy
}
1821 proxies
= compat_urllib_request
. getproxies ()
1822 # Set HTTPS proxy to HTTP one if given (https://github.com/rg3/youtube-dl/issues/805)
1823 if 'http' in proxies
and 'https' not in proxies
:
1824 proxies
[ 'https' ] = proxies
[ 'http' ]
1825 proxy_handler
= PerRequestProxyHandler ( proxies
)
1827 debuglevel
= 1 if self
. params
. get ( 'debug_printtraffic' ) else 0
1828 https_handler
= make_HTTPS_handler ( self
. params
, debuglevel
= debuglevel
)
1829 ydlh
= YoutubeDLHandler ( self
. params
, debuglevel
= debuglevel
)
1830 opener
= compat_urllib_request
. build_opener (
1831 proxy_handler
, https_handler
, cookie_processor
, ydlh
)
1833 # Delete the default user-agent header, which would otherwise apply in
1834 # cases where our custom HTTP handler doesn't come into play
1835 # (See https://github.com/rg3/youtube-dl/issues/1309 for details)
1836 opener
. addheaders
= []
1837 self
._ opener
= opener
1839 def encode ( self
, s
):
1840 if isinstance ( s
, bytes ):
1841 return s
# Already encoded
1844 return s
. encode ( self
. get_encoding ())
1845 except UnicodeEncodeError as err
:
1846 err
. reason
= err
. reason
+ '. Check your system encoding configuration or use the --encoding option.'
1849 def get_encoding ( self
):
1850 encoding
= self
. params
. get ( 'encoding' )
1851 if encoding
is None :
1852 encoding
= preferredencoding ()
1855 def _write_thumbnails ( self
, info_dict
, filename
):
1856 if self
. params
. get ( 'writethumbnail' , False ):
1857 thumbnails
= info_dict
. get ( 'thumbnails' )
1859 thumbnails
= [ thumbnails
[- 1 ]]
1860 elif self
. params
. get ( 'write_all_thumbnails' , False ):
1861 thumbnails
= info_dict
. get ( 'thumbnails' )
1866 # No thumbnails present, so return immediately
1869 for t
in thumbnails
:
1870 thumb_ext
= determine_ext ( t
[ 'url' ], 'jpg' )
1871 suffix
= '_ %s ' % t
[ 'id' ] if len ( thumbnails
) > 1 else ''
1872 thumb_display_id
= ' %s ' % t
[ 'id' ] if len ( thumbnails
) > 1 else ''
1873 t
[ 'filename' ] = thumb_filename
= os
. path
. splitext ( filename
)[ 0 ] + suffix
+ '.' + thumb_ext
1875 if self
. params
. get ( 'nooverwrites' , False ) and os
. path
. exists ( encodeFilename ( thumb_filename
)):
1876 self
. to_screen ( '[ %s ] %s : Thumbnail %sis already present' %
1877 ( info_dict
[ 'extractor' ], info_dict
[ 'id' ], thumb_display_id
))
1879 self
. to_screen ( '[ %s ] %s : Downloading thumbnail %s ...' %
1880 ( info_dict
[ 'extractor' ], info_dict
[ 'id' ], thumb_display_id
))
1882 uf
= self
. urlopen ( t
[ 'url' ])
1883 with open ( thumb_filename
, 'wb' ) as thumbf
:
1884 shutil
. copyfileobj ( uf
, thumbf
)
1885 self
. to_screen ( '[ %s ] %s : Writing thumbnail %s to: %s ' %
1886 ( info_dict
[ 'extractor' ], info_dict
[ 'id' ], thumb_display_id
, thumb_filename
))
1887 except ( compat_urllib_error
. URLError
, compat_http_client
. HTTPException
, socket
. error
) as err
:
1888 self
. report_warning ( 'Unable to download thumbnail " %s ": %s ' %
1889 ( t
[ 'url' ], compat_str ( err
)))