From e409895f13f3985639562fdb566b36c28d02370a Mon Sep 17 00:00:00 2001 From: pukkandan Date: Wed, 24 Feb 2021 21:31:01 +0530 Subject: [PATCH] [documentation] Fix documentation of "Extractor Options" --- README.md | 29 +++++++++++++++++------------ youtube_dlc/YoutubeDL.py | 14 +++++++++++--- youtube_dlc/options.py | 32 ++++++++++++++++---------------- 3 files changed, 44 insertions(+), 31 deletions(-) diff --git a/README.md b/README.md index c42145d73..cf6339743 100644 --- a/README.md +++ b/README.md @@ -531,18 +531,6 @@ ## Video Format Options: (default) --list-formats-old Present the output of -F in the old form (Alias: --no-list-formats-as-table) - --youtube-include-dash-manifest Download the DASH manifests and related - data on YouTube videos (default) - (Alias: --no-youtube-skip-dash-manifest) - --youtube-skip-dash-manifest Do not download the DASH manifests and - related data on YouTube videos - (Alias: --no-youtube-include-dash-manifest) - --youtube-include-hls-manifest Download the HLS manifests and related data - on YouTube videos (default) - (Alias: --no-youtube-skip-hls-manifest) - --youtube-skip-hls-manifest Do not download the HLS manifests and - related data on YouTube videos - (Alias: --no-youtube-include-hls-manifest) --merge-output-format FORMAT If a merge is required (e.g. bestvideo+bestaudio), output to given container format. One of mkv, mp4, ogg, @@ -700,6 +688,23 @@ ## Extractor Options: (Alias: --no-ignore-dynamic-mpd) --ignore-dynamic-mpd Do not process dynamic DASH manifests (Alias: --no-allow-dynamic-mpd) + --hls-split-discontinuity Split HLS playlists to different formats at + discontinuities such as ad breaks + --no-hls-split-discontinuity Do not split HLS playlists to different + formats at discontinuities such as ad + breaks (default) + --youtube-include-dash-manifest Download the DASH manifests and related + data on YouTube videos (default) + (Alias: --no-youtube-skip-dash-manifest) + --youtube-skip-dash-manifest Do not download the DASH manifests and + related data on YouTube videos + (Alias: --no-youtube-include-dash-manifest) + --youtube-include-hls-manifest Download the HLS manifests and related data + on YouTube videos (default) + (Alias: --no-youtube-skip-hls-manifest) + --youtube-skip-hls-manifest Do not download the HLS manifests and + related data on YouTube videos + (Alias: --no-youtube-include-hls-manifest) # CONFIGURATION diff --git a/youtube_dlc/YoutubeDL.py b/youtube_dlc/YoutubeDL.py index 6a5fb2b9a..8ff6a64f0 100644 --- a/youtube_dlc/YoutubeDL.py +++ b/youtube_dlc/YoutubeDL.py @@ -364,7 +364,7 @@ class YoutubeDL(object): nopart, updatetime, buffersize, ratelimit, min_filesize, max_filesize, test, noresizebuffer, retries, continuedl, noprogress, consoletitle, xattr_set_filesize, external_downloader_args, hls_use_mpegts, - hls_split_discontinuity, http_chunk_size. + http_chunk_size. The following options are used by the post processors: prefer_ffmpeg: If False, use avconv instead of ffmpeg if both are available, @@ -376,11 +376,19 @@ class YoutubeDL(object): postprocessor/executable. The dict can also have "PP+EXE" keys which are used when the given exe is used by the given PP. Use 'default' as the name for arguments to passed to all PP - The following options are used by the Youtube extractor: + + The following options are used by the extractors: + dynamic_mpd: Whether to process dynamic DASH manifests (default: True) + hls_split_discontinuity: Split HLS playlists to different formats at + discontinuities such as ad breaks (default: False) youtube_include_dash_manifest: If True (default), DASH manifests and related data will be downloaded and processed by extractor. You can reduce network I/O by disabling it if you don't - care about DASH. + care about DASH. (only for youtube) + youtube_include_hls_manifest: If True (default), HLS manifests and related + data will be downloaded and processed by extractor. + You can reduce network I/O by disabling it if you don't + care about HLS. (only for youtube) """ _NUMERIC_FIELDS = set(( diff --git a/youtube_dlc/options.py b/youtube_dlc/options.py index 47349f928..f2f9dd9dd 100644 --- a/youtube_dlc/options.py +++ b/youtube_dlc/options.py @@ -504,22 +504,6 @@ def _dict_from_multiple_values_options_callback( '--list-formats-old', '--no-list-formats-as-table', action='store_false', dest='listformats_table', help='Present the output of -F in the old form (Alias: --no-list-formats-as-table)') - video_format.add_option( - '--youtube-include-dash-manifest', '--no-youtube-skip-dash-manifest', - action='store_true', dest='youtube_include_dash_manifest', default=True, - help='Download the DASH manifests and related data on YouTube videos (default) (Alias: --no-youtube-skip-dash-manifest)') - video_format.add_option( - '--youtube-skip-dash-manifest', '--no-youtube-include-dash-manifest', - action='store_false', dest='youtube_include_dash_manifest', - help='Do not download the DASH manifests and related data on YouTube videos (Alias: --no-youtube-include-dash-manifest)') - video_format.add_option( - '--youtube-include-hls-manifest', '--no-youtube-skip-hls-manifest', - action='store_true', dest='youtube_include_hls_manifest', default=True, - help='Download the HLS manifests and related data on YouTube videos (default) (Alias: --no-youtube-skip-hls-manifest)') - video_format.add_option( - '--youtube-skip-hls-manifest', '--no-youtube-include-hls-manifest', - action='store_false', dest='youtube_include_hls_manifest', - help='Do not download the HLS manifests and related data on YouTube videos (Alias: --no-youtube-include-hls-manifest)') video_format.add_option( '--merge-output-format', action='store', dest='merge_output_format', metavar='FORMAT', default=None, @@ -1235,6 +1219,22 @@ def _dict_from_multiple_values_options_callback( '--no-hls-split-discontinuity', dest='hls_split_discontinuity', action='store_false', help='Do not split HLS playlists to different formats at discontinuities such as ad breaks (default)') + extractor.add_option( + '--youtube-include-dash-manifest', '--no-youtube-skip-dash-manifest', + action='store_true', dest='youtube_include_dash_manifest', default=True, + help='Download the DASH manifests and related data on YouTube videos (default) (Alias: --no-youtube-skip-dash-manifest)') + extractor.add_option( + '--youtube-skip-dash-manifest', '--no-youtube-include-dash-manifest', + action='store_false', dest='youtube_include_dash_manifest', + help='Do not download the DASH manifests and related data on YouTube videos (Alias: --no-youtube-include-dash-manifest)') + extractor.add_option( + '--youtube-include-hls-manifest', '--no-youtube-skip-hls-manifest', + action='store_true', dest='youtube_include_hls_manifest', default=True, + help='Download the HLS manifests and related data on YouTube videos (default) (Alias: --no-youtube-skip-hls-manifest)') + extractor.add_option( + '--youtube-skip-hls-manifest', '--no-youtube-include-hls-manifest', + action='store_false', dest='youtube_include_hls_manifest', + help='Do not download the HLS manifests and related data on YouTube videos (Alias: --no-youtube-include-hls-manifest)') parser.add_option_group(general) parser.add_option_group(network)