decoder/ffmpeg: add API documentation

This commit is contained in:
Max Kellermann 2014-12-19 06:41:50 +01:00
parent 26d8e41a6b
commit 087a9938d2

View File

@ -278,7 +278,7 @@ copy_interleave_frame2(uint8_t *dest, uint8_t **src,
} }
/** /**
* Copy PCM data from a AVFrame to an interleaved buffer. * Copy PCM data from a non-empty AVFrame to an interleaved buffer.
*/ */
static ConstBuffer<void> static ConstBuffer<void>
copy_interleave_frame(const AVCodecContext &codec_context, copy_interleave_frame(const AVCodecContext &codec_context,
@ -351,6 +351,9 @@ PtsToPcmFrame(uint64_t pts, const AVStream &stream,
} }
/** /**
* Decode an #AVPacket and send the resulting PCM data to the decoder
* API.
*
* @param min_frame skip all data before this PCM frame number; this * @param min_frame skip all data before this PCM frame number; this
* is used after seeking to skip data in an AVPacket until the exact * is used after seeking to skip data in an AVPacket until the exact
* desired time stamp has been reached * desired time stamp has been reached