rtpdec: Improve some comments
authorMartin Storsjö <martin@martin.st>
Tue, 11 Dec 2012 17:57:18 +0000 (19:57 +0200)
committerMartin Storsjö <martin@martin.st>
Wed, 12 Dec 2012 10:18:28 +0000 (12:18 +0200)
The previous comment about the buffer was wildly inaccurate and
misleading.

Signed-off-by: Martin Storsjö <martin@martin.st>
libavformat/rtpdec.h

index f643fa2..4a920a9 100644 (file)
@@ -94,7 +94,8 @@ typedef struct RTPStatistics {
  * @param s stream context
  * @param st stream that this packet belongs to
  * @param pkt packet in which to write the parsed data
- * @param timestamp pointer in which to write the timestamp of this RTP packet
+ * @param timestamp pointer to the RTP timestamp of the input data, can be
+ *                  updated by the function if returning older, buffered data
  * @param buf pointer to raw RTP packet data
  * @param len length of buf
  * @param flags flags from the RTP packet header (RTP_FLAG_*)
@@ -176,7 +177,7 @@ struct RTPDemuxContext {
     unsigned int packet_count;     // TODO: move into statistics (outgoing)
     unsigned int octet_count;      // TODO: move into statistics (outgoing)
     unsigned int last_octet_count; // TODO: move into statistics (outgoing)
-    /* buffer for output */
+    /* buffer for partially parsed packets */
     uint8_t buf[RTP_MAX_PACKET_LENGTH];
 
     /* dynamic payload stuff */