code.delx.au - pulseaudio/blob - src/modules/module-protocol-stub.c

   1 /* $Id$ */
   2
   3 /***
   4   This file is part of polypaudio.
   5
   6   polypaudio 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   polypaudio 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 polypaudio; 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 <string.h>
  27 #include <errno.h>
  28 #include <stdio.h>
  29 #include <assert.h>
  30 #include <unistd.h>
  31 #include <limits.h>
  32
  33 #ifdef HAVE_SYS_SOCKET_H
  34 #include <sys/socket.h>
  35 #endif
  36 #ifdef HAVE_ARPA_INET_H
  37 #include <arpa/inet.h>
  38 #endif
  39 #ifdef HAVE_NETINET_IN_H
  40 #include <netinet/in.h>
  41 #endif
  42
  43 #include "../polypcore/winsock.h"
  44
  45 #include <polypcore/module.h>
  46 #include <polypcore/socket-server.h>
  47 #include <polypcore/socket-util.h>
  48 #include <polypcore/util.h>
  49 #include <polypcore/modargs.h>
  50 #include <polypcore/log.h>
  51 #include <polypcore/native-common.h>
  52
  53 #ifdef USE_TCP_SOCKETS
  54 #define SOCKET_DESCRIPTION "(TCP sockets)"
  55 #define SOCKET_USAGE "port=<TCP port number> loopback=<listen on loopback device only?> listen=<address to listen on>"
  56 #else
  57 #define SOCKET_DESCRIPTION "(UNIX sockets)"
  58 #define SOCKET_USAGE "socket=<path to UNIX socket>"
  59 #endif
  60
  61 #if defined(USE_PROTOCOL_SIMPLE)
  62   #include <polypcore/protocol-simple.h>
  63   #define protocol_new pa_protocol_simple_new
  64   #define protocol_free pa_protocol_simple_free
  65   #define TCPWRAP_SERVICE "polypaudio-simple"
  66   #define IPV4_PORT 4711
  67   #define UNIX_SOCKET "simple"
  68   #define MODULE_ARGUMENTS "rate", "format", "channels", "sink", "source", "playback", "record",
  69   #if defined(USE_TCP_SOCKETS)
  70     #include "module-simple-protocol-tcp-symdef.h"
  71   #else
  72     #include "module-simple-protocol-unix-symdef.h"
  73   #endif
  74   PA_MODULE_DESCRIPTION("Simple protocol "SOCKET_DESCRIPTION)
  75   PA_MODULE_USAGE("rate=<sample rate> format=<sample format> channels=<number of channels> sink=<sink to connect to> source=<source to connect to> playback=<enable playback?> record=<enable record?> "SOCKET_USAGE)
  76 #elif defined(USE_PROTOCOL_CLI)
  77   #include <polypcore/protocol-cli.h>
  78   #define protocol_new pa_protocol_cli_new
  79   #define protocol_free pa_protocol_cli_free
  80   #define TCPWRAP_SERVICE "polypaudio-cli"
  81   #define IPV4_PORT 4712
  82   #define UNIX_SOCKET "cli"
  83   #define MODULE_ARGUMENTS
  84   #ifdef USE_TCP_SOCKETS
  85     #include "module-cli-protocol-tcp-symdef.h"
  86   #else
  87     #include "module-cli-protocol-unix-symdef.h"
  88   #endif
  89   PA_MODULE_DESCRIPTION("Command line interface protocol "SOCKET_DESCRIPTION)
  90   PA_MODULE_USAGE(SOCKET_USAGE)
  91 #elif defined(USE_PROTOCOL_HTTP)
  92   #include <polypcore/protocol-http.h>
  93   #define protocol_new pa_protocol_http_new
  94   #define protocol_free pa_protocol_http_free
  95   #define TCPWRAP_SERVICE "polypaudio-http"
  96   #define IPV4_PORT 4714
  97   #define UNIX_SOCKET "http"
  98   #define MODULE_ARGUMENTS
  99   #ifdef USE_TCP_SOCKETS
 100     #include "module-http-protocol-tcp-symdef.h"
 101   #else
 102     #include "module-http-protocol-unix-symdef.h"
 103   #endif
 104   PA_MODULE_DESCRIPTION("HTTP "SOCKET_DESCRIPTION)
 105   PA_MODULE_USAGE(SOCKET_USAGE)
 106 #elif defined(USE_PROTOCOL_NATIVE)
 107   #include <polypcore/protocol-native.h>
 108   #define protocol_new pa_protocol_native_new
 109   #define protocol_free pa_protocol_native_free
 110   #define TCPWRAP_SERVICE "polypaudio-native"
 111   #define IPV4_PORT PA_NATIVE_DEFAULT_PORT
 112   #define UNIX_SOCKET PA_NATIVE_DEFAULT_UNIX_SOCKET
 113   #define MODULE_ARGUMENTS "public", "cookie",
 114   #ifdef USE_TCP_SOCKETS
 115     #include "module-native-protocol-tcp-symdef.h"
 116   #else
 117     #include "module-native-protocol-unix-symdef.h"
 118   #endif
 119   PA_MODULE_DESCRIPTION("Native protocol "SOCKET_DESCRIPTION)
 120   PA_MODULE_USAGE("public=<don't check for cookies?> cookie=<path to cookie file> "SOCKET_USAGE)
 121 #elif defined(USE_PROTOCOL_ESOUND)
 122   #include <polypcore/protocol-esound.h>
 123   #include <polypcore/esound.h>
 124   #define protocol_new pa_protocol_esound_new
 125   #define protocol_free pa_protocol_esound_free
 126   #define TCPWRAP_SERVICE "esound"
 127   #define IPV4_PORT ESD_DEFAULT_PORT
 128   #define UNIX_SOCKET ESD_UNIX_SOCKET_NAME
 129   #define MODULE_ARGUMENTS "sink", "source", "public", "cookie",
 130   #ifdef USE_TCP_SOCKETS
 131     #include "module-esound-protocol-tcp-symdef.h"
 132   #else
 133     #include "module-esound-protocol-unix-symdef.h"
 134   #endif
 135   PA_MODULE_DESCRIPTION("ESOUND protocol "SOCKET_DESCRIPTION)
 136   PA_MODULE_USAGE("sink=<sink to connect to> source=<source to connect to> public=<don't check for cookies?> cookie=<path to cookie file> "SOCKET_USAGE)
 137 #else
 138   #error "Broken build system"
 139 #endif
 140
 141 PA_MODULE_AUTHOR("Lennart Poettering")
 142 PA_MODULE_VERSION(PACKAGE_VERSION)
 143
 144 static const char* const valid_modargs[] = {
 145     MODULE_ARGUMENTS
 146 #if defined(USE_TCP_SOCKETS)
 147     "port",
 148     "loopback",
 149     "listen",
 150 #else
 151     "socket",
 152 #endif
 153     NULL
 154 };
 155
 156 static pa_socket_server *create_socket_server(pa_core *c, pa_modargs *ma) {
 157     pa_socket_server *s;
 158 #if defined(USE_TCP_SOCKETS)
 159     int loopback = 1;
 160     uint32_t port = IPV4_PORT;
 161     const char *listen_on;
 162
 163     if (pa_modargs_get_value_boolean(ma, "loopback", &loopback) < 0) {
 164         pa_log(__FILE__": loopback= expects a boolean argument.\n");
 165         return NULL;
 166     }
 167
 168     if (pa_modargs_get_value_u32(ma, "port", &port) < 0 || port < 1 || port > 0xFFFF) {
 169         pa_log(__FILE__": port= expects a numerical argument between 1 and 65535.\n");
 170         return NULL;
 171     }
 172
 173     listen_on = pa_modargs_get_value(ma, "listen", NULL);
 174
 175     if (listen_on) {
 176         if (!(s = pa_socket_server_new_ip_string(c->mainloop, listen_on, port, TCPWRAP_SERVICE)))
 177             return NULL;
 178     } else if (loopback) {
 179         if (!(s = pa_socket_server_new_ip_loopback(c->mainloop, port, TCPWRAP_SERVICE)))
 180             return NULL;
 181     } else {
 182         if (!(s = pa_socket_server_new_ip_any(c->mainloop, port, TCPWRAP_SERVICE)))
 183             return NULL;
 184     }
 185
 186 #else
 187     int r;
 188     const char *v;
 189     char tmp[PATH_MAX];
 190
 191     v = pa_modargs_get_value(ma, "socket", UNIX_SOCKET);
 192     assert(v);
 193
 194     pa_runtime_path(v, tmp, sizeof(tmp));
 195
 196     if (pa_make_secure_parent_dir(tmp) < 0) {
 197         pa_log(__FILE__": Failed to create secure socket directory.\n");
 198         return NULL;
 199     }
 200
 201     if ((r = pa_unix_socket_remove_stale(tmp)) < 0) {
 202         pa_log(__FILE__": Failed to remove stale UNIX socket '%s': %s\n", tmp, strerror(errno));
 203         return NULL;
 204     }
 205
 206     if (r)
 207         pa_log(__FILE__": Removed stale UNIX socket '%s'.", tmp);
 208
 209     if (!(s = pa_socket_server_new_unix(c->mainloop, tmp)))
 210         return NULL;
 211
 212 #endif
 213     return s;
 214 }
 215
 216 int pa__init(pa_core *c, pa_module*m) {
 217     pa_socket_server *s;
 218     pa_modargs *ma = NULL;
 219     int ret = -1;
 220     assert(c && m);
 221
 222     if (!(ma = pa_modargs_new(m->argument, valid_modargs))) {
 223         pa_log(__FILE__": Failed to parse module arguments\n");
 224         goto finish;
 225     }
 226
 227     if (!(s = create_socket_server(c, ma)))
 228         goto finish;
 229
 230     if (!(m->userdata = protocol_new(c, s, m, ma))) {
 231         pa_socket_server_unref(s);
 232         goto finish;
 233     }
 234
 235     ret = 0;
 236
 237 finish:
 238     if (ma)
 239         pa_modargs_free(ma);
 240
 241     return ret;
 242 }
 243
 244 void pa__done(pa_core *c, pa_module*m) {
 245     assert(c && m);
 246
 247 #if defined(USE_PROTOCOL_ESOUND) && !defined(USE_TCP_SOCKETS)
 248         if (remove(ESD_UNIX_SOCKET_NAME) != 0)
 249                 pa_log("%s: Failed to remove %s : %s.\n", __FILE__, ESD_UNIX_SOCKET_NAME, strerror (errno));
 250         if (remove(ESD_UNIX_SOCKET_DIR) != 0)
 251                 pa_log("%s: Failed to remove %s : %s.\n", __FILE__, ESD_UNIX_SOCKET_DIR, strerror (errno));
 252 #endif
 253
 254     protocol_free(m->userdata);
 255 }