-
-
Notifications
You must be signed in to change notification settings - Fork 13k
/
args.py
1223 lines (1148 loc) · 57.3 KB
/
args.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
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
#!/usr/bin/env python3
""" The Command Line Argument options for faceswap.py """
# pylint:disable=too-many-lines
import argparse
import gettext
import logging
import re
import sys
import textwrap
import typing as T
from lib.utils import get_backend
from lib.gpu_stats import GPUStats
from plugins.plugin_loader import PluginLoader
from .actions import (DirFullPaths, DirOrFileFullPaths, DirOrFilesFullPaths, FileFullPaths,
FilesFullPaths, MultiOption, Radio, SaveFileFullPaths, Slider)
from .launcher import ScriptExecutor
logger = logging.getLogger(__name__)
_GPUS = GPUStats().cli_devices
# LOCALES
_LANG = gettext.translation("lib.cli.args", localedir="locales", fallback=True)
_ = _LANG.gettext
class FullHelpArgumentParser(argparse.ArgumentParser):
""" Extends :class:`argparse.ArgumentParser` to output full help on bad arguments. """
def error(self, message: str) -> T.NoReturn:
self.print_help(sys.stderr)
self.exit(2, f"{self.prog}: error: {message}\n")
class SmartFormatter(argparse.HelpFormatter):
""" Extends the class :class:`argparse.HelpFormatter` to allow custom formatting in help text.
Adapted from: https://stackoverflow.com/questions/3853722
Notes
-----
Prefix help text with "R|" to override default formatting and use explicitly defined formatting
within the help text.
Prefixing a new line within the help text with "L|" will turn that line into a list item in
both the cli help text and the GUI.
"""
def __init__(self,
prog: str,
indent_increment: int = 2,
max_help_position: int = 24,
width: int | None = None) -> None:
super().__init__(prog, indent_increment, max_help_position, width)
self._whitespace_matcher_limited = re.compile(r'[ \r\f\v]+', re.ASCII)
def _split_lines(self, text: str, width: int) -> list[str]:
""" Split the given text by the given display width.
If the text is not prefixed with "R|" then the standard
:func:`argparse.HelpFormatter._split_lines` function is used, otherwise raw
formatting is processed,
Parameters
----------
text: str
The help text that is to be formatted for display
width: int
The display width, in characters, for the help text
Returns
-------
list
A list of split strings
"""
if text.startswith("R|"):
text = self._whitespace_matcher_limited.sub(' ', text).strip()[2:]
output = []
for txt in text.splitlines():
indent = ""
if txt.startswith("L|"):
indent = " "
txt = f" - {txt[2:]}"
output.extend(textwrap.wrap(txt, width, subsequent_indent=indent))
return output
return argparse.HelpFormatter._split_lines(self, # pylint:disable=protected-access
text,
width)
class FaceSwapArgs():
""" Faceswap argument parser functions that are universal to all commands.
This is the parent class to all subsequent argparsers which holds global arguments that pertain
to all commands.
Process the incoming command line arguments, validates then launches the relevant faceswap
script with the given arguments.
Parameters
----------
subparser: :class:`argparse._SubParsersAction`
The subparser for the given command
command: str
The faceswap command that is to be executed
description: str, optional
The description for the given command. Default: "default"
"""
def __init__(self,
subparser: argparse._SubParsersAction,
command: str,
description: str = "default") -> None:
self.global_arguments = self._get_global_arguments()
self.info = self.get_info()
self.argument_list = self.get_argument_list()
self.optional_arguments = self.get_optional_arguments()
self._process_suppressions()
if not subparser:
return
self.parser = self._create_parser(subparser, command, description)
self._add_arguments()
script = ScriptExecutor(command)
self.parser.set_defaults(func=script.execute_script)
@staticmethod
def get_info() -> str:
""" Returns the information text for the current command.
This function should be overridden with the actual command help text for each
commands' parser.
Returns
-------
str
The information text for this command.
"""
return ""
@staticmethod
def get_argument_list() -> list[dict[str, T.Any]]:
""" Returns the argument list for the current command.
The argument list should be a list of dictionaries pertaining to each option for a command.
This function should be overridden with the actual argument list for each command's
argument list.
See existing parsers for examples.
Returns
-------
list
The list of command line options for the given command
"""
argument_list: list[dict[str, T.Any]] = []
return argument_list
@staticmethod
def get_optional_arguments() -> list[dict[str, T.Any]]:
""" Returns the optional argument list for the current command.
The optional arguments list is not always required, but is used when there are shared
options between multiple commands (e.g. convert and extract). Only override if required.
Returns
-------
list
The list of optional command line options for the given command
"""
argument_list: list[dict[str, T.Any]] = []
return argument_list
@staticmethod
def _get_global_arguments() -> list[dict[str, T.Any]]:
""" Returns the global Arguments list that are required for ALL commands in Faceswap.
This method should NOT be overridden.
Returns
-------
list
The list of global command line options for all Faceswap commands.
"""
global_args: list[dict[str, T.Any]] = []
if _GPUS:
global_args.append(dict(
opts=("-X", "--exclude-gpus"),
dest="exclude_gpus",
action=MultiOption,
type=str.lower,
nargs="+",
choices=[str(idx) for idx in range(len(_GPUS))],
group=_("Global Options"),
help=_("R|Exclude GPUs from use by Faceswap. Select the number(s) which "
"correspond to any GPU(s) that you do not wish to be made available to "
"Faceswap. Selecting all GPUs here will force Faceswap into CPU mode."
"\nL|{}").format(" \nL|".join(_GPUS))))
global_args.append(dict(
opts=("-C", "--configfile"),
action=FileFullPaths,
filetypes="ini",
type=str,
group=_("Global Options"),
help=_("Optionally overide the saved config with the path to a custom config file.")))
global_args.append(dict(
opts=("-L", "--loglevel"),
type=str.upper,
dest="loglevel",
default="INFO",
choices=("INFO", "VERBOSE", "DEBUG", "TRACE"),
group=_("Global Options"),
help=_("Log level. Stick with INFO or VERBOSE unless you need to file an error "
"report. Be careful with TRACE as it will generate a lot of data")))
global_args.append(dict(
opts=("-LF", "--logfile"),
action=SaveFileFullPaths,
filetypes='log',
type=str,
dest="logfile",
default=None,
group=_("Global Options"),
help=_("Path to store the logfile. Leave blank to store in the faceswap folder")))
# These are hidden arguments to indicate that the GUI/Colab is being used
global_args.append(dict(
opts=("-gui", "--gui"),
action="store_true",
dest="redirect_gui",
default=False,
help=argparse.SUPPRESS))
global_args.append(dict(
opts=("-colab", "--colab"),
action="store_true",
dest="colab",
default=False,
help=argparse.SUPPRESS))
return global_args
@staticmethod
def _create_parser(subparser: argparse._SubParsersAction,
command: str,
description: str) -> argparse.ArgumentParser:
""" Create the parser for the selected command.
Parameters
----------
subparser: :class:`argparse._SubParsersAction`
The subparser for the given command
command: str
The faceswap command that is to be executed
description: str
The description for the given command
Returns
-------
:class:`~lib.cli.args.FullHelpArgumentParser`
The parser for the given command
"""
parser = subparser.add_parser(command,
help=description,
description=description,
epilog="Questions and feedback: https://faceswap.dev/forum",
formatter_class=SmartFormatter)
return parser
def _add_arguments(self) -> None:
""" Parse the list of dictionaries containing the command line arguments and convert to
argparse parser arguments. """
options = self.global_arguments + self.argument_list + self.optional_arguments
for option in options:
args = option["opts"]
kwargs = {key: option[key] for key in option.keys() if key not in ("opts", "group")}
self.parser.add_argument(*args, **kwargs)
def _process_suppressions(self) -> None:
""" Certain options are only available for certain backends.
Suppresses command line options that are not available for the running backend.
"""
fs_backend = get_backend()
for opt_list in [self.global_arguments, self.argument_list, self.optional_arguments]:
for opts in opt_list:
if opts.get("backend", None) is None:
continue
opt_backend = opts.pop("backend")
if isinstance(opt_backend, (list, tuple)):
opt_backend = [backend.lower() for backend in opt_backend]
else:
opt_backend = [opt_backend.lower()]
if fs_backend not in opt_backend:
opts["help"] = argparse.SUPPRESS
class ExtractConvertArgs(FaceSwapArgs):
""" Parent class to capture arguments that will be used in both extract and convert processes.
Extract and Convert share a fair amount of arguments, so arguments that can be used in both of
these processes should be placed here.
No further processing is done in this class (this is handled by the children), this just
captures the shared arguments.
"""
@staticmethod
def get_argument_list() -> list[dict[str, T.Any]]:
""" Returns the argument list for shared Extract and Convert arguments.
Returns
-------
list
The list of command line options for the given Extract and Convert
"""
argument_list: list[dict[str, T.Any]] = []
argument_list.append(dict(
opts=("-i", "--input-dir"),
action=DirOrFileFullPaths,
filetypes="video",
dest="input_dir",
required=True,
group=_("Data"),
help=_("Input directory or video. Either a directory containing the image files you "
"wish to process or path to a video file. NB: This should be the source video/"
"frames NOT the source faces.")))
argument_list.append(dict(
opts=("-o", "--output-dir"),
action=DirFullPaths,
dest="output_dir",
required=True,
group=_("Data"),
help=_("Output directory. This is where the converted files will be saved.")))
argument_list.append(dict(
opts=("-al", "--alignments"),
action=FileFullPaths,
filetypes="alignments",
type=str,
dest="alignments_path",
group=_("Data"),
help=_("Optional path to an alignments file. Leave blank if the alignments file is "
"at the default location.")))
return argument_list
class ExtractArgs(ExtractConvertArgs):
""" Creates the command line arguments for extraction.
This class inherits base options from :class:`ExtractConvertArgs` where arguments that are used
for both Extract and Convert should be placed.
Commands explicit to Extract should be added in :func:`get_optional_arguments`
"""
@staticmethod
def get_info() -> str:
""" The information text for the Extract command.
Returns
-------
str
The information text for the Extract command.
"""
return _("Extract faces from image or video sources.\n"
"Extraction plugins can be configured in the 'Settings' Menu")
@staticmethod
def get_optional_arguments() -> list[dict[str, T.Any]]:
""" Returns the argument list unique to the Extract command.
Returns
-------
list
The list of optional command line options for the Extract command
"""
if get_backend() == "cpu":
default_detector = "mtcnn"
default_aligner = "cv2-dnn"
else:
default_detector = "s3fd"
default_aligner = "fan"
argument_list: list[dict[str, T.Any]] = []
argument_list.append(dict(
opts=("-b", "--batch-mode"),
action="store_true",
dest="batch_mode",
default=False,
group=_("Data"),
help=_("R|If selected then the input_dir should be a parent folder containing "
"multiple videos and/or folders of images you wish to extract from. The faces "
"will be output to separate sub-folders in the output_dir.")))
argument_list.append(dict(
opts=("-D", "--detector"),
action=Radio,
type=str.lower,
default=default_detector,
choices=PluginLoader.get_available_extractors("detect"),
group=_("Plugins"),
help=_("R|Detector to use. Some of these have configurable settings in "
"'/config/extract.ini' or 'Settings > Configure Extract 'Plugins':"
"\nL|cv2-dnn: A CPU only extractor which is the least reliable and least "
"resource intensive. Use this if not using a GPU and time is important."
"\nL|mtcnn: Good detector. Fast on CPU, faster on GPU. Uses fewer resources "
"than other GPU detectors but can often return more false positives."
"\nL|s3fd: Best detector. Slow on CPU, faster on GPU. Can detect more faces "
"and fewer false positives than other GPU detectors, but is a lot more "
"resource intensive.")))
argument_list.append(dict(
opts=("-A", "--aligner"),
action=Radio,
type=str.lower,
default=default_aligner,
choices=PluginLoader.get_available_extractors("align"),
group=_("Plugins"),
help=_("R|Aligner to use."
"\nL|cv2-dnn: A CPU only landmark detector. Faster, less resource intensive, "
"but less accurate. Only use this if not using a GPU and time is important."
"\nL|fan: Best aligner. Fast on GPU, slow on CPU.")))
argument_list.append(dict(
opts=("-M", "--masker"),
action=MultiOption,
type=str.lower,
nargs="+",
choices=[mask for mask in PluginLoader.get_available_extractors("mask")
if mask not in ("components", "extended")],
group=_("Plugins"),
help=_("R|Additional Masker(s) to use. The masks generated here will all take up GPU "
"RAM. You can select none, one or multiple masks, but the extraction may take "
"longer the more you select. NB: The Extended and Components (landmark based) "
"masks are automatically generated on extraction."
"\nL|bisenet-fp: Relatively lightweight NN based mask that provides more "
"refined control over the area to be masked including full head masking "
"(configurable in mask settings)."
"\nL|custom: A dummy mask that fills the mask area with all 1s or 0s "
"(configurable in settings). This is only required if you intend to manually "
"edit the custom masks yourself in the manual tool. This mask does not use the "
"GPU so will not use any additional VRAM."
"\nL|vgg-clear: Mask designed to provide smart segmentation of mostly frontal "
"faces clear of obstructions. Profile faces and obstructions may result in "
"sub-par performance."
"\nL|vgg-obstructed: Mask designed to provide smart segmentation of mostly "
"frontal faces. The mask model has been specifically trained to recognize "
"some facial obstructions (hands and eyeglasses). Profile faces may result in "
"sub-par performance."
"\nL|unet-dfl: Mask designed to provide smart segmentation of mostly frontal "
"faces. The mask model has been trained by community members and will need "
"testing for further description. Profile faces may result in sub-par "
"performance."
"\nThe auto generated masks are as follows:"
"\nL|components: Mask designed to provide facial segmentation based on the "
"positioning of landmark locations. A convex hull is constructed around the "
"exterior of the landmarks to create a mask."
"\nL|extended: Mask designed to provide facial segmentation based on the "
"positioning of landmark locations. A convex hull is constructed around the "
"exterior of the landmarks and the mask is extended upwards onto the "
"forehead."
"\n(eg: `-M unet-dfl vgg-clear`, `--masker vgg-obstructed`)")))
argument_list.append(dict(
opts=("-nm", "--normalization"),
action=Radio,
type=str.lower,
dest="normalization",
default="none",
choices=["none", "clahe", "hist", "mean"],
group=_("Plugins"),
help=_("R|Performing normalization can help the aligner better align faces with "
"difficult lighting conditions at an extraction speed cost. Different methods "
"will yield different results on different sets. NB: This does not impact the "
"output face, just the input to the aligner."
"\nL|none: Don't perform normalization on the face."
"\nL|clahe: Perform Contrast Limited Adaptive Histogram Equalization on the "
"face."
"\nL|hist: Equalize the histograms on the RGB channels."
"\nL|mean: Normalize the face colors to the mean.")))
argument_list.append(dict(
opts=("-rf", "--re-feed"),
action=Slider,
min_max=(0, 10),
rounding=1,
type=int,
dest="re_feed",
default=0,
group=_("Plugins"),
help=_("The number of times to re-feed the detected face into the aligner. Each time "
"the face is re-fed into the aligner the bounding box is adjusted by a small "
"amount. The final landmarks are then averaged from each iteration. Helps to "
"remove 'micro-jitter' but at the cost of slower extraction speed. The more "
"times the face is re-fed into the aligner, the less micro-jitter should occur "
"but the longer extraction will take.")))
argument_list.append(dict(
opts=("-a", "--re-align"),
action="store_true",
dest="re_align",
default=False,
group=_("Plugins"),
help=_("Re-feed the initially found aligned face through the aligner. Can help "
"produce better alignments for faces that are rotated beyond 45 degrees in "
"the frame or are at extreme angles. Slows down extraction.")))
argument_list.append(dict(
opts=("-r", "--rotate-images"),
type=str,
dest="rotate_images",
default=None,
group=_("Plugins"),
help=_("If a face isn't found, rotate the images to try to find a face. Can find "
"more faces at the cost of extraction speed. Pass in a single number to use "
"increments of that size up to 360, or pass in a list of numbers to enumerate "
"exactly what angles to check.")))
argument_list.append(dict(
opts=("-I", "--identity"),
action="store_true",
default=False,
group=_("Plugins"),
help=_("Obtain and store face identity encodings from VGGFace2. Slows down extract a "
"little, but will save time if using 'sort by face'")))
argument_list.append(dict(
opts=("-min", "--min-size"),
action=Slider,
min_max=(0, 1080),
rounding=20,
type=int,
dest="min_size",
default=0,
group=_("Face Processing"),
help=_("Filters out faces detected below this size. Length, in pixels across the "
"diagonal of the bounding box. Set to 0 for off")))
argument_list.append(dict(
opts=("-n", "--nfilter"),
action=DirOrFilesFullPaths,
filetypes="image",
dest="nfilter",
default=None,
nargs="+",
group=_("Face Processing"),
help=_("Optionally filter out people who you do not wish to extract by passing in "
"images of those people. Should be a small variety of images at different "
"angles and in different conditions. A folder containing the required images "
"or multiple image files, space separated, can be selected.")))
argument_list.append(dict(
opts=("-f", "--filter"),
action=DirOrFilesFullPaths,
filetypes="image",
dest="filter",
default=None,
nargs="+",
group=_("Face Processing"),
help=_("Optionally select people you wish to extract by passing in images of that "
"person. Should be a small variety of images at different angles and in "
"different conditions A folder containing the required images or multiple "
"image files, space separated, can be selected.")))
argument_list.append(dict(
opts=("-l", "--ref_threshold"),
action=Slider,
min_max=(0.01, 0.99),
rounding=2,
type=float,
dest="ref_threshold",
default=0.60,
group=_("Face Processing"),
help=_("For use with the optional nfilter/filter files. Threshold for positive face "
"recognition. Higher values are stricter.")))
argument_list.append(dict(
opts=("-sz", "--size"),
action=Slider,
min_max=(256, 1024),
rounding=64,
type=int,
default=512,
group=_("output"),
help=_("The output size of extracted faces. Make sure that the model you intend to "
"train supports your required size. This will only need to be changed for "
"hi-res models.")))
argument_list.append(dict(
opts=("-een", "--extract-every-n"),
action=Slider,
min_max=(1, 100),
rounding=1,
type=int,
dest="extract_every_n",
default=1,
group=_("output"),
help=_("Extract every 'nth' frame. This option will skip frames when extracting "
"faces. For example a value of 1 will extract faces from every frame, a value "
"of 10 will extract faces from every 10th frame.")))
argument_list.append(dict(
opts=("-si", "--save-interval"),
action=Slider,
min_max=(0, 1000),
rounding=10,
type=int,
dest="save_interval",
default=0,
group=_("output"),
help=_("Automatically save the alignments file after a set amount of frames. By "
"default the alignments file is only saved at the end of the extraction "
"process. NB: If extracting in 2 passes then the alignments file will only "
"start to be saved out during the second pass. WARNING: Don't interrupt the "
"script when writing the file because it might get corrupted. Set to 0 to "
"turn off")))
argument_list.append(dict(
opts=("-dl", "--debug-landmarks"),
action="store_true",
dest="debug_landmarks",
default=False,
group=_("output"),
help=_("Draw landmarks on the ouput faces for debugging purposes.")))
argument_list.append(dict(
opts=("-sp", "--singleprocess"),
action="store_true",
default=False,
backend=("nvidia", "directml", "rocm", "apple_silicon"),
group=_("settings"),
help=_("Don't run extraction in parallel. Will run each part of the extraction "
"process separately (one after the other) rather than all at the same time. "
"Useful if VRAM is at a premium.")))
argument_list.append(dict(
opts=("-s", "--skip-existing"),
action="store_true",
dest="skip_existing",
default=False,
group=_("settings"),
help=_("Skips frames that have already been extracted and exist in the alignments "
"file")))
argument_list.append(dict(
opts=("-sf", "--skip-existing-faces"),
action="store_true",
dest="skip_faces",
default=False,
group=_("settings"),
help=_("Skip frames that already have detected faces in the alignments file")))
argument_list.append(dict(
opts=("-ssf", "--skip-saving-faces"),
action="store_true",
dest="skip_saving_faces",
default=False,
group=_("settings"),
help=_("Skip saving the detected faces to disk. Just create an alignments file")))
return argument_list
class ConvertArgs(ExtractConvertArgs):
""" Creates the command line arguments for conversion.
This class inherits base options from :class:`ExtractConvertArgs` where arguments that are used
for both Extract and Convert should be placed.
Commands explicit to Convert should be added in :func:`get_optional_arguments`
"""
@staticmethod
def get_info() -> str:
""" The information text for the Convert command.
Returns
-------
str
The information text for the Convert command.
"""
return _("Swap the original faces in a source video/images to your final faces.\n"
"Conversion plugins can be configured in the 'Settings' Menu")
@staticmethod
def get_optional_arguments() -> list[dict[str, T.Any]]:
""" Returns the argument list unique to the Convert command.
Returns
-------
list
The list of optional command line options for the Convert command
"""
argument_list: list[dict[str, T.Any]] = []
argument_list.append(dict(
opts=("-ref", "--reference-video"),
action=FileFullPaths,
filetypes="video",
type=str,
dest="reference_video",
group=_("Data"),
help=_("Only required if converting from images to video. Provide The original video "
"that the source frames were extracted from (for extracting the fps and "
"audio).")))
argument_list.append(dict(
opts=("-m", "--model-dir"),
action=DirFullPaths,
dest="model_dir",
required=True,
group=_("Data"),
help=_("Model directory. The directory containing the trained model you wish to use "
"for conversion.")))
argument_list.append(dict(
opts=("-c", "--color-adjustment"),
action=Radio,
type=str.lower,
dest="color_adjustment",
default="avg-color",
choices=PluginLoader.get_available_convert_plugins("color", True),
group=_("Plugins"),
help=_("R|Performs color adjustment to the swapped face. Some of these options have "
"configurable settings in '/config/convert.ini' or 'Settings > Configure "
"Convert Plugins':"
"\nL|avg-color: Adjust the mean of each color channel in the swapped "
"reconstruction to equal the mean of the masked area in the original image."
"\nL|color-transfer: Transfers the color distribution from the source to the "
"target image using the mean and standard deviations of the L*a*b* "
"color space."
"\nL|manual-balance: Manually adjust the balance of the image in a variety of "
"color spaces. Best used with the Preview tool to set correct values."
"\nL|match-hist: Adjust the histogram of each color channel in the swapped "
"reconstruction to equal the histogram of the masked area in the original "
"image."
"\nL|seamless-clone: Use cv2's seamless clone function to remove extreme "
"gradients at the mask seam by smoothing colors. Generally does not give "
"very satisfactory results."
"\nL|none: Don't perform color adjustment.")))
argument_list.append(dict(
opts=("-M", "--mask-type"),
action=Radio,
type=str.lower,
dest="mask_type",
default="extended",
choices=PluginLoader.get_available_extractors("mask",
add_none=True,
extend_plugin=True) + ["predicted"],
group=_("Plugins"),
help=_("R|Masker to use. NB: The mask you require must exist within the alignments "
"file. You can add additional masks with the Mask Tool."
"\nL|none: Don't use a mask."
"\nL|bisenet-fp_face: Relatively lightweight NN based mask that provides more "
"refined control over the area to be masked (configurable in mask settings). "
"Use this version of bisenet-fp if your model is trained with 'face' or "
"'legacy' centering."
"\nL|bisenet-fp_head: Relatively lightweight NN based mask that provides more "
"refined control over the area to be masked (configurable in mask settings). "
"Use this version of bisenet-fp if your model is trained with 'head' centering."
"\nL|custom_face: Custom user created, face centered mask."
"\nL|custom_head: Custom user created, head centered mask."
"\nL|components: Mask designed to provide facial segmentation based on the "
"positioning of landmark locations. A convex hull is constructed around the "
"exterior of the landmarks to create a mask."
"\nL|extended: Mask designed to provide facial segmentation based on the "
"positioning of landmark locations. A convex hull is constructed around the "
"exterior of the landmarks and the mask is extended upwards onto the forehead."
"\nL|vgg-clear: Mask designed to provide smart segmentation of mostly frontal "
"faces clear of obstructions. Profile faces and obstructions may result in "
"sub-par performance."
"\nL|vgg-obstructed: Mask designed to provide smart segmentation of mostly "
"frontal faces. The mask model has been specifically trained to recognize "
"some facial obstructions (hands and eyeglasses). Profile faces may result in "
"sub-par performance."
"\nL|unet-dfl: Mask designed to provide smart segmentation of mostly frontal "
"faces. The mask model has been trained by community members and will need "
"testing for further description. Profile faces may result in sub-par "
"performance."
"\nL|predicted: If the 'Learn Mask' option was enabled during training, this "
"will use the mask that was created by the trained model.")))
argument_list.append(dict(
opts=("-w", "--writer"),
action=Radio,
type=str,
default="opencv",
choices=PluginLoader.get_available_convert_plugins("writer", False),
group=_("Plugins"),
help=_("R|The plugin to use to output the converted images. The writers are "
"configurable in '/config/convert.ini' or 'Settings > Configure Convert "
"Plugins:'"
"\nL|ffmpeg: [video] Writes out the convert straight to video. When the input "
"is a series of images then the '-ref' (--reference-video) parameter must be "
"set."
"\nL|gif: [animated image] Create an animated gif."
"\nL|opencv: [images] The fastest image writer, but less options and formats "
"than other plugins."
"\nL|patch: [images] Outputs the raw swapped face patch, along with the "
"transformation matrix required to re-insert the face back into the original "
"frame. Use this option if you wish to post-process and composite the final "
"face within external tools."
"\nL|pillow: [images] Slower than opencv, but has more options and supports "
"more formats.")))
argument_list.append(dict(
opts=("-osc", "--output-scale"),
action=Slider,
min_max=(25, 400),
rounding=1,
type=int,
dest="output_scale",
default=100,
group=_("Frame Processing"),
help=_("Scale the final output frames by this amount. 100%% will output the frames "
"at source dimensions. 50%% at half size 200%% at double size")))
argument_list.append(dict(
opts=("-fr", "--frame-ranges"),
type=str,
nargs="+",
group=_("Frame Processing"),
help=_("Frame ranges to apply transfer to e.g. For frames 10 to 50 and 90 to 100 use "
"--frame-ranges 10-50 90-100. Frames falling outside of the selected range "
"will be discarded unless '-k' (--keep-unchanged) is selected. NB: If you are "
"converting from images, then the filenames must end with the frame-number!")))
argument_list.append(dict(
opts=("-S", "--face-scale"),
action=Slider,
min_max=(-10.0, 10.0),
rounding=2,
dest="face_scale",
type=float,
default=0.0,
group=_("Face Processing"),
help=_("Scale the swapped face by this percentage. Positive values will enlarge the "
"face, Negative values will shrink the face.")))
argument_list.append(dict(
opts=("-a", "--input-aligned-dir"),
action=DirFullPaths,
dest="input_aligned_dir",
default=None,
group=_("Face Processing"),
help=_("If you have not cleansed your alignments file, then you can filter out faces "
"by defining a folder here that contains the faces extracted from your input "
"files/video. If this folder is defined, then only faces that exist within "
"your alignments file and also exist within the specified folder will be "
"converted. Leaving this blank will convert all faces that exist within the "
"alignments file.")))
argument_list.append(dict(
opts=("-n", "--nfilter"),
action=FilesFullPaths,
filetypes="image",
dest="nfilter",
default=None,
nargs="+",
group=_("Face Processing"),
help=_("Optionally filter out people who you do not wish to process by passing in an "
"image of that person. Should be a front portrait with a single person in the "
"image. Multiple images can be added space separated. NB: Using face filter "
"will significantly decrease extraction speed and its accuracy cannot be "
"guaranteed.")))
argument_list.append(dict(
opts=("-f", "--filter"),
action=FilesFullPaths,
filetypes="image",
dest="filter",
default=None,
nargs="+",
group=_("Face Processing"),
help=_("Optionally select people you wish to process by passing in an image of that "
"person. Should be a front portrait with a single person in the image. "
"Multiple images can be added space separated. NB: Using face filter will "
"significantly decrease extraction speed and its accuracy cannot be "
"guaranteed.")))
argument_list.append(dict(
opts=("-l", "--ref_threshold"),
action=Slider,
min_max=(0.01, 0.99),
rounding=2,
type=float,
dest="ref_threshold",
default=0.4,
group=_("Face Processing"),
help=_("For use with the optional nfilter/filter files. Threshold for positive face "
"recognition. Lower values are stricter. NB: Using face filter will "
"significantly decrease extraction speed and its accuracy cannot be "
"guaranteed.")))
argument_list.append(dict(
opts=("-j", "--jobs"),
action=Slider,
min_max=(0, 40),
rounding=1,
type=int,
dest="jobs",
default=0,
group=_("settings"),
help=_("The maximum number of parallel processes for performing conversion. "
"Converting images is system RAM heavy so it is possible to run out of memory "
"if you have a lot of processes and not enough RAM to accommodate them all. "
"Setting this to 0 will use the maximum available. No matter what you set "
"this to, it will never attempt to use more processes than are available on "
"your system. If singleprocess is enabled this setting will be ignored.")))
argument_list.append(dict(
opts=("-t", "--trainer"),
type=str.lower,
choices=PluginLoader.get_available_models(),
group=_("settings"),
help=_("[LEGACY] This only needs to be selected if a legacy model is being loaded or "
"if there are multiple models in the model folder")))
argument_list.append(dict(
opts=("-otf", "--on-the-fly"),
action="store_true",
dest="on_the_fly",
default=False,
group=_("settings"),
help=_("Enable On-The-Fly Conversion. NOT recommended. You should generate a clean "
"alignments file for your destination video. However, if you wish you can "
"generate the alignments on-the-fly by enabling this option. This will use "
"an inferior extraction pipeline and will lead to substandard results. If an "
"alignments file is found, this option will be ignored.")))
argument_list.append(dict(
opts=("-k", "--keep-unchanged"),
action="store_true",
dest="keep_unchanged",
default=False,
group=_("Frame Processing"),
help=_("When used with --frame-ranges outputs the unchanged frames that are not "
"processed instead of discarding them.")))
argument_list.append(dict(
opts=("-s", "--swap-model"),
action="store_true",
dest="swap_model",
default=False,
group=_("settings"),
help=_("Swap the model. Instead converting from of A -> B, converts B -> A")))
argument_list.append(dict(
opts=("-sp", "--singleprocess"),
action="store_true",
default=False,
group=_("settings"),
help=_("Disable multiprocessing. Slower but less resource intensive.")))
return argument_list
class TrainArgs(FaceSwapArgs):
""" Creates the command line arguments for training. """
@staticmethod
def get_info() -> str:
""" The information text for the Train command.
Returns
-------
str
The information text for the Train command.
"""
return _("Train a model on extracted original (A) and swap (B) faces.\n"
"Training models can take a long time. Anything from 24hrs to over a week\n"
"Model plugins can be configured in the 'Settings' Menu")
@staticmethod
def get_argument_list() -> list[dict[str, T.Any]]:
""" Returns the argument list for Train arguments.
Returns
-------
list
The list of command line options for training
"""
argument_list: list[dict[str, T.Any]] = []
argument_list.append(dict(
opts=("-A", "--input-A"),
action=DirFullPaths,
dest="input_a",
required=True,
group=_("faces"),
help=_("Input directory. A directory containing training images for face A. This is "
"the original face, i.e. the face that you want to remove and replace with "
"face B.")))
argument_list.append(dict(
opts=("-B", "--input-B"),
action=DirFullPaths,
dest="input_b",
required=True,
group=_("faces"),
help=_("Input directory. A directory containing training images for face B. This is "
"the swap face, i.e. the face that you want to place onto the head of person "
"A.")))
argument_list.append(dict(
opts=("-m", "--model-dir"),
action=DirFullPaths,
dest="model_dir",
required=True,
group=_("model"),
help=_("Model directory. This is where the training data will be stored. You should "
"always specify a new folder for new models. If starting a new model, select "
"either an empty folder, or a folder which does not exist (which will be "
"created). If continuing to train an existing model, specify the location of "
"the existing model.")))
argument_list.append(dict(
opts=("-l", "--load-weights"),
action=FileFullPaths,
filetypes="model",
dest="load_weights",
required=False,
group=_("model"),
help=_("R|Load the weights from a pre-existing model into a newly created model. "
"For most models this will load weights from the Encoder of the given model "
"into the encoder of the newly created model. Some plugins may have specific "
"configuration options allowing you to load weights from other layers. Weights "
"will only be loaded when creating a new model. This option will be ignored if "
"you are resuming an existing model. Generally you will also want to 'freeze-"
"weights' whilst the rest of your model catches up with your Encoder.\n"
"NB: Weights can only be loaded from models of the same plugin as you intend "
"to train.")))
argument_list.append(dict(
opts=("-t", "--trainer"),
action=Radio,
type=str.lower,
default=PluginLoader.get_default_model(),
choices=PluginLoader.get_available_models(),
group=_("model"),
help=_("R|Select which trainer to use. Trainers can be configured from the Settings "
"menu or the config folder."
"\nL|original: The original model created by /u/deepfakes."
"\nL|dfaker: 64px in/128px out model from dfaker. Enable 'warp-to-landmarks' "
"for full dfaker method."
"\nL|dfl-h128: 128px in/out model from deepfacelab"
"\nL|dfl-sae: Adaptable model from deepfacelab"
"\nL|dlight: A lightweight, high resolution DFaker variant."