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