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_properties=<properties for the sink> "
  44         "namereg_fail=<pa_namereg_register() fail parameter value> "
  45         "device=<ALSA device> "
  46         "device_id=<ALSA card index> "
  47         "format=<sample format> "
  48         "rate=<sample rate> "
  49         "channels=<number of channels> "
  50         "channel_map=<channel map> "
  51         "fragments=<number of fragments> "
  52         "fragment_size=<fragment size> "
  53         "mmap=<enable memory mapping?> "
  54         "tsched=<enable system timer based scheduling mode?> "
  55         "tsched_buffer_size=<buffer size when using timer based scheduling> "
  56         "tsched_buffer_watermark=<lower fill watermark> "
  57         "ignore_dB=<ignore dB information from the device?> "
  58         "control=<name of mixer control> "
  59         "rewind_safeguard=<number of bytes that cannot be rewound> "
  60         "sync_volume=<syncronize sw and hw voluchanges in IO-thread?> "
  61         "sync_volume_safety_margin=<usec adjustment depending on volume direction> "
  62         "sync_volume_extra_delay=<usec adjustment to HW volume changes>");
  63
  64 static const char* const valid_modargs[] = {
  65     "name",
  66     "sink_name",
  67     "sink_properties",
  68     "namereg_fail",
  69     "device",
  70     "device_id",
  71     "format",
  72     "rate",
  73     "channels",
  74     "channel_map",
  75     "fragments",
  76     "fragment_size",
  77     "mmap",
  78     "tsched",
  79     "tsched_buffer_size",
  80     "tsched_buffer_watermark",
  81     "ignore_dB",
  82     "control",
  83     "rewind_safeguard",
  84     "sync_volume",
  85     "sync_volume_safety_margin",
  86     "sync_volume_extra_delay",
  87     NULL
  88 };
  89
  90 int pa__init(pa_module*m) {
  91     pa_modargs *ma = NULL;
  92
  93     pa_assert(m);
  94
  95     pa_alsa_refcnt_inc();
  96
  97     if (!(ma = pa_modargs_new(m->argument, valid_modargs))) {
  98         pa_log("Failed to parse module arguments");
  99         goto fail;
 100     }
 101
 102     if (!(m->userdata = pa_alsa_sink_new(m, ma, __FILE__, NULL, NULL)))
 103         goto fail;
 104
 105     pa_modargs_free(ma);
 106
 107     return 0;
 108
 109 fail:
 110
 111     if (ma)
 112         pa_modargs_free(ma);
 113
 114     pa__done(m);
 115
 116     return -1;
 117 }
 118
 119 int pa__get_n_used(pa_module *m) {
 120     pa_sink *sink;
 121
 122     pa_assert(m);
 123     pa_assert_se(sink = m->userdata);
 124
 125     return pa_sink_linked_by(sink);
 126 }
 127
 128 void pa__done(pa_module*m) {
 129     pa_sink *sink;
 130
 131     pa_assert(m);
 132
 133     if ((sink = m->userdata))
 134         pa_alsa_sink_free(sink);
 135
 136     pa_alsa_refcnt_dec();
 137 }