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
)
149 self
.try_utime(out_path
, oldest_mtime
, oldest_mtime
)
151 if self
._deletetempfiles
:
152 for ipath
in input_paths
:
155 def run_ffmpeg(self
, path
, out_path
, opts
):
156 self
.run_ffmpeg_multiple_files([path
], out_path
, opts
)
158 def _ffmpeg_filename_argument(self
, fn
):
159 # ffmpeg broke --, see https://ffmpeg.org/trac/ffmpeg/ticket/2127 for details
160 if fn
.startswith('-'):
165 class FFmpegExtractAudioPP(FFmpegPostProcessor
):
166 def __init__(self
, downloader
=None, preferredcodec
=None, preferredquality
=None, nopostoverwrites
=False):
167 FFmpegPostProcessor
.__init
__(self
, downloader
)
168 if preferredcodec
is None:
169 preferredcodec
= 'best'
170 self
._preferredcodec
= preferredcodec
171 self
._preferredquality
= preferredquality
172 self
._nopostoverwrites
= nopostoverwrites
174 def get_audio_codec(self
, path
):
176 if not self
.probe_available
:
177 raise PostProcessingError('ffprobe or avprobe not found. Please install one.')
180 encodeFilename(self
.probe_executable
, True),
181 encodeArgument('-show_streams'),
182 encodeFilename(self
._ffmpeg
_filename
_argument
(path
), True)]
183 if self
._downloader
.params
.get('verbose', False):
184 self
._downloader
.to_screen('[debug] %s command line: %s' % (self
.basename
, shell_quote(cmd
)))
185 handle
= subprocess
.Popen(cmd
, stderr
=compat_subprocess_get_DEVNULL(), stdout
=subprocess
.PIPE
, stdin
=subprocess
.PIPE
)
186 output
= handle
.communicate()[0]
187 if handle
.wait() != 0:
189 except (IOError, OSError):
192 for line
in output
.decode('ascii', 'ignore').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:
199 def run_ffmpeg(self
, path
, out_path
, codec
, more_opts
):
203 acodec_opts
= ['-acodec', codec
]
204 opts
= ['-vn'] + acodec_opts
+ more_opts
206 FFmpegPostProcessor
.run_ffmpeg(self
, path
, out_path
, opts
)
207 except FFmpegPostProcessorError
as err
:
208 raise AudioConversionError(err
.msg
)
210 def run(self
, information
):
211 path
= information
['filepath']
213 filecodec
= self
.get_audio_codec(path
)
214 if filecodec
is None:
215 raise PostProcessingError('WARNING: unable to obtain file audio codec with ffprobe')
218 if self
._preferredcodec
== 'best' or self
._preferredcodec
== filecodec
or (self
._preferredcodec
== 'm4a' and filecodec
== 'aac'):
219 if filecodec
== 'aac' and self
._preferredcodec
in ['m4a', 'best']:
220 # Lossless, but in another container
223 more_opts
= ['-bsf:a', 'aac_adtstoasc']
224 elif filecodec
in ['aac', 'mp3', 'vorbis', 'opus']:
225 # Lossless if possible
227 extension
= filecodec
228 if filecodec
== 'aac':
229 more_opts
= ['-f', 'adts']
230 if filecodec
== 'vorbis':
234 acodec
= 'libmp3lame'
237 if self
._preferredquality
is not None:
238 if int(self
._preferredquality
) < 10:
239 more_opts
+= ['-q:a', self
._preferredquality
]
241 more_opts
+= ['-b:a', self
._preferredquality
+ 'k']
243 # We convert the audio (lossy)
244 acodec
= {'mp3': 'libmp3lame', 'aac': 'aac', 'm4a': 'aac', 'opus': 'opus', 'vorbis': 'libvorbis', 'wav': None}
[self
._preferredcodec
]
245 extension
= self
._preferredcodec
247 if self
._preferredquality
is not None:
248 # The opus codec doesn't support the -aq option
249 if int(self
._preferredquality
) < 10 and extension
!= 'opus':
250 more_opts
+= ['-q:a', self
._preferredquality
]
252 more_opts
+= ['-b:a', self
._preferredquality
+ 'k']
253 if self
._preferredcodec
== 'aac':
254 more_opts
+= ['-f', 'adts']
255 if self
._preferredcodec
== 'm4a':
256 more_opts
+= ['-bsf:a', 'aac_adtstoasc']
257 if self
._preferredcodec
== 'vorbis':
259 if self
._preferredcodec
== 'wav':
261 more_opts
+= ['-f', 'wav']
263 prefix
, sep
, ext
= path
.rpartition('.') # not os.path.splitext, since the latter does not work on unicode in all setups
264 new_path
= prefix
+ sep
+ extension
266 # If we download foo.mp3 and convert it to... foo.mp3, then don't delete foo.mp3, silly.
267 if (new_path
== path
or
268 (self
._nopostoverwrites
and os
.path
.exists(encodeFilename(new_path
)))):
269 self
._downloader
.to_screen('[youtube] Post-process file %s exists, skipping' % new_path
)
270 return [], information
273 self
._downloader
.to_screen('[' + self
.basename
+ '] Destination: ' + new_path
)
274 self
.run_ffmpeg(path
, new_path
, acodec
, more_opts
)
275 except AudioConversionError
as e
:
276 raise PostProcessingError(
277 'audio conversion failed: ' + e
.msg
)
279 raise PostProcessingError('error running ' + self
.basename
)
281 # Try to update the date time for extracted audio file.
282 if information
.get('filetime') is not None:
284 new_path
, time
.time(), information
['filetime'],
285 errnote
='Cannot update utime of audio file')
287 information
['filepath'] = new_path
288 return [path
], 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 [], 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 [path
], 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 [], information
509 subtitles
= information
.get('requested_subtitles')
511 self
._downloader
.to_screen('[ffmpeg] There aren\'t any subtitles to embed')
512 return [], information
514 sub_langs
= list(subtitles
.keys())
515 filename
= information
['filepath']
516 sub_filenames
= [subtitles_filename(filename
, lang
, sub_info
['ext']) for lang
, sub_info
in subtitles
.items()]
517 input_files
= [filename
] + sub_filenames
522 # Don't copy the existing subtitles, we may be running the
523 # postprocessor a second time
527 for (i
, lang
) in enumerate(sub_langs
):
528 opts
.extend(['-map', '%d:0' % (i
+ 1)])
529 lang_code
= self
._conver
_lang
_code
(lang
)
530 if lang_code
is not None:
531 opts
.extend(['-metadata:s:s:%d' % i
, 'language=%s' % lang_code
])
533 temp_filename
= prepend_extension(filename
, 'temp')
534 self
._downloader
.to_screen('[ffmpeg] Embedding subtitles in \'%s\'' % filename
)
535 self
.run_ffmpeg_multiple_files(input_files
, temp_filename
, opts
)
536 os
.remove(encodeFilename(filename
))
537 os
.rename(encodeFilename(temp_filename
), encodeFilename(filename
))
539 return sub_filenames
, information
542 class FFmpegMetadataPP(FFmpegPostProcessor
):
545 if info
.get('title') is not None:
546 metadata
['title'] = info
['title']
547 if info
.get('upload_date') is not None:
548 metadata
['date'] = info
['upload_date']
549 if info
.get('artist') is not None:
550 metadata
['artist'] = info
['artist']
551 elif info
.get('uploader') is not None:
552 metadata
['artist'] = info
['uploader']
553 elif info
.get('uploader_id') is not None:
554 metadata
['artist'] = info
['uploader_id']
555 if info
.get('description') is not None:
556 metadata
['description'] = info
['description']
557 metadata
['comment'] = info
['description']
558 if info
.get('webpage_url') is not None:
559 metadata
['purl'] = info
['webpage_url']
560 if info
.get('album') is not None:
561 metadata
['album'] = info
['album']
564 self
._downloader
.to_screen('[ffmpeg] There isn\'t any metadata to add')
567 filename
= info
['filepath']
568 temp_filename
= prepend_extension(filename
, 'temp')
570 if info
['ext'] == 'm4a':
571 options
= ['-vn', '-acodec', 'copy']
573 options
= ['-c', 'copy']
575 for (name
, value
) in metadata
.items():
576 options
.extend(['-metadata', '%s=%s' % (name
, value
)])
578 self
._downloader
.to_screen('[ffmpeg] Adding metadata to \'%s\'' % filename
)
579 self
.run_ffmpeg(filename
, temp_filename
, options
)
580 os
.remove(encodeFilename(filename
))
581 os
.rename(encodeFilename(temp_filename
), encodeFilename(filename
))
585 class FFmpegMergerPP(FFmpegPostProcessor
):
587 filename
= info
['filepath']
588 args
= ['-c', 'copy', '-map', '0:v:0', '-map', '1:a:0']
589 self
._downloader
.to_screen('[ffmpeg] Merging formats into "%s"' % filename
)
590 self
.run_ffmpeg_multiple_files(info
['__files_to_merge'], filename
, args
)
594 class FFmpegAudioFixPP(FFmpegPostProcessor
):
596 filename
= info
['filepath']
597 temp_filename
= prepend_extension(filename
, 'temp')
599 options
= ['-vn', '-acodec', 'copy']
600 self
._downloader
.to_screen('[ffmpeg] Fixing audio file "%s"' % filename
)
601 self
.run_ffmpeg(filename
, temp_filename
, options
)
603 os
.remove(encodeFilename(filename
))
604 os
.rename(encodeFilename(temp_filename
), encodeFilename(filename
))
609 class FFmpegFixupStretchedPP(FFmpegPostProcessor
):
611 stretched_ratio
= info
.get('stretched_ratio')
612 if stretched_ratio
is None or stretched_ratio
== 1:
615 filename
= info
['filepath']
616 temp_filename
= prepend_extension(filename
, 'temp')
618 options
= ['-c', 'copy', '-aspect', '%f' % stretched_ratio
]
619 self
._downloader
.to_screen('[ffmpeg] Fixing aspect ratio in "%s"' % filename
)
620 self
.run_ffmpeg(filename
, temp_filename
, options
)
622 os
.remove(encodeFilename(filename
))
623 os
.rename(encodeFilename(temp_filename
), encodeFilename(filename
))
628 class FFmpegFixupM4aPP(FFmpegPostProcessor
):
630 if info
.get('container') != 'm4a_dash':
633 filename
= info
['filepath']
634 temp_filename
= prepend_extension(filename
, 'temp')
636 options
= ['-c', 'copy', '-f', 'mp4']
637 self
._downloader
.to_screen('[ffmpeg] Correcting container in "%s"' % filename
)
638 self
.run_ffmpeg(filename
, temp_filename
, options
)
640 os
.remove(encodeFilename(filename
))
641 os
.rename(encodeFilename(temp_filename
), encodeFilename(filename
))
646 class FFmpegSubtitlesConvertorPP(FFmpegPostProcessor
):
647 def __init__(self
, downloader
=None, format
=None):
648 super(FFmpegSubtitlesConvertorPP
, self
).__init
__(downloader
)
652 subs
= info
.get('requested_subtitles')
653 filename
= info
['filepath']
654 new_ext
= self
.format
656 if new_format
== 'vtt':
657 new_format
= 'webvtt'
659 self
._downloader
.to_screen('[ffmpeg] There aren\'t any subtitles to convert')
661 self
._downloader
.to_screen('[ffmpeg] Converting subtitles')
662 for lang
, sub
in subs
.items():
665 self
._downloader
.to_screen(
666 '[ffmpeg] Subtitle file for %s is already in the requested'
669 new_file
= subtitles_filename(filename
, lang
, new_ext
)
671 subtitles_filename(filename
, lang
, ext
),
672 new_file
, ['-f', new_format
])
674 with io
.open(new_file
, 'rt', encoding
='utf-8') as f
: