1 from __future__ import unicode_literals
10 from .common import AudioConversionError, PostProcessor
27 EXT_TO_OUT_FORMATS = {
45 'vorbis': 'libvorbis',
50 class FFmpegPostProcessorError(PostProcessingError):
54 class FFmpegPostProcessor(PostProcessor):
55 def __init__(self, downloader=None):
56 PostProcessor.__init__(self, downloader)
57 self._determine_executables()
59 def check_version(self):
60 if not self.available:
61 raise FFmpegPostProcessorError('ffmpeg or avconv not found. Please install one.')
63 required_version = '10-0' if self.basename == 'avconv' else '1.0'
64 if is_outdated_version(
65 self._versions[self.basename], required_version):
66 warning = 'Your copy of %s is outdated, update %s to version %s or newer if you encounter any errors.' % (
67 self.basename, self.basename, required_version)
69 self._downloader.report_warning(warning)
72 def get_versions(downloader=None):
73 return FFmpegPostProcessor(downloader)._versions
75 def _determine_executables(self):
76 programs = ['avprobe', 'avconv', 'ffmpeg', 'ffprobe']
79 def get_ffmpeg_version(path):
80 ver = get_exe_version(path, args=['-version'])
83 r'(?:\d+:)?([0-9.]+)-[0-9]+ubuntu[0-9.]+$', # Ubuntu, see [1]
84 r'n([0-9.]+)$', # Arch Linux
85 # 1. http://www.ducea.com/2006/06/17/ubuntu-package-version-naming-explanation/
88 mobj = re.match(regex, ver)
94 self.probe_basename = None
99 prefer_ffmpeg = self._downloader.params.get('prefer_ffmpeg', True)
100 location = self._downloader.params.get('ffmpeg_location')
101 if location is not None:
102 if not os.path.exists(location):
103 self._downloader.report_warning(
104 'ffmpeg-location %s does not exist! '
105 'Continuing without avconv/ffmpeg.' % (location))
108 elif not os.path.isdir(location):
109 basename = os.path.splitext(os.path.basename(location))[0]
110 if basename not in programs:
111 self._downloader.report_warning(
112 'Cannot identify executable %s, its basename should be one of %s. '
113 'Continuing without avconv/ffmpeg.' %
114 (location, ', '.join(programs)))
117 location = os.path.dirname(os.path.abspath(location))
118 if basename in ('ffmpeg', 'ffprobe'):
122 (p, os.path.join(location, p)) for p in programs)
123 self._versions = dict(
124 (p, get_ffmpeg_version(self._paths[p])) for p in programs)
125 if self._versions is None:
126 self._versions = dict(
127 (p, get_ffmpeg_version(p)) for p in programs)
128 self._paths = dict((p, p) for p in programs)
130 if prefer_ffmpeg is False:
131 prefs = ('avconv', 'ffmpeg')
133 prefs = ('ffmpeg', 'avconv')
135 if self._versions[p]:
139 if prefer_ffmpeg is False:
140 prefs = ('avprobe', 'ffprobe')
142 prefs = ('ffprobe', 'avprobe')
144 if self._versions[p]:
145 self.probe_basename = p
150 return self.basename is not None
153 def executable(self):
154 return self._paths[self.basename]
157 def probe_available(self):
158 return self.probe_basename is not None
161 def probe_executable(self):
162 return self._paths[self.probe_basename]
164 def get_audio_codec(self, path):
165 if not self.probe_available and not self.available:
166 raise PostProcessingError('ffprobe/avprobe and ffmpeg/avconv not found. Please install one.')
168 if self.probe_available:
170 encodeFilename(self.probe_executable, True),
171 encodeArgument('-show_streams')]
174 encodeFilename(self.executable, True),
175 encodeArgument('-i')]
176 cmd.append(encodeFilename(self._ffmpeg_filename_argument(path), True))
177 if self._downloader.params.get('verbose', False):
178 self._downloader.to_screen(
179 '[debug] %s command line: %s' % (self.basename, shell_quote(cmd)))
180 handle = subprocess.Popen(
181 cmd, stderr=subprocess.PIPE,
182 stdout=subprocess.PIPE, stdin=subprocess.PIPE)
183 stdout_data, stderr_data = handle.communicate()
184 expected_ret = 0 if self.probe_available else 1
185 if handle.wait() != expected_ret:
187 except (IOError, OSError):
189 output = (stdout_data if self.probe_available else stderr_data).decode('ascii', 'ignore')
190 if self.probe_available:
192 for line in output.split('\n'):
193 if line.startswith('codec_name='):
194 audio_codec = line.split('=')[1].strip()
195 elif line.strip() == 'codec_type=audio' and audio_codec is not None:
198 # Stream #FILE_INDEX:STREAM_INDEX[STREAM_ID](LANGUAGE): CODEC_TYPE: CODEC_NAME
200 r'Stream\s*#\d+:\d+(?:\[0x[0-9a-f]+\])?(?:\([a-z]{3}\))?:\s*Audio:\s*([0-9a-z]+)',
206 def run_ffmpeg_multiple_files(self, input_paths, out_path, opts):
210 os.stat(encodeFilename(path)).st_mtime for path in input_paths)
212 opts += self._configuration_args()
215 for path in input_paths:
217 encodeArgument('-i'),
218 encodeFilename(self._ffmpeg_filename_argument(path), True)
220 cmd = ([encodeFilename(self.executable, True), encodeArgument('-y')] +
221 ['-loglevel', 'repeat+info'] +
223 [encodeArgument(o) for o in opts] +
224 [encodeFilename(self._ffmpeg_filename_argument(out_path), True)])
226 if self._downloader.params.get('verbose', False):
227 self._downloader.to_screen('[debug] ffmpeg command line: %s' % shell_quote(cmd))
228 p = subprocess.Popen(cmd, stdout=subprocess.PIPE, stderr=subprocess.PIPE, stdin=subprocess.PIPE)
229 stdout, stderr = p.communicate()
230 if p.returncode != 0:
231 stderr = stderr.decode('utf-8', 'replace')
232 msg = stderr.strip().split('\n')[-1]
233 raise FFmpegPostProcessorError(msg)
234 self.try_utime(out_path, oldest_mtime, oldest_mtime)
236 def run_ffmpeg(self, path, out_path, opts):
237 self.run_ffmpeg_multiple_files([path], out_path, opts)
239 def _ffmpeg_filename_argument(self, fn):
240 # Always use 'file:' because the filename may contain ':' (ffmpeg
241 # interprets that as a protocol) or can start with '-' (-- is broken in
242 # ffmpeg, see https://ffmpeg.org/trac/ffmpeg/ticket/2127 for details)
243 # Also leave '-' intact in order not to break streaming to stdout.
244 return 'file:' + fn if fn != '-' else fn
247 class FFmpegExtractAudioPP(FFmpegPostProcessor):
248 def __init__(self, downloader=None, preferredcodec=None, preferredquality=None, nopostoverwrites=False):
249 FFmpegPostProcessor.__init__(self, downloader)
250 if preferredcodec is None:
251 preferredcodec = 'best'
252 self._preferredcodec = preferredcodec
253 self._preferredquality = preferredquality
254 self._nopostoverwrites = nopostoverwrites
256 def run_ffmpeg(self, path, out_path, codec, more_opts):
260 acodec_opts = ['-acodec', codec]
261 opts = ['-vn'] + acodec_opts + more_opts
263 FFmpegPostProcessor.run_ffmpeg(self, path, out_path, opts)
264 except FFmpegPostProcessorError as err:
265 raise AudioConversionError(err.msg)
267 def run(self, information):
268 path = information['filepath']
270 filecodec = self.get_audio_codec(path)
271 if filecodec is None:
272 raise PostProcessingError('WARNING: unable to obtain file audio codec with ffprobe')
275 if self._preferredcodec == 'best' or self._preferredcodec == filecodec or (self._preferredcodec == 'm4a' and filecodec == 'aac'):
276 if filecodec == 'aac' and self._preferredcodec in ['m4a', 'best']:
277 # Lossless, but in another container
280 more_opts = ['-bsf:a', 'aac_adtstoasc']
281 elif filecodec in ['aac', 'flac', 'mp3', 'vorbis', 'opus']:
282 # Lossless if possible
284 extension = filecodec
285 if filecodec == 'aac':
286 more_opts = ['-f', 'adts']
287 if filecodec == 'vorbis':
291 acodec = 'libmp3lame'
294 if self._preferredquality is not None:
295 if int(self._preferredquality) < 10:
296 more_opts += ['-q:a', self._preferredquality]
298 more_opts += ['-b:a', self._preferredquality + 'k']
300 # We convert the audio (lossy if codec is lossy)
301 acodec = ACODECS[self._preferredcodec]
302 extension = self._preferredcodec
304 if self._preferredquality is not None:
305 # The opus codec doesn't support the -aq option
306 if int(self._preferredquality) < 10 and extension != 'opus':
307 more_opts += ['-q:a', self._preferredquality]
309 more_opts += ['-b:a', self._preferredquality + 'k']
310 if self._preferredcodec == 'aac':
311 more_opts += ['-f', 'adts']
312 if self._preferredcodec == 'm4a':
313 more_opts += ['-bsf:a', 'aac_adtstoasc']
314 if self._preferredcodec == 'vorbis':
316 if self._preferredcodec == 'wav':
318 more_opts += ['-f', 'wav']
320 prefix, sep, ext = path.rpartition('.') # not os.path.splitext, since the latter does not work on unicode in all setups
321 new_path = prefix + sep + extension
323 information['filepath'] = new_path
324 information['ext'] = extension
326 # If we download foo.mp3 and convert it to... foo.mp3, then don't delete foo.mp3, silly.
327 if (new_path == path or
328 (self._nopostoverwrites and os.path.exists(encodeFilename(new_path)))):
329 self._downloader.to_screen('[ffmpeg] Post-process file %s exists, skipping' % new_path)
330 return [], information
333 self._downloader.to_screen('[ffmpeg] Destination: ' + new_path)
334 self.run_ffmpeg(path, new_path, acodec, more_opts)
335 except AudioConversionError as e:
336 raise PostProcessingError(
337 'audio conversion failed: ' + e.msg)
339 raise PostProcessingError('error running ' + self.basename)
341 # Try to update the date time for extracted audio file.
342 if information.get('filetime') is not None:
344 new_path, time.time(), information['filetime'],
345 errnote='Cannot update utime of audio file')
347 return [path], information
350 class FFmpegVideoConvertorPP(FFmpegPostProcessor):
351 def __init__(self, downloader=None, preferedformat=None):
352 super(FFmpegVideoConvertorPP, self).__init__(downloader)
353 self._preferedformat = preferedformat
355 def run(self, information):
356 path = information['filepath']
357 if information['ext'] == self._preferedformat:
358 self._downloader.to_screen('[ffmpeg] Not converting video file %s - already is in target format %s' % (path, self._preferedformat))
359 return [], information
361 if self._preferedformat == 'avi':
362 options.extend(['-c:v', 'libxvid', '-vtag', 'XVID'])
363 prefix, sep, ext = path.rpartition('.')
364 outpath = prefix + sep + self._preferedformat
365 self._downloader.to_screen('[' + 'ffmpeg' + '] Converting video from %s to %s, Destination: ' % (information['ext'], self._preferedformat) + outpath)
366 self.run_ffmpeg(path, outpath, options)
367 information['filepath'] = outpath
368 information['format'] = self._preferedformat
369 information['ext'] = self._preferedformat
370 return [path], information
373 class FFmpegEmbedSubtitlePP(FFmpegPostProcessor):
374 def run(self, information):
375 if information['ext'] not in ('mp4', 'webm', 'mkv'):
376 self._downloader.to_screen('[ffmpeg] Subtitles can only be embedded in mp4, webm or mkv files')
377 return [], information
378 subtitles = information.get('requested_subtitles')
380 self._downloader.to_screen('[ffmpeg] There aren\'t any subtitles to embed')
381 return [], information
383 filename = information['filepath']
385 ext = information['ext']
388 webm_vtt_warn = False
390 for lang, sub_info in subtitles.items():
391 sub_ext = sub_info['ext']
392 if ext != 'webm' or ext == 'webm' and sub_ext == 'vtt':
393 sub_langs.append(lang)
394 sub_filenames.append(subtitles_filename(filename, lang, sub_ext))
396 if not webm_vtt_warn and ext == 'webm' and sub_ext != 'vtt':
398 self._downloader.to_screen('[ffmpeg] Only WebVTT subtitles can be embedded in webm files')
401 return [], information
403 input_files = [filename] + sub_filenames
408 # Don't copy the existing subtitles, we may be running the
409 # postprocessor a second time
412 if information['ext'] == 'mp4':
413 opts += ['-c:s', 'mov_text']
414 for (i, lang) in enumerate(sub_langs):
415 opts.extend(['-map', '%d:0' % (i + 1)])
416 lang_code = ISO639Utils.short2long(lang) or lang
417 opts.extend(['-metadata:s:s:%d' % i, 'language=%s' % lang_code])
419 temp_filename = prepend_extension(filename, 'temp')
420 self._downloader.to_screen('[ffmpeg] Embedding subtitles in \'%s\'' % filename)
421 self.run_ffmpeg_multiple_files(input_files, temp_filename, opts)
422 os.remove(encodeFilename(filename))
423 os.rename(encodeFilename(temp_filename), encodeFilename(filename))
425 return sub_filenames, information
428 class FFmpegMetadataPP(FFmpegPostProcessor):
432 def add(meta_list, info_list=None):
434 info_list = meta_list
435 if not isinstance(meta_list, (list, tuple)):
436 meta_list = (meta_list,)
437 if not isinstance(info_list, (list, tuple)):
438 info_list = (info_list,)
439 for info_f in info_list:
440 if info.get(info_f) is not None:
441 for meta_f in meta_list:
442 metadata[meta_f] = info[info_f]
445 add('title', ('track', 'title'))
446 add('date', 'upload_date')
447 add(('description', 'comment'), 'description')
448 add('purl', 'webpage_url')
449 add('track', 'track_number')
450 add('artist', ('artist', 'creator', 'uploader', 'uploader_id'))
454 add('disc', 'disc_number')
457 self._downloader.to_screen('[ffmpeg] There isn\'t any metadata to add')
460 filename = info['filepath']
461 temp_filename = prepend_extension(filename, 'temp')
462 in_filenames = [filename]
465 if info['ext'] == 'm4a':
466 options.extend(['-vn', '-acodec', 'copy'])
468 options.extend(['-c', 'copy'])
470 for (name, value) in metadata.items():
471 options.extend(['-metadata', '%s=%s' % (name, value)])
473 chapters = info.get('chapters', [])
475 metadata_filename = replace_extension(filename, 'meta')
476 with io.open(metadata_filename, 'wt', encoding='utf-8') as f:
477 def ffmpeg_escape(text):
478 return re.sub(r'(=|;|#|\\|\n)', r'\\\1', text)
480 metadata_file_content = ';FFMETADATA1\n'
481 for chapter in chapters:
482 metadata_file_content += '[CHAPTER]\nTIMEBASE=1/1000\n'
483 metadata_file_content += 'START=%d\n' % (chapter['start_time'] * 1000)
484 metadata_file_content += 'END=%d\n' % (chapter['end_time'] * 1000)
485 chapter_title = chapter.get('title')
487 metadata_file_content += 'title=%s\n' % ffmpeg_escape(chapter_title)
488 f.write(metadata_file_content)
489 in_filenames.append(metadata_filename)
490 options.extend(['-map_metadata', '1'])
492 self._downloader.to_screen('[ffmpeg] Adding metadata to \'%s\'' % filename)
493 self.run_ffmpeg_multiple_files(in_filenames, temp_filename, options)
495 os.remove(metadata_filename)
496 os.remove(encodeFilename(filename))
497 os.rename(encodeFilename(temp_filename), encodeFilename(filename))
501 class FFmpegMergerPP(FFmpegPostProcessor):
503 filename = info['filepath']
504 temp_filename = prepend_extension(filename, 'temp')
505 args = ['-c', 'copy', '-map', '0:v:0', '-map', '1:a:0']
506 self._downloader.to_screen('[ffmpeg] Merging formats into "%s"' % filename)
507 self.run_ffmpeg_multiple_files(info['__files_to_merge'], temp_filename, args)
508 os.rename(encodeFilename(temp_filename), encodeFilename(filename))
509 return info['__files_to_merge'], info
512 # TODO: figure out merge-capable ffmpeg version
513 if self.basename != 'avconv':
516 required_version = '10-0'
517 if is_outdated_version(
518 self._versions[self.basename], required_version):
519 warning = ('Your copy of %s is outdated and unable to properly mux separate video and audio files, '
520 'youtube-dl will download single file media. '
521 'Update %s to version %s or newer to fix this.') % (
522 self.basename, self.basename, required_version)
524 self._downloader.report_warning(warning)
529 class FFmpegFixupStretchedPP(FFmpegPostProcessor):
531 stretched_ratio = info.get('stretched_ratio')
532 if stretched_ratio is None or stretched_ratio == 1:
535 filename = info['filepath']
536 temp_filename = prepend_extension(filename, 'temp')
538 options = ['-c', 'copy', '-aspect', '%f' % stretched_ratio]
539 self._downloader.to_screen('[ffmpeg] Fixing aspect ratio in "%s"' % filename)
540 self.run_ffmpeg(filename, temp_filename, options)
542 os.remove(encodeFilename(filename))
543 os.rename(encodeFilename(temp_filename), encodeFilename(filename))
548 class FFmpegFixupM4aPP(FFmpegPostProcessor):
550 if info.get('container') != 'm4a_dash':
553 filename = info['filepath']
554 temp_filename = prepend_extension(filename, 'temp')
556 options = ['-c', 'copy', '-f', 'mp4']
557 self._downloader.to_screen('[ffmpeg] Correcting container in "%s"' % filename)
558 self.run_ffmpeg(filename, temp_filename, options)
560 os.remove(encodeFilename(filename))
561 os.rename(encodeFilename(temp_filename), encodeFilename(filename))
566 class FFmpegFixupM3u8PP(FFmpegPostProcessor):
568 filename = info['filepath']
569 if self.get_audio_codec(filename) == 'aac':
570 temp_filename = prepend_extension(filename, 'temp')
572 options = ['-c', 'copy', '-f', 'mp4', '-bsf:a', 'aac_adtstoasc']
573 self._downloader.to_screen('[ffmpeg] Fixing malformed AAC bitstream in "%s"' % filename)
574 self.run_ffmpeg(filename, temp_filename, options)
576 os.remove(encodeFilename(filename))
577 os.rename(encodeFilename(temp_filename), encodeFilename(filename))
581 class FFmpegSubtitlesConvertorPP(FFmpegPostProcessor):
582 def __init__(self, downloader=None, format=None):
583 super(FFmpegSubtitlesConvertorPP, self).__init__(downloader)
587 subs = info.get('requested_subtitles')
588 filename = info['filepath']
589 new_ext = self.format
591 if new_format == 'vtt':
592 new_format = 'webvtt'
594 self._downloader.to_screen('[ffmpeg] There aren\'t any subtitles to convert')
596 self._downloader.to_screen('[ffmpeg] Converting subtitles')
598 for lang, sub in subs.items():
601 self._downloader.to_screen(
602 '[ffmpeg] Subtitle file for %s is already in the requested format' % new_ext)
604 old_file = subtitles_filename(filename, lang, ext)
605 sub_filenames.append(old_file)
606 new_file = subtitles_filename(filename, lang, new_ext)
608 if ext in ('dfxp', 'ttml', 'tt'):
609 self._downloader.report_warning(
610 'You have requested to convert dfxp (TTML) subtitles into another format, '
611 'which results in style information loss')
614 srt_file = subtitles_filename(filename, lang, 'srt')
616 with open(dfxp_file, 'rb') as f:
617 srt_data = dfxp2srt(f.read())
619 with io.open(srt_file, 'wt', encoding='utf-8') as f:
631 sub_filenames.append(srt_file)
633 self.run_ffmpeg(old_file, new_file, ['-f', new_format])
635 with io.open(new_file, 'rt', encoding='utf-8') as f:
641 return sub_filenames, info