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._deletetempfiles = deletetempfiles
34 self._determine_executables()
36 def check_version(self):
37 if not self.available:
38 raise FFmpegPostProcessorError('ffmpeg or avconv not found. Please install one.')
40 required_version = '10-0' if self.basename == 'avconv' else '1.0'
41 if is_outdated_version(
42 self._versions[self.basename], required_version):
43 warning = 'Your copy of %s is outdated, update %s to version %s or newer if you encounter any errors.' % (
44 self.basename, self.basename, required_version)
46 self._downloader.report_warning(warning)
49 def get_versions(downloader=None):
50 return FFmpegPostProcessor(downloader)._versions
52 def _determine_executables(self):
53 programs = ['avprobe', 'avconv', 'ffmpeg', 'ffprobe']
54 prefer_ffmpeg = self._downloader.params.get('prefer_ffmpeg', False)
57 self.probe_basename = None
62 location = self._downloader.params.get('ffmpeg_location')
63 if location is not None:
64 if not os.path.exists(location):
65 self._downloader.report_warning(
66 'ffmpeg-location %s does not exist! '
67 'Continuing without avconv/ffmpeg.' % (location))
70 elif not os.path.isdir(location):
71 basename = os.path.splitext(os.path.basename(location))[0]
72 if basename not in programs:
73 self._downloader.report_warning(
74 'Cannot identify executable %s, its basename should be one of %s. '
75 'Continuing without avconv/ffmpeg.' %
76 (location, ', '.join(programs)))
79 location = os.path.dirname(os.path.abspath(location))
80 if basename in ('ffmpeg', 'ffprobe'):
84 (p, os.path.join(location, p)) for p in programs)
85 self._versions = dict(
86 (p, get_exe_version(self._paths[p], args=['-version']))
88 if self._versions is None:
89 self._versions = dict(
90 (p, get_exe_version(p, args=['-version'])) for p in programs)
91 self._paths = dict((p, p) for p in programs)
94 prefs = ('ffmpeg', 'avconv')
96 prefs = ('avconv', 'ffmpeg')
103 prefs = ('ffprobe', 'avprobe')
105 prefs = ('avprobe', 'ffprobe')
107 if self._versions[p]:
108 self.probe_basename = p
113 return self.basename is not None
116 def executable(self):
117 return self._paths[self.basename]
120 def probe_available(self):
121 return self.probe_basename is not None
124 def probe_executable(self):
125 return self._paths[self.probe_basename]
127 def run_ffmpeg_multiple_files(self, input_paths, out_path, opts):
131 os.stat(encodeFilename(path)).st_mtime for path in input_paths)
134 for path in input_paths:
135 files_cmd.extend([encodeArgument('-i'), encodeFilename(path, True)])
136 cmd = ([encodeFilename(self.executable, True), encodeArgument('-y')] +
138 [encodeArgument(o) for o in opts] +
139 [encodeFilename(self._ffmpeg_filename_argument(out_path), True)])
141 if self._downloader.params.get('verbose', False):
142 self._downloader.to_screen('[debug] ffmpeg command line: %s' % shell_quote(cmd))
143 p = subprocess.Popen(cmd, stdout=subprocess.PIPE, stderr=subprocess.PIPE, stdin=subprocess.PIPE)
144 stdout, stderr = p.communicate()
145 if p.returncode != 0:
146 stderr = stderr.decode('utf-8', 'replace')
147 msg = stderr.strip().split('\n')[-1]
148 raise FFmpegPostProcessorError(msg)
150 os.utime(encodeFilename(out_path), (oldest_mtime, oldest_mtime))
152 self._downloader.report_warning('Cannot update utime of file')
154 if self._deletetempfiles:
155 for ipath in input_paths:
158 def run_ffmpeg(self, path, out_path, opts):
159 self.run_ffmpeg_multiple_files([path], out_path, opts)
161 def _ffmpeg_filename_argument(self, fn):
162 # ffmpeg broke --, see https://ffmpeg.org/trac/ffmpeg/ticket/2127 for details
163 if fn.startswith('-'):
168 class FFmpegExtractAudioPP(FFmpegPostProcessor):
169 def __init__(self, downloader=None, preferredcodec=None, preferredquality=None, nopostoverwrites=False):
170 FFmpegPostProcessor.__init__(self, downloader)
171 if preferredcodec is None:
172 preferredcodec = 'best'
173 self._preferredcodec = preferredcodec
174 self._preferredquality = preferredquality
175 self._nopostoverwrites = nopostoverwrites
177 def get_audio_codec(self, path):
179 if not self.probe_available:
180 raise PostProcessingError('ffprobe or avprobe not found. Please install one.')
183 encodeFilename(self.probe_executable, True),
184 encodeArgument('-show_streams'),
185 encodeFilename(self._ffmpeg_filename_argument(path), True)]
186 if self._downloader.params.get('verbose', False):
187 self._downloader.to_screen('[debug] %s command line: %s' % (self.basename, shell_quote(cmd)))
188 handle = subprocess.Popen(cmd, stderr=compat_subprocess_get_DEVNULL(), stdout=subprocess.PIPE, stdin=subprocess.PIPE)
189 output = handle.communicate()[0]
190 if handle.wait() != 0:
192 except (IOError, OSError):
195 for line in output.decode('ascii', 'ignore').split('\n'):
196 if line.startswith('codec_name='):
197 audio_codec = line.split('=')[1].strip()
198 elif line.strip() == 'codec_type=audio' and audio_codec is not None:
202 def run_ffmpeg(self, path, out_path, codec, more_opts):
206 acodec_opts = ['-acodec', codec]
207 opts = ['-vn'] + acodec_opts + more_opts
209 FFmpegPostProcessor.run_ffmpeg(self, path, out_path, opts)
210 except FFmpegPostProcessorError as err:
211 raise AudioConversionError(err.msg)
213 def run(self, information):
214 path = information['filepath']
216 filecodec = self.get_audio_codec(path)
217 if filecodec is None:
218 raise PostProcessingError('WARNING: unable to obtain file audio codec with ffprobe')
221 if self._preferredcodec == 'best' or self._preferredcodec == filecodec or (self._preferredcodec == 'm4a' and filecodec == 'aac'):
222 if filecodec == 'aac' and self._preferredcodec in ['m4a', 'best']:
223 # Lossless, but in another container
226 more_opts = ['-bsf:a', 'aac_adtstoasc']
227 elif filecodec in ['aac', 'mp3', 'vorbis', 'opus']:
228 # Lossless if possible
230 extension = filecodec
231 if filecodec == 'aac':
232 more_opts = ['-f', 'adts']
233 if filecodec == 'vorbis':
237 acodec = 'libmp3lame'
240 if self._preferredquality is not None:
241 if int(self._preferredquality) < 10:
242 more_opts += ['-q:a', self._preferredquality]
244 more_opts += ['-b:a', self._preferredquality + 'k']
246 # We convert the audio (lossy)
247 acodec = {'mp3': 'libmp3lame', 'aac': 'aac', 'm4a': 'aac', 'opus': 'opus', 'vorbis': 'libvorbis', 'wav': None}[self._preferredcodec]
248 extension = self._preferredcodec
250 if self._preferredquality is not None:
251 # The opus codec doesn't support the -aq option
252 if int(self._preferredquality) < 10 and extension != 'opus':
253 more_opts += ['-q:a', self._preferredquality]
255 more_opts += ['-b:a', self._preferredquality + 'k']
256 if self._preferredcodec == 'aac':
257 more_opts += ['-f', 'adts']
258 if self._preferredcodec == 'm4a':
259 more_opts += ['-bsf:a', 'aac_adtstoasc']
260 if self._preferredcodec == 'vorbis':
262 if self._preferredcodec == 'wav':
264 more_opts += ['-f', 'wav']
266 prefix, sep, ext = path.rpartition('.') # not os.path.splitext, since the latter does not work on unicode in all setups
267 new_path = prefix + sep + extension
269 # If we download foo.mp3 and convert it to... foo.mp3, then don't delete foo.mp3, silly.
271 self._nopostoverwrites = True
274 if self._nopostoverwrites and os.path.exists(encodeFilename(new_path)):
275 self._downloader.to_screen('[youtube] Post-process file %s exists, skipping' % new_path)
277 self._downloader.to_screen('[' + self.basename + '] Destination: ' + new_path)
278 self.run_ffmpeg(path, new_path, acodec, more_opts)
279 except AudioConversionError as e:
280 raise PostProcessingError(
281 'audio conversion failed: ' + e.msg)
283 raise PostProcessingError('error running ' + self.basename)
285 # Try to update the date time for extracted audio file.
286 if information.get('filetime') is not None:
288 os.utime(encodeFilename(new_path), (time.time(), information['filetime']))
290 self._downloader.report_warning('Cannot update utime of audio file')
292 information['filepath'] = new_path
293 return self._nopostoverwrites, information
296 class FFmpegVideoConvertorPP(FFmpegPostProcessor):
297 def __init__(self, downloader=None, preferedformat=None):
298 super(FFmpegVideoConvertorPP, self).__init__(downloader)
299 self._preferedformat = preferedformat
301 def run(self, information):
302 path = information['filepath']
303 prefix, sep, ext = path.rpartition('.')
304 outpath = prefix + sep + self._preferedformat
305 if information['ext'] == self._preferedformat:
306 self._downloader.to_screen('[ffmpeg] Not converting video file %s - already is in target format %s' % (path, self._preferedformat))
307 return True, information
308 self._downloader.to_screen('[' + 'ffmpeg' + '] Converting video from %s to %s, Destination: ' % (information['ext'], self._preferedformat) + outpath)
309 self.run_ffmpeg(path, outpath, [])
310 information['filepath'] = outpath
311 information['format'] = self._preferedformat
312 information['ext'] = self._preferedformat
313 return False, information
316 class FFmpegEmbedSubtitlePP(FFmpegPostProcessor):
317 # See http://www.loc.gov/standards/iso639-2/ISO-639-2_utf-8.txt
506 def _conver_lang_code(cls, code):
507 """Convert language code from ISO 639-1 to ISO 639-2/T"""
508 return cls._lang_map.get(code[:2])
510 def run(self, information):
511 if information['ext'] != 'mp4':
512 self._downloader.to_screen('[ffmpeg] Subtitles can only be embedded in mp4 files')
513 return True, information
514 subtitles = information.get('requested_subtitles')
516 self._downloader.to_screen('[ffmpeg] There aren\'t any subtitles to embed')
517 return True, information
519 sub_langs = list(subtitles.keys())
520 filename = information['filepath']
521 input_files = [filename] + [subtitles_filename(filename, lang, sub_info['ext']) for lang, sub_info in subtitles.items()]
526 # Don't copy the existing subtitles, we may be running the
527 # postprocessor a second time
531 for (i, lang) in enumerate(sub_langs):
532 opts.extend(['-map', '%d:0' % (i + 1)])
533 lang_code = self._conver_lang_code(lang)
534 if lang_code is not None:
535 opts.extend(['-metadata:s:s:%d' % i, 'language=%s' % lang_code])
537 temp_filename = prepend_extension(filename, 'temp')
538 self._downloader.to_screen('[ffmpeg] Embedding subtitles in \'%s\'' % filename)
539 self.run_ffmpeg_multiple_files(input_files, temp_filename, opts)
540 os.remove(encodeFilename(filename))
541 os.rename(encodeFilename(temp_filename), encodeFilename(filename))
543 return True, information
546 class FFmpegMetadataPP(FFmpegPostProcessor):
549 if info.get('title') is not None:
550 metadata['title'] = info['title']
551 if info.get('upload_date') is not None:
552 metadata['date'] = info['upload_date']
553 if info.get('artist') is not None:
554 metadata['artist'] = info['artist']
555 elif info.get('uploader') is not None:
556 metadata['artist'] = info['uploader']
557 elif info.get('uploader_id') is not None:
558 metadata['artist'] = info['uploader_id']
559 if info.get('description') is not None:
560 metadata['description'] = info['description']
561 metadata['comment'] = info['description']
562 if info.get('webpage_url') is not None:
563 metadata['purl'] = info['webpage_url']
564 if info.get('album') is not None:
565 metadata['album'] = info['album']
568 self._downloader.to_screen('[ffmpeg] There isn\'t any metadata to add')
571 filename = info['filepath']
572 temp_filename = prepend_extension(filename, 'temp')
574 if info['ext'] == 'm4a':
575 options = ['-vn', '-acodec', 'copy']
577 options = ['-c', 'copy']
579 for (name, value) in metadata.items():
580 options.extend(['-metadata', '%s=%s' % (name, value)])
582 self._downloader.to_screen('[ffmpeg] Adding metadata to \'%s\'' % filename)
583 self.run_ffmpeg(filename, temp_filename, options)
584 os.remove(encodeFilename(filename))
585 os.rename(encodeFilename(temp_filename), encodeFilename(filename))
589 class FFmpegMergerPP(FFmpegPostProcessor):
591 filename = info['filepath']
592 args = ['-c', 'copy', '-map', '0:v:0', '-map', '1:a:0']
593 self._downloader.to_screen('[ffmpeg] Merging formats into "%s"' % filename)
594 self.run_ffmpeg_multiple_files(info['__files_to_merge'], filename, args)
598 class FFmpegAudioFixPP(FFmpegPostProcessor):
600 filename = info['filepath']
601 temp_filename = prepend_extension(filename, 'temp')
603 options = ['-vn', '-acodec', 'copy']
604 self._downloader.to_screen('[ffmpeg] Fixing audio file "%s"' % filename)
605 self.run_ffmpeg(filename, temp_filename, options)
607 os.remove(encodeFilename(filename))
608 os.rename(encodeFilename(temp_filename), encodeFilename(filename))
613 class FFmpegFixupStretchedPP(FFmpegPostProcessor):
615 stretched_ratio = info.get('stretched_ratio')
616 if stretched_ratio is None or stretched_ratio == 1:
619 filename = info['filepath']
620 temp_filename = prepend_extension(filename, 'temp')
622 options = ['-c', 'copy', '-aspect', '%f' % stretched_ratio]
623 self._downloader.to_screen('[ffmpeg] Fixing aspect ratio in "%s"' % filename)
624 self.run_ffmpeg(filename, temp_filename, options)
626 os.remove(encodeFilename(filename))
627 os.rename(encodeFilename(temp_filename), encodeFilename(filename))
632 class FFmpegFixupM4aPP(FFmpegPostProcessor):
634 if info.get('container') != 'm4a_dash':
637 filename = info['filepath']
638 temp_filename = prepend_extension(filename, 'temp')
640 options = ['-c', 'copy', '-f', 'mp4']
641 self._downloader.to_screen('[ffmpeg] Correcting container in "%s"' % filename)
642 self.run_ffmpeg(filename, temp_filename, options)
644 os.remove(encodeFilename(filename))
645 os.rename(encodeFilename(temp_filename), encodeFilename(filename))
650 class FFmpegSubtitlesConvertorPP(FFmpegPostProcessor):
651 def __init__(self, downloader=None, format=None):
652 super(FFmpegSubtitlesConvertorPP, self).__init__(downloader)
656 subs = info.get('requested_subtitles')
657 filename = info['filepath']
658 new_ext = self.format
660 if new_format == 'vtt':
661 new_format = 'webvtt'
663 self._downloader.to_screen('[ffmpeg] There aren\'t any subtitles to convert')
665 self._downloader.to_screen('[ffmpeg] Converting subtitles')
666 for lang, sub in subs.items():
669 self._downloader.to_screen(
670 '[ffmpeg] Subtitle file for %s is already in the requested'
673 new_file = subtitles_filename(filename, lang, new_ext)
675 subtitles_filename(filename, lang, ext),
676 new_file, ['-f', new_format])
678 with io.open(new_file, 'rt', encoding='utf-8') as f: