From patchwork Sun Sep 25 00:10:59 2022 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Marvin Scholz X-Patchwork-Id: 38242 Delivered-To: ffmpegpatchwork2@gmail.com Received: by 2002:a05:6a20:3b1c:b0:96:9ee8:5cfd with SMTP id c28csp1391487pzh; Sat, 24 Sep 2022 17:16:25 -0700 (PDT) X-Google-Smtp-Source: AMsMyM52V+sdICMBBhtDUlMZJIWXA/I8J2TLlAF34VznKQVpfx+XDVBARr8m9koNo7DqwXGD9ifc X-Received: by 2002:a05:6402:270f:b0:451:b5bd:95dd with SMTP id y15-20020a056402270f00b00451b5bd95ddmr15742915edd.215.1664064985321; Sat, 24 Sep 2022 17:16:25 -0700 (PDT) ARC-Seal: i=1; a=rsa-sha256; t=1664064985; cv=none; d=google.com; s=arc-20160816; b=0UZNBqjpdtM+yGIRnpXziouXNom6LPVO0x2zgzBeLNzj9bhEKuk2VHlUchiH+j9gkg yoNlxyUNWzAtK8i54/k2Ki8JayN9r0gFJxiF+puTo1mYZqCgHw5hDpZp/TirNskGpdz0 CBzLbKUaUexCMdgcfy6edCWpT9JvPzc9Pr8l4muHtnZS8VdWqg6/L238/F69OGWgSNvf yPC8G+R4XoCFZOSiOL2vEj4oJTjWWqSK7YjkusNB/lwB+Bp3+5iN5BbYWsD9FLa3eDg+ IVrX9BRflTomqrb2zqlpuOfD/tjeLA33JZJk3w3+4zE6HDqT1U0c0Rq5Tv+0/Tui73lg lrRA== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=arc-20160816; h=sender:errors-to:content-transfer-encoding:cc: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=z1Fo9QW0gJx+v/HFjjJLtM8dLqSu7c8ydt9kQxA4i84=; b=tj5KXWp0IqsbH1tQ69zy9biDFtsFMYnRReFYKqQ+OVYbReNrNLivhZFGouERzF0TOU oc5RbJmjP9p5tvFOH68p/xZIy4F2T1tPe0zn86jwBs8UcG/HPU1tvWzfZXSdhbo0dV5Q utzIwXubzC4ydCt1EZWpVds5lO+pW8LY3y9WrRy2Y6IjciSwp6QyJpRo/l8f3Q4XbDAj shTU/nbXgg28wZq73joikANBOYDinyJeq94YtO9xZ3Yn11YNx2c8IYDgCQV0VizftGH9 SPSicpB6raRaYjmgmhb1dULk+EhmZd2dKWVbuZm2RRhRWIXaBLqqbqIJuQ/4a97S7RtI MFiQ== ARC-Authentication-Results: i=1; mx.google.com; dkim=neutral (body hash did not verify) header.i=@gmail.com header.s=20210112 header.b=qfoh3oky; 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 w11-20020a05640234cb00b0044ea4c5a78dsi15194043edc.158.2022.09.24.17.16.24; Sat, 24 Sep 2022 17:16:25 -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=20210112 header.b=qfoh3oky; 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 CCE8B68BC41; Sun, 25 Sep 2022 03:12:17 +0300 (EEST) X-Original-To: ffmpeg-devel@ffmpeg.org Delivered-To: ffmpeg-devel@ffmpeg.org Received: from mail-ej1-f54.google.com (mail-ej1-f54.google.com [209.85.218.54]) by ffbox0-bg.mplayerhq.hu (Postfix) with ESMTPS id 1210668BC14 for ; Sun, 25 Sep 2022 03:12:11 +0300 (EEST) Received: by mail-ej1-f54.google.com with SMTP id sb3so7406366ejb.9 for ; Sat, 24 Sep 2022 17:12:11 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20210112; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:cc:to:from:from:to:cc:subject:date; bh=AVsCBt3qQ2r98aRLeLv6OfOuQtl7eY1Q3/31lFvZG8c=; b=qfoh3okyrUNZF0zdvecWRScfjo5VwENMmyCMRcwU6D7a2fTamW4dr30mrWrCTK6EiV AWjcSQo+4Hjd+19fwHqnG0dF9+1kfYx8FGybbDKbKUzLJxYkoQ7IohK/Mg1ik9IwlVJf m63PPuhWJtN3PKaQZ2Ws7K0VvL59IqKC30GaEpegT7I//TBP+ptxUa8WhNNsXx3L5HQq vKP7epUkcoGxPTB9TEJsrHrQDSVdYQrVUOYTAswvEKt9YxiI4kLvX3G7pvkJh9gNvBsj FqXW7vTFBtheYDp2usRcDOgcM5tNSHcTzXwHmLciA6YlW58qd2DM5dLqVEsjmDrsL/5j PN5Q== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20210112; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:cc:to:from:x-gm-message-state:from:to:cc :subject:date; bh=AVsCBt3qQ2r98aRLeLv6OfOuQtl7eY1Q3/31lFvZG8c=; b=2IIxPZy0P5xfc59rKYSeo6jr3kJ6P/3+0gKAbU/K5OLh43EPrUBS4IgFuPRHk75Hs6 ODYw+CP8KgEQwqUtXUsIIdtRDSPSr4AzBO8NPiVUBCe2MZo2ejbNuLsRVB9nh9KiTiBr tV3iH+WYZj/+Lbmsle0+LIJWqsLzh+U536VXP4PnU++6HU2wVjStUoppZiaC8Hc+LvDn dHUfAFoe1kX+vjNY+2YqbelWPyccUPCr4e0UP/+z7g9nyP0Zkj+yEOo0rsJZ92zKYJdA gvswEmeKukuyWJzRAtZ8kngR0jNez+44344LtpJbK1wNhH4tq5T7kH7qBuQRdsq65UK8 WeFw== X-Gm-Message-State: ACrzQf2bqZEaVbxD/Oy9zTmYRKGl5yQ8P7T3lkOihF3mcPJW73MNezQE 29tD+b7aFgbk0OUzfMUaDU8pUQMTmPU= X-Received: by 2002:a17:907:7ea3:b0:782:8c54:259 with SMTP id qb35-20020a1709077ea300b007828c540259mr9014315ejc.217.1664064731730; Sat, 24 Sep 2022 17:12:11 -0700 (PDT) Received: from MBP-von-Marvin.citadel.scalie.me (84-112-104-25.cable.dynamic.surfer.at. [84.112.104.25]) by smtp.gmail.com with ESMTPSA id kz3-20020a17090777c300b007812ba2a360sm6208042ejc.149.2022.09.24.17.12.11 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Sat, 24 Sep 2022 17:12:11 -0700 (PDT) From: Marvin Scholz To: ffmpeg-devel@ffmpeg.org Date: Sun, 25 Sep 2022 02:10:59 +0200 Message-Id: <20220925001121.37721-33-epirat07@gmail.com> X-Mailer: git-send-email 2.37.0 (Apple Git-136) In-Reply-To: <20220925001121.37721-1-epirat07@gmail.com> References: <20220922020400.46715-1-epirat07@gmail.com> <20220925001121.37721-1-epirat07@gmail.com> MIME-Version: 1.0 Subject: [FFmpeg-devel] [PATCH v3 32/54] avutil/channel_layout: Document missing arguments 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 Cc: Marvin Scholz Errors-To: ffmpeg-devel-bounces@ffmpeg.org Sender: "ffmpeg-devel" X-TUID: B4a04rgQnNCR --- libavutil/channel_layout.h | 11 ++++++++++- 1 file changed, 10 insertions(+), 1 deletion(-) diff --git a/libavutil/channel_layout.h b/libavutil/channel_layout.h index ee32cc9ab9..46b501df7f 100644 --- a/libavutil/channel_layout.h +++ b/libavutil/channel_layout.h @@ -448,6 +448,8 @@ int av_get_extended_channel_layout(const char *name, uint64_t* channel_layout, i * * @param buf put here the string containing the channel layout * @param buf_size size in bytes of the buffer + * @param nb_channels number of channels + * @param channel_layout channel layout bitset * @deprecated use av_channel_layout_describe() */ attribute_deprecated @@ -478,6 +480,7 @@ int64_t av_get_default_channel_layout(int nb_channels); /** * Get the index of a channel in channel_layout. * + * @param channel_layout channel layout bitset * @param channel a channel layout describing exactly one channel which must be * present in channel_layout. * @@ -541,6 +544,7 @@ int av_get_standard_channel_layout(unsigned index, uint64_t *layout, * * @param buf pre-allocated buffer where to put the generated string * @param buf_size size in bytes of the buffer. + * @param channel the AVChannel whose name to get * @return amount of bytes needed to hold the output string, or a negative AVERROR * on failure. If the returned value is bigger than buf_size, then the * string was truncated. @@ -559,6 +563,7 @@ void av_channel_name_bprint(struct AVBPrint *bp, enum AVChannel channel_id); * * @param buf pre-allocated buffer where to put the generated string * @param buf_size size in bytes of the buffer. + * @param channel the AVChannel whose description to get * @return amount of bytes needed to hold the output string, or a negative AVERROR * on failure. If the returned value is bigger than buf_size, then the * string was truncated. @@ -615,7 +620,7 @@ int av_channel_layout_from_string(AVChannelLayout *channel_layout, /** * Get the default channel layout for a given number of channels. * - * @param channel_layout the layout structure to be initialized + * @param ch_layout the layout structure to be initialized * @param nb_channels number of channels */ void av_channel_layout_default(AVChannelLayout *ch_layout, int nb_channels); @@ -680,6 +685,7 @@ int av_channel_layout_describe_bprint(const AVChannelLayout *channel_layout, * Get the channel with the given index in a channel layout. * * @param channel_layout input channel layout + * @param idx index of the channel * @return channel with the index idx in channel_layout on success or * AV_CHAN_NONE on failure (if idx is not valid or the channel order is * unspecified) @@ -692,6 +698,7 @@ av_channel_layout_channel_from_index(const AVChannelLayout *channel_layout, unsi * channels are found, only the first match will be returned. * * @param channel_layout input channel layout + * @param channel the channel whose index to obtain * @return index of channel in channel_layout on success or a negative number if * channel is not present in channel_layout. */ @@ -706,6 +713,7 @@ int av_channel_layout_index_from_channel(const AVChannelLayout *channel_layout, * @ref av_channel_from_string(). * * @param channel_layout input channel layout + * @param name string describing the channel whose index to obtain * @return a channel index described by the given string, or a negative AVERROR * value. */ @@ -719,6 +727,7 @@ int av_channel_layout_index_from_string(const AVChannelLayout *channel_layout, * @ref av_channel_from_string(). * * @param channel_layout input channel layout + * @param name string describing the channel to obtain * @return a channel described by the given string in channel_layout on success * or AV_CHAN_NONE on failure (if the string is not valid or the channel * order is unspecified)