from __future__ import annotations

import argparse
import logging as _logging
import numbers
import re
import warnings
from collections.abc import Callable
from pathlib import Path
from string import printable
from textwrap import dedent
from typing import Any

from streamlink import __version__ as streamlink_version, logger
from streamlink.exceptions import StreamlinkDeprecationWarning
from streamlink.options import Options
from streamlink.plugin import Plugin
from streamlink.session import Streamlink
from streamlink.user_input import UserInputRequester
from streamlink.utils.args import boolean, comma_list, comma_list_filter, filesize, keyvalue, num
from streamlink.utils.times import hours_minutes_seconds_float
from streamlink_cli.constants import STREAM_PASSTHROUGH
from streamlink_cli.exceptions import StreamlinkCLIError
from streamlink_cli.output.player import PlayerOutput
from streamlink_cli.utils import find_default_player


log = _logging.getLogger(__name__)


class ArgumentParser(argparse.ArgumentParser):
    # noinspection PyUnresolvedReferences,PyProtectedMember
    NESTED_ARGUMENT_GROUPS: dict[argparse._ArgumentGroup | None, list[argparse._ArgumentGroup]]

    _RE_PRINTABLE = re.compile(rf"[{re.escape(printable)}]")
    _RE_OPTION = re.compile(r"^(?P<name>[A-Za-z0-9-]+)(?:(?P<op>\s*=\s*|\s+)(?P<value>.*))?$")

    def __init__(self, *args, **kwargs):
        self.NESTED_ARGUMENT_GROUPS = {}
        super().__init__(*args, **kwargs)

    # noinspection PyUnresolvedReferences,PyProtectedMember
    def add_argument_group(
        self,
        *args,
        parent: argparse._ArgumentGroup | None = None,
        **kwargs,
    ) -> argparse._ArgumentGroup:
        group = super().add_argument_group(*args, **kwargs)
        if parent not in self.NESTED_ARGUMENT_GROUPS:
            self.NESTED_ARGUMENT_GROUPS[parent] = [group]
        else:
            self.NESTED_ARGUMENT_GROUPS[parent].append(group)
        return group

    def convert_arg_line_to_args(self, line):
        # Strip any non-printable characters that might be in the
        # beginning of the line (e.g. Unicode BOM marker).
        match = self._RE_PRINTABLE.search(line)
        if not match:
            return
        line = line[match.start() :].strip()

        # Skip lines that do not start with a valid option (e.g. comments)
        option = self._RE_OPTION.match(line)
        if not option:
            return

        name, op, value = option.group("name", "op", "value")
        prefix = self.prefix_chars[0] if len(name) == 1 else self.prefix_chars[0] * 2
        if value or op:
            yield f"{prefix}{name}={value}"
        else:
            yield f"{prefix}{name}"

    # noinspection PyProtectedMember,PyUnresolvedReferences,PyTypeChecker
    def _match_argument(self, action, arg_strings_pattern):
        # - https://github.com/streamlink/streamlink/issues/971
        # - https://bugs.python.org/issue9334
        # - https://github.com/python/cpython/blame/v3.13.0rc2/Lib/argparse.py#L2227-L2247

        # match the pattern for this action to the arg strings
        nargs_pattern = self._get_nargs_pattern(action)
        match = re.match(nargs_pattern, arg_strings_pattern)

        # if no match, see if we can emulate optparse and return the
        # required number of arguments regardless of their values
        if match is None:
            nargs = action.nargs if action.nargs is not None else 1
            if isinstance(nargs, numbers.Number) and len(arg_strings_pattern) >= nargs:
                return nargs

        # raise an exception if we weren't able to find a match
        if match is None:
            nargs_errors = {
                None: argparse._("expected one argument"),
                argparse.OPTIONAL: argparse._("expected at most one argument"),
                argparse.ONE_OR_MORE: argparse._("expected at least one argument"),
            }
            msg = nargs_errors.get(action.nargs)
            if msg is None:
                msg = argparse.ngettext("expected %s argument", "expected %s arguments", action.nargs) % action.nargs
            raise argparse.ArgumentError(action, msg)

        # return the number of arguments matched
        return len(match.group(1))

    # fix `--help` not including nested argument groups
    def format_help(self):
        formatter = self._get_formatter()

        # usage
        formatter.add_usage(self.usage, self._actions, self._mutually_exclusive_groups)

        # description
        formatter.add_text(self.description)

        def format_group(parent):
            if parent not in self.NESTED_ARGUMENT_GROUPS:
                return
            # positionals, optionals and user-defined groups
            for action_group in self.NESTED_ARGUMENT_GROUPS[parent]:
                formatter.start_section(action_group.title)
                formatter.add_text(action_group.description)
                formatter.add_arguments(action_group._group_actions)
                format_group(action_group)
                formatter.end_section()

        format_group(None)

        # epilog
        formatter.add_text(self.epilog)

        # determine help from format above
        return formatter.format_help()


class HelpFormatter(argparse.RawDescriptionHelpFormatter):
    """A nicer help formatter.

    Help for arguments can be indented and contain new lines.
    It will be de-dented and arguments in the help will be
    separated by a blank line for better readability.

    Originally written by Jakub Roztocil of the httpie project.
    """

    def __init__(self, max_help_position=4, *args, **kwargs):
        # A smaller indent for args help.
        kwargs["max_help_position"] = max_help_position
        super().__init__(*args, **kwargs)

    def _split_lines(self, text, width):
        return f"{dedent(text).strip()}\n\n".splitlines()


def build_parser():
    parser = ArgumentParser(
        prog="streamlink",
        fromfile_prefix_chars="@",
        formatter_class=HelpFormatter,
        add_help=False,
        usage="%(prog)s [OPTIONS] <URL> [STREAM]",
        description=dedent("""
            Streamlink is a command-line utility that extracts streams from various
            services and pipes them into a video player of choice.
        """),
        epilog=dedent("""
            For more in-depth documentation see:
              https://streamlink.github.io/

            Please report broken plugins or bugs to the issue tracker on GitHub:
              https://github.com/streamlink/streamlink/issues
        """),
    )

    positional = parser.add_argument_group("Positional arguments")
    positional.add_argument(
        "url",
        metavar="URL",
        nargs="?",
        help="""
            A URL to attempt to extract streams from.

            Usually, the protocol of http(s) URLs can be omitted (`https://`),
            depending on the implementation of the plugin being used.

            Alternatively, the URL can also be specified by using the --url option.
        """,
    )
    positional.add_argument(
        "stream",
        metavar="STREAM",
        nargs="?",
        type=comma_list,
        help="""
            Stream to play.

            Use `best` or `worst` for selecting the highest or lowest available quality.

            Fallback streams can be specified by using a comma-separated list:

              "720p,480p,best"

            If no stream is specified and --default-stream is not used, then a list of available streams will be printed.
        """,
    )

    general = parser.add_argument_group("General options")
    general.add_argument(
        "-h",
        "--help",
        action="store_true",
        help="""
            Show this help message and exit.
        """,
    )
    general.add_argument(
        "-V",
        "--version",
        action="version",
        version=f"%(prog)s {streamlink_version}",
        help="""
            Show version string and exit.
        """,
    )
    general.add_argument(
        "--version-check",
        action="store_true",
        help="""
            Run a version check and exit.
        """,
    )
    general.add_argument(
        "--auto-version-check",
        type=boolean,
        metavar="{yes,true,1,on,no,false,0,off}",
        default=False,
        help="""
            Enable or disable the automatic check for a new version of Streamlink.

            Default is "no".
        """,
    )
    general.add_argument(
        "--config",
        action="append",
        metavar="FILENAME",
        help="""
            Load options from this config file.

            Can be repeated to load multiple files, in which case the options are
            merged on top of each other where the last config has highest priority.
        """,
    )
    general.add_argument(
        "--no-config",
        action="store_true",
        help="""
            Disable loading any default or custom config files.
        """,
    )
    general.add_argument(
        "--locale",
        type=str,
        metavar="LOCALE",
        help="""
            Override the system's locale setting, for selecting the preferred subtitle and audio language.

            The locale is formatted as `[language_code]_[country_code]`, e.g. `en_US` or `es_ES`.

            Default is system locale.
        """,
    )

    logging = parser.add_argument_group("Logging arguments")
    logging.add_argument(
        "-l",
        "--loglevel",
        metavar="LEVEL",
        choices=logger.levels,
        default="info",
        help=f"""
            Set the log message threshold.

            Valid levels are, in order of increasing verbosity:

            {", ".join([f"`{level}`" for level in logger.levels])}

            Default is "info".
        """,
    )
    logging.add_argument(
        "--logformat",
        metavar="FORMAT",
        help="""
            Set a custom logging format.

            See the Python standard library's `logging.Formatter` docs for more information about the logging format
            and the available `LogRecord` attributes. Streamlink's formatter uses the curly brace style.

            The default format depends on the chosen log level.

            For verbose levels (`trace` and `all`):

            Default is "[{asctime}][{threadName}][{name}][{levelname}] {message}".

            Otherwise:

            Default is "[{name}][{levelname}] {message}".
        """,
    )
    logging.add_argument(
        "--logdateformat",
        metavar="DATEFORMAT",
        help="""
            Set a custom logging date format.

            This formats the `LogRecord`'s `asctime` attribute via `strftime()`.

            The default date format depends on the chosen log level.

            For verbose levels (`trace` and `all`):

            Default is "%%H:%%M:%%S.%%f".

            Otherwise:

            Default is "%%H:%%M:%%S".
        """,
    )
    logging.add_argument(
        "--logfile",
        metavar="FILE",
        help="""
            Append log output to `FILE` instead of writing to stdout/stderr.

            User prompts and download progress won't be written to `FILE`.

            A value of `-` (dash) will set the file name to an ISO8601-like string
            and will choose the following default log directories.

            Windows:

              %%TEMP%%\\streamlink\\logs

            macOS:

              ${HOME}/Library/Logs/streamlink

            Linux/BSD:

              ${XDG_STATE_HOME:-${HOME}/.local/state}/streamlink/logs
        """,
    )
    logging.add_argument(
        "-Q",
        "--quiet",
        action="store_true",
        help="""
            Suppress all console and log output, and also disable user prompts.
        """,
    )
    logging.add_argument(
        "-j",
        "--json",
        action="store_true",
        help="""
            Output JSON representations instead of the normal text output.

            Useful for external scripting.
        """,
    )

    plugin = parser.add_argument_group("Plugin options")
    plugin.add_argument(
        "--plugins",
        action="store_true",
        help="""
            Print a list of all currently installed plugins.
        """,
    )
    plugin.add_argument(
        "--show-matchers",
        metavar="PLUGIN",
        help="""
            Show the list of matchers of a specific plugin (URL regex pattern with opt. priority and opt. name).

            The output is a human-readable pseudo YAML format. Please use --json when reading matcher data programmatically.
        """,
    )
    plugin.add_argument(
        "--can-handle-url",
        metavar="URL",
        help="""
            Check if Streamlink has a plugin that can handle the specified URL.

            Status code is `0` on success, `1` on failure.

            Useful for external scripting.
        """,
    )
    plugin.add_argument(
        "--can-handle-url-no-redirect",
        metavar="URL",
        help="""
            Same as --can-handle-url, but without following redirects when looking up the URL.
        """,
    )
    plugin.add_argument(
        "--no-plugin-cache",
        action="store_true",
        default=None,
        help="""
            Disable I/O of the plugin key-value store.

            If disabled, plugins won't be able to load or store data like cookies, authentication data, etc.
            The data which is loaded or stored depends on each plugin implementation.
        """,
    )
    plugin.add_argument(
        "--no-plugin-sideloading",
        action="store_true",
        help="""
            Disable automatic sideloading of third-party plugins from the default location.

            See the plugin-sideloading documentation for where third-party plugins are loaded from.
        """,
    )
    plugin.add_argument(
        "--plugin-dir",
        dest="plugin_dirs",
        metavar="DIRECTORY",
        action="append",
        help="""
            Load additional plugins from this directory.

            Can be set multiple times to load plugins from multiple directories.
        """,
    )
    plugin.add_argument(
        "--plugin-dirs",
        metavar="DIRECTORY",
        type=comma_list,
        action="extend",
        help="""
            Load additional plugins from a list of comma-separated directories. (deprecated)
        """,
    )

    network = parser.add_argument_group("Network arguments")
    network.add_argument(
        "--interface",
        type=str,
        metavar="INTERFACE",
        help="""
            Set the network interface.
        """,
    )
    network.add_argument(
        "-4",
        "--ipv4",
        action="store_true",
        default=None,
        help="""
            Resolve address names to IPv4 only. This option overrides --ipv6.
        """,
    )
    network.add_argument(
        "-6",
        "--ipv6",
        action="store_true",
        default=None,
        help="""
            Resolve address names to IPv6 only. This option overrides --ipv4.
        """,
    )

    player = parser.add_argument_group("Player options")
    player.add_argument(
        "-p",
        "--player",
        metavar="PATH",
        type=Path,
        default=find_default_player(),
        help="""
            Set the player executable that will be launched (unless a different output method was chosen).

            Either set an absolute or relative path to the player executable, or just set the executable's name
            if it can be resolved from the paths of the system's `PATH` environment variable.

            In addition to setting the player executable path, custom player arguments can be set via --player-args.

            Note: In the past, --player allowed defining additional player arguments, which as a consequence required wrapping
            player paths that contained spaces in quotation marks. This is unsupported since release `6.0.0`.

            Default is VLC player, if available.
        """,
    )
    player.add_argument(
        "-a",
        "--player-args",
        metavar="ARGUMENTS",
        default="",
        help=f"""
            Set a string of custom --player launch arguments that will be parsed and tokenized.

            The value can contain formatting variables surrounded by curly braces, `{{` and `}}`.
            Curly brace characters can be escaped by doubling, e.g. `{{{{` and `}}}}`.

            Available formatting variables:

            `{{{PlayerOutput.PLAYER_ARGS_INPUT}}}`
                This is the input argument that the --player will receive. For standard input (stdin),
                it is `-` (dash), but it can also be a file path or URL, depending on the options used.
                If unset, then the player input argument will be appended to the parsed player arguments list.

            `{{{PlayerOutput.PLAYER_ARGS_TITLE}}}`
                The automatically generated player title arguments, if a supported --player was found. See --title for more.
                If unset, automatically generated player title arguments will be prepended to the parsed player arguments list.

            Example:

              %(prog)s -p vlc -a "--play-and-exit --no-one-instance" <url> [stream]

            Default is "".
        """,
    )
    player.add_argument(
        "--player-env",
        metavar="KEY=VALUE",
        type=keyvalue,
        action="append",
        help="""
            Add an additional environment variable to the spawned --player process, in addition to the ones inherited from
            the Streamlink/Python parent process. This allows setting player environment variables in config files.

            Can be repeated to add multiple environment variables.
        """,
    )
    player.add_argument(
        "-v",
        "--player-verbose",
        action="store_true",
        help="""
            Write the --player's stdout/stderr output to Streamlink's stdout/stderr output.
        """,
    )
    player.add_argument(
        "--verbose-player",
        dest="player_verbose",
        action="store_true",
        help="""
            Deprecated in favor of --player-verbose.
        """,
    )
    player.add_argument(
        "-n",
        "--player-fifo",
        action="store_true",
        help="""
            Make the --player read the stream through a named pipe instead of the stdin pipe.
        """,
    )
    player.add_argument(
        "--fifo",
        dest="player_fifo",
        action="store_true",
        help="""
            Deprecated in favor of --player-fifo.
        """,
    )
    player.add_argument(
        "--player-http",
        action="store_true",
        help="""
            Make the --player read the stream through HTTP instead of the stdin pipe.
        """,
    )
    player.add_argument(
        "--player-continuous-http",
        action="store_true",
        help="""
            Make the --player read the stream through HTTP, but unlike --player-http,
            it will continuously try to open the stream if the player requests it.

            This enables the handling of stream disconnects if the player is
            capable of reconnecting to a HTTP stream. This is usually done by
            setting the player to a "repeat mode".
        """,
    )
    player.add_argument(
        "--player-external-http",
        action="store_true",
        help="""
            Serve stream data through HTTP without opening the --player. This is
            useful to allow external devices like smartphones or streaming boxes to
            watch streams they wouldn't be able to otherwise.

            The default behavior is similar to the --player-continuous-http option,
            but no player program will be started, and the server will listen on all available
            connections instead of just in the local (loopback) interface.

            See --player-external-http-interface for choosing a specific network interface, and
            see --player-external-http-port for choosing a non-randomized port.

            Optionally, the --player-external-http-continuous option allows for disabling
            the continuous run-mode, so that Streamlink will stop when the stream ends.

            The URLs that can be used to access the stream will be printed to the
            console, and the server can be interrupted using CTRL-C.
        """,
    )
    player.add_argument(
        "--player-external-http-continuous",
        type=boolean,
        metavar="{yes,true,1,on,no,false,0,off}",
        default=True,
        help="""
            Set the run-mode of --player-external-http to continuous or non-continuous.

            In the continuous run-mode, Streamlink will keep running after the stream has ended
            and will wait for the next HTTP request being made unless it gets shut down via CTRL-C.

            If set to non-continuous, Streamlink will stop once the stream has ended.

            Default is true.
        """,
    )
    player.add_argument(
        "--player-external-http-interface",
        metavar="INTERFACE",
        help="""
            Set the network interface on which the HTTP server will be listening on.
            If unset or set to `0.0.0.0`, all available interfaces will be bound.
        """,
    )
    player.add_argument(
        "--player-external-http-port",
        metavar="PORT",
        type=num(int, ge=0, le=65535),
        default=0,
        help="""
            Set the port of the external HTTP server if that mode is enabled.
            Omit or set to `0` to use a random high ( >1024) port.
        """,
    )
    player.add_argument(
        "--player-passthrough",
        metavar="TYPES",
        type=comma_list_filter(STREAM_PASSTHROUGH),
        default=[],
        help=f"""
            A comma-delimited list of stream types to pass to the --player as a URL to
            let it handle the transport of the stream instead of Streamlink.

            Stream types that can be converted into a playable URL are:

            {", ".join(STREAM_PASSTHROUGH)}

            Make sure the player can handle the stream type when using this.
        """,
    )
    player.add_argument(
        "--player-no-close",
        action="store_true",
        help="""
            By default, Streamlink will close the --player when the stream ends.
            This is to avoid "dead" GUI players lingering after Streamlink has exited.

            It does however have the side-effect of sometimes closing a
            player before it has played back all of its cached data.

            This option will instead let the player decide when to exit.
        """,
    )
    player.add_argument(
        "-t",
        "--title",
        metavar="TITLE",
        help=f"""
            Change the title of the --player's window.

            Please see the "Metadata variables" section of Streamlink's CLI documentation for all available metadata variables,
            as well as the "Plugins" section for the list of metadata variables defined in each plugin.

            Only the following players are supported:

            {", ".join(sorted(PlayerOutput.PLAYERS.keys()))}

            Example:

                %(prog)s -p mpv --title "{{author}} - {{category}} - {{title}}" <URL> [STREAM]
        """,
    )

    output = parser.add_argument_group("File output options")
    output.add_argument(
        "-O",
        "--stdout",
        action="store_true",
        help="""
            Write stream data to `stdout` instead of playing it in the --player.
        """,
    )
    output.add_argument(
        "-o",
        "--output",
        metavar="FILENAME",
        help="""
            Write stream data to `FILENAME` instead of playing it in the --player.
            If `FILENAME` is set to `-` (dash), then the stream data will be written to `stdout`,
            similar to the --stdout argument.

            Directories and subdirectories will be created if they do not exist, if filesystem permissions allow.

            Unless --force is set, Streamlink will ask for confirmation before writing if `FILENAME` already exists.

            Please see the "Metadata variables" section of Streamlink's CLI documentation for all available metadata variables,
            as well as the "Plugins" section for the list of metadata variables defined in each plugin.

            Unsupported characters in substituted variables will be replaced with an underscore.

            Example:

                %(prog)s --output "~/recordings/{author}/{category}/{id}-{time:%%Y%%m%%d%%H%%M%%S}.ts" <URL> [STREAM]
        """,
    )
    output.add_argument(
        "-r",
        "--record",
        metavar="FILENAME",
        help="""
            Write stream data to `FILENAME` while at the same time allowing playback in the --player or writing it to --stdout.
            If `FILENAME` is set to `-` (dash), then the stream data will be written to `stdout`,
            similar to the --stdout argument, while still opening the player.

            Directories and subdirectories will be created if they do not exist, if filesystem permissions allow.

            Unless --force is set, Streamlink will ask for confirmation before writing if `FILENAME` already exists.

            Please see the "Metadata variables" section of Streamlink's CLI documentation for all available metadata variables,
            as well as the "Plugins" section for the list of metadata variables defined in each plugin.

            Unsupported characters in substituted variables will be replaced with an underscore.

            Example:

                %(prog)s --record "~/recordings/{author}/{category}/{id}-{time:%%Y%%m%%d%%H%%M%%S}.ts" <URL> [STREAM]
        """,
    )
    output.add_argument(
        "-R",
        "--record-and-pipe",
        metavar="FILENAME",
        help="""
            Deprecated in favor of --stdout --record=FILENAME.
        """,
    )
    output.add_argument(
        "--fs-safe-rules",
        metavar="{POSIX,Windows}",
        choices=["POSIX", "Windows"],
        type=str,
        help="""
            The rules used to make formatting variables filesystem-safe are chosen
            automatically according to the type of system in use. This overrides
            the automatic detection.

            Intended for use when Streamlink is running on a UNIX-like OS but writing
            to Windows filesystems such as NTFS; USB devices using VFAT or exFAT; CIFS
            shares that are enforcing Windows filename limitations, etc.

            These characters are replaced with an underscore for the rules in use:

            - POSIX: `\\x00-\\x1F /`
            - Windows: `\\x00-\\x1F \\x7F " * / : < > ? \\ |`
        """,
    )
    output.add_argument(
        "-f",
        "--force",
        action="store_true",
        help="""
            When using --output or --record, always write to file even if it already exists (overwrite).
        """,
    )
    output.add_argument(
        "--skip",
        action="store_true",
        help="""
            When using --output or --record, never write to file if it already exists (don't prompt).

            Takes precedence over --force.
        """,
    )
    output.add_argument(
        "--progress",
        metavar="{yes,force,no}",
        choices=("yes", "force", "no"),
        default="yes",
        help="""
            When using --output or --record, show or hide the download progress bar, or force it if there's no terminal.

            Default is yes.
        """,
    )

    stream = parser.add_argument_group("Stream options")
    stream.add_argument(
        "--url",
        dest="url_param",
        metavar="URL",
        help="""
            A URL to attempt to extract streams from.

            Usually, the protocol of http(s) URLs can be omitted (`https://`),
            depending on the implementation of the plugin being used.

            This is an alternative to setting the URL using a positional argument and can be useful if set in a config file.
        """,
    )
    stream.add_argument(
        "--default-stream",
        type=comma_list,
        metavar="STREAM",
        help="""
            Stream to play.

            Use `best` or `worst` for selecting the highest or lowest available quality.

            Fallback streams can be specified by using a comma-separated list:

              "720p,480p,best"

            This is an alternative to setting the stream using a positional argument and can be useful if set in a config file.
        """,
    )
    stream.add_argument(
        "--stream-url",
        action="store_true",
        help="""
            If possible, translate the resolved stream to a URL and print it.
        """,
    )
    stream.add_argument(
        "--retry-streams",
        metavar="DELAY",
        type=num(float, ge=0),
        help="""
            Retry fetching the list of available streams until streams are found
            while waiting `DELAY` second(s) between each attempt.

            The number of retry attempts can be capped with --retry-max.
            A default value of ``1`` is implied for non-zero values of --retry-max.

            If both --retry-streams and --retry-max are set to `0`, then only one attempt will be made
            to fetch the list of available streams. This is the default behavior.
        """,
    )
    stream.add_argument(
        "--retry-max",
        metavar="COUNT",
        type=num(int, ge=0),
        help="""
            Stop fetching the list of available streams after `COUNT` retry attempt(s).

            A value of `0` makes Streamlink fetch streams indefinitely if --retry-streams is set to a non-zero value.
            If --retry-streams is unset, then the default delay between fetching available streams is 1 second.
        """,
    )
    stream.add_argument(
        "--retry-open",
        metavar="ATTEMPTS",
        type=num(int, ge=1),
        default=1,
        help="""
            After a successful fetch, try `ATTEMPTS` time(s) to open the stream until giving up.

            Default is 1.
        """,
    )
    stream.add_argument(
        "--stream-types",
        "--stream-priority",
        metavar="TYPES",
        type=comma_list,
        help="""
            A comma-delimited list of stream types to allow.

            The order will be used to separate streams when there are multiple
            streams with the same name but different stream types. Any stream type
            not listed will be omitted from the available streams list.  An `*` (asterisk) can
            be used as a wildcard to match any other type of stream, e.g. dash.

            Default is "hls,http,*".
        """,
    )
    stream.add_argument(
        "--stream-sorting-excludes",
        metavar="STREAMS",
        type=comma_list,
        help="""
            Fine-tune the `best` and `worst` stream name synonyms by excluding unwanted streams.

            If all of the available streams get excluded, `best` and `worst` will become
            inaccessible and new special stream synonyms `best-unfiltered` and `worst-unfiltered`
            can be used as a fallback selection method.

            The filter-expression's format is:

              [operator]<value>

            Valid operators are `>`, `>=`, `<` and `<=`. If no operator is specified then
            equality is tested.

            For example this will exclude streams ranked higher than "480p":

              --stream-sorting-excludes ">480p"

            Multiple filters can be used by separating each expression with a comma.

            For example this will exclude streams from two quality types:

              --stream-sorting-excludes ">480p,>medium"

        """,
    )

    transport = parser.add_argument_group("Stream transport options")
    transport_hls = parser.add_argument_group("HLS options", parent=transport)
    transport_dash = parser.add_argument_group("DASH options", parent=transport)
    transport_ffmpeg = parser.add_argument_group("FFmpeg options", parent=transport)

    transport.add_argument(
        "--ringbuffer-size",
        metavar="SIZE",
        type=filesize,
        help="""
            The maximum size of the ringbuffer.

            Mebibytes or kibibytes (base 2) can be specified via the M or K suffix respectively.

            The ringbuffer is used as a temporary storage between the stream and the player.
            This allows Streamlink to download the stream faster than the player which reads the data from the ringbuffer.

            The smaller the size of the ringbuffer, the higher the chance of the player buffering if the download speed
            decreases, and the higher the size, the more data can be use as a storage to recover from volatile download speeds.

            Most players have their own additional cache and will read the ringbuffer's content as soon as data is available.
            If the player stops reading data while playback is paused, Streamlink will continue to download the stream in the
            background as long as the ringbuffer doesn't get full.

            Default is "16M".
        """,
    )
    transport.add_argument(
        "--stream-segment-attempts",
        type=num(int, ge=1),
        metavar="ATTEMPTS",
        help="""
            The number of download attempts of each stream segment before giving up.

            This applies to all different kinds of segmented stream types, such as DASH, HLS, etc.

            Default is 3.
        """,
    )
    transport.add_argument(
        "--stream-segment-threads",
        type=num(int, ge=1, le=10),
        metavar="THREADS",
        help="""
            The size of the thread pool used to download segments. Minimum value is `1` and maximum is `10`.

            This applies to all different kinds of segmented stream types, such as DASH, HLS, etc.

            Default is 1.
        """,
    )
    transport.add_argument(
        "--stream-segment-timeout",
        type=num(float, gt=0),
        metavar="TIMEOUT",
        help="""
            The maximum time to wait for each segment to start downloading.

            This applies to all different kinds of segmented stream types, such as DASH, HLS, etc.

            Default is 10.0.
        """,
    )
    transport.add_argument(
        "--stream-timeout",
        type=num(float, gt=0),
        metavar="TIMEOUT",
        help="""
            The maximum time to wait for an unfiltered stream to continue outputting data.

            This applies to all different kinds of stream types, such as DASH, HLS, HTTP, etc.

            Default is 60.0.
        """,
    )
    transport.add_argument(
        "--mux-subtitles",
        action="store_true",
        default=None,
        help="""
            Automatically mux available subtitles into the output stream.

            Needs to be supported by the used plugin.
        """,
    )

    transport_hls.add_argument(
        "--hls-live-edge",
        type=num(int, ge=1),
        metavar="SEGMENTS",
        help="""
            Number of segments from the live stream's current live position to begin streaming.
            The size or length of each segment is determined by the streaming provider.

            Lower values will decrease the latency, but will also increase the chance of buffering, as there is less time for
            Streamlink to download segments and write their data to the output buffer. The number of parallel segment downloads
            can be set with --stream-segment-threads and the HLS playlist reload time to fetch and queue new segments can be
            overridden with --hls-playlist-reload-time.

            Default is 3.

            Note: During live playback, the caching/buffering settings of the used player will add additional latency.
            To adjust this, please refer to the player's own documentation for the required configuration.
            Player parameters can be set via --player-args.
        """,
    )
    transport_hls.add_argument(
        "--hls-segment-stream-data",
        action="store_true",
        default=None,
        help="""
            Immediately write segment data into output buffer while downloading.
        """,
    )
    transport_hls.add_argument(
        "--hls-playlist-reload-attempts",
        type=num(int, ge=1),
        metavar="ATTEMPTS",
        help="""
            The maximum number of attempts when reloading the HLS playlist before giving up.

            Default is 3.
        """,
    )
    transport_hls.add_argument(
        "--hls-playlist-reload-time",
        metavar="TIME",
        help="""
            Set a custom HLS playlist reload time value, either in seconds or by using one of the following keywords:

            - segment: The duration of the last segment in the current playlist
            - live-edge: The sum of segment durations of the live edge value minus one
            - default: The playlist's target duration metadata

            Default is default.
        """,
    )
    transport_hls.add_argument(
        "--hls-segment-queue-threshold",
        metavar="FACTOR",
        type=num(float, ge=0),
        help="""
            The multiplication factor of the HLS playlist's target duration after which the stream will be stopped early
            if no new segments were queued after refreshing the playlist (multiple times). The target duration defines the
            maximum duration a single segment can have, meaning new segments must be available during this time frame,
            otherwise playback issues can occur.

            The intention of this queue threshold is to be able to stop early when the end of a stream doesn't get
            announced by the server, so Streamlink doesn't have to wait until a read-timeout occurs. See --stream-timeout.

            Set to ``0`` to disable.

            Default is 3.
        """,
    )
    transport_hls.add_argument(
        "--hls-segment-ignore-names",
        metavar="NAMES",
        type=comma_list,
        help="""
            A comma-delimited list of segment names that will get filtered out.

            Example: --hls-segment-ignore-names 000,001,002

            This will ignore every segment that ends with 000.ts, 001.ts and 002.ts

            Default is None.
        """,
    )
    transport_hls.add_argument(
        "--hls-segment-key-uri",
        metavar="URI",
        type=str,
        help="""
            Override the segment encryption key URIs for encrypted streams.

            The value can be templated using the following variables, which will be
            replaced with their respective part from the source segment URI:

              {url} {scheme} {netloc} {path} {query}

            Examples:

              --hls-segment-key-uri "https://example.com/hls/encryption_key"
              --hls-segment-key-uri "{scheme}://1.2.3.4{path}{query}"
              --hls-segment-key-uri "{scheme}://{netloc}/custom/path/to/key"

            Default is None.
        """,
    )
    transport_hls.add_argument(
        "--hls-audio-select",
        type=comma_list,
        metavar="CODE",
        help="""
            Select one or more specific audio sources by language code or name.
            Can be set to `*` (asterisk) to include all audio sources.

            Examples:

              --hls-audio-select "English,German"
              --hls-audio-select "en,de"
              --hls-audio-select "*"

            Note: This is only useful in special circumstances where the regular
            locale option fails, such as when multiple sources of the same language exist.
        """,
    )
    transport_hls.add_argument(
        "--hls-start-offset",
        type=hours_minutes_seconds_float,
        metavar="[[XX:]XX:]XX[.XX] | [XXh][XXm][XX[.XX]s]",
        help="""
            The amount of time to skip from the beginning of the stream.
            For live streams, this is a negative offset from the end of the stream (rewind).

            Default is 0.
        """,
    )
    transport_hls.add_argument(
        "--hls-duration",
        type=hours_minutes_seconds_float,
        metavar="[[XX:]XX:]XX[.XX] | [XXh][XXm][XX[.XX]s]",
        help="""
            Limit the playback duration, useful for watching segments of a stream.
            The actual duration may be slightly longer, as it is rounded to the nearest HLS segment.

            Default is unlimited.
        """,
    )
    transport_hls.add_argument(
        "--hls-live-restart",
        action="store_true",
        default=None,
        help="""
            Skip to the beginning of a live stream, or as far back as possible.
        """,
    )

    transport_dash.add_argument(
        "--dash-manifest-reload-attempts",
        type=num(int, ge=1),
        metavar="ATTEMPTS",
        help="""
            The maximum number of attempts when reloading the DASH manifest before giving up.

            Default is 3.
        """,
    )

    transport_ffmpeg.add_argument(
        "--ffmpeg-ffmpeg",
        metavar="FILENAME",
        help="""
            Set the location of the FFmpeg executable if it can't be resolved
            from the paths of the system's `PATH` environment variable.

            FFmpeg is required to access or mux separate video and audio streams,
            e.g. in DASH streams or HLS streams with multiple sources.

            Example: --ffmpeg-ffmpeg "/usr/local/bin/ffmpeg"
        """,
    )
    transport_ffmpeg.add_argument(
        "--ffmpeg-no-validation",
        action="store_true",
        default=None,
        help="""
            Disable FFmpeg validation and version logging.
        """,
    )
    transport_ffmpeg.add_argument(
        "--ffmpeg-verbose",
        action="store_true",
        default=None,
        help="""
            Write FFmpeg's stderr output to Streamlink's stderr output.
        """,
    )
    transport_ffmpeg.add_argument(
        "--ffmpeg-verbose-path",
        type=str,
        metavar="PATH",
        help="""
            Write FFmpeg's stderr output to PATH.
        """,
    )
    transport_ffmpeg.add_argument(
        "--ffmpeg-loglevel",
        type=str,
        metavar="LOGLEVEL",
        help="""
            Change FFmpeg's `-loglevel` value to `LOGLEVEL`.

            Unless --ffmpeg-verbose or --ffmpeg-verbose-path is set, changing the log level won't have any effect.

            Default is "info".
        """,
    )
    transport_ffmpeg.add_argument(
        "--ffmpeg-fout",
        type=str,
        metavar="OUTFORMAT",
        help="""
            Set the output format to `OUTFORMAT`. This only applies to streams which require muxing.

            Default is "matroska".

            Example: --ffmpeg-fout "mpegts"
        """,
    )
    transport_ffmpeg.add_argument(
        "--ffmpeg-video-transcode",
        metavar="CODEC",
        help="""
            Transcode the video to `CODEC`. This only applies to streams which require muxing.

            Default is "copy".

            Example: --ffmpeg-video-transcode "h264"
        """,
    )
    transport_ffmpeg.add_argument(
        "--ffmpeg-audio-transcode",
        metavar="CODEC",
        help="""
            Transcode the audio to `CODEC`. This only applies to streams which require muxing.

            Default is "copy".

            Example: --ffmpeg-audio-transcode "aac"
        """,
    )
    transport_ffmpeg.add_argument(
        "--ffmpeg-copyts",
        action="store_true",
        default=None,
        help="""
            Set the `-copyts` FFmpeg option, so input timestamps won't be processed
            and the initial start time offset value be kept.
        """,
    )
    transport_ffmpeg.add_argument(
        "--ffmpeg-start-at-zero",
        action="store_true",
        default=None,
        help="""
            Enable the `-start_at_zero` FFmpeg option when using --ffmpeg-copyts.
        """,
    )

    http = parser.add_argument_group("HTTP options")
    http.add_argument(
        "--http-proxy",
        metavar="HTTP_PROXY",
        help="""
            An HTTP proxy to use for all HTTP and HTTPS requests, including WebSocket connections.

            Example: --http-proxy "http://hostname:port/"
        """,
    )
    http.add_argument("--https-proxy", help=argparse.SUPPRESS)
    http.add_argument(
        "--http-cookie",
        metavar="KEY=VALUE",
        type=keyvalue,
        action="append",
        help="""
            A cookie to add to each HTTP request.

            Can be repeated to add multiple cookies.
        """,
    )
    http.add_argument(
        "--http-header",
        metavar="KEY=VALUE",
        type=keyvalue,
        action="append",
        help="""
            A header to add to each HTTP request.

            Can be repeated to add multiple headers.
        """,
    )
    http.add_argument(
        "--http-query-param",
        metavar="KEY=VALUE",
        type=keyvalue,
        action="append",
        help="""
            A query parameter to add to each HTTP request.

            Can be repeated to add multiple query parameters.
        """,
    )
    http.add_argument(
        "--http-ignore-env",
        action="store_false",
        default=None,
        help="""
            Ignore HTTP settings set in the environment, such as environment variables (`HTTP_PROXY`, etc)
            or `~/.netrc` authentication.
        """,
    )
    http.add_argument(
        "--http-no-ssl-verify",
        action="store_false",
        default=None,
        help="""
            Don't attempt to verify TLS/SSL certificates.

            Use with caution, as it has TLS/SSL security implications.
        """,
    )
    http.add_argument(
        "--http-disable-dh",
        action="store_true",
        default=None,
        help="""
            Disable Diffie Hellman key exchange.

            Use with caution, as it has TLS/SSL security implications.
        """,
    )
    http.add_argument(
        "--http-ssl-cert",
        metavar="PEM_FILENAME",
        help="""
            SSL certificate to use: a .pem file.
        """,
    )
    http.add_argument(
        "--http-ssl-cert-crt-key",
        metavar=("CRT_FILENAME", "KEY_FILENAME"),
        nargs=2,
        help="""
            SSL certificate to use: a .crt and a .key file.
        """,
    )
    http.add_argument(
        "--http-timeout",
        metavar="TIMEOUT",
        type=num(float, gt=0),
        help="""
            Set the general timeout value used by all HTTP requests except the ones covered by other options.

            Default is 20.0.
        """,
    )

    webbrowser = parser.add_argument_group("Web browser options")
    webbrowser.add_argument(
        "--webbrowser",
        type=boolean,
        metavar="{yes,true,1,on,no,false,0,off}",
        default=None,
        help="""
            Enable or disable support for Streamlink's webbrowser API.

            Streamlink's webbrowser API allows plugins which implement it to launch a web browser and extract data from websites
            which they otherwise couldn't do via the regular HTTP session in Python due to specific JavaScript restrictions.

            The web browser is run isolated and in a clean environment without access to regular user data.

            Streamlink currently only supports Chromium-based web browsers using the Chrome Devtools Protocol (CDP).
            This includes Chromium itself, Google Chrome, Microsoft Edge, Brave, Vivaldi, and others, but full support for
            third party Chromium forks is not guaranteed. Please try Chromium or Google Chrome when encountering any issues.

            Default is true.
        """,
    )
    webbrowser.add_argument(
        "--webbrowser-executable",
        metavar="PATH",
        help="""
            Path to the web browser's executable.

            By default, it is looked up automatically according to the rules of the used webbrowser API implementation.
            This usually involves a list of known executable names and fallback paths on all supported operating systems.
        """,
    )
    webbrowser.add_argument(
        "--webbrowser-timeout",
        metavar="TIME",
        type=num(float, gt=0),
        help="""
            The maximum amount of time which the web browser can take to launch and execute.
        """,
    )
    webbrowser.add_argument(
        "--webbrowser-cdp-host",
        metavar="HOST",
        help="""
            Host for the web browser's inter-process communication interface (CDP specific).

            Default is 127.0.0.1.
        """,
    )
    webbrowser.add_argument(
        "--webbrowser-cdp-port",
        metavar="PORT",
        type=num(int, ge=0, le=65535),
        help="""
            Port for the web browser's inter-process communication interface (CDP specific).

            Tries to find a free port by default.
        """,
    )
    webbrowser.add_argument(
        "--webbrowser-cdp-timeout",
        metavar="TIME",
        type=num(float, gt=0),
        help="""
            The maximum amount of time for waiting on a single CDP command response.
        """,
    )
    webbrowser.add_argument(
        "--webbrowser-headless",
        type=boolean,
        metavar="{yes,true,1,on,no,false,0,off}",
        default=None,
        help="""
            Whether to launch the web browser in headless mode or not.
            When enabled, it stays completely hidden and doesn't require a desktop environment to run.

            Please be aware that headless mode might be blocked by websites which implement bot detections.

            Default is false.
        """,
    )

    return parser


# The order of arguments determines if options get overridden by `Streamlink.set_option()`
# NOTE: arguments with `action=store_{true,false}` must set `default=None`
_ARGUMENT_TO_SESSIONOPTION: list[tuple[str, str, Callable[[Any], Any] | None]] = [
    # generic arguments
    ("no_plugin_cache", "no-plugin-cache", None),
    ("locale", "locale", None),
    # network arguments
    ("interface", "interface", None),
    ("ipv4", "ipv4", None),
    ("ipv6", "ipv6", None),
    # HTTP session arguments
    ("https_proxy", "https-proxy", None),
    ("http_proxy", "http-proxy", None),
    ("http_cookie", "http-cookies", dict),
    ("http_header", "http-headers", dict),
    ("http_query_param", "http-query-params", dict),
    ("http_ignore_env", "http-trust-env", None),
    ("http_no_ssl_verify", "http-ssl-verify", None),
    ("http_disable_dh", "http-disable-dh", None),
    ("http_ssl_cert", "http-ssl-cert", None),
    ("http_ssl_cert_crt_key", "http-ssl-cert", tuple),
    ("http_timeout", "http-timeout", None),
    # stream transport arguments
    ("ringbuffer_size", "ringbuffer-size", None),
    ("mux_subtitles", "mux-subtitles", None),
    ("stream_segment_attempts", "stream-segment-attempts", None),
    ("stream_segment_threads", "stream-segment-threads", None),
    ("stream_segment_timeout", "stream-segment-timeout", None),
    ("stream_timeout", "stream-timeout", None),
    ("hls_live_edge", "hls-live-edge", None),
    ("hls_live_restart", "hls-live-restart", None),
    ("hls_start_offset", "hls-start-offset", None),
    ("hls_duration", "hls-duration", None),
    ("hls_playlist_reload_attempts", "hls-playlist-reload-attempts", None),
    ("hls_playlist_reload_time", "hls-playlist-reload-time", None),
    ("hls_segment_queue_threshold", "hls-segment-queue-threshold", None),
    ("hls_segment_stream_data", "hls-segment-stream-data", None),
    ("hls_segment_ignore_names", "hls-segment-ignore-names", None),
    ("hls_segment_key_uri", "hls-segment-key-uri", None),
    ("hls_audio_select", "hls-audio-select", None),
    ("dash_manifest_reload_attempts", "dash-manifest-reload-attempts", None),
    ("ffmpeg_ffmpeg", "ffmpeg-ffmpeg", None),
    ("ffmpeg_no_validation", "ffmpeg-no-validation", None),
    ("ffmpeg_verbose", "ffmpeg-verbose", None),
    ("ffmpeg_verbose_path", "ffmpeg-verbose-path", None),
    ("ffmpeg_loglevel", "ffmpeg-loglevel", None),
    ("ffmpeg_fout", "ffmpeg-fout", None),
    ("ffmpeg_video_transcode", "ffmpeg-video-transcode", None),
    ("ffmpeg_audio_transcode", "ffmpeg-audio-transcode", None),
    ("ffmpeg_copyts", "ffmpeg-copyts", None),
    ("ffmpeg_start_at_zero", "ffmpeg-start-at-zero", None),
    # web browser arguments
    ("webbrowser", "webbrowser", None),
    ("webbrowser_executable", "webbrowser-executable", None),
    ("webbrowser_timeout", "webbrowser-timeout", None),
    ("webbrowser_cdp_host", "webbrowser-cdp-host", None),
    ("webbrowser_cdp_port", "webbrowser-cdp-port", None),
    ("webbrowser_cdp_timeout", "webbrowser-cdp-timeout", None),
    ("webbrowser_headless", "webbrowser-headless", None),
]


def setup_session_options(session: Streamlink, args: argparse.Namespace):
    for arg, option, mapper in _ARGUMENT_TO_SESSIONOPTION:
        value = getattr(args, arg)
        if value is not None:
            if mapper is not None:
                value = mapper(value)
            session.set_option(option, value)


def setup_plugin_args(session: Streamlink, parser: ArgumentParser):
    """Adds plugin argument data to the argument parser."""

    plugin_args = parser.add_argument_group("Plugin-specific options")
    for pname, arguments in session.plugins.iter_arguments():
        group = parser.add_argument_group(pname.capitalize(), parent=plugin_args)

        for parg in arguments:
            group.add_argument(parg.argument_name(pname), **parg.options)


def setup_plugin_options(
    session: Streamlink,
    args: argparse.Namespace,
    pluginname: str,
    pluginclass: type[Plugin],
) -> Options:
    """Initializes plugin options from argument values."""

    if not pluginclass.arguments:
        return Options()

    user_input_requester: UserInputRequester | None = session.get_option("user-input-requester")
    if not user_input_requester:
        raise RuntimeError("The Streamlink session is missing a UserInputRequester")

    defaults = {}
    values = {}
    required = {}

    for parg in pluginclass.arguments:
        value = getattr(args, parg.namespace_dest(pluginname))
        values[parg.dest] = value
        defaults[parg.dest] = parg.default

        if parg.help == argparse.SUPPRESS:
            if value != parg.default:
                warnings.warn(
                    f"The {parg.argument_name(pluginname)} plugin argument has been disabled and will be removed in the future",
                    StreamlinkDeprecationWarning,
                    stacklevel=1,
                )
            continue

        if parg.required:
            required[parg.name] = parg
        # if the value is set, check to see if any of the required arguments are not set
        if parg.required or value:
            try:
                for rparg in pluginclass.arguments.requires(parg.name):
                    required[rparg.name] = rparg
            except RuntimeError:  # pragma: no cover
                log.error(f"{pluginname} plugin has a configuration error and the arguments cannot be parsed")
                break

    for req in required.values():
        if not values.get(req.dest):
            prompt = f"{req.prompt or f'Enter {pluginname} {req.name}'}"
            try:
                if req.sensitive:
                    value = user_input_requester.ask_password(prompt)
                else:
                    value = user_input_requester.ask(prompt)
            except OSError as err:
                raise StreamlinkCLIError from err
            values[req.dest] = value

    options = Options(defaults)
    options.update(values)

    return options


__all__ = ["ArgumentParser", "build_parser", "setup_session_options", "setup_plugin_args", "setup_plugin_options"]
