[yt-dlp.git] / yt_dlp / postprocessor / embedthumbnail.py

import base64
import os
import re
import subprocess

from .common import PostProcessor
from .ffmpeg import FFmpegPostProcessor, FFmpegThumbnailsConvertorPP
from ..compat import imghdr
from ..dependencies import mutagen
from ..utils import (
    Popen,
    PostProcessingError,
    check_executable,
    encodeArgument,
    encodeFilename,
    prepend_extension,
    shell_quote,
)

if mutagen:
    from mutagen.flac import FLAC, Picture
    from mutagen.mp4 import MP4, MP4Cover
    from mutagen.oggopus import OggOpus
    from mutagen.oggvorbis import OggVorbis


class EmbedThumbnailPPError(PostProcessingError):
    pass


class EmbedThumbnailPP(FFmpegPostProcessor):

    def __init__(self, downloader=None, already_have_thumbnail=False):
        FFmpegPostProcessor.__init__(self, downloader)
        self._already_have_thumbnail = already_have_thumbnail

    def _get_thumbnail_resolution(self, filename, thumbnail_dict):
        def guess():
            width, height = thumbnail_dict.get('width'), thumbnail_dict.get('height')
            if width and height:
                return width, height

        try:
            size_regex = r',\s*(?P<w>\d+)x(?P<h>\d+)\s*[,\[]'
            size_result = self.run_ffmpeg(filename, None, ['-hide_banner'], expected_retcodes=(1,))
            mobj = re.search(size_regex, size_result)
            if mobj is None:
                return guess()
        except PostProcessingError as err:
            self.report_warning(f'unable to find the thumbnail resolution; {err}')
            return guess()
        return int(mobj.group('w')), int(mobj.group('h'))

    def _report_run(self, exe, filename):
        self.to_screen(f'{exe}: Adding thumbnail to "{filename}"')

    @PostProcessor._restrict_to(images=False)
    def run(self, info):
        filename = info['filepath']
        temp_filename = prepend_extension(filename, 'temp')

        if not info.get('thumbnails'):
            self.to_screen('There aren\'t any thumbnails to embed')
            return [], info

        idx = next((-i for i, t in enumerate(info['thumbnails'][::-1], 1) if t.get('filepath')), None)
        if idx is None:
            self.to_screen('There are no thumbnails on disk')
            return [], info
        thumbnail_filename = info['thumbnails'][idx]['filepath']
        if not os.path.exists(encodeFilename(thumbnail_filename)):
            self.report_warning('Skipping embedding the thumbnail because the file is missing.')
            return [], info

        # Correct extension for WebP file with wrong extension (see #25687, #25717)
        convertor = FFmpegThumbnailsConvertorPP(self._downloader)
        convertor.fixup_webp(info, idx)

        original_thumbnail = thumbnail_filename = info['thumbnails'][idx]['filepath']

        # Convert unsupported thumbnail formats (see #25687, #25717)
        # PNG is preferred since JPEG is lossy
        thumbnail_ext = os.path.splitext(thumbnail_filename)[1][1:]
        if info['ext'] not in ('mkv', 'mka') and thumbnail_ext not in ('jpg', 'jpeg', 'png'):
            thumbnail_filename = convertor.convert_thumbnail(thumbnail_filename, 'png')
            thumbnail_ext = 'png'

        mtime = os.stat(encodeFilename(filename)).st_mtime

        success = True
        if info['ext'] == 'mp3':
            options = [
                '-c', 'copy', '-map', '0:0', '-map', '1:0', '-write_id3v1', '1', '-id3v2_version', '3',
                '-metadata:s:v', 'title="Album cover"', '-metadata:s:v', 'comment=Cover (front)']

            self._report_run('ffmpeg', filename)
            self.run_ffmpeg_multiple_files([filename, thumbnail_filename], temp_filename, options)

        elif info['ext'] in ['mkv', 'mka']:
            options = list(self.stream_copy_opts())

            mimetype = f'image/{thumbnail_ext.replace("jpg", "jpeg")}'
            old_stream, new_stream = self.get_stream_number(
                filename, ('tags', 'mimetype'), mimetype)
            if old_stream is not None:
                options.extend(['-map', f'-0:{old_stream}'])
                new_stream -= 1
            options.extend([
                '-attach', self._ffmpeg_filename_argument(thumbnail_filename),
                f'-metadata:s:{new_stream}', f'mimetype={mimetype}',
                f'-metadata:s:{new_stream}', f'filename=cover.{thumbnail_ext}'])

            self._report_run('ffmpeg', filename)
            self.run_ffmpeg(filename, temp_filename, options)

        elif info['ext'] in ['m4a', 'mp4', 'm4v', 'mov']:
            prefer_atomicparsley = 'embed-thumbnail-atomicparsley' in self.get_param('compat_opts', [])
            # Method 1: Use mutagen
            if not mutagen or prefer_atomicparsley:
                success = False
            else:
                try:
                    self._report_run('mutagen', filename)
                    meta = MP4(filename)
                    # NOTE: the 'covr' atom is a non-standard MPEG-4 atom,
                    # Apple iTunes 'M4A' files include the 'moov.udta.meta.ilst' atom.
                    f = {'jpeg': MP4Cover.FORMAT_JPEG, 'png': MP4Cover.FORMAT_PNG}[imghdr.what(thumbnail_filename)]
                    with open(thumbnail_filename, 'rb') as thumbfile:
                        thumb_data = thumbfile.read()
                    meta.tags['covr'] = [MP4Cover(data=thumb_data, imageformat=f)]
                    meta.save()
                    temp_filename = filename
                except Exception as err:
                    self.report_warning(f'unable to embed using mutagen; {err}')
                    success = False

            # Method 2: Use AtomicParsley
            if not success:
                success = True
                atomicparsley = next((
                    # libatomicparsley.so : See https://github.com/xibr/ytdlp-lazy/issues/1
                    x for x in ['AtomicParsley', 'atomicparsley', 'libatomicparsley.so']
                    if check_executable(x, ['-v'])), None)
                if atomicparsley is None:
                    self.to_screen('Neither mutagen nor AtomicParsley was found. Falling back to ffmpeg')
                    success = False
                else:
                    if not prefer_atomicparsley:
                        self.to_screen('mutagen was not found. Falling back to AtomicParsley')
                    cmd = [encodeFilename(atomicparsley, True),
                           encodeFilename(filename, True),
                           encodeArgument('--artwork'),
                           encodeFilename(thumbnail_filename, True),
                           encodeArgument('-o'),
                           encodeFilename(temp_filename, True)]
                    cmd += [encodeArgument(o) for o in self._configuration_args('AtomicParsley')]

                    self._report_run('atomicparsley', filename)
                    self.write_debug(f'AtomicParsley command line: {shell_quote(cmd)}')
                    stdout, stderr, returncode = Popen.run(cmd, text=True, stdout=subprocess.PIPE, stderr=subprocess.PIPE)
                    if returncode:
                        self.report_warning(f'Unable to embed thumbnails using AtomicParsley; {stderr.strip()}')
                    # for formats that don't support thumbnails (like 3gp) AtomicParsley
                    # won't create to the temporary file
                    if 'No changes' in stdout:
                        self.report_warning('The file format doesn\'t support embedding a thumbnail')
                        success = False

            # Method 3: Use ffmpeg+ffprobe
            # Thumbnails attached using this method doesn't show up as cover in some cases
            # See https://github.com/yt-dlp/yt-dlp/issues/2125, https://github.com/yt-dlp/yt-dlp/issues/411
            if not success:
                success = True
                try:
                    options = [*self.stream_copy_opts(), '-map', '1']

                    old_stream, new_stream = self.get_stream_number(
                        filename, ('disposition', 'attached_pic'), 1)
                    if old_stream is not None:
                        options.extend(['-map', f'-0:{old_stream}'])
                        new_stream -= 1
                    options.extend([f'-disposition:{new_stream}', 'attached_pic'])

                    self._report_run('ffmpeg', filename)
                    self.run_ffmpeg_multiple_files([filename, thumbnail_filename], temp_filename, options)
                except PostProcessingError as err:
                    success = False
                    raise EmbedThumbnailPPError(f'Unable to embed using ffprobe & ffmpeg; {err}')

        elif info['ext'] in ['ogg', 'opus', 'flac']:
            if not mutagen:
                raise EmbedThumbnailPPError('module mutagen was not found. Please install using `python3 -m pip install mutagen`')

            self._report_run('mutagen', filename)
            f = {'opus': OggOpus, 'flac': FLAC, 'ogg': OggVorbis}[info['ext']](filename)

            pic = Picture()
            pic.mime = f'image/{imghdr.what(thumbnail_filename)}'
            with open(thumbnail_filename, 'rb') as thumbfile:
                pic.data = thumbfile.read()
            pic.type = 3  # front cover
            res = self._get_thumbnail_resolution(thumbnail_filename, info['thumbnails'][idx])
            if res is not None:
                pic.width, pic.height = res

            if info['ext'] == 'flac':
                f.add_picture(pic)
            else:
                # https://wiki.xiph.org/VorbisComment#METADATA_BLOCK_PICTURE
                f['METADATA_BLOCK_PICTURE'] = base64.b64encode(pic.write()).decode('ascii')
            f.save()
            temp_filename = filename

        else:
            raise EmbedThumbnailPPError('Supported filetypes for thumbnail embedding are: mp3, mkv/mka, ogg/opus/flac, m4a/mp4/m4v/mov')

        if success and temp_filename != filename:
            os.replace(temp_filename, filename)

        self.try_utime(filename, mtime, mtime)
        converted = original_thumbnail != thumbnail_filename
        self._delete_downloaded_files(
            thumbnail_filename if converted or not self._already_have_thumbnail else None,
            original_thumbnail if converted and not self._already_have_thumbnail else None,
            info=info)
        return [], info
Commit	Line	Data
95131b21	1	import base64
ddbed364	2	import os
06167fbb	3	import re
f8271158	4	import subprocess
06167fbb	5
8326b00a	6	from .common import PostProcessor
f8271158	7	from .ffmpeg import FFmpegPostProcessor, FFmpegThumbnailsConvertorPP
5792c950	8	from ..compat import imghdr
9b8ee23b	9	from ..dependencies import mutagen
ddbed364	10	from ..utils import (
f8271158	11	Popen,
f8271158	12	PostProcessingError,
ddbed364	13	check_executable,
2cc6d135	14	encodeArgument,
ddbed364	15	encodeFilename,
ddbed364	16	prepend_extension,
f5b1bca9	17	shell_quote,
ddbed364	18	)
ddbed364	19
9b8ee23b	20	if mutagen:
	21	from mutagen.flac import FLAC, Picture
	22	from mutagen.mp4 import MP4, MP4Cover
	23	from mutagen.oggopus import OggOpus
	24	from mutagen.oggvorbis import OggVorbis
	25
ddbed364	26
	27	class EmbedThumbnailPPError(PostProcessingError):
	28	pass
	29
	30
31fd9c76	31	class EmbedThumbnailPP(FFmpegPostProcessor):
1b77b347	32
8e595397	33	def __init__(self, downloader=None, already_have_thumbnail=False):
8fa43c73	34	FFmpegPostProcessor.__init__(self, downloader)
8e595397 YCH	35	self._already_have_thumbnail = already_have_thumbnail
8e595397 YCH	36
95131b21	37	def _get_thumbnail_resolution(self, filename, thumbnail_dict):
	38	def guess():
	39	width, height = thumbnail_dict.get('width'), thumbnail_dict.get('height')
	40	if width and height:
	41	return width, height
	42
	43	try:
	44	size_regex = r',\s(?P<w>\d+)x(?P<h>\d+)\s[,\[]'
00034c14	45	size_result = self.run_ffmpeg(filename, None, ['-hide_banner'], expected_retcodes=(1,))
95131b21	46	mobj = re.search(size_regex, size_result)
	47	if mobj is None:
	48	return guess()
	49	except PostProcessingError as err:
add96eb9	50	self.report_warning(f'unable to find the thumbnail resolution; {err}')
95131b21	51	return guess()
	52	return int(mobj.group('w')), int(mobj.group('h'))
	53
acdecdfa	54	def _report_run(self, exe, filename):
86e5f3ed	55	self.to_screen(f'{exe}: Adding thumbnail to "{filename}"')
acdecdfa	56
8326b00a	57	@PostProcessor._restrict_to(images=False)
ddbed364	58	def run(self, info):
	59	filename = info['filepath']
	60	temp_filename = prepend_extension(filename, 'temp')
ddbed364	61
8e595397	62	if not info.get('thumbnails'):
1b77b347	63	self.to_screen('There aren\'t any thumbnails to embed')
b5cbe3d6	64	return [], info
ddbed364	65
337e0c62	66	idx = next((-i for i, t in enumerate(info['thumbnails'][::-1], 1) if t.get('filepath')), None)
885cc0b7	67	if idx is None:
	68	self.to_screen('There are no thumbnails on disk')
	69	return [], info
	70	thumbnail_filename = info['thumbnails'][idx]['filepath']
c33a8639	71	if not os.path.exists(encodeFilename(thumbnail_filename)):
f446cc66	72	self.report_warning('Skipping embedding the thumbnail because the file is missing.')
c33a8639 YCH	73	return [], info
c33a8639 YCH	74
bff857a8	75	# Correct extension for WebP file with wrong extension (see #25687, #25717)
8fa43c73	76	convertor = FFmpegThumbnailsConvertorPP(self._downloader)
885cc0b7	77	convertor.fixup_webp(info, idx)
8fa43c73	78
885cc0b7	79	original_thumbnail = thumbnail_filename = info['thumbnails'][idx]['filepath']
bff857a8	80
7774db5b ES	81	# Convert unsupported thumbnail formats (see #25687, #25717)
7774db5b ES	82	# PNG is preferred since JPEG is lossy
1d485a1a	83	thumbnail_ext = os.path.splitext(thumbnail_filename)[1][1:]
7774db5b	84	if info['ext'] not in ('mkv', 'mka') and thumbnail_ext not in ('jpg', 'jpeg', 'png'):
a927acb1	85	thumbnail_filename = convertor.convert_thumbnail(thumbnail_filename, 'png')
a927acb1	86	thumbnail_ext = 'png'
777d5a45	87
ca879745	88	mtime = os.stat(encodeFilename(filename)).st_mtime
ca879745	89
67002a5a	90	success = True
8e2915d7	91	if info['ext'] == 'mp3':
92995e62	92	options = [
f8942946	93	'-c', 'copy', '-map', '0:0', '-map', '1:0', '-write_id3v1', '1', '-id3v2_version', '3',
e02e6d86	94	'-metadata:s:v', 'title="Album cover"', '-metadata:s:v', 'comment=Cover (front)']
ddbed364	95
acdecdfa	96	self._report_run('ffmpeg', filename)
bb8ca1d1	97	self.run_ffmpeg_multiple_files([filename, thumbnail_filename], temp_filename, options)
ddbed364	98
06167fbb	99	elif info['ext'] in ['mkv', 'mka']:
397235c5	100	options = list(self.stream_copy_opts())
ddbed364	101
1d485a1a	102	mimetype = f'image/{thumbnail_ext.replace("jpg", "jpeg")}'
06167fbb	103	old_stream, new_stream = self.get_stream_number(
	104	filename, ('tags', 'mimetype'), mimetype)
	105	if old_stream is not None:
add96eb9	106	options.extend(['-map', f'-0:{old_stream}'])
06167fbb	107	new_stream -= 1
06167fbb	108	options.extend([
0f0875ed	109	'-attach', self._ffmpeg_filename_argument(thumbnail_filename),
add96eb9	110	f'-metadata:s:{new_stream}', f'mimetype={mimetype}',
add96eb9	111	f'-metadata:s:{new_stream}', f'filename=cover.{thumbnail_ext}'])
ddbed364	112
acdecdfa	113	self._report_run('ffmpeg', filename)
06167fbb	114	self.run_ffmpeg(filename, temp_filename, options)
06167fbb	115
8a4cd12c	116	elif info['ext'] in ['m4a', 'mp4', 'm4v', 'mov']:
e858a9d6	117	prefer_atomicparsley = 'embed-thumbnail-atomicparsley' in self.get_param('compat_opts', [])
acdecdfa	118	# Method 1: Use mutagen
9b8ee23b	119	if not mutagen or prefer_atomicparsley:
acdecdfa	120	success = False
	121	else:
	122	try:
	123	self._report_run('mutagen', filename)
	124	meta = MP4(filename)
	125	# NOTE: the 'covr' atom is a non-standard MPEG-4 atom,
	126	# Apple iTunes 'M4A' files include the 'moov.udta.meta.ilst' atom.
f17c7022	127	f = {'jpeg': MP4Cover.FORMAT_JPEG, 'png': MP4Cover.FORMAT_PNG}[imghdr.what(thumbnail_filename)]
acdecdfa	128	with open(thumbnail_filename, 'rb') as thumbfile:
	129	thumb_data = thumbfile.read()
	130	meta.tags['covr'] = [MP4Cover(data=thumb_data, imageformat=f)]
	131	meta.save()
	132	temp_filename = filename
	133	except Exception as err:
add96eb9	134	self.report_warning(f'unable to embed using mutagen; {err}')
acdecdfa	135	success = False
06167fbb	136
77cee0f1	137	# Method 2: Use AtomicParsley
	138	if not success:
	139	success = True
	140	atomicparsley = next((
b5e9a641	141	# libatomicparsley.so : See https://github.com/xibr/ytdlp-lazy/issues/1
b5e9a641	142	x for x in ['AtomicParsley', 'atomicparsley', 'libatomicparsley.so']
77cee0f1	143	if check_executable(x, ['-v'])), None)
	144	if atomicparsley is None:
	145	self.to_screen('Neither mutagen nor AtomicParsley was found. Falling back to ffmpeg')
	146	success = False
	147	else:
	148	if not prefer_atomicparsley:
	149	self.to_screen('mutagen was not found. Falling back to AtomicParsley')
	150	cmd = [encodeFilename(atomicparsley, True),
	151	encodeFilename(filename, True),
	152	encodeArgument('--artwork'),
	153	encodeFilename(thumbnail_filename, True),
	154	encodeArgument('-o'),
	155	encodeFilename(temp_filename, True)]
	156	cmd += [encodeArgument(o) for o in self._configuration_args('AtomicParsley')]
	157
	158	self._report_run('atomicparsley', filename)
add96eb9	159	self.write_debug(f'AtomicParsley command line: {shell_quote(cmd)}')
f0c9fb96	160	stdout, stderr, returncode = Popen.run(cmd, text=True, stdout=subprocess.PIPE, stderr=subprocess.PIPE)
	161	if returncode:
	162	self.report_warning(f'Unable to embed thumbnails using AtomicParsley; {stderr.strip()}')
77cee0f1	163	# for formats that don't support thumbnails (like 3gp) AtomicParsley
77cee0f1	164	# won't create to the temporary file
f0c9fb96	165	if 'No changes' in stdout:
77cee0f1	166	self.report_warning('The file format doesn\'t support embedding a thumbnail')
	167	success = False
	168
	169	# Method 3: Use ffmpeg+ffprobe
	170	# Thumbnails attached using this method doesn't show up as cover in some cases
	171	# See https://github.com/yt-dlp/yt-dlp/issues/2125, https://github.com/yt-dlp/yt-dlp/issues/411
	172	if not success:
acdecdfa	173	success = True
acdecdfa	174	try:
397235c5	175	options = [*self.stream_copy_opts(), '-map', '1']
acdecdfa	176
	177	old_stream, new_stream = self.get_stream_number(
	178	filename, ('disposition', 'attached_pic'), 1)
	179	if old_stream is not None:
add96eb9	180	options.extend(['-map', f'-0:{old_stream}'])
acdecdfa	181	new_stream -= 1
add96eb9	182	options.extend([f'-disposition:{new_stream}', 'attached_pic'])
acdecdfa	183
	184	self._report_run('ffmpeg', filename)
	185	self.run_ffmpeg_multiple_files([filename, thumbnail_filename], temp_filename, options)
	186	except PostProcessingError as err:
06167fbb	187	success = False
77cee0f1	188	raise EmbedThumbnailPPError(f'Unable to embed using ffprobe & ffmpeg; {err}')
06167fbb	189
95131b21	190	elif info['ext'] in ['ogg', 'opus', 'flac']:
9b8ee23b	191	if not mutagen:
47ab66db	192	raise EmbedThumbnailPPError('module mutagen was not found. Please install using `python3 -m pip install mutagen`')
06167fbb	193
acdecdfa	194	self._report_run('mutagen', filename)
95131b21	195	f = {'opus': OggOpus, 'flac': FLAC, 'ogg': OggVorbis}[info['ext']](filename)
	196
	197	pic = Picture()
add96eb9	198	pic.mime = f'image/{imghdr.what(thumbnail_filename)}'
95131b21	199	with open(thumbnail_filename, 'rb') as thumbfile:
	200	pic.data = thumbfile.read()
	201	pic.type = 3 # front cover
885cc0b7	202	res = self._get_thumbnail_resolution(thumbnail_filename, info['thumbnails'][idx])
95131b21	203	if res is not None:
	204	pic.width, pic.height = res
	205
	206	if info['ext'] == 'flac':
	207	f.add_picture(pic)
	208	else:
	209	# https://wiki.xiph.org/VorbisComment#METADATA_BLOCK_PICTURE
	210	f['METADATA_BLOCK_PICTURE'] = base64.b64encode(pic.write()).decode('ascii')
06167fbb	211	f.save()
acdecdfa	212	temp_filename = filename
67002a5a	213
ddbed364	214	else:
8a4cd12c	215	raise EmbedThumbnailPPError('Supported filetypes for thumbnail embedding are: mp3, mkv/mka, ogg/opus/flac, m4a/mp4/m4v/mov')
ddbed364	216
06167fbb	217	if success and temp_filename != filename:
d75201a8	218	os.replace(temp_filename, filename)
2e339f59	219
ca879745	220	self.try_utime(filename, mtime, mtime)
43d7f5a5	221	converted = original_thumbnail != thumbnail_filename
	222	self._delete_downloaded_files(
	223	thumbnail_filename if converted or not self._already_have_thumbnail else None,
	224	original_thumbnail if converted and not self._already_have_thumbnail else None,
	225	info=info)
	226	return [], info