Mercurial > libavcodec.hg
comparison avcodec.h @ 9825:37558edc9df2 libavcodec
clarify avcodec_decode_audio3 and avcodec_decode_video2 doxygen
author | bcoudurier |
---|---|
date | Sat, 06 Jun 2009 20:16:53 +0000 |
parents | 2887f410011f |
children | bca8ee90e5eb |
comparison
equal
deleted
inserted
replaced
9824:7679262f1459 | 9825:37558edc9df2 |
---|---|
3206 * no overreading happens for damaged MPEG streams. | 3206 * no overreading happens for damaged MPEG streams. |
3207 * | 3207 * |
3208 * @note You might have to align the input buffer avpkt->data and output buffer | 3208 * @note You might have to align the input buffer avpkt->data and output buffer |
3209 * samples. The alignment requirements depend on the CPU: On some CPUs it isn't | 3209 * samples. The alignment requirements depend on the CPU: On some CPUs it isn't |
3210 * necessary at all, on others it won't work at all if not aligned and on others | 3210 * necessary at all, on others it won't work at all if not aligned and on others |
3211 * it will work but it will have an impact on performance. In practice, the | 3211 * it will work but it will have an impact on performance. |
3212 * bitstream should have 4 byte alignment at minimum and all sample data should | 3212 * |
3213 * be 16 byte aligned unless the CPU doesn't need it (AltiVec and SSE do). If | 3213 * In practice, avpkt->data should have 4 byte alignment at minimum and |
3214 * the linesize is not a multiple of 16 then there's no sense in aligning the | 3214 * samples should be 16 byte aligned unless the CPU doesn't need it |
3215 * start of the buffer to 16. | 3215 * (AltiVec and SSE do). |
3216 * | 3216 * |
3217 * @param avctx the codec context | 3217 * @param avctx the codec context |
3218 * @param[out] samples the output buffer | 3218 * @param[out] samples the output buffer |
3219 * @param[in,out] frame_size_ptr the output buffer size in bytes | 3219 * @param[in,out] frame_size_ptr the output buffer size in bytes |
3220 * @param[in] avpkt The input AVPacket containing the input buffer. | 3220 * @param[in] avpkt The input AVPacket containing the input buffer. |
3257 * bits at once and could read over the end. | 3257 * bits at once and could read over the end. |
3258 * | 3258 * |
3259 * @warning The end of the input buffer buf should be set to 0 to ensure that | 3259 * @warning The end of the input buffer buf should be set to 0 to ensure that |
3260 * no overreading happens for damaged MPEG streams. | 3260 * no overreading happens for damaged MPEG streams. |
3261 * | 3261 * |
3262 * @note You might have to align the input buffer avpkt->data and output buffer | 3262 * @note You might have to align the input buffer avpkt->data. |
3263 * samples. The alignment requirements depend on the CPU: on some CPUs it isn't | 3263 * The alignment requirements depend on the CPU: on some CPUs it isn't |
3264 * necessary at all, on others it won't work at all if not aligned and on others | 3264 * necessary at all, on others it won't work at all if not aligned and on others |
3265 * it will work but it will have an impact on performance. In practice, the | 3265 * it will work but it will have an impact on performance. |
3266 * bitstream should have 4 byte alignment at minimum and all sample data should | 3266 * |
3267 * be 16 byte aligned unless the CPU doesn't need it (AltiVec and SSE do). If | 3267 * In practice, avpkt->data should have 4 byte alignment at minimum. |
3268 * the linesize is not a multiple of 16 then there's no sense in aligning the | |
3269 * start of the buffer to 16. | |
3270 * | 3268 * |
3271 * @note Some codecs have a delay between input and output, these need to be | 3269 * @note Some codecs have a delay between input and output, these need to be |
3272 * feeded with avpkt->data=NULL, avpkt->size=0 at the end to return the remaining frames. | 3270 * feeded with avpkt->data=NULL, avpkt->size=0 at the end to return the remaining frames. |
3273 * | 3271 * |
3274 * @param avctx the codec context | 3272 * @param avctx the codec context |