7 from .common import AudioConversionError, PostProcessor
10 compat_subprocess_get_DEVNULL,
24 class FFmpegPostProcessorError(PostProcessingError):
28 class FFmpegPostProcessor(PostProcessor):
29 def __init__(self, downloader=None, deletetempfiles=False):
30 PostProcessor.__init__(self, downloader)
31 self._versions = self.get_versions()
32 self._deletetempfiles = deletetempfiles
34 def check_version(self):
35 if not self._executable:
36 raise FFmpegPostProcessorError(u'ffmpeg or avconv not found. Please install one.')
38 REQUIRED_VERSION = '1.0'
39 if is_outdated_version(
40 self._versions[self._executable], REQUIRED_VERSION):
41 warning = u'Your copy of %s is outdated, update %s to version %s or newer if you encounter any errors.' % (
42 self._executable, self._executable, REQUIRED_VERSION)
44 self._downloader.report_warning(warning)
48 programs = ['avprobe', 'avconv', 'ffmpeg', 'ffprobe']
49 return dict((p, get_exe_version(p, args=['-version'])) for p in programs)
52 def _executable(self):
53 if self._downloader.params.get('prefer_ffmpeg', False):
54 prefs = ('ffmpeg', 'avconv')
56 prefs = ('avconv', 'ffmpeg')
63 def _probe_executable(self):
64 if self._downloader.params.get('prefer_ffmpeg', False):
65 prefs = ('ffprobe', 'avprobe')
67 prefs = ('avprobe', 'ffprobe')
73 def _uses_avconv(self):
74 return self._executable == 'avconv'
76 def run_ffmpeg_multiple_files(self, input_paths, out_path, opts):
80 for path in input_paths:
81 files_cmd.extend(['-i', encodeFilename(path, True)])
82 cmd = ([self._executable, '-y'] + files_cmd
83 + [encodeArgument(o) for o in opts] +
84 [encodeFilename(self._ffmpeg_filename_argument(out_path), True)])
86 if self._downloader.params.get('verbose', False):
87 self._downloader.to_screen(u'[debug] ffmpeg command line: %s' % shell_quote(cmd))
88 p = subprocess.Popen(cmd, stdout=subprocess.PIPE, stderr=subprocess.PIPE)
89 stdout, stderr = p.communicate()
91 stderr = stderr.decode('utf-8', 'replace')
92 msg = stderr.strip().split('\n')[-1]
93 raise FFmpegPostProcessorError(msg)
94 if self._deletetempfiles:
95 for ipath in input_paths:
98 def run_ffmpeg(self, path, out_path, opts):
99 self.run_ffmpeg_multiple_files([path], out_path, opts)
101 def _ffmpeg_filename_argument(self, fn):
102 # ffmpeg broke --, see https://ffmpeg.org/trac/ffmpeg/ticket/2127 for details
103 if fn.startswith(u'-'):
108 class FFmpegExtractAudioPP(FFmpegPostProcessor):
109 def __init__(self, downloader=None, preferredcodec=None, preferredquality=None, nopostoverwrites=False):
110 FFmpegPostProcessor.__init__(self, downloader)
111 if preferredcodec is None:
112 preferredcodec = 'best'
113 self._preferredcodec = preferredcodec
114 self._preferredquality = preferredquality
115 self._nopostoverwrites = nopostoverwrites
117 def get_audio_codec(self, path):
119 if not self._probe_executable:
120 raise PostProcessingError(u'ffprobe or avprobe not found. Please install one.')
123 self._probe_executable,
125 encodeFilename(self._ffmpeg_filename_argument(path), True)]
126 handle = subprocess.Popen(cmd, stderr=compat_subprocess_get_DEVNULL(), stdout=subprocess.PIPE)
127 output = handle.communicate()[0]
128 if handle.wait() != 0:
130 except (IOError, OSError):
133 for line in output.decode('ascii', 'ignore').split('\n'):
134 if line.startswith('codec_name='):
135 audio_codec = line.split('=')[1].strip()
136 elif line.strip() == 'codec_type=audio' and audio_codec is not None:
140 def run_ffmpeg(self, path, out_path, codec, more_opts):
144 acodec_opts = ['-acodec', codec]
145 opts = ['-vn'] + acodec_opts + more_opts
147 FFmpegPostProcessor.run_ffmpeg(self, path, out_path, opts)
148 except FFmpegPostProcessorError as err:
149 raise AudioConversionError(err.msg)
151 def run(self, information):
152 path = information['filepath']
154 filecodec = self.get_audio_codec(path)
155 if filecodec is None:
156 raise PostProcessingError(u'WARNING: unable to obtain file audio codec with ffprobe')
158 uses_avconv = self._uses_avconv()
160 if self._preferredcodec == 'best' or self._preferredcodec == filecodec or (self._preferredcodec == 'm4a' and filecodec == 'aac'):
161 if filecodec == 'aac' and self._preferredcodec in ['m4a', 'best']:
162 # Lossless, but in another container
165 more_opts = ['-bsf:a' if uses_avconv else '-absf', 'aac_adtstoasc']
166 elif filecodec in ['aac', 'mp3', 'vorbis', 'opus']:
167 # Lossless if possible
169 extension = filecodec
170 if filecodec == 'aac':
171 more_opts = ['-f', 'adts']
172 if filecodec == 'vorbis':
176 acodec = 'libmp3lame'
179 if self._preferredquality is not None:
180 if int(self._preferredquality) < 10:
181 more_opts += ['-q:a' if uses_avconv else '-aq', self._preferredquality]
183 more_opts += ['-b:a' if uses_avconv else '-ab', self._preferredquality + 'k']
185 # We convert the audio (lossy)
186 acodec = {'mp3': 'libmp3lame', 'aac': 'aac', 'm4a': 'aac', 'opus': 'opus', 'vorbis': 'libvorbis', 'wav': None}[self._preferredcodec]
187 extension = self._preferredcodec
189 if self._preferredquality is not None:
190 # The opus codec doesn't support the -aq option
191 if int(self._preferredquality) < 10 and extension != 'opus':
192 more_opts += ['-q:a' if uses_avconv else '-aq', self._preferredquality]
194 more_opts += ['-b:a' if uses_avconv else '-ab', self._preferredquality + 'k']
195 if self._preferredcodec == 'aac':
196 more_opts += ['-f', 'adts']
197 if self._preferredcodec == 'm4a':
198 more_opts += ['-bsf:a' if uses_avconv else '-absf', 'aac_adtstoasc']
199 if self._preferredcodec == 'vorbis':
201 if self._preferredcodec == 'wav':
203 more_opts += ['-f', 'wav']
205 prefix, sep, ext = path.rpartition(u'.') # not os.path.splitext, since the latter does not work on unicode in all setups
206 new_path = prefix + sep + extension
208 # If we download foo.mp3 and convert it to... foo.mp3, then don't delete foo.mp3, silly.
210 self._nopostoverwrites = True
213 if self._nopostoverwrites and os.path.exists(encodeFilename(new_path)):
214 self._downloader.to_screen(u'[youtube] Post-process file %s exists, skipping' % new_path)
216 self._downloader.to_screen(u'[' + self._executable + '] Destination: ' + new_path)
217 self.run_ffmpeg(path, new_path, acodec, more_opts)
219 etype,e,tb = sys.exc_info()
220 if isinstance(e, AudioConversionError):
221 msg = u'audio conversion failed: ' + e.msg
223 msg = u'error running ' + self._executable
224 raise PostProcessingError(msg)
226 # Try to update the date time for extracted audio file.
227 if information.get('filetime') is not None:
229 os.utime(encodeFilename(new_path), (time.time(), information['filetime']))
231 self._downloader.report_warning(u'Cannot update utime of audio file')
233 information['filepath'] = new_path
234 return self._nopostoverwrites,information
237 class FFmpegVideoConvertor(FFmpegPostProcessor):
238 def __init__(self, downloader=None,preferedformat=None):
239 super(FFmpegVideoConvertor, self).__init__(downloader)
240 self._preferedformat=preferedformat
242 def run(self, information):
243 path = information['filepath']
244 prefix, sep, ext = path.rpartition(u'.')
245 outpath = prefix + sep + self._preferedformat
246 if information['ext'] == self._preferedformat:
247 self._downloader.to_screen(u'[ffmpeg] Not converting video file %s - already is in target format %s' % (path, self._preferedformat))
248 return True,information
249 self._downloader.to_screen(u'['+'ffmpeg'+'] Converting video from %s to %s, Destination: ' % (information['ext'], self._preferedformat) +outpath)
250 self.run_ffmpeg(path, outpath, [])
251 information['filepath'] = outpath
252 information['format'] = self._preferedformat
253 information['ext'] = self._preferedformat
254 return False,information
257 class FFmpegEmbedSubtitlePP(FFmpegPostProcessor):
258 # See http://www.loc.gov/standards/iso639-2/ISO-639-2_utf-8.txt
446 def __init__(self, downloader=None, subtitlesformat='srt'):
447 super(FFmpegEmbedSubtitlePP, self).__init__(downloader)
448 self._subformat = subtitlesformat
451 def _conver_lang_code(cls, code):
452 """Convert language code from ISO 639-1 to ISO 639-2/T"""
453 return cls._lang_map.get(code[:2])
455 def run(self, information):
456 if information['ext'] != u'mp4':
457 self._downloader.to_screen(u'[ffmpeg] Subtitles can only be embedded in mp4 files')
458 return True, information
459 if not information.get('subtitles'):
460 self._downloader.to_screen(u'[ffmpeg] There aren\'t any subtitles to embed')
461 return True, information
463 sub_langs = [key for key in information['subtitles']]
464 filename = information['filepath']
465 input_files = [filename] + [subtitles_filename(filename, lang, self._subformat) for lang in sub_langs]
467 opts = ['-map', '0:0', '-map', '0:1', '-c:v', 'copy', '-c:a', 'copy']
468 for (i, lang) in enumerate(sub_langs):
469 opts.extend(['-map', '%d:0' % (i+1), '-c:s:%d' % i, 'mov_text'])
470 lang_code = self._conver_lang_code(lang)
471 if lang_code is not None:
472 opts.extend(['-metadata:s:s:%d' % i, 'language=%s' % lang_code])
473 opts.extend(['-f', 'mp4'])
475 temp_filename = filename + u'.temp'
476 self._downloader.to_screen(u'[ffmpeg] Embedding subtitles in \'%s\'' % filename)
477 self.run_ffmpeg_multiple_files(input_files, temp_filename, opts)
478 os.remove(encodeFilename(filename))
479 os.rename(encodeFilename(temp_filename), encodeFilename(filename))
481 return True, information
484 class FFmpegMetadataPP(FFmpegPostProcessor):
487 if info.get('title') is not None:
488 metadata['title'] = info['title']
489 if info.get('upload_date') is not None:
490 metadata['date'] = info['upload_date']
491 if info.get('uploader') is not None:
492 metadata['artist'] = info['uploader']
493 elif info.get('uploader_id') is not None:
494 metadata['artist'] = info['uploader_id']
497 self._downloader.to_screen(u'[ffmpeg] There isn\'t any metadata to add')
500 filename = info['filepath']
501 temp_filename = prepend_extension(filename, 'temp')
503 if info['ext'] == u'm4a':
504 options = ['-vn', '-acodec', 'copy']
506 options = ['-c', 'copy']
508 for (name, value) in metadata.items():
509 options.extend(['-metadata', '%s=%s' % (name, value)])
511 self._downloader.to_screen(u'[ffmpeg] Adding metadata to \'%s\'' % filename)
512 self.run_ffmpeg(filename, temp_filename, options)
513 os.remove(encodeFilename(filename))
514 os.rename(encodeFilename(temp_filename), encodeFilename(filename))
518 class FFmpegMergerPP(FFmpegPostProcessor):
520 filename = info['filepath']
521 args = ['-c', 'copy', '-map', '0:v:0', '-map', '1:a:0', '-shortest']
522 self._downloader.to_screen(u'[ffmpeg] Merging formats into "%s"' % filename)
523 self.run_ffmpeg_multiple_files(info['__files_to_merge'], filename, args)
527 class FFmpegAudioFixPP(FFmpegPostProcessor):
529 filename = info['filepath']
530 temp_filename = prepend_extension(filename, 'temp')
532 options = ['-vn', '-acodec', 'copy']
533 self._downloader.to_screen(u'[ffmpeg] Fixing audio file "%s"' % filename)
534 self.run_ffmpeg(filename, temp_filename, options)
536 os.remove(encodeFilename(filename))
537 os.rename(encodeFilename(temp_filename), encodeFilename(filename))