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