facefusion/facefusion/program.py

import tempfile
from argparse import ArgumentParser, HelpFormatter
from functools import partial

import facefusion.choices
from facefusion import capability_store, config, metadata, state_manager, translator
from facefusion.common_helper import create_float_metavar, create_int_metavar, get_first, get_last
from facefusion.execution import get_available_execution_providers
from facefusion.ffmpeg import get_available_encoder_set
from facefusion.filesystem import get_file_name, resolve_file_paths
from facefusion.processors.core import get_processors_modules
from facefusion.sanitizer import sanitize_int_range, sanitize_job_id


def create_help_formatter_small(prog : str) -> HelpFormatter:
	return HelpFormatter(prog, max_help_position = 50)


def create_help_formatter_large(prog : str) -> HelpFormatter:
	return HelpFormatter(prog, max_help_position = 300)


def create_config_path_program() -> ArgumentParser:
	program = ArgumentParser(add_help = False)
	group_paths = program.add_argument_group('paths')

	capability_store.register_capability_set(
		[
			group_paths.add_argument(
				'--config-path',
				help = translator.get('help.config_path'),
				default = 'facefusion.ini'
			)
		],
		scopes = [ 'cli' ]
	)

	apply_config_path(program)
	return program


def create_workflow_program() -> ArgumentParser:
	program = ArgumentParser(add_help = False)
	group_paths = program.add_argument_group('paths')

	capability_store.register_capability_set(
		[
			group_paths.add_argument(
				'--workflow',
				help = translator.get('help.workflow'),
				default = config.get_str_value('workflow', 'workflow', 'auto'),
				choices = facefusion.choices.workflows
			)
		],
		scopes = [ 'api', 'cli' ]
	)

	return program


def create_temp_path_program() -> ArgumentParser:
	program = ArgumentParser(add_help = False)
	group_paths = program.add_argument_group('paths')

	capability_store.register_capability_set(
		[
			group_paths.add_argument(
				'--temp-path',
				help = translator.get('help.temp_path'),
				default = config.get_str_value('paths', 'temp_path', tempfile.gettempdir())
			)
		],
		scopes = [ 'cli' ]
	)

	return program


def create_jobs_path_program() -> ArgumentParser:
	program = ArgumentParser(add_help = False)
	group_paths = program.add_argument_group('paths')

	capability_store.register_capability_set(
		[
			group_paths.add_argument(
				'--jobs-path',
				help = translator.get('help.jobs_path'),
				default = config.get_str_value('paths', 'jobs_path', '.jobs')
			)
		],
		scopes = [ 'cli' ]
	)

	return program


def create_source_paths_program() -> ArgumentParser:
	program = ArgumentParser(add_help = False)
	group_paths = program.add_argument_group('paths')

	capability_store.register_capability_set(
		[
			group_paths.add_argument(
				'-s', '--source-paths',
				help = translator.get('help.source_paths'),
				default = config.get_str_list('paths', 'source_paths'),
				nargs = '+'
			)
		],
		scopes = [ 'cli' ]
	)

	return program


def create_target_path_program() -> ArgumentParser:
	program = ArgumentParser(add_help = False)
	group_paths = program.add_argument_group('paths')

	capability_store.register_capability_set(
		[
			group_paths.add_argument(
				'-t', '--target-path',
				help = translator.get('help.target_path'),
				default = config.get_str_value('paths', 'target_path')
			)
		],
		scopes = [ 'cli' ]
	)

	return program


def create_output_path_program() -> ArgumentParser:
	program = ArgumentParser(add_help = False)
	group_paths = program.add_argument_group('paths')

	capability_store.register_capability_set(
		[
			group_paths.add_argument(
				'-o', '--output-path',
				help = translator.get('help.output_path'),
				default = config.get_str_value('paths', 'output_path')
			)
		],
		scopes = [ 'cli' ]
	)

	return program


def create_source_pattern_program() -> ArgumentParser:
	program = ArgumentParser(add_help = False)
	group_patterns = program.add_argument_group('patterns')

	capability_store.register_capability_set(
		[
			group_patterns.add_argument(
				'-s', '--source-pattern',
				help = translator.get('help.source_pattern'),
				default = config.get_str_value('patterns', 'source_pattern')
			)
		],
		scopes = [ 'cli' ]
	)

	return program


def create_target_pattern_program() -> ArgumentParser:
	program = ArgumentParser(add_help = False)
	group_patterns = program.add_argument_group('patterns')

	capability_store.register_capability_set(
		[
			group_patterns.add_argument(
				'-t', '--target-pattern',
				help = translator.get('help.target_pattern'),
				default = config.get_str_value('patterns', 'target_pattern')
			)
		],
		scopes = [ 'cli' ]
	)

	return program


def create_output_pattern_program() -> ArgumentParser:
	program = ArgumentParser(add_help = False)
	group_patterns = program.add_argument_group('patterns')

	capability_store.register_capability_set(
		[
			group_patterns.add_argument(
				'-o', '--output-pattern',
				help = translator.get('help.output_pattern'),
				default = config.get_str_value('patterns', 'output_pattern')
			)
		],
		scopes = [ 'cli' ]
	)

	return program


def create_face_detector_program() -> ArgumentParser:
	program = ArgumentParser(add_help = False)
	group_face_detector = program.add_argument_group('face detector')

	capability_store.register_capability_set(
		[
			group_face_detector.add_argument(
				'--face-detector-model',
				help = translator.get('help.face_detector_model'),
				default = config.get_str_value('face_detector', 'face_detector_model', 'yolo_face'),
				choices = facefusion.choices.face_detector_models
			)
		],
		scopes = [ 'api', 'cli' ]
	)

	known_args, _ = program.parse_known_args()
	face_detector_size_choices = facefusion.choices.face_detector_set.get(known_args.face_detector_model)

	capability_store.register_capability_set(
		[
			group_face_detector.add_argument(
				'--face-detector-size',
				help = translator.get('help.face_detector_size'),
				default = config.get_str_value('face_detector', 'face_detector_size', get_last(face_detector_size_choices)),
				choices = face_detector_size_choices
			)
		],
		scopes = [ 'api', 'cli' ]
	)
	capability_store.register_capability_set(
		[
			group_face_detector.add_argument(
				'--face-detector-margin',
				help = translator.get('help.face_detector_margin'),
				type = partial(sanitize_int_range, int_range = facefusion.choices.face_detector_margin_range),
				default = config.get_int_list('face_detector', 'face_detector_margin', '0 0 0 0'),
				nargs = '+'
			)
		],
		scopes = [ 'api', 'cli' ]
	)
	capability_store.register_capability_set(
		[
			group_face_detector.add_argument(
				'--face-detector-angles',
				help = translator.get('help.face_detector_angles'),
				type = int,
				default = config.get_int_list('face_detector', 'face_detector_angles', '0'),
				choices = facefusion.choices.face_detector_angles,
				nargs = '+',
				metavar = 'FACE_DETECTOR_ANGLES'
			)
		],
		scopes = [ 'api', 'cli' ]
	)
	capability_store.register_capability_set(
		[
			group_face_detector.add_argument(
				'--face-detector-score',
				help = translator.get('help.face_detector_score'),
				type = float,
				default = config.get_float_value('face_detector', 'face_detector_score', '0.5'),
				choices = facefusion.choices.face_detector_score_range,
				metavar = create_float_metavar(facefusion.choices.face_detector_score_range)
			)
		],
		scopes = [ 'api', 'cli' ]
	)

	return program


def create_face_landmarker_program() -> ArgumentParser:
	program = ArgumentParser(add_help = False)
	group_face_landmarker = program.add_argument_group('face landmarker')

	capability_store.register_capability_set(
		[
			group_face_landmarker.add_argument(
				'--face-landmarker-model',
				help = translator.get('help.face_landmarker_model'),
				default = config.get_str_value('face_landmarker', 'face_landmarker_model', '2dfan4'),
				choices = facefusion.choices.face_landmarker_models
			)
		],
		scopes = [ 'api', 'cli' ]
	)
	capability_store.register_capability_set(
		[
			group_face_landmarker.add_argument(
				'--face-landmarker-score',
				help = translator.get('help.face_landmarker_score'),
				type = float,
				default = config.get_float_value('face_landmarker', 'face_landmarker_score', '0.5'),
				choices = facefusion.choices.face_landmarker_score_range,
				metavar = create_float_metavar(facefusion.choices.face_landmarker_score_range)
			)
		],
		scopes = [ 'api', 'cli' ]
	)

	return program


def create_face_selector_program() -> ArgumentParser:
	program = ArgumentParser(add_help = False)
	group_face_selector = program.add_argument_group('face selector')

	capability_store.register_capability_set(
		[
			group_face_selector.add_argument(
				'--face-selector-mode',
				help = translator.get('help.face_selector_mode'),
				default = config.get_str_value('face_selector', 'face_selector_mode', 'reference'),
				choices = facefusion.choices.face_selector_modes
			)
		],
		scopes = [ 'api', 'cli' ]
	)
	capability_store.register_capability_set(
		[
			group_face_selector.add_argument(
				'--face-selector-order',
				help = translator.get('help.face_selector_order'),
				default = config.get_str_value('face_selector', 'face_selector_order', 'large-small'),
				choices = facefusion.choices.face_selector_orders
			)
		],
		scopes = [ 'api', 'cli' ]
	)
	capability_store.register_capability_set(
		[
			group_face_selector.add_argument(
				'--face-selector-age-start',
				help = translator.get('help.face_selector_age_start'),
				type = int,
				default = config.get_int_value('face_selector', 'face_selector_age_start'),
				choices = facefusion.choices.face_selector_age_range,
				metavar = create_int_metavar(facefusion.choices.face_selector_age_range)
			)
		],
		scopes = [ 'api', 'cli' ]
	)
	capability_store.register_capability_set(
		[
			group_face_selector.add_argument(
				'--face-selector-age-end',
				help = translator.get('help.face_selector_age_end'),
				type = int,
				default = config.get_int_value('face_selector', 'face_selector_age_end'),
				choices = facefusion.choices.face_selector_age_range,
				metavar = create_int_metavar(facefusion.choices.face_selector_age_range)
			)
		],
		scopes = [ 'api', 'cli' ]
	)
	capability_store.register_capability_set(
		[
			group_face_selector.add_argument(
				'--face-selector-gender',
				help = translator.get('help.face_selector_gender'),
				default = config.get_str_value('face_selector', 'face_selector_gender'),
				choices = facefusion.choices.face_selector_genders
			)
		],
		scopes = [ 'api', 'cli' ]
	)
	capability_store.register_capability_set(
		[
			group_face_selector.add_argument(
				'--face-selector-race',
				help = translator.get('help.face_selector_race'),
				default = config.get_str_value('face_selector', 'face_selector_race'),
				choices = facefusion.choices.face_selector_races
			)
		],
		scopes = [ 'api', 'cli' ]
	)
	capability_store.register_capability_set(
		[
			group_face_selector.add_argument(
				'--reference-face-position',
				help = translator.get('help.reference_face_position'),
				type = int,
				default = config.get_int_value('face_selector', 'reference_face_position', '0')
			)
		],
		scopes = [ 'api', 'cli' ]
	)
	capability_store.register_capability_set(
		[
			group_face_selector.add_argument(
				'--reference-face-distance',
				help = translator.get('help.reference_face_distance'),
				type = float,
				default = config.get_float_value('face_selector', 'reference_face_distance', '0.3'),
				choices = facefusion.choices.reference_face_distance_range,
				metavar = create_float_metavar(facefusion.choices.reference_face_distance_range)
			)
		],
		scopes = [ 'api', 'cli' ]
	)
	capability_store.register_capability_set(
		[
			group_face_selector.add_argument(
				'--reference-frame-number',
				help = translator.get('help.reference_frame_number'),
				type = int,
				default = config.get_int_value('face_selector', 'reference_frame_number', '0')
			)
		],
		scopes = [ 'api', 'cli' ]
	)

	return program


def create_face_masker_program() -> ArgumentParser:
	program = ArgumentParser(add_help = False)
	group_face_masker = program.add_argument_group('face masker')

	capability_store.register_capability_set(
		[
			group_face_masker.add_argument(
				'--face-occluder-model',
				help = translator.get('help.face_occluder_model'),
				default = config.get_str_value('face_masker', 'face_occluder_model', 'xseg_1'),
				choices = facefusion.choices.face_occluder_models
			)
		],
		scopes = [ 'api', 'cli' ]
	)
	capability_store.register_capability_set(
		[
			group_face_masker.add_argument(
				'--face-parser-model',
				help = translator.get('help.face_parser_model'),
				default = config.get_str_value('face_masker', 'face_parser_model', 'bisenet_resnet_34'),
				choices = facefusion.choices.face_parser_models
			)
		],
		scopes = [ 'api', 'cli' ]
	)
	capability_store.register_capability_set(
		[
			group_face_masker.add_argument(
				'--face-mask-types',
				help = translator.get('help.face_mask_types').format(choices = ', '.join(facefusion.choices.face_mask_types)),
				default = config.get_str_list('face_masker', 'face_mask_types', 'box'),
				choices = facefusion.choices.face_mask_types,
				nargs = '+',
				metavar = 'FACE_MASK_TYPES'
			)
		],
		scopes = [ 'api', 'cli' ]
	)
	capability_store.register_capability_set(
		[
			group_face_masker.add_argument(
				'--face-mask-areas',
				help = translator.get('help.face_mask_areas').format(choices = ', '.join(facefusion.choices.face_mask_areas)),
				default = config.get_str_list('face_masker', 'face_mask_areas', ' '.join(facefusion.choices.face_mask_areas)),
				choices = facefusion.choices.face_mask_areas,
				nargs = '+',
				metavar = 'FACE_MASK_AREAS'
			)
		],
		scopes = [ 'api', 'cli' ]
	)
	capability_store.register_capability_set(
		[
			group_face_masker.add_argument(
				'--face-mask-regions',
				help = translator.get('help.face_mask_regions').format(choices = ', '.join(facefusion.choices.face_mask_regions)),
				default = config.get_str_list('face_masker', 'face_mask_regions', ' '.join(facefusion.choices.face_mask_regions)),
				choices = facefusion.choices.face_mask_regions,
				nargs = '+',
				metavar = 'FACE_MASK_REGIONS'
			)
		],
		scopes = [ 'api', 'cli' ]
	)
	capability_store.register_capability_set(
		[
			group_face_masker.add_argument(
				'--face-mask-blur',
				help = translator.get('help.face_mask_blur'),
				type = float,
				default = config.get_float_value('face_masker', 'face_mask_blur', '0.3'),
				choices = facefusion.choices.face_mask_blur_range,
				metavar = create_float_metavar(facefusion.choices.face_mask_blur_range)
			)
		],
		scopes = [ 'api', 'cli' ]
	)
	capability_store.register_capability_set(
		[
			group_face_masker.add_argument(
				'--face-mask-padding',
				help = translator.get('help.face_mask_padding'),
				type = partial(sanitize_int_range, int_range = facefusion.choices.face_mask_padding_range),
				default = config.get_int_list('face_masker', 'face_mask_padding', '0 0 0 0'),
				nargs = '+'
			)
		],
		scopes = [ 'api', 'cli' ]
	)

	return program


def create_voice_extractor_program() -> ArgumentParser:
	program = ArgumentParser(add_help = False)
	group_voice_extractor = program.add_argument_group('voice extractor')

	capability_store.register_capability_set(
		[
			group_voice_extractor.add_argument(
				'--voice-extractor-model',
				help = translator.get('help.voice_extractor_model'),
				default = config.get_str_value('voice_extractor', 'voice_extractor_model', 'kim_vocal_2'),
				choices = facefusion.choices.voice_extractor_models
			)
		],
		scopes = [ 'api', 'cli' ]
	)

	return program


def create_frame_extraction_program() -> ArgumentParser:
	program = ArgumentParser(add_help = False)
	group_frame_extraction = program.add_argument_group('frame extraction')

	capability_store.register_capability_set(
		[
			group_frame_extraction.add_argument(
				'--trim-frame-start',
				help = translator.get('help.trim_frame_start'),
				type = int,
				default = facefusion.config.get_int_value('frame_extraction', 'trim_frame_start')
			)
		],
		scopes = [ 'api', 'cli' ]
	)
	capability_store.register_capability_set(
		[
			group_frame_extraction.add_argument(
				'--trim-frame-end',
				help = translator.get('help.trim_frame_end'),
				type = int,
				default = facefusion.config.get_int_value('frame_extraction', 'trim_frame_end')
			)
		],
		scopes = [ 'api', 'cli' ]
	)
	capability_store.register_capability_set(
		[
			group_frame_extraction.add_argument(
				'--temp-frame-format',
				help = translator.get('help.temp_frame_format'),
				default = config.get_str_value('frame_extraction', 'temp_frame_format', 'png'),
				choices = facefusion.choices.temp_frame_formats
			)
		],
		scopes = [ 'api', 'cli' ]
	)

	return program


def create_output_creation_program() -> ArgumentParser:
	program = ArgumentParser(add_help = False)
	available_encoder_set = get_available_encoder_set()
	group_output_creation = program.add_argument_group('output creation')

	capability_store.register_capability_set(
		[
			group_output_creation.add_argument(
				'--output-image-quality',
				help = translator.get('help.output_image_quality'),
				type = int,
				default = config.get_int_value('output_creation', 'output_image_quality', '80'),
				choices = facefusion.choices.output_image_quality_range,
				metavar = create_int_metavar(facefusion.choices.output_image_quality_range)
			)
		],
		scopes = [ 'api', 'cli' ]
	)
	capability_store.register_capability_set(
		[
			group_output_creation.add_argument(
				'--output-image-scale',
				help = translator.get('help.output_image_scale'),
				type = float,
				default = config.get_float_value('output_creation', 'output_image_scale', '1.0'),
				choices = facefusion.choices.output_image_scale_range
			)
		],
		scopes = [ 'api', 'cli' ]
	)
	capability_store.register_capability_set(
		[
			group_output_creation.add_argument(
				'--output-audio-encoder',
				help = translator.get('help.output_audio_encoder'),
				default = config.get_str_value('output_creation', 'output_audio_encoder', get_first(available_encoder_set.get('audio'))),
				choices = available_encoder_set.get('audio')
			)
		],
		scopes = [ 'api', 'cli' ]
	)
	capability_store.register_capability_set(
		[
			group_output_creation.add_argument(
				'--output-audio-quality',
				help = translator.get('help.output_audio_quality'),
				type = int,
				default = config.get_int_value('output_creation', 'output_audio_quality', '80'),
				choices = facefusion.choices.output_audio_quality_range,
				metavar = create_int_metavar(facefusion.choices.output_audio_quality_range)
			)
		],
		scopes = [ 'api', 'cli' ]
	)
	capability_store.register_capability_set(
		[
			group_output_creation.add_argument(
				'--output-audio-volume',
				help = translator.get('help.output_audio_volume'),
				type = int,
				default = config.get_int_value('output_creation', 'output_audio_volume', '100'),
				choices = facefusion.choices.output_audio_volume_range,
				metavar = create_int_metavar(facefusion.choices.output_audio_volume_range)
			)
		],
		scopes = [ 'api', 'cli' ]
	)
	capability_store.register_capability_set(
		[
			group_output_creation.add_argument(
				'--output-video-encoder',
				help = translator.get('help.output_video_encoder'),
				default = config.get_str_value('output_creation', 'output_video_encoder', get_first(available_encoder_set.get('video'))),
				choices = available_encoder_set.get('video')
			)
		],
		scopes = [ 'api', 'cli' ]
	)
	capability_store.register_capability_set(
		[
			group_output_creation.add_argument(
				'--output-video-preset',
				help = translator.get('help.output_video_preset'),
				default = config.get_str_value('output_creation', 'output_video_preset', 'veryfast'),
				choices = facefusion.choices.video_presets
			)
		],
		scopes = [ 'api', 'cli' ]
	)
	capability_store.register_capability_set(
		[
			group_output_creation.add_argument(
				'--output-video-quality',
				help = translator.get('help.output_video_quality'),
				type = int,
				default = config.get_int_value('output_creation', 'output_video_quality', '80'),
				choices = facefusion.choices.output_video_quality_range,
				metavar = create_int_metavar(facefusion.choices.output_video_quality_range)
			)
		],
		scopes = [ 'api', 'cli' ]
	)
	capability_store.register_capability_set(
		[
			group_output_creation.add_argument(
				'--output-video-scale',
				help = translator.get('help.output_video_scale'),
				type = float,
				default = config.get_float_value('output_creation', 'output_video_scale', '1.0'),
				choices = facefusion.choices.output_video_scale_range
			)
		],
		scopes = [ 'api', 'cli' ]
	)
	capability_store.register_capability_set(
		[
			group_output_creation.add_argument(
				'--output-video-fps',
				help = translator.get('help.output_video_fps'),
				type = float,
				default = config.get_float_value('output_creation', 'output_video_fps')
			)
		],
		scopes = [ 'api', 'cli' ]
	)
	capability_store.register_capability_set(
		[
			group_output_creation.add_argument(
				'--output-audio-fps',
				help = translator.get('help.output_audio_fps'),
				type = float,
				default = config.get_float_value('output_creation', 'output_audio_fps', '25.0')
			)
		],
		scopes = [ 'api', 'cli' ]
	)

	return program


def create_processors_program() -> ArgumentParser:
	program = ArgumentParser(add_help = False)
	available_processors = [ get_file_name(file_path) for file_path in resolve_file_paths('facefusion/processors/modules') ]
	group_processors = program.add_argument_group('processors')

	capability_store.register_capability_set(
		[
			group_processors.add_argument(
				'--processors',
				help = translator.get('help.processors').format(choices = ', '.join(available_processors)),
				default = config.get_str_list('processors', 'processors', 'face_swapper'),
				choices = available_processors,
				nargs = '+'
			)
		],
		scopes = [ 'api', 'cli' ]
	)

	for processor_module in get_processors_modules(available_processors):
		processor_module.register_args(program)

	return program


def create_download_providers_program() -> ArgumentParser:
	program = ArgumentParser(add_help = False)
	group_download = program.add_argument_group('download')

	capability_store.register_capability_set(
		[
			group_download.add_argument(
				'--download-providers',
				help = translator.get('help.download_providers').format(choices = ', '.join(facefusion.choices.download_providers)),
				default = config.get_str_list('download', 'download_providers', ' '.join(facefusion.choices.download_providers)),
				choices = facefusion.choices.download_providers,
				nargs = '+',
				metavar = 'DOWNLOAD_PROVIDERS'
			)
		],
		scopes = [ 'cli', 'sys' ]
	)

	return program


def create_download_scope_program() -> ArgumentParser:
	program = ArgumentParser(add_help = False)
	group_download = program.add_argument_group('download')

	capability_store.register_capability_set(
		[
			group_download.add_argument(
				'--download-scope',
				help = translator.get('help.download_scope'),
				default = config.get_str_value('download', 'download_scope', 'lite'),
				choices = facefusion.choices.download_scopes
			)
		],
		scopes = [ 'cli', 'sys' ]
	)

	return program


def create_benchmark_program() -> ArgumentParser:
	program = ArgumentParser(add_help = False)
	group_benchmark = program.add_argument_group('benchmark')

	group_benchmark.add_argument(
		'--benchmark-mode',
		help = translator.get('help.benchmark_mode'),
		default = config.get_str_value('benchmark', 'benchmark_mode', 'warm'),
		choices = facefusion.choices.benchmark_modes
	)
	group_benchmark.add_argument(
		'--benchmark-resolutions',
		help = translator.get('help.benchmark_resolutions'),
		default = config.get_str_list('benchmark', 'benchmark_resolutions', get_first(facefusion.choices.benchmark_resolutions)),
		choices = facefusion.choices.benchmark_resolutions,
		nargs = '+'
	)
	group_benchmark.add_argument(
		'--benchmark-cycle-count',
		help = translator.get('help.benchmark_cycle_count'),
		type = int,
		default = config.get_int_value('benchmark', 'benchmark_cycle_count', '5'),
		choices = facefusion.choices.benchmark_cycle_count_range
	)

	return program


def create_api_program() -> ArgumentParser:
	program = ArgumentParser(add_help = False)
	group_api = program.add_argument_group('api')

	group_api.add_argument(
		'--api-host',
		help = translator.get('help.api_host'),
		default = config.get_str_value('api', 'api_host', '127.0.0.1')
	)
	group_api.add_argument(
		'--api-port',
		help = translator.get('help.api_port'),
		type = int,
		default = config.get_int_value('api', 'api_port', '8000')
	)
	capability_store.register_capability_set(
		[
			group_api.add_argument(
				'--api-security-strategy',
				help = translator.get('help.api_security_strategy'),
				default = config.get_str_value('api', 'api_security_strategy', 'strict'),
				choices = facefusion.choices.api_security_strategies
			)
		],
		scopes = [ 'api' ]
	)

	return program


def create_execution_program() -> ArgumentParser:
	program = ArgumentParser(add_help = False)
	available_execution_providers = get_available_execution_providers()
	group_execution = program.add_argument_group('execution')

	capability_store.register_capability_set(
		[
			group_execution.add_argument(
				'--execution-device-ids',
				help = translator.get('help.execution_device_ids'),
				type = int,
				default = config.get_str_list('execution', 'execution_device_ids', '0'),
				nargs = '+',
				metavar = 'EXECUTION_DEVICE_IDS'
			)
		],
		scopes = [ 'cli', 'sys' ]
	)
	capability_store.register_capability_set(
		[
			group_execution.add_argument(
				'--execution-providers',
				help = translator.get('help.execution_providers').format(choices = ', '.join(available_execution_providers)),
				default = config.get_str_list('execution', 'execution_providers', get_first(available_execution_providers)),
				choices = available_execution_providers,
				nargs = '+',
				metavar = 'EXECUTION_PROVIDERS'
			)
		],
		scopes = [ 'cli', 'sys' ]
	)
	capability_store.register_capability_set(
		[
			group_execution.add_argument(
				'--execution-thread-count',
				help = translator.get('help.execution_thread_count'),
				type = int,
				default = config.get_int_value('execution', 'execution_thread_count', '8'),
				choices = facefusion.choices.execution_thread_count_range,
				metavar = create_int_metavar(facefusion.choices.execution_thread_count_range)
			)
		],
		scopes = [ 'cli', 'sys' ]
	)

	return program


def create_memory_program() -> ArgumentParser:
	program = ArgumentParser(add_help = False)
	group_memory = program.add_argument_group('memory')

	capability_store.register_capability_set(
		[
			group_memory.add_argument(
				'--video-memory-strategy',
				help = translator.get('help.video_memory_strategy'),
				default = config.get_str_value('memory', 'video_memory_strategy', 'strict'),
				choices = facefusion.choices.video_memory_strategies
			)
		],
		scopes = [ 'cli', 'sys' ]
	)

	return program


def create_log_level_program() -> ArgumentParser:
	program = ArgumentParser(add_help = False)
	group_misc = program.add_argument_group('misc')

	capability_store.register_capability_set(
		[
			group_misc.add_argument(
				'--log-level',
				help = translator.get('help.log_level'),
				default = config.get_str_value('misc', 'log_level', 'info'),
				choices = facefusion.choices.log_levels
			)
		],
		scopes = [ 'cli' ]
	)

	return program


def create_halt_on_error_program() -> ArgumentParser:
	program = ArgumentParser(add_help = False)
	group_misc = program.add_argument_group('misc')

	capability_store.register_capability_set(
		[
			group_misc.add_argument(
				'--halt-on-error',
				help = translator.get('help.halt_on_error'),
				action = 'store_true',
				default = config.get_bool_value('misc', 'halt_on_error')
			)
		],
		scopes = [ 'cli' ]
	)

	return program


def create_job_id_program() -> ArgumentParser:
	program = ArgumentParser(add_help = False)

	program.add_argument(
		'job_id',
		help = translator.get('help.job_id'),
		type = sanitize_job_id
	)

	return program


def create_job_status_program() -> ArgumentParser:
	program = ArgumentParser(add_help = False)

	program.add_argument(
		'job_status',
		help = translator.get('help.job_status'),
		choices = facefusion.choices.job_statuses
	)

	return program


def create_step_index_program() -> ArgumentParser:
	program = ArgumentParser(add_help = False)

	program.add_argument(
		'step_index',
		help = translator.get('help.step_index'),
		type = int
	)

	return program


def collect_step_program() -> ArgumentParser:
	return ArgumentParser(
		parents =
		[
			create_face_detector_program(),
			create_face_landmarker_program(),
			create_face_selector_program(),
			create_face_masker_program(),
			create_voice_extractor_program(),
			create_frame_extraction_program(),
			create_output_creation_program(),
			create_processors_program()
		],
		add_help = False
	)


def collect_job_program() -> ArgumentParser:
	return ArgumentParser(
		parents =
		[
			create_workflow_program(),
			create_execution_program(),
			create_download_providers_program(),
			create_memory_program(),
			create_log_level_program()
		],
		add_help = False
	)


def create_program() -> ArgumentParser:
	program = ArgumentParser(formatter_class = create_help_formatter_large, add_help = False)
	program._positionals.title = 'commands'

	program.add_argument(
		'-v', '--version',
		version = metadata.get('name') + ' ' + metadata.get('version'),
		action = 'version'
	)

	sub_program = program.add_subparsers(dest = 'command')
	sub_program.add_parser(
		'run',
		help = translator.get('help.run'),
		parents =
		[
			create_config_path_program(),
			create_temp_path_program(),
			create_jobs_path_program(),
			create_source_paths_program(),
			create_target_path_program(),
			create_output_path_program(),
			collect_step_program(),
			collect_job_program()
		],
		formatter_class = create_help_formatter_large
	)
	sub_program.add_parser(
		'batch-run',
		help = translator.get('help.batch_run'),
		parents =
		[
			create_config_path_program(),
			create_temp_path_program(),
			create_jobs_path_program(),
			create_source_pattern_program(),
			create_target_pattern_program(),
			create_output_pattern_program(),
			collect_step_program(),
			collect_job_program()
		],
		formatter_class = create_help_formatter_large
	)
	sub_program.add_parser(
		'force-download',
		help = translator.get('help.force_download'),
		parents =
		[
			create_download_providers_program(),
			create_download_scope_program(),
			create_log_level_program()
		],
		formatter_class = create_help_formatter_large
	)
	sub_program.add_parser(
		'benchmark',
		help = translator.get('help.benchmark'),
		parents =
		[
			create_temp_path_program(),
			collect_step_program(),
			create_benchmark_program(),
			collect_job_program()
		],
		formatter_class = create_help_formatter_large
	)
	sub_program.add_parser(
		'api',
		help = translator.get('help.api'),
		parents =
		[
			create_config_path_program(),
			create_temp_path_program(),
			create_jobs_path_program(),
			create_api_program(),
			collect_step_program(),
			collect_job_program()
		],
		formatter_class = create_help_formatter_large
	)
	sub_program.add_parser(
		'job-list',
		help = translator.get('help.job_list'),
		parents =
		[
			create_job_status_program(),
			create_jobs_path_program(),
			create_log_level_program()
		],
		formatter_class = create_help_formatter_large
	)
	sub_program.add_parser(
		'job-create',
		help = translator.get('help.job_create'),
		parents =
		[
			create_job_id_program(),
			create_jobs_path_program(),
			create_log_level_program()
		],
		formatter_class = create_help_formatter_large
	)
	sub_program.add_parser(
		'job-submit',
		help = translator.get('help.job_submit'),
		parents =
		[
			create_job_id_program(),
			create_jobs_path_program(),
			create_log_level_program()
		],
		formatter_class = create_help_formatter_large
	)
	sub_program.add_parser(
		'job-submit-all',
		help = translator.get('help.job_submit_all'),
		parents =
		[
			create_jobs_path_program(),
			create_log_level_program(),
			create_halt_on_error_program()
		],
		formatter_class = create_help_formatter_large
	)
	sub_program.add_parser(
		'job-delete',
		help = translator.get('help.job_delete'),
		parents =
		[
			create_job_id_program(),
			create_jobs_path_program(),
			create_log_level_program()
		],
		formatter_class = create_help_formatter_large
	)
	sub_program.add_parser(
		'job-delete-all',
		help = translator.get('help.job_delete_all'),
		parents =
		[
			create_jobs_path_program(),
			create_log_level_program(),
			create_halt_on_error_program()
		],
		formatter_class = create_help_formatter_large
	)
	sub_program.add_parser(
		'job-add-step',
		help = translator.get('help.job_add_step'),
		parents =
		[
			create_job_id_program(),
			create_workflow_program(),
			create_config_path_program(),
			create_jobs_path_program(),
			create_source_paths_program(),
			create_target_path_program(),
			create_output_path_program(),
			collect_step_program(),
			create_log_level_program()
		],
		formatter_class = create_help_formatter_large
	)
	sub_program.add_parser(
		'job-remix-step',
		help = translator.get('help.job_remix_step'),
		parents =
		[
			create_job_id_program(),
			create_workflow_program(),
			create_step_index_program(),
			create_config_path_program(),
			create_jobs_path_program(),
			create_source_paths_program(),
			create_output_path_program(),
			collect_step_program(),
			create_log_level_program()
		],
		formatter_class = create_help_formatter_large
	)
	sub_program.add_parser(
		'job-insert-step',
		help = translator.get('help.job_insert_step'),
		parents =
		[
			create_job_id_program(),
			create_workflow_program(),
			create_step_index_program(),
			create_config_path_program(),
			create_jobs_path_program(),
			create_source_paths_program(),
			create_target_path_program(),
			create_output_path_program(),
			collect_step_program(),
			create_log_level_program()
		],
		formatter_class = create_help_formatter_large
	)
	sub_program.add_parser(
		'job-remove-step',
		help = translator.get('help.job_remove_step'),
		parents =
		[
			create_job_id_program(),
			create_step_index_program(),
			create_jobs_path_program(),
			create_log_level_program()
		],
		formatter_class = create_help_formatter_large
	)
	sub_program.add_parser(
		'job-run',
		help = translator.get('help.job_run'),
		parents =
		[
			create_job_id_program(),
			create_config_path_program(),
			create_temp_path_program(),
			create_jobs_path_program(),
			collect_job_program()
		],
		formatter_class = create_help_formatter_large
	)
	sub_program.add_parser(
		'job-run-all',
		help = translator.get('help.job_run_all'),
		parents =
		[
			create_config_path_program(),
			create_temp_path_program(),
			create_jobs_path_program(),
			collect_job_program(),
			create_halt_on_error_program()
		],
		formatter_class = create_help_formatter_large
	)
	sub_program.add_parser(
		'job-retry',
		help = translator.get('help.job_retry'),
		parents =
		[
			create_job_id_program(),
			create_config_path_program(),
			create_temp_path_program(),
			create_jobs_path_program(),
			collect_job_program()
		],
		formatter_class = create_help_formatter_large
	)
	sub_program.add_parser(
		'job-retry-all',
		help = translator.get('help.job_retry_all'),
		parents =
		[
			create_config_path_program(),
			create_temp_path_program(),
			create_jobs_path_program(),
			collect_job_program(),
			create_halt_on_error_program()
		],
		formatter_class = create_help_formatter_large
	)

	return ArgumentParser(parents = [ program ], formatter_class = create_help_formatter_small)


def apply_config_path(program : ArgumentParser) -> None:
	known_args, _ = program.parse_known_args()
	state_manager.init_item('config_path', known_args.config_path)