From patchwork Mon Apr 22 14:25:46 2024 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Derek Buitenhuis X-Patchwork-Id: 48218 Delivered-To: ffmpegpatchwork2@gmail.com Received: by 2002:a05:6a20:c906:b0:1a9:af23:56c1 with SMTP id gx6csp2325659pzb; Mon, 22 Apr 2024 07:26:55 -0700 (PDT) X-Forwarded-Encrypted: i=2; AJvYcCU0NdXuGO1KvU88s7V7+bP8Wt6TonFrgSGh+2WVJFGheRUHHl7DdYlD+zsUgq7HPWNtP1vHefUCd2rIX9n0EpW3eD3ZlQ5BX/LEAQ== X-Google-Smtp-Source: AGHT+IH6GcVtoESZnsar/wQATSubLM8JLUIPMbhvWGbEq8Hdq8F8jlcFrCYrLjx48IdJEEYqn6Wt X-Received: by 2002:a17:907:940c:b0:a55:b577:d2f with SMTP id dk12-20020a170907940c00b00a55b5770d2fmr2288071ejc.71.1713796015308; Mon, 22 Apr 2024 07:26:55 -0700 (PDT) ARC-Seal: i=1; a=rsa-sha256; t=1713796015; cv=none; d=google.com; s=arc-20160816; b=fqpGfPi3wyK/0E6zcS+43KGfqzPOt3swTQU0bNf7fJ8AWztpMcWzR8Dwt1/0VHpmEM TytDnOBt7OO93j+J/iLneLdmZc34UTCvdkUPr8rNfsHfVKj8yov1Op4028FGnbmBLQoE hDpObybYvDyFIGqAuuOLNEJWnFBpJ1ID7jejRgetxjn3gQDq0EKRekOJwITaOB+steqn Gm/u95yVAOkr8n3sX0dU4UutmKCJdxH+2QZSD3+mWlDzDufaEGnd+1hg7EUIQVVSIXgX J/5Clb3dQxx2svGI5V7Fi1tw/gR5uKqziAviF2Hwn9EoSO90uwp71xmUMwoVTuhR2UU0 7NLg== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=arc-20160816; h=sender:errors-to:content-transfer-encoding:reply-to:list-subscribe :list-help:list-post:list-archive:list-unsubscribe:list-id :precedence:subject:mime-version:references:in-reply-to:message-id :date:to:from:dkim-signature:delivered-to; bh=TKhLVkCwvS7iFf2K8ZFxlYHPa9dhzLgfGFwfktMAhQk=; fh=YOA8vD9MJZuwZ71F/05pj6KdCjf6jQRmzLS+CATXUQk=; b=OKPKNnP7ntfjkWrNhlwZsBNzjYXlH0sZhSCWE+I26BdxoLlVs5d18enOmZuMrLfr+r 0kHT91eSM8u2TZExqkLLl3PUBRHRC+zhZQFU1mf9EcX2dB2xQTZIFguFwe7oIkC4XwSF GUl1S5gHlVnAzHFnGPZ+YsbUkYJloyBNEWCmU9t6Oh9NCcJCDSGqAa/s8Gh/V9KngWGH AAbad3xKvOQvifoz3OGIo2bbnnVt8bzVfCQUN8ETI9o7gQMn0syt0axcIlAT3PeU6rGr qJpJZbmKrHLPcilu8iWZNwDe6dCvMJUvvkj4c2+inal0YgTMBwYJnaqixgQUvTWFNcfk fbAg==; dara=google.com ARC-Authentication-Results: i=1; mx.google.com; dkim=neutral (body hash did not verify) header.i=@gmail.com header.s=20230601 header.b=JkXYXyC1; spf=pass (google.com: domain of ffmpeg-devel-bounces@ffmpeg.org designates 79.124.17.100 as permitted sender) smtp.mailfrom=ffmpeg-devel-bounces@ffmpeg.org; dmarc=fail (p=NONE sp=QUARANTINE dis=NONE) header.from=gmail.com Return-Path: Received: from ffbox0-bg.mplayerhq.hu (ffbox0-bg.ffmpeg.org. [79.124.17.100]) by mx.google.com with ESMTP id z24-20020a170906715800b00a51e004de4bsi5672119ejj.763.2024.04.22.07.26.54; Mon, 22 Apr 2024 07:26:55 -0700 (PDT) Received-SPF: pass (google.com: domain of ffmpeg-devel-bounces@ffmpeg.org designates 79.124.17.100 as permitted sender) client-ip=79.124.17.100; Authentication-Results: mx.google.com; dkim=neutral (body hash did not verify) header.i=@gmail.com header.s=20230601 header.b=JkXYXyC1; spf=pass (google.com: domain of ffmpeg-devel-bounces@ffmpeg.org designates 79.124.17.100 as permitted sender) smtp.mailfrom=ffmpeg-devel-bounces@ffmpeg.org; dmarc=fail (p=NONE sp=QUARANTINE dis=NONE) header.from=gmail.com Received: from [127.0.1.1] (localhost [127.0.0.1]) by ffbox0-bg.mplayerhq.hu (Postfix) with ESMTP id B2CB968D355; Mon, 22 Apr 2024 17:26:12 +0300 (EEST) X-Original-To: ffmpeg-devel@ffmpeg.org Delivered-To: ffmpeg-devel@ffmpeg.org Received: from mail-wm1-f43.google.com (mail-wm1-f43.google.com [209.85.128.43]) by ffbox0-bg.mplayerhq.hu (Postfix) with ESMTPS id 437E768D308 for ; Mon, 22 Apr 2024 17:26:08 +0300 (EEST) Received: by mail-wm1-f43.google.com with SMTP id 5b1f17b1804b1-41a72f3a20dso5679715e9.0 for ; Mon, 22 Apr 2024 07:26:08 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20230601; t=1713795966; x=1714400766; darn=ffmpeg.org; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:to:from:from:to:cc:subject:date:message-id :reply-to; bh=q05V2PXSnPPzq+j4F3+JmFGWAq49v8LVqzulBOz+VzU=; b=JkXYXyC12qeTrwlAT1AvccMTke4WYLox+hR9812ed9pvVDn00Uws3MPj6D0Vl8gmWB +dhoH00CySVgsm0OFPQWk2MUClVStZ5n0fNkpP4RHeUcwWRBtyI6M87XB2xV3R+THHGX 7YylWiaWYanc5rXGA6EryzXameZQaKK0MxGDiva1hKAidYqmvKWszUQaTQLQGbpwXe23 y7g8BmZN69+fDGLjLuH/GwOZyLZCcIihcLf6zV3c9QS+UrTq5bZVdSKlf+UGQOMGFxLR 9thUs1aDB6Kxe8+tonCoD31XqniZqiooaIOesjYZ3mI5pTpkTfSGo1js1m4rjbEtR2ZX JTIQ== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1713795966; x=1714400766; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:to:from:x-gm-message-state:from:to:cc :subject:date:message-id:reply-to; bh=q05V2PXSnPPzq+j4F3+JmFGWAq49v8LVqzulBOz+VzU=; b=iEN3vxKVidbdofU4TZaC8a8x49LaYO+fUKtjH/s4ecfdTQwI0TrZgf3P/c78QlGz2p GM1m32f6LOmIw0MEI4OQNCsPYEn78NKNngKRRZVl6OX8A7J/CvYKGSYVjEeZPJ5BTxQQ RY+ykycVkf+qjMB3dXB4XTfQWpEfp5WrBKYNEfsAtOqDi+00VuftpoTw6pQn/uK1qncY 40wJAPJtlUWkrxW/kAT73wHqqQY6D5olMnYVrjknZ6FfxrpFQkEhdCXhI5bU5qGPlrPm rFiLpxQmQ9AHVV4C9g3SPEMQSSxqoQ/Hj831qpuITIUxhS82F+g6zZcOty++P+1SnkQo O6hw== X-Gm-Message-State: AOJu0YwqKkt1ohjUIw7fZdr8XHiBCdAj4SKK9BLRY6Wym6/LzPITms1N lYgnslnhwVvh/Ue3pHJLurCM2XIRvbg/jsC1kEUGsnGinQgED+VM9WwsHQ== X-Received: by 2002:a05:600c:5020:b0:41a:66ef:e543 with SMTP id n32-20020a05600c502000b0041a66efe543mr1395276wmr.19.1713795966445; Mon, 22 Apr 2024 07:26:06 -0700 (PDT) Received: from localhost.localdomain (33bf3d9d.skybroadband.com. [51.191.61.157]) by smtp.gmail.com with ESMTPSA id d11-20020a05600c3acb00b0041aa14b4646sm67111wms.8.2024.04.22.07.26.04 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Mon, 22 Apr 2024 07:26:05 -0700 (PDT) From: Derek Buitenhuis To: ffmpeg-devel@ffmpeg.org Date: Mon, 22 Apr 2024 15:25:46 +0100 Message-ID: <20240422142547.281064-9-derek.buitenhuis@gmail.com> X-Mailer: git-send-email 2.43.0 In-Reply-To: <20240422142547.281064-1-derek.buitenhuis@gmail.com> References: <20240422142547.281064-1-derek.buitenhuis@gmail.com> MIME-Version: 1.0 Subject: [FFmpeg-devel] [PATCH v2 8/9] doc/protocols: Re-order HTTP options to match http.c order X-BeenThere: ffmpeg-devel@ffmpeg.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: FFmpeg development discussions and patches List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Reply-To: FFmpeg development discussions and patches Errors-To: ffmpeg-devel-bounces@ffmpeg.org Sender: "ffmpeg-devel" X-TUID: gD1I4goQ2E/z This makes the list easier to maintain. Signed-off-by: Derek Buitenhuis --- doc/protocols.texi | 112 ++++++++++++++++++++++----------------------- 1 file changed, 56 insertions(+), 56 deletions(-) diff --git a/doc/protocols.texi b/doc/protocols.texi index f54600b846..5ce1ddc8f4 100644 --- a/doc/protocols.texi +++ b/doc/protocols.texi @@ -442,9 +442,6 @@ value is -1. @item chunked_post If set to 1 use chunked Transfer-Encoding for posts, default is 1. -@item content_type -Set a specific content type for the POST messages or for listen mode. - @item http_proxy set HTTP proxy to tunnel through e.g. http://example.com:1234 @@ -452,35 +449,21 @@ set HTTP proxy to tunnel through e.g. http://example.com:1234 Set custom HTTP headers, can override built in default headers. The value must be a string encoding the headers. -@item multiple_requests -Use persistent connections if set to 1, default is 0. - -@item post_data -Set custom HTTP post data. - -@item referer -Set the Referer header. Include 'Referer: URL' header in HTTP request. +@item content_type +Set a specific content type for the POST messages or for listen mode. @item user_agent Override the User-Agent header. If not specified the protocol will use a string describing the libavformat build. ("Lavf/") -@item reconnect_at_eof -If set then eof is treated like an error and causes reconnection, this is useful -for live / endless streams. - -@item reconnect_streamed -If set then even streamed/non seekable streams will be reconnected on errors. - -@item reconnect_on_network_error -Reconnect automatically in case of TCP/TLS errors during connect. +@item referer +Set the Referer header. Include 'Referer: URL' header in HTTP request. -@item reconnect_on_http_error -A comma separated list of HTTP status codes to reconnect on. The list can -include specific status codes (e.g. '503') or the strings '4xx' / '5xx'. +@item multiple_requests +Use persistent connections if set to 1, default is 0. -@item reconnect_delay_max -Sets the maximum delay in seconds after which to give up reconnecting +@item post_data +Set custom HTTP post data. @item mime_type Export the MIME type. @@ -488,6 +471,11 @@ Export the MIME type. @item http_version Exports the HTTP response version number. Usually "1.0" or "1.1". +@item cookies +Set the cookies to be sent in future requests. The format of each cookie is the +same as the value of a Set-Cookie HTTP response field. Multiple cookies can be +delimited by a newline character. + @item icy If set to 1 request ICY (SHOUTcast) metadata from the server. If the server supports this, the metadata has to be retrieved by the application by reading @@ -504,10 +492,32 @@ contains the last non-empty metadata packet sent by the server. It should be polled in regular intervals by applications interested in mid-stream metadata updates. -@item cookies -Set the cookies to be sent in future requests. The format of each cookie is the -same as the value of a Set-Cookie HTTP response field. Multiple cookies can be -delimited by a newline character. +@item auth_type + +Set HTTP authentication type. No option for Digest, since this method requires +getting nonce parameters from the server first and can't be used straight away like +Basic. + +@table @option +@item none +Choose the HTTP authentication type automatically. This is the default. +@item basic + +Choose the HTTP basic authentication. + +Basic authentication sends a Base64-encoded string that contains a user name and password +for the client. Base64 is not a form of encryption and should be considered the same as +sending the user name and password in clear text (Base64 is a reversible encoding). +If a resource needs to be protected, strongly consider using an authentication scheme +other than basic authentication. HTTPS/TLS should be used with basic authentication. +Without these additional security enhancements, basic authentication should not be used +to protect sensitive or valuable information. +@end table + +@item send_expect_100 +Send an Expect: 100-continue header for POST. If set to 1 it will send, if set +to 0 it won't, if set to -1 it will try to send if it is applicable. Default +value is -1. @item offset Set initial byte offset. @@ -525,6 +535,23 @@ be given a Bad Request response. When unset the HTTP method is not checked for now. This will be replaced by autodetection in the future. +@item reconnect_at_eof +If set then eof is treated like an error and causes reconnection, this is useful +for live / endless streams. + +@item reconnect_on_network_error +Reconnect automatically in case of TCP/TLS errors during connect. + +@item reconnect_on_http_error +A comma separated list of HTTP status codes to reconnect on. The list can +include specific status codes (e.g. '503') or the strings '4xx' / '5xx'. + +@item reconnect_streamed +If set then even streamed/non seekable streams will be reconnected on errors. + +@item reconnect_delay_max +Sets the maximum delay in seconds after which to give up reconnecting + @item listen If set to 1 enables experimental HTTP server. This can be used to send data when used as an output option, or read data from a client with HTTP POST when used as @@ -551,33 +578,6 @@ ffmpeg -i somefile.ogg -chunked_post 0 -c copy -f ogg http://@var{server}:@var{p wget --post-file=somefile.ogg http://@var{server}:@var{port} @end example -@item send_expect_100 -Send an Expect: 100-continue header for POST. If set to 1 it will send, if set -to 0 it won't, if set to -1 it will try to send if it is applicable. Default -value is -1. - -@item auth_type - -Set HTTP authentication type. No option for Digest, since this method requires -getting nonce parameters from the server first and can't be used straight away like -Basic. - -@table @option -@item none -Choose the HTTP authentication type automatically. This is the default. -@item basic - -Choose the HTTP basic authentication. - -Basic authentication sends a Base64-encoded string that contains a user name and password -for the client. Base64 is not a form of encryption and should be considered the same as -sending the user name and password in clear text (Base64 is a reversible encoding). -If a resource needs to be protected, strongly consider using an authentication scheme -other than basic authentication. HTTPS/TLS should be used with basic authentication. -Without these additional security enhancements, basic authentication should not be used -to protect sensitive or valuable information. -@end table - @end table @subsection HTTP Cookies