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/module.h>
  28 #include <pulsecore/sink.h>
  29 #include <pulsecore/modargs.h>
  30
  31 #include "alsa-util.h"
  32 #include "alsa-sink.h"
  33 #include "module-alsa-sink-symdef.h"
  34
  35 PA_MODULE_AUTHOR("Lennart Poettering");
  36 PA_MODULE_DESCRIPTION("ALSA Sink");
  37 PA_MODULE_VERSION(PACKAGE_VERSION);
  38 PA_MODULE_LOAD_ONCE(FALSE);
  39 PA_MODULE_USAGE(
  40         "name=<name of the sink, to be prefixed> "
  41         "sink_name=<name for the sink> "
  42         "sink_properties=<properties for the sink> "
  43         "namereg_fail=<when false attempt to synthesise new sink_name if it is already taken> "
  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         "sync_volume=<syncronize sw and hw voluchanges in IO-thread?> "
  60         "sync_volume_safety_margin=<usec adjustment depending on volume direction> "
  61         "sync_volume_extra_delay=<usec adjustment to HW volume changes>");
  62
  63 static const char* const valid_modargs[] = {
  64     "name",
  65     "sink_name",
  66     "sink_properties",
  67     "namereg_fail",
  68     "device",
  69     "device_id",
  70     "format",
  71     "rate",
  72     "channels",
  73     "channel_map",
  74     "fragments",
  75     "fragment_size",
  76     "mmap",
  77     "tsched",
  78     "tsched_buffer_size",
  79     "tsched_buffer_watermark",
  80     "ignore_dB",
  81     "control",
  82     "rewind_safeguard",
  83     "sync_volume",
  84     "sync_volume_safety_margin",
  85     "sync_volume_extra_delay",
  86     NULL
  87 };
  88
  89 int pa__init(pa_module*m) {
  90     pa_modargs *ma = NULL;
  91
  92     pa_assert(m);
  93
  94     pa_alsa_refcnt_inc();
  95
  96     if (!(ma = pa_modargs_new(m->argument, valid_modargs))) {
  97         pa_log("Failed to parse module arguments");
  98         goto fail;
  99     }
 100
 101     if (!(m->userdata = pa_alsa_sink_new(m, ma, __FILE__, NULL, NULL)))
 102         goto fail;
 103
 104     pa_modargs_free(ma);
 105
 106     return 0;
 107
 108 fail:
 109
 110     if (ma)
 111         pa_modargs_free(ma);
 112
 113     pa__done(m);
 114
 115     return -1;
 116 }
 117
 118 int pa__get_n_used(pa_module *m) {
 119     pa_sink *sink;
 120
 121     pa_assert(m);
 122     pa_assert_se(sink = m->userdata);
 123
 124     return pa_sink_linked_by(sink);
 125 }
 126
 127 void pa__done(pa_module*m) {
 128     pa_sink *sink;
 129
 130     pa_assert(m);
 131
 132     if ((sink = m->userdata))
 133         pa_alsa_sink_free(sink);
 134
 135     pa_alsa_refcnt_dec();
 136 }