2 * Copyright (C) <2005,2006> Wim Taymans <wim@fluendo.com>
4 * This library is free software; you can redistribute it and/or
5 * modify it under the terms of the GNU Library General Public
6 * License as published by the Free Software Foundation; either
7 * version 2 of the License, or (at your option) any later version.
9 * This library is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
12 * Library General Public License for more details.
14 * You should have received a copy of the GNU Library General Public
15 * License along with this library; if not, write to the
16 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
17 * Boston, MA 02111-1307, USA.
20 * Unless otherwise indicated, Source Code is licensed under MIT license.
21 * See further explanation attached in License Statement (distributed in the file
24 * Permission is hereby granted, free of charge, to any person obtaining a copy of
25 * this software and associated documentation files (the "Software"), to deal in
26 * the Software without restriction, including without limitation the rights to
27 * use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
28 * of the Software, and to permit persons to whom the Software is furnished to do
29 * so, subject to the following conditions:
31 * The above copyright notice and this permission notice shall be included in all
32 * copies or substantial portions of the Software.
34 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
35 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
36 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
37 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
38 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
39 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
44 * SECTION:gstrtspconnection
45 * @short_description: manage RTSP connections
46 * @see_also: gstrtspurl
50 * This object manages the RTSP connection to the server. It provides function
51 * to receive and send bytes and messages.
55 * Last reviewed on 2007-07-24 (0.10.14)
73 /* we include this here to get the G_OS_* defines */
80 #define EINPROGRESS WSAEINPROGRESS
82 #include <sys/ioctl.h>
84 #include <sys/socket.h>
85 #include <netinet/in.h>
86 #include <arpa/inet.h>
90 #ifdef HAVE_FIONREAD_IN_SYS_FILIO
91 #include <sys/filio.h>
94 #include "gstrtspconnection.h"
95 #include "gstrtspbase64.h"
108 static GstRTSPResult read_line (gint fd, guint8 * buffer, guint * idx,
109 guint size, DecodeCtx * ctxp);
110 static GstRTSPResult parse_key_value (guint8 * buffer, gchar * key,
111 guint keysize, gchar ** value);
112 static void parse_string (gchar * dest, gint size, gchar ** src);
115 #define READ_SOCKET(fd, buf, len) recv (fd, (char *)buf, len, 0)
116 #define WRITE_SOCKET(fd, buf, len) send (fd, (const char *)buf, len, 0)
117 #define SETSOCKOPT(sock, level, name, val, len) setsockopt (sock, level, name, (const char *)val, len)
118 #define CLOSE_SOCKET(sock) closesocket (sock)
119 #define ERRNO_IS_EAGAIN (WSAGetLastError () == WSAEWOULDBLOCK)
120 #define ERRNO_IS_EINTR (WSAGetLastError () == WSAEINTR)
121 /* According to Microsoft's connect() documentation this one returns
122 * WSAEWOULDBLOCK and not WSAEINPROGRESS. */
123 #define ERRNO_IS_EINPROGRESS (WSAGetLastError () == WSAEWOULDBLOCK)
125 #define READ_SOCKET(fd, buf, len) read (fd, buf, len)
126 #define WRITE_SOCKET(fd, buf, len) write (fd, buf, len)
127 #define SETSOCKOPT(sock, level, name, val, len) setsockopt (sock, level, name, val, len)
128 #define CLOSE_SOCKET(sock) close (sock)
129 #define ERRNO_IS_EAGAIN (errno == EAGAIN)
130 #define ERRNO_IS_EINTR (errno == EINTR)
131 #define ERRNO_IS_EINPROGRESS (errno == EINPROGRESS)
134 #define ADD_POLLFD(fdset, pfd, fd) \
137 gst_poll_add_fd (fdset, pfd); \
140 #define REMOVE_POLLFD(fdset, pfd) \
142 if ((pfd)->fd != -1) { \
143 GST_DEBUG ("remove fd %d", (pfd)->fd); \
144 gst_poll_remove_fd (fdset, pfd); \
145 CLOSE_SOCKET ((pfd)->fd); \
155 TUNNEL_STATE_COMPLETE
156 } GstRTSPTunnelState;
158 #define TUNNELID_LEN 24
160 struct _GstRTSPConnection
163 /* URL for the connection */
166 /* connection state */
173 gchar tunnelid[TUNNELID_LEN];
175 GstRTSPTunnelState tstate;
181 gint cseq; /* sequence number */
182 gchar session_id[512]; /* session id */
183 gint timeout; /* session timeout in seconds */
184 GTimer *timer; /* timeout timer */
187 GstRTSPAuthMethod auth_method;
190 GHashTable *auth_params;
198 inet_aton (const char *c, struct in_addr *paddr)
200 /* note that inet_addr is deprecated on unix because
201 * inet_addr returns -1 (INADDR_NONE) for the valid 255.255.255.255
203 paddr->s_addr = inet_addr (c);
205 if (paddr->s_addr == INADDR_NONE)
222 /* a structure for constructing RTSPMessages */
235 build_reset (GstRTSPBuilder * builder)
237 g_free (builder->body_data);
238 memset (builder, 0, sizeof (builder));
242 * gst_rtsp_connection_create:
243 * @url: a #GstRTSPUrl
244 * @conn: storage for a #GstRTSPConnection
246 * Create a newly allocated #GstRTSPConnection from @url and store it in @conn.
247 * The connection will not yet attempt to connect to @url, use
248 * gst_rtsp_connection_connect().
250 * A copy of @url will be made.
252 * Returns: #GST_RTSP_OK when @conn contains a valid connection.
255 gst_rtsp_connection_create (const GstRTSPUrl * url, GstRTSPConnection ** conn)
257 GstRTSPConnection *newconn;
263 g_return_val_if_fail (conn != NULL, GST_RTSP_EINVAL);
266 error = WSAStartup (0x0202, &w);
271 if (w.wVersion != 0x0202)
275 newconn = g_new0 (GstRTSPConnection, 1);
277 if ((newconn->fdset = gst_poll_new (TRUE)) == NULL)
280 newconn->url = gst_rtsp_url_copy (url);
281 newconn->fd0.fd = -1;
282 newconn->fd1.fd = -1;
283 newconn->timer = g_timer_new ();
284 newconn->timeout = 60;
286 newconn->auth_method = GST_RTSP_AUTH_NONE;
287 newconn->username = NULL;
288 newconn->passwd = NULL;
289 newconn->auth_params = NULL;
299 g_warning ("Error %d on WSAStartup", error);
300 return GST_RTSP_EWSASTART;
304 g_warning ("Windows sockets are not version 0x202 (current 0x%x)",
307 return GST_RTSP_EWSAVERSION;
316 return GST_RTSP_ESYS;
321 * gst_rtsp_connection_accept:
323 * @conn: storage for a #GstRTSPConnection
325 * Accept a new connection on @sock and create a new #GstRTSPConnection for
326 * handling communication on new socket.
328 * Returns: #GST_RTSP_OK when @conn contains a valid connection.
333 gst_rtsp_connection_accept (gint sock, GstRTSPConnection ** conn)
336 unsigned int address_len;
337 GstRTSPConnection *newconn = NULL;
338 struct sockaddr_in address;
344 address_len = sizeof (address);
345 memset (&address, 0, address_len);
348 fd = accept (sock, (struct sockaddr *) &address, &address_len);
350 fd = accept (sock, (struct sockaddr *) &address, (gint *) & address_len);
351 #endif /* G_OS_WIN32 */
355 /* set to non-blocking mode so that we can cancel the communication */
357 fcntl (fd, F_SETFL, O_NONBLOCK);
359 ioctlsocket (fd, FIONBIO, &flags);
360 #endif /* G_OS_WIN32 */
362 /* create a url for the client address */
363 url = g_new0 (GstRTSPUrl, 1);
364 url->host = g_strdup_printf ("%s", inet_ntoa (address.sin_addr));
365 url->port = address.sin_port;
367 /* now create the connection object */
368 gst_rtsp_connection_create (url, &newconn);
369 gst_rtsp_url_free (url);
371 ADD_POLLFD (newconn->fdset, &newconn->fd0, fd);
373 /* both read and write initially */
374 newconn->readfd = &newconn->fd0;
375 newconn->writefd = &newconn->fd0;
384 return GST_RTSP_ESYS;
389 do_resolve (const gchar * host)
391 struct hostent *hostinfo;
395 struct in_addr *addrp;
398 gchar ipbuf[INET_ADDRSTRLEN];
399 #endif /* G_OS_WIN32 */
403 /* first check if it already is an IP address */
404 if (inet_aton (host, &addr)) {
407 hostinfo = gethostbyname (host);
409 goto not_resolved; /* h_errno set */
411 if (hostinfo->h_addrtype != AF_INET)
412 goto not_ip; /* host not an IP host */
414 addrp = (struct in_addr *) hostinfo->h_addr_list[0];
415 /* this is not threadsafe */
416 ip = inet_ntoa (*addrp);
418 addrs = hostinfo->h_addr_list;
419 ip = inet_ntop (AF_INET, (struct in_addr *) addrs[0], ipbuf,
421 #endif /* G_OS_WIN32 */
428 GST_ERROR ("could not resolve %s", host);
433 GST_ERROR ("not an IP address");
439 do_connect (const gchar * ip, guint16 port, GstPollFD * fdout,
440 GstPoll * fdset, GTimeVal * timeout)
443 struct sockaddr_in sa_in;
446 unsigned long flags = 1;
447 #endif /* G_OS_WIN32 */
451 memset (&sa_in, 0, sizeof (sa_in));
452 sa_in.sin_family = AF_INET; /* network socket */
453 sa_in.sin_port = htons (port); /* on port */
454 sa_in.sin_addr.s_addr = inet_addr (ip); /* on host ip */
456 fd = socket (AF_INET, SOCK_STREAM, 0);
460 /* set to non-blocking mode so that we can cancel the connect */
462 fcntl (fd, F_SETFL, O_NONBLOCK);
464 ioctlsocket (fd, FIONBIO, &flags);
465 #endif /* G_OS_WIN32 */
467 /* add the socket to our fdset */
468 ADD_POLLFD (fdset, fdout, fd);
470 /* we are going to connect ASYNC now */
471 ret = connect (fd, (struct sockaddr *) &sa_in, sizeof (sa_in));
474 if (!ERRNO_IS_EINPROGRESS)
477 /* wait for connect to complete up to the specified timeout or until we got
479 gst_poll_fd_ctl_write (fdset, fdout, TRUE);
481 to = timeout ? GST_TIMEVAL_TO_TIME (*timeout) : GST_CLOCK_TIME_NONE;
484 retval = gst_poll_wait (fdset, to);
485 } while (retval == -1 && (errno == EINTR || errno == EAGAIN));
489 else if (retval == -1)
492 /* we can still have an error connecting on windows */
493 if (gst_poll_fd_has_error (fdset, fdout)) {
494 socklen_t len = sizeof (errno);
496 getsockopt (fd, SOL_SOCKET, SO_ERROR, &errno, &len);
498 getsockopt (fd, SOL_SOCKET, SO_ERROR, (char *) &errno, &len);
503 gst_poll_fd_ignored (fdset, fdout);
511 GST_ERROR ("no socket %d (%s)", errno, g_strerror (errno));
512 return GST_RTSP_ESYS;
516 GST_ERROR ("system error %d (%s)", errno, g_strerror (errno));
517 REMOVE_POLLFD (fdset, fdout);
518 return GST_RTSP_ESYS;
522 GST_ERROR ("timeout");
523 REMOVE_POLLFD (fdset, fdout);
524 return GST_RTSP_ETIMEOUT;
529 setup_tunneling (GstRTSPConnection * conn, GTimeVal * timeout)
539 gchar codestr[4], *resultstr;
543 /* create a random sessionid */
544 for (i = 0; i < TUNNELID_LEN; i++)
545 conn->tunnelid[i] = g_random_int_range ('a', 'z');
546 conn->tunnelid[TUNNELID_LEN - 1] = '\0';
551 str = g_strdup_printf ("GET %s%s%s HTTP/1.0\r\n"
552 "x-sessioncookie: %s\r\n"
553 "Accept: application/x-rtsp-tunnelled\r\n"
554 "Pragma: no-cache\r\n"
555 "Cache-Control: no-cache\r\n" "\r\n",
556 url->abspath, url->query ? "?" : "", url->query ? url->query : "",
559 /* we start by writing to this fd */
560 conn->writefd = &conn->fd0;
562 res = gst_rtsp_connection_write (conn, (guint8 *) str, strlen (str), timeout);
564 if (res != GST_RTSP_OK)
567 gst_poll_fd_ctl_write (conn->fdset, &conn->fd0, FALSE);
568 gst_poll_fd_ctl_read (conn->fdset, &conn->fd0, TRUE);
570 to = timeout ? GST_TIMEVAL_TO_TIME (*timeout) : GST_CLOCK_TIME_NONE;
578 res = read_line (conn->fd0.fd, buffer, &idx, sizeof (buffer), NULL);
579 if (res == GST_RTSP_EEOF)
581 if (res == GST_RTSP_OK)
583 if (res != GST_RTSP_EINTR)
587 retval = gst_poll_wait (conn->fdset, to);
588 } while (retval == -1 && (errno == EINTR || errno == EAGAIN));
590 /* check for timeout */
602 /* check for last line */
603 if (buffer[0] == '\r')
605 if (buffer[0] == '\0')
609 /* first line, parse response */
610 gchar versionstr[20];
613 bptr = (gchar *) buffer;
615 parse_string (versionstr, sizeof (versionstr), &bptr);
616 parse_string (codestr, sizeof (codestr), &bptr);
617 code = atoi (codestr);
619 while (g_ascii_isspace (*bptr))
630 /* other lines, parse key/value */
631 res = parse_key_value (buffer, key, sizeof (key), &value);
632 if (res == GST_RTSP_OK) {
633 /* we got a new ip address */
634 if (g_ascii_strcasecmp (key, "x-server-ip-address") == 0) {
636 conn->ip = g_strdup (value);
643 if (!(ip = do_resolve (conn->ip)))
646 /* get the port from the url */
647 gst_rtsp_url_get_port (conn->url, &port);
649 /* connect to the host/port */
650 res = do_connect (ip, port, &conn->fd1, conn->fdset, timeout);
651 if (res != GST_RTSP_OK)
654 /* this is now our writing socket */
655 conn->writefd = &conn->fd1;
658 str = g_strdup_printf ("POST %s%s%s HTTP/1.0\r\n"
659 "x-sessioncookie: %s\r\n"
660 "Content-Type: application/x-rtsp-tunnelled\r\n"
661 "Pragma: no-cache\r\n"
662 "Cache-Control: no-cache\r\n"
663 "Content-Length: 32767\r\n"
664 "Expires: Sun, 9 Jan 1972 00:00:00 GMT\r\n"
666 url->abspath, url->query ? "?" : "", url->query ? url->query : "",
669 /* we start by writing to this fd */
670 conn->writefd = &conn->fd1;
672 res = gst_rtsp_connection_write (conn, (guint8 *) str, strlen (str), timeout);
674 if (res != GST_RTSP_OK)
682 GST_ERROR ("write failed (%d)", res);
687 return GST_RTSP_EEOF;
695 return GST_RTSP_ETIMEOUT;
699 return GST_RTSP_ESYS;
703 return GST_RTSP_EINTR;
707 GST_ERROR ("got failure response %d %s", code, resultstr);
708 return GST_RTSP_ERROR;
712 GST_ERROR ("could not resolve %s", conn->ip);
713 return GST_RTSP_ENET;
717 GST_ERROR ("failed to connect");
723 * gst_rtsp_connection_connect:
724 * @conn: a #GstRTSPConnection
725 * @timeout: a #GTimeVal timeout
727 * Attempt to connect to the url of @conn made with
728 * gst_rtsp_connection_create(). If @timeout is #NULL this function can block
729 * forever. If @timeout contains a valid timeout, this function will return
730 * #GST_RTSP_ETIMEOUT after the timeout expired.
732 * This function can be cancelled with gst_rtsp_connection_flush().
734 * Returns: #GST_RTSP_OK when a connection could be made.
737 gst_rtsp_connection_connect (GstRTSPConnection * conn, GTimeVal * timeout)
744 g_return_val_if_fail (conn != NULL, GST_RTSP_EINVAL);
745 g_return_val_if_fail (conn->url != NULL, GST_RTSP_EINVAL);
746 g_return_val_if_fail (conn->fd0.fd < 0, GST_RTSP_EINVAL);
750 if (!(ip = do_resolve (url->host)))
753 /* get the port from the url */
754 gst_rtsp_url_get_port (url, &port);
756 /* connect to the host/port */
757 res = do_connect (ip, port, &conn->fd0, conn->fdset, timeout);
758 if (res != GST_RTSP_OK)
762 conn->ip = g_strdup (ip);
764 /* this is our read URL */
765 conn->readfd = &conn->fd0;
767 if (conn->tunneled) {
768 res = setup_tunneling (conn, timeout);
769 if (res != GST_RTSP_OK)
770 goto tunneling_failed;
772 conn->writefd = &conn->fd0;
779 GST_ERROR ("could not resolve %s", url->host);
780 return GST_RTSP_ENET;
784 GST_ERROR ("failed to connect");
789 GST_ERROR ("failed to setup tunneling");
795 md5_digest_to_hex_string (unsigned char digest[16], char string[33])
797 static const char hexdigits[] = "0123456789abcdef";
800 for (i = 0; i < 16; i++) {
801 string[i * 2] = hexdigits[(digest[i] >> 4) & 0x0f];
802 string[i * 2 + 1] = hexdigits[digest[i] & 0x0f];
808 auth_digest_compute_hex_urp (const gchar * username,
809 const gchar * realm, const gchar * password, gchar hex_urp[33])
811 struct MD5Context md5_context;
812 unsigned char digest[16];
814 MD5Init (&md5_context);
815 MD5Update (&md5_context, username, strlen (username));
816 MD5Update (&md5_context, ":", 1);
817 MD5Update (&md5_context, realm, strlen (realm));
818 MD5Update (&md5_context, ":", 1);
819 MD5Update (&md5_context, password, strlen (password));
820 MD5Final (digest, &md5_context);
821 md5_digest_to_hex_string (digest, hex_urp);
825 auth_digest_compute_response (const gchar * method,
826 const gchar * uri, const gchar * hex_a1, const gchar * nonce,
830 struct MD5Context md5_context;
831 unsigned char digest[16];
834 MD5Init (&md5_context);
835 MD5Update (&md5_context, method, strlen (method));
836 MD5Update (&md5_context, ":", 1);
837 MD5Update (&md5_context, uri, strlen (uri));
838 MD5Final (digest, &md5_context);
839 md5_digest_to_hex_string (digest, hex_a2);
842 MD5Init (&md5_context);
843 MD5Update (&md5_context, hex_a1, strlen (hex_a1));
844 MD5Update (&md5_context, ":", 1);
845 MD5Update (&md5_context, nonce, strlen (nonce));
846 MD5Update (&md5_context, ":", 1);
848 MD5Update (&md5_context, hex_a2, 32);
849 MD5Final (digest, &md5_context);
850 md5_digest_to_hex_string (digest, response);
854 add_auth_header (GstRTSPConnection * conn, GstRTSPMessage * message)
856 switch (conn->auth_method) {
857 case GST_RTSP_AUTH_BASIC:{
859 g_strdup_printf ("%s:%s", conn->username, conn->passwd);
861 gst_rtsp_base64_encode (user_pass, strlen (user_pass));
862 gchar *auth_string = g_strdup_printf ("Basic %s", user_pass64);
864 gst_rtsp_message_take_header (message, GST_RTSP_HDR_AUTHORIZATION,
868 g_free (user_pass64);
871 case GST_RTSP_AUTH_DIGEST:{
872 gchar response[33], hex_urp[33];
873 gchar *auth_string, *auth_string2;
880 /* we need to have some params set */
881 if (conn->auth_params == NULL)
884 /* we need the realm and nonce */
885 realm = (gchar *) g_hash_table_lookup (conn->auth_params, "realm");
886 nonce = (gchar *) g_hash_table_lookup (conn->auth_params, "nonce");
887 if (realm == NULL || nonce == NULL)
890 auth_digest_compute_hex_urp (conn->username, realm, conn->passwd,
893 method = gst_rtsp_method_as_text (message->type_data.request.method);
894 uri = message->type_data.request.uri;
896 /* Assume no qop, algorithm=md5, stale=false */
897 /* For algorithm MD5, a1 = urp. */
898 auth_digest_compute_response (method, uri, hex_urp, nonce, response);
899 auth_string = g_strdup_printf ("Digest username=\"%s\", "
900 "realm=\"%s\", nonce=\"%s\", uri=\"%s\", response=\"%s\"",
901 conn->username, realm, nonce, uri, response);
903 opaque = (gchar *) g_hash_table_lookup (conn->auth_params, "opaque");
905 auth_string2 = g_strdup_printf ("%s, opaque=\"%s\"", auth_string,
907 g_free (auth_string);
908 auth_string = auth_string2;
910 gst_rtsp_message_take_header (message, GST_RTSP_HDR_AUTHORIZATION,
921 gen_date_string (gchar * date_string, guint len)
929 g_get_current_time (&tv);
930 t = (time_t) tv.tv_sec;
933 strftime (date_string, len, "%a, %d %b %Y %H:%M:%S GMT", gmtime_r (&t, &tm_));
935 strftime (date_string, len, "%a, %d %b %Y %H:%M:%S GMT", gmtime (&t));
940 write_bytes (gint fd, const guint8 * buffer, guint * idx, guint size)
945 return GST_RTSP_ERROR;
952 r = WRITE_SOCKET (fd, &buffer[*idx], left);
954 return GST_RTSP_EINTR;
957 return GST_RTSP_EINTR;
959 return GST_RTSP_ESYS;
969 fill_bytes (gint fd, guint8 * buffer, guint size, DecodeCtx * ctx)
977 while (size > 0 && ctx->cout < 3) {
978 /* we have some leftover bytes */
979 *buffer++ = ctx->out[ctx->cout];
984 /* nothing in the buffer */
988 /* try to read more bytes */
989 r = READ_SOCKET (fd, &ctx->in[ctx->cin], 4 - ctx->cin);
998 r = g_base64_decode_step ((const gchar *) ctx->in, 4,
999 (guchar *) ctx->out, &ctx->state, &ctx->save);
1005 out = READ_SOCKET (fd, buffer, size);
1011 static GstRTSPResult
1012 read_bytes (gint fd, guint8 * buffer, guint * idx, guint size, DecodeCtx * ctx)
1017 return GST_RTSP_ERROR;
1024 r = fill_bytes (fd, &buffer[*idx], left, ctx);
1026 return GST_RTSP_EEOF;
1028 if (ERRNO_IS_EAGAIN)
1029 return GST_RTSP_EINTR;
1030 if (!ERRNO_IS_EINTR)
1031 return GST_RTSP_ESYS;
1040 static GstRTSPResult
1041 read_line (gint fd, guint8 * buffer, guint * idx, guint size, DecodeCtx * ctx)
1047 r = fill_bytes (fd, &c, 1, ctx);
1049 return GST_RTSP_EEOF;
1051 if (ERRNO_IS_EAGAIN)
1052 return GST_RTSP_EINTR;
1053 if (!ERRNO_IS_EINTR)
1054 return GST_RTSP_ESYS;
1056 if (c == '\n') /* end on \n */
1058 if (c == '\r') /* ignore \r */
1061 if (*idx < size - 1)
1062 buffer[(*idx)++] = c;
1065 buffer[*idx] = '\0';
1071 * gst_rtsp_connection_write:
1072 * @conn: a #GstRTSPConnection
1073 * @data: the data to write
1074 * @size: the size of @data
1075 * @timeout: a timeout value or #NULL
1077 * Attempt to write @size bytes of @data to the connected @conn, blocking up to
1078 * the specified @timeout. @timeout can be #NULL, in which case this function
1079 * might block forever.
1081 * This function can be cancelled with gst_rtsp_connection_flush().
1083 * Returns: #GST_RTSP_OK on success.
1086 gst_rtsp_connection_write (GstRTSPConnection * conn, const guint8 * data,
1087 guint size, GTimeVal * timeout)
1094 g_return_val_if_fail (conn != NULL, GST_RTSP_EINVAL);
1095 g_return_val_if_fail (data != NULL || size == 0, GST_RTSP_EINVAL);
1096 g_return_val_if_fail (conn->writefd != NULL, GST_RTSP_EINVAL);
1098 gst_poll_set_controllable (conn->fdset, TRUE);
1099 gst_poll_fd_ctl_write (conn->fdset, conn->writefd, TRUE);
1100 gst_poll_fd_ctl_read (conn->fdset, conn->readfd, FALSE);
1101 /* clear all previous poll results */
1102 gst_poll_fd_ignored (conn->fdset, conn->writefd);
1103 gst_poll_fd_ignored (conn->fdset, conn->readfd);
1105 to = timeout ? GST_TIMEVAL_TO_TIME (*timeout) : GST_CLOCK_TIME_NONE;
1111 res = write_bytes (conn->writefd->fd, data, &offset, size);
1112 if (res == GST_RTSP_OK)
1114 if (res != GST_RTSP_EINTR)
1117 /* not all is written, wait until we can write more */
1119 retval = gst_poll_wait (conn->fdset, to);
1120 } while (retval == -1 && (errno == EINTR || errno == EAGAIN));
1137 return GST_RTSP_ETIMEOUT;
1141 return GST_RTSP_ESYS;
1145 return GST_RTSP_EINTR;
1154 message_to_string (GstRTSPConnection * conn, GstRTSPMessage * message)
1156 GString *str = NULL;
1158 str = g_string_new ("");
1160 switch (message->type) {
1161 case GST_RTSP_MESSAGE_REQUEST:
1162 /* create request string, add CSeq */
1163 g_string_append_printf (str, "%s %s RTSP/1.0\r\n"
1165 gst_rtsp_method_as_text (message->type_data.request.method),
1166 message->type_data.request.uri, conn->cseq++);
1167 /* add session id if we have one */
1168 if (conn->session_id[0] != '\0') {
1169 gst_rtsp_message_add_header (message, GST_RTSP_HDR_SESSION,
1172 /* add any authentication headers */
1173 add_auth_header (conn, message);
1175 case GST_RTSP_MESSAGE_RESPONSE:
1176 /* create response string */
1177 g_string_append_printf (str, "RTSP/1.0 %d %s\r\n",
1178 message->type_data.response.code, message->type_data.response.reason);
1180 case GST_RTSP_MESSAGE_DATA:
1182 guint8 data_header[4];
1184 /* prepare data header */
1185 data_header[0] = '$';
1186 data_header[1] = message->type_data.data.channel;
1187 data_header[2] = (message->body_size >> 8) & 0xff;
1188 data_header[3] = message->body_size & 0xff;
1190 /* create string with header and data */
1191 str = g_string_append_len (str, (gchar *) data_header, 4);
1193 g_string_append_len (str, (gchar *) message->body,
1194 message->body_size);
1198 g_string_free (str, TRUE);
1199 g_return_val_if_reached (NULL);
1203 /* append headers and body */
1204 if (message->type != GST_RTSP_MESSAGE_DATA) {
1205 gchar date_string[100];
1207 gen_date_string (date_string, sizeof (date_string));
1209 /* add date header */
1210 gst_rtsp_message_add_header (message, GST_RTSP_HDR_DATE, date_string);
1212 /* append headers */
1213 gst_rtsp_message_append_headers (message, str);
1215 /* append Content-Length and body if needed */
1216 if (message->body != NULL && message->body_size > 0) {
1219 len = g_strdup_printf ("%d", message->body_size);
1220 g_string_append_printf (str, "%s: %s\r\n",
1221 gst_rtsp_header_as_text (GST_RTSP_HDR_CONTENT_LENGTH), len);
1223 /* header ends here */
1224 g_string_append (str, "\r\n");
1226 g_string_append_len (str, (gchar *) message->body,
1227 message->body_size);
1229 /* just end headers */
1230 g_string_append (str, "\r\n");
1238 * gst_rtsp_connection_send:
1239 * @conn: a #GstRTSPConnection
1240 * @message: the message to send
1241 * @timeout: a timeout value or #NULL
1243 * Attempt to send @message to the connected @conn, blocking up to
1244 * the specified @timeout. @timeout can be #NULL, in which case this function
1245 * might block forever.
1247 * This function can be cancelled with gst_rtsp_connection_flush().
1249 * Returns: #GST_RTSP_OK on success.
1252 gst_rtsp_connection_send (GstRTSPConnection * conn, GstRTSPMessage * message,
1255 GString *string = NULL;
1260 g_return_val_if_fail (conn != NULL, GST_RTSP_EINVAL);
1261 g_return_val_if_fail (message != NULL, GST_RTSP_EINVAL);
1263 if (!(string = message_to_string (conn, message)))
1266 if (conn->tunneled) {
1267 str = g_base64_encode ((const guchar *) string->str, string->len);
1268 g_string_free (string, TRUE);
1273 g_string_free (string, FALSE);
1277 res = gst_rtsp_connection_write (conn, (guint8 *) str, len, timeout);
1285 g_warning ("Wrong message");
1286 return GST_RTSP_EINVAL;
1291 parse_string (gchar * dest, gint size, gchar ** src)
1297 while (g_ascii_isspace (**src))
1300 while (!g_ascii_isspace (**src) && **src != '\0') {
1302 dest[idx++] = **src;
1310 parse_key (gchar * dest, gint size, gchar ** src)
1315 while (**src != ':' && **src != '\0') {
1317 dest[idx++] = **src;
1324 static GstRTSPResult
1325 parse_response_status (guint8 * buffer, GstRTSPMessage * msg)
1328 gchar versionstr[20];
1333 bptr = (gchar *) buffer;
1335 parse_string (versionstr, sizeof (versionstr), &bptr);
1336 parse_string (codestr, sizeof (codestr), &bptr);
1337 code = atoi (codestr);
1339 while (g_ascii_isspace (*bptr))
1342 if (strcmp (versionstr, "RTSP/1.0") == 0)
1343 GST_RTSP_CHECK (gst_rtsp_message_init_response (msg, code, bptr, NULL),
1345 else if (strncmp (versionstr, "RTSP/", 5) == 0) {
1346 GST_RTSP_CHECK (gst_rtsp_message_init_response (msg, code, bptr, NULL),
1348 msg->type_data.response.version = GST_RTSP_VERSION_INVALID;
1356 return GST_RTSP_EPARSE;
1360 static GstRTSPResult
1361 parse_request_line (GstRTSPConnection * conn, guint8 * buffer,
1362 GstRTSPMessage * msg)
1364 GstRTSPResult res = GST_RTSP_OK;
1365 gchar versionstr[20];
1366 gchar methodstr[20];
1369 GstRTSPMethod method;
1370 GstRTSPTunnelState tstate = TUNNEL_STATE_NONE;
1372 bptr = (gchar *) buffer;
1374 parse_string (methodstr, sizeof (methodstr), &bptr);
1375 method = gst_rtsp_find_method (methodstr);
1376 if (method == GST_RTSP_INVALID) {
1377 /* a tunnel request is allowed when we don't have one yet */
1378 if (conn->tstate != TUNNEL_STATE_NONE)
1379 goto invalid_method;
1380 /* we need GET or POST for a valid tunnel request */
1381 if (!strcmp (methodstr, "GET"))
1382 tstate = TUNNEL_STATE_GET;
1383 else if (!strcmp (methodstr, "POST"))
1384 tstate = TUNNEL_STATE_POST;
1386 goto invalid_method;
1389 parse_string (urlstr, sizeof (urlstr), &bptr);
1390 if (*urlstr == '\0')
1393 parse_string (versionstr, sizeof (versionstr), &bptr);
1396 goto invalid_version;
1398 if (strcmp (versionstr, "RTSP/1.0") == 0) {
1399 res = gst_rtsp_message_init_request (msg, method, urlstr);
1400 } else if (strncmp (versionstr, "RTSP/", 5) == 0) {
1401 res = gst_rtsp_message_init_request (msg, method, urlstr);
1402 msg->type_data.request.version = GST_RTSP_VERSION_INVALID;
1403 } else if (strcmp (versionstr, "HTTP/1.0") == 0) {
1404 /* tunnel request, we need a tunnel method */
1405 if (tstate == TUNNEL_STATE_NONE) {
1406 res = GST_RTSP_EPARSE;
1408 conn->tstate = tstate;
1411 res = GST_RTSP_EPARSE;
1419 GST_ERROR ("invalid method %s", methodstr);
1420 return GST_RTSP_EPARSE;
1424 GST_ERROR ("invalid url %s", urlstr);
1425 return GST_RTSP_EPARSE;
1429 GST_ERROR ("invalid version");
1430 return GST_RTSP_EPARSE;
1434 static GstRTSPResult
1435 parse_key_value (guint8 * buffer, gchar * key, guint keysize, gchar ** value)
1439 bptr = (gchar *) buffer;
1442 parse_key (key, keysize, &bptr);
1447 while (g_ascii_isspace (*bptr))
1457 return GST_RTSP_EPARSE;
1461 /* parsing lines means reading a Key: Value pair */
1462 static GstRTSPResult
1463 parse_line (GstRTSPConnection * conn, guint8 * buffer, GstRTSPMessage * msg)
1468 GstRTSPHeaderField field;
1470 res = parse_key_value (buffer, key, sizeof (key), &value);
1471 if (res != GST_RTSP_OK)
1474 if (conn->tstate == TUNNEL_STATE_GET || conn->tstate == TUNNEL_STATE_POST) {
1475 /* save the tunnel session in the connection */
1476 if (!strcmp (key, "x-sessioncookie")) {
1477 strncpy (conn->tunnelid, value, TUNNELID_LEN);
1478 conn->tunnelid[TUNNELID_LEN - 1] = '\0';
1479 conn->tunneled = TRUE;
1482 field = gst_rtsp_find_header_field (key);
1483 if (field != GST_RTSP_HDR_INVALID)
1484 gst_rtsp_message_add_header (msg, field, value);
1497 * GST_RTSP_OK when a complete message was read.
1498 * GST_RTSP_EEOF: when the socket is closed
1499 * GST_RTSP_EINTR: when more data is needed.
1500 * GST_RTSP_..: some other error occured.
1502 static GstRTSPResult
1503 build_next (GstRTSPBuilder * builder, GstRTSPMessage * message,
1504 GstRTSPConnection * conn)
1509 switch (builder->state) {
1511 builder->offset = 0;
1513 read_bytes (conn->readfd->fd, (guint8 *) builder->buffer,
1514 &builder->offset, 1, conn->ctxp);
1515 if (res != GST_RTSP_OK)
1518 /* we have 1 bytes now and we can see if this is a data message or
1520 if (builder->buffer[0] == '$') {
1521 /* data message, prepare for the header */
1522 builder->state = STATE_DATA_HEADER;
1525 builder->state = STATE_READ_LINES;
1528 case STATE_DATA_HEADER:
1531 read_bytes (conn->readfd->fd, (guint8 *) builder->buffer,
1532 &builder->offset, 4, conn->ctxp);
1533 if (res != GST_RTSP_OK)
1536 gst_rtsp_message_init_data (message, builder->buffer[1]);
1538 builder->body_len = (builder->buffer[2] << 8) | builder->buffer[3];
1539 builder->body_data = g_malloc (builder->body_len + 1);
1540 builder->body_data[builder->body_len] = '\0';
1541 builder->offset = 0;
1542 builder->state = STATE_DATA_BODY;
1545 case STATE_DATA_BODY:
1548 read_bytes (conn->readfd->fd, builder->body_data, &builder->offset,
1549 builder->body_len, conn->ctxp);
1550 if (res != GST_RTSP_OK)
1553 /* we have the complete body now, store in the message adjusting the
1554 * length to include the traling '\0' */
1555 gst_rtsp_message_take_body (message,
1556 (guint8 *) builder->body_data, builder->body_len + 1);
1557 builder->body_data = NULL;
1558 builder->body_len = 0;
1560 builder->state = STATE_END;
1563 case STATE_READ_LINES:
1565 res = read_line (conn->readfd->fd, builder->buffer, &builder->offset,
1566 sizeof (builder->buffer), conn->ctxp);
1567 if (res != GST_RTSP_OK)
1570 /* we have a regular response */
1571 if (builder->buffer[0] == '\r') {
1572 builder->buffer[0] = '\0';
1575 if (builder->buffer[0] == '\0') {
1578 /* empty line, end of message header */
1579 /* see if there is a Content-Length header */
1580 if (gst_rtsp_message_get_header (message,
1581 GST_RTSP_HDR_CONTENT_LENGTH, &hdrval, 0) == GST_RTSP_OK) {
1582 /* there is, prepare to read the body */
1583 builder->body_len = atol (hdrval);
1584 builder->body_data = g_malloc (builder->body_len + 1);
1585 builder->body_data[builder->body_len] = '\0';
1586 builder->offset = 0;
1587 builder->state = STATE_DATA_BODY;
1589 builder->state = STATE_END;
1594 /* we have a line */
1595 if (builder->line == 0) {
1596 /* first line, check for response status */
1597 if (memcmp (builder->buffer, "RTSP", 4) == 0) {
1598 res = parse_response_status (builder->buffer, message);
1600 res = parse_request_line (conn, builder->buffer, message);
1602 /* the first line must parse without errors */
1603 if (res != GST_RTSP_OK)
1606 /* else just parse the line, ignore errors */
1607 parse_line (conn, builder->buffer, message);
1610 builder->offset = 0;
1617 if (conn->tstate == TUNNEL_STATE_GET) {
1618 res = GST_RTSP_ETGET;
1620 } else if (conn->tstate == TUNNEL_STATE_POST) {
1621 res = GST_RTSP_ETPOST;
1625 if (message->type == GST_RTSP_MESSAGE_DATA) {
1626 /* data messages don't have headers */
1631 /* save session id in the connection for further use */
1632 if (gst_rtsp_message_get_header (message, GST_RTSP_HDR_SESSION,
1633 &session_id, 0) == GST_RTSP_OK) {
1636 maxlen = sizeof (conn->session_id) - 1;
1637 /* the sessionid can have attributes marked with ;
1638 * Make sure we strip them */
1639 for (i = 0; session_id[i] != '\0'; i++) {
1640 if (session_id[i] == ';') {
1645 } while (g_ascii_isspace (session_id[i]));
1646 if (g_str_has_prefix (&session_id[i], "timeout=")) {
1649 /* if we parsed something valid, configure */
1650 if ((to = atoi (&session_id[i + 9])) > 0)
1657 /* make sure to not overflow */
1658 strncpy (conn->session_id, session_id, maxlen);
1659 conn->session_id[maxlen] = '\0';
1665 res = GST_RTSP_ERROR;
1674 * gst_rtsp_connection_read:
1675 * @conn: a #GstRTSPConnection
1676 * @data: the data to read
1677 * @size: the size of @data
1678 * @timeout: a timeout value or #NULL
1680 * Attempt to read @size bytes into @data from the connected @conn, blocking up to
1681 * the specified @timeout. @timeout can be #NULL, in which case this function
1682 * might block forever.
1684 * This function can be cancelled with gst_rtsp_connection_flush().
1686 * Returns: #GST_RTSP_OK on success.
1689 gst_rtsp_connection_read (GstRTSPConnection * conn, guint8 * data, guint size,
1697 g_return_val_if_fail (conn != NULL, GST_RTSP_EINVAL);
1698 g_return_val_if_fail (data != NULL, GST_RTSP_EINVAL);
1699 g_return_val_if_fail (conn->readfd != NULL, GST_RTSP_EINVAL);
1706 /* configure timeout if any */
1707 to = timeout ? GST_TIMEVAL_TO_TIME (*timeout) : GST_CLOCK_TIME_NONE;
1709 gst_poll_set_controllable (conn->fdset, TRUE);
1710 gst_poll_fd_ctl_write (conn->fdset, conn->writefd, FALSE);
1711 gst_poll_fd_ctl_read (conn->fdset, conn->readfd, TRUE);
1714 res = read_bytes (conn->readfd->fd, data, &offset, size, conn->ctxp);
1715 if (res == GST_RTSP_EEOF)
1717 if (res == GST_RTSP_OK)
1719 if (res != GST_RTSP_EINTR)
1723 retval = gst_poll_wait (conn->fdset, to);
1724 } while (retval == -1 && (errno == EINTR || errno == EAGAIN));
1726 /* check for timeout */
1728 goto select_timeout;
1736 gst_poll_set_controllable (conn->fdset, FALSE);
1743 return GST_RTSP_ESYS;
1747 return GST_RTSP_ETIMEOUT;
1751 return GST_RTSP_EINTR;
1755 return GST_RTSP_EEOF;
1764 gen_tunnel_reply (GstRTSPConnection * conn, GstRTSPStatusCode code)
1767 gchar date_string[100];
1768 const gchar *status;
1770 gen_date_string (date_string, sizeof (date_string));
1772 status = gst_rtsp_status_as_text (code);
1773 if (status == NULL) {
1775 status = "Internal Server Error";
1778 str = g_string_new ("");
1781 g_string_append_printf (str, "HTTP/1.0 %d %s\r\n", code, status);
1782 g_string_append_printf (str,
1783 "Server: GStreamer RTSP Server\r\n"
1785 "Connection: close\r\n"
1786 "Cache-Control: no-store\r\n" "Pragma: no-cache\r\n", date_string);
1789 g_string_append_printf (str, "x-server-ip-address: %s\r\n", conn->ip);
1790 g_string_append_printf (str,
1791 "Content-Type: application/x-rtsp-tunnelled\r\n" "\r\n");
1797 * gst_rtsp_connection_receive:
1798 * @conn: a #GstRTSPConnection
1799 * @message: the message to read
1800 * @timeout: a timeout value or #NULL
1802 * Attempt to read into @message from the connected @conn, blocking up to
1803 * the specified @timeout. @timeout can be #NULL, in which case this function
1804 * might block forever.
1806 * This function can be cancelled with gst_rtsp_connection_flush().
1808 * Returns: #GST_RTSP_OK on success.
1811 gst_rtsp_connection_receive (GstRTSPConnection * conn, GstRTSPMessage * message,
1815 GstRTSPBuilder builder = { 0 };
1819 g_return_val_if_fail (conn != NULL, GST_RTSP_EINVAL);
1820 g_return_val_if_fail (message != NULL, GST_RTSP_EINVAL);
1821 g_return_val_if_fail (conn->readfd != NULL, GST_RTSP_EINVAL);
1823 /* configure timeout if any */
1824 to = timeout ? GST_TIMEVAL_TO_TIME (*timeout) : GST_CLOCK_TIME_NONE;
1826 gst_poll_set_controllable (conn->fdset, TRUE);
1827 gst_poll_fd_ctl_write (conn->fdset, conn->writefd, FALSE);
1828 gst_poll_fd_ctl_read (conn->fdset, conn->readfd, TRUE);
1831 res = build_next (&builder, message, conn);
1832 if (res == GST_RTSP_EEOF)
1834 if (res == GST_RTSP_OK)
1836 if (res == GST_RTSP_ETGET) {
1839 /* tunnel GET request, we can reply now */
1840 str = gen_tunnel_reply (conn, GST_RTSP_STS_OK);
1842 gst_rtsp_connection_write (conn, (guint8 *) str->str, str->len,
1844 g_string_free (str, TRUE);
1845 } else if (res == GST_RTSP_ETPOST) {
1846 /* tunnel POST request, return the value, the caller now has to link the
1847 * two connections. */
1849 } else if (res != GST_RTSP_EINTR)
1853 retval = gst_poll_wait (conn->fdset, to);
1854 } while (retval == -1 && (errno == EINTR || errno == EAGAIN));
1856 /* check for timeout */
1858 goto select_timeout;
1866 gst_poll_set_controllable (conn->fdset, FALSE);
1869 /* we have a message here */
1870 build_reset (&builder);
1877 res = GST_RTSP_ESYS;
1882 res = GST_RTSP_ETIMEOUT;
1887 res = GST_RTSP_EINTR;
1892 res = GST_RTSP_EEOF;
1898 build_reset (&builder);
1899 gst_rtsp_message_unset (message);
1905 * gst_rtsp_connection_close:
1906 * @conn: a #GstRTSPConnection
1908 * Close the connected @conn. After this call, the connection is in the same
1909 * state as when it was first created.
1911 * Returns: #GST_RTSP_OK on success.
1914 gst_rtsp_connection_close (GstRTSPConnection * conn)
1916 g_return_val_if_fail (conn != NULL, GST_RTSP_EINVAL);
1921 REMOVE_POLLFD (conn->fdset, &conn->fd0);
1922 REMOVE_POLLFD (conn->fdset, &conn->fd1);
1923 conn->writefd = NULL;
1924 conn->readfd = NULL;
1925 conn->tunneled = FALSE;
1926 conn->tstate = TUNNEL_STATE_NONE;
1928 g_free (conn->username);
1929 conn->username = NULL;
1930 g_free (conn->passwd);
1931 conn->passwd = NULL;
1932 gst_rtsp_connection_clear_auth_params (conn);
1935 conn->session_id[0] = '\0';
1941 * gst_rtsp_connection_free:
1942 * @conn: a #GstRTSPConnection
1944 * Close and free @conn.
1946 * Returns: #GST_RTSP_OK on success.
1949 gst_rtsp_connection_free (GstRTSPConnection * conn)
1953 g_return_val_if_fail (conn != NULL, GST_RTSP_EINVAL);
1955 res = gst_rtsp_connection_close (conn);
1956 gst_poll_free (conn->fdset);
1957 g_timer_destroy (conn->timer);
1958 gst_rtsp_url_free (conn->url);
1968 * gst_rtsp_connection_poll:
1969 * @conn: a #GstRTSPConnection
1970 * @events: a bitmask of #GstRTSPEvent flags to check
1971 * @revents: location for result flags
1972 * @timeout: a timeout
1974 * Wait up to the specified @timeout for the connection to become available for
1975 * at least one of the operations specified in @events. When the function returns
1976 * with #GST_RTSP_OK, @revents will contain a bitmask of available operations on
1979 * @timeout can be #NULL, in which case this function might block forever.
1981 * This function can be cancelled with gst_rtsp_connection_flush().
1983 * Returns: #GST_RTSP_OK on success.
1988 gst_rtsp_connection_poll (GstRTSPConnection * conn, GstRTSPEvent events,
1989 GstRTSPEvent * revents, GTimeVal * timeout)
1994 g_return_val_if_fail (conn != NULL, GST_RTSP_EINVAL);
1995 g_return_val_if_fail (events != 0, GST_RTSP_EINVAL);
1996 g_return_val_if_fail (revents != NULL, GST_RTSP_EINVAL);
1997 g_return_val_if_fail (conn->readfd != NULL, GST_RTSP_EINVAL);
1998 g_return_val_if_fail (conn->writefd != NULL, GST_RTSP_EINVAL);
2000 gst_poll_set_controllable (conn->fdset, TRUE);
2002 /* add fd to writer set when asked to */
2003 gst_poll_fd_ctl_write (conn->fdset, conn->writefd,
2004 events & GST_RTSP_EV_WRITE);
2006 /* add fd to reader set when asked to */
2007 gst_poll_fd_ctl_read (conn->fdset, conn->readfd, events & GST_RTSP_EV_READ);
2009 /* configure timeout if any */
2010 to = timeout ? GST_TIMEVAL_TO_TIME (*timeout) : GST_CLOCK_TIME_NONE;
2013 retval = gst_poll_wait (conn->fdset, to);
2014 } while (retval == -1 && (errno == EINTR || errno == EAGAIN));
2017 goto select_timeout;
2027 if (events & GST_RTSP_EV_READ) {
2028 if (gst_poll_fd_can_read (conn->fdset, conn->readfd))
2029 *revents |= GST_RTSP_EV_READ;
2031 if (events & GST_RTSP_EV_WRITE) {
2032 if (gst_poll_fd_can_write (conn->fdset, conn->writefd))
2033 *revents |= GST_RTSP_EV_WRITE;
2040 return GST_RTSP_ETIMEOUT;
2044 return GST_RTSP_ESYS;
2048 return GST_RTSP_EINTR;
2053 * gst_rtsp_connection_next_timeout:
2054 * @conn: a #GstRTSPConnection
2055 * @timeout: a timeout
2057 * Calculate the next timeout for @conn, storing the result in @timeout.
2059 * Returns: #GST_RTSP_OK.
2062 gst_rtsp_connection_next_timeout (GstRTSPConnection * conn, GTimeVal * timeout)
2068 g_return_val_if_fail (conn != NULL, GST_RTSP_EINVAL);
2069 g_return_val_if_fail (timeout != NULL, GST_RTSP_EINVAL);
2071 elapsed = g_timer_elapsed (conn->timer, &usec);
2072 if (elapsed >= conn->timeout) {
2076 sec = conn->timeout - elapsed;
2079 timeout->tv_sec = sec;
2080 timeout->tv_usec = usec;
2086 * gst_rtsp_connection_reset_timeout:
2087 * @conn: a #GstRTSPConnection
2089 * Reset the timeout of @conn.
2091 * Returns: #GST_RTSP_OK.
2094 gst_rtsp_connection_reset_timeout (GstRTSPConnection * conn)
2096 g_return_val_if_fail (conn != NULL, GST_RTSP_EINVAL);
2098 g_timer_start (conn->timer);
2104 * gst_rtsp_connection_flush:
2105 * @conn: a #GstRTSPConnection
2106 * @flush: start or stop the flush
2108 * Start or stop the flushing action on @conn. When flushing, all current
2109 * and future actions on @conn will return #GST_RTSP_EINTR until the connection
2110 * is set to non-flushing mode again.
2112 * Returns: #GST_RTSP_OK.
2115 gst_rtsp_connection_flush (GstRTSPConnection * conn, gboolean flush)
2117 g_return_val_if_fail (conn != NULL, GST_RTSP_EINVAL);
2119 gst_poll_set_flushing (conn->fdset, flush);
2125 * gst_rtsp_connection_set_auth:
2126 * @conn: a #GstRTSPConnection
2127 * @method: authentication method
2129 * @pass: the password
2131 * Configure @conn for authentication mode @method with @user and @pass as the
2132 * user and password respectively.
2134 * Returns: #GST_RTSP_OK.
2137 gst_rtsp_connection_set_auth (GstRTSPConnection * conn,
2138 GstRTSPAuthMethod method, const gchar * user, const gchar * pass)
2140 g_return_val_if_fail (conn != NULL, GST_RTSP_EINVAL);
2142 if (method == GST_RTSP_AUTH_DIGEST && ((user == NULL || pass == NULL)
2143 || g_strrstr (user, ":") != NULL))
2144 return GST_RTSP_EINVAL;
2146 /* Make sure the username and passwd are being set for authentication */
2147 if (method == GST_RTSP_AUTH_NONE && (user == NULL || pass == NULL))
2148 return GST_RTSP_EINVAL;
2150 /* ":" chars are not allowed in usernames for basic auth */
2151 if (method == GST_RTSP_AUTH_BASIC && g_strrstr (user, ":") != NULL)
2152 return GST_RTSP_EINVAL;
2154 g_free (conn->username);
2155 g_free (conn->passwd);
2157 conn->auth_method = method;
2158 conn->username = g_strdup (user);
2159 conn->passwd = g_strdup (pass);
2166 * @key: ASCII string to hash
2168 * Hashes @key in a case-insensitive manner.
2170 * Returns: the hash code.
2173 str_case_hash (gconstpointer key)
2175 const char *p = key;
2176 guint h = g_ascii_toupper (*p);
2179 for (p += 1; *p != '\0'; p++)
2180 h = (h << 5) - h + g_ascii_toupper (*p);
2187 * @v1: an ASCII string
2188 * @v2: another ASCII string
2190 * Compares @v1 and @v2 in a case-insensitive manner
2192 * Returns: %TRUE if they are equal (modulo case)
2195 str_case_equal (gconstpointer v1, gconstpointer v2)
2197 const char *string1 = v1;
2198 const char *string2 = v2;
2200 return g_ascii_strcasecmp (string1, string2) == 0;
2204 * gst_rtsp_connection_set_auth_param:
2205 * @conn: a #GstRTSPConnection
2206 * @param: authentication directive
2209 * Setup @conn with authentication directives. This is not necesary for
2210 * methods #GST_RTSP_AUTH_NONE and #GST_RTSP_AUTH_BASIC. For
2211 * #GST_RTSP_AUTH_DIGEST, directives should be taken from the digest challenge
2212 * in the WWW-Authenticate response header and can include realm, domain,
2213 * nonce, opaque, stale, algorithm, qop as per RFC2617.
2218 gst_rtsp_connection_set_auth_param (GstRTSPConnection * conn,
2219 const gchar * param, const gchar * value)
2221 g_return_if_fail (conn != NULL);
2222 g_return_if_fail (param != NULL);
2224 if (conn->auth_params == NULL) {
2226 g_hash_table_new_full (str_case_hash, str_case_equal, g_free, g_free);
2228 g_hash_table_insert (conn->auth_params, g_strdup (param), g_strdup (value));
2232 * gst_rtsp_connection_clear_auth_params:
2233 * @conn: a #GstRTSPConnection
2235 * Clear the list of authentication directives stored in @conn.
2240 gst_rtsp_connection_clear_auth_params (GstRTSPConnection * conn)
2242 g_return_if_fail (conn != NULL);
2244 if (conn->auth_params != NULL) {
2245 g_hash_table_destroy (conn->auth_params);
2246 conn->auth_params = NULL;
2250 static GstRTSPResult
2251 set_qos_dscp (gint fd, guint qos_dscp)
2256 struct sockaddr_in6 sa_in6;
2257 struct sockaddr_storage sa_stor;
2259 socklen_t slen = sizeof (sa);
2266 if (getsockname (fd, &sa.sa, &slen) < 0)
2267 goto no_getsockname;
2269 af = sa.sa.sa_family;
2271 /* if this is an IPv4-mapped address then do IPv4 QoS */
2272 if (af == AF_INET6) {
2273 if (IN6_IS_ADDR_V4MAPPED (&sa.sa_in6.sin6_addr))
2277 /* extract and shift 6 bits of the DSCP */
2278 tos = (qos_dscp & 0x3f) << 2;
2282 if (SETSOCKOPT (fd, IPPROTO_IP, IP_TOS, &tos, sizeof (tos)) < 0)
2287 if (SETSOCKOPT (fd, IPPROTO_IPV6, IPV6_TCLASS, &tos, sizeof (tos)) < 0)
2301 return GST_RTSP_ESYS;
2306 return GST_RTSP_ERROR;
2311 * gst_rtsp_connection_set_qos_dscp:
2312 * @conn: a #GstRTSPConnection
2313 * @qos_dscp: DSCP value
2315 * Configure @conn to use the specified DSCP value.
2317 * Returns: #GST_RTSP_OK on success.
2322 gst_rtsp_connection_set_qos_dscp (GstRTSPConnection * conn, guint qos_dscp)
2326 g_return_val_if_fail (conn != NULL, GST_RTSP_EINVAL);
2327 g_return_val_if_fail (conn->readfd != NULL, GST_RTSP_EINVAL);
2328 g_return_val_if_fail (conn->writefd != NULL, GST_RTSP_EINVAL);
2330 res = set_qos_dscp (conn->fd0.fd, qos_dscp);
2331 if (res == GST_RTSP_OK)
2332 res = set_qos_dscp (conn->fd1.fd, qos_dscp);
2339 * gst_rtsp_connection_get_url:
2340 * @conn: a #GstRTSPConnection
2342 * Retrieve the URL of the other end of @conn.
2344 * Returns: The URL. This value remains valid until the
2345 * connection is freed.
2350 gst_rtsp_connection_get_url (const GstRTSPConnection * conn)
2352 g_return_val_if_fail (conn != NULL, NULL);
2358 * gst_rtsp_connection_get_ip:
2359 * @conn: a #GstRTSPConnection
2361 * Retrieve the IP address of the other end of @conn.
2363 * Returns: The IP address as a string. this value remains valid until the
2364 * connection is closed.
2369 gst_rtsp_connection_get_ip (const GstRTSPConnection * conn)
2371 g_return_val_if_fail (conn != NULL, NULL);
2377 * gst_rtsp_connection_set_ip:
2378 * @conn: a #GstRTSPConnection
2379 * @ip: an ip address
2381 * Set the IP address of the server.
2386 gst_rtsp_connection_set_ip (GstRTSPConnection * conn, const gchar * ip)
2388 g_return_if_fail (conn != NULL);
2391 conn->ip = g_strdup (ip);
2395 * gst_rtsp_connection_get_readfd:
2396 * @conn: a #GstRTSPConnection
2398 * Get the file descriptor for reading.
2400 * Returns: the file descriptor used for reading or -1 on error. The file
2401 * descriptor remains valid until the connection is closed.
2406 gst_rtsp_connection_get_readfd (const GstRTSPConnection * conn)
2408 g_return_val_if_fail (conn != NULL, -1);
2409 g_return_val_if_fail (conn->readfd != NULL, -1);
2411 return conn->readfd->fd;
2415 * gst_rtsp_connection_get_writefd:
2416 * @conn: a #GstRTSPConnection
2418 * Get the file descriptor for writing.
2420 * Returns: the file descriptor used for writing or -1 on error. The file
2421 * descriptor remains valid until the connection is closed.
2426 gst_rtsp_connection_get_writefd (const GstRTSPConnection * conn)
2428 g_return_val_if_fail (conn != NULL, -1);
2429 g_return_val_if_fail (conn->writefd != NULL, -1);
2431 return conn->writefd->fd;
2436 * gst_rtsp_connection_set_tunneled:
2437 * @conn: a #GstRTSPConnection
2438 * @tunneled: the new state
2440 * Set the HTTP tunneling state of the connection. This must be configured before
2441 * the @conn is connected.
2446 gst_rtsp_connection_set_tunneled (GstRTSPConnection * conn, gboolean tunneled)
2448 g_return_if_fail (conn != NULL);
2449 g_return_if_fail (conn->readfd == NULL);
2450 g_return_if_fail (conn->writefd == NULL);
2452 conn->tunneled = tunneled;
2456 * gst_rtsp_connection_is_tunneled:
2457 * @conn: a #GstRTSPConnection
2459 * Get the tunneling state of the connection.
2461 * Returns: if @conn is using HTTP tunneling.
2466 gst_rtsp_connection_is_tunneled (const GstRTSPConnection * conn)
2468 g_return_val_if_fail (conn != NULL, FALSE);
2470 return conn->tunneled;
2474 * gst_rtsp_connection_get_tunnelid:
2475 * @conn: a #GstRTSPConnection
2477 * Get the tunnel session id the connection.
2479 * Returns: returns a non-empty string if @conn is being tunneled over HTTP.
2484 gst_rtsp_connection_get_tunnelid (const GstRTSPConnection * conn)
2486 g_return_val_if_fail (conn != NULL, NULL);
2488 if (!conn->tunneled)
2491 return conn->tunnelid;
2495 * gst_rtsp_connection_do_tunnel:
2496 * @conn: a #GstRTSPConnection
2497 * @conn2: a #GstRTSPConnection
2499 * If @conn received the first tunnel connection and @conn2 received
2500 * the second tunnel connection, link the two connections together so that
2501 * @conn manages the tunneled connection.
2503 * After this call, @conn2 cannot be used anymore and must be freed with
2504 * gst_rtsp_connection_free().
2506 * Returns: return GST_RTSP_OK on success.
2511 gst_rtsp_connection_do_tunnel (GstRTSPConnection * conn,
2512 GstRTSPConnection * conn2)
2514 g_return_val_if_fail (conn != NULL, GST_RTSP_EINVAL);
2515 g_return_val_if_fail (conn2 != NULL, GST_RTSP_EINVAL);
2516 g_return_val_if_fail (conn->tstate == TUNNEL_STATE_GET, GST_RTSP_EINVAL);
2517 g_return_val_if_fail (conn2->tstate == TUNNEL_STATE_POST, GST_RTSP_EINVAL);
2518 g_return_val_if_fail (!memcmp (conn2->tunnelid, conn->tunnelid, TUNNELID_LEN),
2521 /* both connections have fd0 as the read/write socket. start by taking the
2522 * socket from conn2 and set it as the socket in conn */
2523 conn->fd1 = conn2->fd0;
2525 /* clean up some of the state of conn2 */
2526 gst_poll_remove_fd (conn2->fdset, &conn2->fd0);
2528 conn2->readfd = conn2->writefd = NULL;
2530 /* We make fd0 the write socket and fd1 the read socket. */
2531 conn->writefd = &conn->fd0;
2532 conn->readfd = &conn->fd1;
2534 conn->tstate = TUNNEL_STATE_COMPLETE;
2536 /* we need base64 decoding for the readfd */
2537 conn->ctx.state = 0;
2541 conn->ctxp = &conn->ctx;
2546 #define READ_COND (G_IO_IN | G_IO_HUP | G_IO_ERR)
2547 #define WRITE_COND (G_IO_OUT | G_IO_ERR)
2555 static GstRTSPRec *queue_response (GstRTSPWatch * watch, GString * str,
2558 /* async functions */
2559 struct _GstRTSPWatch
2563 GstRTSPConnection *conn;
2565 GstRTSPBuilder builder;
2566 GstRTSPMessage message;
2570 gboolean write_added;
2572 /* queued message for transmission */
2579 GstRTSPWatchFuncs funcs;
2582 GDestroyNotify notify;
2586 gst_rtsp_source_prepare (GSource * source, gint * timeout)
2588 GstRTSPWatch *watch = (GstRTSPWatch *) source;
2590 *timeout = (watch->conn->timeout * 1000);
2596 gst_rtsp_source_check (GSource * source)
2598 GstRTSPWatch *watch = (GstRTSPWatch *) source;
2600 if (watch->readfd.revents & READ_COND)
2603 if (watch->writefd.revents & WRITE_COND)
2610 gst_rtsp_source_dispatch (GSource * source, GSourceFunc callback,
2613 GstRTSPWatch *watch = (GstRTSPWatch *) source;
2616 /* first read as much as we can */
2617 if (watch->readfd.revents & READ_COND) {
2619 res = build_next (&watch->builder, &watch->message, watch->conn);
2620 if (res == GST_RTSP_EINTR)
2622 if (res == GST_RTSP_EEOF)
2624 if (res == GST_RTSP_ETGET) {
2626 GstRTSPStatusCode code;
2628 if (watch->funcs.tunnel_start)
2629 code = watch->funcs.tunnel_start (watch, watch->user_data);
2631 code = GST_RTSP_STS_OK;
2633 /* queue the response string */
2634 str = gen_tunnel_reply (watch->conn, code);
2635 queue_response (watch, str, -1);
2636 } else if (res == GST_RTSP_ETPOST) {
2637 /* in the callback the connection should be tunneled with the
2639 if (watch->funcs.tunnel_complete)
2640 watch->funcs.tunnel_complete (watch, watch->user_data);
2641 } else if (res != GST_RTSP_OK)
2644 if (res == GST_RTSP_OK) {
2645 if (watch->funcs.message_received)
2646 watch->funcs.message_received (watch, &watch->message,
2649 gst_rtsp_message_unset (&watch->message);
2651 build_reset (&watch->builder);
2655 if (watch->writefd.revents & WRITE_COND) {
2657 if (watch->write_data == NULL) {
2660 if (!watch->messages)
2663 /* no data, get a new message from the queue */
2664 data = watch->messages->data;
2665 watch->messages = g_list_delete_link (watch->messages, watch->messages);
2667 watch->write_off = 0;
2668 watch->write_len = data->str->len;
2669 watch->write_data = (guint8 *) g_string_free (data->str, FALSE);
2670 watch->write_cseq = data->cseq;
2672 g_slice_free (GstRTSPRec, data);
2675 res = write_bytes (watch->writefd.fd, watch->write_data,
2676 &watch->write_off, watch->write_len);
2677 if (res == GST_RTSP_EINTR)
2679 if (res != GST_RTSP_OK)
2682 if (watch->funcs.message_sent && watch->write_cseq != -1)
2683 watch->funcs.message_sent (watch, watch->write_cseq, watch->user_data);
2686 if (watch->messages == NULL && watch->write_added) {
2687 g_source_remove_poll ((GSource *) watch, &watch->writefd);
2688 watch->write_added = FALSE;
2689 watch->writefd.revents = 0;
2691 g_free (watch->write_data);
2692 watch->write_data = NULL;
2701 if (watch->funcs.closed)
2702 watch->funcs.closed (watch, watch->user_data);
2707 if (watch->funcs.error)
2708 watch->funcs.error (watch, res, watch->user_data);
2714 gst_rtsp_source_finalize (GSource * source)
2716 GstRTSPWatch *watch = (GstRTSPWatch *) source;
2719 build_reset (&watch->builder);
2721 for (walk = watch->messages; walk; walk = g_list_next (walk)) {
2722 GstRTSPRec *data = walk->data;
2724 g_string_free (data->str, TRUE);
2725 g_slice_free (GstRTSPRec, data);
2727 g_list_free (watch->messages);
2728 g_free (watch->write_data);
2731 watch->notify (watch->user_data);
2734 static GSourceFuncs gst_rtsp_source_funcs = {
2735 gst_rtsp_source_prepare,
2736 gst_rtsp_source_check,
2737 gst_rtsp_source_dispatch,
2738 gst_rtsp_source_finalize
2742 * gst_rtsp_watch_new:
2743 * @conn: a #GstRTSPConnection
2744 * @funcs: watch functions
2745 * @user_data: user data to pass to @funcs
2746 * @notify: notify when @user_data is not referenced anymore
2748 * Create a watch object for @conn. The functions provided in @funcs will be
2749 * called with @user_data when activity happened on the watch.
2751 * The new watch is usually created so that it can be attached to a
2752 * maincontext with gst_rtsp_watch_attach().
2754 * @conn must exist for the entire lifetime of the watch.
2756 * Returns: a #GstRTSPWatch that can be used for asynchronous RTSP
2757 * communication. Free with gst_rtsp_watch_unref () after usage.
2762 gst_rtsp_watch_new (GstRTSPConnection * conn,
2763 GstRTSPWatchFuncs * funcs, gpointer user_data, GDestroyNotify notify)
2765 GstRTSPWatch *result;
2767 g_return_val_if_fail (conn != NULL, NULL);
2768 g_return_val_if_fail (funcs != NULL, NULL);
2769 g_return_val_if_fail (conn->readfd != NULL, NULL);
2770 g_return_val_if_fail (conn->writefd != NULL, NULL);
2772 result = (GstRTSPWatch *) g_source_new (&gst_rtsp_source_funcs,
2773 sizeof (GstRTSPWatch));
2775 result->conn = conn;
2776 result->builder.state = STATE_START;
2778 result->readfd.fd = -1;
2779 result->writefd.fd = -1;
2781 gst_rtsp_watch_reset (result);
2783 result->funcs = *funcs;
2784 result->user_data = user_data;
2785 result->notify = notify;
2787 /* only add the read fd, the write fd is only added when we have data
2789 g_source_add_poll ((GSource *) result, &result->readfd);
2795 * gst_rtsp_watch_reset:
2796 * @watch: a #GstRTSPWatch
2798 * Reset @watch, this is usually called after gst_rtsp_connection_do_tunnel()
2799 * when the file descriptors of the connection might have changed.
2804 gst_rtsp_watch_reset (GstRTSPWatch * watch)
2806 if (watch->readfd.fd != -1)
2807 g_source_remove_poll ((GSource *) watch, &watch->readfd);
2808 if (watch->writefd.fd != -1)
2809 g_source_remove_poll ((GSource *) watch, &watch->writefd);
2811 watch->readfd.fd = watch->conn->readfd->fd;
2812 watch->readfd.events = READ_COND;
2813 watch->readfd.revents = 0;
2815 watch->writefd.fd = watch->conn->writefd->fd;
2816 watch->writefd.events = WRITE_COND;
2817 watch->writefd.revents = 0;
2818 watch->write_added = FALSE;
2820 g_source_add_poll ((GSource *) watch, &watch->readfd);
2824 * gst_rtsp_watch_attach:
2825 * @watch: a #GstRTSPWatch
2826 * @context: a GMainContext (if NULL, the default context will be used)
2828 * Adds a #GstRTSPWatch to a context so that it will be executed within that context.
2830 * Returns: the ID (greater than 0) for the watch within the GMainContext.
2835 gst_rtsp_watch_attach (GstRTSPWatch * watch, GMainContext * context)
2837 g_return_val_if_fail (watch != NULL, 0);
2839 return g_source_attach ((GSource *) watch, context);
2843 * gst_rtsp_watch_unref:
2844 * @watch: a #GstRTSPWatch
2846 * Decreases the reference count of @watch by one. If the resulting reference
2847 * count is zero the watch and associated memory will be destroyed.
2852 gst_rtsp_watch_unref (GstRTSPWatch * watch)
2854 g_return_if_fail (watch != NULL);
2856 g_source_unref ((GSource *) watch);
2860 queue_response (GstRTSPWatch * watch, GString * str, guint cseq)
2864 /* make a record with the message as a string ans cseq */
2865 data = g_slice_new (GstRTSPRec);
2869 /* add the record to a queue */
2870 watch->messages = g_list_append (watch->messages, data);
2872 /* make sure the main context will now also check for writability on the
2874 if (!watch->write_added) {
2875 g_source_add_poll ((GSource *) watch, &watch->writefd);
2876 watch->write_added = TRUE;
2883 * gst_rtsp_watch_queue_message:
2884 * @watch: a #GstRTSPWatch
2885 * @message: a #GstRTSPMessage
2887 * Queue a @message for transmission in @watch. The contents of this
2888 * message will be serialized and transmitted when the connection of the
2889 * watch becomes writable.
2891 * The return value of this function will be returned as the cseq argument in
2892 * the message_sent callback.
2894 * Returns: the sequence number of the message or -1 if the cseq could not be
2900 gst_rtsp_watch_queue_message (GstRTSPWatch * watch, GstRTSPMessage * message)
2906 g_return_val_if_fail (watch != NULL, GST_RTSP_EINVAL);
2907 g_return_val_if_fail (message != NULL, GST_RTSP_EINVAL);
2909 /* get the cseq from the message, when we finish writing this message on the
2910 * socket we will have to pass the cseq to the callback. */
2911 if (gst_rtsp_message_get_header (message, GST_RTSP_HDR_CSEQ, &header,
2912 0) == GST_RTSP_OK) {
2913 cseq = atoi (header);
2918 /* make a record with the message as a string ans cseq */
2919 data = queue_response (watch, message_to_string (watch->conn, message), cseq);