8 from .common import AudioConversionError, PostProcessor
12 compat_subprocess_get_DEVNULL,
22 def get_version(executable):
23 """ Returns the version of the specified executable,
24 or False if the executable is not present """
26 out, err = subprocess.Popen(
27 [executable, '-version'],
28 stdout=subprocess.PIPE, stderr=subprocess.PIPE).communicate()
31 firstline = out.partition(b'\n')[0].decode('ascii', 'ignore')
32 m = re.search(r'version\s+([0-9._-a-zA-Z]+)', firstline)
39 class FFmpegPostProcessorError(PostProcessingError):
43 class FFmpegPostProcessor(PostProcessor):
44 def __init__(self, downloader=None, deletetempfiles=False):
45 PostProcessor.__init__(self, downloader)
46 self._versions = self.get_versions()
47 self._deletetempfiles = deletetempfiles
51 programs = ['avprobe', 'avconv', 'ffmpeg', 'ffprobe']
52 return dict((program, get_version(program)) for program in programs)
54 def _get_executable(self):
55 if self._downloader.params.get('prefer_ffmpeg', False):
56 prefs = ('ffmpeg', 'avconv')
58 prefs = ('avconv', 'ffmpeg')
64 def _uses_avconv(self):
65 return self._get_executable() == 'avconv'
67 def run_ffmpeg_multiple_files(self, input_paths, out_path, opts):
68 if not self._get_executable():
69 raise FFmpegPostProcessorError(u'ffmpeg or avconv not found. Please install one.')
72 for path in input_paths:
73 files_cmd.extend(['-i', encodeFilename(path, True)])
74 cmd = ([self._get_executable(), '-y'] + files_cmd
75 + [encodeArgument(o) for o in opts] +
76 [encodeFilename(self._ffmpeg_filename_argument(out_path), True)])
78 if self._downloader.params.get('verbose', False):
79 self._downloader.to_screen(u'[debug] ffmpeg command line: %s' % shell_quote(cmd))
80 p = subprocess.Popen(cmd, stdout=subprocess.PIPE, stderr=subprocess.PIPE)
81 stdout, stderr = p.communicate()
83 stderr = stderr.decode('utf-8', 'replace')
84 msg = stderr.strip().split('\n')[-1]
85 raise FFmpegPostProcessorError(msg)
86 if self._deletetempfiles:
87 for ipath in input_paths:
90 def run_ffmpeg(self, path, out_path, opts):
91 self.run_ffmpeg_multiple_files([path], out_path, opts)
93 def _ffmpeg_filename_argument(self, fn):
94 # ffmpeg broke --, see https://ffmpeg.org/trac/ffmpeg/ticket/2127 for details
95 if fn.startswith(u'-'):
100 class FFmpegExtractAudioPP(FFmpegPostProcessor):
101 def __init__(self, downloader=None, preferredcodec=None, preferredquality=None, nopostoverwrites=False):
102 FFmpegPostProcessor.__init__(self, downloader)
103 if preferredcodec is None:
104 preferredcodec = 'best'
105 self._preferredcodec = preferredcodec
106 self._preferredquality = preferredquality
107 self._nopostoverwrites = nopostoverwrites
109 def get_audio_codec(self, path):
110 if not self._exes['ffprobe'] and not self._exes['avprobe']:
111 raise PostProcessingError(u'ffprobe or avprobe not found. Please install one.')
114 self._exes['avprobe'] or self._exes['ffprobe'],
116 encodeFilename(self._ffmpeg_filename_argument(path), True)]
117 handle = subprocess.Popen(cmd, stderr=compat_subprocess_get_DEVNULL(), stdout=subprocess.PIPE)
118 output = handle.communicate()[0]
119 if handle.wait() != 0:
121 except (IOError, OSError):
124 for line in output.decode('ascii', 'ignore').split('\n'):
125 if line.startswith('codec_name='):
126 audio_codec = line.split('=')[1].strip()
127 elif line.strip() == 'codec_type=audio' and audio_codec is not None:
131 def run_ffmpeg(self, path, out_path, codec, more_opts):
135 acodec_opts = ['-acodec', codec]
136 opts = ['-vn'] + acodec_opts + more_opts
138 FFmpegPostProcessor.run_ffmpeg(self, path, out_path, opts)
139 except FFmpegPostProcessorError as err:
140 raise AudioConversionError(err.msg)
142 def run(self, information):
143 path = information['filepath']
145 filecodec = self.get_audio_codec(path)
146 if filecodec is None:
147 raise PostProcessingError(u'WARNING: unable to obtain file audio codec with ffprobe')
149 uses_avconv = self._uses_avconv()
151 if self._preferredcodec == 'best' or self._preferredcodec == filecodec or (self._preferredcodec == 'm4a' and filecodec == 'aac'):
152 if filecodec == 'aac' and self._preferredcodec in ['m4a', 'best']:
153 # Lossless, but in another container
156 more_opts = ['-bsf:a' if uses_avconv else '-absf', 'aac_adtstoasc']
157 elif filecodec in ['aac', 'mp3', 'vorbis', 'opus']:
158 # Lossless if possible
160 extension = filecodec
161 if filecodec == 'aac':
162 more_opts = ['-f', 'adts']
163 if filecodec == 'vorbis':
167 acodec = 'libmp3lame'
170 if self._preferredquality is not None:
171 if int(self._preferredquality) < 10:
172 more_opts += ['-q:a' if uses_avconv else '-aq', self._preferredquality]
174 more_opts += ['-b:a' if uses_avconv else '-ab', self._preferredquality + 'k']
176 # We convert the audio (lossy)
177 acodec = {'mp3': 'libmp3lame', 'aac': 'aac', 'm4a': 'aac', 'opus': 'opus', 'vorbis': 'libvorbis', 'wav': None}[self._preferredcodec]
178 extension = self._preferredcodec
180 if self._preferredquality is not None:
181 # The opus codec doesn't support the -aq option
182 if int(self._preferredquality) < 10 and extension != 'opus':
183 more_opts += ['-q:a' if uses_avconv else '-aq', self._preferredquality]
185 more_opts += ['-b:a' if uses_avconv else '-ab', self._preferredquality + 'k']
186 if self._preferredcodec == 'aac':
187 more_opts += ['-f', 'adts']
188 if self._preferredcodec == 'm4a':
189 more_opts += ['-bsf:a' if uses_avconv else '-absf', 'aac_adtstoasc']
190 if self._preferredcodec == 'vorbis':
192 if self._preferredcodec == 'wav':
194 more_opts += ['-f', 'wav']
196 prefix, sep, ext = path.rpartition(u'.') # not os.path.splitext, since the latter does not work on unicode in all setups
197 new_path = prefix + sep + extension
199 # If we download foo.mp3 and convert it to... foo.mp3, then don't delete foo.mp3, silly.
201 self._nopostoverwrites = True
204 if self._nopostoverwrites and os.path.exists(encodeFilename(new_path)):
205 self._downloader.to_screen(u'[youtube] Post-process file %s exists, skipping' % new_path)
207 self._downloader.to_screen(u'[' + self._get_executable() + '] Destination: ' + new_path)
208 self.run_ffmpeg(path, new_path, acodec, more_opts)
210 etype,e,tb = sys.exc_info()
211 if isinstance(e, AudioConversionError):
212 msg = u'audio conversion failed: ' + e.msg
214 msg = u'error running ' + self._get_executable()
215 raise PostProcessingError(msg)
217 # Try to update the date time for extracted audio file.
218 if information.get('filetime') is not None:
220 os.utime(encodeFilename(new_path), (time.time(), information['filetime']))
222 self._downloader.report_warning(u'Cannot update utime of audio file')
224 information['filepath'] = new_path
225 return self._nopostoverwrites,information
228 class FFmpegVideoConvertor(FFmpegPostProcessor):
229 def __init__(self, downloader=None,preferedformat=None):
230 super(FFmpegVideoConvertor, self).__init__(downloader)
231 self._preferedformat=preferedformat
233 def run(self, information):
234 path = information['filepath']
235 prefix, sep, ext = path.rpartition(u'.')
236 outpath = prefix + sep + self._preferedformat
237 if information['ext'] == self._preferedformat:
238 self._downloader.to_screen(u'[ffmpeg] Not converting video file %s - already is in target format %s' % (path, self._preferedformat))
239 return True,information
240 self._downloader.to_screen(u'['+'ffmpeg'+'] Converting video from %s to %s, Destination: ' % (information['ext'], self._preferedformat) +outpath)
241 self.run_ffmpeg(path, outpath, [])
242 information['filepath'] = outpath
243 information['format'] = self._preferedformat
244 information['ext'] = self._preferedformat
245 return False,information
248 class FFmpegEmbedSubtitlePP(FFmpegPostProcessor):
249 # See http://www.loc.gov/standards/iso639-2/ISO-639-2_utf-8.txt
437 def __init__(self, downloader=None, subtitlesformat='srt'):
438 super(FFmpegEmbedSubtitlePP, self).__init__(downloader)
439 self._subformat = subtitlesformat
442 def _conver_lang_code(cls, code):
443 """Convert language code from ISO 639-1 to ISO 639-2/T"""
444 return cls._lang_map.get(code[:2])
446 def run(self, information):
447 if information['ext'] != u'mp4':
448 self._downloader.to_screen(u'[ffmpeg] Subtitles can only be embedded in mp4 files')
449 return True, information
450 if not information.get('subtitles'):
451 self._downloader.to_screen(u'[ffmpeg] There aren\'t any subtitles to embed')
452 return True, information
454 sub_langs = [key for key in information['subtitles']]
455 filename = information['filepath']
456 input_files = [filename] + [subtitles_filename(filename, lang, self._subformat) for lang in sub_langs]
458 opts = ['-map', '0:0', '-map', '0:1', '-c:v', 'copy', '-c:a', 'copy']
459 for (i, lang) in enumerate(sub_langs):
460 opts.extend(['-map', '%d:0' % (i+1), '-c:s:%d' % i, 'mov_text'])
461 lang_code = self._conver_lang_code(lang)
462 if lang_code is not None:
463 opts.extend(['-metadata:s:s:%d' % i, 'language=%s' % lang_code])
464 opts.extend(['-f', 'mp4'])
466 temp_filename = filename + u'.temp'
467 self._downloader.to_screen(u'[ffmpeg] Embedding subtitles in \'%s\'' % filename)
468 self.run_ffmpeg_multiple_files(input_files, temp_filename, opts)
469 os.remove(encodeFilename(filename))
470 os.rename(encodeFilename(temp_filename), encodeFilename(filename))
472 return True, information
475 class FFmpegMetadataPP(FFmpegPostProcessor):
478 if info.get('title') is not None:
479 metadata['title'] = info['title']
480 if info.get('upload_date') is not None:
481 metadata['date'] = info['upload_date']
482 if info.get('uploader') is not None:
483 metadata['artist'] = info['uploader']
484 elif info.get('uploader_id') is not None:
485 metadata['artist'] = info['uploader_id']
488 self._downloader.to_screen(u'[ffmpeg] There isn\'t any metadata to add')
491 filename = info['filepath']
492 temp_filename = prepend_extension(filename, 'temp')
494 if info['ext'] == u'm4a':
495 options = ['-vn', '-acodec', 'copy']
497 options = ['-c', 'copy']
499 for (name, value) in metadata.items():
500 options.extend(['-metadata', '%s=%s' % (name, value)])
502 self._downloader.to_screen(u'[ffmpeg] Adding metadata to \'%s\'' % filename)
503 self.run_ffmpeg(filename, temp_filename, options)
504 os.remove(encodeFilename(filename))
505 os.rename(encodeFilename(temp_filename), encodeFilename(filename))
509 class FFmpegMergerPP(FFmpegPostProcessor):
511 filename = info['filepath']
512 args = ['-c', 'copy', '-map', '0:v:0', '-map', '1:a:0', '-shortest']
513 self._downloader.to_screen(u'[ffmpeg] Merging formats into "%s"' % filename)
514 self.run_ffmpeg_multiple_files(info['__files_to_merge'], filename, args)
518 class FFmpegAudioFixPP(FFmpegPostProcessor):
520 filename = info['filepath']
521 temp_filename = prepend_extension(filename, 'temp')
523 options = ['-vn', '-acodec', 'copy']
524 self._downloader.to_screen(u'[ffmpeg] Fixing audio file "%s"' % filename)
525 self.run_ffmpeg(filename, temp_filename, options)
527 os.remove(encodeFilename(filename))
528 os.rename(encodeFilename(temp_filename), encodeFilename(filename))