From patchwork Sun Oct 29 15:49:44 2017 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: James Almer X-Patchwork-Id: 5747 Delivered-To: ffmpegpatchwork@gmail.com Received: by 10.2.161.90 with SMTP id m26csp1697743jah; Sun, 29 Oct 2017 08:50:17 -0700 (PDT) X-Google-Smtp-Source: ABhQp+S8ziltD4QKJ+2t9PBop8YxU7HXO5czCHXdkxf+1wmPw2W332GGW0ipjcz+lYBwwcGgAqb8 X-Received: by 10.28.24.70 with SMTP id 67mr1516224wmy.7.1509292217141; Sun, 29 Oct 2017 08:50:17 -0700 (PDT) ARC-Seal: i=1; a=rsa-sha256; t=1509292217; cv=none; d=google.com; s=arc-20160816; b=EW5qdSUzlObdSYszZSV2ZEDmKnZzDjI7f46O+1sw7FK5DRU3sjyObNppn4UR6XxvTA MVQ6AkXd0PHM3A7UWUCprfKhcJBu7hv+7VqKub45DWYJZqTHoCJKzoZimaY/wpUWsoi5 CmAT/7YE/8xo+6ufll/jgDTUrEujUvP8W6W+bODDv32x4dTaOxxTpLA4461uH3yZcziS kkMWtXI+Vd5eMOxEvOYrkCQ5EHXhSQURSLlNjzr2g/OLiHJ+MouPwvumH6vfevtMKbh5 ui6JNCIYG2ItRVnwQiqbnwIjUPKzxbWkbDaUjXBlauEu4qt2t7AtHsF7UkYhAMTtfm69 nefA== 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:message-id:date:to:from:dkim-signature :delivered-to:arc-authentication-results; bh=RELtCDjorrCTGKAMQxfFjDUb1Doj1USjuEAArt5PWIM=; b=XUPboP6/xN66cYf3B/wJXJckK300HdVO4pVLM0wsPqQzp/NLvBQ6TdawK13AkmYzwS 01QK5b5AcsMtwN4Rn93eO7tZOYXK30jOOf6Qee6DiAWsjU9TdWNBm8igHG8m/loobECY pvtzysgoeL9FCEyisVJS/6ahRh4CEcv107n5yHPfz9rDndwwtw+mMwAm9+K3MiW5fwPL fbYRGYAACr0FcTCk0Py6HbEm8vsWPVmCha4ERHyijF/oVXkqFzhk9NpE9dyYW7lZtxe3 DaZ5C50w8QjoIxHKl84YQO9q78qdFHRutlf9NtN+Z0j6jVRyhyVmLd8RS6R3KLSlVp1f PdEg== ARC-Authentication-Results: i=1; mx.google.com; dkim=neutral (body hash did not verify) header.i=@gmail.com header.s=20161025 header.b=rlrhivD0; 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 193si1413364wmj.143.2017.10.29.08.50.16; Sun, 29 Oct 2017 08:50:17 -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=rlrhivD0; 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 D536968A09E; Sun, 29 Oct 2017 17:50:06 +0200 (EET) X-Original-To: ffmpeg-devel@ffmpeg.org Delivered-To: ffmpeg-devel@ffmpeg.org Received: from mail-qk0-f196.google.com (mail-qk0-f196.google.com [209.85.220.196]) by ffbox0-bg.mplayerhq.hu (Postfix) with ESMTPS id C48FE68A084 for ; Sun, 29 Oct 2017 17:50:00 +0200 (EET) Received: by mail-qk0-f196.google.com with SMTP id r64so13460629qkc.1 for ; Sun, 29 Oct 2017 08:50:10 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20161025; h=from:to:subject:date:message-id; bh=POrWEF3m6Qd8m4a6+Vo0iwVz3Le9mfItsaFCRRzphUA=; b=rlrhivD0SvGzVWDrZYX2xphzoz4m+mJ2g8ey0dryRNBLMh9kA0UfUIWtkGJPrbzwEn y1VgplWoTX623Wp4NaoWDZhYP+ElsUQTSpU9wAg1Dt1t/RrEDenFdoAWbSZLHhF+sBMp 3p4geAsEyyjJUeoluftzPQgPFouG/Ul72MykX5P68RYX5s/iVHtLaHif7qJcN4t3dvEk nX2H0LcvZKs2C1hFL2hCBveyUDy3ATcoGXbn5hmejA9MIs6te2kwMX+rxWwjMaBx+6eJ jXbqXtbJzZmEJOPZKGcGepirxwMkXXpgbi5sbn3/DweEkdsnfv8E6X35HfxAVEiK1JrU RVOQ== 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; bh=POrWEF3m6Qd8m4a6+Vo0iwVz3Le9mfItsaFCRRzphUA=; b=il6jV2N/EsNhOilToIcGMQIPr8L4MP7CQ6+oGai01bIKpddR+1SUOCZhrQzMuRTDMr FGrxKuopQOk1Q6vP10sGtD7zwQwPSYFacED6Pb/RQQHr6gwMb6kmK9gqfXpW1TMdt6Vd ycTULQ8bIzI57IhqZKpzpK7atdVLwAV9P8QwCZIJVN2BK0kbBL+ugIL4S0t69aVl+sjt VE3exhlEaina2Q4ooJgoCcZ407b1sjn7ds1GK/PM7gnZ129Lq9NRz4PaxhPwzT86COL+ GqkvcxKUtbSN4M5NKig8bOufZCajz7tGs94Tsb0nnvH9l1MF/Q72vjaCyzMWAgDc+qO8 4ZlA== X-Gm-Message-State: AMCzsaXuGg03y43tH37+m+yFPSS8gkY/Urgjy1lF3OppqyfMrNZZxeFR h00sSpBkQLKBcZV/BqKEvnh09A== X-Received: by 10.55.105.130 with SMTP id e124mr9026212qkc.314.1509292208577; Sun, 29 Oct 2017 08:50:08 -0700 (PDT) Received: from localhost.localdomain ([181.231.59.220]) by smtp.gmail.com with ESMTPSA id k7sm7926468qkf.45.2017.10.29.08.50.07 for (version=TLS1_2 cipher=ECDHE-RSA-AES128-SHA bits=128/128); Sun, 29 Oct 2017 08:50:08 -0700 (PDT) From: James Almer To: ffmpeg-devel@ffmpeg.org Date: Sun, 29 Oct 2017 12:49:44 -0300 Message-Id: <20171029154944.10000-1-jamrial@gmail.com> X-Mailer: git-send-email 2.14.2 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 reduces differences with libav. Signed-off-by: James Almer --- With this, existing users will get an extra incentive to migrate, and potential new users will not start using the old one by mistake. libavcodec/avcodec.h | 66 ++-------------------------------------------------- 1 file changed, 2 insertions(+), 64 deletions(-) diff --git a/libavcodec/avcodec.h b/libavcodec/avcodec.h index ee7834c8a2..5a65ed1067 100644 --- a/libavcodec/avcodec.h +++ b/libavcodec/avcodec.h @@ -5407,82 +5407,20 @@ 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 - */ 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. - */ 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 - */ 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. - */ attribute_deprecated const AVBitStreamFilter *av_bitstream_filter_next(const AVBitStreamFilter *f); #endif