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?>"
  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 #else
 150     "socket",
 151 #endif
 152     NULL
 153 };
 154
 155 static pa_socket_server *create_socket_server(pa_core *c, pa_modargs *ma) {
 156     pa_socket_server *s;
 157 #if defined(USE_TCP_SOCKETS)
 158     int loopback = 1;
 159     uint32_t port = IPV4_PORT;
 160
 161     if (pa_modargs_get_value_boolean(ma, "loopback", &loopback) < 0) {
 162         pa_log(__FILE__": loopback= expects a boolean argument.\n");
 163         return NULL;
 164     }
 165
 166     if (pa_modargs_get_value_u32(ma, "port", &port) < 0 || port < 1 || port > 0xFFFF) {
 167         pa_log(__FILE__": port= expects a numerical argument between 1 and 65535.\n");
 168         return NULL;
 169     }
 170
 171
 172     if (loopback) {
 173         if (!(s = pa_socket_server_new_ip_loopback(c->mainloop, port, TCPWRAP_SERVICE)))
 174             return NULL;
 175     } else {
 176         if (!(s = pa_socket_server_new_ip_any(c->mainloop, port, TCPWRAP_SERVICE)))
 177             return NULL;
 178     }
 179
 180 #else
 181     int r;
 182     const char *v;
 183     char tmp[PATH_MAX];
 184
 185     v = pa_modargs_get_value(ma, "socket", UNIX_SOCKET);
 186     assert(v);
 187
 188     pa_runtime_path(v, tmp, sizeof(tmp));
 189
 190     if (pa_make_secure_parent_dir(tmp) < 0) {
 191         pa_log(__FILE__": Failed to create secure socket directory.\n");
 192         return NULL;
 193     }
 194
 195     if ((r = pa_unix_socket_remove_stale(tmp)) < 0) {
 196         pa_log(__FILE__": Failed to remove stale UNIX socket '%s': %s\n", tmp, strerror(errno));
 197         return NULL;
 198     }
 199
 200     if (r)
 201         pa_log(__FILE__": Removed stale UNIX socket '%s'.", tmp);
 202
 203     if (!(s = pa_socket_server_new_unix(c->mainloop, tmp)))
 204         return NULL;
 205
 206 #endif
 207     return s;
 208 }
 209
 210 int pa__init(pa_core *c, pa_module*m) {
 211     pa_socket_server *s;
 212     pa_modargs *ma = NULL;
 213     int ret = -1;
 214     assert(c && m);
 215
 216     if (!(ma = pa_modargs_new(m->argument, valid_modargs))) {
 217         pa_log(__FILE__": Failed to parse module arguments\n");
 218         goto finish;
 219     }
 220
 221     if (!(s = create_socket_server(c, ma)))
 222         goto finish;
 223
 224     if (!(m->userdata = protocol_new(c, s, m, ma))) {
 225         pa_socket_server_unref(s);
 226         goto finish;
 227     }
 228
 229     ret = 0;
 230
 231 finish:
 232     if (ma)
 233         pa_modargs_free(ma);
 234
 235     return ret;
 236 }
 237
 238 void pa__done(pa_core *c, pa_module*m) {
 239     assert(c && m);
 240
 241 #if defined(USE_PROTOCOL_ESOUND) && !defined(USE_TCP_SOCKETS)
 242         if (remove(ESD_UNIX_SOCKET_NAME) != 0)
 243                 pa_log("%s: Failed to remove %s : %s.\n", __FILE__, ESD_UNIX_SOCKET_NAME, strerror (errno));
 244         if (remove(ESD_UNIX_SOCKET_DIR) != 0)
 245                 pa_log("%s: Failed to remove %s : %s.\n", __FILE__, ESD_UNIX_SOCKET_DIR, strerror (errno));
 246 #endif
 247
 248     protocol_free(m->userdata);
 249 }