1 from __future__ import unicode_literals
10 from .common import AudioConversionError, PostProcessor
12 from ..compat import (
13 compat_subprocess_get_DEVNULL,
27 class FFmpegPostProcessorError(PostProcessingError):
31 class FFmpegPostProcessor(PostProcessor):
32 def __init__(self, downloader=None, deletetempfiles=False):
33 PostProcessor.__init__(self, downloader)
34 self._deletetempfiles = deletetempfiles
35 self._determine_executables()
37 def check_version(self):
38 if not self.available:
39 raise FFmpegPostProcessorError('ffmpeg or avconv not found. Please install one.')
41 required_version = '10-0' if self.basename == 'avconv' else '1.0'
42 if is_outdated_version(
43 self._versions[self.basename], required_version):
44 warning = 'Your copy of %s is outdated, update %s to version %s or newer if you encounter any errors.' % (
45 self.basename, self.basename, required_version)
47 self._downloader.report_warning(warning)
50 def get_versions(downloader=None):
51 return FFmpegPostProcessor(downloader)._versions
53 def _determine_executables(self):
54 programs = ['avprobe', 'avconv', 'ffmpeg', 'ffprobe']
55 prefer_ffmpeg = self._downloader.params.get('prefer_ffmpeg', False)
58 self.probe_basename = None
63 location = self._downloader.params.get('ffmpeg_location')
64 if location is not None:
65 if not os.path.exists(location):
66 self._downloader.report_warning(
67 'ffmpeg-location %s does not exist! '
68 'Continuing without avconv/ffmpeg.' % (location))
71 elif not os.path.isdir(location):
72 basename = os.path.splitext(os.path.basename(location))[0]
73 if basename not in programs:
74 self._downloader.report_warning(
75 'Cannot identify executable %s, its basename should be one of %s. '
76 'Continuing without avconv/ffmpeg.' %
77 (location, ', '.join(programs)))
80 location = os.path.dirname(os.path.abspath(location))
81 if basename in ('ffmpeg', 'ffprobe'):
85 (p, os.path.join(location, p)) for p in programs)
86 self._versions = dict(
87 (p, get_exe_version(self._paths[p], args=['-version']))
89 if self._versions is None:
90 self._versions = dict(
91 (p, get_exe_version(p, args=['-version'])) for p in programs)
92 self._paths = dict((p, p) for p in programs)
95 prefs = ('ffmpeg', 'avconv')
97 prefs = ('avconv', 'ffmpeg')
104 prefs = ('ffprobe', 'avprobe')
106 prefs = ('avprobe', 'ffprobe')
108 if self._versions[p]:
109 self.probe_basename = p
114 return self.basename is not None
117 def executable(self):
118 return self._paths[self.basename]
121 def probe_executable(self):
122 return self._paths[self.probe_basename]
124 def run_ffmpeg_multiple_files(self, input_paths, out_path, opts):
128 os.stat(encodeFilename(path)).st_mtime for path in input_paths)
131 for path in input_paths:
132 files_cmd.extend([encodeArgument('-i'), encodeFilename(path, True)])
133 cmd = ([encodeFilename(self.executable, True), encodeArgument('-y')] +
135 [encodeArgument(o) for o in opts] +
136 [encodeFilename(self._ffmpeg_filename_argument(out_path), True)])
138 if self._downloader.params.get('verbose', False):
139 self._downloader.to_screen('[debug] ffmpeg command line: %s' % shell_quote(cmd))
140 p = subprocess.Popen(cmd, stdout=subprocess.PIPE, stderr=subprocess.PIPE, stdin=subprocess.PIPE)
141 stdout, stderr = p.communicate()
142 if p.returncode != 0:
143 stderr = stderr.decode('utf-8', 'replace')
144 msg = stderr.strip().split('\n')[-1]
145 raise FFmpegPostProcessorError(msg)
146 os.utime(encodeFilename(out_path), (oldest_mtime, oldest_mtime))
147 if self._deletetempfiles:
148 for ipath in input_paths:
151 def run_ffmpeg(self, path, out_path, opts):
152 self.run_ffmpeg_multiple_files([path], out_path, opts)
154 def _ffmpeg_filename_argument(self, fn):
155 # ffmpeg broke --, see https://ffmpeg.org/trac/ffmpeg/ticket/2127 for details
156 if fn.startswith('-'):
161 class FFmpegExtractAudioPP(FFmpegPostProcessor):
162 def __init__(self, downloader=None, preferredcodec=None, preferredquality=None, nopostoverwrites=False):
163 FFmpegPostProcessor.__init__(self, downloader)
164 if preferredcodec is None:
165 preferredcodec = 'best'
166 self._preferredcodec = preferredcodec
167 self._preferredquality = preferredquality
168 self._nopostoverwrites = nopostoverwrites
170 def get_audio_codec(self, path):
172 if not self.probe_executable:
173 raise PostProcessingError('ffprobe or avprobe not found. Please install one.')
176 encodeFilename(self.probe_executable, True),
177 encodeArgument('-show_streams'),
178 encodeFilename(self._ffmpeg_filename_argument(path), True)]
179 if self._downloader.params.get('verbose', False):
180 self._downloader.to_screen('[debug] %s command line: %s' % (self.basename, shell_quote(cmd)))
181 handle = subprocess.Popen(cmd, stderr=compat_subprocess_get_DEVNULL(), stdout=subprocess.PIPE, stdin=subprocess.PIPE)
182 output = handle.communicate()[0]
183 if handle.wait() != 0:
185 except (IOError, OSError):
188 for line in output.decode('ascii', 'ignore').split('\n'):
189 if line.startswith('codec_name='):
190 audio_codec = line.split('=')[1].strip()
191 elif line.strip() == 'codec_type=audio' and audio_codec is not None:
195 def run_ffmpeg(self, path, out_path, codec, more_opts):
199 acodec_opts = ['-acodec', codec]
200 opts = ['-vn'] + acodec_opts + more_opts
202 FFmpegPostProcessor.run_ffmpeg(self, path, out_path, opts)
203 except FFmpegPostProcessorError as err:
204 raise AudioConversionError(err.msg)
206 def run(self, information):
207 path = information['filepath']
209 filecodec = self.get_audio_codec(path)
210 if filecodec is None:
211 raise PostProcessingError('WARNING: unable to obtain file audio codec with ffprobe')
214 if self._preferredcodec == 'best' or self._preferredcodec == filecodec or (self._preferredcodec == 'm4a' and filecodec == 'aac'):
215 if filecodec == 'aac' and self._preferredcodec in ['m4a', 'best']:
216 # Lossless, but in another container
219 more_opts = ['-bsf:a', 'aac_adtstoasc']
220 elif filecodec in ['aac', 'mp3', 'vorbis', 'opus']:
221 # Lossless if possible
223 extension = filecodec
224 if filecodec == 'aac':
225 more_opts = ['-f', 'adts']
226 if filecodec == 'vorbis':
230 acodec = 'libmp3lame'
233 if self._preferredquality is not None:
234 if int(self._preferredquality) < 10:
235 more_opts += ['-q:a', self._preferredquality]
237 more_opts += ['-b:a', self._preferredquality + 'k']
239 # We convert the audio (lossy)
240 acodec = {'mp3': 'libmp3lame', 'aac': 'aac', 'm4a': 'aac', 'opus': 'opus', 'vorbis': 'libvorbis', 'wav': None}[self._preferredcodec]
241 extension = self._preferredcodec
243 if self._preferredquality is not None:
244 # The opus codec doesn't support the -aq option
245 if int(self._preferredquality) < 10 and extension != 'opus':
246 more_opts += ['-q:a', self._preferredquality]
248 more_opts += ['-b:a', self._preferredquality + 'k']
249 if self._preferredcodec == 'aac':
250 more_opts += ['-f', 'adts']
251 if self._preferredcodec == 'm4a':
252 more_opts += ['-bsf:a', 'aac_adtstoasc']
253 if self._preferredcodec == 'vorbis':
255 if self._preferredcodec == 'wav':
257 more_opts += ['-f', 'wav']
259 prefix, sep, ext = path.rpartition('.') # not os.path.splitext, since the latter does not work on unicode in all setups
260 new_path = prefix + sep + extension
262 # If we download foo.mp3 and convert it to... foo.mp3, then don't delete foo.mp3, silly.
264 self._nopostoverwrites = True
267 if self._nopostoverwrites and os.path.exists(encodeFilename(new_path)):
268 self._downloader.to_screen('[youtube] Post-process file %s exists, skipping' % new_path)
270 self._downloader.to_screen('[' + self.basename + '] Destination: ' + new_path)
271 self.run_ffmpeg(path, new_path, acodec, more_opts)
273 etype, e, tb = sys.exc_info()
274 if isinstance(e, AudioConversionError):
275 msg = 'audio conversion failed: ' + e.msg
277 msg = 'error running ' + self.basename
278 raise PostProcessingError(msg)
280 # Try to update the date time for extracted audio file.
281 if information.get('filetime') is not None:
283 os.utime(encodeFilename(new_path), (time.time(), information['filetime']))
285 self._downloader.report_warning('Cannot update utime of audio file')
287 information['filepath'] = new_path
288 return self._nopostoverwrites, information
291 class FFmpegVideoConvertorPP(FFmpegPostProcessor):
292 def __init__(self, downloader=None, preferedformat=None):
293 super(FFmpegVideoConvertorPP, self).__init__(downloader)
294 self._preferedformat = preferedformat
296 def run(self, information):
297 path = information['filepath']
298 prefix, sep, ext = path.rpartition('.')
299 outpath = prefix + sep + self._preferedformat
300 if information['ext'] == self._preferedformat:
301 self._downloader.to_screen('[ffmpeg] Not converting video file %s - already is in target format %s' % (path, self._preferedformat))
302 return True, information
303 self._downloader.to_screen('[' + 'ffmpeg' + '] Converting video from %s to %s, Destination: ' % (information['ext'], self._preferedformat) + outpath)
304 self.run_ffmpeg(path, outpath, [])
305 information['filepath'] = outpath
306 information['format'] = self._preferedformat
307 information['ext'] = self._preferedformat
308 return False, information
311 class FFmpegEmbedSubtitlePP(FFmpegPostProcessor):
312 # See http://www.loc.gov/standards/iso639-2/ISO-639-2_utf-8.txt
501 def _conver_lang_code(cls, code):
502 """Convert language code from ISO 639-1 to ISO 639-2/T"""
503 return cls._lang_map.get(code[:2])
505 def run(self, information):
506 if information['ext'] != 'mp4':
507 self._downloader.to_screen('[ffmpeg] Subtitles can only be embedded in mp4 files')
508 return True, information
509 subtitles = information.get('requested_subtitles')
511 self._downloader.to_screen('[ffmpeg] There aren\'t any subtitles to embed')
512 return True, information
514 sub_langs = list(subtitles.keys())
515 filename = information['filepath']
516 input_files = [filename] + [subtitles_filename(filename, lang, sub_info['ext']) for lang, sub_info in subtitles.items()]
521 # Don't copy the existing subtitles, we may be running the
522 # postprocessor a second time
526 for (i, lang) in enumerate(sub_langs):
527 opts.extend(['-map', '%d:0' % (i + 1)])
528 lang_code = self._conver_lang_code(lang)
529 if lang_code is not None:
530 opts.extend(['-metadata:s:s:%d' % i, 'language=%s' % lang_code])
532 temp_filename = prepend_extension(filename, 'temp')
533 self._downloader.to_screen('[ffmpeg] Embedding subtitles in \'%s\'' % filename)
534 self.run_ffmpeg_multiple_files(input_files, temp_filename, opts)
535 os.remove(encodeFilename(filename))
536 os.rename(encodeFilename(temp_filename), encodeFilename(filename))
538 return True, information
541 class FFmpegMetadataPP(FFmpegPostProcessor):
544 if info.get('title') is not None:
545 metadata['title'] = info['title']
546 if info.get('upload_date') is not None:
547 metadata['date'] = info['upload_date']
548 if info.get('uploader') is not None:
549 metadata['artist'] = info['uploader']
550 elif info.get('uploader_id') is not None:
551 metadata['artist'] = info['uploader_id']
552 if info.get('description') is not None:
553 metadata['description'] = info['description']
554 metadata['comment'] = info['description']
555 if info.get('webpage_url') is not None:
556 metadata['purl'] = info['webpage_url']
559 self._downloader.to_screen('[ffmpeg] There isn\'t any metadata to add')
562 filename = info['filepath']
563 temp_filename = prepend_extension(filename, 'temp')
565 if info['ext'] == 'm4a':
566 options = ['-vn', '-acodec', 'copy']
568 options = ['-c', 'copy']
570 for (name, value) in metadata.items():
571 options.extend(['-metadata', '%s=%s' % (name, value)])
573 self._downloader.to_screen('[ffmpeg] Adding metadata to \'%s\'' % filename)
574 self.run_ffmpeg(filename, temp_filename, options)
575 os.remove(encodeFilename(filename))
576 os.rename(encodeFilename(temp_filename), encodeFilename(filename))
580 class FFmpegMergerPP(FFmpegPostProcessor):
582 filename = info['filepath']
583 args = ['-c', 'copy', '-map', '0:v:0', '-map', '1:a:0']
584 self._downloader.to_screen('[ffmpeg] Merging formats into "%s"' % filename)
585 self.run_ffmpeg_multiple_files(info['__files_to_merge'], filename, args)
589 class FFmpegAudioFixPP(FFmpegPostProcessor):
591 filename = info['filepath']
592 temp_filename = prepend_extension(filename, 'temp')
594 options = ['-vn', '-acodec', 'copy']
595 self._downloader.to_screen('[ffmpeg] Fixing audio file "%s"' % filename)
596 self.run_ffmpeg(filename, temp_filename, options)
598 os.remove(encodeFilename(filename))
599 os.rename(encodeFilename(temp_filename), encodeFilename(filename))
604 class FFmpegFixupStretchedPP(FFmpegPostProcessor):
606 stretched_ratio = info.get('stretched_ratio')
607 if stretched_ratio is None or stretched_ratio == 1:
610 filename = info['filepath']
611 temp_filename = prepend_extension(filename, 'temp')
613 options = ['-c', 'copy', '-aspect', '%f' % stretched_ratio]
614 self._downloader.to_screen('[ffmpeg] Fixing aspect ratio in "%s"' % filename)
615 self.run_ffmpeg(filename, temp_filename, options)
617 os.remove(encodeFilename(filename))
618 os.rename(encodeFilename(temp_filename), encodeFilename(filename))
623 class FFmpegFixupM4aPP(FFmpegPostProcessor):
625 if info.get('container') != 'm4a_dash':
628 filename = info['filepath']
629 temp_filename = prepend_extension(filename, 'temp')
631 options = ['-c', 'copy', '-f', 'mp4']
632 self._downloader.to_screen('[ffmpeg] Correcting container in "%s"' % filename)
633 self.run_ffmpeg(filename, temp_filename, options)
635 os.remove(encodeFilename(filename))
636 os.rename(encodeFilename(temp_filename), encodeFilename(filename))
641 class FFmpegSubtitlesConvertorPP(FFmpegPostProcessor):
642 def __init__(self, downloader=None, format=None):
643 super(FFmpegSubtitlesConvertorPP, self).__init__(downloader)
647 subs = info.get('requested_subtitles')
648 filename = info['filepath']
649 new_ext = self.format
651 if new_format == 'vtt':
652 new_format = 'webvtt'
654 self._downloader.to_screen('[ffmpeg] There aren\'t any subtitles to convert')
656 self._downloader.to_screen('[ffmpeg] Converting subtitles')
657 for lang, sub in subs.items():
660 self._downloader.to_screen(
661 '[ffmpeg] Subtitle file for %s is already in the requested'
664 new_file = subtitles_filename(filename, lang, new_ext)
666 subtitles_filename(filename, lang, ext),
667 new_file, ['-f', new_format])
669 with io.open(new_file, 'rt', encoding='utf-8') as f: