]>
jfr.im git - yt-dlp.git/blob - yt_dlp/postprocessor/sponskrub.py
1 from __future__
import unicode_literals
5 from .common
import PostProcessor
6 from ..compat
import compat_shlex_split
20 # Deprecated in favor of the native implementation
21 class SponSkrubPP(PostProcessor
):
23 _exe_name
= 'sponskrub'
25 def __init__(self
, downloader
, path
='', args
=None, ignoreerror
=False, cut
=False, force
=False, _from_cli
=False):
26 PostProcessor
.__init
__(self
, downloader
)
29 self
.args
= str_or_none(args
) or '' # For backward compatibility
30 self
.path
= self
.get_exe(path
)
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')
37 if not ignoreerror
and self
.path
is None:
39 raise PostProcessingError('sponskrub not found in "%s"' % path
)
41 raise PostProcessingError('sponskrub not found. Please install or provide the path using --sponskrub-path')
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']):
50 @PostProcessor._restrict_to(images
=False)
51 def run(self
, information
):
53 return [], information
55 filename
= information
['filepath']
56 if not os
.path
.exists(encodeFilename(filename
)): # no download
57 return [], information
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):
64 'Skipping sponskrub since the video was already downloaded. '
65 'Use --sponskrub-force to run sponskrub anyway')
66 return [], information
68 self
.to_screen('Trying to %s sponsor sections' % ('remove' if self
.cutout
else 'mark'))
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.')
74 temp_filename
= prepend_extension(filename
, self
._temp
_ext
)
75 if os
.path
.exists(encodeFilename(temp_filename
)):
76 os
.remove(encodeFilename(temp_filename
))
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
]
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]
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')
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