Fix link to gitweb on the main page.
[paraslash.git] / mp3dec.c
index 93181ef1421c75879b26156f5ecdbb8103b71f3e..16599411820313eae492a604fb58d09b1221b752 100644 (file)
--- a/mp3dec.c
+++ b/mp3dec.c
@@ -1,22 +1,10 @@
 /*
- * Copyright (C) 2005-2006 Andre Noll <maan@systemlinux.org>
+ * Copyright (C) 2005-2007 Andre Noll <maan@systemlinux.org>
  *
- *     This program is free software; you can redistribute it and/or modify
- *     it under the terms of the GNU General Public License as published by
- *     the Free Software Foundation; either version 2 of the License, or
- *     (at your option) any later version.
- *
- *     This program is distributed in the hope that it will be useful,
- *     but WITHOUT ANY WARRANTY; without even the implied warranty of
- *     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
- *     GNU General Public License for more details.
- *
- *     You should have received a copy of the GNU General Public License
- *     along with this program; if not, write to the Free Software
- *     Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111, USA.
+ * 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 <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))
-/** \endcond */
 
-/**
- * data specific to the mp3dec filter
- *
- * \sa filter, filter_node
- */
+/** Data specific to the mp3dec filter. */
 struct private_mp3dec_data {
-       /** information on the current mp3 stream */
+       /** Information on the current mp3 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;
-       /** contains the PCM output */
+       /** Contains the PCM output. */
        struct mad_synth synth;
 };
 
@@ -74,14 +57,13 @@ next_frame:
        mad_synth_frame(&pmd->synth, &pmd->frame);
 
        for (i = 0; i < pmd->synth.pcm.length; i++) {
-               /* output format: unsigned 16 bit little endian */
-               signed short s = MAD_TO_SHORT(pmd->synth.pcm.samples[0][i]);
-               fn->buf[fn->loaded++] = s & 0xff;
-               fn->buf[fn->loaded++] = s >> 8;
+               int s = MAD_TO_SHORT(pmd->synth.pcm.samples[0][i]);
+               write_int16_host_endian(fn->buf + fn->loaded, s);
+               fn->loaded += 2;
                if (MAD_NCHANNELS(&pmd->frame.header) == 2) { /* stereo */
                        s = MAD_TO_SHORT(pmd->synth.pcm.samples[1][i]);
-                       fn->buf[fn->loaded++] = s & 0xff;
-                       fn->buf[fn->loaded++] = s >> 8;
+                       write_int16_host_endian(fn->buf + fn->loaded, s);
+                       fn->loaded += 2;
                }
                if (fn->loaded != fn->bufsize) /* output buffer not full */
                        continue;
@@ -128,9 +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.
  *
- * \sa filter::init
+ * \sa filter::init.
  */
 void mp3dec_init(struct filter *f)
 {