Browse code

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>

James Almer authored on 2017/10/30 00:42:18
Showing 1 changed files
... ...
@@ -5407,81 +5407,39 @@ typedef struct AVBitStreamFilter {
5407 5407
 
5408 5408
 #if FF_API_OLD_BSF
5409 5409
 /**
5410
- * Register a bitstream filter.
5411
- *
5412
- * The filter will be accessible to the application code through
5413
- * av_bitstream_filter_next() or can be directly initialized with
5414
- * av_bitstream_filter_init().
5415
- *
5416
- * @see avcodec_register_all()
5410
+ * @deprecated the old bitstream filtering API (using AVBitStreamFilterContext)
5411
+ * is deprecated. Use the new bitstream filtering API (using AVBSFContext).
5417 5412
  */
5418 5413
 attribute_deprecated
5419 5414
 void av_register_bitstream_filter(AVBitStreamFilter *bsf);
5420
-
5421 5415
 /**
5422
- * Create and initialize a bitstream filter context given a bitstream
5423
- * filter name.
5424
- *
5425
- * The returned context must be freed with av_bitstream_filter_close().
5426
- *
5427
- * @param name    the name of the bitstream filter
5428
- * @return a bitstream filter context if a matching filter was found
5429
- * and successfully initialized, NULL otherwise
5416
+ * @deprecated the old bitstream filtering API (using AVBitStreamFilterContext)
5417
+ * is deprecated. Use av_bsf_get_by_name(), av_bsf_alloc(), and av_bsf_init()
5418
+ * from the new bitstream filtering API (using AVBSFContext).
5430 5419
  */
5431 5420
 attribute_deprecated
5432 5421
 AVBitStreamFilterContext *av_bitstream_filter_init(const char *name);
5433
-
5434 5422
 /**
5435
- * Filter bitstream.
5436
- *
5437
- * This function filters the buffer buf with size buf_size, and places the
5438
- * filtered buffer in the buffer pointed to by poutbuf.
5439
- *
5440
- * The output buffer must be freed by the caller.
5441
- *
5442
- * @param bsfc            bitstream filter context created by av_bitstream_filter_init()
5443
- * @param avctx           AVCodecContext accessed by the filter, may be NULL.
5444
- *                        If specified, this must point to the encoder context of the
5445
- *                        output stream the packet is sent to.
5446
- * @param args            arguments which specify the filter configuration, may be NULL
5447
- * @param poutbuf         pointer which is updated to point to the filtered buffer
5448
- * @param poutbuf_size    pointer which is updated to the filtered buffer size in bytes
5449
- * @param buf             buffer containing the data to filter
5450
- * @param buf_size        size in bytes of buf
5451
- * @param keyframe        set to non-zero if the buffer to filter corresponds to a key-frame packet data
5452
- * @return >= 0 in case of success, or a negative error code in case of failure
5453
- *
5454
- * If the return value is positive, an output buffer is allocated and
5455
- * is available in *poutbuf, and is distinct from the input buffer.
5456
- *
5457
- * If the return value is 0, the output buffer is not allocated and
5458
- * should be considered identical to the input buffer, or in case
5459
- * *poutbuf was set it points to the input buffer (not necessarily to
5460
- * its starting address). A special case is if *poutbuf was set to NULL and
5461
- * *poutbuf_size was set to 0, which indicates the packet should be dropped.
5423
+ * @deprecated the old bitstream filtering API (using AVBitStreamFilterContext)
5424
+ * is deprecated. Use av_bsf_send_packet() and av_bsf_receive_packet() from the
5425
+ * new bitstream filtering API (using AVBSFContext).
5462 5426
  */
5463 5427
 attribute_deprecated
5464 5428
 int av_bitstream_filter_filter(AVBitStreamFilterContext *bsfc,
5465 5429
                                AVCodecContext *avctx, const char *args,
5466 5430
                                uint8_t **poutbuf, int *poutbuf_size,
5467 5431
                                const uint8_t *buf, int buf_size, int keyframe);
5468
-
5469 5432
 /**
5470
- * Release bitstream filter context.
5471
- *
5472
- * @param bsf the bitstream filter context created with
5473
- * av_bitstream_filter_init(), can be NULL
5433
+ * @deprecated the old bitstream filtering API (using AVBitStreamFilterContext)
5434
+ * is deprecated. Use av_bsf_free() from the new bitstream filtering API (using
5435
+ * AVBSFContext).
5474 5436
  */
5475 5437
 attribute_deprecated
5476 5438
 void av_bitstream_filter_close(AVBitStreamFilterContext *bsf);
5477
-
5478 5439
 /**
5479
- * If f is NULL, return the first registered bitstream filter,
5480
- * if f is non-NULL, return the next registered bitstream filter
5481
- * after f, or NULL if f is the last one.
5482
- *
5483
- * This function can be used to iterate over all registered bitstream
5484
- * filters.
5440
+ * @deprecated the old bitstream filtering API (using AVBitStreamFilterContext)
5441
+ * is deprecated. Use av_bsf_next() from the new bitstream filtering API (using
5442
+ * AVBSFContext).
5485 5443
  */
5486 5444
 attribute_deprecated
5487 5445
 const AVBitStreamFilter *av_bitstream_filter_next(const AVBitStreamFilter *f);