# coding: utf-8 from __future__ import unicode_literals import base64 import imghdr import os import subprocess import re try: from mutagen.oggvorbis import OggVorbis from mutagen.oggopus import OggOpus from mutagen.flac import Picture, FLAC has_mutagen = True except ImportError: has_mutagen = False from .ffmpeg import ( FFmpegPostProcessor, FFmpegThumbnailsConvertorPP, ) from ..utils import ( check_executable, encodeArgument, encodeFilename, error_to_compat_str, PostProcessingError, prepend_extension, process_communicate_or_kill, shell_quote, ) 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\d+)x(?P\d+)\s*[,\[]' size_result = self.run_ffmpeg(filename, filename, ['-hide_banner']) mobj = re.search(size_regex, size_result) if mobj is None: return guess() except PostProcessingError as err: self.report_warning('unable to find the thumbnail resolution; %s' % error_to_compat_str(err)) return guess() return int(mobj.group('w')), int(mobj.group('h')) 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 thumbnail_filename = info['thumbnails'][-1]['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, -1) original_thumbnail = thumbnail_filename = info['thumbnails'][-1]['filepath'] # Convert unsupported thumbnail formats to JPEG (see #25687, #25717) thumbnail_ext = os.path.splitext(thumbnail_filename)[1][1:] if thumbnail_ext not in ('jpg', 'png'): thumbnail_filename = convertor.convert_thumbnail(thumbnail_filename, 'jpg') thumbnail_ext = 'jpg' mtime = os.stat(encodeFilename(filename)).st_mtime success = True if info['ext'] == 'mp3': options = [ '-c', 'copy', '-map', '0:0', '-map', '1:0', '-id3v2_version', '3', '-metadata:s:v', 'title="Album cover"', '-metadata:s:v', 'comment="Cover (front)"'] self.to_screen('Adding thumbnail to "%s"' % filename) self.run_ffmpeg_multiple_files([filename, thumbnail_filename], temp_filename, options) elif info['ext'] in ['mkv', 'mka']: options = ['-c', 'copy', '-map', '0', '-dn'] mimetype = 'image/%s' % ('png' if thumbnail_ext == 'png' else 'jpeg') old_stream, new_stream = self.get_stream_number( filename, ('tags', 'mimetype'), mimetype) if old_stream is not None: options.extend(['-map', '-0:%d' % old_stream]) new_stream -= 1 options.extend([ '-attach', thumbnail_filename, '-metadata:s:%d' % new_stream, 'mimetype=%s' % mimetype, '-metadata:s:%d' % new_stream, 'filename=cover.%s' % thumbnail_ext]) self.to_screen('Adding thumbnail to "%s"' % filename) self.run_ffmpeg(filename, temp_filename, options) elif info['ext'] in ['m4a', 'mp4', 'mov']: try: options = ['-c', 'copy', '-map', '0', '-dn', '-map', '1'] old_stream, new_stream = self.get_stream_number( filename, ('disposition', 'attached_pic'), 1) if old_stream is not None: options.extend(['-map', '-0:%d' % old_stream]) new_stream -= 1 options.extend(['-disposition:%s' % new_stream, 'attached_pic']) self.to_screen('Adding thumbnail to "%s"' % filename) self.run_ffmpeg_multiple_files([filename, thumbnail_filename], temp_filename, options) except PostProcessingError as err: self.report_warning('unable to embed using ffprobe & ffmpeg; %s' % error_to_compat_str(err)) atomicparsley = next(( x for x in ['AtomicParsley', 'atomicparsley'] if check_executable(x, ['-v'])), None) if atomicparsley is None: 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)] cmd += [encodeArgument(o) for o in self._configuration_args('AtomicParsley')] self.to_screen('Adding thumbnail to "%s"' % filename) self.write_debug('AtomicParsley command line: %s' % shell_quote(cmd)) p = subprocess.Popen(cmd, stdout=subprocess.PIPE, stderr=subprocess.PIPE) stdout, stderr = process_communicate_or_kill(p) if p.returncode != 0: msg = stderr.decode('utf-8', 'replace').strip() raise EmbedThumbnailPPError(msg) # for formats that don't support thumbnails (like 3gp) AtomicParsley # won't create to the temporary file if b'No changes' in stdout: self.report_warning('The file format doesn\'t support embedding a thumbnail') success = False elif info['ext'] in ['ogg', 'opus', 'flac']: if not has_mutagen: raise EmbedThumbnailPPError('module mutagen was not found. Please install using `python -m pip install mutagen`') self.to_screen('Adding thumbnail to "%s"' % filename) temp_filename = filename f = {'opus': OggOpus, 'flac': FLAC, 'ogg': OggVorbis}[info['ext']](filename) pic = Picture() pic.mime = 'image/%s' % 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'][-1]) 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() else: raise EmbedThumbnailPPError('Supported filetypes for thumbnail embedding are: mp3, mkv/mka, ogg/opus/flac, m4a/mp4/mov') if success and temp_filename != filename: os.remove(encodeFilename(filename)) os.rename(encodeFilename(temp_filename), encodeFilename(filename)) self.try_utime(filename, mtime, mtime) files_to_delete = [thumbnail_filename] if self._already_have_thumbnail: if original_thumbnail == thumbnail_filename: files_to_delete = [] elif original_thumbnail != thumbnail_filename: files_to_delete.append(original_thumbnail) return files_to_delete, info