From 087a9938d2dc84573d9efd9f92ec7ef88661c5ff Mon Sep 17 00:00:00 2001 From: Max Kellermann Date: Fri, 19 Dec 2014 06:41:50 +0100 Subject: [PATCH] decoder/ffmpeg: add API documentation --- src/decoder/plugins/FfmpegDecoderPlugin.cxx | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/src/decoder/plugins/FfmpegDecoderPlugin.cxx b/src/decoder/plugins/FfmpegDecoderPlugin.cxx index 41dfbb8a8..70534f218 100644 --- a/src/decoder/plugins/FfmpegDecoderPlugin.cxx +++ b/src/decoder/plugins/FfmpegDecoderPlugin.cxx @@ -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 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 * is used after seeking to skip data in an AVPacket until the exact * desired time stamp has been reached