summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMax Kellermann <max@duempel.org>2014-12-19 06:41:50 +0100
committerMax Kellermann <max@duempel.org>2016-07-28 19:45:05 +0200
commit087a9938d2dc84573d9efd9f92ec7ef88661c5ff (patch)
treea07d6d6ea9f50e673bf2cbcf06a797bbb105c346
parent26d8e41a6b0602a290c49a9bcac4517f9a1c7512 (diff)
decoder/ffmpeg: add API documentation
-rw-r--r--src/decoder/plugins/FfmpegDecoderPlugin.cxx5
1 files changed, 4 insertions, 1 deletions
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<void>
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