/
context.py
699 lines (595 loc) · 32.6 KB
/
context.py
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
# -*- coding: utf-8 -*-
#
# PySceneDetect: Python-Based Video Scene Detector
# ---------------------------------------------------------------
# [ Site: http://www.bcastell.com/projects/PySceneDetect/ ]
# [ Github: https://github.com/Breakthrough/PySceneDetect/ ]
# [ Documentation: http://pyscenedetect.readthedocs.org/ ]
#
# Copyright (C) 2014-2019 Brandon Castellano <http://www.bcastell.com>.
#
# PySceneDetect is licensed under the BSD 3-Clause License; see the included
# LICENSE file, or visit one of the following pages for details:
# - https://github.com/Breakthrough/PySceneDetect/
# - http://www.bcastell.com/projects/PySceneDetect/
#
# This software uses Numpy, OpenCV, click, tqdm, simpletable, and pytest.
# See the included LICENSE files or one of the above URLs for more information.
#
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
# AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
# ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
# WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
#
""" PySceneDetect scenedetect.cli.context Module
This file contains the implementation of the PySceneDetect command-line
interface (CLI) context class CliContext, used for the main application
state/context and logic to run the PySceneDetect CLI.
"""
# Standard Library Imports
from __future__ import print_function
import logging
import os
import time
import math
from string import Template
import numpy as np
# Third-Party Library Imports
import click
import cv2
from scenedetect.platform import tqdm
from scenedetect.platform import get_and_create_path
# PySceneDetect Library Imports
import scenedetect.detectors
from scenedetect.scene_manager import SceneManager
from scenedetect.scene_manager import write_scene_list
from scenedetect.scene_manager import write_scene_list_html
from scenedetect.stats_manager import StatsManager
from scenedetect.stats_manager import StatsFileCorrupt
from scenedetect.stats_manager import StatsFileFramerateMismatch
from scenedetect.video_manager import VideoManager
from scenedetect.video_manager import VideoOpenFailure
from scenedetect.video_manager import VideoFramerateUnavailable
from scenedetect.video_manager import VideoParameterMismatch
from scenedetect.video_manager import InvalidDownscaleFactor
from scenedetect.video_splitter import is_mkvmerge_available
from scenedetect.video_splitter import is_ffmpeg_available
from scenedetect.video_splitter import split_video_mkvmerge
from scenedetect.video_splitter import split_video_ffmpeg
from scenedetect.platform import get_cv2_imwrite_params
from scenedetect.platform import check_opencv_ffmpeg_dll
from scenedetect.frame_timecode import FrameTimecode
def get_plural(val_list):
""" Get Plural: Helper function to return 's' if a list has more than one (1)
element, otherwise returns ''.
Returns:
str: String of 's' if the length of val_list is greater than 1, otherwise ''.
"""
return 's' if len(val_list) > 1 else ''
class CliContext(object):
""" Context of the command-line interface passed between the various sub-commands.
Pools all options, processing the main program options as they come in (e.g. those
not passed to a command), followed by parsing each sub-command's options, preparing
the actions to be executed in the process_input() method, which is called after the
whole command line has been processed (successfully nor not).
This class and the cli.__init__ module make up the bulk of the PySceneDetect
application logic for the command line.
"""
def __init__(self):
# Properties for main scenedetect command options (-i, -s, etc...) and CliContext logic.
self.options_processed = False # True when CLI option parsing is complete.
self.scene_manager = None # detect-content, detect-threshold, etc...
self.video_manager = None # -i/--input, -d/--downscale
self.base_timecode = None # -f/--framerate
self.start_frame = 0 # time -s/--start
self.stats_manager = None # -s/--stats
self.stats_file_path = None # -s/--stats
self.output_directory = None # -o/--output
self.quiet_mode = False # -q/--quiet or -v/--verbosity quiet
self.frame_skip = 0 # -fs/--frame-skip
# Properties for save-images command.
self.save_images = False # save-images command
self.image_extension = 'jpg' # save-images -j/--jpeg, -w/--webp, -p/--png
self.image_directory = None # save-images -o/--output
self.image_param = None # save-images -q/--quality if -j/-w,
# -c/--compression if -p
self.image_name_format = ( # save-images -f/--name-format
'$VIDEO_NAME-Scene-$SCENE_NUMBER-$IMAGE_NUMBER')
self.num_images = 2 # save-images -n/--num-images
self.imwrite_params = get_cv2_imwrite_params()
# Properties for split-video command.
self.split_video = False # split-video command
self.split_mkvmerge = False # split-video -c/--copy
self.split_args = None # split-video -a/--override-args
self.split_directory = None # split-video -o/--output
self.split_name_format = '$VIDEO_NAME-Scene-$SCENE_NUMBER' # split-video -f/--filename
self.split_quiet = False # split-video -q/--quiet
# Properties for list-scenes command.
self.list_scenes = False # list-scenes command
self.print_scene_list = False # list-scenes --quiet/-q
self.scene_list_directory = None # list-scenes -o/--output
self.scene_list_name_format = None # list-scenes -f/--filename
self.scene_list_output = False # list-scenes -n/--no-output
self.export_html = False # export-html command
self.html_name_format = None # export-html -f/--filename
self.html_include_images = True # export-html --no-images
self.image_filenames = None # export-html used for embedding images
self.image_width = None # export-html -w/--image-width
self.image_height = None # export-html -h/--image-height
def cleanup(self):
# type: () -> None
""" Cleanup: Releases all resources acquired by the CliContext (esp. the VideoManager). """
try:
logging.debug('Cleaning up...\n\n')
finally:
if self.video_manager is not None:
self.video_manager.release()
# TODO: Replace with scenedetect.scene_manager.save_images
def _generate_images(self, scene_list, video_name,
image_name_template='$VIDEO_NAME-Scene-$SCENE_NUMBER-$IMAGE_NUMBER',
output_dir=None):
# type: (List[Tuple[FrameTimecode, FrameTimecode]) -> None
if not scene_list:
return
if not self.options_processed:
return
if self.num_images <= 0:
raise ValueError()
self.check_input_open()
imwrite_param = []
if self.image_param is not None:
imwrite_param = [self.imwrite_params[self.image_extension], self.image_param]
# Reset video manager and downscale factor.
self.video_manager.release()
self.video_manager.reset()
self.video_manager.set_downscale_factor(1)
self.video_manager.start()
# Setup flags and init progress bar if available.
completed = True
logging.info('Generating output images (%d per scene)...', self.num_images)
progress_bar = None
if tqdm and not self.quiet_mode:
progress_bar = tqdm(
total=len(scene_list) * self.num_images, unit='images')
filename_template = Template(image_name_template)
scene_num_format = '%0'
scene_num_format += str(max(3, math.floor(math.log(len(scene_list), 10)) + 1)) + 'd'
image_num_format = '%0'
image_num_format += str(math.floor(math.log(self.num_images, 10)) + 2) + 'd'
timecode_list = dict()
fps = scene_list[0][0].framerate
timecode_list = [
[
FrameTimecode(int(f), fps=fps) for f in [
# middle frames
a[len(a)//2] if (0 < j < self.num_images-1) or self.num_images == 1
# first frame
else min(a[0] + self.image_frame_margin, a[-1]) if j == 0
# last frame
else max(a[-1] - self.image_frame_margin, a[0])
# for each evenly-split array of frames in the scene list
for j, a in enumerate(np.array_split(r, self.num_images))
]
]
# create range of frames in scene
for i, r in enumerate(
range(start.get_frames(), end.get_frames())
# for each scene in scene list
for start, end in scene_list)
]
self.image_filenames = { i: [] for i in range(len(timecode_list)) }
for i, tl in enumerate(timecode_list):
for j, image_timecode in enumerate(tl):
self.video_manager.seek(image_timecode)
self.video_manager.grab()
ret_val, frame_im = self.video_manager.retrieve()
if ret_val:
file_path = '%s.%s' % (filename_template.safe_substitute(
VIDEO_NAME=video_name,
SCENE_NUMBER=scene_num_format % (i + 1),
IMAGE_NUMBER=image_num_format % (j + 1),
FRAME_NUMBER=image_timecode.get_frames()),
self.image_extension)
self.image_filenames[i].append(file_path)
cv2.imwrite(
get_and_create_path(
file_path,
output_dir if output_dir is not None else self.output_directory),
frame_im, imwrite_param)
else:
completed = False
break
if progress_bar:
progress_bar.update(1)
if not completed:
logging.error('Could not generate all output images.')
def _open_stats_file(self):
if self.stats_manager is None:
self.stats_manager = StatsManager()
if self.stats_file_path is not None:
if os.path.exists(self.stats_file_path):
logging.info('Loading frame metrics from stats file: %s',
os.path.basename(self.stats_file_path))
try:
with open(self.stats_file_path, 'rt') as stats_file:
self.stats_manager.load_from_csv(stats_file, self.base_timecode)
except StatsFileCorrupt:
error_strs = [
'Could not load stats file.', 'Failed to parse stats file:',
'Could not load frame metrics from stats file - file is corrupt or not a'
' valid PySceneDetect stats file. If the file exists, ensure that it is'
' a valid stats file CSV, otherwise delete it and run PySceneDetect again'
' to re-generate the stats file.']
logging.error('\n'.join(error_strs))
raise click.BadParameter(
'\n Could not load given stats file, see above output for details.',
param_hint='input stats file')
except StatsFileFramerateMismatch as ex:
error_strs = [
'could not load stats file.', 'Failed to parse stats file:',
'Framerate differs between stats file (%.2f FPS) and input'
' video%s (%.2f FPS)' % (
ex.stats_file_fps,
's' if self.video_manager.get_num_videos() > 1 else '',
ex.base_timecode_fps),
'Ensure the correct stats file path was given, or delete and re-generate'
' the stats file.']
logging.error('\n'.join(error_strs))
raise click.BadParameter(
'framerate differs between given stats file and input video(s).',
param_hint='input stats file')
def process_input(self):
# type: () -> None
""" Process Input: Processes input video(s) and generates output as per CLI commands.
Run after all command line options/sub-commands have been parsed.
"""
logging.debug('Processing input...')
if not self.options_processed:
logging.debug('Skipping processing, CLI options were not parsed successfully.')
return
self.check_input_open()
if not self.scene_manager.get_num_detectors() > 0:
logging.error(
'No scene detectors specified (detect-content, detect-threshold, etc...),\n'
' or failed to process all command line arguments.')
return
# Handle scene detection commands (detect-content, detect-threshold, etc...).
self.video_manager.start()
base_timecode = self.video_manager.get_base_timecode()
start_time = time.time()
logging.info('Detecting scenes...')
num_frames = self.scene_manager.detect_scenes(
frame_source=self.video_manager, frame_skip=self.frame_skip,
show_progress=not self.quiet_mode)
duration = time.time() - start_time
logging.info('Processed %d frames in %.1f seconds (average %.2f FPS).',
num_frames, duration, float(num_frames)/duration)
# Handle -s/--statsfile option.
if self.stats_file_path is not None:
if self.stats_manager.is_save_required():
with open(self.stats_file_path, 'wt') as stats_file:
logging.info('Saving frame metrics to stats file: %s',
os.path.basename(self.stats_file_path))
self.stats_manager.save_to_csv(
stats_file, base_timecode)
else:
logging.debug('No frame metrics updated, skipping update of the stats file.')
# Get list of detected cuts and scenes from the SceneManager to generate the required output
# files with based on the given commands (list-scenes, split-video, save-images, etc...).
cut_list = self.scene_manager.get_cut_list(base_timecode)
scene_list = self.scene_manager.get_scene_list(base_timecode)
video_paths = self.video_manager.get_video_paths()
video_name = os.path.basename(video_paths[0])
if video_name.rfind('.') >= 0:
video_name = video_name[:video_name.rfind('.')]
# Ensure we don't divide by zero.
if scene_list:
logging.info('Detected %d scenes, average shot length %.1f seconds.',
len(scene_list),
sum([(end_time - start_time).get_seconds()
for start_time, end_time in scene_list]) / float(len(scene_list)))
else:
logging.info('No scenes detected.')
# Handle list-scenes command.
if self.scene_list_output:
scene_list_filename = Template(self.scene_list_name_format).safe_substitute(
VIDEO_NAME=video_name)
if not scene_list_filename.lower().endswith('.csv'):
scene_list_filename += '.csv'
scene_list_path = get_and_create_path(
scene_list_filename,
self.scene_list_directory if self.scene_list_directory is not None
else self.output_directory)
logging.info('Writing scene list to CSV file:\n %s', scene_list_path)
with open(scene_list_path, 'wt') as scene_list_file:
write_scene_list(scene_list_file, scene_list, cut_list)
# Handle `list-scenes`.
if self.print_scene_list:
logging.info("""Scene List:
-----------------------------------------------------------------------
| Scene # | Start Frame | Start Time | End Frame | End Time |
-----------------------------------------------------------------------
%s
-----------------------------------------------------------------------
""", '\n'.join(
[' | %5d | %11d | %s | %11d | %s |' % (
i+1,
start_time.get_frames(), start_time.get_timecode(),
end_time.get_frames(), end_time.get_timecode())
for i, (start_time, end_time) in enumerate(scene_list)]))
if cut_list:
logging.info('Comma-separated timecode list:\n %s',
','.join([cut.get_timecode() for cut in cut_list]))
# Handle save-images command.
if self.save_images:
self._generate_images(scene_list=scene_list, video_name=video_name,
image_name_template=self.image_name_format,
output_dir=self.image_directory)
# Handle export-html command.
if self.export_html:
html_filename = Template(self.html_name_format).safe_substitute(
VIDEO_NAME=video_name)
if not html_filename.lower().endswith('.html'):
html_filename += '.html'
html_path = get_and_create_path(
html_filename,
self.image_directory if self.image_directory is not None
else self.output_directory)
logging.info('Exporting to html file:\n %s:', html_path)
if not self.html_include_images:
self.image_filenames = None
write_scene_list_html(html_path, scene_list, cut_list,
image_filenames=self.image_filenames,
image_width=self.image_width,
image_height=self.image_height)
# Handle split-video command.
if self.split_video:
# Add proper extension to filename template if required.
dot_pos = self.split_name_format.rfind('.')
if self.split_mkvmerge and not self.split_name_format.endswith('.mkv'):
self.split_name_format += '.mkv'
# Don't add if we find an extension between 2 and 4 characters
elif not (dot_pos >= 0) or (
dot_pos >= 0 and not
((len(self.split_name_format) - (dot_pos+1) <= 4 >= 2))):
self.split_name_format += '.mp4'
output_file_prefix = get_and_create_path(
self.split_name_format,
self.split_directory if self.split_directory is not None
else self.output_directory)
mkvmerge_available = is_mkvmerge_available()
ffmpeg_available = is_ffmpeg_available()
if mkvmerge_available and (self.split_mkvmerge or not ffmpeg_available):
if not self.split_mkvmerge:
logging.warning(
'ffmpeg not found, falling back to fast copy mode (split-video -c/--copy).')
split_video_mkvmerge(video_paths, scene_list, output_file_prefix, video_name,
suppress_output=self.quiet_mode or self.split_quiet)
elif ffmpeg_available:
if self.split_mkvmerge:
logging.warning('mkvmerge not found, falling back to normal splitting'
' mode (split-video).')
split_video_ffmpeg(video_paths, scene_list, output_file_prefix,
video_name, arg_override=self.split_args,
hide_progress=self.quiet_mode,
suppress_output=self.quiet_mode or self.split_quiet)
else:
if not (mkvmerge_available or ffmpeg_available):
error_strs = ["ffmpeg/mkvmerge is required for split-video [-c/--copy]."]
else:
error_strs = [
"{EXTERN_TOOL} is required for split-video{EXTRA_ARGS}.".format(
EXTERN_TOOL='mkvmerge' if self.split_mkvmerge else 'ffmpeg',
EXTRA_ARGS=' -c/--copy' if self.split_mkvmerge else '')]
error_strs += ["Install one of the above tools to enable the split-video command."]
error_str = '\n'.join(error_strs)
logging.debug(error_str)
raise click.BadParameter(error_str, param_hint='split-video')
if scene_list:
logging.info('Video splitting completed, individual scenes written to disk.')
def check_input_open(self):
# type: () -> None
""" Check Input Open: Ensures that the CliContext's VideoManager was initialized,
started, and at *least* one input video was successfully opened - otherwise, an
exception is raised.
Raises:
click.BadParameter
"""
if self.video_manager is None or not self.video_manager.get_num_videos() > 0:
error_strs = ["No input video(s) specified.",
"Make sure '--input VIDEO' is specified at the start of the command."]
error_str = '\n'.join(error_strs)
logging.debug(error_str)
raise click.BadParameter(error_str, param_hint='input video')
def add_detector(self, detector):
""" Add Detector: Adds a detection algorithm to the CliContext's SceneManager. """
self.check_input_open()
options_processed_orig = self.options_processed
self.options_processed = False
try:
self.scene_manager.add_detector(detector)
except scenedetect.stats_manager.FrameMetricRegistered:
raise click.BadParameter(message='Cannot specify detection algorithm twice.',
param_hint=detector.cli_name)
self.options_processed = options_processed_orig
def _init_video_manager(self, input_list, framerate, downscale):
self.base_timecode = None
logging.debug('Initializing VideoManager.')
video_manager_initialized = False
try:
self.video_manager = VideoManager(
video_files=input_list, framerate=framerate, logger=logging)
video_manager_initialized = True
self.base_timecode = self.video_manager.get_base_timecode()
self.video_manager.set_downscale_factor(downscale)
except VideoOpenFailure as ex:
error_strs = [
'could not open video%s.' % get_plural(ex.file_list),
'Failed to open the following video file%s:' % get_plural(ex.file_list)]
error_strs += [' %s' % file_name[0] for file_name in ex.file_list]
dll_okay, dll_name = check_opencv_ffmpeg_dll()
if not dll_okay:
error_strs += [
'Error: OpenCV dependency %s not found.' % dll_name,
'Ensure that you installed the Python OpenCV module, and that the',
'%s file can be found to enable video support.' % dll_name]
logging.debug('\n'.join(error_strs[1:]))
if not dll_okay:
click.echo(click.style(
'\nOpenCV dependency missing, video input/decoding not available.\n', fg='red'))
raise click.BadParameter('\n'.join(error_strs), param_hint='input video')
except VideoFramerateUnavailable as ex:
error_strs = ['could not get framerate from video(s)',
'Failed to obtain framerate for video file %s.' % ex.file_name]
error_strs.append('Specify framerate manually with the -f / --framerate option.')
logging.debug('\n'.join(error_strs))
raise click.BadParameter('\n'.join(error_strs), param_hint='input video')
except VideoParameterMismatch as ex:
error_strs = ['video parameters do not match.', 'List of mismatched parameters:']
for param in ex.file_list:
if param[0] == cv2.CAP_PROP_FPS:
param_name = 'FPS'
if param[0] == cv2.CAP_PROP_FRAME_WIDTH:
param_name = 'Frame width'
if param[0] == cv2.CAP_PROP_FRAME_HEIGHT:
param_name = 'Frame height'
error_strs.append(' %s mismatch in video %s (got %.2f, expected %.2f)' % (
param_name, param[3], param[1], param[2]))
error_strs.append(
'Multiple videos may only be specified if they have the same framerate and'
' resolution. -f / --framerate may be specified to override the framerate.')
logging.debug('\n'.join(error_strs))
raise click.BadParameter('\n'.join(error_strs), param_hint='input videos')
except InvalidDownscaleFactor as ex:
error_strs = ['Downscale value is not > 0.', str(ex)]
logging.debug('\n'.join(error_strs))
raise click.BadParameter('\n'.join(error_strs), param_hint='downscale factor')
return video_manager_initialized
def parse_options(self, input_list, framerate, stats_file, downscale, frame_skip):
# type: (List[str], float, str, int, int) -> None
""" Parse Options: Parses all global options/arguments passed to the main
scenedetect command, before other sub-commands (e.g. this function processes
the [options] when calling scenedetect [options] [commands [command options]].
This method calls the _init_video_manager(), _open_stats_file(), and
check_input_open() methods, which may raise a click.BadParameter exception.
Raises:
click.BadParameter
"""
if not input_list:
return
logging.debug('Parsing program options.')
self.frame_skip = frame_skip
video_manager_initialized = self._init_video_manager(
input_list=input_list, framerate=framerate, downscale=downscale)
# Ensure VideoManager is initialized, and open StatsManager if --stats is specified.
if not video_manager_initialized:
self.video_manager = None
logging.info('VideoManager not initialized.')
else:
logging.debug('VideoManager initialized.')
self.stats_file_path = get_and_create_path(stats_file, self.output_directory)
if self.stats_file_path is not None:
self.check_input_open()
self._open_stats_file()
# Init SceneManager.
self.scene_manager = SceneManager(self.stats_manager)
self.options_processed = True
def time_command(self, start=None, duration=None, end=None):
# type: (Optional[str], Optional[str], Optional[str]) -> None
""" Time Command: Parses all options/arguments passed to the time command,
or with respect to the CLI, this function processes [time options] when calling:
scenedetect [global options] time [time options] [other commands...].
Raises:
click.BadParameter, VideoDecodingInProgress
"""
logging.debug('Setting video time:\n start: %s, duration: %s, end: %s',
start, duration, end)
self.check_input_open()
if duration is not None and end is not None:
raise click.BadParameter(
'Only one of --duration/-d or --end/-e can be specified, not both.',
param_hint='time')
self.video_manager.set_duration(start_time=start, duration=duration, end_time=end)
if start is not None:
self.start_frame = start.get_frames()
def list_scenes_command(self, output_path, filename_format, no_output_mode, quiet_mode):
# type: (str, str, bool, bool) -> None
""" List Scenes Command: Parses all options/arguments passed to the list-scenes command,
or with respect to the CLI, this function processes [list-scenes options] when calling:
scenedetect [global options] list-scenes [list-scenes options] [other commands...].
Raises:
click.BadParameter
"""
self.check_input_open()
self.print_scene_list = True if quiet_mode is None else not quiet_mode
self.scene_list_directory = output_path
self.scene_list_name_format = filename_format
if self.scene_list_name_format is not None and not no_output_mode:
logging.info('Scene list CSV file name format:\n %s', self.scene_list_name_format)
self.scene_list_output = False if no_output_mode else True
if self.scene_list_directory is not None:
logging.info('Scene list output directory set:\n %s', self.scene_list_directory)
def export_html_command(self, filename, no_images, image_width, image_height):
# type: (str, bool) -> None
"""Export HTML command: Parses all options/arguments passed to the export-html command,
or with respect to the CLI, this function processes [export-html] options when calling:
scenedetect [global options] export-html [export-html options] [other commands...].
Raises:
click.BadParameter
"""
self.check_input_open()
self.html_name_format = filename
if self.html_name_format is not None:
logging.info('Scene list html file name format:\n %s', self.html_name_format)
self.html_include_images = False if no_images else True
self.image_width = image_width
self.image_height = image_height
def save_images_command(self, num_images, output, name_format, jpeg, webp, quality,
png, compression, image_frame_margin):
# type: (int, str, str, bool, bool, int, bool, int) -> None
""" Save Images Command: Parses all options/arguments passed to the save-images command,
or with respect to the CLI, this function processes [save-images options] when calling:
scenedetect [global options] save-images [save-images options] [other commands...].
Raises:
click.BadParameter
"""
self.check_input_open()
num_flags = sum([True if flag else False for flag in [jpeg, webp, png]])
if num_flags <= 1:
# Ensure the format exists.
extension = 'jpg' # Default is jpg.
if png:
extension = 'png'
elif webp:
extension = 'webp'
if not extension in self.imwrite_params or self.imwrite_params[extension] is None:
error_strs = [
'Image encoder type %s not supported.' % extension.upper(),
'The specified encoder type could not be found in the current OpenCV module.',
'To enable this output format, please update the installed version of OpenCV.',
'If you build OpenCV, ensure the the proper dependencies are enabled. ']
logging.debug('\n'.join(error_strs))
raise click.BadParameter('\n'.join(error_strs), param_hint='save-images')
self.save_images = True
self.image_directory = output
self.image_extension = extension
self.image_param = compression if png else quality
self.image_name_format = name_format
self.num_images = num_images
self.image_frame_margin = image_frame_margin
image_type = 'JPEG' if self.image_extension == 'jpg' else self.image_extension.upper()
image_param_type = ''
if self.image_param:
image_param_type = 'Compression' if image_type == 'PNG' else 'Quality'
image_param_type = ' [%s: %d]' % (image_param_type, self.image_param)
logging.info('Image output format set: %s%s', image_type, image_param_type)
if self.image_directory is not None:
logging.info('Image output directory set:\n %s',
os.path.abspath(self.image_directory))
else:
self.options_processed = False
logging.error('Multiple image type flags set for save-images command.')
raise click.BadParameter(
'Only one image type (JPG/PNG/WEBP) can be specified.', param_hint='save-images')