8 from .common import AudioConversionError, PostProcessor
12 compat_subprocess_get_DEVNULL,
23 def get_version(executable):
24 """ Returns the version of the specified executable,
25 or False if the executable is not present """
27 out, err = subprocess.Popen(
28 [executable, '-version'],
29 stdout=subprocess.PIPE, stderr=subprocess.STDOUT).communicate()
32 firstline = out.partition(b'\n')[0].decode('ascii', 'ignore')
33 m = re.search(r'version\s+([0-9._-a-zA-Z]+)', firstline)
40 class FFmpegPostProcessorError(PostProcessingError):
44 class FFmpegPostProcessor(PostProcessor):
45 def __init__(self, downloader, deletetempfiles=False):
46 PostProcessor.__init__(self, downloader)
47 self._versions = self.get_versions()
48 self._deletetempfiles = deletetempfiles
50 def check_version(self):
51 if not self._executable:
52 raise FFmpegPostProcessorError(u'ffmpeg or avconv not found. Please install one.')
54 REQUIRED_VERSION = '1.0'
55 if is_outdated_version(
56 self._versions[self._executable], REQUIRED_VERSION):
57 warning = u'Your copy of %s is outdated, update %s to version %s or newer if you encounter any errors.' % (
58 self._executable, self._executable, REQUIRED_VERSION)
59 self._downloader.report_warning(warning)
63 programs = ['avprobe', 'avconv', 'ffmpeg', 'ffprobe']
64 return dict((program, get_version(program)) for program in programs)
67 def _executable(self):
68 if self._downloader.params.get('prefer_ffmpeg', False):
69 prefs = ('ffmpeg', 'avconv')
71 prefs = ('avconv', 'ffmpeg')
77 def _uses_avconv(self):
78 return self._executable == 'avconv'
80 def run_ffmpeg_multiple_files(self, input_paths, out_path, opts):
84 for path in input_paths:
85 files_cmd.extend(['-i', encodeFilename(path, True)])
86 cmd = ([self._executable, '-y'] + files_cmd
87 + [encodeArgument(o) for o in opts] +
88 [encodeFilename(self._ffmpeg_filename_argument(out_path), True)])
90 if self._downloader.params.get('verbose', False):
91 self._downloader.to_screen(u'[debug] ffmpeg command line: %s' % shell_quote(cmd))
92 p = subprocess.Popen(cmd, stdout=subprocess.PIPE, stderr=subprocess.PIPE)
93 stdout, stderr = p.communicate()
95 stderr = stderr.decode('utf-8', 'replace')
96 msg = stderr.strip().split('\n')[-1]
97 raise FFmpegPostProcessorError(msg)
98 if self._deletetempfiles:
99 for ipath in input_paths:
102 def run_ffmpeg(self, path, out_path, opts):
103 self.run_ffmpeg_multiple_files([path], out_path, opts)
105 def _ffmpeg_filename_argument(self, fn):
106 # ffmpeg broke --, see https://ffmpeg.org/trac/ffmpeg/ticket/2127 for details
107 if fn.startswith(u'-'):
112 class FFmpegExtractAudioPP(FFmpegPostProcessor):
113 def __init__(self, downloader=None, preferredcodec=None, preferredquality=None, nopostoverwrites=False):
114 FFmpegPostProcessor.__init__(self, downloader)
115 if preferredcodec is None:
116 preferredcodec = 'best'
117 self._preferredcodec = preferredcodec
118 self._preferredquality = preferredquality
119 self._nopostoverwrites = nopostoverwrites
121 def get_audio_codec(self, path):
122 if not self._exes['ffprobe'] and not self._exes['avprobe']:
123 raise PostProcessingError(u'ffprobe or avprobe not found. Please install one.')
126 self._exes['avprobe'] or self._exes['ffprobe'],
128 encodeFilename(self._ffmpeg_filename_argument(path), True)]
129 handle = subprocess.Popen(cmd, stderr=compat_subprocess_get_DEVNULL(), stdout=subprocess.PIPE)
130 output = handle.communicate()[0]
131 if handle.wait() != 0:
133 except (IOError, OSError):
136 for line in output.decode('ascii', 'ignore').split('\n'):
137 if line.startswith('codec_name='):
138 audio_codec = line.split('=')[1].strip()
139 elif line.strip() == 'codec_type=audio' and audio_codec is not None:
143 def run_ffmpeg(self, path, out_path, codec, more_opts):
147 acodec_opts = ['-acodec', codec]
148 opts = ['-vn'] + acodec_opts + more_opts
150 FFmpegPostProcessor.run_ffmpeg(self, path, out_path, opts)
151 except FFmpegPostProcessorError as err:
152 raise AudioConversionError(err.msg)
154 def run(self, information):
155 path = information['filepath']
157 filecodec = self.get_audio_codec(path)
158 if filecodec is None:
159 raise PostProcessingError(u'WARNING: unable to obtain file audio codec with ffprobe')
161 uses_avconv = self._uses_avconv()
163 if self._preferredcodec == 'best' or self._preferredcodec == filecodec or (self._preferredcodec == 'm4a' and filecodec == 'aac'):
164 if filecodec == 'aac' and self._preferredcodec in ['m4a', 'best']:
165 # Lossless, but in another container
168 more_opts = ['-bsf:a' if uses_avconv else '-absf', 'aac_adtstoasc']
169 elif filecodec in ['aac', 'mp3', 'vorbis', 'opus']:
170 # Lossless if possible
172 extension = filecodec
173 if filecodec == 'aac':
174 more_opts = ['-f', 'adts']
175 if filecodec == 'vorbis':
179 acodec = 'libmp3lame'
182 if self._preferredquality is not None:
183 if int(self._preferredquality) < 10:
184 more_opts += ['-q:a' if uses_avconv else '-aq', self._preferredquality]
186 more_opts += ['-b:a' if uses_avconv else '-ab', self._preferredquality + 'k']
188 # We convert the audio (lossy)
189 acodec = {'mp3': 'libmp3lame', 'aac': 'aac', 'm4a': 'aac', 'opus': 'opus', 'vorbis': 'libvorbis', 'wav': None}[self._preferredcodec]
190 extension = self._preferredcodec
192 if self._preferredquality is not None:
193 # The opus codec doesn't support the -aq option
194 if int(self._preferredquality) < 10 and extension != 'opus':
195 more_opts += ['-q:a' if uses_avconv else '-aq', self._preferredquality]
197 more_opts += ['-b:a' if uses_avconv else '-ab', self._preferredquality + 'k']
198 if self._preferredcodec == 'aac':
199 more_opts += ['-f', 'adts']
200 if self._preferredcodec == 'm4a':
201 more_opts += ['-bsf:a' if uses_avconv else '-absf', 'aac_adtstoasc']
202 if self._preferredcodec == 'vorbis':
204 if self._preferredcodec == 'wav':
206 more_opts += ['-f', 'wav']
208 prefix, sep, ext = path.rpartition(u'.') # not os.path.splitext, since the latter does not work on unicode in all setups
209 new_path = prefix + sep + extension
211 # If we download foo.mp3 and convert it to... foo.mp3, then don't delete foo.mp3, silly.
213 self._nopostoverwrites = True
216 if self._nopostoverwrites and os.path.exists(encodeFilename(new_path)):
217 self._downloader.to_screen(u'[youtube] Post-process file %s exists, skipping' % new_path)
219 self._downloader.to_screen(u'[' + self._executable + '] Destination: ' + new_path)
220 self.run_ffmpeg(path, new_path, acodec, more_opts)
222 etype,e,tb = sys.exc_info()
223 if isinstance(e, AudioConversionError):
224 msg = u'audio conversion failed: ' + e.msg
226 msg = u'error running ' + self._executable
227 raise PostProcessingError(msg)
229 # Try to update the date time for extracted audio file.
230 if information.get('filetime') is not None:
232 os.utime(encodeFilename(new_path), (time.time(), information['filetime']))
234 self._downloader.report_warning(u'Cannot update utime of audio file')
236 information['filepath'] = new_path
237 return self._nopostoverwrites,information
240 class FFmpegVideoConvertor(FFmpegPostProcessor):
241 def __init__(self, downloader=None,preferedformat=None):
242 super(FFmpegVideoConvertor, self).__init__(downloader)
243 self._preferedformat=preferedformat
245 def run(self, information):
246 path = information['filepath']
247 prefix, sep, ext = path.rpartition(u'.')
248 outpath = prefix + sep + self._preferedformat
249 if information['ext'] == self._preferedformat:
250 self._downloader.to_screen(u'[ffmpeg] Not converting video file %s - already is in target format %s' % (path, self._preferedformat))
251 return True,information
252 self._downloader.to_screen(u'['+'ffmpeg'+'] Converting video from %s to %s, Destination: ' % (information['ext'], self._preferedformat) +outpath)
253 self.run_ffmpeg(path, outpath, [])
254 information['filepath'] = outpath
255 information['format'] = self._preferedformat
256 information['ext'] = self._preferedformat
257 return False,information
260 class FFmpegEmbedSubtitlePP(FFmpegPostProcessor):
261 # See http://www.loc.gov/standards/iso639-2/ISO-639-2_utf-8.txt
449 def __init__(self, downloader=None, subtitlesformat='srt'):
450 super(FFmpegEmbedSubtitlePP, self).__init__(downloader)
451 self._subformat = subtitlesformat
454 def _conver_lang_code(cls, code):
455 """Convert language code from ISO 639-1 to ISO 639-2/T"""
456 return cls._lang_map.get(code[:2])
458 def run(self, information):
459 if information['ext'] != u'mp4':
460 self._downloader.to_screen(u'[ffmpeg] Subtitles can only be embedded in mp4 files')
461 return True, information
462 if not information.get('subtitles'):
463 self._downloader.to_screen(u'[ffmpeg] There aren\'t any subtitles to embed')
464 return True, information
466 sub_langs = [key for key in information['subtitles']]
467 filename = information['filepath']
468 input_files = [filename] + [subtitles_filename(filename, lang, self._subformat) for lang in sub_langs]
470 opts = ['-map', '0:0', '-map', '0:1', '-c:v', 'copy', '-c:a', 'copy']
471 for (i, lang) in enumerate(sub_langs):
472 opts.extend(['-map', '%d:0' % (i+1), '-c:s:%d' % i, 'mov_text'])
473 lang_code = self._conver_lang_code(lang)
474 if lang_code is not None:
475 opts.extend(['-metadata:s:s:%d' % i, 'language=%s' % lang_code])
476 opts.extend(['-f', 'mp4'])
478 temp_filename = filename + u'.temp'
479 self._downloader.to_screen(u'[ffmpeg] Embedding subtitles in \'%s\'' % filename)
480 self.run_ffmpeg_multiple_files(input_files, temp_filename, opts)
481 os.remove(encodeFilename(filename))
482 os.rename(encodeFilename(temp_filename), encodeFilename(filename))
484 return True, information
487 class FFmpegMetadataPP(FFmpegPostProcessor):
490 if info.get('title') is not None:
491 metadata['title'] = info['title']
492 if info.get('upload_date') is not None:
493 metadata['date'] = info['upload_date']
494 if info.get('uploader') is not None:
495 metadata['artist'] = info['uploader']
496 elif info.get('uploader_id') is not None:
497 metadata['artist'] = info['uploader_id']
500 self._downloader.to_screen(u'[ffmpeg] There isn\'t any metadata to add')
503 filename = info['filepath']
504 temp_filename = prepend_extension(filename, 'temp')
506 if info['ext'] == u'm4a':
507 options = ['-vn', '-acodec', 'copy']
509 options = ['-c', 'copy']
511 for (name, value) in metadata.items():
512 options.extend(['-metadata', '%s=%s' % (name, value)])
514 self._downloader.to_screen(u'[ffmpeg] Adding metadata to \'%s\'' % filename)
515 self.run_ffmpeg(filename, temp_filename, options)
516 os.remove(encodeFilename(filename))
517 os.rename(encodeFilename(temp_filename), encodeFilename(filename))
521 class FFmpegMergerPP(FFmpegPostProcessor):
523 filename = info['filepath']
524 args = ['-c', 'copy', '-map', '0:v:0', '-map', '1:a:0', '-shortest']
525 self._downloader.to_screen(u'[ffmpeg] Merging formats into "%s"' % filename)
526 self.run_ffmpeg_multiple_files(info['__files_to_merge'], filename, args)
530 class FFmpegAudioFixPP(FFmpegPostProcessor):
532 filename = info['filepath']
533 temp_filename = prepend_extension(filename, 'temp')
535 options = ['-vn', '-acodec', 'copy']
536 self._downloader.to_screen(u'[ffmpeg] Fixing audio file "%s"' % filename)
537 self.run_ffmpeg(filename, temp_filename, options)
539 os.remove(encodeFilename(filename))
540 os.rename(encodeFilename(temp_filename), encodeFilename(filename))