From patchwork Mon Feb 1 22:44:21 2021 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: James Almer X-Patchwork-Id: 25335 Return-Path: X-Original-To: patchwork@ffaux-bg.ffmpeg.org Delivered-To: patchwork@ffaux-bg.ffmpeg.org Received: from ffbox0-bg.mplayerhq.hu (ffbox0-bg.ffmpeg.org [79.124.17.100]) by ffaux.localdomain (Postfix) with ESMTP id AA34C448D78 for ; Tue, 2 Feb 2021 00:50:34 +0200 (EET) Received: from [127.0.1.1] (localhost [127.0.0.1]) by ffbox0-bg.mplayerhq.hu (Postfix) with ESMTP id 7F3EE689D3A; Tue, 2 Feb 2021 00:50:34 +0200 (EET) X-Original-To: ffmpeg-devel@ffmpeg.org Delivered-To: ffmpeg-devel@ffmpeg.org Received: from mail-pf1-f179.google.com (mail-pf1-f179.google.com [209.85.210.179]) by ffbox0-bg.mplayerhq.hu (Postfix) with ESMTPS id 73B64689D16 for ; Tue, 2 Feb 2021 00:50:27 +0200 (EET) Received: by mail-pf1-f179.google.com with SMTP id e19so12690797pfh.6 for ; Mon, 01 Feb 2021 14:50:27 -0800 (PST) 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:mime-version :content-transfer-encoding; bh=fATUaLklzIkw85NtI7zJsq5wtbGrdtute5PmYRwnAcM=; b=XXm2rHyCddtUdWzg6ko1Em+ZigCPfVFcY5PPyh4DyhXWmIMJepFAw7vjhGZ+LhrODA cL/lFPZoLyvvxrSnyV+gbBrhORXaQR4i9sYsFBhnj7Ww4RV4ZiYeszsxYz4MGdtN6Vz0 YTU84pNu32iJUy+6C1bgExD0ygO+ojWlTWQ5aHZB8JrEovp3/ecLwfMkaelWzOQLaO8h bB1Zh+vyctpRHRWsTLF5X1AEfCdzTheJoFroSII9RNbtBjlLz1PAFG3YisutC3uCIF8H x718ZcySuHalih/CpkRZF3TTYm40v+KTIwWltSVJ3pLXpru2HIng9CEM/VPI7kb/x6+0 gpWg== 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:mime-version:content-transfer-encoding; bh=fATUaLklzIkw85NtI7zJsq5wtbGrdtute5PmYRwnAcM=; b=hAHzzieVTAn/TyEGvA35TxHtq1nLzF+XAqMR7I3o04Uz4bV8QGajFTxVoE8QqTXnJn ttXvcxgUS0Gusj4C9kyiqSi+oWjzKPI3JtN5LvHiMBGywzL64fsaxdZDj/KdkHdkc1yv sNYocm/havun7tzdy21590FFTJuiueQQ9NOKyfc9OcSnoSRnEkb3LdxUyxBv74lPRAI3 ncxEGXzayQeQj4mp6ZKXIFXIxJ1NMHtrrJPgp/34YtkD1oFYC6/aGkBRNz33hD1OdGQP FA/j4emJUiA8IV8MSl28Pa5MpEIhqdGqjqK9q/P/N2heW6jdJAJPbAv4K7bm8hIjyJ+P 50Aw== X-Gm-Message-State: AOAM530f0tHKZUyshfKcjHFkOWE++s0B15L4XYXoVEY6V4RnvCmAH+BR BSrm9TxFs6JksQOYmzQLj+KGl8AecgnHpw== X-Google-Smtp-Source: ABdhPJxRH0pnOXjL0SNTYWOW0RBP0bw5u/5O0pu4HwzhtCOUjx3hOlyUs1imIJRydLuXG7an8LwmnA== X-Received: by 2002:a0c:e109:: with SMTP id w9mr17124455qvk.57.1612219498953; Mon, 01 Feb 2021 14:44:58 -0800 (PST) Received: from localhost.localdomain ([181.23.89.132]) by smtp.gmail.com with ESMTPSA id e1sm15812720qkd.135.2021.02.01.14.44.57 for (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Mon, 01 Feb 2021 14:44:58 -0800 (PST) From: James Almer To: ffmpeg-devel@ffmpeg.org Date: Mon, 1 Feb 2021 19:44:21 -0300 Message-Id: <20210201224421.1395-11-jamrial@gmail.com> X-Mailer: git-send-email 2.30.0 In-Reply-To: <20210201224421.1395-1-jamrial@gmail.com> References: <20210201224421.1395-1-jamrial@gmail.com> MIME-Version: 1.0 Subject: [FFmpeg-devel] [PATCH 10/10] avcodec/packet: deprecate av_init_packet() 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 Errors-To: ffmpeg-devel-bounces@ffmpeg.org Sender: "ffmpeg-devel" Once removed, sizeof(AVPacket) will stop being a part of the public ABI. Signed-off-by: James Almer --- libavcodec/avpacket.c | 23 +++++++++++++++-------- libavcodec/packet.h | 23 +++++++++++++++++++---- libavcodec/version.h | 3 +++ libavformat/avformat.h | 4 ++++ 4 files changed, 41 insertions(+), 12 deletions(-) diff --git a/libavcodec/avpacket.c b/libavcodec/avpacket.c index e4ba403cf6..ae0cbfb9f9 100644 --- a/libavcodec/avpacket.c +++ b/libavcodec/avpacket.c @@ -32,6 +32,7 @@ #include "packet.h" #include "packet_internal.h" +#if FF_API_INIT_PACKET void av_init_packet(AVPacket *pkt) { pkt->pts = AV_NOPTS_VALUE; @@ -49,6 +50,16 @@ FF_ENABLE_DEPRECATION_WARNINGS pkt->side_data = NULL; pkt->side_data_elems = 0; } +#endif + +static void get_packet_defaults(AVPacket *pkt) +{ + memset(pkt, 0, sizeof(*pkt)); + + pkt->pts = AV_NOPTS_VALUE; + pkt->dts = AV_NOPTS_VALUE; + pkt->pos = -1; +} AVPacket *av_packet_alloc(void) { @@ -56,7 +67,7 @@ AVPacket *av_packet_alloc(void) if (!pkt) return pkt; - av_init_packet(pkt); + get_packet_defaults(pkt); return pkt; } @@ -92,7 +103,7 @@ int av_new_packet(AVPacket *pkt, int size) if (ret < 0) return ret; - av_init_packet(pkt); + get_packet_defaults(pkt); pkt->buf = buf; pkt->data = buf->data; pkt->size = size; @@ -607,9 +618,7 @@ void av_packet_unref(AVPacket *pkt) { av_packet_free_side_data(pkt); av_buffer_unref(&pkt->buf); - av_init_packet(pkt); - pkt->data = NULL; - pkt->size = 0; + get_packet_defaults(pkt); } int av_packet_ref(AVPacket *dst, const AVPacket *src) @@ -664,9 +673,7 @@ AVPacket *av_packet_clone(const AVPacket *src) void av_packet_move_ref(AVPacket *dst, AVPacket *src) { *dst = *src; - av_init_packet(src); - src->data = NULL; - src->size = 0; + get_packet_defaults(src); } int av_packet_make_refcounted(AVPacket *pkt) diff --git a/libavcodec/packet.h b/libavcodec/packet.h index b9d4c9c2c8..c442b6a6eb 100644 --- a/libavcodec/packet.h +++ b/libavcodec/packet.h @@ -319,10 +319,6 @@ typedef struct AVPacketSideData { * packets, with no compressed data, containing only side data * (e.g. to update some stream parameters at the end of encoding). * - * AVPacket is one of the few structs in FFmpeg, whose size is a part of public - * ABI. Thus it may be allocated on stack and no new fields can be added to it - * without libavcodec and libavformat major bump. - * * The semantics of data ownership depends on the buf field. * If it is set, the packet data is dynamically allocated and is * valid indefinitely until a call to av_packet_unref() reduces the @@ -334,6 +330,12 @@ typedef struct AVPacketSideData { * The side data is always allocated with av_malloc(), copied by * av_packet_ref() and freed by av_packet_unref(). * + * sizeof(AVPacket) being a part of the public ABI is deprecated. once + * av_init_packet() is removed, new packets will only be able to be allocated + * with av_packet_alloc(), and new fields may be added to the end of the struct + * with a minor bump. + * + * @see av_packet_alloc * @see av_packet_ref * @see av_packet_unref */ @@ -394,7 +396,11 @@ typedef struct AVPacket { } AVPacket; typedef struct AVPacketList { +#if FF_API_INIT_PACKET AVPacket pkt; +#else + AVPacket *pkt; +#endif struct AVPacketList *next; } AVPacketList; @@ -460,6 +466,7 @@ AVPacket *av_packet_clone(const AVPacket *src); */ void av_packet_free(AVPacket **pkt); +#if FF_API_INIT_PACKET /** * Initialize optional fields of a packet with default values. * @@ -467,8 +474,16 @@ void av_packet_free(AVPacket **pkt); * initialized separately. * * @param pkt packet + * + * @see av_packet_alloc + * @see av_packet_unref + * + * @deprecated This function is deprecated. Once it's removed, + sizeof(AVPacket) will not be a part of the ABI anymore. */ +attribute_deprecated void av_init_packet(AVPacket *pkt); +#endif /** * Allocate the payload of a packet and initialize its fields with diff --git a/libavcodec/version.h b/libavcodec/version.h index 1e1bedfce6..af8487a4c1 100644 --- a/libavcodec/version.h +++ b/libavcodec/version.h @@ -153,5 +153,8 @@ #ifndef FF_API_DEBUG_MV #define FF_API_DEBUG_MV (LIBAVCODEC_VERSION_MAJOR < 60) #endif +#ifndef FF_API_INIT_PACKET +#define FF_API_INIT_PACKET (LIBAVCODEC_VERSION_MAJOR < 60) +#endif #endif /* AVCODEC_VERSION_H */ diff --git a/libavformat/avformat.h b/libavformat/avformat.h index 523cf34d55..d2d31e1deb 100644 --- a/libavformat/avformat.h +++ b/libavformat/avformat.h @@ -950,7 +950,11 @@ typedef struct AVStream { * decoding: set by libavformat, must not be modified by the caller. * encoding: unused */ +#if FF_API_INIT_PACKET AVPacket attached_pic; +#else + AVPacket *attached_pic; +#endif /** * An array of side data that applies to the whole stream (i.e. the