From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from ffbox0-bg.mplayerhq.hu (ffbox0-bg.ffmpeg.org [79.124.17.100]) by master.gitmailbox.com (Postfix) with ESMTP id 0369C420F4 for ; Tue, 22 Feb 2022 17:10:13 +0000 (UTC) Received: from [127.0.1.1] (localhost [127.0.0.1]) by ffbox0-bg.mplayerhq.hu (Postfix) with ESMTP id 523ED68B113; Tue, 22 Feb 2022 19:10:11 +0200 (EET) Received: from mail-oi1-f181.google.com (mail-oi1-f181.google.com [209.85.167.181]) by ffbox0-bg.mplayerhq.hu (Postfix) with ESMTPS id D2C6B689BC6 for ; Tue, 22 Feb 2022 19:10:04 +0200 (EET) Received: by mail-oi1-f181.google.com with SMTP id j24so13053131oii.11 for ; Tue, 22 Feb 2022 09:10:04 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20210112; h=message-id:date:mime-version:user-agent:subject:content-language:to :references:from:in-reply-to:content-transfer-encoding; bh=u4/l3A0YrEydWR7h8pCixnwvVXjzXMfGzA72jRBEhCo=; b=SDVWMFA+GtkymmsCLjOimXL9bEK62LoSyttzkqSChg2HjXKQ9qk4mASJ2zdKbOiYeI HZpSUV4tAdksrFnq/XlBQMMcT+J9IFYqp1tgI16cDdaap1U3VL9Zsl3DqipxXnORmt1M JsBmIUmrvzzSgC52Qj20EBFcKw0uSnTEAx6L3su15c//5OzFw3xZ1mO1teRQIejFpx4f c4YizyTzYjQqY/JgmtpNIP6fpYYXazTkJTEGWsdVf5+Rcqkuf1kNTqz32MitUMF/uyB2 VOpIjadvcmbRmmFdWPRuocyt0Is8a+746Se0Z56uMQ6wS9DhJmCIMhR1NYZFFMjw73Xx lAgg== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20210112; h=x-gm-message-state:message-id:date:mime-version:user-agent:subject :content-language:to:references:from:in-reply-to :content-transfer-encoding; bh=u4/l3A0YrEydWR7h8pCixnwvVXjzXMfGzA72jRBEhCo=; b=UnoPmzlfwxd83bennoWMonVK9MsQzEuMpz6cSL3uXj00NGskbfl8HrI0Kcgth7WCsc gWVh7Ib3LUAprHK2Dc/jkeBUQsoc7bqqXkytaUzfzPsjoZvLNvOsmP+FUUS1rWCYW8YI QItX4+RkTo+VyKYqXIrDHAME+Gf7Rd1f2cu4fzwUqlNpfICojSyq2ZKSyooXf1iWyx1v YXbpNCv/ZJjFL33ddq+n5t/QUMuAPfuS8Bwj1GFfpxKE3uaSM1zx0esY+HWgAONDVGVM SsJv1UX8FadrUlcVDPeL5ZRB+KQqfwvrwaB9xVa2nF5QDYZeqMwYnQ8/+xivbcJFLYsz F2BA== X-Gm-Message-State: AOAM530v+B39Fv9uwiHW3G44fXTg7JsQNluqHchfdfywsSmCyB/IUCKs FO4ilBB5ZxTVGmcK//Muwp4PbcRKeX5iXg== X-Google-Smtp-Source: ABdhPJxuy5jeRj00SKNZSEt4bMY2fPbL9gZiZSGlseO+MI4Mvcy3332jYnUFAt/riIVxK3Gt1gLWTQ== X-Received: by 2002:aca:eb45:0:b0:2d4:ea24:2aa4 with SMTP id j66-20020acaeb45000000b002d4ea242aa4mr2620652oih.340.1645549802839; Tue, 22 Feb 2022 09:10:02 -0800 (PST) Received: from [192.168.0.11] ([186.136.131.95]) by smtp.gmail.com with ESMTPSA id ay42sm9037652oib.5.2022.02.22.09.10.01 for (version=TLS1_3 cipher=TLS_AES_128_GCM_SHA256 bits=128/128); Tue, 22 Feb 2022 09:10:02 -0800 (PST) Message-ID: <61135415-ad5f-41d4-814e-d0b44488da83@gmail.com> Date: Tue, 22 Feb 2022 14:09:59 -0300 MIME-Version: 1.0 User-Agent: Mozilla/5.0 (Windows NT 10.0; Win64; x64; rv:91.0) Gecko/20100101 Thunderbird/91.6.1 Content-Language: en-US To: ffmpeg-devel@ffmpeg.org References: <20220222062757.20908-1-anton@khirnov.net> From: James Almer In-Reply-To: <20220222062757.20908-1-anton@khirnov.net> Subject: Re: [FFmpeg-devel] [PATCH 1/2] lavc/bsf: add general documentation 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 Content-Transfer-Encoding: 7bit Content-Type: text/plain; charset="us-ascii"; Format="flowed" Errors-To: ffmpeg-devel-bounces@ffmpeg.org Sender: "ffmpeg-devel" Archived-At: List-Archive: List-Post: On 2/22/2022 3:27 AM, Anton Khirnov wrote: > Also, place the BSF api docs in their own doxygen group. > --- > libavcodec/bsf.h | 23 ++++++++++++++++++++++- > 1 file changed, 22 insertions(+), 1 deletion(-) > > diff --git a/libavcodec/bsf.h b/libavcodec/bsf.h > index 8c5355d186..ba8b48f222 100644 > --- a/libavcodec/bsf.h > +++ b/libavcodec/bsf.h > @@ -30,7 +30,28 @@ > #include "packet.h" > > /** > - * @addtogroup lavc_core > + * @defgroup lavc_bsf Bitstream filters > + * @ingroup libavc > + * > + * Bitstream filters transform encoded media data without decoding it. This > + * allows e.g. manipulating various header values. Bitstream filters operate on > + * @ref AVPacket "AVPackets". > + * > + * The bitstream filtering API is centered around two structures: > + * AVBitStreamFilter and AVBSFContext. The former represents a bitstream filter Could use @ref here and below, too. > + * in abstract, the latter a specific filtering process. Obtain an > + * AVBitStreamFilter using av_bsf_get_by_name() or av_bsf_iterate(), then pass > + * it to av_bsf_alloc() to create an AVBSFContext. Fill in the user-settable > + * AVBSFContext fields, as described in its documentation, then call > + * av_bsf_init() to prepare the filter context for use. > + * > + * Submit packets for filtering using av_bsf_send_packet(), obtain filtered > + * results with av_bsf_receive_packet(). When no more input packets will be > + * sent, submit a NULL AVPacket to signal the end of the stream to the filter. The doxy for av_bsf_send_packet() states the packet must be "empty", meaning either "NULL, or pkt->data is NULL and pkt->side_data_elems zero", so probably mention the same here so it's consistent. > + * av_bsf_receive_packet() will then return trailing packets, if any are > + * produced by the filter. > + * > + * Finally, free the filter context with av_bsf_free(). > * @{ > */ LGTM otherwise. _______________________________________________ ffmpeg-devel mailing list ffmpeg-devel@ffmpeg.org https://ffmpeg.org/mailman/listinfo/ffmpeg-devel To unsubscribe, visit link above, or email ffmpeg-devel-request@ffmpeg.org with subject "unsubscribe".