code.delx.au - pulseaudio/blob - src/modules/rtp/module-rtp-send.c

   1 /***
   2   This file is part of PulseAudio.
   3
   4   Copyright 2006 Lennart Poettering
   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 <stdio.h>
  27 #include <sys/socket.h>
  28 #include <netinet/in.h>
  29 #include <arpa/inet.h>
  30 #include <errno.h>
  31 #include <string.h>
  32 #include <unistd.h>
  33
  34 #include <pulse/timeval.h>
  35 #include <pulse/util.h>
  36 #include <pulse/xmalloc.h>
  37
  38 #include <pulsecore/core-error.h>
  39 #include <pulsecore/module.h>
  40 #include <pulsecore/llist.h>
  41 #include <pulsecore/source.h>
  42 #include <pulsecore/source-output.h>
  43 #include <pulsecore/memblockq.h>
  44 #include <pulsecore/log.h>
  45 #include <pulsecore/core-util.h>
  46 #include <pulsecore/modargs.h>
  47 #include <pulsecore/namereg.h>
  48 #include <pulsecore/sample-util.h>
  49 #include <pulsecore/macro.h>
  50 #include <pulsecore/socket-util.h>
  51
  52 #include "module-rtp-send-symdef.h"
  53
  54 #include "rtp.h"
  55 #include "sdp.h"
  56 #include "sap.h"
  57
  58 PA_MODULE_AUTHOR("Lennart Poettering");
  59 PA_MODULE_DESCRIPTION("Read data from source and send it to the network via RTP/SAP/SDP");
  60 PA_MODULE_VERSION(PACKAGE_VERSION);
  61 PA_MODULE_LOAD_ONCE(FALSE);
  62 PA_MODULE_USAGE(
  63         "source=<name of the source> "
  64         "format=<sample format> "
  65         "channels=<number of channels> "
  66         "rate=<sample rate> "
  67         "destination=<destination IP address> "
  68         "port=<port number> "
  69         "mtu=<maximum transfer unit> "
  70         "loop=<loopback to local host?> "
  71         "ttl=<ttl value>"
  72 );
  73
  74 #define DEFAULT_PORT 46000
  75 #define DEFAULT_TTL 1
  76 #define SAP_PORT 9875
  77 #define DEFAULT_DESTINATION "224.0.0.56"
  78 #define MEMBLOCKQ_MAXLENGTH (1024*170)
  79 #define DEFAULT_MTU 1280
  80 #define SAP_INTERVAL 5
  81
  82 static const char* const valid_modargs[] = {
  83     "source",
  84     "format",
  85     "channels",
  86     "rate",
  87     "destination",
  88     "port",
  89     "mtu" ,
  90     "loop",
  91     "ttl",
  92     NULL
  93 };
  94
  95 struct userdata {
  96     pa_module *module;
  97
  98     pa_source_output *source_output;
  99     pa_memblockq *memblockq;
 100
 101     pa_rtp_context rtp_context;
 102     pa_sap_context sap_context;
 103     size_t mtu;
 104
 105     pa_time_event *sap_event;
 106 };
 107
 108 /* Called from I/O thread context */
 109 static int source_output_process_msg(pa_msgobject *o, int code, void *data, int64_t offset, pa_memchunk *chunk) {
 110     struct userdata *u;
 111     pa_assert_se(u = PA_SOURCE_OUTPUT(o)->userdata);
 112
 113     switch (code) {
 114         case PA_SOURCE_OUTPUT_MESSAGE_GET_LATENCY:
 115             *((pa_usec_t*) data) = pa_bytes_to_usec(pa_memblockq_get_length(u->memblockq), &u->source_output->sample_spec);
 116
 117             /* Fall through, the default handler will add in the extra
 118              * latency added by the resampler */
 119             break;
 120     }
 121
 122     return pa_source_output_process_msg(o, code, data, offset, chunk);
 123 }
 124
 125 /* Called from I/O thread context */
 126 static void source_output_push(pa_source_output *o, const pa_memchunk *chunk) {
 127     struct userdata *u;
 128     pa_source_output_assert_ref(o);
 129     pa_assert_se(u = o->userdata);
 130
 131     if (pa_memblockq_push(u->memblockq, chunk) < 0) {
 132         pa_log_warn("Failed to push chunk into memblockq.");
 133         return;
 134     }
 135
 136     pa_rtp_send(&u->rtp_context, u->mtu, u->memblockq);
 137 }
 138
 139 /* Called from main context */
 140 static void source_output_kill(pa_source_output* o) {
 141     struct userdata *u;
 142     pa_source_output_assert_ref(o);
 143     pa_assert_se(u = o->userdata);
 144
 145     pa_module_unload_request(u->module, TRUE);
 146
 147     pa_source_output_unlink(u->source_output);
 148     pa_source_output_unref(u->source_output);
 149     u->source_output = NULL;
 150 }
 151
 152 static void sap_event_cb(pa_mainloop_api *m, pa_time_event *t, const struct timeval *tv, void *userdata) {
 153     struct userdata *u = userdata;
 154     struct timeval next;
 155
 156     pa_assert(m);
 157     pa_assert(t);
 158     pa_assert(tv);
 159     pa_assert(u);
 160
 161     pa_sap_send(&u->sap_context, 0);
 162
 163     pa_gettimeofday(&next);
 164     pa_timeval_add(&next, SAP_INTERVAL * PA_USEC_PER_SEC);
 165     m->time_restart(t, &next);
 166 }
 167
 168 int pa__init(pa_module*m) {
 169     struct userdata *u;
 170     pa_modargs *ma = NULL;
 171     const char *dest;
 172     uint32_t port = DEFAULT_PORT, mtu;
 173     uint32_t ttl = DEFAULT_TTL;
 174     sa_family_t af;
 175     int fd = -1, sap_fd = -1;
 176     pa_source *s;
 177     pa_sample_spec ss;
 178     pa_channel_map cm;
 179     struct sockaddr_in sa4, sap_sa4;
 180     struct sockaddr_in6 sa6, sap_sa6;
 181     struct sockaddr_storage sa_dst;
 182     pa_source_output *o = NULL;
 183     uint8_t payload;
 184     char *p;
 185     int r, j;
 186     socklen_t k;
 187     struct timeval tv;
 188     char hn[128], *n;
 189     pa_bool_t loop = FALSE;
 190     pa_source_output_new_data data;
 191
 192     pa_assert(m);
 193
 194     if (!(ma = pa_modargs_new(m->argument, valid_modargs))) {
 195         pa_log("Failed to parse module arguments");
 196         goto fail;
 197     }
 198
 199     if (!(s = pa_namereg_get(m->core, pa_modargs_get_value(ma, "source", NULL), PA_NAMEREG_SOURCE, 1))) {
 200         pa_log("Source does not exist.");
 201         goto fail;
 202     }
 203
 204     if (pa_modargs_get_value_boolean(ma, "loop", &loop) < 0) {
 205         pa_log("Failed to parse \"loop\" parameter.");
 206         goto fail;
 207     }
 208
 209     ss = s->sample_spec;
 210     pa_rtp_sample_spec_fixup(&ss);
 211     cm = s->channel_map;
 212     if (pa_modargs_get_sample_spec(ma, &ss) < 0) {
 213         pa_log("Failed to parse sample specification");
 214         goto fail;
 215     }
 216
 217     if (!pa_rtp_sample_spec_valid(&ss)) {
 218         pa_log("Specified sample type not compatible with RTP");
 219         goto fail;
 220     }
 221
 222     if (ss.channels != cm.channels)
 223         pa_channel_map_init_auto(&cm, ss.channels, PA_CHANNEL_MAP_AIFF);
 224
 225     payload = pa_rtp_payload_from_sample_spec(&ss);
 226
 227     mtu = (uint32_t) pa_frame_align(DEFAULT_MTU, &ss);
 228
 229     if (pa_modargs_get_value_u32(ma, "mtu", &mtu) < 0 || mtu < 1 || mtu % pa_frame_size(&ss) != 0) {
 230         pa_log("Invalid MTU.");
 231         goto fail;
 232     }
 233
 234     port = DEFAULT_PORT + ((uint32_t) (rand() % 512) << 1);
 235     if (pa_modargs_get_value_u32(ma, "port", &port) < 0 || port < 1 || port > 0xFFFF) {
 236         pa_log("port= expects a numerical argument between 1 and 65535.");
 237         goto fail;
 238     }
 239
 240     if (port & 1)
 241         pa_log_warn("Port number not even as suggested in RFC3550!");
 242
 243     if (pa_modargs_get_value_u32(ma, "ttl", &ttl) < 0 || ttl < 1 || ttl > 0xFF) {
 244         pa_log("ttl= expects a numerical argument between 1 and 255.");
 245         goto fail;
 246     }
 247
 248     dest = pa_modargs_get_value(ma, "destination", DEFAULT_DESTINATION);
 249
 250     if (inet_pton(AF_INET6, dest, &sa6.sin6_addr) > 0) {
 251         sa6.sin6_family = af = AF_INET6;
 252         sa6.sin6_port = htons((uint16_t) port);
 253         sap_sa6 = sa6;
 254         sap_sa6.sin6_port = htons(SAP_PORT);
 255     } else if (inet_pton(AF_INET, dest, &sa4.sin_addr) > 0) {
 256         sa4.sin_family = af = AF_INET;
 257         sa4.sin_port = htons((uint16_t) port);
 258         sap_sa4 = sa4;
 259         sap_sa4.sin_port = htons(SAP_PORT);
 260     } else {
 261         pa_log("Invalid destination '%s'", dest);
 262         goto fail;
 263     }
 264
 265     if ((fd = socket(af, SOCK_DGRAM, 0)) < 0) {
 266         pa_log("socket() failed: %s", pa_cstrerror(errno));
 267         goto fail;
 268     }
 269
 270     if (connect(fd, af == AF_INET ? (struct sockaddr*) &sa4 : (struct sockaddr*) &sa6, (socklen_t) (af == AF_INET ? sizeof(sa4) : sizeof(sa6))) < 0) {
 271         pa_log("connect() failed: %s", pa_cstrerror(errno));
 272         goto fail;
 273     }
 274
 275     if ((sap_fd = socket(af, SOCK_DGRAM, 0)) < 0) {
 276         pa_log("socket() failed: %s", pa_cstrerror(errno));
 277         goto fail;
 278     }
 279
 280     if (connect(sap_fd, af == AF_INET ? (struct sockaddr*) &sap_sa4 : (struct sockaddr*) &sap_sa6, (socklen_t) (af == AF_INET ? sizeof(sap_sa4) : sizeof(sap_sa6))) < 0) {
 281         pa_log("connect() failed: %s", pa_cstrerror(errno));
 282         goto fail;
 283     }
 284
 285     j = !!loop;
 286     if (setsockopt(fd, IPPROTO_IP, IP_MULTICAST_LOOP, &j, sizeof(j)) < 0 ||
 287         setsockopt(sap_fd, IPPROTO_IP, IP_MULTICAST_LOOP, &j, sizeof(j)) < 0) {
 288         pa_log("IP_MULTICAST_LOOP failed: %s", pa_cstrerror(errno));
 289         goto fail;
 290     }
 291
 292     if (ttl != DEFAULT_TTL) {
 293         int _ttl = (int) ttl;
 294
 295         if (setsockopt(fd, IPPROTO_IP, IP_MULTICAST_TTL, &_ttl, sizeof(_ttl)) < 0) {
 296             pa_log("IP_MULTICAST_TTL failed: %s", pa_cstrerror(errno));
 297             goto fail;
 298         }
 299
 300         if (setsockopt(sap_fd, IPPROTO_IP, IP_MULTICAST_TTL, &_ttl, sizeof(_ttl)) < 0) {
 301             pa_log("IP_MULTICAST_TTL (sap) failed: %s", pa_cstrerror(errno));
 302             goto fail;
 303         }
 304     }
 305
 306     /* If the socket queue is full, let's drop packets */
 307     pa_make_fd_nonblock(fd);
 308     pa_make_udp_socket_low_delay(fd);
 309     pa_make_fd_cloexec(fd);
 310     pa_make_fd_cloexec(sap_fd);
 311
 312     pa_source_output_new_data_init(&data);
 313     pa_proplist_sets(data.proplist, PA_PROP_MEDIA_NAME, "RTP Monitor Stream");
 314     pa_proplist_sets(data.proplist, "rtp.destination", dest);
 315     pa_proplist_setf(data.proplist, "rtp.mtu", "%lu", (unsigned long) mtu);
 316     pa_proplist_setf(data.proplist, "rtp.port", "%lu", (unsigned long) port);
 317     pa_proplist_setf(data.proplist, "rtp.ttl", "%lu", (unsigned long) ttl);
 318     data.driver = __FILE__;
 319     data.module = m;
 320     data.source = s;
 321     pa_source_output_new_data_set_sample_spec(&data, &ss);
 322     pa_source_output_new_data_set_channel_map(&data, &cm);
 323
 324     o = pa_source_output_new(m->core, &data, PA_SOURCE_OUTPUT_DONT_INHIBIT_AUTO_SUSPEND);
 325     pa_source_output_new_data_done(&data);
 326
 327     if (!o) {
 328         pa_log("failed to create source output.");
 329         goto fail;
 330     }
 331
 332     o->parent.process_msg = source_output_process_msg;
 333     o->push = source_output_push;
 334     o->kill = source_output_kill;
 335
 336     u = pa_xnew(struct userdata, 1);
 337     m->userdata = u;
 338     o->userdata = u;
 339
 340     u->module = m;
 341     u->source_output = o;
 342
 343     u->memblockq = pa_memblockq_new(
 344             0,
 345             MEMBLOCKQ_MAXLENGTH,
 346             MEMBLOCKQ_MAXLENGTH,
 347             pa_frame_size(&ss),
 348             1,
 349             0,
 350             0,
 351             NULL);
 352
 353     u->mtu = mtu;
 354
 355     k = sizeof(sa_dst);
 356     pa_assert_se((r = getsockname(fd, (struct sockaddr*) &sa_dst, &k)) >= 0);
 357
 358     n = pa_sprintf_malloc("PulseAudio RTP Stream on %s", pa_get_fqdn(hn, sizeof(hn)));
 359
 360     p = pa_sdp_build(af,
 361                      af == AF_INET ? (void*) &((struct sockaddr_in*) &sa_dst)->sin_addr : (void*) &((struct sockaddr_in6*) &sa_dst)->sin6_addr,
 362                      af == AF_INET ? (void*) &sa4.sin_addr : (void*) &sa6.sin6_addr,
 363                      n, (uint16_t) port, payload, &ss);
 364
 365     pa_xfree(n);
 366
 367     pa_rtp_context_init_send(&u->rtp_context, fd, m->core->cookie, payload, pa_frame_size(&ss));
 368     pa_sap_context_init_send(&u->sap_context, sap_fd, p);
 369
 370     pa_log_info("RTP stream initialized with mtu %u on %s:%u ttl=%u, SSRC=0x%08x, payload=%u, initial sequence #%u", mtu, dest, port, ttl, u->rtp_context.ssrc, payload, u->rtp_context.sequence);
 371     pa_log_info("SDP-Data:\n%s\nEOF", p);
 372
 373     pa_sap_send(&u->sap_context, 0);
 374
 375     pa_gettimeofday(&tv);
 376     pa_timeval_add(&tv, SAP_INTERVAL * PA_USEC_PER_SEC);
 377     u->sap_event = m->core->mainloop->time_new(m->core->mainloop, &tv, sap_event_cb, u);
 378
 379     pa_source_output_put(u->source_output);
 380
 381     pa_modargs_free(ma);
 382
 383     return 0;
 384
 385 fail:
 386     if (ma)
 387         pa_modargs_free(ma);
 388
 389     if (fd >= 0)
 390         pa_close(fd);
 391
 392     if (sap_fd >= 0)
 393         pa_close(sap_fd);
 394
 395     if (o) {
 396         pa_source_output_unlink(o);
 397         pa_source_output_unref(o);
 398     }
 399
 400     return -1;
 401 }
 402
 403 void pa__done(pa_module*m) {
 404     struct userdata *u;
 405     pa_assert(m);
 406
 407     if (!(u = m->userdata))
 408         return;
 409
 410     if (u->sap_event)
 411         m->core->mainloop->time_free(u->sap_event);
 412
 413     if (u->source_output) {
 414         pa_source_output_unlink(u->source_output);
 415         pa_source_output_unref(u->source_output);
 416     }
 417
 418     pa_rtp_context_destroy(&u->rtp_context);
 419
 420     pa_sap_send(&u->sap_context, 1);
 421     pa_sap_context_destroy(&u->sap_context);
 422
 423     if (u->memblockq)
 424         pa_memblockq_free(u->memblockq);
 425
 426     pa_xfree(u);
 427 }