From patchwork Tue Jul 27 14:48:13 2021 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Nicolas George X-Patchwork-Id: 29065 Delivered-To: ffmpegpatchwork2@gmail.com Received: by 2002:a05:6a11:4023:0:0:0:0 with SMTP id ky35csp4920821pxb; Tue, 27 Jul 2021 07:50:24 -0700 (PDT) X-Google-Smtp-Source: ABdhPJzq+kSfwF7O2xQMzQ0vTyvFhqrCxrDBVdbN7FEowkM/PPBRdKBoLbqrfkQLOEWmkYRx8MVF X-Received: by 2002:a17:906:af6f:: with SMTP id os15mr5298252ejb.71.1627397423953; Tue, 27 Jul 2021 07:50:23 -0700 (PDT) ARC-Seal: i=1; a=rsa-sha256; t=1627397423; cv=none; d=google.com; s=arc-20160816; b=nkUmEsf4IAKrgCxsKbg37dhWUFyoaFFW4rFwY3Rzcyukv9ws/Hljpp6jXFneJPXpPi UF6LLb3gSS8DIJO7IpNx1jyf5VVX0m8/OSOJ+QP5Z7XelSpA45VECMgQetCjb5ekAdnu uJZpjbFlOAsiVxX3qRkuXYwKN7lHeilQEk/RDzbNPa01WxqNwARoWA3PN1AkNMqD2BjB WHe6HvUtBTBekJI6fnzEqXQ0hBm89+W/pGOzi/iEScbsiTab0gJLQsXolBYHlXBXLqJ5 CWsqDrgpPfX0wN2oLIJ3I3wTNoc3CwS9PmSgl568/usjYsBvMllA1ha0wvlKdfD4A2HY ZBMA== 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:delivered-to; bh=X93BV578pqCSh5c2N1FhFnBkp9Mutfz/KikmY+1CDq8=; b=RzYoxqa8A4xuTD52/ynGRptvV+/8JkIdFA9B6vA9YqLY25bOBqjNOyINpC+3UosPhJ WzlDOQNgYZ+jbV6iwjpQPROLvrKgWJ5CqLfumuKANYZ75qXDW32ph3a8p8srb8PX4AMm fIUUviE73v6r+UaM1Wtr+zwONBlHo8XOq1xocw0AVzgq+ZErfvawbv2sssZ98DuOCGB5 YOWSXcYxYNnWOpXHKnuTB2M7PXUhRGhsVLn1XYHzHcmFU37hu4SJEuTxmmTFQfcfB5l8 edOdzONDR1F2WJuhQMXpGChi8diLRk6mOy69rqteBqNC5qDIwP0gAga6xdYpo02bzoaw 1+BA== ARC-Authentication-Results: i=1; mx.google.com; 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 Return-Path: Received: from ffbox0-bg.mplayerhq.hu (ffbox0-bg.ffmpeg.org. [79.124.17.100]) by mx.google.com with ESMTP id da17si3037954edb.259.2021.07.27.07.50.23; Tue, 27 Jul 2021 07:50:23 -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; 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 Received: from [127.0.1.1] (localhost [127.0.0.1]) by ffbox0-bg.mplayerhq.hu (Postfix) with ESMTP id 2475F68A37E; Tue, 27 Jul 2021 17:48:35 +0300 (EEST) X-Original-To: ffmpeg-devel@ffmpeg.org Delivered-To: ffmpeg-devel@ffmpeg.org Received: from nef.ens.fr (nef2.ens.fr [129.199.96.40]) by ffbox0-bg.mplayerhq.hu (Postfix) with ESMTPS id 7FCAB689D48 for ; Tue, 27 Jul 2021 17:48:23 +0300 (EEST) X-ENS-nef-client: 129.199.129.80 ( name = phare.normalesup.org ) Received: from phare.normalesup.org (phare.normalesup.org [129.199.129.80]) by nef.ens.fr (8.14.4/1.01.28121999) with ESMTP id 16REmMJ4026228 for ; Tue, 27 Jul 2021 16:48:23 +0200 Received: by phare.normalesup.org (Postfix, from userid 1001) id B232FE977F; Tue, 27 Jul 2021 16:48:22 +0200 (CEST) From: Nicolas George To: ffmpeg-devel@ffmpeg.org Date: Tue, 27 Jul 2021 16:48:13 +0200 Message-Id: <20210727144813.452917-11-george@nsup.org> X-Mailer: git-send-email 2.30.2 In-Reply-To: <20210727144813.452917-1-george@nsup.org> References: <20210727144813.452917-1-george@nsup.org> MIME-Version: 1.0 X-Greylist: Sender IP whitelisted, not delayed by milter-greylist-4.4.3 (nef.ens.fr [129.199.96.32]); Tue, 27 Jul 2021 16:48:23 +0200 (CEST) Subject: [FFmpeg-devel] [PATCH 10/10] doc: document fs: and file: changes. 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: uVZTqvlvSbzt Signed-off-by: Nicolas George --- doc/protocols.texi | 40 +++++++++++++++++++++++++++++++--------- 1 file changed, 31 insertions(+), 9 deletions(-) diff --git a/doc/protocols.texi b/doc/protocols.texi index 726e5f1c44..d341d93914 100644 --- a/doc/protocols.texi +++ b/doc/protocols.texi @@ -283,20 +283,16 @@ Read from or write to a file. A file URL can have the form: @example -file:@var{filename} +file://@var{encoded_absolute_path} @end example -where @var{filename} is the path of the file to read. +where @var{encoded_absolute_path} is the path of the file, with standard % +URL encoding.. -An URL that does not have a protocol prefix will be assumed to be a -file URL. Depending on the build, an URL that looks like a Windows -path with the drive letter at the beginning will also be assumed to be -a file URL (usually not the case in builds for unix-like systems). - -For example to read from a file @file{input.mpeg} with @command{ffmpeg} +For example to read from a file @file{/tmp/test input.mpeg} with @command{ffmpeg} use the command: @example -ffmpeg -i file:input.mpeg output.mpeg +ffmpeg -i file:///tmp/test%20input.mpeg output.mpeg @end example This protocol accepts the following options: @@ -327,6 +323,32 @@ overriding this might speed up opening certain files at the cost of losing some features (e.g. accurate seeking). @end table +@section fs + +Direct file system access protocol. + +Read from or write to a file. + +A fs URL can have the form: +@example +fs:@var{filename} +@end example + +where @var{filename} is the path of the file. + +An URL that does not have a protocol prefix will be assumed to be a +fs URL. Depending on the build, an URL that looks like a Windows +path with the drive letter at the beginning will also be assumed to be +a fs URL (usually not the case in builds for unix-like systems). + +For example to read from a file @file{input.mpeg} with @command{ffmpeg} +use the command: +@example +ffmpeg -i fs:input.mpeg output.mpeg +@end example + +This protocol accepts the same options as the file protocol. + @section ftp FTP (File Transfer Protocol).