2 * Copyright (C) <2005-2009> Wim Taymans <wim.taymans@gmail.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)
72 /* we include this here to get the G_OS_* defines */
77 /* ws2_32.dll has getaddrinfo and freeaddrinfo on Windows XP and later.
78 * minwg32 headers check WINVER before allowing the use of these */
84 #define EINPROGRESS WSAEINPROGRESS
86 #include <sys/ioctl.h>
88 #include <sys/socket.h>
90 #include <netinet/in.h>
93 #ifdef HAVE_FIONREAD_IN_SYS_FILIO
94 #include <sys/filio.h>
97 #include "gstrtspconnection.h"
98 #include "gstrtspbase64.h"
103 struct sockaddr_in sa_in;
104 struct sockaddr_in6 sa_in6;
105 struct sockaddr_storage sa_stor;
112 guchar out[3]; /* the size must be evenly divisible by 3 */
118 #define READ_SOCKET(fd, buf, len) recv (fd, (char *)buf, len, 0)
119 #define WRITE_SOCKET(fd, buf, len) send (fd, (const char *)buf, len, 0)
120 #define SETSOCKOPT(sock, level, name, val, len) setsockopt (sock, level, name, (const char *)val, len)
121 #define CLOSE_SOCKET(sock) closesocket (sock)
122 #define ERRNO_IS_EAGAIN (WSAGetLastError () == WSAEWOULDBLOCK)
123 #define ERRNO_IS_EINTR (WSAGetLastError () == WSAEINTR)
124 /* According to Microsoft's connect() documentation this one returns
125 * WSAEWOULDBLOCK and not WSAEINPROGRESS. */
126 #define ERRNO_IS_EINPROGRESS (WSAGetLastError () == WSAEWOULDBLOCK)
128 #define READ_SOCKET(fd, buf, len) read (fd, buf, len)
129 #define WRITE_SOCKET(fd, buf, len) write (fd, buf, len)
130 #define SETSOCKOPT(sock, level, name, val, len) setsockopt (sock, level, name, val, len)
131 #define CLOSE_SOCKET(sock) close (sock)
132 #define ERRNO_IS_EAGAIN (errno == EAGAIN)
133 #define ERRNO_IS_EINTR (errno == EINTR)
134 #define ERRNO_IS_EINPROGRESS (errno == EINPROGRESS)
137 #define ADD_POLLFD(fdset, pfd, fd) \
140 gst_poll_add_fd (fdset, pfd); \
143 #define REMOVE_POLLFD(fdset, pfd) \
145 if ((pfd)->fd != -1) { \
146 GST_DEBUG ("remove fd %d", (pfd)->fd); \
147 gst_poll_remove_fd (fdset, pfd); \
148 CLOSE_SOCKET ((pfd)->fd); \
158 TUNNEL_STATE_COMPLETE
159 } GstRTSPTunnelState;
161 #define TUNNELID_LEN 24
163 struct _GstRTSPConnection
166 /* URL for the connection */
169 /* connection state */
176 gboolean manual_http;
178 gchar tunnelid[TUNNELID_LEN];
180 GstRTSPTunnelState tstate;
187 gchar *initial_buffer;
188 gsize initial_buffer_offset;
191 gint cseq; /* sequence number */
192 gchar session_id[512]; /* session id */
193 gint timeout; /* session timeout in seconds */
194 GTimer *timer; /* timeout timer */
197 GstRTSPAuthMethod auth_method;
200 GHashTable *auth_params;
221 READ_AHEAD_EOH = -1, /* end of headers */
222 READ_AHEAD_CRLF = -2,
223 READ_AHEAD_CRLFCR = -3
226 /* a structure for constructing RTSPMessages */
230 GstRTSPResult status;
240 build_reset (GstRTSPBuilder * builder)
242 g_free (builder->body_data);
243 memset (builder, 0, sizeof (GstRTSPBuilder));
247 * gst_rtsp_connection_create:
248 * @url: a #GstRTSPUrl
249 * @conn: storage for a #GstRTSPConnection
251 * Create a newly allocated #GstRTSPConnection from @url and store it in @conn.
252 * The connection will not yet attempt to connect to @url, use
253 * gst_rtsp_connection_connect().
255 * A copy of @url will be made.
257 * Returns: #GST_RTSP_OK when @conn contains a valid connection.
260 gst_rtsp_connection_create (const GstRTSPUrl * url, GstRTSPConnection ** conn)
262 GstRTSPConnection *newconn;
268 g_return_val_if_fail (conn != NULL, GST_RTSP_EINVAL);
271 error = WSAStartup (0x0202, &w);
276 if (w.wVersion != 0x0202)
280 newconn = g_new0 (GstRTSPConnection, 1);
282 if ((newconn->fdset = gst_poll_new (TRUE)) == NULL)
285 newconn->url = gst_rtsp_url_copy (url);
286 newconn->fd0.fd = -1;
287 newconn->fd1.fd = -1;
288 newconn->timer = g_timer_new ();
289 newconn->timeout = 60;
292 newconn->auth_method = GST_RTSP_AUTH_NONE;
293 newconn->username = NULL;
294 newconn->passwd = NULL;
295 newconn->auth_params = NULL;
305 g_warning ("Error %d on WSAStartup", error);
306 return GST_RTSP_EWSASTART;
310 g_warning ("Windows sockets are not version 0x202 (current 0x%x)",
313 return GST_RTSP_EWSAVERSION;
322 return GST_RTSP_ESYS;
327 * gst_rtsp_connection_create_from_fd:
328 * @fd: a file descriptor
329 * @ip: the IP address of the other end
330 * @port: the port used by the other end
331 * @initial_buffer: data already read from @fd
332 * @conn: storage for a #GstRTSPConnection
334 * Create a new #GstRTSPConnection for handling communication on the existing
335 * file descriptor @fd. The @initial_buffer contains any data already read from
336 * @fd which should be used before starting to read new data.
338 * Returns: #GST_RTSP_OK when @conn contains a valid connection.
343 gst_rtsp_connection_create_from_fd (gint fd, const gchar * ip, guint16 port,
344 const gchar * initial_buffer, GstRTSPConnection ** conn)
346 GstRTSPConnection *newconn = NULL;
353 g_return_val_if_fail (fd >= 0, GST_RTSP_EINVAL);
354 g_return_val_if_fail (ip != NULL, GST_RTSP_EINVAL);
355 g_return_val_if_fail (conn != NULL, GST_RTSP_EINVAL);
357 /* set to non-blocking mode so that we can cancel the communication */
359 fcntl (fd, F_SETFL, O_NONBLOCK);
361 ioctlsocket (fd, FIONBIO, &flags);
362 #endif /* G_OS_WIN32 */
364 /* create a url for the client address */
365 url = g_new0 (GstRTSPUrl, 1);
366 url->host = g_strdup (ip);
369 /* now create the connection object */
370 GST_RTSP_CHECK (gst_rtsp_connection_create (url, &newconn), newconn_failed);
371 gst_rtsp_url_free (url);
373 ADD_POLLFD (newconn->fdset, &newconn->fd0, fd);
375 /* both read and write initially */
376 newconn->readfd = &newconn->fd0;
377 newconn->writefd = &newconn->fd0;
379 newconn->ip = g_strdup (ip);
381 newconn->initial_buffer = g_strdup (initial_buffer);
390 gst_rtsp_url_free (url);
396 * gst_rtsp_connection_accept:
398 * @conn: storage for a #GstRTSPConnection
400 * Accept a new connection on @sock and create a new #GstRTSPConnection for
401 * handling communication on new socket.
403 * Returns: #GST_RTSP_OK when @conn contains a valid connection.
408 gst_rtsp_connection_accept (gint sock, GstRTSPConnection ** conn)
411 union gst_sockaddr sa;
412 socklen_t slen = sizeof (sa);
413 gchar ip[INET6_ADDRSTRLEN];
416 g_return_val_if_fail (sock >= 0, GST_RTSP_EINVAL);
417 g_return_val_if_fail (conn != NULL, GST_RTSP_EINVAL);
419 memset (&sa, 0, slen);
422 fd = accept (sock, &sa.sa, &slen);
424 fd = accept (sock, &sa.sa, (gint *) & slen);
425 #endif /* G_OS_WIN32 */
429 if (getnameinfo (&sa.sa, slen, ip, sizeof (ip), NULL, 0, NI_NUMERICHOST) != 0)
430 goto getnameinfo_failed;
432 if (sa.sa.sa_family == AF_INET)
433 port = sa.sa_in.sin_port;
434 else if (sa.sa.sa_family == AF_INET6)
435 port = sa.sa_in6.sin6_port;
439 return gst_rtsp_connection_create_from_fd (fd, ip, port, NULL, conn);
444 return GST_RTSP_ESYS;
450 return GST_RTSP_ERROR;
455 do_resolve (const gchar * host)
457 static gchar ip[INET6_ADDRSTRLEN];
458 struct addrinfo *aires;
462 aierr = getaddrinfo (host, NULL, NULL, &aires);
466 for (ai = aires; ai; ai = ai->ai_next) {
467 if (ai->ai_family == AF_INET || ai->ai_family == AF_INET6) {
474 aierr = getnameinfo (ai->ai_addr, ai->ai_addrlen, ip, sizeof (ip), NULL, 0,
475 NI_NUMERICHOST | NI_NUMERICSERV);
479 freeaddrinfo (aires);
481 return g_strdup (ip);
486 GST_ERROR ("no addrinfo found for %s: %s", host, gai_strerror (aierr));
491 GST_ERROR ("no family found for %s", host);
492 freeaddrinfo (aires);
497 GST_ERROR ("no address found for %s: %s", host, gai_strerror (aierr));
498 freeaddrinfo (aires);
504 do_connect (const gchar * ip, guint16 port, GstPollFD * fdout,
505 GstPoll * fdset, GTimeVal * timeout)
508 struct addrinfo hints;
509 struct addrinfo *aires;
512 gchar service[NI_MAXSERV];
515 unsigned long flags = 1;
516 #endif /* G_OS_WIN32 */
520 memset (&hints, 0, sizeof hints);
521 hints.ai_flags = AI_NUMERICHOST;
522 hints.ai_family = AF_UNSPEC;
523 hints.ai_socktype = SOCK_STREAM;
524 g_snprintf (service, sizeof (service) - 1, "%hu", port);
525 service[sizeof (service) - 1] = '\0';
527 aierr = getaddrinfo (ip, service, &hints, &aires);
531 for (ai = aires; ai; ai = ai->ai_next) {
532 if (ai->ai_family == AF_INET || ai->ai_family == AF_INET6) {
539 fd = socket (ai->ai_family, SOCK_STREAM, 0);
543 /* set to non-blocking mode so that we can cancel the connect */
545 fcntl (fd, F_SETFL, O_NONBLOCK);
547 ioctlsocket (fd, FIONBIO, &flags);
548 #endif /* G_OS_WIN32 */
550 /* add the socket to our fdset */
551 ADD_POLLFD (fdset, fdout, fd);
553 /* we are going to connect ASYNC now */
554 ret = connect (fd, ai->ai_addr, ai->ai_addrlen);
557 if (!ERRNO_IS_EINPROGRESS)
560 /* wait for connect to complete up to the specified timeout or until we got
562 gst_poll_fd_ctl_write (fdset, fdout, TRUE);
564 to = timeout ? GST_TIMEVAL_TO_TIME (*timeout) : GST_CLOCK_TIME_NONE;
567 retval = gst_poll_wait (fdset, to);
568 } while (retval == -1 && (errno == EINTR || errno == EAGAIN));
572 else if (retval == -1)
575 /* we can still have an error connecting on windows */
576 if (gst_poll_fd_has_error (fdset, fdout)) {
577 socklen_t len = sizeof (errno);
579 getsockopt (fd, SOL_SOCKET, SO_ERROR, &errno, &len);
581 getsockopt (fd, SOL_SOCKET, SO_ERROR, (char *) &errno, &len);
586 gst_poll_fd_ignored (fdset, fdout);
589 freeaddrinfo (aires);
596 GST_ERROR ("no addrinfo found for %s: %s", ip, gai_strerror (aierr));
597 return GST_RTSP_ERROR;
601 GST_ERROR ("no family found for %s", ip);
602 freeaddrinfo (aires);
603 return GST_RTSP_ERROR;
607 GST_ERROR ("no socket %d (%s)", errno, g_strerror (errno));
608 freeaddrinfo (aires);
609 return GST_RTSP_ESYS;
613 GST_ERROR ("system error %d (%s)", errno, g_strerror (errno));
614 REMOVE_POLLFD (fdset, fdout);
615 freeaddrinfo (aires);
616 return GST_RTSP_ESYS;
620 GST_ERROR ("timeout");
621 REMOVE_POLLFD (fdset, fdout);
622 freeaddrinfo (aires);
623 return GST_RTSP_ETIMEOUT;
628 setup_tunneling (GstRTSPConnection * conn, GTimeVal * timeout)
635 guint16 port, url_port;
639 GstRTSPMessage response;
641 memset (&response, 0, sizeof (response));
642 gst_rtsp_message_init (&response);
644 /* create a random sessionid */
645 for (i = 0; i < TUNNELID_LEN; i++)
646 conn->tunnelid[i] = g_random_int_range ('a', 'z');
647 conn->tunnelid[TUNNELID_LEN - 1] = '\0';
650 /* get the port from the url */
651 gst_rtsp_url_get_port (url, &url_port);
653 if (conn->proxy_host) {
654 uri = g_strdup_printf ("http://%s:%d%s%s%s", url->host, url_port,
655 url->abspath, url->query ? "?" : "", url->query ? url->query : "");
656 hostparam = g_strdup_printf ("%s:%d", url->host, url_port);
657 ip = conn->proxy_host;
658 port = conn->proxy_port;
660 uri = g_strdup_printf ("%s%s%s", url->abspath, url->query ? "?" : "",
661 url->query ? url->query : "");
667 /* create the GET request for the read connection */
668 GST_RTSP_CHECK (gst_rtsp_message_new_request (&msg, GST_RTSP_GET, uri),
670 msg->type = GST_RTSP_MESSAGE_HTTP_REQUEST;
672 if (hostparam != NULL)
673 gst_rtsp_message_add_header (msg, GST_RTSP_HDR_HOST, hostparam);
674 gst_rtsp_message_add_header (msg, GST_RTSP_HDR_X_SESSIONCOOKIE,
676 gst_rtsp_message_add_header (msg, GST_RTSP_HDR_ACCEPT,
677 "application/x-rtsp-tunnelled");
678 gst_rtsp_message_add_header (msg, GST_RTSP_HDR_CACHE_CONTROL, "no-cache");
679 gst_rtsp_message_add_header (msg, GST_RTSP_HDR_PRAGMA, "no-cache");
681 /* we start by writing to this fd */
682 conn->writefd = &conn->fd0;
684 /* we need to temporarily set conn->tunneled to FALSE to prevent the HTTP
685 * request from being base64 encoded */
686 conn->tunneled = FALSE;
687 GST_RTSP_CHECK (gst_rtsp_connection_send (conn, msg, timeout), write_failed);
688 gst_rtsp_message_free (msg);
689 conn->tunneled = TRUE;
691 /* receive the response to the GET request */
692 /* we need to temporarily set manual_http to TRUE since
693 * gst_rtsp_connection_receive() will treat the HTTP response as a parsing
694 * failure otherwise */
695 conn->manual_http = TRUE;
696 GST_RTSP_CHECK (gst_rtsp_connection_receive (conn, &response, timeout),
698 conn->manual_http = FALSE;
700 if (response.type != GST_RTSP_MESSAGE_HTTP_RESPONSE ||
701 response.type_data.response.code != GST_RTSP_STS_OK)
704 if (gst_rtsp_message_get_header (&response, GST_RTSP_HDR_X_SERVER_IP_ADDRESS,
705 &value, 0) != GST_RTSP_OK) {
706 if (conn->proxy_host) {
707 /* if we use a proxy we need to change the destination url */
709 url->host = g_strdup (value);
711 hostparam = g_strdup_printf ("%s:%d", url->host, url_port);
713 /* and resolve the new ip address */
714 if (!(ip = do_resolve (conn->ip)))
721 /* connect to the host/port */
722 res = do_connect (ip, port, &conn->fd1, conn->fdset, timeout);
723 if (res != GST_RTSP_OK)
726 /* this is now our writing socket */
727 conn->writefd = &conn->fd1;
729 /* create the POST request for the write connection */
730 GST_RTSP_CHECK (gst_rtsp_message_new_request (&msg, GST_RTSP_POST, uri),
732 msg->type = GST_RTSP_MESSAGE_HTTP_REQUEST;
734 if (hostparam != NULL)
735 gst_rtsp_message_add_header (msg, GST_RTSP_HDR_HOST, hostparam);
736 gst_rtsp_message_add_header (msg, GST_RTSP_HDR_X_SESSIONCOOKIE,
738 gst_rtsp_message_add_header (msg, GST_RTSP_HDR_ACCEPT,
739 "application/x-rtsp-tunnelled");
740 gst_rtsp_message_add_header (msg, GST_RTSP_HDR_CACHE_CONTROL, "no-cache");
741 gst_rtsp_message_add_header (msg, GST_RTSP_HDR_PRAGMA, "no-cache");
742 gst_rtsp_message_add_header (msg, GST_RTSP_HDR_EXPIRES,
743 "Sun, 9 Jan 1972 00:00:00 GMT");
744 gst_rtsp_message_add_header (msg, GST_RTSP_HDR_CONTENT_LENGTH, "32767");
746 /* we need to temporarily set conn->tunneled to FALSE to prevent the HTTP
747 * request from being base64 encoded */
748 conn->tunneled = FALSE;
749 GST_RTSP_CHECK (gst_rtsp_connection_send (conn, msg, timeout), write_failed);
750 gst_rtsp_message_free (msg);
751 conn->tunneled = TRUE;
754 gst_rtsp_message_unset (&response);
763 GST_ERROR ("failed to create request (%d)", res);
768 GST_ERROR ("write failed (%d)", res);
769 gst_rtsp_message_free (msg);
770 conn->tunneled = TRUE;
775 GST_ERROR ("read failed (%d)", res);
776 conn->manual_http = FALSE;
781 GST_ERROR ("got failure response %d %s", response.type_data.response.code,
782 response.type_data.response.reason);
783 res = GST_RTSP_ERROR;
788 GST_ERROR ("could not resolve %s", conn->ip);
794 GST_ERROR ("failed to connect");
800 * gst_rtsp_connection_connect:
801 * @conn: a #GstRTSPConnection
802 * @timeout: a #GTimeVal timeout
804 * Attempt to connect to the url of @conn made with
805 * gst_rtsp_connection_create(). If @timeout is #NULL this function can block
806 * forever. If @timeout contains a valid timeout, this function will return
807 * #GST_RTSP_ETIMEOUT after the timeout expired.
809 * This function can be cancelled with gst_rtsp_connection_flush().
811 * Returns: #GST_RTSP_OK when a connection could be made.
814 gst_rtsp_connection_connect (GstRTSPConnection * conn, GTimeVal * timeout)
821 g_return_val_if_fail (conn != NULL, GST_RTSP_EINVAL);
822 g_return_val_if_fail (conn->url != NULL, GST_RTSP_EINVAL);
823 g_return_val_if_fail (conn->fd0.fd < 0, GST_RTSP_EINVAL);
827 if (conn->proxy_host && conn->tunneled) {
828 if (!(ip = do_resolve (conn->proxy_host))) {
829 GST_ERROR ("could not resolve %s", conn->proxy_host);
832 port = conn->proxy_port;
833 g_free (conn->proxy_host);
834 conn->proxy_host = ip;
836 if (!(ip = do_resolve (url->host))) {
837 GST_ERROR ("could not resolve %s", url->host);
840 /* get the port from the url */
841 gst_rtsp_url_get_port (url, &port);
847 /* connect to the host/port */
848 res = do_connect (ip, port, &conn->fd0, conn->fdset, timeout);
849 if (res != GST_RTSP_OK)
852 /* this is our read URL */
853 conn->readfd = &conn->fd0;
855 if (conn->tunneled) {
856 res = setup_tunneling (conn, timeout);
857 if (res != GST_RTSP_OK)
858 goto tunneling_failed;
860 conn->writefd = &conn->fd0;
867 return GST_RTSP_ENET;
871 GST_ERROR ("failed to connect");
876 GST_ERROR ("failed to setup tunneling");
882 auth_digest_compute_hex_urp (const gchar * username,
883 const gchar * realm, const gchar * password, gchar hex_urp[33])
885 GChecksum *md5_context = g_checksum_new (G_CHECKSUM_MD5);
886 const gchar *digest_string;
888 g_checksum_update (md5_context, (const guchar *) username, strlen (username));
889 g_checksum_update (md5_context, (const guchar *) ":", 1);
890 g_checksum_update (md5_context, (const guchar *) realm, strlen (realm));
891 g_checksum_update (md5_context, (const guchar *) ":", 1);
892 g_checksum_update (md5_context, (const guchar *) password, strlen (password));
893 digest_string = g_checksum_get_string (md5_context);
895 memset (hex_urp, 0, 33);
896 memcpy (hex_urp, digest_string, strlen (digest_string));
898 g_checksum_free (md5_context);
902 auth_digest_compute_response (const gchar * method,
903 const gchar * uri, const gchar * hex_a1, const gchar * nonce,
906 char hex_a2[33] = { 0, };
907 GChecksum *md5_context = g_checksum_new (G_CHECKSUM_MD5);
908 const gchar *digest_string;
911 g_checksum_update (md5_context, (const guchar *) method, strlen (method));
912 g_checksum_update (md5_context, (const guchar *) ":", 1);
913 g_checksum_update (md5_context, (const guchar *) uri, strlen (uri));
914 digest_string = g_checksum_get_string (md5_context);
915 memcpy (hex_a2, digest_string, strlen (digest_string));
918 #if GLIB_CHECK_VERSION (2, 18, 0)
919 g_checksum_reset (md5_context);
921 g_checksum_free (md5_context);
922 md5_context = g_checksum_new (G_CHECKSUM_MD5);
924 g_checksum_update (md5_context, (const guchar *) hex_a1, strlen (hex_a1));
925 g_checksum_update (md5_context, (const guchar *) ":", 1);
926 g_checksum_update (md5_context, (const guchar *) nonce, strlen (nonce));
927 g_checksum_update (md5_context, (const guchar *) ":", 1);
929 g_checksum_update (md5_context, (const guchar *) hex_a2, 32);
930 digest_string = g_checksum_get_string (md5_context);
931 memset (response, 0, 33);
932 memcpy (response, digest_string, strlen (digest_string));
934 g_checksum_free (md5_context);
938 add_auth_header (GstRTSPConnection * conn, GstRTSPMessage * message)
940 switch (conn->auth_method) {
941 case GST_RTSP_AUTH_BASIC:{
946 user_pass = g_strdup_printf ("%s:%s", conn->username, conn->passwd);
947 user_pass64 = g_base64_encode ((guchar *) user_pass, strlen (user_pass));
948 auth_string = g_strdup_printf ("Basic %s", user_pass64);
950 gst_rtsp_message_take_header (message, GST_RTSP_HDR_AUTHORIZATION,
954 g_free (user_pass64);
957 case GST_RTSP_AUTH_DIGEST:{
958 gchar response[33], hex_urp[33];
959 gchar *auth_string, *auth_string2;
966 /* we need to have some params set */
967 if (conn->auth_params == NULL)
970 /* we need the realm and nonce */
971 realm = (gchar *) g_hash_table_lookup (conn->auth_params, "realm");
972 nonce = (gchar *) g_hash_table_lookup (conn->auth_params, "nonce");
973 if (realm == NULL || nonce == NULL)
976 auth_digest_compute_hex_urp (conn->username, realm, conn->passwd,
979 method = gst_rtsp_method_as_text (message->type_data.request.method);
980 uri = message->type_data.request.uri;
982 /* Assume no qop, algorithm=md5, stale=false */
983 /* For algorithm MD5, a1 = urp. */
984 auth_digest_compute_response (method, uri, hex_urp, nonce, response);
985 auth_string = g_strdup_printf ("Digest username=\"%s\", "
986 "realm=\"%s\", nonce=\"%s\", uri=\"%s\", response=\"%s\"",
987 conn->username, realm, nonce, uri, response);
989 opaque = (gchar *) g_hash_table_lookup (conn->auth_params, "opaque");
991 auth_string2 = g_strdup_printf ("%s, opaque=\"%s\"", auth_string,
993 g_free (auth_string);
994 auth_string = auth_string2;
996 gst_rtsp_message_take_header (message, GST_RTSP_HDR_AUTHORIZATION,
1007 gen_date_string (gchar * date_string, guint len)
1011 #ifdef HAVE_GMTIME_R
1015 g_get_current_time (&tv);
1016 t = (time_t) tv.tv_sec;
1018 #ifdef HAVE_GMTIME_R
1019 strftime (date_string, len, "%a, %d %b %Y %H:%M:%S GMT", gmtime_r (&t, &tm_));
1021 strftime (date_string, len, "%a, %d %b %Y %H:%M:%S GMT", gmtime (&t));
1025 static GstRTSPResult
1026 write_bytes (gint fd, const guint8 * buffer, guint * idx, guint size)
1030 if (G_UNLIKELY (*idx > size))
1031 return GST_RTSP_ERROR;
1038 r = WRITE_SOCKET (fd, &buffer[*idx], left);
1039 if (G_UNLIKELY (r == 0)) {
1040 return GST_RTSP_EINTR;
1041 } else if (G_UNLIKELY (r < 0)) {
1042 if (ERRNO_IS_EAGAIN)
1043 return GST_RTSP_EINTR;
1044 if (!ERRNO_IS_EINTR)
1045 return GST_RTSP_ESYS;
1055 fill_raw_bytes (GstRTSPConnection * conn, guint8 * buffer, guint size)
1059 if (G_UNLIKELY (conn->initial_buffer != NULL)) {
1060 gsize left = strlen (&conn->initial_buffer[conn->initial_buffer_offset]);
1062 out = MIN (left, size);
1063 memcpy (buffer, &conn->initial_buffer[conn->initial_buffer_offset], out);
1065 if (left == (gsize) out) {
1066 g_free (conn->initial_buffer);
1067 conn->initial_buffer = NULL;
1068 conn->initial_buffer_offset = 0;
1070 conn->initial_buffer_offset += out;
1073 if (G_LIKELY (size > (guint) out)) {
1076 r = READ_SOCKET (conn->readfd->fd, &buffer[out], size - out);
1088 fill_bytes (GstRTSPConnection * conn, guint8 * buffer, guint size)
1090 DecodeCtx *ctx = conn->ctxp;
1095 guint8 in[sizeof (ctx->out) * 4 / 3];
1098 while (size > 0 && ctx->cout < ctx->coutl) {
1099 /* we have some leftover bytes */
1100 *buffer++ = ctx->out[ctx->cout++];
1105 /* got what we needed? */
1109 /* try to read more bytes */
1110 r = fill_raw_bytes (conn, in, sizeof (in));
1119 g_base64_decode_step ((gchar *) in, r, ctx->out, &ctx->state,
1123 out = fill_raw_bytes (conn, buffer, size);
1129 static GstRTSPResult
1130 read_bytes (GstRTSPConnection * conn, guint8 * buffer, guint * idx, guint size)
1134 if (G_UNLIKELY (*idx > size))
1135 return GST_RTSP_ERROR;
1142 r = fill_bytes (conn, &buffer[*idx], left);
1143 if (G_UNLIKELY (r == 0)) {
1144 return GST_RTSP_EEOF;
1145 } else if (G_UNLIKELY (r < 0)) {
1146 if (ERRNO_IS_EAGAIN)
1147 return GST_RTSP_EINTR;
1148 if (!ERRNO_IS_EINTR)
1149 return GST_RTSP_ESYS;
1158 /* The code below tries to handle clients using \r, \n or \r\n to indicate the
1159 * end of a line. It even does its best to handle clients which mix them (even
1160 * though this is a really stupid idea (tm).) It also handles Line White Space
1161 * (LWS), where a line end followed by whitespace is considered LWS. This is
1162 * the method used in RTSP (and HTTP) to break long lines.
1164 static GstRTSPResult
1165 read_line (GstRTSPConnection * conn, guint8 * buffer, guint * idx, guint size)
1171 if (conn->read_ahead == READ_AHEAD_EOH) {
1172 /* the last call to read_line() already determined that we have reached
1173 * the end of the headers, so convey that information now */
1174 conn->read_ahead = 0;
1176 } else if (conn->read_ahead == READ_AHEAD_CRLF) {
1177 /* the last call to read_line() left off after having read \r\n */
1179 } else if (conn->read_ahead == READ_AHEAD_CRLFCR) {
1180 /* the last call to read_line() left off after having read \r\n\r */
1182 } else if (conn->read_ahead != 0) {
1183 /* the last call to read_line() left us with a character to start with */
1184 c = (guint8) conn->read_ahead;
1185 conn->read_ahead = 0;
1187 /* read the next character */
1188 r = fill_bytes (conn, &c, 1);
1189 if (G_UNLIKELY (r == 0)) {
1190 return GST_RTSP_EEOF;
1191 } else if (G_UNLIKELY (r < 0)) {
1192 if (ERRNO_IS_EAGAIN)
1193 return GST_RTSP_EINTR;
1194 if (!ERRNO_IS_EINTR)
1195 return GST_RTSP_ESYS;
1200 /* special treatment of line endings */
1201 if (c == '\r' || c == '\n') {
1205 /* need to read ahead one more character to know what to do... */
1206 r = fill_bytes (conn, &read_ahead, 1);
1207 if (G_UNLIKELY (r == 0)) {
1208 return GST_RTSP_EEOF;
1209 } else if (G_UNLIKELY (r < 0)) {
1210 if (ERRNO_IS_EAGAIN) {
1211 /* remember the original character we read and try again next time */
1212 if (conn->read_ahead == 0)
1213 conn->read_ahead = c;
1214 return GST_RTSP_EINTR;
1216 if (!ERRNO_IS_EINTR)
1217 return GST_RTSP_ESYS;
1221 if (read_ahead == ' ' || read_ahead == '\t') {
1222 if (conn->read_ahead == READ_AHEAD_CRLFCR) {
1223 /* got \r\n\r followed by whitespace, treat it as a normal line
1224 * followed by one starting with LWS */
1225 conn->read_ahead = read_ahead;
1228 /* got LWS, change the line ending to a space and continue */
1230 conn->read_ahead = read_ahead;
1232 } else if (conn->read_ahead == READ_AHEAD_CRLFCR) {
1233 if (read_ahead == '\r' || read_ahead == '\n') {
1234 /* got \r\n\r\r or \r\n\r\n, treat it as the end of the headers */
1235 conn->read_ahead = READ_AHEAD_EOH;
1238 /* got \r\n\r followed by something else, this is not really
1239 * supported since we have probably just eaten the first character
1240 * of the body or the next message, so just ignore the second \r
1241 * and live with it... */
1242 conn->read_ahead = read_ahead;
1245 } else if (conn->read_ahead == READ_AHEAD_CRLF) {
1246 if (read_ahead == '\r') {
1247 /* got \r\n\r so far, need one more character... */
1248 conn->read_ahead = READ_AHEAD_CRLFCR;
1250 } else if (read_ahead == '\n') {
1251 /* got \r\n\n, treat it as the end of the headers */
1252 conn->read_ahead = READ_AHEAD_EOH;
1255 /* found the end of a line, keep read_ahead for the next line */
1256 conn->read_ahead = read_ahead;
1259 } else if (c == read_ahead) {
1260 /* got double \r or \n, treat it as the end of the headers */
1261 conn->read_ahead = READ_AHEAD_EOH;
1263 } else if (c == '\r' && read_ahead == '\n') {
1264 /* got \r\n so far, still need more to know what to do... */
1265 conn->read_ahead = READ_AHEAD_CRLF;
1268 /* found the end of a line, keep read_ahead for the next line */
1269 conn->read_ahead = read_ahead;
1274 if (G_LIKELY (*idx < size - 1))
1275 buffer[(*idx)++] = c;
1277 buffer[*idx] = '\0';
1283 * gst_rtsp_connection_write:
1284 * @conn: a #GstRTSPConnection
1285 * @data: the data to write
1286 * @size: the size of @data
1287 * @timeout: a timeout value or #NULL
1289 * Attempt to write @size bytes of @data to the connected @conn, blocking up to
1290 * the specified @timeout. @timeout can be #NULL, in which case this function
1291 * might block forever.
1293 * This function can be cancelled with gst_rtsp_connection_flush().
1295 * Returns: #GST_RTSP_OK on success.
1298 gst_rtsp_connection_write (GstRTSPConnection * conn, const guint8 * data,
1299 guint size, GTimeVal * timeout)
1306 g_return_val_if_fail (conn != NULL, GST_RTSP_EINVAL);
1307 g_return_val_if_fail (data != NULL || size == 0, GST_RTSP_EINVAL);
1308 g_return_val_if_fail (conn->writefd != NULL, GST_RTSP_EINVAL);
1310 gst_poll_set_controllable (conn->fdset, TRUE);
1311 gst_poll_fd_ctl_write (conn->fdset, conn->writefd, TRUE);
1312 gst_poll_fd_ctl_read (conn->fdset, conn->readfd, FALSE);
1313 /* clear all previous poll results */
1314 gst_poll_fd_ignored (conn->fdset, conn->writefd);
1315 gst_poll_fd_ignored (conn->fdset, conn->readfd);
1317 to = timeout ? GST_TIMEVAL_TO_TIME (*timeout) : GST_CLOCK_TIME_NONE;
1323 res = write_bytes (conn->writefd->fd, data, &offset, size);
1324 if (G_LIKELY (res == GST_RTSP_OK))
1326 if (G_UNLIKELY (res != GST_RTSP_EINTR))
1329 /* not all is written, wait until we can write more */
1331 retval = gst_poll_wait (conn->fdset, to);
1332 } while (retval == -1 && (errno == EINTR || errno == EAGAIN));
1334 if (G_UNLIKELY (retval == 0))
1337 if (G_UNLIKELY (retval == -1)) {
1349 return GST_RTSP_ETIMEOUT;
1353 return GST_RTSP_ESYS;
1357 return GST_RTSP_EINTR;
1366 message_to_string (GstRTSPConnection * conn, GstRTSPMessage * message)
1368 GString *str = NULL;
1370 str = g_string_new ("");
1372 switch (message->type) {
1373 case GST_RTSP_MESSAGE_REQUEST:
1374 /* create request string, add CSeq */
1375 g_string_append_printf (str, "%s %s RTSP/1.0\r\n"
1377 gst_rtsp_method_as_text (message->type_data.request.method),
1378 message->type_data.request.uri, conn->cseq++);
1379 /* add session id if we have one */
1380 if (conn->session_id[0] != '\0') {
1381 gst_rtsp_message_remove_header (message, GST_RTSP_HDR_SESSION, -1);
1382 gst_rtsp_message_add_header (message, GST_RTSP_HDR_SESSION,
1385 /* add any authentication headers */
1386 add_auth_header (conn, message);
1388 case GST_RTSP_MESSAGE_RESPONSE:
1389 /* create response string */
1390 g_string_append_printf (str, "RTSP/1.0 %d %s\r\n",
1391 message->type_data.response.code, message->type_data.response.reason);
1393 case GST_RTSP_MESSAGE_HTTP_REQUEST:
1394 /* create request string */
1395 g_string_append_printf (str, "%s %s HTTP/%s\r\n",
1396 gst_rtsp_method_as_text (message->type_data.request.method),
1397 message->type_data.request.uri,
1398 gst_rtsp_version_as_text (message->type_data.request.version));
1399 /* add any authentication headers */
1400 add_auth_header (conn, message);
1402 case GST_RTSP_MESSAGE_HTTP_RESPONSE:
1403 /* create response string */
1404 g_string_append_printf (str, "HTTP/%s %d %s\r\n",
1405 gst_rtsp_version_as_text (message->type_data.request.version),
1406 message->type_data.response.code, message->type_data.response.reason);
1408 case GST_RTSP_MESSAGE_DATA:
1410 guint8 data_header[4];
1412 /* prepare data header */
1413 data_header[0] = '$';
1414 data_header[1] = message->type_data.data.channel;
1415 data_header[2] = (message->body_size >> 8) & 0xff;
1416 data_header[3] = message->body_size & 0xff;
1418 /* create string with header and data */
1419 str = g_string_append_len (str, (gchar *) data_header, 4);
1421 g_string_append_len (str, (gchar *) message->body,
1422 message->body_size);
1426 g_string_free (str, TRUE);
1427 g_return_val_if_reached (NULL);
1431 /* append headers and body */
1432 if (message->type != GST_RTSP_MESSAGE_DATA) {
1433 gchar date_string[100];
1435 gen_date_string (date_string, sizeof (date_string));
1437 /* add date header */
1438 gst_rtsp_message_remove_header (message, GST_RTSP_HDR_DATE, -1);
1439 gst_rtsp_message_add_header (message, GST_RTSP_HDR_DATE, date_string);
1441 /* append headers */
1442 gst_rtsp_message_append_headers (message, str);
1444 /* append Content-Length and body if needed */
1445 if (message->body != NULL && message->body_size > 0) {
1448 len = g_strdup_printf ("%d", message->body_size);
1449 g_string_append_printf (str, "%s: %s\r\n",
1450 gst_rtsp_header_as_text (GST_RTSP_HDR_CONTENT_LENGTH), len);
1452 /* header ends here */
1453 g_string_append (str, "\r\n");
1455 g_string_append_len (str, (gchar *) message->body,
1456 message->body_size);
1458 /* just end headers */
1459 g_string_append (str, "\r\n");
1467 * gst_rtsp_connection_send:
1468 * @conn: a #GstRTSPConnection
1469 * @message: the message to send
1470 * @timeout: a timeout value or #NULL
1472 * Attempt to send @message to the connected @conn, blocking up to
1473 * the specified @timeout. @timeout can be #NULL, in which case this function
1474 * might block forever.
1476 * This function can be cancelled with gst_rtsp_connection_flush().
1478 * Returns: #GST_RTSP_OK on success.
1481 gst_rtsp_connection_send (GstRTSPConnection * conn, GstRTSPMessage * message,
1484 GString *string = NULL;
1489 g_return_val_if_fail (conn != NULL, GST_RTSP_EINVAL);
1490 g_return_val_if_fail (message != NULL, GST_RTSP_EINVAL);
1492 if (G_UNLIKELY (!(string = message_to_string (conn, message))))
1495 if (conn->tunneled) {
1496 str = g_base64_encode ((const guchar *) string->str, string->len);
1497 g_string_free (string, TRUE);
1502 g_string_free (string, FALSE);
1506 res = gst_rtsp_connection_write (conn, (guint8 *) str, len, timeout);
1514 g_warning ("Wrong message");
1515 return GST_RTSP_EINVAL;
1519 static GstRTSPResult
1520 parse_string (gchar * dest, gint size, gchar ** src)
1522 GstRTSPResult res = GST_RTSP_OK;
1527 while (g_ascii_isspace (**src))
1530 while (!g_ascii_isspace (**src) && **src != '\0') {
1532 dest[idx++] = **src;
1534 res = GST_RTSP_EPARSE;
1543 static GstRTSPResult
1544 parse_protocol_version (gchar * protocol, GstRTSPMsgType * type,
1545 GstRTSPVersion * version)
1547 GstRTSPResult res = GST_RTSP_OK;
1550 if (G_LIKELY ((ver = strchr (protocol, '/')) != NULL)) {
1557 /* the version number must be formatted as X.Y with nothing following */
1558 if (sscanf (ver, "%u.%u%c", &major, &minor, &dummychar) != 2)
1559 res = GST_RTSP_EPARSE;
1561 if (g_ascii_strcasecmp (protocol, "RTSP") == 0) {
1562 if (major != 1 || minor != 0) {
1563 *version = GST_RTSP_VERSION_INVALID;
1564 res = GST_RTSP_ERROR;
1566 } else if (g_ascii_strcasecmp (protocol, "HTTP") == 0) {
1567 if (*type == GST_RTSP_MESSAGE_REQUEST)
1568 *type = GST_RTSP_MESSAGE_HTTP_REQUEST;
1569 else if (*type == GST_RTSP_MESSAGE_RESPONSE)
1570 *type = GST_RTSP_MESSAGE_HTTP_RESPONSE;
1572 if (major == 1 && minor == 1) {
1573 *version = GST_RTSP_VERSION_1_1;
1574 } else if (major != 1 || minor != 0) {
1575 *version = GST_RTSP_VERSION_INVALID;
1576 res = GST_RTSP_ERROR;
1579 res = GST_RTSP_EPARSE;
1581 res = GST_RTSP_EPARSE;
1586 static GstRTSPResult
1587 parse_response_status (guint8 * buffer, GstRTSPMessage * msg)
1589 GstRTSPResult res = GST_RTSP_OK;
1591 gchar versionstr[20];
1596 bptr = (gchar *) buffer;
1598 if (parse_string (versionstr, sizeof (versionstr), &bptr) != GST_RTSP_OK)
1599 res = GST_RTSP_EPARSE;
1601 if (parse_string (codestr, sizeof (codestr), &bptr) != GST_RTSP_OK)
1602 res = GST_RTSP_EPARSE;
1603 code = atoi (codestr);
1604 if (G_UNLIKELY (*codestr == '\0' || code < 0 || code >= 600))
1605 res = GST_RTSP_EPARSE;
1607 while (g_ascii_isspace (*bptr))
1610 if (G_UNLIKELY (gst_rtsp_message_init_response (msg, code, bptr,
1611 NULL) != GST_RTSP_OK))
1612 res = GST_RTSP_EPARSE;
1614 res2 = parse_protocol_version (versionstr, &msg->type,
1615 &msg->type_data.response.version);
1616 if (G_LIKELY (res == GST_RTSP_OK))
1622 static GstRTSPResult
1623 parse_request_line (guint8 * buffer, GstRTSPMessage * msg)
1625 GstRTSPResult res = GST_RTSP_OK;
1627 gchar versionstr[20];
1628 gchar methodstr[20];
1631 GstRTSPMethod method;
1633 bptr = (gchar *) buffer;
1635 if (parse_string (methodstr, sizeof (methodstr), &bptr) != GST_RTSP_OK)
1636 res = GST_RTSP_EPARSE;
1637 method = gst_rtsp_find_method (methodstr);
1639 if (parse_string (urlstr, sizeof (urlstr), &bptr) != GST_RTSP_OK)
1640 res = GST_RTSP_EPARSE;
1641 if (G_UNLIKELY (*urlstr == '\0'))
1642 res = GST_RTSP_EPARSE;
1644 if (parse_string (versionstr, sizeof (versionstr), &bptr) != GST_RTSP_OK)
1645 res = GST_RTSP_EPARSE;
1647 if (G_UNLIKELY (*bptr != '\0'))
1648 res = GST_RTSP_EPARSE;
1650 if (G_UNLIKELY (gst_rtsp_message_init_request (msg, method,
1651 urlstr) != GST_RTSP_OK))
1652 res = GST_RTSP_EPARSE;
1654 res2 = parse_protocol_version (versionstr, &msg->type,
1655 &msg->type_data.request.version);
1656 if (G_LIKELY (res == GST_RTSP_OK))
1659 if (G_LIKELY (msg->type == GST_RTSP_MESSAGE_REQUEST)) {
1660 /* GET and POST are not allowed as RTSP methods */
1661 if (msg->type_data.request.method == GST_RTSP_GET ||
1662 msg->type_data.request.method == GST_RTSP_POST) {
1663 msg->type_data.request.method = GST_RTSP_INVALID;
1664 if (res == GST_RTSP_OK)
1665 res = GST_RTSP_ERROR;
1667 } else if (msg->type == GST_RTSP_MESSAGE_HTTP_REQUEST) {
1668 /* only GET and POST are allowed as HTTP methods */
1669 if (msg->type_data.request.method != GST_RTSP_GET &&
1670 msg->type_data.request.method != GST_RTSP_POST) {
1671 msg->type_data.request.method = GST_RTSP_INVALID;
1672 if (res == GST_RTSP_OK)
1673 res = GST_RTSP_ERROR;
1680 /* parsing lines means reading a Key: Value pair */
1681 static GstRTSPResult
1682 parse_line (guint8 * buffer, GstRTSPMessage * msg)
1684 GstRTSPHeaderField field;
1685 gchar *line = (gchar *) buffer;
1688 if ((value = strchr (line, ':')) == NULL || value == line)
1691 /* trim space before the colon */
1692 if (value[-1] == ' ')
1695 /* replace the colon with a NUL */
1698 /* find the header */
1699 field = gst_rtsp_find_header_field (line);
1700 if (field == GST_RTSP_HDR_INVALID)
1703 /* split up the value in multiple key:value pairs if it contains comma(s) */
1704 while (*value != '\0') {
1706 gchar *comma = NULL;
1707 gboolean quoted = FALSE;
1710 /* trim leading space */
1714 /* for headers which may not appear multiple times, and thus may not
1715 * contain multiple values on the same line, we can short-circuit the loop
1716 * below and the entire value results in just one key:value pair*/
1717 if (!gst_rtsp_header_allow_multiple (field))
1718 next_value = value + strlen (value);
1722 /* find the next value, taking special care of quotes and comments */
1723 while (*next_value != '\0') {
1724 if ((quoted || comment != 0) && *next_value == '\\' &&
1725 next_value[1] != '\0')
1727 else if (comment == 0 && *next_value == '"')
1729 else if (!quoted && *next_value == '(')
1731 else if (comment != 0 && *next_value == ')')
1733 else if (!quoted && comment == 0) {
1734 /* To quote RFC 2068: "User agents MUST take special care in parsing
1735 * the WWW-Authenticate field value if it contains more than one
1736 * challenge, or if more than one WWW-Authenticate header field is
1737 * provided, since the contents of a challenge may itself contain a
1738 * comma-separated list of authentication parameters."
1740 * What this means is that we cannot just look for an unquoted comma
1741 * when looking for multiple values in Proxy-Authenticate and
1742 * WWW-Authenticate headers. Instead we need to look for the sequence
1743 * "comma [space] token space token" before we can split after the
1746 if (field == GST_RTSP_HDR_PROXY_AUTHENTICATE ||
1747 field == GST_RTSP_HDR_WWW_AUTHENTICATE) {
1748 if (*next_value == ',') {
1749 if (next_value[1] == ' ') {
1750 /* skip any space following the comma so we do not mistake it for
1751 * separating between two tokens */
1755 } else if (*next_value == ' ' && next_value[1] != ',' &&
1756 next_value[1] != '=' && comma != NULL) {
1761 } else if (*next_value == ',')
1769 if (value != next_value && next_value[-1] == ' ')
1770 next_value[-1] = '\0';
1772 if (*next_value != '\0')
1773 *next_value++ = '\0';
1775 /* add the key:value pair */
1777 gst_rtsp_message_add_header (msg, field, value);
1788 return GST_RTSP_EPARSE;
1792 /* convert all consecutive whitespace to a single space */
1794 normalize_line (guint8 * buffer)
1797 if (g_ascii_isspace (*buffer)) {
1801 for (tmp = buffer; g_ascii_isspace (*tmp); tmp++) {
1804 memmove (buffer, tmp, strlen ((gchar *) tmp) + 1);
1812 * GST_RTSP_OK when a complete message was read.
1813 * GST_RTSP_EEOF: when the socket is closed
1814 * GST_RTSP_EINTR: when more data is needed.
1815 * GST_RTSP_..: some other error occured.
1817 static GstRTSPResult
1818 build_next (GstRTSPBuilder * builder, GstRTSPMessage * message,
1819 GstRTSPConnection * conn)
1824 switch (builder->state) {
1826 builder->offset = 0;
1828 read_bytes (conn, (guint8 *) builder->buffer, &builder->offset, 1);
1829 if (res != GST_RTSP_OK)
1832 /* we have 1 bytes now and we can see if this is a data message or
1834 if (builder->buffer[0] == '$') {
1835 /* data message, prepare for the header */
1836 builder->state = STATE_DATA_HEADER;
1839 builder->state = STATE_READ_LINES;
1842 case STATE_DATA_HEADER:
1845 read_bytes (conn, (guint8 *) builder->buffer, &builder->offset, 4);
1846 if (res != GST_RTSP_OK)
1849 gst_rtsp_message_init_data (message, builder->buffer[1]);
1851 builder->body_len = (builder->buffer[2] << 8) | builder->buffer[3];
1852 builder->body_data = g_malloc (builder->body_len + 1);
1853 builder->body_data[builder->body_len] = '\0';
1854 builder->offset = 0;
1855 builder->state = STATE_DATA_BODY;
1858 case STATE_DATA_BODY:
1861 read_bytes (conn, builder->body_data, &builder->offset,
1863 if (res != GST_RTSP_OK)
1866 /* we have the complete body now, store in the message adjusting the
1867 * length to include the traling '\0' */
1868 gst_rtsp_message_take_body (message,
1869 (guint8 *) builder->body_data, builder->body_len + 1);
1870 builder->body_data = NULL;
1871 builder->body_len = 0;
1873 builder->state = STATE_END;
1876 case STATE_READ_LINES:
1878 res = read_line (conn, builder->buffer, &builder->offset,
1879 sizeof (builder->buffer));
1880 if (res != GST_RTSP_OK)
1883 /* we have a regular response */
1884 if (builder->buffer[0] == '\0') {
1887 /* empty line, end of message header */
1888 /* see if there is a Content-Length header, but ignore it if this
1889 * is a POST request with an x-sessioncookie header */
1890 if (gst_rtsp_message_get_header (message,
1891 GST_RTSP_HDR_CONTENT_LENGTH, &hdrval, 0) == GST_RTSP_OK &&
1892 (message->type != GST_RTSP_MESSAGE_HTTP_REQUEST ||
1893 message->type_data.request.method != GST_RTSP_POST ||
1894 gst_rtsp_message_get_header (message,
1895 GST_RTSP_HDR_X_SESSIONCOOKIE, NULL, 0) != GST_RTSP_OK)) {
1896 /* there is, prepare to read the body */
1897 builder->body_len = atol (hdrval);
1898 builder->body_data = g_malloc (builder->body_len + 1);
1899 builder->body_data[builder->body_len] = '\0';
1900 builder->offset = 0;
1901 builder->state = STATE_DATA_BODY;
1903 builder->state = STATE_END;
1908 /* we have a line */
1909 normalize_line (builder->buffer);
1910 if (builder->line == 0) {
1911 /* first line, check for response status */
1912 if (memcmp (builder->buffer, "RTSP", 4) == 0 ||
1913 memcmp (builder->buffer, "HTTP", 4) == 0) {
1914 builder->status = parse_response_status (builder->buffer, message);
1916 builder->status = parse_request_line (builder->buffer, message);
1919 /* else just parse the line */
1920 res = parse_line (builder->buffer, message);
1921 if (res != GST_RTSP_OK)
1922 builder->status = res;
1925 builder->offset = 0;
1930 gchar *session_cookie;
1933 if (message->type == GST_RTSP_MESSAGE_DATA) {
1934 /* data messages don't have headers */
1939 /* save the tunnel session in the connection */
1940 if (message->type == GST_RTSP_MESSAGE_HTTP_REQUEST &&
1941 !conn->manual_http &&
1942 conn->tstate == TUNNEL_STATE_NONE &&
1943 gst_rtsp_message_get_header (message, GST_RTSP_HDR_X_SESSIONCOOKIE,
1944 &session_cookie, 0) == GST_RTSP_OK) {
1945 strncpy (conn->tunnelid, session_cookie, TUNNELID_LEN);
1946 conn->tunnelid[TUNNELID_LEN - 1] = '\0';
1947 conn->tunneled = TRUE;
1950 /* save session id in the connection for further use */
1951 if (message->type == GST_RTSP_MESSAGE_RESPONSE &&
1952 gst_rtsp_message_get_header (message, GST_RTSP_HDR_SESSION,
1953 &session_id, 0) == GST_RTSP_OK) {
1956 maxlen = sizeof (conn->session_id) - 1;
1957 /* the sessionid can have attributes marked with ;
1958 * Make sure we strip them */
1959 for (i = 0; session_id[i] != '\0'; i++) {
1960 if (session_id[i] == ';') {
1965 } while (g_ascii_isspace (session_id[i]));
1966 if (g_str_has_prefix (&session_id[i], "timeout=")) {
1969 /* if we parsed something valid, configure */
1970 if ((to = atoi (&session_id[i + 8])) > 0)
1977 /* make sure to not overflow */
1978 strncpy (conn->session_id, session_id, maxlen);
1979 conn->session_id[maxlen] = '\0';
1981 res = builder->status;
1985 res = GST_RTSP_ERROR;
1994 * gst_rtsp_connection_read:
1995 * @conn: a #GstRTSPConnection
1996 * @data: the data to read
1997 * @size: the size of @data
1998 * @timeout: a timeout value or #NULL
2000 * Attempt to read @size bytes into @data from the connected @conn, blocking up to
2001 * the specified @timeout. @timeout can be #NULL, in which case this function
2002 * might block forever.
2004 * This function can be cancelled with gst_rtsp_connection_flush().
2006 * Returns: #GST_RTSP_OK on success.
2009 gst_rtsp_connection_read (GstRTSPConnection * conn, guint8 * data, guint size,
2017 g_return_val_if_fail (conn != NULL, GST_RTSP_EINVAL);
2018 g_return_val_if_fail (data != NULL, GST_RTSP_EINVAL);
2019 g_return_val_if_fail (conn->readfd != NULL, GST_RTSP_EINVAL);
2021 if (G_UNLIKELY (size == 0))
2026 /* configure timeout if any */
2027 to = timeout ? GST_TIMEVAL_TO_TIME (*timeout) : GST_CLOCK_TIME_NONE;
2029 gst_poll_set_controllable (conn->fdset, TRUE);
2030 gst_poll_fd_ctl_write (conn->fdset, conn->writefd, FALSE);
2031 gst_poll_fd_ctl_read (conn->fdset, conn->readfd, TRUE);
2034 res = read_bytes (conn, data, &offset, size);
2035 if (G_UNLIKELY (res == GST_RTSP_EEOF))
2037 if (G_LIKELY (res == GST_RTSP_OK))
2039 if (G_UNLIKELY (res != GST_RTSP_EINTR))
2043 retval = gst_poll_wait (conn->fdset, to);
2044 } while (retval == -1 && (errno == EINTR || errno == EAGAIN));
2046 /* check for timeout */
2047 if (G_UNLIKELY (retval == 0))
2048 goto select_timeout;
2050 if (G_UNLIKELY (retval == -1)) {
2056 gst_poll_set_controllable (conn->fdset, FALSE);
2063 return GST_RTSP_ESYS;
2067 return GST_RTSP_ETIMEOUT;
2071 return GST_RTSP_EINTR;
2075 return GST_RTSP_EEOF;
2083 static GstRTSPMessage *
2084 gen_tunnel_reply (GstRTSPConnection * conn, GstRTSPStatusCode code,
2085 const GstRTSPMessage * request)
2087 GstRTSPMessage *msg;
2090 if (gst_rtsp_status_as_text (code) == NULL)
2091 code = GST_RTSP_STS_INTERNAL_SERVER_ERROR;
2093 GST_RTSP_CHECK (gst_rtsp_message_new_response (&msg, code, NULL, request),
2096 gst_rtsp_message_add_header (msg, GST_RTSP_HDR_SERVER,
2097 "GStreamer RTSP Server");
2098 gst_rtsp_message_add_header (msg, GST_RTSP_HDR_CONNECTION, "close");
2099 gst_rtsp_message_add_header (msg, GST_RTSP_HDR_CACHE_CONTROL, "no-store");
2100 gst_rtsp_message_add_header (msg, GST_RTSP_HDR_PRAGMA, "no-cache");
2102 if (code == GST_RTSP_STS_OK) {
2104 gst_rtsp_message_add_header (msg, GST_RTSP_HDR_X_SERVER_IP_ADDRESS,
2106 gst_rtsp_message_add_header (msg, GST_RTSP_HDR_CONTENT_TYPE,
2107 "application/x-rtsp-tunnelled");
2120 * gst_rtsp_connection_receive:
2121 * @conn: a #GstRTSPConnection
2122 * @message: the message to read
2123 * @timeout: a timeout value or #NULL
2125 * Attempt to read into @message from the connected @conn, blocking up to
2126 * the specified @timeout. @timeout can be #NULL, in which case this function
2127 * might block forever.
2129 * This function can be cancelled with gst_rtsp_connection_flush().
2131 * Returns: #GST_RTSP_OK on success.
2134 gst_rtsp_connection_receive (GstRTSPConnection * conn, GstRTSPMessage * message,
2138 GstRTSPBuilder builder;
2142 g_return_val_if_fail (conn != NULL, GST_RTSP_EINVAL);
2143 g_return_val_if_fail (message != NULL, GST_RTSP_EINVAL);
2144 g_return_val_if_fail (conn->readfd != NULL, GST_RTSP_EINVAL);
2146 /* configure timeout if any */
2147 to = timeout ? GST_TIMEVAL_TO_TIME (*timeout) : GST_CLOCK_TIME_NONE;
2149 gst_poll_set_controllable (conn->fdset, TRUE);
2150 gst_poll_fd_ctl_write (conn->fdset, conn->writefd, FALSE);
2151 gst_poll_fd_ctl_read (conn->fdset, conn->readfd, TRUE);
2153 memset (&builder, 0, sizeof (GstRTSPBuilder));
2155 res = build_next (&builder, message, conn);
2156 if (G_UNLIKELY (res == GST_RTSP_EEOF))
2158 else if (G_LIKELY (res == GST_RTSP_OK)) {
2159 if (!conn->manual_http) {
2160 if (message->type == GST_RTSP_MESSAGE_HTTP_REQUEST) {
2161 if (conn->tstate == TUNNEL_STATE_NONE &&
2162 message->type_data.request.method == GST_RTSP_GET) {
2163 GstRTSPMessage *response;
2165 conn->tstate = TUNNEL_STATE_GET;
2167 /* tunnel GET request, we can reply now */
2168 response = gen_tunnel_reply (conn, GST_RTSP_STS_OK, message);
2169 res = gst_rtsp_connection_send (conn, response, timeout);
2170 gst_rtsp_message_free (response);
2171 if (res == GST_RTSP_OK)
2172 res = GST_RTSP_ETGET;
2174 } else if (conn->tstate == TUNNEL_STATE_NONE &&
2175 message->type_data.request.method == GST_RTSP_POST) {
2176 conn->tstate = TUNNEL_STATE_POST;
2178 /* tunnel POST request, the caller now has to link the two
2180 res = GST_RTSP_ETPOST;
2183 res = GST_RTSP_EPARSE;
2186 } else if (message->type == GST_RTSP_MESSAGE_HTTP_RESPONSE) {
2187 res = GST_RTSP_EPARSE;
2193 } else if (G_UNLIKELY (res != GST_RTSP_EINTR))
2197 retval = gst_poll_wait (conn->fdset, to);
2198 } while (retval == -1 && (errno == EINTR || errno == EAGAIN));
2200 /* check for timeout */
2201 if (G_UNLIKELY (retval == 0))
2202 goto select_timeout;
2204 if (G_UNLIKELY (retval == -1)) {
2210 gst_poll_set_controllable (conn->fdset, FALSE);
2213 /* we have a message here */
2214 build_reset (&builder);
2221 res = GST_RTSP_ESYS;
2226 res = GST_RTSP_ETIMEOUT;
2231 res = GST_RTSP_EINTR;
2236 res = GST_RTSP_EEOF;
2242 build_reset (&builder);
2243 gst_rtsp_message_unset (message);
2249 * gst_rtsp_connection_close:
2250 * @conn: a #GstRTSPConnection
2252 * Close the connected @conn. After this call, the connection is in the same
2253 * state as when it was first created.
2255 * Returns: #GST_RTSP_OK on success.
2258 gst_rtsp_connection_close (GstRTSPConnection * conn)
2260 g_return_val_if_fail (conn != NULL, GST_RTSP_EINVAL);
2265 conn->read_ahead = 0;
2267 g_free (conn->initial_buffer);
2268 conn->initial_buffer = NULL;
2269 conn->initial_buffer_offset = 0;
2271 REMOVE_POLLFD (conn->fdset, &conn->fd0);
2272 REMOVE_POLLFD (conn->fdset, &conn->fd1);
2273 conn->writefd = NULL;
2274 conn->readfd = NULL;
2275 conn->tunneled = FALSE;
2276 conn->tstate = TUNNEL_STATE_NONE;
2278 g_free (conn->username);
2279 conn->username = NULL;
2280 g_free (conn->passwd);
2281 conn->passwd = NULL;
2282 gst_rtsp_connection_clear_auth_params (conn);
2285 conn->session_id[0] = '\0';
2291 * gst_rtsp_connection_free:
2292 * @conn: a #GstRTSPConnection
2294 * Close and free @conn.
2296 * Returns: #GST_RTSP_OK on success.
2299 gst_rtsp_connection_free (GstRTSPConnection * conn)
2303 g_return_val_if_fail (conn != NULL, GST_RTSP_EINVAL);
2305 res = gst_rtsp_connection_close (conn);
2306 gst_poll_free (conn->fdset);
2307 g_timer_destroy (conn->timer);
2308 gst_rtsp_url_free (conn->url);
2309 g_free (conn->proxy_host);
2319 * gst_rtsp_connection_poll:
2320 * @conn: a #GstRTSPConnection
2321 * @events: a bitmask of #GstRTSPEvent flags to check
2322 * @revents: location for result flags
2323 * @timeout: a timeout
2325 * Wait up to the specified @timeout for the connection to become available for
2326 * at least one of the operations specified in @events. When the function returns
2327 * with #GST_RTSP_OK, @revents will contain a bitmask of available operations on
2330 * @timeout can be #NULL, in which case this function might block forever.
2332 * This function can be cancelled with gst_rtsp_connection_flush().
2334 * Returns: #GST_RTSP_OK on success.
2339 gst_rtsp_connection_poll (GstRTSPConnection * conn, GstRTSPEvent events,
2340 GstRTSPEvent * revents, GTimeVal * timeout)
2345 g_return_val_if_fail (conn != NULL, GST_RTSP_EINVAL);
2346 g_return_val_if_fail (events != 0, GST_RTSP_EINVAL);
2347 g_return_val_if_fail (revents != NULL, GST_RTSP_EINVAL);
2348 g_return_val_if_fail (conn->readfd != NULL, GST_RTSP_EINVAL);
2349 g_return_val_if_fail (conn->writefd != NULL, GST_RTSP_EINVAL);
2351 gst_poll_set_controllable (conn->fdset, TRUE);
2353 /* add fd to writer set when asked to */
2354 gst_poll_fd_ctl_write (conn->fdset, conn->writefd,
2355 events & GST_RTSP_EV_WRITE);
2357 /* add fd to reader set when asked to */
2358 gst_poll_fd_ctl_read (conn->fdset, conn->readfd, events & GST_RTSP_EV_READ);
2360 /* configure timeout if any */
2361 to = timeout ? GST_TIMEVAL_TO_TIME (*timeout) : GST_CLOCK_TIME_NONE;
2364 retval = gst_poll_wait (conn->fdset, to);
2365 } while (retval == -1 && (errno == EINTR || errno == EAGAIN));
2367 if (G_UNLIKELY (retval == 0))
2368 goto select_timeout;
2370 if (G_UNLIKELY (retval == -1)) {
2378 if (events & GST_RTSP_EV_READ) {
2379 if (gst_poll_fd_can_read (conn->fdset, conn->readfd))
2380 *revents |= GST_RTSP_EV_READ;
2382 if (events & GST_RTSP_EV_WRITE) {
2383 if (gst_poll_fd_can_write (conn->fdset, conn->writefd))
2384 *revents |= GST_RTSP_EV_WRITE;
2391 return GST_RTSP_ETIMEOUT;
2395 return GST_RTSP_ESYS;
2399 return GST_RTSP_EINTR;
2404 * gst_rtsp_connection_next_timeout:
2405 * @conn: a #GstRTSPConnection
2406 * @timeout: a timeout
2408 * Calculate the next timeout for @conn, storing the result in @timeout.
2410 * Returns: #GST_RTSP_OK.
2413 gst_rtsp_connection_next_timeout (GstRTSPConnection * conn, GTimeVal * timeout)
2419 g_return_val_if_fail (conn != NULL, GST_RTSP_EINVAL);
2420 g_return_val_if_fail (timeout != NULL, GST_RTSP_EINVAL);
2422 elapsed = g_timer_elapsed (conn->timer, &usec);
2423 if (elapsed >= conn->timeout) {
2427 sec = conn->timeout - elapsed;
2430 timeout->tv_sec = sec;
2431 timeout->tv_usec = usec;
2437 * gst_rtsp_connection_reset_timeout:
2438 * @conn: a #GstRTSPConnection
2440 * Reset the timeout of @conn.
2442 * Returns: #GST_RTSP_OK.
2445 gst_rtsp_connection_reset_timeout (GstRTSPConnection * conn)
2447 g_return_val_if_fail (conn != NULL, GST_RTSP_EINVAL);
2449 g_timer_start (conn->timer);
2455 * gst_rtsp_connection_flush:
2456 * @conn: a #GstRTSPConnection
2457 * @flush: start or stop the flush
2459 * Start or stop the flushing action on @conn. When flushing, all current
2460 * and future actions on @conn will return #GST_RTSP_EINTR until the connection
2461 * is set to non-flushing mode again.
2463 * Returns: #GST_RTSP_OK.
2466 gst_rtsp_connection_flush (GstRTSPConnection * conn, gboolean flush)
2468 g_return_val_if_fail (conn != NULL, GST_RTSP_EINVAL);
2470 gst_poll_set_flushing (conn->fdset, flush);
2476 * gst_rtsp_connection_set_proxy:
2477 * @conn: a #GstRTSPConnection
2478 * @host: the proxy host
2479 * @port: the proxy port
2481 * Set the proxy host and port.
2483 * Returns: #GST_RTSP_OK.
2488 gst_rtsp_connection_set_proxy (GstRTSPConnection * conn,
2489 const gchar * host, guint port)
2491 g_return_val_if_fail (conn != NULL, GST_RTSP_EINVAL);
2493 g_free (conn->proxy_host);
2494 conn->proxy_host = g_strdup (host);
2495 conn->proxy_port = port;
2501 * gst_rtsp_connection_set_auth:
2502 * @conn: a #GstRTSPConnection
2503 * @method: authentication method
2505 * @pass: the password
2507 * Configure @conn for authentication mode @method with @user and @pass as the
2508 * user and password respectively.
2510 * Returns: #GST_RTSP_OK.
2513 gst_rtsp_connection_set_auth (GstRTSPConnection * conn,
2514 GstRTSPAuthMethod method, const gchar * user, const gchar * pass)
2516 g_return_val_if_fail (conn != NULL, GST_RTSP_EINVAL);
2518 if (method == GST_RTSP_AUTH_DIGEST && ((user == NULL || pass == NULL)
2519 || g_strrstr (user, ":") != NULL))
2520 return GST_RTSP_EINVAL;
2522 /* Make sure the username and passwd are being set for authentication */
2523 if (method == GST_RTSP_AUTH_NONE && (user == NULL || pass == NULL))
2524 return GST_RTSP_EINVAL;
2526 /* ":" chars are not allowed in usernames for basic auth */
2527 if (method == GST_RTSP_AUTH_BASIC && g_strrstr (user, ":") != NULL)
2528 return GST_RTSP_EINVAL;
2530 g_free (conn->username);
2531 g_free (conn->passwd);
2533 conn->auth_method = method;
2534 conn->username = g_strdup (user);
2535 conn->passwd = g_strdup (pass);
2542 * @key: ASCII string to hash
2544 * Hashes @key in a case-insensitive manner.
2546 * Returns: the hash code.
2549 str_case_hash (gconstpointer key)
2551 const char *p = key;
2552 guint h = g_ascii_toupper (*p);
2555 for (p += 1; *p != '\0'; p++)
2556 h = (h << 5) - h + g_ascii_toupper (*p);
2563 * @v1: an ASCII string
2564 * @v2: another ASCII string
2566 * Compares @v1 and @v2 in a case-insensitive manner
2568 * Returns: %TRUE if they are equal (modulo case)
2571 str_case_equal (gconstpointer v1, gconstpointer v2)
2573 const char *string1 = v1;
2574 const char *string2 = v2;
2576 return g_ascii_strcasecmp (string1, string2) == 0;
2580 * gst_rtsp_connection_set_auth_param:
2581 * @conn: a #GstRTSPConnection
2582 * @param: authentication directive
2585 * Setup @conn with authentication directives. This is not necesary for
2586 * methods #GST_RTSP_AUTH_NONE and #GST_RTSP_AUTH_BASIC. For
2587 * #GST_RTSP_AUTH_DIGEST, directives should be taken from the digest challenge
2588 * in the WWW-Authenticate response header and can include realm, domain,
2589 * nonce, opaque, stale, algorithm, qop as per RFC2617.
2594 gst_rtsp_connection_set_auth_param (GstRTSPConnection * conn,
2595 const gchar * param, const gchar * value)
2597 g_return_if_fail (conn != NULL);
2598 g_return_if_fail (param != NULL);
2600 if (conn->auth_params == NULL) {
2602 g_hash_table_new_full (str_case_hash, str_case_equal, g_free, g_free);
2604 g_hash_table_insert (conn->auth_params, g_strdup (param), g_strdup (value));
2608 * gst_rtsp_connection_clear_auth_params:
2609 * @conn: a #GstRTSPConnection
2611 * Clear the list of authentication directives stored in @conn.
2616 gst_rtsp_connection_clear_auth_params (GstRTSPConnection * conn)
2618 g_return_if_fail (conn != NULL);
2620 if (conn->auth_params != NULL) {
2621 g_hash_table_destroy (conn->auth_params);
2622 conn->auth_params = NULL;
2626 static GstRTSPResult
2627 set_qos_dscp (gint fd, guint qos_dscp)
2629 union gst_sockaddr sa;
2630 socklen_t slen = sizeof (sa);
2637 if (getsockname (fd, &sa.sa, &slen) < 0)
2638 goto no_getsockname;
2640 af = sa.sa.sa_family;
2642 /* if this is an IPv4-mapped address then do IPv4 QoS */
2643 if (af == AF_INET6) {
2644 if (IN6_IS_ADDR_V4MAPPED (&sa.sa_in6.sin6_addr))
2648 /* extract and shift 6 bits of the DSCP */
2649 tos = (qos_dscp & 0x3f) << 2;
2653 if (SETSOCKOPT (fd, IPPROTO_IP, IP_TOS, &tos, sizeof (tos)) < 0)
2658 if (SETSOCKOPT (fd, IPPROTO_IPV6, IPV6_TCLASS, &tos, sizeof (tos)) < 0)
2672 return GST_RTSP_ESYS;
2677 return GST_RTSP_ERROR;
2682 * gst_rtsp_connection_set_qos_dscp:
2683 * @conn: a #GstRTSPConnection
2684 * @qos_dscp: DSCP value
2686 * Configure @conn to use the specified DSCP value.
2688 * Returns: #GST_RTSP_OK on success.
2693 gst_rtsp_connection_set_qos_dscp (GstRTSPConnection * conn, guint qos_dscp)
2697 g_return_val_if_fail (conn != NULL, GST_RTSP_EINVAL);
2698 g_return_val_if_fail (conn->readfd != NULL, GST_RTSP_EINVAL);
2699 g_return_val_if_fail (conn->writefd != NULL, GST_RTSP_EINVAL);
2701 res = set_qos_dscp (conn->fd0.fd, qos_dscp);
2702 if (res == GST_RTSP_OK)
2703 res = set_qos_dscp (conn->fd1.fd, qos_dscp);
2710 * gst_rtsp_connection_get_url:
2711 * @conn: a #GstRTSPConnection
2713 * Retrieve the URL of the other end of @conn.
2715 * Returns: The URL. This value remains valid until the
2716 * connection is freed.
2721 gst_rtsp_connection_get_url (const GstRTSPConnection * conn)
2723 g_return_val_if_fail (conn != NULL, NULL);
2729 * gst_rtsp_connection_get_ip:
2730 * @conn: a #GstRTSPConnection
2732 * Retrieve the IP address of the other end of @conn.
2734 * Returns: The IP address as a string. this value remains valid until the
2735 * connection is closed.
2740 gst_rtsp_connection_get_ip (const GstRTSPConnection * conn)
2742 g_return_val_if_fail (conn != NULL, NULL);
2748 * gst_rtsp_connection_set_ip:
2749 * @conn: a #GstRTSPConnection
2750 * @ip: an ip address
2752 * Set the IP address of the server.
2757 gst_rtsp_connection_set_ip (GstRTSPConnection * conn, const gchar * ip)
2759 g_return_if_fail (conn != NULL);
2762 conn->ip = g_strdup (ip);
2766 * gst_rtsp_connection_get_readfd:
2767 * @conn: a #GstRTSPConnection
2769 * Get the file descriptor for reading.
2771 * Returns: the file descriptor used for reading or -1 on error. The file
2772 * descriptor remains valid until the connection is closed.
2777 gst_rtsp_connection_get_readfd (const GstRTSPConnection * conn)
2779 g_return_val_if_fail (conn != NULL, -1);
2780 g_return_val_if_fail (conn->readfd != NULL, -1);
2782 return conn->readfd->fd;
2786 * gst_rtsp_connection_get_writefd:
2787 * @conn: a #GstRTSPConnection
2789 * Get the file descriptor for writing.
2791 * Returns: the file descriptor used for writing or -1 on error. The file
2792 * descriptor remains valid until the connection is closed.
2797 gst_rtsp_connection_get_writefd (const GstRTSPConnection * conn)
2799 g_return_val_if_fail (conn != NULL, -1);
2800 g_return_val_if_fail (conn->writefd != NULL, -1);
2802 return conn->writefd->fd;
2806 * gst_rtsp_connection_set_http_mode:
2807 * @conn: a #GstRTSPConnection
2808 * @enable: %TRUE to enable manual HTTP mode
2810 * By setting the HTTP mode to %TRUE the message parsing will support HTTP
2811 * messages in addition to the RTSP messages. It will also disable the
2812 * automatic handling of setting up an HTTP tunnel.
2817 gst_rtsp_connection_set_http_mode (GstRTSPConnection * conn, gboolean enable)
2819 g_return_if_fail (conn != NULL);
2821 conn->manual_http = enable;
2825 * gst_rtsp_connection_set_tunneled:
2826 * @conn: a #GstRTSPConnection
2827 * @tunneled: the new state
2829 * Set the HTTP tunneling state of the connection. This must be configured before
2830 * the @conn is connected.
2835 gst_rtsp_connection_set_tunneled (GstRTSPConnection * conn, gboolean tunneled)
2837 g_return_if_fail (conn != NULL);
2838 g_return_if_fail (conn->readfd == NULL);
2839 g_return_if_fail (conn->writefd == NULL);
2841 conn->tunneled = tunneled;
2845 * gst_rtsp_connection_is_tunneled:
2846 * @conn: a #GstRTSPConnection
2848 * Get the tunneling state of the connection.
2850 * Returns: if @conn is using HTTP tunneling.
2855 gst_rtsp_connection_is_tunneled (const GstRTSPConnection * conn)
2857 g_return_val_if_fail (conn != NULL, FALSE);
2859 return conn->tunneled;
2863 * gst_rtsp_connection_get_tunnelid:
2864 * @conn: a #GstRTSPConnection
2866 * Get the tunnel session id the connection.
2868 * Returns: returns a non-empty string if @conn is being tunneled over HTTP.
2873 gst_rtsp_connection_get_tunnelid (const GstRTSPConnection * conn)
2875 g_return_val_if_fail (conn != NULL, NULL);
2877 if (!conn->tunneled)
2880 return conn->tunnelid;
2884 * gst_rtsp_connection_do_tunnel:
2885 * @conn: a #GstRTSPConnection
2886 * @conn2: a #GstRTSPConnection or %NULL
2888 * If @conn received the first tunnel connection and @conn2 received
2889 * the second tunnel connection, link the two connections together so that
2890 * @conn manages the tunneled connection.
2892 * After this call, @conn2 cannot be used anymore and must be freed with
2893 * gst_rtsp_connection_free().
2895 * If @conn2 is %NULL then only the base64 decoding context will be setup for
2898 * Returns: return GST_RTSP_OK on success.
2903 gst_rtsp_connection_do_tunnel (GstRTSPConnection * conn,
2904 GstRTSPConnection * conn2)
2906 g_return_val_if_fail (conn != NULL, GST_RTSP_EINVAL);
2908 if (conn2 != NULL) {
2909 g_return_val_if_fail (conn->tstate == TUNNEL_STATE_GET, GST_RTSP_EINVAL);
2910 g_return_val_if_fail (conn2->tstate == TUNNEL_STATE_POST, GST_RTSP_EINVAL);
2911 g_return_val_if_fail (!memcmp (conn2->tunnelid, conn->tunnelid,
2912 TUNNELID_LEN), GST_RTSP_EINVAL);
2914 /* both connections have fd0 as the read/write socket. start by taking the
2915 * socket from conn2 and set it as the socket in conn */
2916 conn->fd1 = conn2->fd0;
2918 /* clean up some of the state of conn2 */
2919 gst_poll_remove_fd (conn2->fdset, &conn2->fd0);
2921 conn2->readfd = conn2->writefd = NULL;
2923 /* We make fd0 the write socket and fd1 the read socket. */
2924 conn->writefd = &conn->fd0;
2925 conn->readfd = &conn->fd1;
2927 conn->tstate = TUNNEL_STATE_COMPLETE;
2930 /* we need base64 decoding for the readfd */
2931 conn->ctx.state = 0;
2934 conn->ctx.coutl = 0;
2935 conn->ctxp = &conn->ctx;
2940 #define READ_COND (G_IO_IN | G_IO_HUP | G_IO_ERR)
2941 #define WRITE_COND (G_IO_OUT | G_IO_ERR)
2950 /* async functions */
2951 struct _GstRTSPWatch
2955 GstRTSPConnection *conn;
2957 GstRTSPBuilder builder;
2958 GstRTSPMessage message;
2962 gboolean write_added;
2964 /* queued message for transmission */
2973 GstRTSPWatchFuncs funcs;
2976 GDestroyNotify notify;
2980 gst_rtsp_source_prepare (GSource * source, gint * timeout)
2982 GstRTSPWatch *watch = (GstRTSPWatch *) source;
2984 if (watch->conn->initial_buffer != NULL)
2987 *timeout = (watch->conn->timeout * 1000);
2993 gst_rtsp_source_check (GSource * source)
2995 GstRTSPWatch *watch = (GstRTSPWatch *) source;
2997 if (watch->readfd.revents & READ_COND)
3000 if (watch->writefd.revents & WRITE_COND)
3007 gst_rtsp_source_dispatch (GSource * source, GSourceFunc callback G_GNUC_UNUSED,
3008 gpointer user_data G_GNUC_UNUSED)
3010 GstRTSPWatch *watch = (GstRTSPWatch *) source;
3013 /* first read as much as we can */
3014 if (watch->readfd.revents & READ_COND || watch->conn->initial_buffer != NULL) {
3016 res = build_next (&watch->builder, &watch->message, watch->conn);
3017 if (res == GST_RTSP_EINTR)
3019 else if (G_UNLIKELY (res == GST_RTSP_EEOF))
3021 else if (G_LIKELY (res == GST_RTSP_OK)) {
3022 if (!watch->conn->manual_http &&
3023 watch->message.type == GST_RTSP_MESSAGE_HTTP_REQUEST) {
3024 if (watch->conn->tstate == TUNNEL_STATE_NONE &&
3025 watch->message.type_data.request.method == GST_RTSP_GET) {
3026 GstRTSPMessage *response;
3027 GstRTSPStatusCode code;
3029 watch->conn->tstate = TUNNEL_STATE_GET;
3031 if (watch->funcs.tunnel_start)
3032 code = watch->funcs.tunnel_start (watch, watch->user_data);
3034 code = GST_RTSP_STS_OK;
3036 /* queue the response */
3037 response = gen_tunnel_reply (watch->conn, code, &watch->message);
3038 gst_rtsp_watch_queue_message (watch, response);
3039 gst_rtsp_message_free (response);
3041 } else if (watch->conn->tstate == TUNNEL_STATE_NONE &&
3042 watch->message.type_data.request.method == GST_RTSP_POST) {
3043 watch->conn->tstate = TUNNEL_STATE_POST;
3045 /* in the callback the connection should be tunneled with the
3047 if (watch->funcs.tunnel_complete)
3048 watch->funcs.tunnel_complete (watch, watch->user_data);
3054 if (!watch->conn->manual_http) {
3055 /* if manual HTTP support is not enabled, then restore the message to
3056 * what it would have looked like without the support for parsing HTTP
3057 * messages being present */
3058 if (watch->message.type == GST_RTSP_MESSAGE_HTTP_REQUEST) {
3059 watch->message.type = GST_RTSP_MESSAGE_REQUEST;
3060 watch->message.type_data.request.method = GST_RTSP_INVALID;
3061 if (watch->message.type_data.request.version != GST_RTSP_VERSION_1_0)
3062 watch->message.type_data.request.version = GST_RTSP_VERSION_INVALID;
3063 } else if (watch->message.type == GST_RTSP_MESSAGE_HTTP_RESPONSE) {
3064 watch->message.type = GST_RTSP_MESSAGE_RESPONSE;
3065 if (watch->message.type_data.response.version != GST_RTSP_VERSION_1_0)
3066 watch->message.type_data.response.version =
3067 GST_RTSP_VERSION_INVALID;
3069 res = GST_RTSP_EPARSE;
3072 if (G_LIKELY (res == GST_RTSP_OK)) {
3073 if (watch->funcs.message_received)
3074 watch->funcs.message_received (watch, &watch->message,
3077 if (watch->funcs.error_full)
3078 GST_RTSP_CHECK (watch->funcs.error_full (watch, res, &watch->message,
3079 0, watch->user_data), error);
3085 gst_rtsp_message_unset (&watch->message);
3086 build_reset (&watch->builder);
3090 if (watch->writefd.revents & WRITE_COND) {
3091 g_mutex_lock (watch->mutex);
3093 if (watch->write_data == NULL) {
3096 /* get a new message from the queue */
3097 rec = g_queue_pop_tail (watch->messages);
3101 watch->write_off = 0;
3102 watch->write_data = rec->data;
3103 watch->write_size = rec->size;
3104 watch->write_id = rec->id;
3106 g_slice_free (GstRTSPRec, rec);
3109 res = write_bytes (watch->writefd.fd, watch->write_data,
3110 &watch->write_off, watch->write_size);
3111 g_mutex_unlock (watch->mutex);
3112 if (res == GST_RTSP_EINTR)
3114 else if (G_LIKELY (res == GST_RTSP_OK)) {
3115 if (watch->funcs.message_sent)
3116 watch->funcs.message_sent (watch, watch->write_id, watch->user_data);
3118 if (watch->funcs.error_full)
3119 GST_RTSP_CHECK (watch->funcs.error_full (watch, res, NULL,
3120 watch->write_id, watch->user_data), error);
3124 g_mutex_lock (watch->mutex);
3126 g_free (watch->write_data);
3127 watch->write_data = NULL;
3131 if (watch->write_added) {
3132 g_source_remove_poll ((GSource *) watch, &watch->writefd);
3133 watch->write_added = FALSE;
3134 watch->writefd.revents = 0;
3137 g_mutex_unlock (watch->mutex);
3146 if (watch->funcs.closed)
3147 watch->funcs.closed (watch, watch->user_data);
3152 if (watch->funcs.error)
3153 watch->funcs.error (watch, res, watch->user_data);
3159 gst_rtsp_rec_free (gpointer data)
3161 GstRTSPRec *rec = data;
3164 g_slice_free (GstRTSPRec, rec);
3168 gst_rtsp_source_finalize (GSource * source)
3170 GstRTSPWatch *watch = (GstRTSPWatch *) source;
3172 build_reset (&watch->builder);
3173 gst_rtsp_message_unset (&watch->message);
3175 g_queue_foreach (watch->messages, (GFunc) gst_rtsp_rec_free, NULL);
3176 g_queue_free (watch->messages);
3177 watch->messages = NULL;
3179 g_mutex_free (watch->mutex);
3181 g_free (watch->write_data);
3184 watch->notify (watch->user_data);
3187 static GSourceFuncs gst_rtsp_source_funcs = {
3188 gst_rtsp_source_prepare,
3189 gst_rtsp_source_check,
3190 gst_rtsp_source_dispatch,
3191 gst_rtsp_source_finalize,
3197 * gst_rtsp_watch_new:
3198 * @conn: a #GstRTSPConnection
3199 * @funcs: watch functions
3200 * @user_data: user data to pass to @funcs
3201 * @notify: notify when @user_data is not referenced anymore
3203 * Create a watch object for @conn. The functions provided in @funcs will be
3204 * called with @user_data when activity happened on the watch.
3206 * The new watch is usually created so that it can be attached to a
3207 * maincontext with gst_rtsp_watch_attach().
3209 * @conn must exist for the entire lifetime of the watch.
3211 * Returns: a #GstRTSPWatch that can be used for asynchronous RTSP
3212 * communication. Free with gst_rtsp_watch_unref () after usage.
3217 gst_rtsp_watch_new (GstRTSPConnection * conn,
3218 GstRTSPWatchFuncs * funcs, gpointer user_data, GDestroyNotify notify)
3220 GstRTSPWatch *result;
3222 g_return_val_if_fail (conn != NULL, NULL);
3223 g_return_val_if_fail (funcs != NULL, NULL);
3224 g_return_val_if_fail (conn->readfd != NULL, NULL);
3225 g_return_val_if_fail (conn->writefd != NULL, NULL);
3227 result = (GstRTSPWatch *) g_source_new (&gst_rtsp_source_funcs,
3228 sizeof (GstRTSPWatch));
3230 result->conn = conn;
3231 result->builder.state = STATE_START;
3233 result->mutex = g_mutex_new ();
3234 result->messages = g_queue_new ();
3236 result->readfd.fd = -1;
3237 result->writefd.fd = -1;
3239 gst_rtsp_watch_reset (result);
3241 result->funcs = *funcs;
3242 result->user_data = user_data;
3243 result->notify = notify;
3245 /* only add the read fd, the write fd is only added when we have data
3247 g_source_add_poll ((GSource *) result, &result->readfd);
3253 * gst_rtsp_watch_reset:
3254 * @watch: a #GstRTSPWatch
3256 * Reset @watch, this is usually called after gst_rtsp_connection_do_tunnel()
3257 * when the file descriptors of the connection might have changed.
3262 gst_rtsp_watch_reset (GstRTSPWatch * watch)
3264 if (watch->readfd.fd != -1)
3265 g_source_remove_poll ((GSource *) watch, &watch->readfd);
3266 if (watch->writefd.fd != -1)
3267 g_source_remove_poll ((GSource *) watch, &watch->writefd);
3269 watch->readfd.fd = watch->conn->readfd->fd;
3270 watch->readfd.events = READ_COND;
3271 watch->readfd.revents = 0;
3273 watch->writefd.fd = watch->conn->writefd->fd;
3274 watch->writefd.events = WRITE_COND;
3275 watch->writefd.revents = 0;
3276 watch->write_added = FALSE;
3278 g_source_add_poll ((GSource *) watch, &watch->readfd);
3282 * gst_rtsp_watch_attach:
3283 * @watch: a #GstRTSPWatch
3284 * @context: a GMainContext (if NULL, the default context will be used)
3286 * Adds a #GstRTSPWatch to a context so that it will be executed within that context.
3288 * Returns: the ID (greater than 0) for the watch within the GMainContext.
3293 gst_rtsp_watch_attach (GstRTSPWatch * watch, GMainContext * context)
3295 g_return_val_if_fail (watch != NULL, 0);
3297 return g_source_attach ((GSource *) watch, context);
3301 * gst_rtsp_watch_unref:
3302 * @watch: a #GstRTSPWatch
3304 * Decreases the reference count of @watch by one. If the resulting reference
3305 * count is zero the watch and associated memory will be destroyed.
3310 gst_rtsp_watch_unref (GstRTSPWatch * watch)
3312 g_return_if_fail (watch != NULL);
3314 g_source_unref ((GSource *) watch);
3318 * gst_rtsp_watch_queue_data:
3319 * @watch: a #GstRTSPWatch
3320 * @data: the data to queue
3321 * @size: the size of @data
3323 * Queue @data for transmission in @watch. It will be transmitted when the
3324 * connection of the @watch becomes writable.
3326 * This function will take ownership of @data and g_free() it after use.
3328 * The return value of this function will be used as the id argument in the
3329 * message_sent callback.
3336 gst_rtsp_watch_queue_data (GstRTSPWatch * watch, const guint8 * data,
3341 g_return_val_if_fail (watch != NULL, GST_RTSP_EINVAL);
3342 g_return_val_if_fail (data != NULL, GST_RTSP_EINVAL);
3343 g_return_val_if_fail (size != 0, GST_RTSP_EINVAL);
3345 g_mutex_lock (watch->mutex);
3347 /* make a record with the data and id */
3348 rec = g_slice_new (GstRTSPRec);
3349 rec->data = (guint8 *) data;
3352 /* make sure rec->id is never 0 */
3353 rec->id = ++watch->id;
3354 } while (G_UNLIKELY (rec->id == 0));
3356 /* add the record to a queue. FIXME we would like to have an upper limit here */
3357 g_queue_push_head (watch->messages, rec);
3359 /* make sure the main context will now also check for writability on the
3361 if (!watch->write_added) {
3362 g_source_add_poll ((GSource *) watch, &watch->writefd);
3363 watch->write_added = TRUE;
3366 g_mutex_unlock (watch->mutex);
3371 * gst_rtsp_watch_queue_message:
3372 * @watch: a #GstRTSPWatch
3373 * @message: a #GstRTSPMessage
3375 * Queue a @message for transmission in @watch. The contents of this
3376 * message will be serialized and transmitted when the connection of the
3377 * @watch becomes writable.
3379 * The return value of this function will be used as the id argument in the
3380 * message_sent callback.
3387 gst_rtsp_watch_queue_message (GstRTSPWatch * watch, GstRTSPMessage * message)
3392 g_return_val_if_fail (watch != NULL, GST_RTSP_EINVAL);
3393 g_return_val_if_fail (message != NULL, GST_RTSP_EINVAL);
3395 /* make a record with the message as a string and id */
3396 str = message_to_string (watch->conn, message);
3398 return gst_rtsp_watch_queue_data (watch,
3399 (guint8 *) g_string_free (str, FALSE), size);