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         "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     "device",
  68     "device_id",
  69     "format",
  70     "rate",
  71     "channels",
  72     "channel_map",
  73     "fragments",
  74     "fragment_size",
  75     "mmap",
  76     "tsched",
  77     "tsched_buffer_size",
  78     "tsched_buffer_watermark",
  79     "ignore_dB",
  80     "control",
  81     "rewind_safeguard",
  82     "sync_volume",
  83     "sync_volume_safety_margin",
  84     "sync_volume_extra_delay",
  85     NULL
  86 };
  87
  88 int pa__init(pa_module*m) {
  89     pa_modargs *ma = NULL;
  90
  91     pa_assert(m);
  92
  93     pa_alsa_refcnt_inc();
  94
  95     if (!(ma = pa_modargs_new(m->argument, valid_modargs))) {
  96         pa_log("Failed to parse module arguments");
  97         goto fail;
  98     }
  99
 100     if (!(m->userdata = pa_alsa_sink_new(m, ma, __FILE__, NULL, NULL)))
 101         goto fail;
 102
 103     pa_modargs_free(ma);
 104
 105     return 0;
 106
 107 fail:
 108
 109     if (ma)
 110         pa_modargs_free(ma);
 111
 112     pa__done(m);
 113
 114     return -1;
 115 }
 116
 117 int pa__get_n_used(pa_module *m) {
 118     pa_sink *sink;
 119
 120     pa_assert(m);
 121     pa_assert_se(sink = m->userdata);
 122
 123     return pa_sink_linked_by(sink);
 124 }
 125
 126 void pa__done(pa_module*m) {
 127     pa_sink *sink;
 128
 129     pa_assert(m);
 130
 131     if ((sink = m->userdata))
 132         pa_alsa_sink_free(sink);
 133
 134     pa_alsa_refcnt_dec();
 135 }