From patchwork Sun Sep 25 00:11:16 2022 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Marvin Scholz X-Patchwork-Id: 38301 Delivered-To: andriy.gelman@gmail.com Received: by 2002:a05:6a10:9905:b0:2f4:3559:b653 with SMTP id j5csp1461420pxh; Sat, 24 Sep 2022 17:18:54 -0700 (PDT) X-Google-Smtp-Source: AMsMyM62uK8hCCpB91kLUqAne3zC4ozmpR+hhjo5311CzPVHjYNNLq/oOrvxrqS/xZsahNcZrOiR X-Received: by 2002:a17:906:9bd3:b0:76f:8cce:7a61 with SMTP id de19-20020a1709069bd300b0076f8cce7a61mr12857612ejc.345.1664065133927; Sat, 24 Sep 2022 17:18:53 -0700 (PDT) ARC-Seal: i=1; a=rsa-sha256; t=1664065133; cv=none; d=google.com; s=arc-20160816; b=U4v6ZApTHPeQaF+hygGga7px+cnCr0eyVW+IInXmOO607az1SM/7aUNpMbWHCr1yWj 4/zaZHStiKlf2a0AQnLlvDkCcbq6W6K6JwwHSUFfKrLp+GbTdDjQTWxHyYJO0e8dGBcG tpIfh/hqcTvALmK8V6TDspi1h8TnL+CKxKjtqsi54PM/n7pMwG6nZEXrX2dU9pRa0EiW j9TJsaKbYlAe2f69YA3fem91BSDBnRAjWOIa1yFW+BPuxIT2crKSAVosh/45JrHkwjkr 0W6by19OkI4KzwfircjZjEVSUE6WsWNgTdCI13wco+TvdsHnMGm6rhIVL+Bei75KospN 1NCQ== 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=5BTVXXKB747cK1Q1S8j/GWU9sZzn4HUwURjLAezQ4X8=; b=pHU4JYBG9d4KWgKBIssg1HESl9Zqo+CEt/EX65B8IyrUadrCz6u1qDYw6D+EcGvuYP ol7696Wo2ObOUonyp+WJuE8IGZxsYgsYei6x8ZqeBBBocW/AmQLf6qqEkXXTwt0hDw+d pktesU5gQv3ttMivinT2hBCyAtpSlX2gv2Yo6BuOUc32m2boxgy6n7OSPAQXr7HmVNIv VUiNG/yumhOSryLSHMsbCrx+5KBxCu4pDNZhf06KdYU2KfzjXLYX8/rSzWBK8HvPFa95 zeKXbm0TzXLd0dlTZi1XHSMDRKMrIqOM3WEuwjtTEoCzVoVVxGC7feyq2tv+mw8LHnMz t4zQ== ARC-Authentication-Results: i=1; mx.google.com; dkim=neutral (body hash did not verify) header.i=@gmail.com header.s=20210112 header.b="cw/MKErn"; 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 sc32-20020a1709078a2000b0077c3308aea9si8216712ejc.707.2022.09.24.17.18.53; Sat, 24 Sep 2022 17:18:53 -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="cw/MKErn"; 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 10DF868BC94; Sun, 25 Sep 2022 03:12:46 +0300 (EEST) X-Original-To: ffmpeg-devel@ffmpeg.org Delivered-To: ffmpeg-devel@ffmpeg.org Received: from mail-ed1-f46.google.com (mail-ed1-f46.google.com [209.85.208.46]) by ffbox0-bg.mplayerhq.hu (Postfix) with ESMTPS id 2846A68BC8D for ; Sun, 25 Sep 2022 03:12:43 +0300 (EEST) Received: by mail-ed1-f46.google.com with SMTP id z2so4708895edi.1 for ; Sat, 24 Sep 2022 17:12:43 -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=M1IZWz0lj3F1RspoobAxDDA6amfn3cXH4q1S9QpORfs=; b=cw/MKErn++T2tkxWQfmhijA99NLACbte8B67iAenwZaHmWqYfsKeoVEWMvaDmQbECd sq/rW8tg0YXXZFf+Bx40iJ0m/vl4mo0aBkd+hOX3uP5fKiXeFm638HygsetPSnLeWKW7 s9TbLZ3VHRMVaDNcc2gNOaHCLY5+s1nWvbU0TvTSI4Gm+hI7NkWk1bgawQMO3voucHAl xnlcv4NVIuM1bLoT5nvt9KKege7Wsofw4x3YIrr0GqztLDYprjSWcjx5x574DNq9x6ur k5aYUOWguFZBuwvukN4r4hLMwpc+ro/yytzPsW4SpbpsBbN3typ/EwVjvAJaY0sjBzcG jY2Q== 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=M1IZWz0lj3F1RspoobAxDDA6amfn3cXH4q1S9QpORfs=; b=sKQL/u2ISeXg7aBOz0cm/kJnNrNVUMCV6KOCc/i51S2BHQcpL/G23021KXRTUwTc9X juDJMD+EX+D0Ld8l5FLtXJ5+32asajncY7lIYnOM8krmnfTQAyV8+6w9qTd6J6Ci44U2 FuSYE6AiigCfiDqaNKtAH3lcUUM/DPa22Uk5eYyBEFzCPug9ttgCm81L/HKIb/YA766u K07h3eCexz2Twurnc9RUs2aysZo44vZRnNVSkGWo70DBkHw59/cyEhjDET6zm7Hjgy/M 4nD0evY/AKN/X106Bnbqq48dsGtkOrM2JbQEAX/7KtzPlmv++juxzseb+Rl5DpsGOkH3 58Pw== X-Gm-Message-State: ACrzQf3bWN7ggX38OsEZBIxSUISHLHkDiWNVRiYFA6eoThDQkRpy2+bJ nWqcp6nK0ztHNSx0b95nfKVi8xnPV3k= X-Received: by 2002:aa7:d883:0:b0:44e:bbbe:d661 with SMTP id u3-20020aa7d883000000b0044ebbbed661mr15471480edq.248.1664064762757; Sat, 24 Sep 2022 17:12:42 -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.42 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Sat, 24 Sep 2022 17:12:42 -0700 (PDT) From: Marvin Scholz To: ffmpeg-devel@ffmpeg.org Date: Sun, 25 Sep 2022 02:11:16 +0200 Message-Id: <20220925001121.37721-50-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 49/54] avutil/imgutils: document some 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: XrG8HjVYHaCk Content-Length: 4420 --- libavutil/imgutils.h | 20 ++++++++++++++++++++ 1 file changed, 20 insertions(+) diff --git a/libavutil/imgutils.h b/libavutil/imgutils.h index be53335568..e10ac14952 100644 --- a/libavutil/imgutils.h +++ b/libavutil/imgutils.h @@ -48,6 +48,7 @@ * component in the plane with the max pixel step. * @param max_pixstep_comps an array which is filled with the component * for each plane which has the max pixel step. May be NULL. + * @param pixdesc the AVPixFmtDescriptor for the image, describing its format */ void av_image_fill_max_pixsteps(int max_pixsteps[4], int max_pixstep_comps[4], const AVPixFmtDescriptor *pixdesc); @@ -65,6 +66,8 @@ int av_image_get_linesize(enum AVPixelFormat pix_fmt, int width, int plane); * width width. * * @param linesizes array to be filled with the linesize for each plane + * @param pix_fmt the AVPixelFormat of the image + * @param width width of the image in pixels * @return >= 0 in case of success, a negative error code otherwise */ int av_image_fill_linesizes(int linesizes[4], enum AVPixelFormat pix_fmt, int width); @@ -73,6 +76,8 @@ int av_image_fill_linesizes(int linesizes[4], enum AVPixelFormat pix_fmt, int wi * Fill plane sizes for an image with pixel format pix_fmt and height height. * * @param size the array to be filled with the size of each image plane + * @param pix_fmt the AVPixelFormat of the image + * @param height height of the image in pixels * @param linesizes the array containing the linesize for each * plane, should be filled by av_image_fill_linesizes() * @return >= 0 in case of success, a negative error code otherwise @@ -88,6 +93,8 @@ int av_image_fill_plane_sizes(size_t size[4], enum AVPixelFormat pix_fmt, * height height. * * @param data pointers array to be filled with the pointer for each image plane + * @param pix_fmt the AVPixelFormat of the image + * @param height height of the image in pixels * @param ptr the pointer to a buffer which will contain the image * @param linesizes the array containing the linesize for each * plane, should be filled by av_image_fill_linesizes() @@ -103,6 +110,11 @@ int av_image_fill_pointers(uint8_t *data[4], enum AVPixelFormat pix_fmt, int hei * The allocated image buffer has to be freed by using * av_freep(&pointers[0]). * + * @param pointers array to be filled with the pointer for each image plane + * @param linesizes the array filled with the linesize for each plane + * @param w width of the image in pixels + * @param h height of the image in pixels + * @param pix_fmt the AVPixelFormat of the image * @param align the value to use for buffer size alignment * @return the size in bytes required for the image buffer, a negative * error code in case of failure @@ -119,8 +131,11 @@ int av_image_alloc(uint8_t *pointers[4], int linesizes[4], * bytewidth must be contained by both absolute values of dst_linesize * and src_linesize, otherwise the function behavior is undefined. * + * @param dst destination plane to copy to * @param dst_linesize linesize for the image plane in dst + * @param src source plane to copy from * @param src_linesize linesize for the image plane in src + * @param height height (number of lines) of the plane */ void av_image_copy_plane(uint8_t *dst, int dst_linesize, const uint8_t *src, int src_linesize, @@ -147,8 +162,13 @@ void av_image_copy_plane_uc_from(uint8_t *dst, ptrdiff_t dst_linesize, /** * Copy image in src_data to dst_data. * + * @param dst_data destination image data buffer to copy to * @param dst_linesizes linesizes for the image in dst_data + * @param src_data source image data buffer to copy from * @param src_linesizes linesizes for the image in src_data + * @param pix_fmt the AVPixelFormat of the image + * @param width width of the image in pixels + * @param height height of the image in pixels */ void av_image_copy(uint8_t *dst_data[4], int dst_linesizes[4], const uint8_t *src_data[4], const int src_linesizes[4],