code.delx.au - pulseaudio/blob - src/modules/alsa/module-alsa-sink.c

   1 /***
   2   This file is part of PulseAudio.
   3
   4   Copyright 2004-2008 Lennart Poettering
   5   Copyright 2006 Pierre Ossman <ossman@cendio.se> for Cendio AB
   6
   7   PulseAudio is free software; you can redistribute it and/or modify
   8   it under the terms of the GNU Lesser General Public License as published
   9   by the Free Software Foundation; either version 2.1 of the License,
  10   or (at your option) any later version.
  11
  12   PulseAudio is distributed in the hope that it will be useful, but
  13   WITHOUT ANY WARRANTY; without even the implied warranty of
  14   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  15   General Public License for more details.
  16
  17   You should have received a copy of the GNU Lesser General Public License
  18   along with PulseAudio; if not, write to the Free Software
  19   Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
  20   USA.
  21 ***/
  22
  23 #ifdef HAVE_CONFIG_H
  24 #include <config.h>
  25 #endif
  26
  27 #include <pulsecore/core.h>
  28 #include <pulsecore/module.h>
  29 #include <pulsecore/sink.h>
  30 #include <pulsecore/modargs.h>
  31
  32 #include "alsa-util.h"
  33 #include "alsa-sink.h"
  34 #include "module-alsa-sink-symdef.h"
  35
  36 PA_MODULE_AUTHOR("Lennart Poettering");
  37 PA_MODULE_DESCRIPTION("ALSA Sink");
  38 PA_MODULE_VERSION(PACKAGE_VERSION);
  39 PA_MODULE_LOAD_ONCE(FALSE);
  40 PA_MODULE_USAGE(
  41         "name=<name of the sink, to be prefixed> "
  42         "sink_name=<name for the sink> "
  43         "sink_properities=<properties for the sink> "
  44         "device=<ALSA device> "
  45         "device_id=<ALSA card index> "
  46         "format=<sample format> "
  47         "rate=<sample rate> "
  48         "channels=<number of channels> "
  49         "channel_map=<channel map> "
  50         "fragments=<number of fragments> "
  51         "fragment_size=<fragment size> "
  52         "mmap=<enable memory mapping?> "
  53         "tsched=<enable system timer based scheduling mode?> "
  54         "tsched_buffer_size=<buffer size when using timer based scheduling> "
  55         "tsched_buffer_watermark=<lower fill watermark> "
  56         "ignore_dB=<ignore dB information from the device?> "
  57         "control=<name of mixer control>"
  58         "rewind_safeguard=<number of bytes that cannot be rewound");
  59
  60 static const char* const valid_modargs[] = {
  61     "name",
  62     "sink_name",
  63     "sink_properties",
  64     "device",
  65     "device_id",
  66     "format",
  67     "rate",
  68     "channels",
  69     "channel_map",
  70     "fragments",
  71     "fragment_size",
  72     "mmap",
  73     "tsched",
  74     "tsched_buffer_size",
  75     "tsched_buffer_watermark",
  76     "ignore_dB",
  77     "control",
  78     "rewind_safeguard",
  79     NULL
  80 };
  81
  82 int pa__init(pa_module*m) {
  83     pa_modargs *ma = NULL;
  84
  85     pa_assert(m);
  86
  87     pa_alsa_refcnt_inc();
  88
  89     if (!(ma = pa_modargs_new(m->argument, valid_modargs))) {
  90         pa_log("Failed to parse module arguments");
  91         goto fail;
  92     }
  93
  94     if (!(m->userdata = pa_alsa_sink_new(m, ma, __FILE__, NULL, NULL)))
  95         goto fail;
  96
  97     pa_modargs_free(ma);
  98
  99     return 0;
 100
 101 fail:
 102
 103     if (ma)
 104         pa_modargs_free(ma);
 105
 106     pa__done(m);
 107
 108     return -1;
 109 }
 110
 111 int pa__get_n_used(pa_module *m) {
 112     pa_sink *sink;
 113
 114     pa_assert(m);
 115     pa_assert_se(sink = m->userdata);
 116
 117     return pa_sink_linked_by(sink);
 118 }
 119
 120 void pa__done(pa_module*m) {
 121     pa_sink *sink;
 122
 123     pa_assert(m);
 124
 125     if ((sink = m->userdata))
 126         pa_alsa_sink_free(sink);
 127
 128     pa_alsa_refcnt_dec();
 129 }