1
0
mirror of https://github.com/l1ving/youtube-dl synced 2025-02-13 21:55:46 +08:00
youtube-dl/youtube_dl/postprocessor/embedthumbnail.py
Alexandre L 7ec1e417ca
Allow embedding thumbnail in MKV as attachment
To fix rg3#10359, use `-attach` to embed the thumbnail as attachment.
In this version, the attached filename follow the https://matroska.org/technical/cover_art/index.html convention, as pointed in #6046.
The image dimensions are probably not going to respect the convention though, and we assume the thumbnail is in landscape orientation.
As only 2 images type seems to be recognized by the convention, they are hardcoded (mimetypes module would match on extension too).
2017-11-05 01:58:03 +01:00

126 lines
5.1 KiB
Python

# coding: utf-8
from __future__ import unicode_literals
import os
import subprocess
from .ffmpeg import FFmpegPostProcessor
from ..utils import (
check_executable,
encodeArgument,
encodeFilename,
PostProcessingError,
prepend_extension,
shell_quote
)
class EmbedThumbnailPPError(PostProcessingError):
pass
class EmbedThumbnailPP(FFmpegPostProcessor):
def __init__(self, downloader=None, already_have_thumbnail=False):
super(EmbedThumbnailPP, self).__init__(downloader)
self._already_have_thumbnail = already_have_thumbnail
def run(self, info):
filename = info['filepath']
temp_filename = prepend_extension(filename, 'temp')
if not info.get('thumbnails'):
raise EmbedThumbnailPPError('Thumbnail was not found. Nothing to do.')
thumbnail_filename = info['thumbnails'][-1]['filename']
if not os.path.exists(encodeFilename(thumbnail_filename)):
self._downloader.report_warning(
'Skipping embedding the thumbnail because the file is missing.')
return [], info
if info['ext'] == 'mkv':
if thumbnail_filename.endswith(('.jpe', '.jpeg', '.jpg', '.jfif')):
mimetype = 'image/jpeg'
extension = 'jpg'
elif thumbnail_filename.endswith('.png'):
mimetype = 'image/png'
extension = 'png'
else:
self._downloader.report_warning(
'Skipping embedding the thumbnail because the thumbnail extension is unknown.')
return [], info
options = [
'-c', 'copy',
'-attach', thumbnail_filename,
# https://matroska.org/technical/cover_art/index.html as pointed in #6046
# No orientation detection nor dimensions checking/convertion
'-metadata:s:t', 'filename=cover_land.{}'.format(extension),
# If not given : "[matroska @ 000001458de38840] Attachment stream 2 has no mimetype tag and it cannot be deduced from the codec id."
'-metadata:s:t', 'mimetype={}'.format(mimetype),
# Use metadata "title" so it is set as MATROSKA_ID_FILEDESC - optional
# https://github.com/FFmpeg/FFmpeg/blob/9cfdf0e3322b9a451277cf36406ac4a8e4e3da74/libavformat/matroskaenc.c#L1762
'-metadata:s:t', 'title=Thumbnail']
self._downloader.to_screen('[ffmpeg] Adding thumbnail to "%s"' % filename)
self.run_ffmpeg(filename, temp_filename, options)
if not self._already_have_thumbnail:
os.remove(encodeFilename(thumbnail_filename))
os.remove(encodeFilename(filename))
os.rename(encodeFilename(temp_filename), encodeFilename(filename))
elif info['ext'] == 'mp3':
options = [
'-c', 'copy', '-map', '0', '-map', '1',
'-metadata:s:v', 'title="Album cover"', '-metadata:s:v', 'comment="Cover (Front)"']
self._downloader.to_screen('[ffmpeg] Adding thumbnail to "%s"' % filename)
self.run_ffmpeg_multiple_files([filename, thumbnail_filename], temp_filename, options)
if not self._already_have_thumbnail:
os.remove(encodeFilename(thumbnail_filename))
os.remove(encodeFilename(filename))
os.rename(encodeFilename(temp_filename), encodeFilename(filename))
elif info['ext'] in ['m4a', 'mp4']:
if not check_executable('AtomicParsley', ['-v']):
raise EmbedThumbnailPPError('AtomicParsley was not found. Please install.')
cmd = [encodeFilename('AtomicParsley', True),
encodeFilename(filename, True),
encodeArgument('--artwork'),
encodeFilename(thumbnail_filename, True),
encodeArgument('-o'),
encodeFilename(temp_filename, True)]
self._downloader.to_screen('[atomicparsley] Adding thumbnail to "%s"' % filename)
if self._downloader.params.get('verbose', False):
self._downloader.to_screen('[debug] AtomicParsley command line: %s' % shell_quote(cmd))
p = subprocess.Popen(cmd, stdout=subprocess.PIPE, stderr=subprocess.PIPE)
stdout, stderr = p.communicate()
if p.returncode != 0:
msg = stderr.decode('utf-8', 'replace').strip()
raise EmbedThumbnailPPError(msg)
if not self._already_have_thumbnail:
os.remove(encodeFilename(thumbnail_filename))
# for formats that don't support thumbnails (like 3gp) AtomicParsley
# won't create to the temporary file
if b'No changes' in stdout:
self._downloader.report_warning('The file format doesn\'t support embedding a thumbnail')
else:
os.remove(encodeFilename(filename))
os.rename(encodeFilename(temp_filename), encodeFilename(filename))
else:
raise EmbedThumbnailPPError('Only mp3, m4a/mp4 and mkv are supported for thumbnail embedding for now.')
return [], info