]>
Commit | Line | Data |
---|---|---|
1 | from __future__ import unicode_literals | |
2 | import os | |
3 | import subprocess | |
4 | ||
5 | from .common import PostProcessor | |
6 | from ..compat import compat_shlex_split | |
7 | from ..utils import ( | |
8 | check_executable, | |
9 | cli_option, | |
10 | encodeArgument, | |
11 | encodeFilename, | |
12 | shell_quote, | |
13 | str_or_none, | |
14 | Popen, | |
15 | PostProcessingError, | |
16 | prepend_extension, | |
17 | ) | |
18 | ||
19 | ||
20 | # Deprecated in favor of the native implementation | |
21 | class SponSkrubPP(PostProcessor): | |
22 | _temp_ext = 'spons' | |
23 | _exe_name = 'sponskrub' | |
24 | ||
25 | def __init__(self, downloader, path='', args=None, ignoreerror=False, cut=False, force=False, _from_cli=False): | |
26 | PostProcessor.__init__(self, downloader) | |
27 | self.force = force | |
28 | self.cutout = cut | |
29 | self.args = str_or_none(args) or '' # For backward compatibility | |
30 | self.path = self.get_exe(path) | |
31 | ||
32 | if not _from_cli: | |
33 | self.deprecation_warning( | |
34 | 'yt_dlp.postprocessor.SponSkrubPP support is deprecated and may be removed in a future version. ' | |
35 | 'Use yt_dlp.postprocessor.SponsorBlock and yt_dlp.postprocessor.ModifyChaptersPP instead') | |
36 | ||
37 | if not ignoreerror and self.path is None: | |
38 | if path: | |
39 | raise PostProcessingError('sponskrub not found in "%s"' % path) | |
40 | else: | |
41 | raise PostProcessingError('sponskrub not found. Please install or provide the path using --sponskrub-path') | |
42 | ||
43 | def get_exe(self, path=''): | |
44 | if not path or not check_executable(path, ['-h']): | |
45 | path = os.path.join(path, self._exe_name) | |
46 | if not check_executable(path, ['-h']): | |
47 | return None | |
48 | return path | |
49 | ||
50 | @PostProcessor._restrict_to(images=False) | |
51 | def run(self, information): | |
52 | if self.path is None: | |
53 | return [], information | |
54 | ||
55 | filename = information['filepath'] | |
56 | if not os.path.exists(encodeFilename(filename)): # no download | |
57 | return [], information | |
58 | ||
59 | if information['extractor_key'].lower() != 'youtube': | |
60 | self.to_screen('Skipping sponskrub since it is not a YouTube video') | |
61 | return [], information | |
62 | if self.cutout and not self.force and not information.get('__real_download', False): | |
63 | self.report_warning( | |
64 | 'Skipping sponskrub since the video was already downloaded. ' | |
65 | 'Use --sponskrub-force to run sponskrub anyway') | |
66 | return [], information | |
67 | ||
68 | self.to_screen('Trying to %s sponsor sections' % ('remove' if self.cutout else 'mark')) | |
69 | if self.cutout: | |
70 | self.report_warning('Cutting out sponsor segments will cause the subtitles to go out of sync.') | |
71 | if not information.get('__real_download', False): | |
72 | self.report_warning('If sponskrub is run multiple times, unintended parts of the video could be cut out.') | |
73 | ||
74 | temp_filename = prepend_extension(filename, self._temp_ext) | |
75 | if os.path.exists(encodeFilename(temp_filename)): | |
76 | os.remove(encodeFilename(temp_filename)) | |
77 | ||
78 | cmd = [self.path] | |
79 | if not self.cutout: | |
80 | cmd += ['-chapter'] | |
81 | cmd += cli_option(self._downloader.params, '-proxy', 'proxy') | |
82 | cmd += compat_shlex_split(self.args) # For backward compatibility | |
83 | cmd += self._configuration_args(self._exe_name, use_compat=False) | |
84 | cmd += ['--', information['id'], filename, temp_filename] | |
85 | cmd = [encodeArgument(i) for i in cmd] | |
86 | ||
87 | self.write_debug('sponskrub command line: %s' % shell_quote(cmd)) | |
88 | pipe = None if self.get_param('verbose') else subprocess.PIPE | |
89 | p = Popen(cmd, stdout=pipe) | |
90 | stdout = p.communicate_or_kill()[0] | |
91 | ||
92 | if p.returncode == 0: | |
93 | os.replace(temp_filename, filename) | |
94 | self.to_screen('Sponsor sections have been %s' % ('removed' if self.cutout else 'marked')) | |
95 | elif p.returncode == 3: | |
96 | self.to_screen('No segments in the SponsorBlock database') | |
97 | else: | |
98 | msg = stdout.decode('utf-8', 'replace').strip() if stdout else '' | |
99 | msg = msg.split('\n')[0 if msg.lower().startswith('unrecognised') else -1] | |
100 | raise PostProcessingError(msg if msg else 'sponskrub failed with error code %s' % p.returncode) | |
101 | return [], information |