1 from __future__ import unicode_literals
9 from .common import AudioConversionError, PostProcessor
11 from ..compat import (
12 compat_subprocess_get_DEVNULL,
26 class FFmpegPostProcessorError(PostProcessingError):
30 class FFmpegPostProcessor(PostProcessor):
31 def __init__(self, downloader=None, deletetempfiles=False):
32 PostProcessor.__init__(self, downloader)
33 self._versions = self.get_versions()
34 self._deletetempfiles = deletetempfiles
36 def check_version(self):
37 if not self._executable:
38 raise FFmpegPostProcessorError('ffmpeg or avconv not found. Please install one.')
40 required_version = '10-0' if self._uses_avconv() else '1.0'
41 if is_outdated_version(
42 self._versions[self._executable], required_version):
43 warning = 'Your copy of %s is outdated, update %s to version %s or newer if you encounter any errors.' % (
44 self._executable, self._executable, required_version)
46 self._downloader.report_warning(warning)
50 programs = ['avprobe', 'avconv', 'ffmpeg', 'ffprobe']
51 return dict((p, get_exe_version(p, args=['-version'])) for p in programs)
55 return self._executable is not None
58 def _executable(self):
59 if self._downloader.params.get('prefer_ffmpeg', False):
60 prefs = ('ffmpeg', 'avconv')
62 prefs = ('avconv', 'ffmpeg')
69 def _probe_executable(self):
70 if self._downloader.params.get('prefer_ffmpeg', False):
71 prefs = ('ffprobe', 'avprobe')
73 prefs = ('avprobe', 'ffprobe')
79 def _uses_avconv(self):
80 return self._executable == 'avconv'
82 def run_ffmpeg_multiple_files(self, input_paths, out_path, opts):
86 for path in input_paths:
87 files_cmd.extend([encodeArgument('-i'), encodeFilename(path, True)])
88 cmd = ([encodeFilename(self._executable, True), encodeArgument('-y')] +
90 + [encodeArgument(o) for o in opts] +
91 [encodeFilename(self._ffmpeg_filename_argument(out_path), True)])
93 if self._downloader.params.get('verbose', False):
94 self._downloader.to_screen('[debug] ffmpeg command line: %s' % shell_quote(cmd))
95 p = subprocess.Popen(cmd, stdout=subprocess.PIPE, stderr=subprocess.PIPE)
96 stdout, stderr = p.communicate()
98 stderr = stderr.decode('utf-8', 'replace')
99 msg = stderr.strip().split('\n')[-1]
100 raise FFmpegPostProcessorError(msg)
101 if self._deletetempfiles:
102 for ipath in input_paths:
105 def run_ffmpeg(self, path, out_path, opts):
106 self.run_ffmpeg_multiple_files([path], out_path, opts)
108 def _ffmpeg_filename_argument(self, fn):
109 # ffmpeg broke --, see https://ffmpeg.org/trac/ffmpeg/ticket/2127 for details
110 if fn.startswith('-'):
115 class FFmpegExtractAudioPP(FFmpegPostProcessor):
116 def __init__(self, downloader=None, preferredcodec=None, preferredquality=None, nopostoverwrites=False):
117 FFmpegPostProcessor.__init__(self, downloader)
118 if preferredcodec is None:
119 preferredcodec = 'best'
120 self._preferredcodec = preferredcodec
121 self._preferredquality = preferredquality
122 self._nopostoverwrites = nopostoverwrites
124 def get_audio_codec(self, path):
126 if not self._probe_executable:
127 raise PostProcessingError('ffprobe or avprobe not found. Please install one.')
130 encodeFilename(self._probe_executable, True),
131 encodeArgument('-show_streams'),
132 encodeFilename(self._ffmpeg_filename_argument(path), True)]
133 handle = subprocess.Popen(cmd, stderr=compat_subprocess_get_DEVNULL(), stdout=subprocess.PIPE)
134 output = handle.communicate()[0]
135 if handle.wait() != 0:
137 except (IOError, OSError):
140 for line in output.decode('ascii', 'ignore').split('\n'):
141 if line.startswith('codec_name='):
142 audio_codec = line.split('=')[1].strip()
143 elif line.strip() == 'codec_type=audio' and audio_codec is not None:
147 def run_ffmpeg(self, path, out_path, codec, more_opts):
151 acodec_opts = ['-acodec', codec]
152 opts = ['-vn'] + acodec_opts + more_opts
154 FFmpegPostProcessor.run_ffmpeg(self, path, out_path, opts)
155 except FFmpegPostProcessorError as err:
156 raise AudioConversionError(err.msg)
158 def run(self, information):
159 path = information['filepath']
161 filecodec = self.get_audio_codec(path)
162 if filecodec is None:
163 raise PostProcessingError('WARNING: unable to obtain file audio codec with ffprobe')
165 uses_avconv = self._uses_avconv()
167 if self._preferredcodec == 'best' or self._preferredcodec == filecodec or (self._preferredcodec == 'm4a' and filecodec == 'aac'):
168 if filecodec == 'aac' and self._preferredcodec in ['m4a', 'best']:
169 # Lossless, but in another container
172 more_opts = ['-bsf:a' if uses_avconv else '-absf', 'aac_adtstoasc']
173 elif filecodec in ['aac', 'mp3', 'vorbis', 'opus']:
174 # Lossless if possible
176 extension = filecodec
177 if filecodec == 'aac':
178 more_opts = ['-f', 'adts']
179 if filecodec == 'vorbis':
183 acodec = 'libmp3lame'
186 if self._preferredquality is not None:
187 if int(self._preferredquality) < 10:
188 more_opts += ['-q:a' if uses_avconv else '-aq', self._preferredquality]
190 more_opts += ['-b:a' if uses_avconv else '-ab', self._preferredquality + 'k']
192 # We convert the audio (lossy)
193 acodec = {'mp3': 'libmp3lame', 'aac': 'aac', 'm4a': 'aac', 'opus': 'opus', 'vorbis': 'libvorbis', 'wav': None}[self._preferredcodec]
194 extension = self._preferredcodec
196 if self._preferredquality is not None:
197 # The opus codec doesn't support the -aq option
198 if int(self._preferredquality) < 10 and extension != 'opus':
199 more_opts += ['-q:a' if uses_avconv else '-aq', self._preferredquality]
201 more_opts += ['-b:a' if uses_avconv else '-ab', self._preferredquality + 'k']
202 if self._preferredcodec == 'aac':
203 more_opts += ['-f', 'adts']
204 if self._preferredcodec == 'm4a':
205 more_opts += ['-bsf:a' if uses_avconv else '-absf', 'aac_adtstoasc']
206 if self._preferredcodec == 'vorbis':
208 if self._preferredcodec == 'wav':
210 more_opts += ['-f', 'wav']
212 prefix, sep, ext = path.rpartition('.') # not os.path.splitext, since the latter does not work on unicode in all setups
213 new_path = prefix + sep + extension
215 # If we download foo.mp3 and convert it to... foo.mp3, then don't delete foo.mp3, silly.
217 self._nopostoverwrites = True
220 if self._nopostoverwrites and os.path.exists(encodeFilename(new_path)):
221 self._downloader.to_screen('[youtube] Post-process file %s exists, skipping' % new_path)
223 self._downloader.to_screen('[' + self._executable + '] Destination: ' + new_path)
224 self.run_ffmpeg(path, new_path, acodec, more_opts)
226 etype, e, tb = sys.exc_info()
227 if isinstance(e, AudioConversionError):
228 msg = 'audio conversion failed: ' + e.msg
230 msg = 'error running ' + self._executable
231 raise PostProcessingError(msg)
233 # Try to update the date time for extracted audio file.
234 if information.get('filetime') is not None:
236 os.utime(encodeFilename(new_path), (time.time(), information['filetime']))
238 self._downloader.report_warning('Cannot update utime of audio file')
240 information['filepath'] = new_path
241 return self._nopostoverwrites, information
244 class FFmpegVideoConvertorPP(FFmpegPostProcessor):
245 def __init__(self, downloader=None, preferedformat=None):
246 super(FFmpegVideoConvertorPP, self).__init__(downloader)
247 self._preferedformat = preferedformat
249 def run(self, information):
250 path = information['filepath']
251 prefix, sep, ext = path.rpartition('.')
252 outpath = prefix + sep + self._preferedformat
253 if information['ext'] == self._preferedformat:
254 self._downloader.to_screen('[ffmpeg] Not converting video file %s - already is in target format %s' % (path, self._preferedformat))
255 return True, information
256 self._downloader.to_screen('[' + 'ffmpeg' + '] Converting video from %s to %s, Destination: ' % (information['ext'], self._preferedformat) + outpath)
257 self.run_ffmpeg(path, outpath, [])
258 information['filepath'] = outpath
259 information['format'] = self._preferedformat
260 information['ext'] = self._preferedformat
261 return False, information
264 class FFmpegEmbedSubtitlePP(FFmpegPostProcessor):
265 # See http://www.loc.gov/standards/iso639-2/ISO-639-2_utf-8.txt
453 def __init__(self, downloader=None, subtitlesformat='srt'):
454 super(FFmpegEmbedSubtitlePP, self).__init__(downloader)
455 self._subformat = subtitlesformat
458 def _conver_lang_code(cls, code):
459 """Convert language code from ISO 639-1 to ISO 639-2/T"""
460 return cls._lang_map.get(code[:2])
462 def run(self, information):
463 if information['ext'] != 'mp4':
464 self._downloader.to_screen('[ffmpeg] Subtitles can only be embedded in mp4 files')
465 return True, information
466 if not information.get('subtitles'):
467 self._downloader.to_screen('[ffmpeg] There aren\'t any subtitles to embed')
468 return True, information
470 sub_langs = [key for key in information['subtitles']]
471 filename = information['filepath']
472 input_files = [filename] + [subtitles_filename(filename, lang, self._subformat) for lang in sub_langs]
474 opts = ['-map', '0:0', '-map', '0:1', '-c:v', 'copy', '-c:a', 'copy']
475 for (i, lang) in enumerate(sub_langs):
476 opts.extend(['-map', '%d:0' % (i + 1), '-c:s:%d' % i, 'mov_text'])
477 lang_code = self._conver_lang_code(lang)
478 if lang_code is not None:
479 opts.extend(['-metadata:s:s:%d' % i, 'language=%s' % lang_code])
480 opts.extend(['-f', 'mp4'])
482 temp_filename = filename + '.temp'
483 self._downloader.to_screen('[ffmpeg] Embedding subtitles in \'%s\'' % filename)
484 self.run_ffmpeg_multiple_files(input_files, temp_filename, opts)
485 os.remove(encodeFilename(filename))
486 os.rename(encodeFilename(temp_filename), encodeFilename(filename))
488 return True, information
491 class FFmpegMetadataPP(FFmpegPostProcessor):
494 if info.get('title') is not None:
495 metadata['title'] = info['title']
496 if info.get('upload_date') is not None:
497 metadata['date'] = info['upload_date']
498 if info.get('uploader') is not None:
499 metadata['artist'] = info['uploader']
500 elif info.get('uploader_id') is not None:
501 metadata['artist'] = info['uploader_id']
504 self._downloader.to_screen('[ffmpeg] There isn\'t any metadata to add')
507 filename = info['filepath']
508 temp_filename = prepend_extension(filename, 'temp')
510 if info['ext'] == 'm4a':
511 options = ['-vn', '-acodec', 'copy']
513 options = ['-c', 'copy']
515 for (name, value) in metadata.items():
516 options.extend(['-metadata', '%s=%s' % (name, value)])
518 self._downloader.to_screen('[ffmpeg] Adding metadata to \'%s\'' % filename)
519 self.run_ffmpeg(filename, temp_filename, options)
520 os.remove(encodeFilename(filename))
521 os.rename(encodeFilename(temp_filename), encodeFilename(filename))
525 class FFmpegMergerPP(FFmpegPostProcessor):
527 filename = info['filepath']
528 args = ['-c', 'copy', '-map', '0:v:0', '-map', '1:a:0']
529 self._downloader.to_screen('[ffmpeg] Merging formats into "%s"' % filename)
530 self.run_ffmpeg_multiple_files(info['__files_to_merge'], filename, args)
534 class FFmpegAudioFixPP(FFmpegPostProcessor):
536 filename = info['filepath']
537 temp_filename = prepend_extension(filename, 'temp')
539 options = ['-vn', '-acodec', 'copy']
540 self._downloader.to_screen('[ffmpeg] Fixing audio file "%s"' % filename)
541 self.run_ffmpeg(filename, temp_filename, options)
543 os.remove(encodeFilename(filename))
544 os.rename(encodeFilename(temp_filename), encodeFilename(filename))
549 class FFmpegFixupStretchedPP(FFmpegPostProcessor):
551 stretched_ratio = info.get('stretched_ratio')
552 if stretched_ratio is None or stretched_ratio == 1:
555 filename = info['filepath']
556 temp_filename = prepend_extension(filename, 'temp')
558 options = ['-c', 'copy', '-aspect', '%f' % stretched_ratio]
559 self._downloader.to_screen('[ffmpeg] Fixing aspect ratio in "%s"' % filename)
560 self.run_ffmpeg(filename, temp_filename, options)
562 os.remove(encodeFilename(filename))
563 os.rename(encodeFilename(temp_filename), encodeFilename(filename))