From patchwork Sun Oct 29 19:20:52 2017 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: James Almer X-Patchwork-Id: 5748 Delivered-To: ffmpegpatchwork@gmail.com Received: by 10.2.161.90 with SMTP id m26csp1868505jah; Sun, 29 Oct 2017 12:21:15 -0700 (PDT) X-Google-Smtp-Source: ABhQp+S4gMeFVPwoziOdUdgvnpP5zDLRRYKhLXm88BUbhoF/jBjoIV5DHbwvR5o78jOwKK5MXa5G X-Received: by 10.28.46.137 with SMTP id u131mr1947260wmu.64.1509304875190; Sun, 29 Oct 2017 12:21:15 -0700 (PDT) ARC-Seal: i=1; a=rsa-sha256; t=1509304875; cv=none; d=google.com; s=arc-20160816; b=hbUgg8jPgrogiPYw2ylb5uuf11aG0T1F3aL5UNci0Ed20zAKACQnY8aBimS6QskfIf zOimslUNxzeWAR9GyAKKULsYLkB6BeMrTDSNjBY5Bk7w/3ZvwS4DOn3WxPRZlBPTFO6v aLxGC5sQx/e44Bmf9ijtyccNtyPJlYDCa73ZT2DBgwqyqgnoYmynjJfNPKIcmUReEk/i qnM/5T1wkjH0T1r7mItqTq+12Icz6cztsB9lh6y1hvzqEUoQs2ZE6kXyxSSoPdNq6+0c dgg3eeTfa7BohcoKKRLWdJ/RfPNpNSTN+gZ5d4txu0VYtMDlwyQ91E9cC9E6x+f6WvQ5 Gt1w== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=arc-20160816; h=sender:errors-to:content-transfer-encoding:mime-version:reply-to :list-subscribe:list-help:list-post:list-archive:list-unsubscribe :list-id:precedence:subject:references:in-reply-to:message-id:date :to:from:dkim-signature:delivered-to:arc-authentication-results; bh=yMKqm7QBdFvEiT1I25m3i3ZumehCHLMn8v42JOO+9F4=; b=U7HUfh2f6tn/aOs6lsacZsjLYFw1Gmvq/+sG/jfOAR+KCn1ltTzrdbOXLJll3nhZ1e nWyaRiediXnQxVRprhaIN0t3u+UdjiSJtRyJkuUEEsx9Ml2+Vmkcl4qSdDVwJTi2gY6b DsVV3igpd5JI1XO01ZnqVuzzDSXdwmE9qe1dHwWamneTbEVVIVr7FzGqEZpfUb4TxG/C Hkp+Oz6Aygp3XDFX43scWac49psph6ZbVN5hVxJ+AjCQnQeIE+2GAEe4nYeY05ZZd2dg q03+Eqrv0Dv7KX+zyOiIRvw3zAx1SHTDaL+iPOduiEWyyBt6wbu7eznaPWTX7uE4+5X4 TxTQ== ARC-Authentication-Results: i=1; mx.google.com; dkim=neutral (body hash did not verify) header.i=@gmail.com header.s=20161025 header.b=Bb2+uHQv; 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=NONE 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 y15si9988333wry.86.2017.10.29.12.21.14; Sun, 29 Oct 2017 12:21:15 -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=20161025 header.b=Bb2+uHQv; 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=NONE 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 0221B68A283; Sun, 29 Oct 2017 21:21:04 +0200 (EET) X-Original-To: ffmpeg-devel@ffmpeg.org Delivered-To: ffmpeg-devel@ffmpeg.org Received: from mail-qk0-f193.google.com (mail-qk0-f193.google.com [209.85.220.193]) by ffbox0-bg.mplayerhq.hu (Postfix) with ESMTPS id A9EFE689E45 for ; Sun, 29 Oct 2017 21:20:57 +0200 (EET) Received: by mail-qk0-f193.google.com with SMTP id l194so13736868qke.13 for ; Sun, 29 Oct 2017 12:21:07 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20161025; h=from:to:subject:date:message-id:in-reply-to:references; bh=cX8VHlNRtob1tRcEuhpZ5+nJ4EuP/RrsKOmBplTbeSw=; b=Bb2+uHQvyUuLYYmb9GMyEDR9662ITXIyHWASKMC6jdV7ViAxiiJ+TNQqpdvOUklSQF WKXMUKH743Sv3Wk+K4+TkjAGwKqbGY5MVLlvCjAPp1xVpG9TThotIo+chCu1Lv/PELPL 9GQEaOIVKAwljdZUk3m7aV1qy/8cRLkKgyIHHLqXjmRyDhKVs4ta5EzTRAXj1QtS57hg pRKs7CXHv81yNeXUqJKna6hnzSHBKRoBt6ZLHk2QpR/3jzZ3n/FgcWGrv9alG874yYlH XqKp82rZFedMk8/BGpQxUgECgg2zHR4kJMg7IVqlbBdyUUAPKONpRxjiPSkgsYPQ6Rak IWLQ== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:from:to:subject:date:message-id:in-reply-to :references; bh=cX8VHlNRtob1tRcEuhpZ5+nJ4EuP/RrsKOmBplTbeSw=; b=Zi7s1bGHze6YC11gPfFnEk3Bl87G4SupDb9h+jDAdRO9/8VCgs0HkfUvE18sSA8lLV 98IGOUZEZbsb1bIKyXFOaRayaEnCUknKcCLru2trmAHex+cHpHY1TfdpOM5ZVF5oH4tw 16lb7zBaGKcFprVaD3zhliAtZ+lvrngTXb6fKqz4oLUwk9KI/LyuZaELTHu4Od+1geUw CRdGvXHNKfixrIo1ifAZmDPrpO+jOrmjg4Rgjquz0K7t+XPylKwsuO5z078pt2MiqFSf ozmLUkgUzwFd1R2QCa2TwWhv1RutqSUj81AaCbfCaU2brH1j2reMGpqCo+F/MjpNRLfq 5PiA== X-Gm-Message-State: AMCzsaUrsFhIp0unomehzbn1/Ih9vLRhno9sbOPSUBtrurB9n0UNjU++ cyl338RGOVTJDWSk1S8S99uO7Q== X-Received: by 10.55.188.6 with SMTP id m6mr10253780qkf.312.1509304865347; Sun, 29 Oct 2017 12:21:05 -0700 (PDT) Received: from localhost.localdomain ([181.231.59.220]) by smtp.gmail.com with ESMTPSA id g23sm9046883qta.35.2017.10.29.12.21.03 for (version=TLS1_2 cipher=ECDHE-RSA-AES128-SHA bits=128/128); Sun, 29 Oct 2017 12:21:04 -0700 (PDT) From: James Almer To: ffmpeg-devel@ffmpeg.org Date: Sun, 29 Oct 2017 16:20:52 -0300 Message-Id: <20171029192052.9528-1-jamrial@gmail.com> X-Mailer: git-send-email 2.14.2 In-Reply-To: <4d258ecb-e7f6-8a3e-de63-610d11a76c8f@gmail.com> References: <4d258ecb-e7f6-8a3e-de63-610d11a76c8f@gmail.com> Subject: [FFmpeg-devel] [PATCH] avcodec/avcodec.h: remove doxy from the old bsf API functions X-BeenThere: ffmpeg-devel@ffmpeg.org X-Mailman-Version: 2.1.20 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 MIME-Version: 1.0 Errors-To: ffmpeg-devel-bounces@ffmpeg.org Sender: "ffmpeg-devel" Make it clear that these are deprecated and the new API should be used instead. As a side effect, this slightly reduces differences with libav. Signed-off-by: James Almer --- libavcodec/avcodec.h | 70 +++++++++++----------------------------------------- 1 file changed, 14 insertions(+), 56 deletions(-) diff --git a/libavcodec/avcodec.h b/libavcodec/avcodec.h index ee7834c8a2..c4134424f0 100644 --- a/libavcodec/avcodec.h +++ b/libavcodec/avcodec.h @@ -5407,81 +5407,39 @@ typedef struct AVBitStreamFilter { #if FF_API_OLD_BSF /** - * Register a bitstream filter. - * - * The filter will be accessible to the application code through - * av_bitstream_filter_next() or can be directly initialized with - * av_bitstream_filter_init(). - * - * @see avcodec_register_all() + * @deprecated the old bitstream filtering API (using AVBitStreamFilterContext) + * is deprecated. Use the new bitstream filtering API (using AVBSFContext). */ attribute_deprecated void av_register_bitstream_filter(AVBitStreamFilter *bsf); - /** - * Create and initialize a bitstream filter context given a bitstream - * filter name. - * - * The returned context must be freed with av_bitstream_filter_close(). - * - * @param name the name of the bitstream filter - * @return a bitstream filter context if a matching filter was found - * and successfully initialized, NULL otherwise + * @deprecated the old bitstream filtering API (using AVBitStreamFilterContext) + * is deprecated. Use av_bsf_get_by_name(), av_bsf_alloc(), and av_bsf_init() + * from the new bitstream filtering API (using AVBSFContext). */ attribute_deprecated AVBitStreamFilterContext *av_bitstream_filter_init(const char *name); - /** - * Filter bitstream. - * - * This function filters the buffer buf with size buf_size, and places the - * filtered buffer in the buffer pointed to by poutbuf. - * - * The output buffer must be freed by the caller. - * - * @param bsfc bitstream filter context created by av_bitstream_filter_init() - * @param avctx AVCodecContext accessed by the filter, may be NULL. - * If specified, this must point to the encoder context of the - * output stream the packet is sent to. - * @param args arguments which specify the filter configuration, may be NULL - * @param poutbuf pointer which is updated to point to the filtered buffer - * @param poutbuf_size pointer which is updated to the filtered buffer size in bytes - * @param buf buffer containing the data to filter - * @param buf_size size in bytes of buf - * @param keyframe set to non-zero if the buffer to filter corresponds to a key-frame packet data - * @return >= 0 in case of success, or a negative error code in case of failure - * - * If the return value is positive, an output buffer is allocated and - * is available in *poutbuf, and is distinct from the input buffer. - * - * If the return value is 0, the output buffer is not allocated and - * should be considered identical to the input buffer, or in case - * *poutbuf was set it points to the input buffer (not necessarily to - * its starting address). A special case is if *poutbuf was set to NULL and - * *poutbuf_size was set to 0, which indicates the packet should be dropped. + * @deprecated the old bitstream filtering API (using AVBitStreamFilterContext) + * is deprecated. Use av_bsf_send_packet() and av_bsf_receive_packet() from the + * new bitstream filtering API (using AVBSFContext). */ attribute_deprecated int av_bitstream_filter_filter(AVBitStreamFilterContext *bsfc, AVCodecContext *avctx, const char *args, uint8_t **poutbuf, int *poutbuf_size, const uint8_t *buf, int buf_size, int keyframe); - /** - * Release bitstream filter context. - * - * @param bsf the bitstream filter context created with - * av_bitstream_filter_init(), can be NULL + * @deprecated the old bitstream filtering API (using AVBitStreamFilterContext) + * is deprecated. Use av_bsf_free() from the new bitstream filtering API (using + * AVBSFContext). */ attribute_deprecated void av_bitstream_filter_close(AVBitStreamFilterContext *bsf); - /** - * If f is NULL, return the first registered bitstream filter, - * if f is non-NULL, return the next registered bitstream filter - * after f, or NULL if f is the last one. - * - * This function can be used to iterate over all registered bitstream - * filters. + * @deprecated the old bitstream filtering API (using AVBitStreamFilterContext) + * is deprecated. Use av_bsf_next() from the new bitstream filtering API (using + * AVBSFContext). */ attribute_deprecated const AVBitStreamFilter *av_bitstream_filter_next(const AVBitStreamFilter *f);