Kill unused E_FSTAT.

[paraslash.git] / mp3dec.c

diff --git a/mp3dec.c b/mp3dec.c
index 5c6bab3..1659941 100644 (file)
--- a/mp3dec.c
+++ b/mp3dec.c
@@ -4,7 +4,7 @@
  * Licensed under the GPL v2. For licencing details see COPYING.
  */
 
  * Licensed under the GPL v2. For licencing details see COPYING.
  */
 

-/** \file mp3dec.c paraslash's mp3 decoder */
+/** \file mp3dec.c Paraslash's mp3 decoder. */

 
 #include "para.h"
 #include "list.h"
 
 #include "para.h"
 #include "list.h"


@@ -14,25 +14,20 @@
 #include <mad.h>
 #include "string.h"
 
 #include <mad.h>
 #include "string.h"
 

-/** the output buffer size */
-#define MP3_OUTBUF_SIZE 128 * 1024
+/** The output buffer size. */
+#define MP3_OUTBUF_SIZE (128 * 1024)

 
 

-/** \cond a helper macro */
+/** Convert a sample value from libmad to a signed short. */

 #define MAD_TO_SHORT(f) (f) >= MAD_F_ONE? SHRT_MAX :\
        (f) <= -MAD_F_ONE? -SHRT_MAX : (signed short) ((f) >> (MAD_F_FRACBITS - 15))
 #define MAD_TO_SHORT(f) (f) >= MAD_F_ONE? SHRT_MAX :\
        (f) <= -MAD_F_ONE? -SHRT_MAX : (signed short) ((f) >> (MAD_F_FRACBITS - 15))

-/** \endcond */

 
 

-/**
- * data specific to the mp3dec filter
- *
- * \sa filter, filter_node
- */
+/** Data specific to the mp3dec filter. */

 struct private_mp3dec_data {
 struct private_mp3dec_data {

-       /** information on the current mp3 stream */
+       /** Information on the current mp3 stream. */

        struct mad_stream stream;
        struct mad_stream stream;

-       /** information about the frame which is currently decoded */
+       /** Information about the frame which is currently decoded. */

        struct mad_frame frame;
        struct mad_frame frame;

-       /** contains the PCM output */
+       /** Contains the PCM output. */

        struct mad_synth synth;
 };
 
        struct mad_synth synth;
 };
 


@@ -115,11 +110,11 @@ static void mp3dec_open(struct filter_node *fn)
 }
 
 /**
 }
 
 /**

- * the init function of the mp3dec filter
+ * The init function of the mp3dec filter.

  *
  *

- * \param f pointer to the filter struct to initialize
+ * \param f Pointer to the filter struct to initialize.

  *
  *

- * \sa filter::init
+ * \sa filter::init.

  */
 void mp3dec_init(struct filter *f)
 {
  */
 void mp3dec_init(struct filter *f)
 {