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;
642 memset (&response, 0, sizeof (response));
643 gst_rtsp_message_init (&response);
645 /* create a random sessionid */
646 for (i = 0; i < TUNNELID_LEN; i++)
647 conn->tunnelid[i] = g_random_int_range ('a', 'z');
648 conn->tunnelid[TUNNELID_LEN - 1] = '\0';
651 /* get the port from the url */
652 gst_rtsp_url_get_port (url, &url_port);
654 if (conn->proxy_host) {
655 uri = g_strdup_printf ("http://%s:%d%s%s%s", url->host, url_port,
656 url->abspath, url->query ? "?" : "", url->query ? url->query : "");
657 hostparam = g_strdup_printf ("%s:%d", url->host, url_port);
658 ip = conn->proxy_host;
659 port = conn->proxy_port;
661 uri = g_strdup_printf ("%s%s%s", url->abspath, url->query ? "?" : "",
662 url->query ? url->query : "");
668 /* create the GET request for the read connection */
669 GST_RTSP_CHECK (gst_rtsp_message_new_request (&msg, GST_RTSP_GET, uri),
671 msg->type = GST_RTSP_MESSAGE_HTTP_REQUEST;
673 if (hostparam != NULL)
674 gst_rtsp_message_add_header (msg, GST_RTSP_HDR_HOST, hostparam);
675 gst_rtsp_message_add_header (msg, GST_RTSP_HDR_X_SESSIONCOOKIE,
677 gst_rtsp_message_add_header (msg, GST_RTSP_HDR_ACCEPT,
678 "application/x-rtsp-tunnelled");
679 gst_rtsp_message_add_header (msg, GST_RTSP_HDR_CACHE_CONTROL, "no-cache");
680 gst_rtsp_message_add_header (msg, GST_RTSP_HDR_PRAGMA, "no-cache");
682 /* we start by writing to this fd */
683 conn->writefd = &conn->fd0;
685 /* we need to temporarily set conn->tunneled to FALSE to prevent the HTTP
686 * request from being base64 encoded */
687 conn->tunneled = FALSE;
688 GST_RTSP_CHECK (gst_rtsp_connection_send (conn, msg, timeout), write_failed);
689 gst_rtsp_message_free (msg);
690 conn->tunneled = TRUE;
692 /* receive the response to the GET request */
693 /* we need to temporarily set manual_http to TRUE since
694 * gst_rtsp_connection_receive() will treat the HTTP response as a parsing
695 * failure otherwise */
696 old_http = conn->manual_http;
697 conn->manual_http = TRUE;
698 GST_RTSP_CHECK (gst_rtsp_connection_receive (conn, &response, timeout),
700 conn->manual_http = old_http;
702 if (response.type != GST_RTSP_MESSAGE_HTTP_RESPONSE ||
703 response.type_data.response.code != GST_RTSP_STS_OK)
706 if (gst_rtsp_message_get_header (&response, GST_RTSP_HDR_X_SERVER_IP_ADDRESS,
707 &value, 0) != GST_RTSP_OK) {
708 if (conn->proxy_host) {
709 /* if we use a proxy we need to change the destination url */
711 url->host = g_strdup (value);
713 hostparam = g_strdup_printf ("%s:%d", url->host, url_port);
715 /* and resolve the new ip address */
716 if (!(ip = do_resolve (conn->ip)))
723 /* connect to the host/port */
724 res = do_connect (ip, port, &conn->fd1, conn->fdset, timeout);
725 if (res != GST_RTSP_OK)
728 /* this is now our writing socket */
729 conn->writefd = &conn->fd1;
731 /* create the POST request for the write connection */
732 GST_RTSP_CHECK (gst_rtsp_message_new_request (&msg, GST_RTSP_POST, uri),
734 msg->type = GST_RTSP_MESSAGE_HTTP_REQUEST;
736 if (hostparam != NULL)
737 gst_rtsp_message_add_header (msg, GST_RTSP_HDR_HOST, hostparam);
738 gst_rtsp_message_add_header (msg, GST_RTSP_HDR_X_SESSIONCOOKIE,
740 gst_rtsp_message_add_header (msg, GST_RTSP_HDR_ACCEPT,
741 "application/x-rtsp-tunnelled");
742 gst_rtsp_message_add_header (msg, GST_RTSP_HDR_CACHE_CONTROL, "no-cache");
743 gst_rtsp_message_add_header (msg, GST_RTSP_HDR_PRAGMA, "no-cache");
744 gst_rtsp_message_add_header (msg, GST_RTSP_HDR_EXPIRES,
745 "Sun, 9 Jan 1972 00:00:00 GMT");
746 gst_rtsp_message_add_header (msg, GST_RTSP_HDR_CONTENT_LENGTH, "32767");
748 /* we need to temporarily set conn->tunneled to FALSE to prevent the HTTP
749 * request from being base64 encoded */
750 conn->tunneled = FALSE;
751 GST_RTSP_CHECK (gst_rtsp_connection_send (conn, msg, timeout), write_failed);
752 gst_rtsp_message_free (msg);
753 conn->tunneled = TRUE;
756 gst_rtsp_message_unset (&response);
765 GST_ERROR ("failed to create request (%d)", res);
770 GST_ERROR ("write failed (%d)", res);
771 gst_rtsp_message_free (msg);
772 conn->tunneled = TRUE;
777 GST_ERROR ("read failed (%d)", res);
778 conn->manual_http = FALSE;
783 GST_ERROR ("got failure response %d %s", response.type_data.response.code,
784 response.type_data.response.reason);
785 res = GST_RTSP_ERROR;
790 GST_ERROR ("could not resolve %s", conn->ip);
796 GST_ERROR ("failed to connect");
802 * gst_rtsp_connection_connect:
803 * @conn: a #GstRTSPConnection
804 * @timeout: a #GTimeVal timeout
806 * Attempt to connect to the url of @conn made with
807 * gst_rtsp_connection_create(). If @timeout is #NULL this function can block
808 * forever. If @timeout contains a valid timeout, this function will return
809 * #GST_RTSP_ETIMEOUT after the timeout expired.
811 * This function can be cancelled with gst_rtsp_connection_flush().
813 * Returns: #GST_RTSP_OK when a connection could be made.
816 gst_rtsp_connection_connect (GstRTSPConnection * conn, GTimeVal * timeout)
823 g_return_val_if_fail (conn != NULL, GST_RTSP_EINVAL);
824 g_return_val_if_fail (conn->url != NULL, GST_RTSP_EINVAL);
825 g_return_val_if_fail (conn->fd0.fd < 0, GST_RTSP_EINVAL);
829 if (conn->proxy_host && conn->tunneled) {
830 if (!(ip = do_resolve (conn->proxy_host))) {
831 GST_ERROR ("could not resolve %s", conn->proxy_host);
834 port = conn->proxy_port;
835 g_free (conn->proxy_host);
836 conn->proxy_host = ip;
838 if (!(ip = do_resolve (url->host))) {
839 GST_ERROR ("could not resolve %s", url->host);
842 /* get the port from the url */
843 gst_rtsp_url_get_port (url, &port);
849 /* connect to the host/port */
850 res = do_connect (ip, port, &conn->fd0, conn->fdset, timeout);
851 if (res != GST_RTSP_OK)
854 /* this is our read URL */
855 conn->readfd = &conn->fd0;
857 if (conn->tunneled) {
858 res = setup_tunneling (conn, timeout);
859 if (res != GST_RTSP_OK)
860 goto tunneling_failed;
862 conn->writefd = &conn->fd0;
869 return GST_RTSP_ENET;
873 GST_ERROR ("failed to connect");
878 GST_ERROR ("failed to setup tunneling");
884 auth_digest_compute_hex_urp (const gchar * username,
885 const gchar * realm, const gchar * password, gchar hex_urp[33])
887 GChecksum *md5_context = g_checksum_new (G_CHECKSUM_MD5);
888 const gchar *digest_string;
890 g_checksum_update (md5_context, (const guchar *) username, strlen (username));
891 g_checksum_update (md5_context, (const guchar *) ":", 1);
892 g_checksum_update (md5_context, (const guchar *) realm, strlen (realm));
893 g_checksum_update (md5_context, (const guchar *) ":", 1);
894 g_checksum_update (md5_context, (const guchar *) password, strlen (password));
895 digest_string = g_checksum_get_string (md5_context);
897 memset (hex_urp, 0, 33);
898 memcpy (hex_urp, digest_string, strlen (digest_string));
900 g_checksum_free (md5_context);
904 auth_digest_compute_response (const gchar * method,
905 const gchar * uri, const gchar * hex_a1, const gchar * nonce,
908 char hex_a2[33] = { 0, };
909 GChecksum *md5_context = g_checksum_new (G_CHECKSUM_MD5);
910 const gchar *digest_string;
913 g_checksum_update (md5_context, (const guchar *) method, strlen (method));
914 g_checksum_update (md5_context, (const guchar *) ":", 1);
915 g_checksum_update (md5_context, (const guchar *) uri, strlen (uri));
916 digest_string = g_checksum_get_string (md5_context);
917 memcpy (hex_a2, digest_string, strlen (digest_string));
920 #if GLIB_CHECK_VERSION (2, 18, 0)
921 g_checksum_reset (md5_context);
923 g_checksum_free (md5_context);
924 md5_context = g_checksum_new (G_CHECKSUM_MD5);
926 g_checksum_update (md5_context, (const guchar *) hex_a1, strlen (hex_a1));
927 g_checksum_update (md5_context, (const guchar *) ":", 1);
928 g_checksum_update (md5_context, (const guchar *) nonce, strlen (nonce));
929 g_checksum_update (md5_context, (const guchar *) ":", 1);
931 g_checksum_update (md5_context, (const guchar *) hex_a2, 32);
932 digest_string = g_checksum_get_string (md5_context);
933 memset (response, 0, 33);
934 memcpy (response, digest_string, strlen (digest_string));
936 g_checksum_free (md5_context);
940 add_auth_header (GstRTSPConnection * conn, GstRTSPMessage * message)
942 switch (conn->auth_method) {
943 case GST_RTSP_AUTH_BASIC:{
948 user_pass = g_strdup_printf ("%s:%s", conn->username, conn->passwd);
949 user_pass64 = g_base64_encode ((guchar *) user_pass, strlen (user_pass));
950 auth_string = g_strdup_printf ("Basic %s", user_pass64);
952 gst_rtsp_message_take_header (message, GST_RTSP_HDR_AUTHORIZATION,
956 g_free (user_pass64);
959 case GST_RTSP_AUTH_DIGEST:{
960 gchar response[33], hex_urp[33];
961 gchar *auth_string, *auth_string2;
968 /* we need to have some params set */
969 if (conn->auth_params == NULL)
972 /* we need the realm and nonce */
973 realm = (gchar *) g_hash_table_lookup (conn->auth_params, "realm");
974 nonce = (gchar *) g_hash_table_lookup (conn->auth_params, "nonce");
975 if (realm == NULL || nonce == NULL)
978 auth_digest_compute_hex_urp (conn->username, realm, conn->passwd,
981 method = gst_rtsp_method_as_text (message->type_data.request.method);
982 uri = message->type_data.request.uri;
984 /* Assume no qop, algorithm=md5, stale=false */
985 /* For algorithm MD5, a1 = urp. */
986 auth_digest_compute_response (method, uri, hex_urp, nonce, response);
987 auth_string = g_strdup_printf ("Digest username=\"%s\", "
988 "realm=\"%s\", nonce=\"%s\", uri=\"%s\", response=\"%s\"",
989 conn->username, realm, nonce, uri, response);
991 opaque = (gchar *) g_hash_table_lookup (conn->auth_params, "opaque");
993 auth_string2 = g_strdup_printf ("%s, opaque=\"%s\"", auth_string,
995 g_free (auth_string);
996 auth_string = auth_string2;
998 gst_rtsp_message_take_header (message, GST_RTSP_HDR_AUTHORIZATION,
1009 gen_date_string (gchar * date_string, guint len)
1013 #ifdef HAVE_GMTIME_R
1017 g_get_current_time (&tv);
1018 t = (time_t) tv.tv_sec;
1020 #ifdef HAVE_GMTIME_R
1021 strftime (date_string, len, "%a, %d %b %Y %H:%M:%S GMT", gmtime_r (&t, &tm_));
1023 strftime (date_string, len, "%a, %d %b %Y %H:%M:%S GMT", gmtime (&t));
1027 static GstRTSPResult
1028 write_bytes (gint fd, const guint8 * buffer, guint * idx, guint size)
1032 if (G_UNLIKELY (*idx > size))
1033 return GST_RTSP_ERROR;
1040 r = WRITE_SOCKET (fd, &buffer[*idx], left);
1041 if (G_UNLIKELY (r == 0)) {
1042 return GST_RTSP_EINTR;
1043 } else if (G_UNLIKELY (r < 0)) {
1044 if (ERRNO_IS_EAGAIN)
1045 return GST_RTSP_EINTR;
1046 if (!ERRNO_IS_EINTR)
1047 return GST_RTSP_ESYS;
1057 fill_raw_bytes (GstRTSPConnection * conn, guint8 * buffer, guint size)
1061 if (G_UNLIKELY (conn->initial_buffer != NULL)) {
1062 gsize left = strlen (&conn->initial_buffer[conn->initial_buffer_offset]);
1064 out = MIN (left, size);
1065 memcpy (buffer, &conn->initial_buffer[conn->initial_buffer_offset], out);
1067 if (left == (gsize) out) {
1068 g_free (conn->initial_buffer);
1069 conn->initial_buffer = NULL;
1070 conn->initial_buffer_offset = 0;
1072 conn->initial_buffer_offset += out;
1075 if (G_LIKELY (size > (guint) out)) {
1078 r = READ_SOCKET (conn->readfd->fd, &buffer[out], size - out);
1090 fill_bytes (GstRTSPConnection * conn, guint8 * buffer, guint size)
1092 DecodeCtx *ctx = conn->ctxp;
1097 guint8 in[sizeof (ctx->out) * 4 / 3];
1100 while (size > 0 && ctx->cout < ctx->coutl) {
1101 /* we have some leftover bytes */
1102 *buffer++ = ctx->out[ctx->cout++];
1107 /* got what we needed? */
1111 /* try to read more bytes */
1112 r = fill_raw_bytes (conn, in, sizeof (in));
1121 g_base64_decode_step ((gchar *) in, r, ctx->out, &ctx->state,
1125 out = fill_raw_bytes (conn, buffer, size);
1131 static GstRTSPResult
1132 read_bytes (GstRTSPConnection * conn, guint8 * buffer, guint * idx, guint size)
1136 if (G_UNLIKELY (*idx > size))
1137 return GST_RTSP_ERROR;
1144 r = fill_bytes (conn, &buffer[*idx], left);
1145 if (G_UNLIKELY (r == 0)) {
1146 return GST_RTSP_EEOF;
1147 } else if (G_UNLIKELY (r < 0)) {
1148 if (ERRNO_IS_EAGAIN)
1149 return GST_RTSP_EINTR;
1150 if (!ERRNO_IS_EINTR)
1151 return GST_RTSP_ESYS;
1160 /* The code below tries to handle clients using \r, \n or \r\n to indicate the
1161 * end of a line. It even does its best to handle clients which mix them (even
1162 * though this is a really stupid idea (tm).) It also handles Line White Space
1163 * (LWS), where a line end followed by whitespace is considered LWS. This is
1164 * the method used in RTSP (and HTTP) to break long lines.
1166 static GstRTSPResult
1167 read_line (GstRTSPConnection * conn, guint8 * buffer, guint * idx, guint size)
1173 if (conn->read_ahead == READ_AHEAD_EOH) {
1174 /* the last call to read_line() already determined that we have reached
1175 * the end of the headers, so convey that information now */
1176 conn->read_ahead = 0;
1178 } else if (conn->read_ahead == READ_AHEAD_CRLF) {
1179 /* the last call to read_line() left off after having read \r\n */
1181 } else if (conn->read_ahead == READ_AHEAD_CRLFCR) {
1182 /* the last call to read_line() left off after having read \r\n\r */
1184 } else if (conn->read_ahead != 0) {
1185 /* the last call to read_line() left us with a character to start with */
1186 c = (guint8) conn->read_ahead;
1187 conn->read_ahead = 0;
1189 /* read the next character */
1190 r = fill_bytes (conn, &c, 1);
1191 if (G_UNLIKELY (r == 0)) {
1192 return GST_RTSP_EEOF;
1193 } else if (G_UNLIKELY (r < 0)) {
1194 if (ERRNO_IS_EAGAIN)
1195 return GST_RTSP_EINTR;
1196 if (!ERRNO_IS_EINTR)
1197 return GST_RTSP_ESYS;
1202 /* special treatment of line endings */
1203 if (c == '\r' || c == '\n') {
1207 /* need to read ahead one more character to know what to do... */
1208 r = fill_bytes (conn, &read_ahead, 1);
1209 if (G_UNLIKELY (r == 0)) {
1210 return GST_RTSP_EEOF;
1211 } else if (G_UNLIKELY (r < 0)) {
1212 if (ERRNO_IS_EAGAIN) {
1213 /* remember the original character we read and try again next time */
1214 if (conn->read_ahead == 0)
1215 conn->read_ahead = c;
1216 return GST_RTSP_EINTR;
1218 if (!ERRNO_IS_EINTR)
1219 return GST_RTSP_ESYS;
1223 if (read_ahead == ' ' || read_ahead == '\t') {
1224 if (conn->read_ahead == READ_AHEAD_CRLFCR) {
1225 /* got \r\n\r followed by whitespace, treat it as a normal line
1226 * followed by one starting with LWS */
1227 conn->read_ahead = read_ahead;
1230 /* got LWS, change the line ending to a space and continue */
1232 conn->read_ahead = read_ahead;
1234 } else if (conn->read_ahead == READ_AHEAD_CRLFCR) {
1235 if (read_ahead == '\r' || read_ahead == '\n') {
1236 /* got \r\n\r\r or \r\n\r\n, treat it as the end of the headers */
1237 conn->read_ahead = READ_AHEAD_EOH;
1240 /* got \r\n\r followed by something else, this is not really
1241 * supported since we have probably just eaten the first character
1242 * of the body or the next message, so just ignore the second \r
1243 * and live with it... */
1244 conn->read_ahead = read_ahead;
1247 } else if (conn->read_ahead == READ_AHEAD_CRLF) {
1248 if (read_ahead == '\r') {
1249 /* got \r\n\r so far, need one more character... */
1250 conn->read_ahead = READ_AHEAD_CRLFCR;
1252 } else if (read_ahead == '\n') {
1253 /* got \r\n\n, treat it as the end of the headers */
1254 conn->read_ahead = READ_AHEAD_EOH;
1257 /* found the end of a line, keep read_ahead for the next line */
1258 conn->read_ahead = read_ahead;
1261 } else if (c == read_ahead) {
1262 /* got double \r or \n, treat it as the end of the headers */
1263 conn->read_ahead = READ_AHEAD_EOH;
1265 } else if (c == '\r' && read_ahead == '\n') {
1266 /* got \r\n so far, still need more to know what to do... */
1267 conn->read_ahead = READ_AHEAD_CRLF;
1270 /* found the end of a line, keep read_ahead for the next line */
1271 conn->read_ahead = read_ahead;
1276 if (G_LIKELY (*idx < size - 1))
1277 buffer[(*idx)++] = c;
1279 buffer[*idx] = '\0';
1285 * gst_rtsp_connection_write:
1286 * @conn: a #GstRTSPConnection
1287 * @data: the data to write
1288 * @size: the size of @data
1289 * @timeout: a timeout value or #NULL
1291 * Attempt to write @size bytes of @data to the connected @conn, blocking up to
1292 * the specified @timeout. @timeout can be #NULL, in which case this function
1293 * might block forever.
1295 * This function can be cancelled with gst_rtsp_connection_flush().
1297 * Returns: #GST_RTSP_OK on success.
1300 gst_rtsp_connection_write (GstRTSPConnection * conn, const guint8 * data,
1301 guint size, GTimeVal * timeout)
1308 g_return_val_if_fail (conn != NULL, GST_RTSP_EINVAL);
1309 g_return_val_if_fail (data != NULL || size == 0, GST_RTSP_EINVAL);
1310 g_return_val_if_fail (conn->writefd != NULL, GST_RTSP_EINVAL);
1312 gst_poll_set_controllable (conn->fdset, TRUE);
1313 gst_poll_fd_ctl_write (conn->fdset, conn->writefd, TRUE);
1314 gst_poll_fd_ctl_read (conn->fdset, conn->readfd, FALSE);
1315 /* clear all previous poll results */
1316 gst_poll_fd_ignored (conn->fdset, conn->writefd);
1317 gst_poll_fd_ignored (conn->fdset, conn->readfd);
1319 to = timeout ? GST_TIMEVAL_TO_TIME (*timeout) : GST_CLOCK_TIME_NONE;
1325 res = write_bytes (conn->writefd->fd, data, &offset, size);
1326 if (G_LIKELY (res == GST_RTSP_OK))
1328 if (G_UNLIKELY (res != GST_RTSP_EINTR))
1331 /* not all is written, wait until we can write more */
1333 retval = gst_poll_wait (conn->fdset, to);
1334 } while (retval == -1 && (errno == EINTR || errno == EAGAIN));
1336 if (G_UNLIKELY (retval == 0))
1339 if (G_UNLIKELY (retval == -1)) {
1351 return GST_RTSP_ETIMEOUT;
1355 return GST_RTSP_ESYS;
1359 return GST_RTSP_EINTR;
1368 message_to_string (GstRTSPConnection * conn, GstRTSPMessage * message)
1370 GString *str = NULL;
1372 str = g_string_new ("");
1374 switch (message->type) {
1375 case GST_RTSP_MESSAGE_REQUEST:
1376 /* create request string, add CSeq */
1377 g_string_append_printf (str, "%s %s RTSP/1.0\r\n"
1379 gst_rtsp_method_as_text (message->type_data.request.method),
1380 message->type_data.request.uri, conn->cseq++);
1381 /* add session id if we have one */
1382 if (conn->session_id[0] != '\0') {
1383 gst_rtsp_message_remove_header (message, GST_RTSP_HDR_SESSION, -1);
1384 gst_rtsp_message_add_header (message, GST_RTSP_HDR_SESSION,
1387 /* add any authentication headers */
1388 add_auth_header (conn, message);
1390 case GST_RTSP_MESSAGE_RESPONSE:
1391 /* create response string */
1392 g_string_append_printf (str, "RTSP/1.0 %d %s\r\n",
1393 message->type_data.response.code, message->type_data.response.reason);
1395 case GST_RTSP_MESSAGE_HTTP_REQUEST:
1396 /* create request string */
1397 g_string_append_printf (str, "%s %s HTTP/%s\r\n",
1398 gst_rtsp_method_as_text (message->type_data.request.method),
1399 message->type_data.request.uri,
1400 gst_rtsp_version_as_text (message->type_data.request.version));
1401 /* add any authentication headers */
1402 add_auth_header (conn, message);
1404 case GST_RTSP_MESSAGE_HTTP_RESPONSE:
1405 /* create response string */
1406 g_string_append_printf (str, "HTTP/%s %d %s\r\n",
1407 gst_rtsp_version_as_text (message->type_data.request.version),
1408 message->type_data.response.code, message->type_data.response.reason);
1410 case GST_RTSP_MESSAGE_DATA:
1412 guint8 data_header[4];
1414 /* prepare data header */
1415 data_header[0] = '$';
1416 data_header[1] = message->type_data.data.channel;
1417 data_header[2] = (message->body_size >> 8) & 0xff;
1418 data_header[3] = message->body_size & 0xff;
1420 /* create string with header and data */
1421 str = g_string_append_len (str, (gchar *) data_header, 4);
1423 g_string_append_len (str, (gchar *) message->body,
1424 message->body_size);
1428 g_string_free (str, TRUE);
1429 g_return_val_if_reached (NULL);
1433 /* append headers and body */
1434 if (message->type != GST_RTSP_MESSAGE_DATA) {
1435 gchar date_string[100];
1437 gen_date_string (date_string, sizeof (date_string));
1439 /* add date header */
1440 gst_rtsp_message_remove_header (message, GST_RTSP_HDR_DATE, -1);
1441 gst_rtsp_message_add_header (message, GST_RTSP_HDR_DATE, date_string);
1443 /* append headers */
1444 gst_rtsp_message_append_headers (message, str);
1446 /* append Content-Length and body if needed */
1447 if (message->body != NULL && message->body_size > 0) {
1450 len = g_strdup_printf ("%d", message->body_size);
1451 g_string_append_printf (str, "%s: %s\r\n",
1452 gst_rtsp_header_as_text (GST_RTSP_HDR_CONTENT_LENGTH), len);
1454 /* header ends here */
1455 g_string_append (str, "\r\n");
1457 g_string_append_len (str, (gchar *) message->body,
1458 message->body_size);
1460 /* just end headers */
1461 g_string_append (str, "\r\n");
1469 * gst_rtsp_connection_send:
1470 * @conn: a #GstRTSPConnection
1471 * @message: the message to send
1472 * @timeout: a timeout value or #NULL
1474 * Attempt to send @message to the connected @conn, blocking up to
1475 * the specified @timeout. @timeout can be #NULL, in which case this function
1476 * might block forever.
1478 * This function can be cancelled with gst_rtsp_connection_flush().
1480 * Returns: #GST_RTSP_OK on success.
1483 gst_rtsp_connection_send (GstRTSPConnection * conn, GstRTSPMessage * message,
1486 GString *string = NULL;
1491 g_return_val_if_fail (conn != NULL, GST_RTSP_EINVAL);
1492 g_return_val_if_fail (message != NULL, GST_RTSP_EINVAL);
1494 if (G_UNLIKELY (!(string = message_to_string (conn, message))))
1497 if (conn->tunneled) {
1498 str = g_base64_encode ((const guchar *) string->str, string->len);
1499 g_string_free (string, TRUE);
1504 g_string_free (string, FALSE);
1508 res = gst_rtsp_connection_write (conn, (guint8 *) str, len, timeout);
1516 g_warning ("Wrong message");
1517 return GST_RTSP_EINVAL;
1521 static GstRTSPResult
1522 parse_string (gchar * dest, gint size, gchar ** src)
1524 GstRTSPResult res = GST_RTSP_OK;
1529 while (g_ascii_isspace (**src))
1532 while (!g_ascii_isspace (**src) && **src != '\0') {
1534 dest[idx++] = **src;
1536 res = GST_RTSP_EPARSE;
1545 static GstRTSPResult
1546 parse_protocol_version (gchar * protocol, GstRTSPMsgType * type,
1547 GstRTSPVersion * version)
1549 GstRTSPResult res = GST_RTSP_OK;
1552 if (G_LIKELY ((ver = strchr (protocol, '/')) != NULL)) {
1559 /* the version number must be formatted as X.Y with nothing following */
1560 if (sscanf (ver, "%u.%u%c", &major, &minor, &dummychar) != 2)
1561 res = GST_RTSP_EPARSE;
1563 if (g_ascii_strcasecmp (protocol, "RTSP") == 0) {
1564 if (major != 1 || minor != 0) {
1565 *version = GST_RTSP_VERSION_INVALID;
1566 res = GST_RTSP_ERROR;
1568 } else if (g_ascii_strcasecmp (protocol, "HTTP") == 0) {
1569 if (*type == GST_RTSP_MESSAGE_REQUEST)
1570 *type = GST_RTSP_MESSAGE_HTTP_REQUEST;
1571 else if (*type == GST_RTSP_MESSAGE_RESPONSE)
1572 *type = GST_RTSP_MESSAGE_HTTP_RESPONSE;
1574 if (major == 1 && minor == 1) {
1575 *version = GST_RTSP_VERSION_1_1;
1576 } else if (major != 1 || minor != 0) {
1577 *version = GST_RTSP_VERSION_INVALID;
1578 res = GST_RTSP_ERROR;
1581 res = GST_RTSP_EPARSE;
1583 res = GST_RTSP_EPARSE;
1588 static GstRTSPResult
1589 parse_response_status (guint8 * buffer, GstRTSPMessage * msg)
1591 GstRTSPResult res = GST_RTSP_OK;
1593 gchar versionstr[20];
1598 bptr = (gchar *) buffer;
1600 if (parse_string (versionstr, sizeof (versionstr), &bptr) != GST_RTSP_OK)
1601 res = GST_RTSP_EPARSE;
1603 if (parse_string (codestr, sizeof (codestr), &bptr) != GST_RTSP_OK)
1604 res = GST_RTSP_EPARSE;
1605 code = atoi (codestr);
1606 if (G_UNLIKELY (*codestr == '\0' || code < 0 || code >= 600))
1607 res = GST_RTSP_EPARSE;
1609 while (g_ascii_isspace (*bptr))
1612 if (G_UNLIKELY (gst_rtsp_message_init_response (msg, code, bptr,
1613 NULL) != GST_RTSP_OK))
1614 res = GST_RTSP_EPARSE;
1616 res2 = parse_protocol_version (versionstr, &msg->type,
1617 &msg->type_data.response.version);
1618 if (G_LIKELY (res == GST_RTSP_OK))
1624 static GstRTSPResult
1625 parse_request_line (guint8 * buffer, GstRTSPMessage * msg)
1627 GstRTSPResult res = GST_RTSP_OK;
1629 gchar versionstr[20];
1630 gchar methodstr[20];
1633 GstRTSPMethod method;
1635 bptr = (gchar *) buffer;
1637 if (parse_string (methodstr, sizeof (methodstr), &bptr) != GST_RTSP_OK)
1638 res = GST_RTSP_EPARSE;
1639 method = gst_rtsp_find_method (methodstr);
1641 if (parse_string (urlstr, sizeof (urlstr), &bptr) != GST_RTSP_OK)
1642 res = GST_RTSP_EPARSE;
1643 if (G_UNLIKELY (*urlstr == '\0'))
1644 res = GST_RTSP_EPARSE;
1646 if (parse_string (versionstr, sizeof (versionstr), &bptr) != GST_RTSP_OK)
1647 res = GST_RTSP_EPARSE;
1649 if (G_UNLIKELY (*bptr != '\0'))
1650 res = GST_RTSP_EPARSE;
1652 if (G_UNLIKELY (gst_rtsp_message_init_request (msg, method,
1653 urlstr) != GST_RTSP_OK))
1654 res = GST_RTSP_EPARSE;
1656 res2 = parse_protocol_version (versionstr, &msg->type,
1657 &msg->type_data.request.version);
1658 if (G_LIKELY (res == GST_RTSP_OK))
1661 if (G_LIKELY (msg->type == GST_RTSP_MESSAGE_REQUEST)) {
1662 /* GET and POST are not allowed as RTSP methods */
1663 if (msg->type_data.request.method == GST_RTSP_GET ||
1664 msg->type_data.request.method == GST_RTSP_POST) {
1665 msg->type_data.request.method = GST_RTSP_INVALID;
1666 if (res == GST_RTSP_OK)
1667 res = GST_RTSP_ERROR;
1669 } else if (msg->type == GST_RTSP_MESSAGE_HTTP_REQUEST) {
1670 /* only GET and POST are allowed as HTTP methods */
1671 if (msg->type_data.request.method != GST_RTSP_GET &&
1672 msg->type_data.request.method != GST_RTSP_POST) {
1673 msg->type_data.request.method = GST_RTSP_INVALID;
1674 if (res == GST_RTSP_OK)
1675 res = GST_RTSP_ERROR;
1682 /* parsing lines means reading a Key: Value pair */
1683 static GstRTSPResult
1684 parse_line (guint8 * buffer, GstRTSPMessage * msg)
1686 GstRTSPHeaderField field;
1687 gchar *line = (gchar *) buffer;
1690 if ((value = strchr (line, ':')) == NULL || value == line)
1693 /* trim space before the colon */
1694 if (value[-1] == ' ')
1697 /* replace the colon with a NUL */
1700 /* find the header */
1701 field = gst_rtsp_find_header_field (line);
1702 if (field == GST_RTSP_HDR_INVALID)
1705 /* split up the value in multiple key:value pairs if it contains comma(s) */
1706 while (*value != '\0') {
1708 gchar *comma = NULL;
1709 gboolean quoted = FALSE;
1712 /* trim leading space */
1716 /* for headers which may not appear multiple times, and thus may not
1717 * contain multiple values on the same line, we can short-circuit the loop
1718 * below and the entire value results in just one key:value pair*/
1719 if (!gst_rtsp_header_allow_multiple (field))
1720 next_value = value + strlen (value);
1724 /* find the next value, taking special care of quotes and comments */
1725 while (*next_value != '\0') {
1726 if ((quoted || comment != 0) && *next_value == '\\' &&
1727 next_value[1] != '\0')
1729 else if (comment == 0 && *next_value == '"')
1731 else if (!quoted && *next_value == '(')
1733 else if (comment != 0 && *next_value == ')')
1735 else if (!quoted && comment == 0) {
1736 /* To quote RFC 2068: "User agents MUST take special care in parsing
1737 * the WWW-Authenticate field value if it contains more than one
1738 * challenge, or if more than one WWW-Authenticate header field is
1739 * provided, since the contents of a challenge may itself contain a
1740 * comma-separated list of authentication parameters."
1742 * What this means is that we cannot just look for an unquoted comma
1743 * when looking for multiple values in Proxy-Authenticate and
1744 * WWW-Authenticate headers. Instead we need to look for the sequence
1745 * "comma [space] token space token" before we can split after the
1748 if (field == GST_RTSP_HDR_PROXY_AUTHENTICATE ||
1749 field == GST_RTSP_HDR_WWW_AUTHENTICATE) {
1750 if (*next_value == ',') {
1751 if (next_value[1] == ' ') {
1752 /* skip any space following the comma so we do not mistake it for
1753 * separating between two tokens */
1757 } else if (*next_value == ' ' && next_value[1] != ',' &&
1758 next_value[1] != '=' && comma != NULL) {
1763 } else if (*next_value == ',')
1771 if (value != next_value && next_value[-1] == ' ')
1772 next_value[-1] = '\0';
1774 if (*next_value != '\0')
1775 *next_value++ = '\0';
1777 /* add the key:value pair */
1779 gst_rtsp_message_add_header (msg, field, value);
1790 return GST_RTSP_EPARSE;
1794 /* convert all consecutive whitespace to a single space */
1796 normalize_line (guint8 * buffer)
1799 if (g_ascii_isspace (*buffer)) {
1803 for (tmp = buffer; g_ascii_isspace (*tmp); tmp++) {
1806 memmove (buffer, tmp, strlen ((gchar *) tmp) + 1);
1814 * GST_RTSP_OK when a complete message was read.
1815 * GST_RTSP_EEOF: when the socket is closed
1816 * GST_RTSP_EINTR: when more data is needed.
1817 * GST_RTSP_..: some other error occured.
1819 static GstRTSPResult
1820 build_next (GstRTSPBuilder * builder, GstRTSPMessage * message,
1821 GstRTSPConnection * conn)
1826 switch (builder->state) {
1828 builder->offset = 0;
1830 read_bytes (conn, (guint8 *) builder->buffer, &builder->offset, 1);
1831 if (res != GST_RTSP_OK)
1834 /* we have 1 bytes now and we can see if this is a data message or
1836 if (builder->buffer[0] == '$') {
1837 /* data message, prepare for the header */
1838 builder->state = STATE_DATA_HEADER;
1841 builder->state = STATE_READ_LINES;
1844 case STATE_DATA_HEADER:
1847 read_bytes (conn, (guint8 *) builder->buffer, &builder->offset, 4);
1848 if (res != GST_RTSP_OK)
1851 gst_rtsp_message_init_data (message, builder->buffer[1]);
1853 builder->body_len = (builder->buffer[2] << 8) | builder->buffer[3];
1854 builder->body_data = g_malloc (builder->body_len + 1);
1855 builder->body_data[builder->body_len] = '\0';
1856 builder->offset = 0;
1857 builder->state = STATE_DATA_BODY;
1860 case STATE_DATA_BODY:
1863 read_bytes (conn, builder->body_data, &builder->offset,
1865 if (res != GST_RTSP_OK)
1868 /* we have the complete body now, store in the message adjusting the
1869 * length to include the traling '\0' */
1870 gst_rtsp_message_take_body (message,
1871 (guint8 *) builder->body_data, builder->body_len + 1);
1872 builder->body_data = NULL;
1873 builder->body_len = 0;
1875 builder->state = STATE_END;
1878 case STATE_READ_LINES:
1880 res = read_line (conn, builder->buffer, &builder->offset,
1881 sizeof (builder->buffer));
1882 if (res != GST_RTSP_OK)
1885 /* we have a regular response */
1886 if (builder->buffer[0] == '\0') {
1889 /* empty line, end of message header */
1890 /* see if there is a Content-Length header, but ignore it if this
1891 * is a POST request with an x-sessioncookie header */
1892 if (gst_rtsp_message_get_header (message,
1893 GST_RTSP_HDR_CONTENT_LENGTH, &hdrval, 0) == GST_RTSP_OK &&
1894 (message->type != GST_RTSP_MESSAGE_HTTP_REQUEST ||
1895 message->type_data.request.method != GST_RTSP_POST ||
1896 gst_rtsp_message_get_header (message,
1897 GST_RTSP_HDR_X_SESSIONCOOKIE, NULL, 0) != GST_RTSP_OK)) {
1898 /* there is, prepare to read the body */
1899 builder->body_len = atol (hdrval);
1900 builder->body_data = g_malloc (builder->body_len + 1);
1901 builder->body_data[builder->body_len] = '\0';
1902 builder->offset = 0;
1903 builder->state = STATE_DATA_BODY;
1905 builder->state = STATE_END;
1910 /* we have a line */
1911 normalize_line (builder->buffer);
1912 if (builder->line == 0) {
1913 /* first line, check for response status */
1914 if (memcmp (builder->buffer, "RTSP", 4) == 0 ||
1915 memcmp (builder->buffer, "HTTP", 4) == 0) {
1916 builder->status = parse_response_status (builder->buffer, message);
1918 builder->status = parse_request_line (builder->buffer, message);
1921 /* else just parse the line */
1922 res = parse_line (builder->buffer, message);
1923 if (res != GST_RTSP_OK)
1924 builder->status = res;
1927 builder->offset = 0;
1932 gchar *session_cookie;
1935 if (message->type == GST_RTSP_MESSAGE_DATA) {
1936 /* data messages don't have headers */
1941 /* save the tunnel session in the connection */
1942 if (message->type == GST_RTSP_MESSAGE_HTTP_REQUEST &&
1943 !conn->manual_http &&
1944 conn->tstate == TUNNEL_STATE_NONE &&
1945 gst_rtsp_message_get_header (message, GST_RTSP_HDR_X_SESSIONCOOKIE,
1946 &session_cookie, 0) == GST_RTSP_OK) {
1947 strncpy (conn->tunnelid, session_cookie, TUNNELID_LEN);
1948 conn->tunnelid[TUNNELID_LEN - 1] = '\0';
1949 conn->tunneled = TRUE;
1952 /* save session id in the connection for further use */
1953 if (message->type == GST_RTSP_MESSAGE_RESPONSE &&
1954 gst_rtsp_message_get_header (message, GST_RTSP_HDR_SESSION,
1955 &session_id, 0) == GST_RTSP_OK) {
1958 maxlen = sizeof (conn->session_id) - 1;
1959 /* the sessionid can have attributes marked with ;
1960 * Make sure we strip them */
1961 for (i = 0; session_id[i] != '\0'; i++) {
1962 if (session_id[i] == ';') {
1967 } while (g_ascii_isspace (session_id[i]));
1968 if (g_str_has_prefix (&session_id[i], "timeout=")) {
1971 /* if we parsed something valid, configure */
1972 if ((to = atoi (&session_id[i + 8])) > 0)
1979 /* make sure to not overflow */
1980 strncpy (conn->session_id, session_id, maxlen);
1981 conn->session_id[maxlen] = '\0';
1983 res = builder->status;
1987 res = GST_RTSP_ERROR;
1996 * gst_rtsp_connection_read:
1997 * @conn: a #GstRTSPConnection
1998 * @data: the data to read
1999 * @size: the size of @data
2000 * @timeout: a timeout value or #NULL
2002 * Attempt to read @size bytes into @data from the connected @conn, blocking up to
2003 * the specified @timeout. @timeout can be #NULL, in which case this function
2004 * might block forever.
2006 * This function can be cancelled with gst_rtsp_connection_flush().
2008 * Returns: #GST_RTSP_OK on success.
2011 gst_rtsp_connection_read (GstRTSPConnection * conn, guint8 * data, guint size,
2019 g_return_val_if_fail (conn != NULL, GST_RTSP_EINVAL);
2020 g_return_val_if_fail (data != NULL, GST_RTSP_EINVAL);
2021 g_return_val_if_fail (conn->readfd != NULL, GST_RTSP_EINVAL);
2023 if (G_UNLIKELY (size == 0))
2028 /* configure timeout if any */
2029 to = timeout ? GST_TIMEVAL_TO_TIME (*timeout) : GST_CLOCK_TIME_NONE;
2031 gst_poll_set_controllable (conn->fdset, TRUE);
2032 gst_poll_fd_ctl_write (conn->fdset, conn->writefd, FALSE);
2033 gst_poll_fd_ctl_read (conn->fdset, conn->readfd, TRUE);
2036 res = read_bytes (conn, data, &offset, size);
2037 if (G_UNLIKELY (res == GST_RTSP_EEOF))
2039 if (G_LIKELY (res == GST_RTSP_OK))
2041 if (G_UNLIKELY (res != GST_RTSP_EINTR))
2045 retval = gst_poll_wait (conn->fdset, to);
2046 } while (retval == -1 && (errno == EINTR || errno == EAGAIN));
2048 /* check for timeout */
2049 if (G_UNLIKELY (retval == 0))
2050 goto select_timeout;
2052 if (G_UNLIKELY (retval == -1)) {
2058 gst_poll_set_controllable (conn->fdset, FALSE);
2065 return GST_RTSP_ESYS;
2069 return GST_RTSP_ETIMEOUT;
2073 return GST_RTSP_EINTR;
2077 return GST_RTSP_EEOF;
2085 static GstRTSPMessage *
2086 gen_tunnel_reply (GstRTSPConnection * conn, GstRTSPStatusCode code,
2087 const GstRTSPMessage * request)
2089 GstRTSPMessage *msg;
2092 if (gst_rtsp_status_as_text (code) == NULL)
2093 code = GST_RTSP_STS_INTERNAL_SERVER_ERROR;
2095 GST_RTSP_CHECK (gst_rtsp_message_new_response (&msg, code, NULL, request),
2098 gst_rtsp_message_add_header (msg, GST_RTSP_HDR_SERVER,
2099 "GStreamer RTSP Server");
2100 gst_rtsp_message_add_header (msg, GST_RTSP_HDR_CONNECTION, "close");
2101 gst_rtsp_message_add_header (msg, GST_RTSP_HDR_CACHE_CONTROL, "no-store");
2102 gst_rtsp_message_add_header (msg, GST_RTSP_HDR_PRAGMA, "no-cache");
2104 if (code == GST_RTSP_STS_OK) {
2106 gst_rtsp_message_add_header (msg, GST_RTSP_HDR_X_SERVER_IP_ADDRESS,
2108 gst_rtsp_message_add_header (msg, GST_RTSP_HDR_CONTENT_TYPE,
2109 "application/x-rtsp-tunnelled");
2122 * gst_rtsp_connection_receive:
2123 * @conn: a #GstRTSPConnection
2124 * @message: the message to read
2125 * @timeout: a timeout value or #NULL
2127 * Attempt to read into @message from the connected @conn, blocking up to
2128 * the specified @timeout. @timeout can be #NULL, in which case this function
2129 * might block forever.
2131 * This function can be cancelled with gst_rtsp_connection_flush().
2133 * Returns: #GST_RTSP_OK on success.
2136 gst_rtsp_connection_receive (GstRTSPConnection * conn, GstRTSPMessage * message,
2140 GstRTSPBuilder builder;
2144 g_return_val_if_fail (conn != NULL, GST_RTSP_EINVAL);
2145 g_return_val_if_fail (message != NULL, GST_RTSP_EINVAL);
2146 g_return_val_if_fail (conn->readfd != NULL, GST_RTSP_EINVAL);
2148 /* configure timeout if any */
2149 to = timeout ? GST_TIMEVAL_TO_TIME (*timeout) : GST_CLOCK_TIME_NONE;
2151 gst_poll_set_controllable (conn->fdset, TRUE);
2152 gst_poll_fd_ctl_write (conn->fdset, conn->writefd, FALSE);
2153 gst_poll_fd_ctl_read (conn->fdset, conn->readfd, TRUE);
2155 memset (&builder, 0, sizeof (GstRTSPBuilder));
2157 res = build_next (&builder, message, conn);
2158 if (G_UNLIKELY (res == GST_RTSP_EEOF))
2160 else if (G_LIKELY (res == GST_RTSP_OK)) {
2161 if (!conn->manual_http) {
2162 if (message->type == GST_RTSP_MESSAGE_HTTP_REQUEST) {
2163 if (conn->tstate == TUNNEL_STATE_NONE &&
2164 message->type_data.request.method == GST_RTSP_GET) {
2165 GstRTSPMessage *response;
2167 conn->tstate = TUNNEL_STATE_GET;
2169 /* tunnel GET request, we can reply now */
2170 response = gen_tunnel_reply (conn, GST_RTSP_STS_OK, message);
2171 res = gst_rtsp_connection_send (conn, response, timeout);
2172 gst_rtsp_message_free (response);
2173 if (res == GST_RTSP_OK)
2174 res = GST_RTSP_ETGET;
2176 } else if (conn->tstate == TUNNEL_STATE_NONE &&
2177 message->type_data.request.method == GST_RTSP_POST) {
2178 conn->tstate = TUNNEL_STATE_POST;
2180 /* tunnel POST request, the caller now has to link the two
2182 res = GST_RTSP_ETPOST;
2185 res = GST_RTSP_EPARSE;
2188 } else if (message->type == GST_RTSP_MESSAGE_HTTP_RESPONSE) {
2189 res = GST_RTSP_EPARSE;
2195 } else if (G_UNLIKELY (res != GST_RTSP_EINTR))
2199 retval = gst_poll_wait (conn->fdset, to);
2200 } while (retval == -1 && (errno == EINTR || errno == EAGAIN));
2202 /* check for timeout */
2203 if (G_UNLIKELY (retval == 0))
2204 goto select_timeout;
2206 if (G_UNLIKELY (retval == -1)) {
2212 gst_poll_set_controllable (conn->fdset, FALSE);
2215 /* we have a message here */
2216 build_reset (&builder);
2223 res = GST_RTSP_ESYS;
2228 res = GST_RTSP_ETIMEOUT;
2233 res = GST_RTSP_EINTR;
2238 res = GST_RTSP_EEOF;
2244 build_reset (&builder);
2245 gst_rtsp_message_unset (message);
2251 * gst_rtsp_connection_close:
2252 * @conn: a #GstRTSPConnection
2254 * Close the connected @conn. After this call, the connection is in the same
2255 * state as when it was first created.
2257 * Returns: #GST_RTSP_OK on success.
2260 gst_rtsp_connection_close (GstRTSPConnection * conn)
2262 g_return_val_if_fail (conn != NULL, GST_RTSP_EINVAL);
2267 conn->read_ahead = 0;
2269 g_free (conn->initial_buffer);
2270 conn->initial_buffer = NULL;
2271 conn->initial_buffer_offset = 0;
2273 REMOVE_POLLFD (conn->fdset, &conn->fd0);
2274 REMOVE_POLLFD (conn->fdset, &conn->fd1);
2275 conn->writefd = NULL;
2276 conn->readfd = NULL;
2277 conn->tunneled = FALSE;
2278 conn->tstate = TUNNEL_STATE_NONE;
2280 g_free (conn->username);
2281 conn->username = NULL;
2282 g_free (conn->passwd);
2283 conn->passwd = NULL;
2284 gst_rtsp_connection_clear_auth_params (conn);
2287 conn->session_id[0] = '\0';
2293 * gst_rtsp_connection_free:
2294 * @conn: a #GstRTSPConnection
2296 * Close and free @conn.
2298 * Returns: #GST_RTSP_OK on success.
2301 gst_rtsp_connection_free (GstRTSPConnection * conn)
2305 g_return_val_if_fail (conn != NULL, GST_RTSP_EINVAL);
2307 res = gst_rtsp_connection_close (conn);
2308 gst_poll_free (conn->fdset);
2309 g_timer_destroy (conn->timer);
2310 gst_rtsp_url_free (conn->url);
2311 g_free (conn->proxy_host);
2321 * gst_rtsp_connection_poll:
2322 * @conn: a #GstRTSPConnection
2323 * @events: a bitmask of #GstRTSPEvent flags to check
2324 * @revents: location for result flags
2325 * @timeout: a timeout
2327 * Wait up to the specified @timeout for the connection to become available for
2328 * at least one of the operations specified in @events. When the function returns
2329 * with #GST_RTSP_OK, @revents will contain a bitmask of available operations on
2332 * @timeout can be #NULL, in which case this function might block forever.
2334 * This function can be cancelled with gst_rtsp_connection_flush().
2336 * Returns: #GST_RTSP_OK on success.
2341 gst_rtsp_connection_poll (GstRTSPConnection * conn, GstRTSPEvent events,
2342 GstRTSPEvent * revents, GTimeVal * timeout)
2347 g_return_val_if_fail (conn != NULL, GST_RTSP_EINVAL);
2348 g_return_val_if_fail (events != 0, GST_RTSP_EINVAL);
2349 g_return_val_if_fail (revents != NULL, GST_RTSP_EINVAL);
2350 g_return_val_if_fail (conn->readfd != NULL, GST_RTSP_EINVAL);
2351 g_return_val_if_fail (conn->writefd != NULL, GST_RTSP_EINVAL);
2353 gst_poll_set_controllable (conn->fdset, TRUE);
2355 /* add fd to writer set when asked to */
2356 gst_poll_fd_ctl_write (conn->fdset, conn->writefd,
2357 events & GST_RTSP_EV_WRITE);
2359 /* add fd to reader set when asked to */
2360 gst_poll_fd_ctl_read (conn->fdset, conn->readfd, events & GST_RTSP_EV_READ);
2362 /* configure timeout if any */
2363 to = timeout ? GST_TIMEVAL_TO_TIME (*timeout) : GST_CLOCK_TIME_NONE;
2366 retval = gst_poll_wait (conn->fdset, to);
2367 } while (retval == -1 && (errno == EINTR || errno == EAGAIN));
2369 if (G_UNLIKELY (retval == 0))
2370 goto select_timeout;
2372 if (G_UNLIKELY (retval == -1)) {
2380 if (events & GST_RTSP_EV_READ) {
2381 if (gst_poll_fd_can_read (conn->fdset, conn->readfd))
2382 *revents |= GST_RTSP_EV_READ;
2384 if (events & GST_RTSP_EV_WRITE) {
2385 if (gst_poll_fd_can_write (conn->fdset, conn->writefd))
2386 *revents |= GST_RTSP_EV_WRITE;
2393 return GST_RTSP_ETIMEOUT;
2397 return GST_RTSP_ESYS;
2401 return GST_RTSP_EINTR;
2406 * gst_rtsp_connection_next_timeout:
2407 * @conn: a #GstRTSPConnection
2408 * @timeout: a timeout
2410 * Calculate the next timeout for @conn, storing the result in @timeout.
2412 * Returns: #GST_RTSP_OK.
2415 gst_rtsp_connection_next_timeout (GstRTSPConnection * conn, GTimeVal * timeout)
2421 g_return_val_if_fail (conn != NULL, GST_RTSP_EINVAL);
2422 g_return_val_if_fail (timeout != NULL, GST_RTSP_EINVAL);
2424 elapsed = g_timer_elapsed (conn->timer, &usec);
2425 if (elapsed >= conn->timeout) {
2429 sec = conn->timeout - elapsed;
2432 timeout->tv_sec = sec;
2433 timeout->tv_usec = usec;
2439 * gst_rtsp_connection_reset_timeout:
2440 * @conn: a #GstRTSPConnection
2442 * Reset the timeout of @conn.
2444 * Returns: #GST_RTSP_OK.
2447 gst_rtsp_connection_reset_timeout (GstRTSPConnection * conn)
2449 g_return_val_if_fail (conn != NULL, GST_RTSP_EINVAL);
2451 g_timer_start (conn->timer);
2457 * gst_rtsp_connection_flush:
2458 * @conn: a #GstRTSPConnection
2459 * @flush: start or stop the flush
2461 * Start or stop the flushing action on @conn. When flushing, all current
2462 * and future actions on @conn will return #GST_RTSP_EINTR until the connection
2463 * is set to non-flushing mode again.
2465 * Returns: #GST_RTSP_OK.
2468 gst_rtsp_connection_flush (GstRTSPConnection * conn, gboolean flush)
2470 g_return_val_if_fail (conn != NULL, GST_RTSP_EINVAL);
2472 gst_poll_set_flushing (conn->fdset, flush);
2478 * gst_rtsp_connection_set_proxy:
2479 * @conn: a #GstRTSPConnection
2480 * @host: the proxy host
2481 * @port: the proxy port
2483 * Set the proxy host and port.
2485 * Returns: #GST_RTSP_OK.
2490 gst_rtsp_connection_set_proxy (GstRTSPConnection * conn,
2491 const gchar * host, guint port)
2493 g_return_val_if_fail (conn != NULL, GST_RTSP_EINVAL);
2495 g_free (conn->proxy_host);
2496 conn->proxy_host = g_strdup (host);
2497 conn->proxy_port = port;
2503 * gst_rtsp_connection_set_auth:
2504 * @conn: a #GstRTSPConnection
2505 * @method: authentication method
2507 * @pass: the password
2509 * Configure @conn for authentication mode @method with @user and @pass as the
2510 * user and password respectively.
2512 * Returns: #GST_RTSP_OK.
2515 gst_rtsp_connection_set_auth (GstRTSPConnection * conn,
2516 GstRTSPAuthMethod method, const gchar * user, const gchar * pass)
2518 g_return_val_if_fail (conn != NULL, GST_RTSP_EINVAL);
2520 if (method == GST_RTSP_AUTH_DIGEST && ((user == NULL || pass == NULL)
2521 || g_strrstr (user, ":") != NULL))
2522 return GST_RTSP_EINVAL;
2524 /* Make sure the username and passwd are being set for authentication */
2525 if (method == GST_RTSP_AUTH_NONE && (user == NULL || pass == NULL))
2526 return GST_RTSP_EINVAL;
2528 /* ":" chars are not allowed in usernames for basic auth */
2529 if (method == GST_RTSP_AUTH_BASIC && g_strrstr (user, ":") != NULL)
2530 return GST_RTSP_EINVAL;
2532 g_free (conn->username);
2533 g_free (conn->passwd);
2535 conn->auth_method = method;
2536 conn->username = g_strdup (user);
2537 conn->passwd = g_strdup (pass);
2544 * @key: ASCII string to hash
2546 * Hashes @key in a case-insensitive manner.
2548 * Returns: the hash code.
2551 str_case_hash (gconstpointer key)
2553 const char *p = key;
2554 guint h = g_ascii_toupper (*p);
2557 for (p += 1; *p != '\0'; p++)
2558 h = (h << 5) - h + g_ascii_toupper (*p);
2565 * @v1: an ASCII string
2566 * @v2: another ASCII string
2568 * Compares @v1 and @v2 in a case-insensitive manner
2570 * Returns: %TRUE if they are equal (modulo case)
2573 str_case_equal (gconstpointer v1, gconstpointer v2)
2575 const char *string1 = v1;
2576 const char *string2 = v2;
2578 return g_ascii_strcasecmp (string1, string2) == 0;
2582 * gst_rtsp_connection_set_auth_param:
2583 * @conn: a #GstRTSPConnection
2584 * @param: authentication directive
2587 * Setup @conn with authentication directives. This is not necesary for
2588 * methods #GST_RTSP_AUTH_NONE and #GST_RTSP_AUTH_BASIC. For
2589 * #GST_RTSP_AUTH_DIGEST, directives should be taken from the digest challenge
2590 * in the WWW-Authenticate response header and can include realm, domain,
2591 * nonce, opaque, stale, algorithm, qop as per RFC2617.
2596 gst_rtsp_connection_set_auth_param (GstRTSPConnection * conn,
2597 const gchar * param, const gchar * value)
2599 g_return_if_fail (conn != NULL);
2600 g_return_if_fail (param != NULL);
2602 if (conn->auth_params == NULL) {
2604 g_hash_table_new_full (str_case_hash, str_case_equal, g_free, g_free);
2606 g_hash_table_insert (conn->auth_params, g_strdup (param), g_strdup (value));
2610 * gst_rtsp_connection_clear_auth_params:
2611 * @conn: a #GstRTSPConnection
2613 * Clear the list of authentication directives stored in @conn.
2618 gst_rtsp_connection_clear_auth_params (GstRTSPConnection * conn)
2620 g_return_if_fail (conn != NULL);
2622 if (conn->auth_params != NULL) {
2623 g_hash_table_destroy (conn->auth_params);
2624 conn->auth_params = NULL;
2628 static GstRTSPResult
2629 set_qos_dscp (gint fd, guint qos_dscp)
2631 union gst_sockaddr sa;
2632 socklen_t slen = sizeof (sa);
2639 if (getsockname (fd, &sa.sa, &slen) < 0)
2640 goto no_getsockname;
2642 af = sa.sa.sa_family;
2644 /* if this is an IPv4-mapped address then do IPv4 QoS */
2645 if (af == AF_INET6) {
2646 if (IN6_IS_ADDR_V4MAPPED (&sa.sa_in6.sin6_addr))
2650 /* extract and shift 6 bits of the DSCP */
2651 tos = (qos_dscp & 0x3f) << 2;
2655 if (SETSOCKOPT (fd, IPPROTO_IP, IP_TOS, &tos, sizeof (tos)) < 0)
2660 if (SETSOCKOPT (fd, IPPROTO_IPV6, IPV6_TCLASS, &tos, sizeof (tos)) < 0)
2674 return GST_RTSP_ESYS;
2679 return GST_RTSP_ERROR;
2684 * gst_rtsp_connection_set_qos_dscp:
2685 * @conn: a #GstRTSPConnection
2686 * @qos_dscp: DSCP value
2688 * Configure @conn to use the specified DSCP value.
2690 * Returns: #GST_RTSP_OK on success.
2695 gst_rtsp_connection_set_qos_dscp (GstRTSPConnection * conn, guint qos_dscp)
2699 g_return_val_if_fail (conn != NULL, GST_RTSP_EINVAL);
2700 g_return_val_if_fail (conn->readfd != NULL, GST_RTSP_EINVAL);
2701 g_return_val_if_fail (conn->writefd != NULL, GST_RTSP_EINVAL);
2703 res = set_qos_dscp (conn->fd0.fd, qos_dscp);
2704 if (res == GST_RTSP_OK)
2705 res = set_qos_dscp (conn->fd1.fd, qos_dscp);
2712 * gst_rtsp_connection_get_url:
2713 * @conn: a #GstRTSPConnection
2715 * Retrieve the URL of the other end of @conn.
2717 * Returns: The URL. This value remains valid until the
2718 * connection is freed.
2723 gst_rtsp_connection_get_url (const GstRTSPConnection * conn)
2725 g_return_val_if_fail (conn != NULL, NULL);
2731 * gst_rtsp_connection_get_ip:
2732 * @conn: a #GstRTSPConnection
2734 * Retrieve the IP address of the other end of @conn.
2736 * Returns: The IP address as a string. this value remains valid until the
2737 * connection is closed.
2742 gst_rtsp_connection_get_ip (const GstRTSPConnection * conn)
2744 g_return_val_if_fail (conn != NULL, NULL);
2750 * gst_rtsp_connection_set_ip:
2751 * @conn: a #GstRTSPConnection
2752 * @ip: an ip address
2754 * Set the IP address of the server.
2759 gst_rtsp_connection_set_ip (GstRTSPConnection * conn, const gchar * ip)
2761 g_return_if_fail (conn != NULL);
2764 conn->ip = g_strdup (ip);
2768 * gst_rtsp_connection_get_readfd:
2769 * @conn: a #GstRTSPConnection
2771 * Get the file descriptor for reading.
2773 * Returns: the file descriptor used for reading or -1 on error. The file
2774 * descriptor remains valid until the connection is closed.
2779 gst_rtsp_connection_get_readfd (const GstRTSPConnection * conn)
2781 g_return_val_if_fail (conn != NULL, -1);
2782 g_return_val_if_fail (conn->readfd != NULL, -1);
2784 return conn->readfd->fd;
2788 * gst_rtsp_connection_get_writefd:
2789 * @conn: a #GstRTSPConnection
2791 * Get the file descriptor for writing.
2793 * Returns: the file descriptor used for writing or -1 on error. The file
2794 * descriptor remains valid until the connection is closed.
2799 gst_rtsp_connection_get_writefd (const GstRTSPConnection * conn)
2801 g_return_val_if_fail (conn != NULL, -1);
2802 g_return_val_if_fail (conn->writefd != NULL, -1);
2804 return conn->writefd->fd;
2808 * gst_rtsp_connection_set_http_mode:
2809 * @conn: a #GstRTSPConnection
2810 * @enable: %TRUE to enable manual HTTP mode
2812 * By setting the HTTP mode to %TRUE the message parsing will support HTTP
2813 * messages in addition to the RTSP messages. It will also disable the
2814 * automatic handling of setting up an HTTP tunnel.
2819 gst_rtsp_connection_set_http_mode (GstRTSPConnection * conn, gboolean enable)
2821 g_return_if_fail (conn != NULL);
2823 conn->manual_http = enable;
2827 * gst_rtsp_connection_set_tunneled:
2828 * @conn: a #GstRTSPConnection
2829 * @tunneled: the new state
2831 * Set the HTTP tunneling state of the connection. This must be configured before
2832 * the @conn is connected.
2837 gst_rtsp_connection_set_tunneled (GstRTSPConnection * conn, gboolean tunneled)
2839 g_return_if_fail (conn != NULL);
2840 g_return_if_fail (conn->readfd == NULL);
2841 g_return_if_fail (conn->writefd == NULL);
2843 conn->tunneled = tunneled;
2847 * gst_rtsp_connection_is_tunneled:
2848 * @conn: a #GstRTSPConnection
2850 * Get the tunneling state of the connection.
2852 * Returns: if @conn is using HTTP tunneling.
2857 gst_rtsp_connection_is_tunneled (const GstRTSPConnection * conn)
2859 g_return_val_if_fail (conn != NULL, FALSE);
2861 return conn->tunneled;
2865 * gst_rtsp_connection_get_tunnelid:
2866 * @conn: a #GstRTSPConnection
2868 * Get the tunnel session id the connection.
2870 * Returns: returns a non-empty string if @conn is being tunneled over HTTP.
2875 gst_rtsp_connection_get_tunnelid (const GstRTSPConnection * conn)
2877 g_return_val_if_fail (conn != NULL, NULL);
2879 if (!conn->tunneled)
2882 return conn->tunnelid;
2886 * gst_rtsp_connection_do_tunnel:
2887 * @conn: a #GstRTSPConnection
2888 * @conn2: a #GstRTSPConnection or %NULL
2890 * If @conn received the first tunnel connection and @conn2 received
2891 * the second tunnel connection, link the two connections together so that
2892 * @conn manages the tunneled connection.
2894 * After this call, @conn2 cannot be used anymore and must be freed with
2895 * gst_rtsp_connection_free().
2897 * If @conn2 is %NULL then only the base64 decoding context will be setup for
2900 * Returns: return GST_RTSP_OK on success.
2905 gst_rtsp_connection_do_tunnel (GstRTSPConnection * conn,
2906 GstRTSPConnection * conn2)
2908 g_return_val_if_fail (conn != NULL, GST_RTSP_EINVAL);
2910 if (conn2 != NULL) {
2911 g_return_val_if_fail (conn->tstate == TUNNEL_STATE_GET, GST_RTSP_EINVAL);
2912 g_return_val_if_fail (conn2->tstate == TUNNEL_STATE_POST, GST_RTSP_EINVAL);
2913 g_return_val_if_fail (!memcmp (conn2->tunnelid, conn->tunnelid,
2914 TUNNELID_LEN), GST_RTSP_EINVAL);
2916 /* both connections have fd0 as the read/write socket. start by taking the
2917 * socket from conn2 and set it as the socket in conn */
2918 conn->fd1 = conn2->fd0;
2920 /* clean up some of the state of conn2 */
2921 gst_poll_remove_fd (conn2->fdset, &conn2->fd0);
2923 conn2->readfd = conn2->writefd = NULL;
2925 /* We make fd0 the write socket and fd1 the read socket. */
2926 conn->writefd = &conn->fd0;
2927 conn->readfd = &conn->fd1;
2929 conn->tstate = TUNNEL_STATE_COMPLETE;
2932 /* we need base64 decoding for the readfd */
2933 conn->ctx.state = 0;
2936 conn->ctx.coutl = 0;
2937 conn->ctxp = &conn->ctx;
2942 #define READ_COND (G_IO_IN | G_IO_HUP | G_IO_ERR)
2943 #define WRITE_COND (G_IO_OUT | G_IO_ERR)
2952 /* async functions */
2953 struct _GstRTSPWatch
2957 GstRTSPConnection *conn;
2959 GstRTSPBuilder builder;
2960 GstRTSPMessage message;
2964 gboolean write_added;
2966 /* queued message for transmission */
2975 GstRTSPWatchFuncs funcs;
2978 GDestroyNotify notify;
2982 gst_rtsp_source_prepare (GSource * source, gint * timeout)
2984 GstRTSPWatch *watch = (GstRTSPWatch *) source;
2986 if (watch->conn->initial_buffer != NULL)
2989 *timeout = (watch->conn->timeout * 1000);
2995 gst_rtsp_source_check (GSource * source)
2997 GstRTSPWatch *watch = (GstRTSPWatch *) source;
2999 if (watch->readfd.revents & READ_COND)
3002 if (watch->writefd.revents & WRITE_COND)
3009 gst_rtsp_source_dispatch (GSource * source, GSourceFunc callback G_GNUC_UNUSED,
3010 gpointer user_data G_GNUC_UNUSED)
3012 GstRTSPWatch *watch = (GstRTSPWatch *) source;
3015 /* first read as much as we can */
3016 if (watch->readfd.revents & READ_COND || watch->conn->initial_buffer != NULL) {
3018 res = build_next (&watch->builder, &watch->message, watch->conn);
3019 if (res == GST_RTSP_EINTR)
3021 else if (G_UNLIKELY (res == GST_RTSP_EEOF))
3023 else if (G_LIKELY (res == GST_RTSP_OK)) {
3024 if (!watch->conn->manual_http &&
3025 watch->message.type == GST_RTSP_MESSAGE_HTTP_REQUEST) {
3026 if (watch->conn->tstate == TUNNEL_STATE_NONE &&
3027 watch->message.type_data.request.method == GST_RTSP_GET) {
3028 GstRTSPMessage *response;
3029 GstRTSPStatusCode code;
3031 watch->conn->tstate = TUNNEL_STATE_GET;
3033 if (watch->funcs.tunnel_start)
3034 code = watch->funcs.tunnel_start (watch, watch->user_data);
3036 code = GST_RTSP_STS_OK;
3038 /* queue the response */
3039 response = gen_tunnel_reply (watch->conn, code, &watch->message);
3040 gst_rtsp_watch_send_message (watch, response, NULL);
3041 gst_rtsp_message_free (response);
3043 } else if (watch->conn->tstate == TUNNEL_STATE_NONE &&
3044 watch->message.type_data.request.method == GST_RTSP_POST) {
3045 watch->conn->tstate = TUNNEL_STATE_POST;
3047 /* in the callback the connection should be tunneled with the
3049 if (watch->funcs.tunnel_complete)
3050 watch->funcs.tunnel_complete (watch, watch->user_data);
3056 if (!watch->conn->manual_http) {
3057 /* if manual HTTP support is not enabled, then restore the message to
3058 * what it would have looked like without the support for parsing HTTP
3059 * messages being present */
3060 if (watch->message.type == GST_RTSP_MESSAGE_HTTP_REQUEST) {
3061 watch->message.type = GST_RTSP_MESSAGE_REQUEST;
3062 watch->message.type_data.request.method = GST_RTSP_INVALID;
3063 if (watch->message.type_data.request.version != GST_RTSP_VERSION_1_0)
3064 watch->message.type_data.request.version = GST_RTSP_VERSION_INVALID;
3065 res = GST_RTSP_EPARSE;
3066 } else if (watch->message.type == GST_RTSP_MESSAGE_HTTP_RESPONSE) {
3067 watch->message.type = GST_RTSP_MESSAGE_RESPONSE;
3068 if (watch->message.type_data.response.version != GST_RTSP_VERSION_1_0)
3069 watch->message.type_data.response.version =
3070 GST_RTSP_VERSION_INVALID;
3071 res = GST_RTSP_EPARSE;
3075 if (G_LIKELY (res == GST_RTSP_OK)) {
3076 if (watch->funcs.message_received)
3077 watch->funcs.message_received (watch, &watch->message,
3080 if (watch->funcs.error_full)
3081 GST_RTSP_CHECK (watch->funcs.error_full (watch, res, &watch->message,
3082 0, watch->user_data), error);
3088 gst_rtsp_message_unset (&watch->message);
3089 build_reset (&watch->builder);
3093 if (watch->writefd.revents & WRITE_COND) {
3094 g_mutex_lock (watch->mutex);
3096 if (watch->write_data == NULL) {
3099 /* get a new message from the queue */
3100 rec = g_queue_pop_tail (watch->messages);
3104 watch->write_off = 0;
3105 watch->write_data = rec->data;
3106 watch->write_size = rec->size;
3107 watch->write_id = rec->id;
3109 g_slice_free (GstRTSPRec, rec);
3112 res = write_bytes (watch->writefd.fd, watch->write_data,
3113 &watch->write_off, watch->write_size);
3114 g_mutex_unlock (watch->mutex);
3115 if (res == GST_RTSP_EINTR)
3117 else if (G_LIKELY (res == GST_RTSP_OK)) {
3118 if (watch->funcs.message_sent)
3119 watch->funcs.message_sent (watch, watch->write_id, watch->user_data);
3121 if (watch->funcs.error_full)
3122 GST_RTSP_CHECK (watch->funcs.error_full (watch, res, NULL,
3123 watch->write_id, watch->user_data), error);
3127 g_mutex_lock (watch->mutex);
3129 g_free (watch->write_data);
3130 watch->write_data = NULL;
3134 if (watch->write_added) {
3135 g_source_remove_poll ((GSource *) watch, &watch->writefd);
3136 watch->write_added = FALSE;
3137 watch->writefd.revents = 0;
3140 g_mutex_unlock (watch->mutex);
3149 if (watch->funcs.closed)
3150 watch->funcs.closed (watch, watch->user_data);
3155 if (watch->funcs.error)
3156 watch->funcs.error (watch, res, watch->user_data);
3162 gst_rtsp_rec_free (gpointer data)
3164 GstRTSPRec *rec = data;
3167 g_slice_free (GstRTSPRec, rec);
3171 gst_rtsp_source_finalize (GSource * source)
3173 GstRTSPWatch *watch = (GstRTSPWatch *) source;
3175 build_reset (&watch->builder);
3176 gst_rtsp_message_unset (&watch->message);
3178 g_queue_foreach (watch->messages, (GFunc) gst_rtsp_rec_free, NULL);
3179 g_queue_free (watch->messages);
3180 watch->messages = NULL;
3182 g_mutex_free (watch->mutex);
3184 g_free (watch->write_data);
3187 watch->notify (watch->user_data);
3190 static GSourceFuncs gst_rtsp_source_funcs = {
3191 gst_rtsp_source_prepare,
3192 gst_rtsp_source_check,
3193 gst_rtsp_source_dispatch,
3194 gst_rtsp_source_finalize,
3200 * gst_rtsp_watch_new:
3201 * @conn: a #GstRTSPConnection
3202 * @funcs: watch functions
3203 * @user_data: user data to pass to @funcs
3204 * @notify: notify when @user_data is not referenced anymore
3206 * Create a watch object for @conn. The functions provided in @funcs will be
3207 * called with @user_data when activity happened on the watch.
3209 * The new watch is usually created so that it can be attached to a
3210 * maincontext with gst_rtsp_watch_attach().
3212 * @conn must exist for the entire lifetime of the watch.
3214 * Returns: a #GstRTSPWatch that can be used for asynchronous RTSP
3215 * communication. Free with gst_rtsp_watch_unref () after usage.
3220 gst_rtsp_watch_new (GstRTSPConnection * conn,
3221 GstRTSPWatchFuncs * funcs, gpointer user_data, GDestroyNotify notify)
3223 GstRTSPWatch *result;
3225 g_return_val_if_fail (conn != NULL, NULL);
3226 g_return_val_if_fail (funcs != NULL, NULL);
3227 g_return_val_if_fail (conn->readfd != NULL, NULL);
3228 g_return_val_if_fail (conn->writefd != NULL, NULL);
3230 result = (GstRTSPWatch *) g_source_new (&gst_rtsp_source_funcs,
3231 sizeof (GstRTSPWatch));
3233 result->conn = conn;
3234 result->builder.state = STATE_START;
3236 result->mutex = g_mutex_new ();
3237 result->messages = g_queue_new ();
3239 result->readfd.fd = -1;
3240 result->writefd.fd = -1;
3242 gst_rtsp_watch_reset (result);
3244 result->funcs = *funcs;
3245 result->user_data = user_data;
3246 result->notify = notify;
3248 /* only add the read fd, the write fd is only added when we have data
3250 g_source_add_poll ((GSource *) result, &result->readfd);
3256 * gst_rtsp_watch_reset:
3257 * @watch: a #GstRTSPWatch
3259 * Reset @watch, this is usually called after gst_rtsp_connection_do_tunnel()
3260 * when the file descriptors of the connection might have changed.
3265 gst_rtsp_watch_reset (GstRTSPWatch * watch)
3267 if (watch->readfd.fd != -1)
3268 g_source_remove_poll ((GSource *) watch, &watch->readfd);
3269 if (watch->writefd.fd != -1)
3270 g_source_remove_poll ((GSource *) watch, &watch->writefd);
3272 watch->readfd.fd = watch->conn->readfd->fd;
3273 watch->readfd.events = READ_COND;
3274 watch->readfd.revents = 0;
3276 watch->writefd.fd = watch->conn->writefd->fd;
3277 watch->writefd.events = WRITE_COND;
3278 watch->writefd.revents = 0;
3279 watch->write_added = FALSE;
3281 g_source_add_poll ((GSource *) watch, &watch->readfd);
3285 * gst_rtsp_watch_attach:
3286 * @watch: a #GstRTSPWatch
3287 * @context: a GMainContext (if NULL, the default context will be used)
3289 * Adds a #GstRTSPWatch to a context so that it will be executed within that context.
3291 * Returns: the ID (greater than 0) for the watch within the GMainContext.
3296 gst_rtsp_watch_attach (GstRTSPWatch * watch, GMainContext * context)
3298 g_return_val_if_fail (watch != NULL, 0);
3300 return g_source_attach ((GSource *) watch, context);
3304 * gst_rtsp_watch_unref:
3305 * @watch: a #GstRTSPWatch
3307 * Decreases the reference count of @watch by one. If the resulting reference
3308 * count is zero the watch and associated memory will be destroyed.
3313 gst_rtsp_watch_unref (GstRTSPWatch * watch)
3315 g_return_if_fail (watch != NULL);
3317 g_source_unref ((GSource *) watch);
3321 * gst_rtsp_watch_write_data:
3322 * @watch: a #GstRTSPWatch
3323 * @data: the data to queue
3324 * @size: the size of @data
3325 * @id: location for a message ID or %NULL
3327 * Write @data using the connection of the @watch. If it cannot be sent
3328 * immediately, it will be queued for transmission in @watch. The contents of
3329 * @message will then be serialized and transmitted when the connection of the
3330 * @watch becomes writable. In case the @message is queued, the ID returned in
3331 * @id will be non-zero and used as the ID argument in the message_sent
3334 * This function will take ownership of @data and g_free() it after use.
3336 * Returns: #GST_RTSP_OK on success.
3341 gst_rtsp_watch_write_data (GstRTSPWatch * watch, const guint8 * data,
3342 guint size, guint * id)
3348 g_return_val_if_fail (watch != NULL, GST_RTSP_EINVAL);
3349 g_return_val_if_fail (data != NULL, GST_RTSP_EINVAL);
3350 g_return_val_if_fail (size != 0, GST_RTSP_EINVAL);
3352 g_mutex_lock (watch->mutex);
3354 if (watch->messages->length == 0) {
3355 res = write_bytes (watch->writefd.fd, data, &off, size);
3356 if (res != GST_RTSP_EINTR) {
3359 g_free ((gpointer) data);
3364 /* make a record with the data and id */
3365 rec = g_slice_new (GstRTSPRec);
3367 rec->data = (guint8 *) data;
3370 rec->data = g_memdup (data + off, size - off);
3371 rec->size = size - off;
3372 g_free ((gpointer) data);
3376 /* make sure rec->id is never 0 */
3377 rec->id = ++watch->id;
3378 } while (G_UNLIKELY (rec->id == 0));
3380 /* add the record to a queue. FIXME we would like to have an upper limit here */
3381 g_queue_push_head (watch->messages, rec);
3383 /* make sure the main context will now also check for writability on the
3385 if (!watch->write_added) {
3386 g_source_add_poll ((GSource *) watch, &watch->writefd);
3387 watch->write_added = TRUE;
3395 g_mutex_unlock (watch->mutex);
3400 * gst_rtsp_watch_send_message:
3401 * @watch: a #GstRTSPWatch
3402 * @message: a #GstRTSPMessage
3403 * @id: location for a message ID or %NULL
3405 * Send a @message using the connection of the @watch. If it cannot be sent
3406 * immediately, it will be queued for transmission in @watch. The contents of
3407 * @message will then be serialized and transmitted when the connection of the
3408 * @watch becomes writable. In case the @message is queued, the ID returned in
3409 * @id will be non-zero and used as the ID argument in the message_sent
3412 * Returns: #GST_RTSP_OK on success.
3417 gst_rtsp_watch_send_message (GstRTSPWatch * watch, GstRTSPMessage * message,
3423 g_return_val_if_fail (watch != NULL, GST_RTSP_EINVAL);
3424 g_return_val_if_fail (message != NULL, GST_RTSP_EINVAL);
3426 /* make a record with the message as a string and id */
3427 str = message_to_string (watch->conn, message);
3429 return gst_rtsp_watch_write_data (watch,
3430 (guint8 *) g_string_free (str, FALSE), size, id);
3434 * gst_rtsp_watch_queue_data:
3435 * @watch: a #GstRTSPWatch
3436 * @data: the data to queue
3437 * @size: the size of @data
3439 * Queue @data for transmission in @watch. It will be transmitted when the
3440 * connection of the @watch becomes writable.
3442 * This function will take ownership of @data and g_free() it after use.
3444 * The return value of this function will be used as the id argument in the
3445 * message_sent callback.
3447 * Deprecated: Use gst_rtsp_watch_write_data()
3453 #ifndef GST_REMOVE_DEPRECATED
3455 gst_rtsp_watch_queue_data (GstRTSPWatch * watch, const guint8 * data,
3460 g_return_val_if_fail (watch != NULL, GST_RTSP_EINVAL);
3461 g_return_val_if_fail (data != NULL, GST_RTSP_EINVAL);
3462 g_return_val_if_fail (size != 0, GST_RTSP_EINVAL);
3464 g_mutex_lock (watch->mutex);
3466 /* make a record with the data and id */
3467 rec = g_slice_new (GstRTSPRec);
3468 rec->data = (guint8 *) data;
3471 /* make sure rec->id is never 0 */
3472 rec->id = ++watch->id;
3473 } while (G_UNLIKELY (rec->id == 0));
3475 /* add the record to a queue. FIXME we would like to have an upper limit here */
3476 g_queue_push_head (watch->messages, rec);
3478 /* make sure the main context will now also check for writability on the
3480 if (!watch->write_added) {
3481 g_source_add_poll ((GSource *) watch, &watch->writefd);
3482 watch->write_added = TRUE;
3485 g_mutex_unlock (watch->mutex);
3488 #endif /* GST_REMOVE_DEPRECATED */
3491 * gst_rtsp_watch_queue_message:
3492 * @watch: a #GstRTSPWatch
3493 * @message: a #GstRTSPMessage
3495 * Queue a @message for transmission in @watch. The contents of this
3496 * message will be serialized and transmitted when the connection of the
3497 * @watch becomes writable.
3499 * The return value of this function will be used as the id argument in the
3500 * message_sent callback.
3502 * Deprecated: Use gst_rtsp_watch_send_message()
3508 #ifndef GST_REMOVE_DEPRECATED
3510 gst_rtsp_watch_queue_message (GstRTSPWatch * watch, GstRTSPMessage * message)
3515 g_return_val_if_fail (watch != NULL, GST_RTSP_EINVAL);
3516 g_return_val_if_fail (message != NULL, GST_RTSP_EINVAL);
3518 /* make a record with the message as a string and id */
3519 str = message_to_string (watch->conn, message);
3521 return gst_rtsp_watch_queue_data (watch,
3522 (guint8 *) g_string_free (str, FALSE), size);
3524 #endif /* GST_REMOVE_DEPRECATED */