From patchwork Sun Sep 25 00:11:17 2022 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Marvin Scholz X-Patchwork-Id: 38300 Delivered-To: andriy.gelman@gmail.com Received: by 2002:a05:6a10:9905:b0:2f4:3559:b653 with SMTP id j5csp1461470pxh; Sat, 24 Sep 2022 17:19:00 -0700 (PDT) X-Google-Smtp-Source: AMsMyM4k6aOpZCAhuIFWM4eh1WX+gBN8nON1w0YJtNii89QuTt9bJKereiHPYVUgV3CEFw8TYXFJ X-Received: by 2002:a17:907:2707:b0:781:cfa5:18f with SMTP id w7-20020a170907270700b00781cfa5018fmr12664323ejk.501.1664065140021; Sat, 24 Sep 2022 17:19:00 -0700 (PDT) ARC-Seal: i=1; a=rsa-sha256; t=1664065140; cv=none; d=google.com; s=arc-20160816; b=m3RitKM5zTgz5gWnWEmHEE+dOhXrOxBB8OtVz2yNjCF9RtWSyQYtP8YL4i1bLh9eVZ 1GQzGupKMQinhJy6JZ299AhQe6KN1+jP6kWVctfJgyBFma+U0olZfqa8E6qtyESSfrcu RlZYSFNAa0/CWPm1N0o8EPIWjTJU/wFC9B5Ncoy7xD5ZdEXf1kamTbUc4H8mdBzU5ixl 9fQZYrUmlyJnKyrKrkjWw2ymDMn8Q2VNIX51Fku4+7JJvYnTSbIMqhPQ/flKmMWvgZ/r JIQUb0Ub0vrzbnT73cqIUSssAOZu+DX1p11n0vEuSikEwQlRnrgrpgB802WWHiID8JYN bbKQ== 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=rCLLfQOwYHbq/zkrvHRC/yRRZz6gPj4saZ1qqns+AqQ=; b=ypXADdOD6mG5RksbxZuH+uVmdYoANI+LJOUnrDXlOPdX+QEZ+MF7k4b9/ECKe2OoZG SAgoON6gKhR+BEViFP7cPEvSRp1MFDcYuZgMpE2brYKY11ysFAWrMdJ7+mr3hj8VDk8D 95E1jkNT/6PS5UQjXW59A/dEc1s4qfv/VgBLrx/NnwtqGaY7QBHJessGPVWVU3uOdiJm xJ4WIXrkQda74swcQ77JNJ37DSW6Fik75kL4wzt3T+vKQVePYBYLQ3rxB8jFSudZpe5l yIgs1tApI7TH1Dn4/pqzRSKKtkfpdhMQdB/i67956eoU+rQ/kXHM3xXxotlDsXLIDBcM +MLg== ARC-Authentication-Results: i=1; mx.google.com; dkim=neutral (body hash did not verify) header.i=@gmail.com header.s=20210112 header.b=nucqmiW0; 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 jt28-20020a170906dfdc00b00733e46f4543si9379737ejc.820.2022.09.24.17.18.59; Sat, 24 Sep 2022 17:19:00 -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=nucqmiW0; 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 772E768BC97; 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-f53.google.com (mail-ed1-f53.google.com [209.85.208.53]) by ffbox0-bg.mplayerhq.hu (Postfix) with ESMTPS id D990368BABC for ; Sun, 25 Sep 2022 03:12:44 +0300 (EEST) Received: by mail-ed1-f53.google.com with SMTP id 30so4677819edw.5 for ; Sat, 24 Sep 2022 17:12:44 -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=vzNkQMTRI8J92TLWWAAngPEYoH/0s3C/ZGgY+I5gkpQ=; b=nucqmiW0vskLpDovha1Ec8iO3YsoizpRZjHEHStte614n996vZZH5GTKrmKM2PXaV4 kpl6V0OYq3U2uZzOm7dmKL68VWylQf3FfEzB3D5EhVNzA8Xs9EWeJaTIJOtTPDcYitA+ fh7hkn0FHEq88dkrM0x9tWTNBuYtjUobn1SoqeFw5G3OvzIllWls/E4jl1TfsCrWGgf+ 4VFrL1l+5vlesCSnk2GqfhzIFQxWrIDP74xoypDBTd/Dq5Y+ye++/3Oz8QSWVy+b9kvX svf8baP1EFM4KYYUBpVV2cAZwuozPy1CxbRRuqzVLINZCGkTv9XTT8KB8JvpS64guF3z XQ8Q== 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=vzNkQMTRI8J92TLWWAAngPEYoH/0s3C/ZGgY+I5gkpQ=; b=cxlbBqO8LrEEs0YFahb16G+37dtNYRYq7TypNVvNpWRPIWwEpzVuvn9Gz7ISOXGWNC vZPRIIuKpJR8JtnbkIUbZ1iaXdUXREYe6pp3SxhuTne+AwXaVTrRMbsiLNjy4fMelhZY Xyaau5sWRfYyFQGGDMQGOA3wGdla1kgebeJdDqDG7dvUdpOO7k5qIVDcHu81tOljdJp4 JvNn3mrOH1mxa5TA7VSWWQZ4ZDAY2miSBEZah+J6kQlm9cdSrdf8BkEKphuOIXi5+nWF M6e7O+w55PE7wAp4T48PoEiLzXiWPOir9EoVokstg0X8qrD88pQm6Z17tcR6+54Ujedi Ad7w== X-Gm-Message-State: ACrzQf1srdpL2tITB5Zhzz9DxiCe7ir/WLQSGzDW6sfTcPz7Wqq+eNKA /Dm0sh4hATHe3T4UDQyTABeMJjSwtC4= X-Received: by 2002:a05:6402:2217:b0:457:1eb6:ca3a with SMTP id cq23-20020a056402221700b004571eb6ca3amr1915917edb.364.1664064764026; Sat, 24 Sep 2022 17:12:44 -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.43 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Sat, 24 Sep 2022 17:12:43 -0700 (PDT) From: Marvin Scholz To: ffmpeg-devel@ffmpeg.org Date: Sun, 25 Sep 2022 02:11:17 +0200 Message-Id: <20220925001121.37721-51-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 50/54] swscale: 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: 6AWVFCJuHSRq Content-Length: 3321 --- libswscale/swscale.h | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/libswscale/swscale.h b/libswscale/swscale.h index 9794f6a258..5410b9e0d2 100644 --- a/libswscale/swscale.h +++ b/libswscale/swscale.h @@ -234,6 +234,7 @@ int sws_scale(struct SwsContext *c, const uint8_t *const srcSlice[], * - sws_receive_slice(0, dst->height) * - sws_frame_end() * + * @param c The scaling context * @param dst The destination frame. See documentation for sws_frame_start() for * more details. * @param src The source frame. @@ -249,6 +250,7 @@ int sws_scale_frame(struct SwsContext *c, AVFrame *dst, const AVFrame *src); * This function will retain references to src and dst, so they must both use * refcounted buffers (if allocated by the caller, in case of dst). * + * @param c The scaling context * @param dst The destination frame. * * The data buffers may either be already allocated by the caller or @@ -273,6 +275,8 @@ int sws_frame_start(struct SwsContext *c, AVFrame *dst, const AVFrame *src); * submitted with sws_frame_start(). Must be called after all sws_send_slice() * and sws_receive_slice() calls are done, before any new sws_frame_start() * calls. + * + * @param c The scaling context */ void sws_frame_end(struct SwsContext *c); @@ -282,6 +286,7 @@ void sws_frame_end(struct SwsContext *c); * any order, but may not overlap. For vertically subsampled pixel formats, the * slices must be aligned according to subsampling. * + * @param c The scaling context * @param slice_start first row of the slice * @param slice_height number of rows in the slice * @@ -294,6 +299,7 @@ int sws_send_slice(struct SwsContext *c, unsigned int slice_start, * Request a horizontal slice of the output data to be written into the frame * previously provided to sws_frame_start(). * + * @param c The scaling context * @param slice_start first row of the slice; must be a multiple of * sws_receive_slice_alignment() * @param slice_height number of rows in the slice; must be a multiple of @@ -310,6 +316,9 @@ int sws_receive_slice(struct SwsContext *c, unsigned int slice_start, unsigned int slice_height); /** + * Get the alignment required for slices + * + * @param c The scaling context * @return alignment required for output slices requested with sws_receive_slice(). * Slice offsets and sizes passed to sws_receive_slice() must be * multiples of the value returned from this function. @@ -317,6 +326,7 @@ int sws_receive_slice(struct SwsContext *c, unsigned int slice_start, unsigned int sws_receive_slice_alignment(const struct SwsContext *c); /** + * @param c the scaling context * @param dstRange flag indicating the while-black range of the output (1=jpeg / 0=mpeg) * @param srcRange flag indicating the while-black range of the input (1=jpeg / 0=mpeg) * @param table the yuv2rgb coefficients describing the output yuv space, normally ff_yuv2rgb_coeffs[x]