src/modules/module-raop-discover.c

   1 /***
   2   This file is part of PulseAudio.
   3
   4   Copyright 2004-2006 Lennart Poettering
   5   Copyright 2008 Colin Guthrie
   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
   9   published by the Free Software Foundation; either version 2 of the
  10   License, 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
  18   License 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 <stdio.h>
  28 #include <stdlib.h>
  29 #include <string.h>
  30 #include <unistd.h>
  31
  32 #include <avahi-client/client.h>
  33 #include <avahi-client/lookup.h>
  34 #include <avahi-common/alternative.h>
  35 #include <avahi-common/error.h>
  36 #include <avahi-common/domain.h>
  37 #include <avahi-common/malloc.h>
  38
  39 #include <pulse/xmalloc.h>
  40 #include <pulse/util.h>
  41
  42 #include <pulsecore/sink.h>
  43 #include <pulsecore/source.h>
  44 #include <pulsecore/native-common.h>
  45 #include <pulsecore/core-util.h>
  46 #include <pulsecore/log.h>
  47 #include <pulsecore/core-subscribe.h>
  48 #include <pulsecore/hashmap.h>
  49 #include <pulsecore/modargs.h>
  50 #include <pulsecore/namereg.h>
  51 #include <pulsecore/avahi-wrap.h>
  52
  53 #include "module-raop-discover-symdef.h"
  54
  55 PA_MODULE_AUTHOR("Colin Guthrie");
  56 PA_MODULE_DESCRIPTION("mDNS/DNS-SD Service Discovery of RAOP devices");
  57 PA_MODULE_VERSION(PACKAGE_VERSION);
  58 PA_MODULE_LOAD_ONCE(TRUE);
  59
  60 #define SERVICE_TYPE_SINK "_raop._tcp"
  61
  62 static const char* const valid_modargs[] = {
  63     NULL
  64 };
  65
  66 struct tunnel {
  67     AvahiIfIndex interface;
  68     AvahiProtocol protocol;
  69     char *name, *type, *domain;
  70     uint32_t module_index;
  71 };
  72
  73 struct userdata {
  74     pa_core *core;
  75     pa_module *module;
  76     AvahiPoll *avahi_poll;
  77     AvahiClient *client;
  78     AvahiServiceBrowser *sink_browser;
  79
  80     pa_hashmap *tunnels;
  81 };
  82
  83 static unsigned tunnel_hash(const void *p) {
  84     const struct tunnel *t = p;
  85
  86     return
  87         (unsigned) t->interface +
  88         (unsigned) t->protocol +
  89         pa_idxset_string_hash_func(t->name) +
  90         pa_idxset_string_hash_func(t->type) +
  91         pa_idxset_string_hash_func(t->domain);
  92 }
  93
  94 static int tunnel_compare(const void *a, const void *b) {
  95     const struct tunnel *ta = a, *tb = b;
  96     int r;
  97
  98     if (ta->interface != tb->interface)
  99         return 1;
 100     if (ta->protocol != tb->protocol)
 101         return 1;
 102     if ((r = strcmp(ta->name, tb->name)))
 103         return r;
 104     if ((r = strcmp(ta->type, tb->type)))
 105         return r;
 106     if ((r = strcmp(ta->domain, tb->domain)))
 107         return r;
 108
 109     return 0;
 110 }
 111
 112 static struct tunnel *tunnel_new(
 113         AvahiIfIndex interface, AvahiProtocol protocol,
 114         const char *name, const char *type, const char *domain) {
 115
 116     struct tunnel *t;
 117     t = pa_xnew(struct tunnel, 1);
 118     t->interface = interface;
 119     t->protocol = protocol;
 120     t->name = pa_xstrdup(name);
 121     t->type = pa_xstrdup(type);
 122     t->domain = pa_xstrdup(domain);
 123     t->module_index = PA_IDXSET_INVALID;
 124     return t;
 125 }
 126
 127 static void tunnel_free(struct tunnel *t) {
 128     pa_assert(t);
 129     pa_xfree(t->name);
 130     pa_xfree(t->type);
 131     pa_xfree(t->domain);
 132     pa_xfree(t);
 133 }
 134
 135 static void resolver_cb(
 136         AvahiServiceResolver *r,
 137         AvahiIfIndex interface, AvahiProtocol protocol,
 138         AvahiResolverEvent event,
 139         const char *name, const char *type, const char *domain,
 140         const char *host_name, const AvahiAddress *a, uint16_t port,
 141         AvahiStringList *txt,
 142         AvahiLookupResultFlags flags,
 143         void *userdata) {
 144
 145     struct userdata *u = userdata;
 146     struct tunnel *tnl;
 147
 148     pa_assert(u);
 149
 150     tnl = tunnel_new(interface, protocol, name, type, domain);
 151
 152     if (event != AVAHI_RESOLVER_FOUND)
 153         pa_log("Resolving of '%s' failed: %s", name, avahi_strerror(avahi_client_errno(u->client)));
 154     else {
 155         char *device = NULL, *dname, *vname, *args;
 156         char at[AVAHI_ADDRESS_STR_MAX];
 157         AvahiStringList *l;
 158         pa_module *m;
 159
 160         for (l = txt; l; l = l->next) {
 161             char *key, *value;
 162             pa_assert_se(avahi_string_list_get_pair(l, &key, &value, NULL) == 0);
 163
 164             pa_log_debug("Found key: '%s' with value: '%s'", key, value);
 165             if (strcmp(key, "device") == 0) {
 166                 pa_xfree(device);
 167                 device = value;
 168                 value = NULL;
 169             }
 170             avahi_free(key);
 171             avahi_free(value);
 172         }
 173
 174         if (device)
 175             dname = pa_sprintf_malloc("raop.%s.%s", host_name, device);
 176         else
 177             dname = pa_sprintf_malloc("raop.%s", host_name);
 178
 179         if (!(vname = pa_namereg_make_valid_name(dname))) {
 180             pa_log("Cannot construct valid device name from '%s'.", dname);
 181             avahi_free(device);
 182             pa_xfree(dname);
 183             goto finish;
 184         }
 185         pa_xfree(dname);
 186
 187         /*
 188          TODO: allow this syntax of server name in things....
 189         args = pa_sprintf_malloc("server=[%s]:%u "
 190                                  "sink_name=%s",
 191                                  avahi_address_snprint(at, sizeof(at), a), port,
 192                                  vname);*/
 193         args = pa_sprintf_malloc("server=%s "
 194                                  "sink_name=%s",
 195                                  avahi_address_snprint(at, sizeof(at), a),
 196                                  vname);
 197
 198         pa_log_debug("Loading module-raop-sink with arguments '%s'", args);
 199
 200         if ((m = pa_module_load(u->core, "module-raop-sink", args))) {
 201             tnl->module_index = m->index;
 202             pa_hashmap_put(u->tunnels, tnl, tnl);
 203             tnl = NULL;
 204         }
 205
 206         pa_xfree(vname);
 207         pa_xfree(args);
 208         avahi_free(device);
 209     }
 210
 211 finish:
 212
 213     avahi_service_resolver_free(r);
 214
 215     if (tnl)
 216         tunnel_free(tnl);
 217 }
 218
 219 static void browser_cb(
 220         AvahiServiceBrowser *b,
 221         AvahiIfIndex interface, AvahiProtocol protocol,
 222         AvahiBrowserEvent event,
 223         const char *name, const char *type, const char *domain,
 224         AvahiLookupResultFlags flags,
 225         void *userdata) {
 226
 227     struct userdata *u = userdata;
 228     struct tunnel *t;
 229
 230     pa_assert(u);
 231
 232     if (flags & AVAHI_LOOKUP_RESULT_LOCAL)
 233         return;
 234
 235     t = tunnel_new(interface, protocol, name, type, domain);
 236
 237     if (event == AVAHI_BROWSER_NEW) {
 238
 239         if (!pa_hashmap_get(u->tunnels, t))
 240             if (!(avahi_service_resolver_new(u->client, interface, protocol, name, type, domain, AVAHI_PROTO_UNSPEC, 0, resolver_cb, u)))
 241                 pa_log("avahi_service_resolver_new() failed: %s", avahi_strerror(avahi_client_errno(u->client)));
 242
 243         /* We ignore the returned resolver object here, since the we don't
 244          * need to attach any special data to it, and we can still destory
 245          * it from the callback */
 246
 247     } else if (event == AVAHI_BROWSER_REMOVE) {
 248         struct tunnel *t2;
 249
 250         if ((t2 = pa_hashmap_get(u->tunnels, t))) {
 251             pa_module_unload_by_index(u->core, t2->module_index, TRUE);
 252             pa_hashmap_remove(u->tunnels, t2);
 253             tunnel_free(t2);
 254         }
 255     }
 256
 257     tunnel_free(t);
 258 }
 259
 260 static void client_callback(AvahiClient *c, AvahiClientState state, void *userdata) {
 261     struct userdata *u = userdata;
 262
 263     pa_assert(c);
 264     pa_assert(u);
 265
 266     u->client = c;
 267
 268     switch (state) {
 269         case AVAHI_CLIENT_S_REGISTERING:
 270         case AVAHI_CLIENT_S_RUNNING:
 271         case AVAHI_CLIENT_S_COLLISION:
 272
 273             if (!u->sink_browser) {
 274
 275                 if (!(u->sink_browser = avahi_service_browser_new(
 276                               c,
 277                               AVAHI_IF_UNSPEC, AVAHI_PROTO_UNSPEC,
 278                               SERVICE_TYPE_SINK,
 279                               NULL,
 280                               0,
 281                               browser_cb, u))) {
 282
 283                     pa_log("avahi_service_browser_new() failed: %s", avahi_strerror(avahi_client_errno(c)));
 284                     pa_module_unload_request(u->module, TRUE);
 285                 }
 286             }
 287
 288             break;
 289
 290         case AVAHI_CLIENT_FAILURE:
 291             if (avahi_client_errno(c) == AVAHI_ERR_DISCONNECTED) {
 292                 int error;
 293
 294                 pa_log_debug("Avahi daemon disconnected.");
 295
 296                 if (!(u->client = avahi_client_new(u->avahi_poll, AVAHI_CLIENT_NO_FAIL, client_callback, u, &error))) {
 297                     pa_log("avahi_client_new() failed: %s", avahi_strerror(error));
 298                     pa_module_unload_request(u->module, TRUE);
 299                 }
 300             }
 301
 302             /* Fall through */
 303
 304         case AVAHI_CLIENT_CONNECTING:
 305
 306             if (u->sink_browser) {
 307                 avahi_service_browser_free(u->sink_browser);
 308                 u->sink_browser = NULL;
 309             }
 310
 311             break;
 312
 313         default: ;
 314     }
 315 }
 316
 317 int pa__init(pa_module*m) {
 318
 319     struct userdata *u;
 320     pa_modargs *ma = NULL;
 321     int error;
 322
 323     if (!(ma = pa_modargs_new(m->argument, valid_modargs))) {
 324         pa_log("Failed to parse module arguments.");
 325         goto fail;
 326     }
 327
 328     m->userdata = u = pa_xnew(struct userdata, 1);
 329     u->core = m->core;
 330     u->module = m;
 331     u->sink_browser = NULL;
 332
 333     u->tunnels = pa_hashmap_new(tunnel_hash, tunnel_compare);
 334
 335     u->avahi_poll = pa_avahi_poll_new(m->core->mainloop);
 336
 337     if (!(u->client = avahi_client_new(u->avahi_poll, AVAHI_CLIENT_NO_FAIL, client_callback, u, &error))) {
 338         pa_log("pa_avahi_client_new() failed: %s", avahi_strerror(error));
 339         goto fail;
 340     }
 341
 342     pa_modargs_free(ma);
 343
 344     return 0;
 345
 346 fail:
 347     pa__done(m);
 348
 349     if (ma)
 350         pa_modargs_free(ma);
 351
 352     return -1;
 353 }
 354
 355 void pa__done(pa_module*m) {
 356     struct userdata*u;
 357     pa_assert(m);
 358
 359     if (!(u = m->userdata))
 360         return;
 361
 362     if (u->client)
 363         avahi_client_free(u->client);
 364
 365     if (u->avahi_poll)
 366         pa_avahi_poll_free(u->avahi_poll);
 367
 368     if (u->tunnels) {
 369         struct tunnel *t;
 370
 371         while ((t = pa_hashmap_steal_first(u->tunnels))) {
 372             pa_module_unload_by_index(u->core, t->module_index, TRUE);
 373             tunnel_free(t);
 374         }
 375
 376         pa_hashmap_free(u->tunnels, NULL, NULL);
 377     }
 378
 379     pa_xfree(u);
 380 }