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

   1
   2 /***
   3   This file is part of PulseAudio.
   4
   5   Copyright 2006 Lennart Poettering
   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 published
   9   by the Free Software Foundation; either version 2 of the License,
  10   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 License
  18   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 <sys/socket.h>
  29 #include <netinet/in.h>
  30 #include <arpa/inet.h>
  31 #include <errno.h>
  32 #include <string.h>
  33 #include <unistd.h>
  34 #include <poll.h>
  35
  36 #include <pulse/timeval.h>
  37 #include <pulse/xmalloc.h>
  38
  39 #include <pulsecore/core-error.h>
  40 #include <pulsecore/module.h>
  41 #include <pulsecore/llist.h>
  42 #include <pulsecore/sink.h>
  43 #include <pulsecore/sink-input.h>
  44 #include <pulsecore/memblockq.h>
  45 #include <pulsecore/log.h>
  46 #include <pulsecore/core-util.h>
  47 #include <pulsecore/modargs.h>
  48 #include <pulsecore/namereg.h>
  49 #include <pulsecore/sample-util.h>
  50 #include <pulsecore/macro.h>
  51 #include <pulsecore/atomic.h>
  52 #include <pulsecore/rtclock.h>
  53 #include <pulsecore/atomic.h>
  54
  55 #include "module-rtp-recv-symdef.h"
  56
  57 #include "rtp.h"
  58 #include "sdp.h"
  59 #include "sap.h"
  60
  61 PA_MODULE_AUTHOR("Lennart Poettering");
  62 PA_MODULE_DESCRIPTION("Recieve data from a network via RTP/SAP/SDP");
  63 PA_MODULE_VERSION(PACKAGE_VERSION);
  64 PA_MODULE_LOAD_ONCE(FALSE);
  65 PA_MODULE_USAGE(
  66         "sink=<name of the sink> "
  67         "sap_address=<multicast address to listen on> "
  68 );
  69
  70 #define SAP_PORT 9875
  71 #define DEFAULT_SAP_ADDRESS "224.0.0.56"
  72 #define MEMBLOCKQ_MAXLENGTH (1024*170)
  73 #define MAX_SESSIONS 16
  74 #define DEATH_TIMEOUT 20
  75
  76 static const char* const valid_modargs[] = {
  77     "sink",
  78     "sap_address",
  79     NULL
  80 };
  81
  82 struct session {
  83     struct userdata *userdata;
  84     PA_LLIST_FIELDS(struct session);
  85
  86     pa_sink_input *sink_input;
  87     pa_memblockq *memblockq;
  88
  89     pa_bool_t first_packet;
  90     uint32_t ssrc;
  91     uint32_t offset;
  92
  93     struct pa_sdp_info sdp_info;
  94
  95     pa_rtp_context rtp_context;
  96
  97     pa_rtpoll_item *rtpoll_item;
  98
  99     pa_atomic_t timestamp;
 100 };
 101
 102 struct userdata {
 103     pa_module *module;
 104
 105     pa_sap_context sap_context;
 106     pa_io_event* sap_event;
 107
 108     pa_time_event *check_death_event;
 109
 110     char *sink_name;
 111
 112     PA_LLIST_HEAD(struct session, sessions);
 113     pa_hashmap *by_origin;
 114     int n_sessions;
 115 };
 116
 117 static void session_free(struct session *s);
 118
 119 /* Called from I/O thread context */
 120 static int sink_input_process_msg(pa_msgobject *o, int code, void *data, int64_t offset, pa_memchunk *chunk) {
 121     struct session *s = PA_SINK_INPUT(o)->userdata;
 122
 123     switch (code) {
 124         case PA_SINK_INPUT_MESSAGE_GET_LATENCY:
 125             *((pa_usec_t*) data) = pa_bytes_to_usec(pa_memblockq_get_length(s->memblockq), &s->sink_input->sample_spec);
 126
 127             /* Fall through, the default handler will add in the extra
 128              * latency added by the resampler */
 129             break;
 130     }
 131
 132     return pa_sink_input_process_msg(o, code, data, offset, chunk);
 133 }
 134
 135 /* Called from I/O thread context */
 136 static int sink_input_pop(pa_sink_input *i, size_t length, pa_memchunk *chunk) {
 137     struct session *s;
 138     pa_sink_input_assert_ref(i);
 139     pa_assert_se(s = i->userdata);
 140
 141     if (pa_memblockq_peek(s->memblockq, chunk) < 0)
 142         return -1;
 143
 144     pa_memblockq_drop(s->memblockq, chunk->length);
 145
 146     return 0;
 147 }
 148
 149 /* Called from main context */
 150 static void sink_input_kill(pa_sink_input* i) {
 151     struct session *s;
 152     pa_sink_input_assert_ref(i);
 153     pa_assert_se(s = i->userdata);
 154
 155     session_free(s);
 156 }
 157
 158 /* Called from I/O thread context */
 159 static int rtpoll_work_cb(pa_rtpoll_item *i) {
 160     pa_memchunk chunk;
 161     int64_t k, j, delta;
 162     struct timeval now;
 163     struct session *s;
 164     struct pollfd *p;
 165
 166     pa_assert_se(s = pa_rtpoll_item_get_userdata(i));
 167
 168     p = pa_rtpoll_item_get_pollfd(i, NULL);
 169
 170     if (p->revents & (POLLERR|POLLNVAL|POLLHUP|POLLOUT)) {
 171         pa_log("poll() signalled bad revents.");
 172         return -1;
 173     }
 174
 175     if ((p->revents & POLLIN) == 0)
 176         return 0;
 177
 178     p->revents = 0;
 179
 180     if (pa_rtp_recv(&s->rtp_context, &chunk, s->userdata->module->core->mempool) < 0)
 181         return 0;
 182
 183     if (s->sdp_info.payload != s->rtp_context.payload) {
 184         pa_memblock_unref(chunk.memblock);
 185         return 0;
 186     }
 187
 188     if (!s->first_packet) {
 189         s->first_packet = TRUE;
 190
 191         s->ssrc = s->rtp_context.ssrc;
 192         s->offset = s->rtp_context.timestamp;
 193
 194         if (s->ssrc == s->userdata->module->core->cookie)
 195             pa_log_warn("Detected RTP packet loop!");
 196     } else {
 197         if (s->ssrc != s->rtp_context.ssrc) {
 198             pa_memblock_unref(chunk.memblock);
 199             return 0;
 200         }
 201     }
 202
 203     /* Check wheter there was a timestamp overflow */
 204     k = (int64_t) s->rtp_context.timestamp - (int64_t) s->offset;
 205     j = (int64_t) 0x100000000LL - (int64_t) s->offset + (int64_t) s->rtp_context.timestamp;
 206
 207     if ((k < 0 ? -k : k) < (j < 0 ? -j : j))
 208         delta = k;
 209     else
 210         delta = j;
 211
 212     pa_memblockq_seek(s->memblockq, delta * s->rtp_context.frame_size, PA_SEEK_RELATIVE);
 213
 214     if (pa_memblockq_push(s->memblockq, &chunk) < 0) {
 215         /* queue overflow, let's flush it and try again */
 216         pa_memblockq_flush(s->memblockq);
 217         pa_memblockq_push(s->memblockq, &chunk);
 218     }
 219
 220     /* The next timestamp we expect */
 221     s->offset = s->rtp_context.timestamp + (chunk.length / s->rtp_context.frame_size);
 222
 223     pa_memblock_unref(chunk.memblock);
 224
 225     pa_rtclock_get(&now);
 226     pa_atomic_store(&s->timestamp, now.tv_sec);
 227
 228     return 1;
 229 }
 230
 231 /* Called from I/O thread context */
 232 static void sink_input_attach(pa_sink_input *i) {
 233     struct session *s;
 234     struct pollfd *p;
 235
 236     pa_sink_input_assert_ref(i);
 237     pa_assert_se(s = i->userdata);
 238
 239     pa_assert(!s->rtpoll_item);
 240     s->rtpoll_item = pa_rtpoll_item_new(i->sink->rtpoll, PA_RTPOLL_LATE, 1);
 241
 242     p = pa_rtpoll_item_get_pollfd(s->rtpoll_item, NULL);
 243     p->fd = s->rtp_context.fd;
 244     p->events = POLLIN;
 245     p->revents = 0;
 246
 247     pa_rtpoll_item_set_work_callback(s->rtpoll_item, rtpoll_work_cb);
 248     pa_rtpoll_item_set_userdata(s->rtpoll_item, s);
 249 }
 250
 251 /* Called from I/O thread context */
 252 static void sink_input_detach(pa_sink_input *i) {
 253     struct session *s;
 254     pa_sink_input_assert_ref(i);
 255     pa_assert_se(s = i->userdata);
 256
 257     pa_assert(s->rtpoll_item);
 258     pa_rtpoll_item_free(s->rtpoll_item);
 259     s->rtpoll_item = NULL;
 260 }
 261
 262 static int mcast_socket(const struct sockaddr* sa, socklen_t salen) {
 263     int af, fd = -1, r, one;
 264
 265     pa_assert(sa);
 266     pa_assert(salen > 0);
 267
 268     af = sa->sa_family;
 269     if ((fd = socket(af, SOCK_DGRAM, 0)) < 0) {
 270         pa_log("Failed to create socket: %s", pa_cstrerror(errno));
 271         goto fail;
 272     }
 273
 274     one = 1;
 275     if (setsockopt(fd, SOL_SOCKET, SO_REUSEADDR, &one, sizeof(one)) < 0) {
 276         pa_log("SO_REUSEADDR failed: %s", pa_cstrerror(errno));
 277         goto fail;
 278     }
 279
 280     if (af == AF_INET) {
 281         struct ip_mreq mr4;
 282         memset(&mr4, 0, sizeof(mr4));
 283         mr4.imr_multiaddr = ((const struct sockaddr_in*) sa)->sin_addr;
 284         r = setsockopt(fd, IPPROTO_IP, IP_ADD_MEMBERSHIP, &mr4, sizeof(mr4));
 285     } else {
 286         struct ipv6_mreq mr6;
 287         memset(&mr6, 0, sizeof(mr6));
 288         mr6.ipv6mr_multiaddr = ((const struct sockaddr_in6*) sa)->sin6_addr;
 289         r = setsockopt(fd, IPPROTO_IPV6, IPV6_JOIN_GROUP, &mr6, sizeof(mr6));
 290     }
 291
 292     if (r < 0) {
 293         pa_log_info("Joining mcast group failed: %s", pa_cstrerror(errno));
 294         goto fail;
 295     }
 296
 297     if (bind(fd, sa, salen) < 0) {
 298         pa_log("bind() failed: %s", pa_cstrerror(errno));
 299         goto fail;
 300     }
 301
 302     return fd;
 303
 304 fail:
 305     if (fd >= 0)
 306         close(fd);
 307
 308     return -1;
 309 }
 310
 311 static struct session *session_new(struct userdata *u, const pa_sdp_info *sdp_info) {
 312     struct session *s = NULL;
 313     char *c;
 314     pa_sink *sink;
 315     int fd = -1;
 316     pa_memblock *silence;
 317     pa_sink_input_new_data data;
 318     struct timeval now;
 319
 320     pa_assert(u);
 321     pa_assert(sdp_info);
 322
 323     if (u->n_sessions >= MAX_SESSIONS) {
 324         pa_log("Session limit reached.");
 325         goto fail;
 326     }
 327
 328     if (!(sink = pa_namereg_get(u->module->core, u->sink_name, PA_NAMEREG_SINK, 1))) {
 329         pa_log("Sink does not exist.");
 330         goto fail;
 331     }
 332
 333     s = pa_xnew0(struct session, 1);
 334     s->userdata = u;
 335     s->first_packet = FALSE;
 336     s->sdp_info = *sdp_info;
 337     s->rtpoll_item = NULL;
 338
 339     pa_rtclock_get(&now);
 340     pa_atomic_store(&s->timestamp, now.tv_sec);
 341
 342     if ((fd = mcast_socket((const struct sockaddr*) &sdp_info->sa, sdp_info->salen)) < 0)
 343         goto fail;
 344
 345     c = pa_sprintf_malloc("RTP Stream%s%s%s",
 346                           sdp_info->session_name ? " (" : "",
 347                           sdp_info->session_name ? sdp_info->session_name : "",
 348                           sdp_info->session_name ? ")" : "");
 349
 350     pa_sink_input_new_data_init(&data);
 351     data.sink = sink;
 352     data.driver = __FILE__;
 353     pa_proplist_sets(data.proplist, PA_PROP_MEDIA_NAME, c);
 354     pa_xfree(c);
 355     data.module = u->module;
 356     pa_sink_input_new_data_set_sample_spec(&data, &sdp_info->sample_spec);
 357
 358     s->sink_input = pa_sink_input_new(u->module->core, &data, 0);
 359     pa_sink_input_new_data_done(&data);
 360
 361     if (!s->sink_input) {
 362         pa_log("Failed to create sink input.");
 363         goto fail;
 364     }
 365
 366     s->sink_input->userdata = s;
 367
 368     s->sink_input->parent.process_msg = sink_input_process_msg;
 369     s->sink_input->pop = sink_input_pop;
 370     s->sink_input->kill = sink_input_kill;
 371     s->sink_input->attach = sink_input_attach;
 372     s->sink_input->detach = sink_input_detach;
 373
 374     silence = pa_silence_memblock_new(
 375             s->userdata->module->core->mempool,
 376             &s->sink_input->sample_spec,
 377             pa_frame_align(pa_bytes_per_second(&s->sink_input->sample_spec)/128, &s->sink_input->sample_spec));
 378
 379     s->memblockq = pa_memblockq_new(
 380             0,
 381             MEMBLOCKQ_MAXLENGTH,
 382             MEMBLOCKQ_MAXLENGTH,
 383             pa_frame_size(&s->sink_input->sample_spec),
 384             pa_bytes_per_second(&s->sink_input->sample_spec)/10+1,
 385             0,
 386             0,
 387             silence);
 388
 389     pa_memblock_unref(silence);
 390
 391     pa_rtp_context_init_recv(&s->rtp_context, fd, pa_frame_size(&s->sdp_info.sample_spec));
 392
 393     pa_hashmap_put(s->userdata->by_origin, s->sdp_info.origin, s);
 394     u->n_sessions++;
 395     PA_LLIST_PREPEND(struct session, s->userdata->sessions, s);
 396
 397     pa_sink_input_put(s->sink_input);
 398
 399     pa_log_info("New session '%s'", s->sdp_info.session_name);
 400
 401     return s;
 402
 403 fail:
 404     pa_xfree(s);
 405
 406     if (fd >= 0)
 407         pa_close(fd);
 408
 409     return NULL;
 410 }
 411
 412 static void session_free(struct session *s) {
 413     pa_assert(s);
 414
 415     pa_log_info("Freeing session '%s'", s->sdp_info.session_name);
 416
 417     pa_sink_input_unlink(s->sink_input);
 418     pa_sink_input_unref(s->sink_input);
 419
 420     PA_LLIST_REMOVE(struct session, s->userdata->sessions, s);
 421     pa_assert(s->userdata->n_sessions >= 1);
 422     s->userdata->n_sessions--;
 423     pa_hashmap_remove(s->userdata->by_origin, s->sdp_info.origin);
 424
 425     pa_memblockq_free(s->memblockq);
 426     pa_sdp_info_destroy(&s->sdp_info);
 427     pa_rtp_context_destroy(&s->rtp_context);
 428
 429     pa_xfree(s);
 430 }
 431
 432 static void sap_event_cb(pa_mainloop_api *m, pa_io_event *e, int fd, pa_io_event_flags_t flags, void *userdata) {
 433     struct userdata *u = userdata;
 434     int goodbye;
 435     pa_sdp_info info;
 436     struct session *s;
 437
 438     pa_assert(m);
 439     pa_assert(e);
 440     pa_assert(u);
 441     pa_assert(fd == u->sap_context.fd);
 442     pa_assert(flags == PA_IO_EVENT_INPUT);
 443
 444     if (pa_sap_recv(&u->sap_context, &goodbye) < 0)
 445         return;
 446
 447     if (!pa_sdp_parse(u->sap_context.sdp_data, &info, goodbye))
 448         return;
 449
 450     if (goodbye) {
 451
 452         if ((s = pa_hashmap_get(u->by_origin, info.origin)))
 453             session_free(s);
 454
 455         pa_sdp_info_destroy(&info);
 456     } else {
 457
 458         if (!(s = pa_hashmap_get(u->by_origin, info.origin))) {
 459             if (!(s = session_new(u, &info)))
 460                 pa_sdp_info_destroy(&info);
 461
 462         } else {
 463             struct timeval now;
 464             pa_rtclock_get(&now);
 465             pa_atomic_store(&s->timestamp, now.tv_sec);
 466
 467             pa_sdp_info_destroy(&info);
 468         }
 469     }
 470 }
 471
 472 static void check_death_event_cb(pa_mainloop_api *m, pa_time_event *t, const struct timeval *ptv, void *userdata) {
 473     struct session *s, *n;
 474     struct userdata *u = userdata;
 475     struct timeval now;
 476     struct timeval tv;
 477
 478     pa_assert(m);
 479     pa_assert(t);
 480     pa_assert(ptv);
 481     pa_assert(u);
 482
 483     pa_rtclock_get(&now);
 484
 485     pa_log_debug("Checking for dead streams ...");
 486
 487     for (s = u->sessions; s; s = n) {
 488         int k;
 489         n = s->next;
 490
 491         k = pa_atomic_load(&s->timestamp);
 492
 493         if (k + DEATH_TIMEOUT < now.tv_sec)
 494             session_free(s);
 495     }
 496
 497     /* Restart timer */
 498     pa_gettimeofday(&tv);
 499     pa_timeval_add(&tv, DEATH_TIMEOUT*PA_USEC_PER_SEC);
 500     m->time_restart(t, &tv);
 501 }
 502
 503 int pa__init(pa_module*m) {
 504     struct userdata *u;
 505     pa_modargs *ma = NULL;
 506     struct sockaddr_in sa4;
 507     struct sockaddr_in6 sa6;
 508     struct sockaddr *sa;
 509     socklen_t salen;
 510     const char *sap_address;
 511     int fd = -1;
 512     struct timeval tv;
 513
 514     pa_assert(m);
 515
 516     if (!(ma = pa_modargs_new(m->argument, valid_modargs))) {
 517         pa_log("failed to parse module arguments");
 518         goto fail;
 519     }
 520
 521     sap_address = pa_modargs_get_value(ma, "sap_address", DEFAULT_SAP_ADDRESS);
 522
 523     if (inet_pton(AF_INET6, sap_address, &sa6.sin6_addr) > 0) {
 524         sa6.sin6_family = AF_INET6;
 525         sa6.sin6_port = htons(SAP_PORT);
 526         sa = (struct sockaddr*) &sa6;
 527         salen = sizeof(sa6);
 528     } else if (inet_pton(AF_INET, sap_address, &sa4.sin_addr) > 0) {
 529         sa4.sin_family = AF_INET;
 530         sa4.sin_port = htons(SAP_PORT);
 531         sa = (struct sockaddr*) &sa4;
 532         salen = sizeof(sa4);
 533     } else {
 534         pa_log("Invalid SAP address '%s'", sap_address);
 535         goto fail;
 536     }
 537
 538     if ((fd = mcast_socket(sa, salen)) < 0)
 539         goto fail;
 540
 541     u = pa_xnew(struct userdata, 1);
 542     m->userdata = u;
 543     u->module = m;
 544     u->sink_name = pa_xstrdup(pa_modargs_get_value(ma, "sink", NULL));
 545
 546     u->sap_event = m->core->mainloop->io_new(m->core->mainloop, fd, PA_IO_EVENT_INPUT, sap_event_cb, u);
 547     pa_sap_context_init_recv(&u->sap_context, fd);
 548
 549     PA_LLIST_HEAD_INIT(struct session, u->sessions);
 550     u->n_sessions = 0;
 551     u->by_origin = pa_hashmap_new(pa_idxset_string_hash_func, pa_idxset_string_compare_func);
 552
 553     pa_gettimeofday(&tv);
 554     pa_timeval_add(&tv, DEATH_TIMEOUT * PA_USEC_PER_SEC);
 555     u->check_death_event = m->core->mainloop->time_new(m->core->mainloop, &tv, check_death_event_cb, u);
 556
 557     pa_modargs_free(ma);
 558
 559     return 0;
 560
 561 fail:
 562     if (ma)
 563         pa_modargs_free(ma);
 564
 565     if (fd >= 0)
 566         pa_close(fd);
 567
 568     return -1;
 569 }
 570
 571 void pa__done(pa_module*m) {
 572     struct userdata *u;
 573     struct session *s;
 574
 575     pa_assert(m);
 576
 577     if (!(u = m->userdata))
 578         return;
 579
 580     if (u->sap_event)
 581         m->core->mainloop->io_free(u->sap_event);
 582
 583     if (u->check_death_event)
 584         m->core->mainloop->time_free(u->check_death_event);
 585
 586     pa_sap_context_destroy(&u->sap_context);
 587
 588     if (u->by_origin) {
 589         while ((s = pa_hashmap_get_first(u->by_origin)))
 590             session_free(s);
 591
 592         pa_hashmap_free(u->by_origin, NULL, NULL);
 593     }
 594
 595     pa_xfree(u->sink_name);
 596     pa_xfree(u);
 597 }