comparison avcodec.h @ 9578:14b9819158a8 libavcodec

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.
author vitor
date Mon, 27 Apr 2009 18:35:54 +0000
parents cb2eaa883d4f
children e30999f7a631
comparison
equal deleted inserted replaced
9577:0b4ee8aa4c11 9578:14b9819158a8
1119 #define FF_RC_STRATEGY_XVID 1 1119 #define FF_RC_STRATEGY_XVID 1
1120 1120
1121 int b_frame_strategy; 1121 int b_frame_strategy;
1122 1122
1123 /** 1123 /**
1124 * hurry up amount
1125 * - encoding: unused
1126 * - decoding: Set by user. 1-> Skip B-frames, 2-> Skip IDCT/dequant too, 5-> Skip everything except header
1124 * @deprecated Deprecated in favor of skip_idct and skip_frame. 1127 * @deprecated Deprecated in favor of skip_idct and skip_frame.
1125 */ 1128 */
1126 int hurry_up; 1129 int hurry_up;
1127 1130
1128 struct AVCodec *codec; 1131 struct AVCodec *codec;
2323 */ 2326 */
2324 int64_t timecode_frame_start; 2327 int64_t timecode_frame_start;
2325 2328
2326 #if LIBAVCODEC_VERSION_MAJOR < 53 2329 #if LIBAVCODEC_VERSION_MAJOR < 53
2327 /** 2330 /**
2331 * Decoder should decode to this many channels if it can (0 for default)
2332 * - encoding: unused
2333 * - decoding: Set by user.
2328 * @deprecated Deprecated in favor of request_channel_layout. 2334 * @deprecated Deprecated in favor of request_channel_layout.
2329 */ 2335 */
2330 int request_channels; 2336 int request_channels;
2331 #endif 2337 #endif
2332 2338
2551 int linesize[4]; ///< number of bytes per line 2557 int linesize[4]; ///< number of bytes per line
2552 } AVPicture; 2558 } AVPicture;
2553 2559
2554 #if LIBAVCODEC_VERSION_MAJOR < 53 2560 #if LIBAVCODEC_VERSION_MAJOR < 53
2555 /** 2561 /**
2562 * AVPaletteControl
2563 * This structure defines a method for communicating palette changes
2564 * between and demuxer and a decoder.
2565 *
2556 * @deprecated Use AVPacket to send palette changes instead. 2566 * @deprecated Use AVPacket to send palette changes instead.
2567 * This is totally broken.
2557 */ 2568 */
2558 #define AVPALETTE_SIZE 1024 2569 #define AVPALETTE_SIZE 1024
2559 #define AVPALETTE_COUNT 256 2570 #define AVPALETTE_COUNT 256
2560 typedef struct AVPaletteControl { 2571 typedef struct AVPaletteControl {
2561 2572
3068 */ 3079 */
3069 int avcodec_open(AVCodecContext *avctx, AVCodec *codec); 3080 int avcodec_open(AVCodecContext *avctx, AVCodec *codec);
3070 3081
3071 #if LIBAVCODEC_VERSION_MAJOR < 53 3082 #if LIBAVCODEC_VERSION_MAJOR < 53
3072 /** 3083 /**
3084 * Decodes an audio frame from \p buf into \p samples.
3085 * Wrapper function which calls avcodec_decode_audio3.
3086 *
3073 * @deprecated Use avcodec_decode_audio3 instead. 3087 * @deprecated Use avcodec_decode_audio3 instead.
3088 * @param avctx the codec context
3089 * @param[out] samples the output buffer
3090 * @param[in,out] frame_size_ptr the output buffer size in bytes
3091 * @param[in] buf the input buffer
3092 * @param[in] buf_size the input buffer size in bytes
3093 * @return On error a negative value is returned, otherwise the number of bytes
3094 * used or zero if no frame could be decompressed.
3074 */ 3095 */
3075 attribute_deprecated int avcodec_decode_audio2(AVCodecContext *avctx, int16_t *samples, 3096 attribute_deprecated int avcodec_decode_audio2(AVCodecContext *avctx, int16_t *samples,
3076 int *frame_size_ptr, 3097 int *frame_size_ptr,
3077 const uint8_t *buf, int buf_size); 3098 const uint8_t *buf, int buf_size);
3078 #endif 3099 #endif
3115 int *frame_size_ptr, 3136 int *frame_size_ptr,
3116 AVPacket *avpkt); 3137 AVPacket *avpkt);
3117 3138
3118 #if LIBAVCODEC_VERSION_MAJOR < 53 3139 #if LIBAVCODEC_VERSION_MAJOR < 53
3119 /** 3140 /**
3141 * Decodes a video frame from \p buf into \p picture.
3142 * Wrapper function which calls avcodec_decode_video2.
3143 *
3120 * @deprecated Use avcodec_decode_video2 instead. 3144 * @deprecated Use avcodec_decode_video2 instead.
3145 * @param avctx the codec context
3146 * @param[out] picture The AVFrame in which the decoded video frame will be stored.
3147 * @param[in] buf the input buffer
3148 * @param[in] buf_size the size of the input buffer in bytes
3149 * @param[in,out] got_picture_ptr Zero if no frame could be decompressed, otherwise, it is nonzero.
3150 * @return On error a negative value is returned, otherwise the number of bytes
3151 * used or zero if no frame could be decompressed.
3121 */ 3152 */
3122 attribute_deprecated int avcodec_decode_video(AVCodecContext *avctx, AVFrame *picture, 3153 attribute_deprecated int avcodec_decode_video(AVCodecContext *avctx, AVFrame *picture,
3123 int *got_picture_ptr, 3154 int *got_picture_ptr,
3124 const uint8_t *buf, int buf_size); 3155 const uint8_t *buf, int buf_size);
3125 #endif 3156 #endif