ffplay: extend doxy for audio_decode_frame()
authorStefano Sabatini <stefasab@gmail.com>
Thu, 28 Jun 2012 21:46:20 +0000 (23:46 +0200)
committerStefano Sabatini <stefasab@gmail.com>
Sat, 2 Feb 2013 14:32:34 +0000 (15:32 +0100)
ffplay.c

index 93090ad..0f7b984 100644 (file)
--- a/ffplay.c
+++ b/ffplay.c
@@ -2066,7 +2066,13 @@ static int synchronize_audio(VideoState *is, int nb_samples)
     return wanted_nb_samples;
 }
 
-/* decode one audio frame and returns its uncompressed size */
+/**
+ * Decode one audio frame and return its uncompressed size.
+ *
+ * The processed audio frame is decoded, converted if required, and
+ * stored in is->audio_buf, with size in bytes given by the return
+ * value.
+ */
 static int audio_decode_frame(VideoState *is, double *pts_ptr)
 {
     AVPacket *pkt_temp = &is->audio_pkt_temp;