avcodec/avcodec.h: remove doxy from the old bsf API functions

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.

Reviewed-by: Derek Buitenhuis <derek.buitenhuis@gmail.com>
Signed-off-by: James Almer <jamrial@gmail.com>
This commit is contained in:
James Almer 2017-10-29 12:42:18 -03:00
parent dbfc31b86e
commit 39e9a7a80f
1 changed files with 14 additions and 56 deletions

View File

@ -5407,81 +5407,39 @@ typedef struct AVBitStreamFilter {
#if FF_API_OLD_BSF #if FF_API_OLD_BSF
/** /**
* Register a bitstream filter. * @deprecated the old bitstream filtering API (using AVBitStreamFilterContext)
* * is deprecated. Use the new bitstream filtering API (using AVBSFContext).
* 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()
*/ */
attribute_deprecated attribute_deprecated
void av_register_bitstream_filter(AVBitStreamFilter *bsf); void av_register_bitstream_filter(AVBitStreamFilter *bsf);
/** /**
* Create and initialize a bitstream filter context given a bitstream * @deprecated the old bitstream filtering API (using AVBitStreamFilterContext)
* filter name. * is deprecated. Use av_bsf_get_by_name(), av_bsf_alloc(), and av_bsf_init()
* * from the new bitstream filtering API (using AVBSFContext).
* 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 attribute_deprecated
AVBitStreamFilterContext *av_bitstream_filter_init(const char *name); AVBitStreamFilterContext *av_bitstream_filter_init(const char *name);
/** /**
* Filter bitstream. * @deprecated the old bitstream filtering API (using AVBitStreamFilterContext)
* * is deprecated. Use av_bsf_send_packet() and av_bsf_receive_packet() from the
* This function filters the buffer buf with size buf_size, and places the * new bitstream filtering API (using AVBSFContext).
* 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 attribute_deprecated
int av_bitstream_filter_filter(AVBitStreamFilterContext *bsfc, int av_bitstream_filter_filter(AVBitStreamFilterContext *bsfc,
AVCodecContext *avctx, const char *args, AVCodecContext *avctx, const char *args,
uint8_t **poutbuf, int *poutbuf_size, uint8_t **poutbuf, int *poutbuf_size,
const uint8_t *buf, int buf_size, int keyframe); const uint8_t *buf, int buf_size, int keyframe);
/** /**
* Release bitstream filter context. * @deprecated the old bitstream filtering API (using AVBitStreamFilterContext)
* * is deprecated. Use av_bsf_free() from the new bitstream filtering API (using
* @param bsf the bitstream filter context created with * AVBSFContext).
* av_bitstream_filter_init(), can be NULL
*/ */
attribute_deprecated attribute_deprecated
void av_bitstream_filter_close(AVBitStreamFilterContext *bsf); void av_bitstream_filter_close(AVBitStreamFilterContext *bsf);
/** /**
* If f is NULL, return the first registered bitstream filter, * @deprecated the old bitstream filtering API (using AVBitStreamFilterContext)
* if f is non-NULL, return the next registered bitstream filter * is deprecated. Use av_bsf_next() from the new bitstream filtering API (using
* after f, or NULL if f is the last one. * AVBSFContext).
*
* This function can be used to iterate over all registered bitstream
* filters.
*/ */
attribute_deprecated attribute_deprecated
const AVBitStreamFilter *av_bitstream_filter_next(const AVBitStreamFilter *f); const AVBitStreamFilter *av_bitstream_filter_next(const AVBitStreamFilter *f);