]> jfr.im git - yt-dlp.git/blame - youtube_dlc/postprocessor/embedthumbnail.py
Fix for os.rename error when embedding thumbnail to video in a different drive
[yt-dlp.git] / youtube_dlc / postprocessor / embedthumbnail.py
CommitLineData
dcdb292f 1# coding: utf-8
ddbed364 2from __future__ import unicode_literals
3
4
5import os
6import subprocess
7
31fd9c76 8from .ffmpeg import FFmpegPostProcessor
9
ddbed364 10from ..utils import (
11 check_executable,
2cc6d135 12 encodeArgument,
ddbed364 13 encodeFilename,
14 PostProcessingError,
15 prepend_extension,
bff857a8 16 replace_extension,
ddbed364 17 shell_quote
18)
19
20
21class EmbedThumbnailPPError(PostProcessingError):
22 pass
23
24
31fd9c76 25class EmbedThumbnailPP(FFmpegPostProcessor):
8e595397
YCH
26 def __init__(self, downloader=None, already_have_thumbnail=False):
27 super(EmbedThumbnailPP, self).__init__(downloader)
28 self._already_have_thumbnail = already_have_thumbnail
29
ddbed364 30 def run(self, info):
31 filename = info['filepath']
32 temp_filename = prepend_extension(filename, 'temp')
ddbed364 33
8e595397 34 if not info.get('thumbnails'):
b5cbe3d6
AU
35 self._downloader.to_screen('[embedthumbnail] There aren\'t any thumbnails to embed')
36 return [], info
ddbed364 37
8e595397 38 thumbnail_filename = info['thumbnails'][-1]['filename']
ddbed364 39
c33a8639
YCH
40 if not os.path.exists(encodeFilename(thumbnail_filename)):
41 self._downloader.report_warning(
42 'Skipping embedding the thumbnail because the file is missing.')
43 return [], info
44
bff857a8
S
45 def is_webp(path):
46 with open(encodeFilename(path), 'rb') as f:
47 b = f.read(12)
48 return b[0:4] == b'RIFF' and b[8:] == b'WEBP'
49
50 # Correct extension for WebP file with wrong extension (see #25687, #25717)
51 _, thumbnail_ext = os.path.splitext(thumbnail_filename)
52 if thumbnail_ext:
53 thumbnail_ext = thumbnail_ext[1:].lower()
54 if thumbnail_ext != 'webp' and is_webp(thumbnail_filename):
55 self._downloader.to_screen(
56 '[ffmpeg] Correcting extension to webp and escaping path for thumbnail "%s"' % thumbnail_filename)
57 thumbnail_webp_filename = replace_extension(thumbnail_filename, 'webp')
58 os.rename(encodeFilename(thumbnail_filename), encodeFilename(thumbnail_webp_filename))
59 thumbnail_filename = thumbnail_webp_filename
60 thumbnail_ext = 'webp'
61
62 # Convert unsupported thumbnail formats to JPEG (see #25687, #25717)
63 if thumbnail_ext not in ['jpg', 'png']:
64 # NB: % is supposed to be escaped with %% but this does not work
65 # for input files so working around with standard substitution
66 escaped_thumbnail_filename = thumbnail_filename.replace('%', '#')
67 os.rename(encodeFilename(thumbnail_filename), encodeFilename(escaped_thumbnail_filename))
68 escaped_thumbnail_jpg_filename = replace_extension(escaped_thumbnail_filename, 'jpg')
69 self._downloader.to_screen('[ffmpeg] Converting thumbnail "%s" to JPEG' % escaped_thumbnail_filename)
70 self.run_ffmpeg(escaped_thumbnail_filename, escaped_thumbnail_jpg_filename, ['-bsf:v', 'mjpeg2jpeg'])
71 os.remove(encodeFilename(escaped_thumbnail_filename))
72 thumbnail_jpg_filename = replace_extension(thumbnail_filename, 'jpg')
73 # Rename back to unescaped for further processing
74 os.rename(encodeFilename(escaped_thumbnail_jpg_filename), encodeFilename(thumbnail_jpg_filename))
75 thumbnail_filename = thumbnail_jpg_filename
777d5a45 76
8e2915d7 77 if info['ext'] == 'mp3':
92995e62 78 options = [
bb8ca1d1 79 '-c', 'copy', '-map', '0', '-map', '1',
31fd9c76 80 '-metadata:s:v', 'title="Album cover"', '-metadata:s:v', 'comment="Cover (Front)"']
ddbed364 81
82 self._downloader.to_screen('[ffmpeg] Adding thumbnail to "%s"' % filename)
83
bb8ca1d1 84 self.run_ffmpeg_multiple_files([filename, thumbnail_filename], temp_filename, options)
ddbed364 85
8e595397
YCH
86 if not self._already_have_thumbnail:
87 os.remove(encodeFilename(thumbnail_filename))
ddbed364 88 os.remove(encodeFilename(filename))
89 os.rename(encodeFilename(temp_filename), encodeFilename(filename))
90
62566a41 91 elif info['ext'] == 'mkv':
62566a41 92 old_thumbnail_filename = thumbnail_filename
55faba7e 93 thumbnail_filename = os.path.join(os.path.dirname(old_thumbnail_filename), 'cover.jpg')
94 os.remove(encodeFilename(thumbnail_filename))
95 os.rename(encodeFilename(old_thumbnail_filename), encodeFilename(thumbnail_filename))
62566a41 96
97 options = [
98 '-c', 'copy', '-attach', thumbnail_filename, '-metadata:s:t', 'mimetype=image/jpeg']
99
100 self._downloader.to_screen('[ffmpeg] Adding thumbnail to "%s"' % filename)
101
102 self.run_ffmpeg_multiple_files([filename], temp_filename, options)
103
104 if not self._already_have_thumbnail:
105 os.remove(encodeFilename(thumbnail_filename))
106 else:
107 os.rename(encodeFilename(thumbnail_filename), encodeFilename(old_thumbnail_filename))
108 os.remove(encodeFilename(filename))
109 os.rename(encodeFilename(temp_filename), encodeFilename(filename))
110
d6aa68ce 111 elif info['ext'] in ['m4a', 'mp4']:
ddbed364 112 if not check_executable('AtomicParsley', ['-v']):
113 raise EmbedThumbnailPPError('AtomicParsley was not found. Please install.')
114
2cc6d135
YCH
115 cmd = [encodeFilename('AtomicParsley', True),
116 encodeFilename(filename, True),
117 encodeArgument('--artwork'),
118 encodeFilename(thumbnail_filename, True),
119 encodeArgument('-o'),
120 encodeFilename(temp_filename, True)]
ddbed364 121
122 self._downloader.to_screen('[atomicparsley] Adding thumbnail to "%s"' % filename)
123
124 if self._downloader.params.get('verbose', False):
125 self._downloader.to_screen('[debug] AtomicParsley command line: %s' % shell_quote(cmd))
126
127 p = subprocess.Popen(cmd, stdout=subprocess.PIPE, stderr=subprocess.PIPE)
128 stdout, stderr = p.communicate()
129
130 if p.returncode != 0:
131 msg = stderr.decode('utf-8', 'replace').strip()
132 raise EmbedThumbnailPPError(msg)
133
8e595397
YCH
134 if not self._already_have_thumbnail:
135 os.remove(encodeFilename(thumbnail_filename))
ddbed364 136 # for formats that don't support thumbnails (like 3gp) AtomicParsley
137 # won't create to the temporary file
138 if b'No changes' in stdout:
139 self._downloader.report_warning('The file format doesn\'t support embedding a thumbnail')
140 else:
141 os.remove(encodeFilename(filename))
142 os.rename(encodeFilename(temp_filename), encodeFilename(filename))
143 else:
d6aa68ce 144 raise EmbedThumbnailPPError('Only mp3 and m4a/mp4 are supported for thumbnail embedding for now.')
ddbed364 145
146 return [], info