From patchwork Tue Sep 24 07:09:42 2024 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Anton Khirnov X-Patchwork-Id: 51780 Delivered-To: ffmpegpatchwork2@gmail.com Received: by 2002:a59:ad12:0:b0:48e:c0f8:d0de with SMTP id w18csp170632vqy; Tue, 24 Sep 2024 00:10:29 -0700 (PDT) X-Forwarded-Encrypted: i=2; AJvYcCWGA5DEUesOVlRP75TNYYrbClCy+rfebsbr6pQukjuHMTZ5r6UiGtfOdt17870el2Z+uwVbQY5IfdJkntJ9LMgF@gmail.com X-Google-Smtp-Source: AGHT+IGhd0uCZl19X91jeIiczY3FYT5TjG6SOEeZZkzO7nLUk0h3iOG15GV4VLmqjYE2coJwCWot X-Received: by 2002:a17:907:74c:b0:a8d:6dab:b8ee with SMTP id a640c23a62f3a-a92d55a1794mr185185666b.23.1727161828692; Tue, 24 Sep 2024 00:10:28 -0700 (PDT) ARC-Seal: i=1; a=rsa-sha256; t=1727161828; cv=none; d=google.com; s=arc-20240605; b=iAr5SYEom7suHSY5/1R6F6k1ajOBPT7keIAIxPaZByEdj2SfH6D0qh2pJhOEFmakOd b0kkjVFGKF0U93jTW2cWsWAZJMnO8cEQrHYJHcuLR+n39ioaQ3US7uhVrfngU7Hs1mFL HxXg4kj32QF9OqMZ7xdDLgg6ki4FKHdfw8CVlGk/FR58yTNPP5OVGLUR/BAcgK9xtYPm WTI37Jrjtb3aO3i8wx6iB6G3Ih4N7OxewnWamS9N/O+4u+XlTK+ISMkOEG0Scpz64GiL hsXg5GTq24IHWjXuL4QZx84kgrax7zDZoEixBubhFpeZtN++glpYUNnA9vmySioaO/HE UGeg== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=arc-20240605; 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:message-id:date:to:from :dkim-signature:delivered-to; bh=5ZhFN1kZsKBgZ0nwHBmud5U2Hl0I3steyzGTEnr9GGM=; fh=YOA8vD9MJZuwZ71F/05pj6KdCjf6jQRmzLS+CATXUQk=; b=VhZan0g0J5bpCnk7+/39841jprIAe0splZOdVP4My31oggOHv7yWWi3apq+3taNy7k O2Bk5N9/gWwEetKcZJJHs4qxr+hnhuwpx+fCn/KEuQFsLOu+UljRQ4PqSSDQPNfbCpgo M5xwVcy1+wY3TI6l9tQHpU7wAmzQSnYrl17jxYQ40+nTkiXH8t+fQmfDDIU4je7pe+FH ok3VAuuKMFsIDolsNgk3Kkx8pTsqNEANGrDD2bNe5n4CVQgzRTBIcWWPAb6ZA5PfuC4h OrNLAopLTAahEBbA88DItMqSGDSofBt9c85MgpiIklS8HZRZopTW4j2wlJ1uw47rVFpr Vdrw==; dara=google.com ARC-Authentication-Results: i=1; mx.google.com; dkim=neutral (body hash did not verify) header.i=@khirnov.net header.s=mail header.b=QlvdwOgP; 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 a640c23a62f3a-a93930be55asi54254266b.389.2024.09.24.00.10.27; Tue, 24 Sep 2024 00:10:28 -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=@khirnov.net header.s=mail header.b=QlvdwOgP; 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 CF3E668DADD; Tue, 24 Sep 2024 10:10:23 +0300 (EEST) X-Original-To: ffmpeg-devel@ffmpeg.org Delivered-To: ffmpeg-devel@ffmpeg.org Received: from mail1.khirnov.net (quelana.khirnov.net [94.230.150.81]) by ffbox0-bg.mplayerhq.hu (Postfix) with ESMTPS id 0883E68D799 for ; Tue, 24 Sep 2024 10:10:17 +0300 (EEST) Authentication-Results: mail1.khirnov.net; dkim=pass (2048-bit key; unprotected) header.d=khirnov.net header.i=@khirnov.net header.a=rsa-sha256 header.s=mail header.b=QlvdwOgP; dkim-atps=neutral Received: from localhost (mail1.khirnov.net [IPv6:::1]) by mail1.khirnov.net (Postfix) with ESMTP id 5D1E54E0F for ; Tue, 24 Sep 2024 09:10:16 +0200 (CEST) Received: from mail1.khirnov.net ([IPv6:::1]) by localhost (mail1.khirnov.net [IPv6:::1]) (amavis, port 10024) with ESMTP id I-eMAoFlmj7Q for ; Tue, 24 Sep 2024 09:10:15 +0200 (CEST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=khirnov.net; s=mail; t=1727161815; bh=DDRpAyezUdp6p7T4t5bGwj0o6dK+6Dp48fsshr0ZQAo=; h=From:To:Subject:Date:From; b=QlvdwOgPwWRnhIvvQYCltQhwPucG6IPrQhL9Ga0CnNYW/xvml2fFU2XnWmjm2zKUL bb2pb7c41bNwb3piKV6DAyOc+X5aP3HHVDSD6D8fZhCg+rON3G/9zvvFrftkDE0G3h GkPtGHtf/GWzXsC6H9YQkg2JrgVflQEdH6dRvkotrLx7bcYZqYNNBpxPMYtTzUslVQ LoQM7+0KhQ36e6epwYXq1W6dUA8rqk/jMzF93N9MW3OetuRd6um/jJAFUMTlqbFtTr YJDRx4Az4qTj8PHmiQ7feD1KOg7enzeRVSC97I/PulnCcKlNNN/QMCIFqSqgPMOxTH n2SYPHYPAT72g== Received: from libav.khirnov.net (libav.khirnov.net [IPv6:2a00:c500:561:201::7]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (2048 bits) server-digest SHA256 client-signature RSA-PSS (2048 bits) client-digest SHA256) (Client CN "libav.khirnov.net", Issuer "smtp.khirnov.net SMTP CA" (verified OK)) by mail1.khirnov.net (Postfix) with ESMTPS id 4202EEE8 for ; Tue, 24 Sep 2024 09:10:15 +0200 (CEST) Received: from libav.khirnov.net (libav.khirnov.net [IPv6:::1]) by libav.khirnov.net (Postfix) with ESMTP id D683D3A036E for ; Tue, 24 Sep 2024 09:10:09 +0200 (CEST) From: Anton Khirnov To: ffmpeg-devel@ffmpeg.org Date: Tue, 24 Sep 2024 09:09:42 +0200 Message-ID: <20240924071000.11428-1-anton@khirnov.net> X-Mailer: git-send-email 2.43.0 MIME-Version: 1.0 Subject: [FFmpeg-devel] [PATCH 01/13] doc/ffmpeg; improve wording in the description section 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: gEadd2SOnshg --- doc/ffmpeg.texi | 29 ++++++++++++++++------------- 1 file changed, 16 insertions(+), 13 deletions(-) diff --git a/doc/ffmpeg.texi b/doc/ffmpeg.texi index 34007f7ea2..d43782e2a4 100644 --- a/doc/ffmpeg.texi +++ b/doc/ffmpeg.texi @@ -21,22 +21,24 @@ ffmpeg [@var{global_options}] @{[@var{input_file_options}] -i @file{input_url}@} inputs - including live grabbing/recording devices - filter, and transcode them into a plethora of output formats. -@command{ffmpeg} reads from an arbitrary number of input "files" (which can be regular +@command{ffmpeg} reads from an arbitrary number of inputs (which can be regular files, pipes, network streams, grabbing devices, etc.), specified by the -@code{-i} option, and writes to an arbitrary number of output "files", which are -specified by a plain output url. Anything found on the command line which -cannot be interpreted as an option is considered to be an output url. +@code{-i} option, and writes to an arbitrary number of output, which are +specified by a plain output url. Anything found on the command line which cannot +be interpreted as an option is considered to be an output url. -Each input or output url can, in principle, contain any number of streams of -different types (video/audio/subtitle/attachment/data). The allowed number and/or -types of streams may be limited by the container format. Selecting which -streams from which inputs will go into which output is either done automatically -or with the @code{-map} option (see the Stream selection chapter). +Each input or output can, in principle, contain any number of elementary streams +of different types (video/audio/subtitle/attachment/data), though the allowed +stream counts and/or types may be limited by the container format. Selecting +which streams from which inputs will go into which output is either done +automatically or with the @code{-map} option (see the @ref{Stream selection} +chapter). -To refer to input files in options, you must use their indices (0-based). E.g. -the first input file is @code{0}, the second is @code{1}, etc. Similarly, streams -within a file are referred to by their indices. E.g. @code{2:3} refers to the -fourth stream in the third input file. Also see the Stream specifiers chapter. +To refer to inputs/outputs in options, you must use their indices (0-based). +E.g. the first input is @code{0}, the second is @code{1}, etc. Similarly, +streams within an input/output are referred to by their indices. E.g. @code{2:3} +refers to the fourth stream in the third input or output. Also see the +@ref{Stream specifiers} chapter. As a general rule, options are applied to the next specified file. Therefore, order is important, and you can have the same @@ -261,6 +263,7 @@ reads an input video and @c man end DETAILED DESCRIPTION +@anchor{Stream selection} @chapter Stream selection @c man begin STREAM SELECTION