src/modules/module-pipe-sink.c

   1 /* $Id$ */
   2
   3 /***
   4   This file is part of PulseAudio.
   5
   6   PulseAudio is free software; you can redistribute it and/or modify
   7   it under the terms of the GNU Lesser General Public License as published
   8   by the Free Software Foundation; either version 2 of the License,
   9   or (at your option) any later version.
  10
  11   PulseAudio is distributed in the hope that it will be useful, but
  12   WITHOUT ANY WARRANTY; without even the implied warranty of
  13   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  14   General Public License for more details.
  15
  16   You should have received a copy of the GNU Lesser General Public License
  17   along with PulseAudio; if not, write to the Free Software
  18   Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
  19   USA.
  20 ***/
  21
  22 #ifdef HAVE_CONFIG_H
  23 #include <config.h>
  24 #endif
  25
  26 #include <stdlib.h>
  27 #include <sys/stat.h>
  28 #include <stdio.h>
  29 #include <assert.h>
  30 #include <errno.h>
  31 #include <string.h>
  32 #include <fcntl.h>
  33 #include <unistd.h>
  34 #include <limits.h>
  35
  36 #include <pulse/xmalloc.h>
  37
  38 #include <pulsecore/core-error.h>
  39 #include <pulsecore/iochannel.h>
  40 #include <pulsecore/sink.h>
  41 #include <pulsecore/module.h>
  42 #include <pulsecore/core-util.h>
  43 #include <pulsecore/modargs.h>
  44 #include <pulsecore/log.h>
  45
  46 #include "module-pipe-sink-symdef.h"
  47
  48 PA_MODULE_AUTHOR("Lennart Poettering")
  49 PA_MODULE_DESCRIPTION("UNIX pipe sink")
  50 PA_MODULE_VERSION(PACKAGE_VERSION)
  51 PA_MODULE_USAGE(
  52         "sink_name=<name for the sink> "
  53         "file=<path of the FIFO> "
  54         "format=<sample format> "
  55         "channels=<number of channels> "
  56         "rate=<sample rate>"
  57         "channel_map=<channel map>")
  58
  59 #define DEFAULT_FIFO_NAME "/tmp/music.output"
  60 #define DEFAULT_SINK_NAME "fifo_output"
  61
  62 struct userdata {
  63     pa_core *core;
  64
  65     char *filename;
  66
  67     pa_sink *sink;
  68     pa_iochannel *io;
  69     pa_defer_event *defer_event;
  70
  71     pa_memchunk memchunk;
  72     pa_module *module;
  73 };
  74
  75 static const char* const valid_modargs[] = {
  76     "file",
  77     "rate",
  78     "format",
  79     "channels",
  80     "sink_name",
  81     "channel_map",
  82     NULL
  83 };
  84
  85 static void do_write(struct userdata *u) {
  86     ssize_t r;
  87     assert(u);
  88
  89     u->core->mainloop->defer_enable(u->defer_event, 0);
  90
  91     if (!pa_iochannel_is_writable(u->io))
  92         return;
  93
  94     pa_module_set_used(u->module, pa_sink_used_by(u->sink));
  95
  96     if (!u->memchunk.length)
  97         if (pa_sink_render(u->sink, PIPE_BUF, &u->memchunk) < 0)
  98             return;
  99
 100     assert(u->memchunk.memblock && u->memchunk.length);
 101
 102     if ((r = pa_iochannel_write(u->io, (uint8_t*) u->memchunk.memblock->data + u->memchunk.index, u->memchunk.length)) < 0) {
 103         pa_log("write(): %s", pa_cstrerror(errno));
 104         return;
 105     }
 106
 107     u->memchunk.index += r;
 108     u->memchunk.length -= r;
 109
 110     if (u->memchunk.length <= 0) {
 111         pa_memblock_unref(u->memchunk.memblock);
 112         u->memchunk.memblock = NULL;
 113     }
 114 }
 115
 116 static void notify_cb(pa_sink*s) {
 117     struct userdata *u = s->userdata;
 118     assert(s && u);
 119
 120     if (pa_iochannel_is_writable(u->io))
 121         u->core->mainloop->defer_enable(u->defer_event, 1);
 122 }
 123
 124 static pa_usec_t get_latency_cb(pa_sink *s) {
 125     struct userdata *u = s->userdata;
 126     assert(s && u);
 127
 128     return u->memchunk.memblock ? pa_bytes_to_usec(u->memchunk.length, &s->sample_spec) : 0;
 129 }
 130
 131 static void defer_callback(PA_GCC_UNUSED pa_mainloop_api *m, PA_GCC_UNUSED pa_defer_event*e, void *userdata) {
 132     struct userdata *u = userdata;
 133     assert(u);
 134     do_write(u);
 135 }
 136
 137 static void io_callback(PA_GCC_UNUSED pa_iochannel *io, void*userdata) {
 138     struct userdata *u = userdata;
 139     assert(u);
 140     do_write(u);
 141 }
 142
 143 int pa__init(pa_core *c, pa_module*m) {
 144     struct userdata *u = NULL;
 145     struct stat st;
 146     const char *p;
 147     int fd = -1;
 148     pa_sample_spec ss;
 149     pa_channel_map map;
 150     pa_modargs *ma = NULL;
 151     char *t;
 152
 153     assert(c && m);
 154
 155     if (!(ma = pa_modargs_new(m->argument, valid_modargs))) {
 156         pa_log("failed to parse module arguments");
 157         goto fail;
 158     }
 159
 160     ss = c->default_sample_spec;
 161     if (pa_modargs_get_sample_spec_and_channel_map(ma, &ss, &map, PA_CHANNEL_MAP_DEFAULT) < 0) {
 162         pa_log("invalid sample format specification");
 163         goto fail;
 164     }
 165
 166     mkfifo(p = pa_modargs_get_value(ma, "file", DEFAULT_FIFO_NAME), 0777);
 167
 168     if ((fd = open(p, O_RDWR)) < 0) {
 169         pa_log("open('%s'): %s", p, pa_cstrerror(errno));
 170         goto fail;
 171     }
 172
 173     pa_fd_set_cloexec(fd, 1);
 174
 175     if (fstat(fd, &st) < 0) {
 176         pa_log("fstat('%s'): %s", p, pa_cstrerror(errno));
 177         goto fail;
 178     }
 179
 180     if (!S_ISFIFO(st.st_mode)) {
 181         pa_log("'%s' is not a FIFO.", p);
 182         goto fail;
 183     }
 184
 185     u = pa_xmalloc0(sizeof(struct userdata));
 186     u->filename = pa_xstrdup(p);
 187     u->core = c;
 188     u->module = m;
 189     m->userdata = u;
 190
 191     if (!(u->sink = pa_sink_new(c, __FILE__, pa_modargs_get_value(ma, "sink_name", DEFAULT_SINK_NAME), 0, &ss, &map))) {
 192         pa_log("failed to create sink.");
 193         goto fail;
 194     }
 195     u->sink->notify = notify_cb;
 196     u->sink->get_latency = get_latency_cb;
 197     u->sink->userdata = u;
 198     pa_sink_set_owner(u->sink, m);
 199     pa_sink_set_description(u->sink, t = pa_sprintf_malloc("Unix FIFO sink '%s'", p));
 200     pa_xfree(t);
 201
 202     u->io = pa_iochannel_new(c->mainloop, -1, fd);
 203     assert(u->io);
 204     pa_iochannel_set_callback(u->io, io_callback, u);
 205
 206     u->memchunk.memblock = NULL;
 207     u->memchunk.length = 0;
 208
 209     u->defer_event = c->mainloop->defer_new(c->mainloop, defer_callback, u);
 210     assert(u->defer_event);
 211     c->mainloop->defer_enable(u->defer_event, 0);
 212
 213     pa_modargs_free(ma);
 214
 215     return 0;
 216
 217 fail:
 218     if (ma)
 219         pa_modargs_free(ma);
 220
 221     if (fd >= 0)
 222         close(fd);
 223
 224     pa__done(c, m);
 225
 226     return -1;
 227 }
 228
 229 void pa__done(pa_core *c, pa_module*m) {
 230     struct userdata *u;
 231     assert(c && m);
 232
 233     if (!(u = m->userdata))
 234         return;
 235
 236     if (u->memchunk.memblock)
 237         pa_memblock_unref(u->memchunk.memblock);
 238
 239     pa_sink_disconnect(u->sink);
 240     pa_sink_unref(u->sink);
 241     pa_iochannel_free(u->io);
 242     u->core->mainloop->defer_free(u->defer_event);
 243
 244     assert(u->filename);
 245     unlink(u->filename);
 246     pa_xfree(u->filename);
 247
 248     pa_xfree(u);
 249 }