Commit 85947156 authored by Vitor Sessak's avatar Vitor Sessak
Browse files

Revert r18700, documentation of deprecated functions might be useful for

people trying to update to the new API.

Log of r18700:
Remove documentation from deprecated fields, they should not be used,
thus there is no sense in documenting them.

Originally committed as revision 18708 to svn://svn.ffmpeg.org/ffmpeg/trunk
parent 6cf92f6d
...@@ -1121,6 +1121,9 @@ typedef struct AVCodecContext { ...@@ -1121,6 +1121,9 @@ typedef struct AVCodecContext {
int b_frame_strategy; int b_frame_strategy;
/** /**
* hurry up amount
* - encoding: unused
* - decoding: Set by user. 1-> Skip B-frames, 2-> Skip IDCT/dequant too, 5-> Skip everything except header
* @deprecated Deprecated in favor of skip_idct and skip_frame. * @deprecated Deprecated in favor of skip_idct and skip_frame.
*/ */
int hurry_up; int hurry_up;
...@@ -2325,6 +2328,9 @@ typedef struct AVCodecContext { ...@@ -2325,6 +2328,9 @@ typedef struct AVCodecContext {
#if LIBAVCODEC_VERSION_MAJOR < 53 #if LIBAVCODEC_VERSION_MAJOR < 53
/** /**
* Decoder should decode to this many channels if it can (0 for default)
* - encoding: unused
* - decoding: Set by user.
* @deprecated Deprecated in favor of request_channel_layout. * @deprecated Deprecated in favor of request_channel_layout.
*/ */
int request_channels; int request_channels;
...@@ -2553,7 +2559,12 @@ typedef struct AVPicture { ...@@ -2553,7 +2559,12 @@ typedef struct AVPicture {
#if LIBAVCODEC_VERSION_MAJOR < 53 #if LIBAVCODEC_VERSION_MAJOR < 53
/** /**
* AVPaletteControl
* This structure defines a method for communicating palette changes
* between and demuxer and a decoder.
*
* @deprecated Use AVPacket to send palette changes instead. * @deprecated Use AVPacket to send palette changes instead.
* This is totally broken.
*/ */
#define AVPALETTE_SIZE 1024 #define AVPALETTE_SIZE 1024
#define AVPALETTE_COUNT 256 #define AVPALETTE_COUNT 256
...@@ -3070,7 +3081,17 @@ int avcodec_open(AVCodecContext *avctx, AVCodec *codec); ...@@ -3070,7 +3081,17 @@ int avcodec_open(AVCodecContext *avctx, AVCodec *codec);
#if LIBAVCODEC_VERSION_MAJOR < 53 #if LIBAVCODEC_VERSION_MAJOR < 53
/** /**
* Decodes an audio frame from \p buf into \p samples.
* Wrapper function which calls avcodec_decode_audio3.
*
* @deprecated Use avcodec_decode_audio3 instead. * @deprecated Use avcodec_decode_audio3 instead.
* @param avctx the codec context
* @param[out] samples the output buffer
* @param[in,out] frame_size_ptr the output buffer size in bytes
* @param[in] buf the input buffer
* @param[in] buf_size the input buffer size in bytes
* @return On error a negative value is returned, otherwise the number of bytes
* used or zero if no frame could be decompressed.
*/ */
attribute_deprecated int avcodec_decode_audio2(AVCodecContext *avctx, int16_t *samples, attribute_deprecated int avcodec_decode_audio2(AVCodecContext *avctx, int16_t *samples,
int *frame_size_ptr, int *frame_size_ptr,
...@@ -3117,7 +3138,17 @@ int avcodec_decode_audio3(AVCodecContext *avctx, int16_t *samples, ...@@ -3117,7 +3138,17 @@ int avcodec_decode_audio3(AVCodecContext *avctx, int16_t *samples,
#if LIBAVCODEC_VERSION_MAJOR < 53 #if LIBAVCODEC_VERSION_MAJOR < 53
/** /**
* Decodes a video frame from \p buf into \p picture.
* Wrapper function which calls avcodec_decode_video2.
*
* @deprecated Use avcodec_decode_video2 instead. * @deprecated Use avcodec_decode_video2 instead.
* @param avctx the codec context
* @param[out] picture The AVFrame in which the decoded video frame will be stored.
* @param[in] buf the input buffer
* @param[in] buf_size the size of the input buffer in bytes
* @param[in,out] got_picture_ptr Zero if no frame could be decompressed, otherwise, it is nonzero.
* @return On error a negative value is returned, otherwise the number of bytes
* used or zero if no frame could be decompressed.
*/ */
attribute_deprecated int avcodec_decode_video(AVCodecContext *avctx, AVFrame *picture, attribute_deprecated int avcodec_decode_video(AVCodecContext *avctx, AVFrame *picture,
int *got_picture_ptr, int *got_picture_ptr,
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment