mysql_selector.c: introduce the myslq lock

[paraslash.git] / alsa_write.c

diff --git a/alsa_write.c b/alsa_write.c
index 7c090c899915cf454abad3c459dc45f0973239f8..6f92612a2221c5bf132b786f9fd67a9872c777cd 100644 (file)
--- a/alsa_write.c
+++ b/alsa_write.c
@@ -1,19 +1,7 @@
 /*
- * 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 alsa_write.c paraslash's alsa output plugin */
@@ -36,7 +24,7 @@
 #include "alsa_write.cmdline.h"
 #include "error.h"
 
-
+/** always use 16 bit little endian */
 #define FORMAT SND_PCM_FORMAT_S16_LE
 
 /** data specific to the alsa writer */
@@ -49,7 +37,15 @@ struct private_alsa_write_data {
        struct timeval next_chunk;
        /** the return value of snd_pcm_hw_params_get_buffer_time_max() */
        unsigned buffer_time;
+       /**
+        * the samplerate given by command line option or the decoder
+        * of the writer node group
+        */
        unsigned samplerate;
+       /**
+        * the number of channels, also given by command line option or the
+        * decoder of the writer node group
+        */
        unsigned channels;
 };
 
@@ -227,7 +223,13 @@ err_out:
        return NULL;
 }
 
-/** the init function of the alsa writer */
+/**
+ * the init function of the alsa writer
+ *
+ * \param w pointer to the writer to initialize
+ *
+ * \sa struct writer
+ */
 void alsa_write_init(struct writer *w)
 {
        w->open = alsa_open;