avcodec/internal: Remove outdated documentation of ff_alloc_packet2()

Its documentation described the way user-supplied buffers worked
before 93016f5d1d.

Signed-off-by: Andreas Rheinhardt <andreas.rheinhardt@outlook.com>
pull/362/head
Andreas Rheinhardt 4 years ago
parent 7a57c5ab91
commit 4e5d2a819c
  1. 16
      libavcodec/internal.h

@ -229,20 +229,16 @@ void ff_color_frame(AVFrame *frame, const int color[4]);
#define FF_MAX_EXTRADATA_SIZE ((1 << 28) - AV_INPUT_BUFFER_PADDING_SIZE) #define FF_MAX_EXTRADATA_SIZE ((1 << 28) - AV_INPUT_BUFFER_PADDING_SIZE)
/** /**
* Check AVPacket size and/or allocate data. * Check AVPacket size and allocate data.
* *
* Encoders supporting AVCodec.encode2() can use this as a convenience to * Encoders supporting AVCodec.encode2() can use this as a convenience to
* ensure the output packet data is large enough, whether provided by the user * obtain a big enough buffer for the encoded bitstream.
* or allocated in this function.
* *
* @param avctx the AVCodecContext of the encoder * @param avctx the AVCodecContext of the encoder
* @param avpkt the AVPacket * @param avpkt The AVPacket: on success, avpkt->data will point to a buffer
* If avpkt->data is already set, avpkt->size is checked * of size at least `size`; the packet will not be refcounted.
* to ensure it is large enough. * This packet must be initially blank.
* If avpkt->data is NULL, a new buffer is allocated. * @param size an upper bound of the size of the packet to encode
* avpkt->size is set to the specified size.
* All other AVPacket fields will be reset with av_init_packet().
* @param size the minimum required packet size
* @param min_size This is a hint to the allocation algorithm, which indicates * @param min_size This is a hint to the allocation algorithm, which indicates
* to what minimal size the caller might later shrink the packet * to what minimal size the caller might later shrink the packet
* to. Encoders often allocate packets which are larger than the * to. Encoders often allocate packets which are larger than the

Loading…
Cancel
Save