From patchwork Sun Sep 25 00:11:18 2022 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Marvin Scholz X-Patchwork-Id: 38295 Delivered-To: andriy.gelman@gmail.com Received: by 2002:a05:6a10:9905:b0:2f4:3559:b653 with SMTP id j5csp1461567pxh; Sat, 24 Sep 2022 17:19:14 -0700 (PDT) X-Google-Smtp-Source: AMsMyM6eBXwxgw3CLTZ480mgfQkKQoUV1ZNArZ1cigBj85xjAnVwKB1XzZj/DqcXRngimxCIfFuB X-Received: by 2002:a05:6402:1053:b0:455:27b7:f1 with SMTP id e19-20020a056402105300b0045527b700f1mr14244013edu.370.1664065154006; Sat, 24 Sep 2022 17:19:14 -0700 (PDT) ARC-Seal: i=1; a=rsa-sha256; t=1664065154; cv=none; d=google.com; s=arc-20160816; b=jJxWODFlhCkl5Wi+ttefeR9Amphd/m6z6+aNZ0hJODoZnAVtLU8bIF3ci3GuEfXIun D1JqBMXmF4P1s2e85WWD0ni/pDDZkacvRjg7qWK0vOne3toIgMo+Zg8xdYK3Fs/YL5o+ N7JQLKqFWSIwD+BKg0tjzK0gmgIuoz2QgBBFxyEoB2wrNJuqyGE3wmAu0qZ4aXrLrWVi oXvoZM69rtya3sniMA64XM6BypedM+khWUEfsecrxZN2OTyCDaW4SDf5h7vNll8Rk6mN ldQE2fIPSecN4JaPrNaS1unfBuMaCaT72diBn4niT9KxHgoXaTbOWitxLna0LpjMdGjC V/xQ== 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=t6xDj2cumkjilD+99ZgqOI20kgv5wBpOv7GPwDxKCoo=; b=x1JRDJ0oV/Awuf6LQa6FScjE8JVeBgvNaTwcgTsU08BiwpkkaaelvwNA0Xh2Nf+/gu EV4u5t2ycz8oUTjhagozomhzACLpC7SomSk/YpDgSEFuavJLy5pYHYaVr+3LBrMD7GFk GeoJ3Qv23PDvYrPPxX8RuO6pnxn2FrfXd8hY2sq0Jr/miWELaF9/1HU0crPAK3CAK7/i britpwSfkrju4UXL5a0c8M/2UlTn39BWz3O7CnWVtWMS6vwUACHCr24U70e1DV5BjYrS GgKJCK9ARTEITmhmIiCxRRCB5f3iFhfgibXT+cGCbCpqeft0NaWMRdyFNGRGTlteeHGr zE5Q== ARC-Authentication-Results: i=1; mx.google.com; dkim=neutral (body hash did not verify) header.i=@gmail.com header.s=20210112 header.b=cEb8HFM7; 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 b10-20020a056402350a00b004513ce1a086si13484289edd.56.2022.09.24.17.19.12; Sat, 24 Sep 2022 17:19:13 -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=cEb8HFM7; 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 048BD68BC9B; Sun, 25 Sep 2022 03:12:49 +0300 (EEST) X-Original-To: ffmpeg-devel@ffmpeg.org Delivered-To: ffmpeg-devel@ffmpeg.org Received: from mail-ed1-f51.google.com (mail-ed1-f51.google.com [209.85.208.51]) by ffbox0-bg.mplayerhq.hu (Postfix) with ESMTPS id A1BCE68BC8C for ; Sun, 25 Sep 2022 03:12:45 +0300 (EEST) Received: by mail-ed1-f51.google.com with SMTP id z97so4648523ede.8 for ; Sat, 24 Sep 2022 17:12:45 -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=vn2cIt20YlKWQUxCOSPQTDlxKcRG/FUWUK++MA2HBfc=; b=cEb8HFM7Iut9jHrKKLC0Allj135+IeDJE+ITzEomlhO1v9BhOd1LQLu2iA/eEQM+dC 0WGP35Z6DzsvfdoZyJ4HC8h+y9v1V0F8nWUT06lJjheS7mFpXLVbsn7enQcWHHQLK+H9 QC5G6ZrPIiA2k29VrX7BFIv9kpL/vRFSrrffmRq+xVMH0lP4z3RmhCqV6K93Uwgg5Eov GGc06d+Oz+q2hnvdTWRXqnevrWNRNb5XCiyBBTIfSpTU1YjsaNPw8dFulpPI9N6glRS5 d34dvZ8UMF6B1DgCFbyGn8pr8Q9LDdEjSAp59oxWfe3rWoTloHpTwb7ND5byGGYVbqdR Qg0g== 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=vn2cIt20YlKWQUxCOSPQTDlxKcRG/FUWUK++MA2HBfc=; b=UfSX1TzjPSRrwtm3BWu5tSzEdgLYN1j5zomtJPbf0wXTB8G2kLSGfwrYowP0CILGQj zoFx8FD/29UfhowDEbSOq1989VZUko1wBlFP50L4GHHOdDsYfWLGFIkwv3D26QsSM8mI Cup0vDotHlBhpYKSWon7Nq9RHaBnyyaD44VeV0aojQxbd+YWEL69JZyzrVfTxqy9i6Y/ jvOqvMnGTT/t3SvM/seLrnFiCUgBFXUFWMqytHBN3U9rYreCcQfFPo/JMr0Pq51f4KuR zYKiA+6tFnGtPS5OOHeFJSpsThjJrTKB2C23V1p4FQHXywdjULrOsEzgPZZ5kGdIVEeI DFiw== X-Gm-Message-State: ACrzQf3T0Y2hhUq/MYZNj/bnqJiOtYjLMLlz6WucccMSfuE3J1ICxgkH D9i2BV4+YnUIExu9bSNB/KjfN3n4Btg= X-Received: by 2002:aa7:db58:0:b0:457:30ce:bcaa with SMTP id n24-20020aa7db58000000b0045730cebcaamr163863edt.20.1664064765288; Sat, 24 Sep 2022 17:12:45 -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.44 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Sat, 24 Sep 2022 17:12:45 -0700 (PDT) From: Marvin Scholz To: ffmpeg-devel@ffmpeg.org Date: Sun, 25 Sep 2022 02:11:18 +0200 Message-Id: <20220925001121.37721-52-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 51/54] avcodec/bsf: 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: nq+WxxduT4gA Content-Length: 1613 --- libavcodec/bsf.h | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/libavcodec/bsf.h b/libavcodec/bsf.h index 69d91a16ab..17fa6141ee 100644 --- a/libavcodec/bsf.h +++ b/libavcodec/bsf.h @@ -164,6 +164,8 @@ int av_bsf_alloc(const AVBitStreamFilter *filter, AVBSFContext **ctx); /** * Prepare the filter for use, after all the parameters and options have been * set. + * + * @param ctx a AVBSFContext previously allocated with av_bsf_alloc() */ int av_bsf_init(AVBSFContext *ctx); @@ -174,6 +176,7 @@ int av_bsf_init(AVBSFContext *ctx); * av_bsf_receive_packet() repeatedly until it returns AVERROR(EAGAIN) or * AVERROR_EOF. * + * @param ctx an initialized AVBSFContext * @param pkt the packet to filter. The bitstream filter will take ownership of * the packet and reset the contents of pkt. pkt is not touched if an error occurs. * If pkt is empty (i.e. NULL, or pkt->data is NULL and pkt->side_data_elems zero), @@ -192,6 +195,7 @@ int av_bsf_send_packet(AVBSFContext *ctx, AVPacket *pkt); /** * Retrieve a filtered packet. * + * @param ctx an initialized AVBSFContext * @param[out] pkt this struct will be filled with the contents of the filtered * packet. It is owned by the caller and must be freed using * av_packet_unref() when it is no longer needed.