Diff: rtpbuf.h

Revision:

69:65665afbad5d

Parent:

60:b4ec6beb3be3

Child:

74:81c47fff88a5

--- a/rtpbuf.h	Fri Nov 07 17:57:55 2014 +0000
+++ b/rtpbuf.h	Wed Nov 12 13:25:54 2014 +0000
@@ -1,12 +1,21 @@
+/**
+ * @file rtpbuf.h
+ * @Synopsis Implementa funcionalidades de conversão entre u-law e a-law
+ * @author Jhonatan Casale / PedroZN 
+ * @version 1
+ * @date 2014-11-05
+ * \note IMPORTANT: sizes must be multiple of 4 
+ */
 #ifndef _RTPBUF_H
 #define _RTPBUF_H
 
 #include <stdint.h>
 #include "debug.h"
 
-/* IMPORTANT: sizes must be multiple of 4 */
-#define RTPBUF_PKGSIZE 240 /* 30ms @ 8Ksamples/sec */
-#define RTPBUF_BUFSIZE 320 /* 40ms @ 8Ksamples/sec */
+#define RTPBUF_PKGSIZE 240 
+///< 30ms @ 8Ksamples/sec
+#define RTPBUF_BUFSIZE 320 
+///< 40ms @ 8Ksamples/sec
 
 #if (RTPBUF_PKGSIZE & 0x03)
 # error OPS... value forbidden
@@ -17,23 +26,30 @@
 
 struct rtpbuf {
   uint32_t b[ RTPBUF_BUFSIZE>>2 ];
-  int size;
+    ///< A fila de audio.
+  int size; 
+    ///< Representa o tamanho da fila.
 };
 typedef struct rtpbuf rtpbuf_t;
 
-/* clear the buffer, useful at the start of a new phone call */
+/** clear the buffer, useful at the start of a new phone call 
+ */
 void rtpbuf_clear (rtpbuf_t * self);
 
-/* use this function to put audio into the fifo */
+/** use this function to put audio into the fifo
+ */
 void rtpbuf_put (rtpbuf_t * self, int size, uint8_t * data);
 
-/* use this function to check if there is audio available
+/** use this function to check if there is audio available
  * returns NULL if there is no audio available
- * or returns a pointer to the audio package */
+ * or returns a pointer to the audio package 
+ */
 uint8_t * rtpbuf_get (rtpbuf_t * self);
 
-/* use this function to tell rtpbuf that you already consumed
- * the data supplied by rtpbuf_get() */
+/** 
+ * use this function to tell rtpbuf that you already consumed
+ * the data supplied by rtpbuf_get() 
+ */
 void rtpbuf_next (rtpbuf_t * self);
 
 #endif
\ No newline at end of file