src/modules/rtp/rtsp_client.c

   1 /***
   2   This file is part of PulseAudio.
   3
   4   Copyright 2008 Colin Guthrie
   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.1 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 <fcntl.h>
  27 #include <stdlib.h>
  28 #include <string.h>
  29 #include <errno.h>
  30 #include <arpa/inet.h>
  31 #include <unistd.h>
  32 #include <sys/ioctl.h>
  33 #include <netinet/in.h>
  34
  35 #ifdef HAVE_SYS_FILIO_H
  36 #include <sys/filio.h>
  37 #endif
  38
  39 #include <pulse/xmalloc.h>
  40
  41 #include <pulsecore/core-error.h>
  42 #include <pulsecore/core-util.h>
  43 #include <pulsecore/socket-util.h>
  44 #include <pulsecore/log.h>
  45 #include <pulsecore/macro.h>
  46 #include <pulsecore/strbuf.h>
  47 #include <pulsecore/ioline.h>
  48
  49 #ifdef HAVE_POLL_H
  50 #include <poll.h>
  51 #else
  52 #include <pulsecore/poll.h>
  53 #endif
  54
  55 #include "rtsp_client.h"
  56
  57 struct pa_rtsp_client {
  58     pa_mainloop_api *mainloop;
  59     char *hostname;
  60     uint16_t port;
  61
  62     pa_socket_client *sc;
  63     pa_ioline *ioline;
  64
  65     pa_rtsp_cb_t callback;
  66
  67     void *userdata;
  68     const char *useragent;
  69
  70     pa_rtsp_state state;
  71     uint8_t waiting;
  72
  73     pa_headerlist* headers;
  74     char *last_header;
  75     pa_strbuf *header_buffer;
  76     pa_headerlist* response_headers;
  77
  78     char *localip;
  79     char *url;
  80     uint16_t rtp_port;
  81     uint32_t cseq;
  82     char *session;
  83     char *transport;
  84 };
  85
  86 pa_rtsp_client* pa_rtsp_client_new(pa_mainloop_api *mainloop, const char* hostname, uint16_t port, const char* useragent) {
  87     pa_rtsp_client *c;
  88
  89     pa_assert(mainloop);
  90     pa_assert(hostname);
  91     pa_assert(port > 0);
  92
  93     c = pa_xnew0(pa_rtsp_client, 1);
  94     c->mainloop = mainloop;
  95     c->hostname = pa_xstrdup(hostname);
  96     c->port = port;
  97     c->headers = pa_headerlist_new();
  98
  99     if (useragent)
 100         c->useragent = useragent;
 101     else
 102         c->useragent = "PulseAudio RTSP Client";
 103
 104     return c;
 105 }
 106
 107
 108 void pa_rtsp_client_free(pa_rtsp_client* c) {
 109     pa_assert(c);
 110
 111     if (c->sc)
 112         pa_socket_client_unref(c->sc);
 113
 114     pa_rtsp_disconnect(c);
 115
 116     pa_xfree(c->hostname);
 117     pa_xfree(c->url);
 118     pa_xfree(c->localip);
 119     pa_xfree(c->session);
 120     pa_xfree(c->transport);
 121     pa_xfree(c->last_header);
 122     if (c->header_buffer)
 123         pa_strbuf_free(c->header_buffer);
 124     if (c->response_headers)
 125         pa_headerlist_free(c->response_headers);
 126     pa_headerlist_free(c->headers);
 127
 128     pa_xfree(c);
 129 }
 130
 131
 132 static void headers_read(pa_rtsp_client *c) {
 133     char* token;
 134     char delimiters[] = ";";
 135
 136     pa_assert(c);
 137     pa_assert(c->response_headers);
 138     pa_assert(c->callback);
 139
 140     /* Deal with a SETUP response */
 141     if (STATE_SETUP == c->state) {
 142         const char* token_state = NULL;
 143         const char* pc = NULL;
 144         c->session = pa_xstrdup(pa_headerlist_gets(c->response_headers, "Session"));
 145         c->transport = pa_xstrdup(pa_headerlist_gets(c->response_headers, "Transport"));
 146
 147         if (!c->session || !c->transport) {
 148             pa_log("Invalid SETUP response.");
 149             return;
 150         }
 151
 152         /* Now parse out the server port component of the response. */
 153         while ((token = pa_split(c->transport, delimiters, &token_state))) {
 154             if ((pc = strstr(token, "="))) {
 155                 if (0 == strncmp(token, "server_port", 11)) {
 156                     pa_atou(pc+1, (uint32_t*)(&c->rtp_port));
 157                     pa_xfree(token);
 158                     break;
 159                 }
 160             }
 161             pa_xfree(token);
 162         }
 163         if (0 == c->rtp_port) {
 164             /* Error no server_port in response */
 165             pa_log("Invalid SETUP response (no port number).");
 166             return;
 167         }
 168     }
 169
 170     /* Call our callback */
 171     c->callback(c, c->state, c->response_headers, c->userdata);
 172 }
 173
 174
 175 static void line_callback(pa_ioline *line, const char *s, void *userdata) {
 176     char *delimpos;
 177     char *s2, *s2p;
 178
 179     pa_rtsp_client *c = userdata;
 180     pa_assert(line);
 181     pa_assert(c);
 182     pa_assert(c->callback);
 183
 184     if (!s) {
 185         /* Keep the ioline/iochannel open as they will be freed automatically */
 186         c->ioline = NULL;
 187         c->callback(c, STATE_DISCONNECTED, NULL, c->userdata);
 188         return;
 189     }
 190
 191     s2 = pa_xstrdup(s);
 192     /* Trim trailing carriage returns */
 193     s2p = s2 + strlen(s2) - 1;
 194     while (s2p >= s2 && '\r' == *s2p) {
 195         *s2p = '\0';
 196         s2p -= 1;
 197     }
 198     if (c->waiting && 0 == strcmp("RTSP/1.0 200 OK", s2)) {
 199         c->waiting = 0;
 200         if (c->response_headers)
 201             pa_headerlist_free(c->response_headers);
 202         c->response_headers = pa_headerlist_new();
 203         goto exit;
 204     }
 205     if (c->waiting) {
 206         pa_log_warn("Unexpected response: %s", s2);
 207         goto exit;;
 208     }
 209     if (!strlen(s2)) {
 210         /* End of headers */
 211         /* We will have a header left from our looping iteration, so add it in :) */
 212         if (c->last_header) {
 213             char *tmp = pa_strbuf_tostring_free(c->header_buffer);
 214             /* This is not a continuation header so let's dump it into our proplist */
 215             pa_headerlist_puts(c->response_headers, c->last_header, tmp);
 216             pa_xfree(tmp);
 217             pa_xfree(c->last_header);
 218             c->last_header = NULL;
 219             c->header_buffer = NULL;
 220         }
 221
 222         pa_log_debug("Full response received. Dispatching");
 223         headers_read(c);
 224         c->waiting = 1;
 225         goto exit;
 226     }
 227
 228     /* Read and parse a header (we know it's not empty) */
 229     /* TODO: Move header reading into the headerlist. */
 230
 231     /* If the first character is a space, it's a continuation header */
 232     if (c->last_header && ' ' == s2[0]) {
 233         pa_assert(c->header_buffer);
 234
 235         /* Add this line to the buffer (sans the space. */
 236         pa_strbuf_puts(c->header_buffer, &(s2[1]));
 237         goto exit;
 238     }
 239
 240     if (c->last_header) {
 241         char *tmp = pa_strbuf_tostring_free(c->header_buffer);
 242         /* This is not a continuation header so let's dump the full
 243           header/value into our proplist */
 244         pa_headerlist_puts(c->response_headers, c->last_header, tmp);
 245         pa_xfree(tmp);
 246         pa_xfree(c->last_header);
 247         c->last_header = NULL;
 248         c->header_buffer = NULL;
 249     }
 250
 251     delimpos = strstr(s2, ":");
 252     if (!delimpos) {
 253         pa_log_warn("Unexpected response when expecting header: %s", s);
 254         goto exit;
 255     }
 256
 257     pa_assert(!c->header_buffer);
 258     pa_assert(!c->last_header);
 259
 260     c->header_buffer = pa_strbuf_new();
 261     if (strlen(delimpos) > 1) {
 262         /* Cut our line off so we can copy the header name out */
 263         *delimpos++ = '\0';
 264
 265         /* Trim the front of any spaces */
 266         while (' ' == *delimpos)
 267             ++delimpos;
 268
 269         pa_strbuf_puts(c->header_buffer, delimpos);
 270     } else {
 271         /* Cut our line off so we can copy the header name out */
 272         *delimpos = '\0';
 273     }
 274
 275     /* Save the header name */
 276     c->last_header = pa_xstrdup(s2);
 277   exit:
 278     pa_xfree(s2);
 279 }
 280
 281
 282 static void on_connection(pa_socket_client *sc, pa_iochannel *io, void *userdata) {
 283     pa_rtsp_client *c = userdata;
 284     union {
 285         struct sockaddr sa;
 286         struct sockaddr_in in;
 287         struct sockaddr_in6 in6;
 288     } sa;
 289     socklen_t sa_len = sizeof(sa);
 290
 291     pa_assert(sc);
 292     pa_assert(c);
 293     pa_assert(STATE_CONNECT == c->state);
 294     pa_assert(c->sc == sc);
 295     pa_socket_client_unref(c->sc);
 296     c->sc = NULL;
 297
 298     if (!io) {
 299         pa_log("Connection failed: %s", pa_cstrerror(errno));
 300         return;
 301     }
 302     pa_assert(!c->ioline);
 303
 304     c->ioline = pa_ioline_new(io);
 305     pa_ioline_set_callback(c->ioline, line_callback, c);
 306
 307     /* Get the local IP address for use externally */
 308     if (0 == getsockname(pa_iochannel_get_recv_fd(io), &sa.sa, &sa_len)) {
 309         char buf[INET6_ADDRSTRLEN];
 310         const char *res = NULL;
 311
 312         if (AF_INET == sa.sa.sa_family) {
 313             if ((res = inet_ntop(sa.sa.sa_family, &sa.in.sin_addr, buf, sizeof(buf)))) {
 314                 c->localip = pa_xstrdup(res);
 315             }
 316         } else if (AF_INET6 == sa.sa.sa_family) {
 317             if ((res = inet_ntop(AF_INET6, &sa.in6.sin6_addr, buf, sizeof(buf)))) {
 318                 c->localip = pa_sprintf_malloc("[%s]", res);
 319             }
 320         }
 321     }
 322     pa_log_debug("Established RTSP connection from local ip %s", c->localip);
 323
 324     if (c->callback)
 325         c->callback(c, c->state, NULL, c->userdata);
 326 }
 327
 328 int pa_rtsp_connect(pa_rtsp_client *c) {
 329     pa_assert(c);
 330     pa_assert(!c->sc);
 331
 332     pa_xfree(c->session);
 333     c->session = NULL;
 334
 335     if (!(c->sc = pa_socket_client_new_string(c->mainloop, TRUE, c->hostname, c->port))) {
 336         pa_log("failed to connect to server '%s:%d'", c->hostname, c->port);
 337         return -1;
 338     }
 339
 340     pa_socket_client_set_callback(c->sc, on_connection, c);
 341     c->waiting = 1;
 342     c->state = STATE_CONNECT;
 343     return 0;
 344 }
 345
 346 void pa_rtsp_set_callback(pa_rtsp_client *c, pa_rtsp_cb_t callback, void *userdata) {
 347     pa_assert(c);
 348
 349     c->callback = callback;
 350     c->userdata = userdata;
 351 }
 352
 353 void pa_rtsp_disconnect(pa_rtsp_client *c) {
 354     pa_assert(c);
 355
 356     if (c->ioline)
 357         pa_ioline_close(c->ioline);
 358     c->ioline = NULL;
 359 }
 360
 361
 362 const char* pa_rtsp_localip(pa_rtsp_client* c) {
 363     pa_assert(c);
 364
 365     return c->localip;
 366 }
 367
 368 uint32_t pa_rtsp_serverport(pa_rtsp_client* c) {
 369     pa_assert(c);
 370
 371     return c->rtp_port;
 372 }
 373
 374 void pa_rtsp_set_url(pa_rtsp_client* c, const char* url) {
 375     pa_assert(c);
 376
 377     c->url = pa_xstrdup(url);
 378 }
 379
 380 void pa_rtsp_add_header(pa_rtsp_client *c, const char* key, const char* value)
 381 {
 382     pa_assert(c);
 383     pa_assert(key);
 384     pa_assert(value);
 385
 386     pa_headerlist_puts(c->headers, key, value);
 387 }
 388
 389 void pa_rtsp_remove_header(pa_rtsp_client *c, const char* key)
 390 {
 391     pa_assert(c);
 392     pa_assert(key);
 393
 394     pa_headerlist_remove(c->headers, key);
 395 }
 396
 397 static int rtsp_exec(pa_rtsp_client* c, const char* cmd,
 398                         const char* content_type, const char* content,
 399                         int expect_response,
 400                         pa_headerlist* headers) {
 401     pa_strbuf* buf;
 402     char* hdrs;
 403
 404     pa_assert(c);
 405     pa_assert(c->url);
 406     pa_assert(cmd);
 407     pa_assert(c->ioline);
 408
 409     pa_log_debug("Sending command: %s", cmd);
 410
 411     buf = pa_strbuf_new();
 412     pa_strbuf_printf(buf, "%s %s RTSP/1.0\r\nCSeq: %d\r\n", cmd, c->url, ++c->cseq);
 413     if (c->session)
 414         pa_strbuf_printf(buf, "Session: %s\r\n", c->session);
 415
 416     /* Add the headers */
 417     if (headers) {
 418         hdrs = pa_headerlist_to_string(headers);
 419         pa_strbuf_puts(buf, hdrs);
 420         pa_xfree(hdrs);
 421     }
 422
 423     if (content_type && content) {
 424         pa_strbuf_printf(buf, "Content-Type: %s\r\nContent-Length: %d\r\n",
 425           content_type, (int)strlen(content));
 426     }
 427
 428     pa_strbuf_printf(buf, "User-Agent: %s\r\n", c->useragent);
 429
 430     if (c->headers) {
 431         hdrs = pa_headerlist_to_string(c->headers);
 432         pa_strbuf_puts(buf, hdrs);
 433         pa_xfree(hdrs);
 434     }
 435
 436     pa_strbuf_puts(buf, "\r\n");
 437
 438     if (content_type && content) {
 439         pa_strbuf_puts(buf, content);
 440     }
 441
 442     /* Our packet is created... now we can send it :) */
 443     hdrs = pa_strbuf_tostring_free(buf);
 444     /*pa_log_debug("Submitting request:");
 445     pa_log_debug(hdrs);*/
 446     pa_ioline_puts(c->ioline, hdrs);
 447     pa_xfree(hdrs);
 448
 449     return 0;
 450 }
 451
 452
 453 int pa_rtsp_announce(pa_rtsp_client *c, const char* sdp) {
 454     pa_assert(c);
 455     if (!sdp)
 456         return -1;
 457
 458     c->state = STATE_ANNOUNCE;
 459     return rtsp_exec(c, "ANNOUNCE", "application/sdp", sdp, 1, NULL);
 460 }
 461
 462
 463 int pa_rtsp_setup(pa_rtsp_client* c) {
 464     pa_headerlist* headers;
 465     int rv;
 466
 467     pa_assert(c);
 468
 469     headers = pa_headerlist_new();
 470     pa_headerlist_puts(headers, "Transport", "RTP/AVP/TCP;unicast;interleaved=0-1;mode=record");
 471
 472     c->state = STATE_SETUP;
 473     rv = rtsp_exec(c, "SETUP", NULL, NULL, 1, headers);
 474     pa_headerlist_free(headers);
 475     return rv;
 476 }
 477
 478
 479 int pa_rtsp_record(pa_rtsp_client* c, uint16_t* seq, uint32_t* rtptime) {
 480     pa_headerlist* headers;
 481     int rv;
 482     char *info;
 483
 484     pa_assert(c);
 485     if (!c->session) {
 486         /* No session in progress */
 487         return -1;
 488     }
 489
 490     /* Todo: Generate these values randomly as per spec */
 491     *seq = *rtptime = 0;
 492
 493     headers = pa_headerlist_new();
 494     pa_headerlist_puts(headers, "Range", "npt=0-");
 495     info = pa_sprintf_malloc("seq=%u;rtptime=%u", *seq, *rtptime);
 496     pa_headerlist_puts(headers, "RTP-Info", info);
 497     pa_xfree(info);
 498
 499     c->state = STATE_RECORD;
 500     rv = rtsp_exec(c, "RECORD", NULL, NULL, 1, headers);
 501     pa_headerlist_free(headers);
 502     return rv;
 503 }
 504
 505
 506 int pa_rtsp_teardown(pa_rtsp_client *c) {
 507     pa_assert(c);
 508
 509     c->state = STATE_TEARDOWN;
 510     return rtsp_exec(c, "TEARDOWN", NULL, NULL, 0, NULL);
 511 }
 512
 513
 514 int pa_rtsp_setparameter(pa_rtsp_client *c, const char* param) {
 515     pa_assert(c);
 516     if (!param)
 517         return -1;
 518
 519     c->state = STATE_SET_PARAMETER;
 520     return rtsp_exec(c, "SET_PARAMETER", "text/parameters", param, 1, NULL);
 521 }
 522
 523
 524 int pa_rtsp_flush(pa_rtsp_client *c, uint16_t seq, uint32_t rtptime) {
 525     pa_headerlist* headers;
 526     int rv;
 527     char *info;
 528
 529     pa_assert(c);
 530
 531     headers = pa_headerlist_new();
 532     info = pa_sprintf_malloc("seq=%u;rtptime=%u", seq, rtptime);
 533     pa_headerlist_puts(headers, "RTP-Info", info);
 534     pa_xfree(info);
 535
 536     c->state = STATE_FLUSH;
 537     rv = rtsp_exec(c, "FLUSH", NULL, NULL, 1, headers);
 538     pa_headerlist_free(headers);
 539     return rv;
 540 }