]>
Commit | Line | Data |
---|---|---|
dcdb292f | 1 | # coding: utf-8 |
ddbed364 | 2 | from __future__ import unicode_literals |
3 | ||
4 | ||
5 | import os | |
6 | import subprocess | |
06167fbb | 7 | import struct |
8 | import re | |
9 | import base64 | |
10 | ||
11 | try: | |
12 | import mutagen | |
06ff212d | 13 | has_mutagen = True |
06167fbb | 14 | except ImportError: |
06ff212d | 15 | has_mutagen = False |
ddbed364 | 16 | |
31fd9c76 | 17 | from .ffmpeg import FFmpegPostProcessor |
18 | ||
ddbed364 | 19 | from ..utils import ( |
20 | check_executable, | |
2cc6d135 | 21 | encodeArgument, |
ddbed364 | 22 | encodeFilename, |
06167fbb | 23 | error_to_compat_str, |
ddbed364 | 24 | PostProcessingError, |
25 | prepend_extension, | |
06167fbb | 26 | process_communicate_or_kill, |
bff857a8 | 27 | replace_extension, |
f5b1bca9 | 28 | shell_quote, |
ddbed364 | 29 | ) |
30 | ||
31 | ||
32 | class EmbedThumbnailPPError(PostProcessingError): | |
33 | pass | |
34 | ||
35 | ||
31fd9c76 | 36 | class EmbedThumbnailPP(FFmpegPostProcessor): |
1b77b347 | 37 | |
8e595397 YCH |
38 | def __init__(self, downloader=None, already_have_thumbnail=False): |
39 | super(EmbedThumbnailPP, self).__init__(downloader) | |
40 | self._already_have_thumbnail = already_have_thumbnail | |
41 | ||
ddbed364 | 42 | def run(self, info): |
43 | filename = info['filepath'] | |
44 | temp_filename = prepend_extension(filename, 'temp') | |
ddbed364 | 45 | |
8e595397 | 46 | if not info.get('thumbnails'): |
1b77b347 | 47 | self.to_screen('There aren\'t any thumbnails to embed') |
b5cbe3d6 | 48 | return [], info |
ddbed364 | 49 | |
2e339f59 | 50 | original_thumbnail = thumbnail_filename = info['thumbnails'][-1]['filename'] |
ddbed364 | 51 | |
c33a8639 | 52 | if not os.path.exists(encodeFilename(thumbnail_filename)): |
f446cc66 | 53 | self.report_warning('Skipping embedding the thumbnail because the file is missing.') |
c33a8639 YCH |
54 | return [], info |
55 | ||
bff857a8 S |
56 | def is_webp(path): |
57 | with open(encodeFilename(path), 'rb') as f: | |
58 | b = f.read(12) | |
59 | return b[0:4] == b'RIFF' and b[8:] == b'WEBP' | |
60 | ||
61 | # Correct extension for WebP file with wrong extension (see #25687, #25717) | |
62 | _, thumbnail_ext = os.path.splitext(thumbnail_filename) | |
63 | if thumbnail_ext: | |
64 | thumbnail_ext = thumbnail_ext[1:].lower() | |
65 | if thumbnail_ext != 'webp' and is_webp(thumbnail_filename): | |
1b77b347 | 66 | self.to_screen('Correcting extension to webp and escaping path for thumbnail "%s"' % thumbnail_filename) |
bff857a8 S |
67 | thumbnail_webp_filename = replace_extension(thumbnail_filename, 'webp') |
68 | os.rename(encodeFilename(thumbnail_filename), encodeFilename(thumbnail_webp_filename)) | |
2e339f59 | 69 | original_thumbnail = thumbnail_filename = thumbnail_webp_filename |
bff857a8 S |
70 | thumbnail_ext = 'webp' |
71 | ||
72 | # Convert unsupported thumbnail formats to JPEG (see #25687, #25717) | |
73 | if thumbnail_ext not in ['jpg', 'png']: | |
74 | # NB: % is supposed to be escaped with %% but this does not work | |
75 | # for input files so working around with standard substitution | |
76 | escaped_thumbnail_filename = thumbnail_filename.replace('%', '#') | |
77 | os.rename(encodeFilename(thumbnail_filename), encodeFilename(escaped_thumbnail_filename)) | |
78 | escaped_thumbnail_jpg_filename = replace_extension(escaped_thumbnail_filename, 'jpg') | |
1b77b347 | 79 | self.to_screen('Converting thumbnail "%s" to JPEG' % escaped_thumbnail_filename) |
bff857a8 | 80 | self.run_ffmpeg(escaped_thumbnail_filename, escaped_thumbnail_jpg_filename, ['-bsf:v', 'mjpeg2jpeg']) |
bff857a8 S |
81 | thumbnail_jpg_filename = replace_extension(thumbnail_filename, 'jpg') |
82 | # Rename back to unescaped for further processing | |
2e339f59 | 83 | os.rename(encodeFilename(escaped_thumbnail_filename), encodeFilename(thumbnail_filename)) |
bff857a8 S |
84 | os.rename(encodeFilename(escaped_thumbnail_jpg_filename), encodeFilename(thumbnail_jpg_filename)) |
85 | thumbnail_filename = thumbnail_jpg_filename | |
06167fbb | 86 | thumbnail_ext = 'jpg' |
777d5a45 | 87 | |
67002a5a | 88 | success = True |
8e2915d7 | 89 | if info['ext'] == 'mp3': |
92995e62 | 90 | options = [ |
c76eb41b | 91 | '-c', 'copy', '-map', '0:0', '-map', '1:0', '-id3v2_version', '3', |
e51f368c | 92 | '-metadata:s:v', 'title="Album cover"', '-metadata:s:v', 'comment="Cover (front)"'] |
ddbed364 | 93 | |
1b77b347 | 94 | self.to_screen('Adding thumbnail to "%s"' % filename) |
bb8ca1d1 | 95 | self.run_ffmpeg_multiple_files([filename, thumbnail_filename], temp_filename, options) |
ddbed364 | 96 | |
06167fbb | 97 | elif info['ext'] in ['mkv', 'mka']: |
98 | options = ['-c', 'copy', '-map', '0', '-dn'] | |
ddbed364 | 99 | |
06167fbb | 100 | mimetype = 'image/%s' % ('png' if thumbnail_ext == 'png' else 'jpeg') |
101 | old_stream, new_stream = self.get_stream_number( | |
102 | filename, ('tags', 'mimetype'), mimetype) | |
103 | if old_stream is not None: | |
104 | options.extend(['-map', '-0:%d' % old_stream]) | |
105 | new_stream -= 1 | |
106 | options.extend([ | |
107 | '-attach', thumbnail_filename, | |
108 | '-metadata:s:%d' % new_stream, 'mimetype=%s' % mimetype, | |
109 | '-metadata:s:%d' % new_stream, 'filename=cover.%s' % thumbnail_ext]) | |
ddbed364 | 110 | |
1b77b347 | 111 | self.to_screen('Adding thumbnail to "%s"' % filename) |
06167fbb | 112 | self.run_ffmpeg(filename, temp_filename, options) |
113 | ||
114 | elif info['ext'] in ['m4a', 'mp4', 'mov']: | |
115 | try: | |
116 | options = ['-c', 'copy', '-map', '0', '-dn', '-map', '1'] | |
117 | ||
118 | old_stream, new_stream = self.get_stream_number( | |
119 | filename, ('disposition', 'attached_pic'), 1) | |
120 | if old_stream is not None: | |
121 | options.extend(['-map', '-0:%d' % old_stream]) | |
122 | new_stream -= 1 | |
123 | options.extend(['-disposition:%s' % new_stream, 'attached_pic']) | |
124 | ||
125 | self.to_screen('Adding thumbnail to "%s"' % filename) | |
126 | self.run_ffmpeg_multiple_files([filename, thumbnail_filename], temp_filename, options) | |
127 | ||
128 | except PostProcessingError as err: | |
129 | self.report_warning('unable to embed using ffprobe & ffmpeg; %s' % error_to_compat_str(err)) | |
bc2ca1bb | 130 | atomicparsley = next(( |
131 | x for x in ['AtomicParsley', 'atomicparsley'] | |
132 | if check_executable(x, ['-v'])), None) | |
133 | if atomicparsley is None: | |
06167fbb | 134 | raise EmbedThumbnailPPError('AtomicParsley was not found. Please install.') |
135 | ||
bc2ca1bb | 136 | cmd = [encodeFilename(atomicparsley, True), |
06167fbb | 137 | encodeFilename(filename, True), |
138 | encodeArgument('--artwork'), | |
139 | encodeFilename(thumbnail_filename, True), | |
140 | encodeArgument('-o'), | |
141 | encodeFilename(temp_filename, True)] | |
142 | cmd += [encodeArgument(o) for o in self._configuration_args(exe='AtomicParsley')] | |
143 | ||
144 | self.to_screen('Adding thumbnail to "%s"' % filename) | |
145 | self.write_debug('AtomicParsley command line: %s' % shell_quote(cmd)) | |
146 | p = subprocess.Popen(cmd, stdout=subprocess.PIPE, stderr=subprocess.PIPE) | |
147 | stdout, stderr = process_communicate_or_kill(p) | |
148 | if p.returncode != 0: | |
149 | msg = stderr.decode('utf-8', 'replace').strip() | |
150 | raise EmbedThumbnailPPError(msg) | |
151 | # for formats that don't support thumbnails (like 3gp) AtomicParsley | |
152 | # won't create to the temporary file | |
153 | if b'No changes' in stdout: | |
154 | self.report_warning('The file format doesn\'t support embedding a thumbnail') | |
155 | success = False | |
156 | ||
157 | elif info['ext'] in ['ogg', 'opus']: | |
06ff212d | 158 | if not has_mutagen: |
e38df8f9 | 159 | raise EmbedThumbnailPPError('module mutagen was not found. Please install using `python -m pip install mutagen`') |
e3b771a8 | 160 | self.to_screen('Adding thumbnail to "%s"' % filename) |
161 | ||
06167fbb | 162 | size_regex = r',\s*(?P<w>\d+)x(?P<h>\d+)\s*[,\[]' |
ece8a2a1 | 163 | size_result = self.run_ffmpeg(thumbnail_filename, thumbnail_filename, ['-hide_banner']) |
06167fbb | 164 | mobj = re.search(size_regex, size_result) |
165 | width, height = int(mobj.group('w')), int(mobj.group('h')) | |
166 | mimetype = ('image/%s' % ('png' if thumbnail_ext == 'png' else 'jpeg')).encode('ascii') | |
167 | ||
168 | # https://xiph.org/flac/format.html#metadata_block_picture | |
169 | data = bytearray() | |
170 | data += struct.pack('>II', 3, len(mimetype)) | |
171 | data += mimetype | |
172 | data += struct.pack('>IIIIII', 0, width, height, 8, 0, os.stat(thumbnail_filename).st_size) # 32 if png else 24 | |
173 | ||
174 | fin = open(thumbnail_filename, "rb") | |
175 | data += fin.read() | |
176 | fin.close() | |
177 | ||
178 | temp_filename = filename | |
179 | f = mutagen.File(temp_filename) | |
180 | f.tags['METADATA_BLOCK_PICTURE'] = base64.b64encode(data).decode('ascii') | |
181 | f.save() | |
67002a5a | 182 | |
ddbed364 | 183 | else: |
06167fbb | 184 | raise EmbedThumbnailPPError('Supported filetypes for thumbnail embedding are: mp3, mkv/mka, ogg/opus, m4a/mp4/mov') |
ddbed364 | 185 | |
06167fbb | 186 | if success and temp_filename != filename: |
67002a5a | 187 | os.remove(encodeFilename(filename)) |
188 | os.rename(encodeFilename(temp_filename), encodeFilename(filename)) | |
2e339f59 | 189 | |
190 | files_to_delete = [thumbnail_filename] | |
de6000d9 | 191 | if self._already_have_thumbnail: |
2e339f59 | 192 | info['__files_to_move'][original_thumbnail] = replace_extension( |
193 | info['__thumbnail_filename'], os.path.splitext(original_thumbnail)[1][1:]) | |
194 | if original_thumbnail == thumbnail_filename: | |
195 | files_to_delete = [] | |
67002a5a | 196 | return files_to_delete, info |