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 */
117 static GstRTSPResult read_line (gint fd, guint8 * buffer, guint * idx,
118 guint size, DecodeCtx * ctxp);
119 static GstRTSPResult parse_key_value (guint8 * buffer, gchar * key,
120 guint keysize, gchar ** value);
121 static void parse_string (gchar * dest, gint size, gchar ** src);
124 #define READ_SOCKET(fd, buf, len) recv (fd, (char *)buf, len, 0)
125 #define WRITE_SOCKET(fd, buf, len) send (fd, (const char *)buf, len, 0)
126 #define SETSOCKOPT(sock, level, name, val, len) setsockopt (sock, level, name, (const char *)val, len)
127 #define CLOSE_SOCKET(sock) closesocket (sock)
128 #define ERRNO_IS_EAGAIN (WSAGetLastError () == WSAEWOULDBLOCK)
129 #define ERRNO_IS_EINTR (WSAGetLastError () == WSAEINTR)
130 /* According to Microsoft's connect() documentation this one returns
131 * WSAEWOULDBLOCK and not WSAEINPROGRESS. */
132 #define ERRNO_IS_EINPROGRESS (WSAGetLastError () == WSAEWOULDBLOCK)
134 #define READ_SOCKET(fd, buf, len) read (fd, buf, len)
135 #define WRITE_SOCKET(fd, buf, len) write (fd, buf, len)
136 #define SETSOCKOPT(sock, level, name, val, len) setsockopt (sock, level, name, val, len)
137 #define CLOSE_SOCKET(sock) close (sock)
138 #define ERRNO_IS_EAGAIN (errno == EAGAIN)
139 #define ERRNO_IS_EINTR (errno == EINTR)
140 #define ERRNO_IS_EINPROGRESS (errno == EINPROGRESS)
143 #define ADD_POLLFD(fdset, pfd, fd) \
146 gst_poll_add_fd (fdset, pfd); \
149 #define REMOVE_POLLFD(fdset, pfd) \
151 if ((pfd)->fd != -1) { \
152 GST_DEBUG ("remove fd %d", (pfd)->fd); \
153 gst_poll_remove_fd (fdset, pfd); \
154 CLOSE_SOCKET ((pfd)->fd); \
164 TUNNEL_STATE_COMPLETE
165 } GstRTSPTunnelState;
167 #define TUNNELID_LEN 24
169 struct _GstRTSPConnection
172 /* URL for the connection */
175 /* connection state */
182 gchar tunnelid[TUNNELID_LEN];
184 GstRTSPTunnelState tstate;
190 gint cseq; /* sequence number */
191 gchar session_id[512]; /* session id */
192 gint timeout; /* session timeout in seconds */
193 GTimer *timer; /* timeout timer */
196 GstRTSPAuthMethod auth_method;
199 GHashTable *auth_params;
218 /* a structure for constructing RTSPMessages */
231 build_reset (GstRTSPBuilder * builder)
233 g_free (builder->body_data);
234 memset (builder, 0, sizeof (GstRTSPBuilder));
238 * gst_rtsp_connection_create:
239 * @url: a #GstRTSPUrl
240 * @conn: storage for a #GstRTSPConnection
242 * Create a newly allocated #GstRTSPConnection from @url and store it in @conn.
243 * The connection will not yet attempt to connect to @url, use
244 * gst_rtsp_connection_connect().
246 * A copy of @url will be made.
248 * Returns: #GST_RTSP_OK when @conn contains a valid connection.
251 gst_rtsp_connection_create (const GstRTSPUrl * url, GstRTSPConnection ** conn)
253 GstRTSPConnection *newconn;
259 g_return_val_if_fail (conn != NULL, GST_RTSP_EINVAL);
262 error = WSAStartup (0x0202, &w);
267 if (w.wVersion != 0x0202)
271 newconn = g_new0 (GstRTSPConnection, 1);
273 if ((newconn->fdset = gst_poll_new (TRUE)) == NULL)
276 newconn->url = gst_rtsp_url_copy (url);
277 newconn->fd0.fd = -1;
278 newconn->fd1.fd = -1;
279 newconn->timer = g_timer_new ();
280 newconn->timeout = 60;
283 newconn->auth_method = GST_RTSP_AUTH_NONE;
284 newconn->username = NULL;
285 newconn->passwd = NULL;
286 newconn->auth_params = NULL;
296 g_warning ("Error %d on WSAStartup", error);
297 return GST_RTSP_EWSASTART;
301 g_warning ("Windows sockets are not version 0x202 (current 0x%x)",
304 return GST_RTSP_EWSAVERSION;
313 return GST_RTSP_ESYS;
318 * gst_rtsp_connection_accept:
320 * @conn: storage for a #GstRTSPConnection
322 * Accept a new connection on @sock and create a new #GstRTSPConnection for
323 * handling communication on new socket.
325 * Returns: #GST_RTSP_OK when @conn contains a valid connection.
330 gst_rtsp_connection_accept (gint sock, GstRTSPConnection ** conn)
333 GstRTSPConnection *newconn = NULL;
334 union gst_sockaddr sa;
335 socklen_t slen = sizeof (sa);
336 gchar ip[INET6_ADDRSTRLEN];
342 memset (&sa, 0, slen);
345 fd = accept (sock, &sa.sa, &slen);
347 fd = accept (sock, &sa.sa, (gint *) & slen);
348 #endif /* G_OS_WIN32 */
352 if (getnameinfo (&sa.sa, slen, ip, sizeof (ip), NULL, 0, NI_NUMERICHOST) != 0)
353 goto getnameinfo_failed;
354 if (sa.sa.sa_family != AF_INET && sa.sa.sa_family != AF_INET6)
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);
367 if (sa.sa.sa_family == AF_INET)
368 url->port = sa.sa_in.sin_port;
370 url->port = sa.sa_in6.sin6_port;
372 /* now create the connection object */
373 gst_rtsp_connection_create (url, &newconn);
374 gst_rtsp_url_free (url);
376 ADD_POLLFD (newconn->fdset, &newconn->fd0, fd);
378 /* both read and write initially */
379 newconn->readfd = &newconn->fd0;
380 newconn->writefd = &newconn->fd0;
389 return GST_RTSP_ESYS;
395 return GST_RTSP_ERROR;
400 do_resolve (const gchar * host)
402 static gchar ip[INET6_ADDRSTRLEN];
403 struct addrinfo *aires;
407 aierr = getaddrinfo (host, NULL, NULL, &aires);
411 for (ai = aires; ai; ai = ai->ai_next) {
412 if (ai->ai_family == AF_INET || ai->ai_family == AF_INET6) {
419 aierr = getnameinfo (ai->ai_addr, ai->ai_addrlen, ip, sizeof (ip), NULL, 0,
420 NI_NUMERICHOST | NI_NUMERICSERV);
424 freeaddrinfo (aires);
426 return g_strdup (ip);
431 GST_ERROR ("no addrinfo found for %s: %s", host, gai_strerror (aierr));
436 GST_ERROR ("no family found for %s", host);
437 freeaddrinfo (aires);
442 GST_ERROR ("no address found for %s: %s", host, gai_strerror (aierr));
443 freeaddrinfo (aires);
449 do_connect (const gchar * ip, guint16 port, GstPollFD * fdout,
450 GstPoll * fdset, GTimeVal * timeout)
453 struct addrinfo hints;
454 struct addrinfo *aires;
457 gchar service[NI_MAXSERV];
460 unsigned long flags = 1;
461 #endif /* G_OS_WIN32 */
465 memset (&hints, 0, sizeof hints);
466 hints.ai_flags = AI_NUMERICHOST;
467 hints.ai_family = AF_UNSPEC;
468 hints.ai_socktype = SOCK_STREAM;
469 g_snprintf (service, sizeof (service) - 1, "%hu", port);
470 service[sizeof (service) - 1] = '\0';
472 aierr = getaddrinfo (ip, service, &hints, &aires);
476 for (ai = aires; ai; ai = ai->ai_next) {
477 if (ai->ai_family == AF_INET || ai->ai_family == AF_INET6) {
484 fd = socket (ai->ai_family, SOCK_STREAM, 0);
488 /* set to non-blocking mode so that we can cancel the connect */
490 fcntl (fd, F_SETFL, O_NONBLOCK);
492 ioctlsocket (fd, FIONBIO, &flags);
493 #endif /* G_OS_WIN32 */
495 /* add the socket to our fdset */
496 ADD_POLLFD (fdset, fdout, fd);
498 /* we are going to connect ASYNC now */
499 ret = connect (fd, ai->ai_addr, ai->ai_addrlen);
502 if (!ERRNO_IS_EINPROGRESS)
505 /* wait for connect to complete up to the specified timeout or until we got
507 gst_poll_fd_ctl_write (fdset, fdout, TRUE);
509 to = timeout ? GST_TIMEVAL_TO_TIME (*timeout) : GST_CLOCK_TIME_NONE;
512 retval = gst_poll_wait (fdset, to);
513 } while (retval == -1 && (errno == EINTR || errno == EAGAIN));
517 else if (retval == -1)
520 /* we can still have an error connecting on windows */
521 if (gst_poll_fd_has_error (fdset, fdout)) {
522 socklen_t len = sizeof (errno);
524 getsockopt (fd, SOL_SOCKET, SO_ERROR, &errno, &len);
526 getsockopt (fd, SOL_SOCKET, SO_ERROR, (char *) &errno, &len);
531 gst_poll_fd_ignored (fdset, fdout);
534 freeaddrinfo (aires);
541 GST_ERROR ("no addrinfo found for %s: %s", ip, gai_strerror (aierr));
542 return GST_RTSP_ERROR;
546 GST_ERROR ("no family found for %s", ip);
547 freeaddrinfo (aires);
548 return GST_RTSP_ERROR;
552 GST_ERROR ("no socket %d (%s)", errno, g_strerror (errno));
553 freeaddrinfo (aires);
554 return GST_RTSP_ESYS;
558 GST_ERROR ("system error %d (%s)", errno, g_strerror (errno));
559 REMOVE_POLLFD (fdset, fdout);
560 freeaddrinfo (aires);
561 return GST_RTSP_ESYS;
565 GST_ERROR ("timeout");
566 REMOVE_POLLFD (fdset, fdout);
567 freeaddrinfo (aires);
568 return GST_RTSP_ETIMEOUT;
573 setup_tunneling (GstRTSPConnection * conn, GTimeVal * timeout)
581 gchar *ip, *url_port_str;
582 guint16 port, url_port;
583 gchar codestr[4], *resultstr;
588 /* create a random sessionid */
589 for (i = 0; i < TUNNELID_LEN; i++)
590 conn->tunnelid[i] = g_random_int_range ('a', 'z');
591 conn->tunnelid[TUNNELID_LEN - 1] = '\0';
594 /* get the port from the url */
595 gst_rtsp_url_get_port (url, &url_port);
597 if (conn->proxy_host) {
598 hostparam = g_strdup_printf ("Host: %s:%d\r\n", url->host, url_port);
599 url_port_str = g_strdup_printf (":%d", url_port);
600 ip = conn->proxy_host;
601 port = conn->proxy_port;
610 str = g_strdup_printf ("GET %s%s%s%s%s%s HTTP/1.0\r\n"
612 "x-sessioncookie: %s\r\n"
613 "Accept: application/x-rtsp-tunnelled\r\n"
614 "Pragma: no-cache\r\n"
615 "Cache-Control: no-cache\r\n" "\r\n",
616 conn->proxy_host ? "http://" : "",
617 conn->proxy_host ? url->host : "",
618 conn->proxy_host ? url_port_str : "",
619 url->abspath, url->query ? "?" : "", url->query ? url->query : "",
620 hostparam ? hostparam : "", conn->tunnelid);
622 /* we start by writing to this fd */
623 conn->writefd = &conn->fd0;
625 res = gst_rtsp_connection_write (conn, (guint8 *) str, strlen (str), timeout);
627 if (res != GST_RTSP_OK)
630 gst_poll_fd_ctl_write (conn->fdset, &conn->fd0, FALSE);
631 gst_poll_fd_ctl_read (conn->fdset, &conn->fd0, TRUE);
633 to = timeout ? GST_TIMEVAL_TO_TIME (*timeout) : GST_CLOCK_TIME_NONE;
641 res = read_line (conn->fd0.fd, buffer, &idx, sizeof (buffer), NULL);
642 if (res == GST_RTSP_EEOF)
644 if (res == GST_RTSP_OK)
646 if (res != GST_RTSP_EINTR)
650 retval = gst_poll_wait (conn->fdset, to);
651 } while (retval == -1 && (errno == EINTR || errno == EAGAIN));
653 /* check for timeout */
665 /* check for last line */
666 if (buffer[0] == '\r')
668 if (buffer[0] == '\0')
672 /* first line, parse response */
673 gchar versionstr[20];
676 bptr = (gchar *) buffer;
678 parse_string (versionstr, sizeof (versionstr), &bptr);
679 parse_string (codestr, sizeof (codestr), &bptr);
680 code = atoi (codestr);
682 while (g_ascii_isspace (*bptr))
687 if (code != GST_RTSP_STS_OK)
693 /* other lines, parse key/value */
694 res = parse_key_value (buffer, key, sizeof (key), &value);
695 if (res == GST_RTSP_OK) {
696 /* we got a new ip address */
697 if (g_ascii_strcasecmp (key, "x-server-ip-address") == 0) {
698 if (conn->proxy_host) {
699 /* if we use a proxy we need to change the destination url */
701 url->host = g_strdup (value);
703 g_free (url_port_str);
705 g_strdup_printf ("Host: %s:%d\r\n", url->host, url_port);
706 url_port_str = g_strdup_printf (":%d", url_port);
708 /* and resolve the new ip address */
709 if (!(ip = do_resolve (conn->ip)))
720 /* connect to the host/port */
721 res = do_connect (ip, port, &conn->fd1, conn->fdset, timeout);
722 if (res != GST_RTSP_OK)
725 /* this is now our writing socket */
726 conn->writefd = &conn->fd1;
729 str = g_strdup_printf ("POST %s%s%s%s%s%s HTTP/1.0\r\n"
731 "x-sessioncookie: %s\r\n"
732 "Content-Type: application/x-rtsp-tunnelled\r\n"
733 "Pragma: no-cache\r\n"
734 "Cache-Control: no-cache\r\n"
735 "Content-Length: 32767\r\n"
736 "Expires: Sun, 9 Jan 1972 00:00:00 GMT\r\n"
738 conn->proxy_host ? "http://" : "",
739 conn->proxy_host ? url->host : "",
740 conn->proxy_host ? url_port_str : "",
741 url->abspath, url->query ? "?" : "", url->query ? url->query : "",
742 hostparam ? hostparam : "", conn->tunnelid);
744 res = gst_rtsp_connection_write (conn, (guint8 *) str, strlen (str), timeout);
746 if (res != GST_RTSP_OK)
751 g_free (url_port_str);
758 GST_ERROR ("write failed (%d)", res);
772 res = GST_RTSP_ETIMEOUT;
782 res = GST_RTSP_EINTR;
787 GST_ERROR ("got failure response %d %s", code, resultstr);
788 res = GST_RTSP_ERROR;
793 GST_ERROR ("could not resolve %s", conn->ip);
799 GST_ERROR ("failed to connect");
805 * gst_rtsp_connection_connect:
806 * @conn: a #GstRTSPConnection
807 * @timeout: a #GTimeVal timeout
809 * Attempt to connect to the url of @conn made with
810 * gst_rtsp_connection_create(). If @timeout is #NULL this function can block
811 * forever. If @timeout contains a valid timeout, this function will return
812 * #GST_RTSP_ETIMEOUT after the timeout expired.
814 * This function can be cancelled with gst_rtsp_connection_flush().
816 * Returns: #GST_RTSP_OK when a connection could be made.
819 gst_rtsp_connection_connect (GstRTSPConnection * conn, GTimeVal * timeout)
826 g_return_val_if_fail (conn != NULL, GST_RTSP_EINVAL);
827 g_return_val_if_fail (conn->url != NULL, GST_RTSP_EINVAL);
828 g_return_val_if_fail (conn->fd0.fd < 0, GST_RTSP_EINVAL);
832 if (conn->proxy_host && conn->tunneled) {
833 if (!(ip = do_resolve (conn->proxy_host))) {
834 GST_ERROR ("could not resolve %s", conn->proxy_host);
837 port = conn->proxy_port;
838 g_free (conn->proxy_host);
839 conn->proxy_host = ip;
841 if (!(ip = do_resolve (url->host))) {
842 GST_ERROR ("could not resolve %s", url->host);
845 /* get the port from the url */
846 gst_rtsp_url_get_port (url, &port);
852 /* connect to the host/port */
853 res = do_connect (ip, port, &conn->fd0, conn->fdset, timeout);
854 if (res != GST_RTSP_OK)
857 /* this is our read URL */
858 conn->readfd = &conn->fd0;
860 if (conn->tunneled) {
861 res = setup_tunneling (conn, timeout);
862 if (res != GST_RTSP_OK)
863 goto tunneling_failed;
865 conn->writefd = &conn->fd0;
872 return GST_RTSP_ENET;
876 GST_ERROR ("failed to connect");
881 GST_ERROR ("failed to setup tunneling");
887 auth_digest_compute_hex_urp (const gchar * username,
888 const gchar * realm, const gchar * password, gchar hex_urp[33])
890 GChecksum *md5_context = g_checksum_new (G_CHECKSUM_MD5);
891 const gchar *digest_string;
893 g_checksum_update (md5_context, (const guchar *) username, strlen (username));
894 g_checksum_update (md5_context, (const guchar *) ":", 1);
895 g_checksum_update (md5_context, (const guchar *) realm, strlen (realm));
896 g_checksum_update (md5_context, (const guchar *) ":", 1);
897 g_checksum_update (md5_context, (const guchar *) password, strlen (password));
898 digest_string = g_checksum_get_string (md5_context);
900 memset (hex_urp, 0, 33);
901 memcpy (hex_urp, digest_string, strlen (digest_string));
903 g_checksum_free (md5_context);
907 auth_digest_compute_response (const gchar * method,
908 const gchar * uri, const gchar * hex_a1, const gchar * nonce,
911 char hex_a2[33] = { 0, };
912 GChecksum *md5_context = g_checksum_new (G_CHECKSUM_MD5);
913 const gchar *digest_string;
916 g_checksum_update (md5_context, (const guchar *) method, strlen (method));
917 g_checksum_update (md5_context, (const guchar *) ":", 1);
918 g_checksum_update (md5_context, (const guchar *) uri, strlen (uri));
919 digest_string = g_checksum_get_string (md5_context);
920 memcpy (hex_a2, digest_string, strlen (digest_string));
923 #if GLIB_CHECK_VERSION (2, 18, 0)
924 g_checksum_reset (md5_context);
926 g_checksum_free (md5_context);
927 md5_context = g_checksum_new (G_CHECKSUM_MD5);
929 g_checksum_update (md5_context, (const guchar *) hex_a1, strlen (hex_a1));
930 g_checksum_update (md5_context, (const guchar *) ":", 1);
931 g_checksum_update (md5_context, (const guchar *) nonce, strlen (nonce));
932 g_checksum_update (md5_context, (const guchar *) ":", 1);
934 g_checksum_update (md5_context, (const guchar *) hex_a2, 32);
935 digest_string = g_checksum_get_string (md5_context);
936 memset (response, 0, 33);
937 memcpy (response, digest_string, strlen (digest_string));
939 g_checksum_free (md5_context);
943 add_auth_header (GstRTSPConnection * conn, GstRTSPMessage * message)
945 switch (conn->auth_method) {
946 case GST_RTSP_AUTH_BASIC:{
951 user_pass = g_strdup_printf ("%s:%s", conn->username, conn->passwd);
952 user_pass64 = g_base64_encode ((guchar *) user_pass, strlen (user_pass));
953 auth_string = g_strdup_printf ("Basic %s", user_pass64);
955 gst_rtsp_message_take_header (message, GST_RTSP_HDR_AUTHORIZATION,
959 g_free (user_pass64);
962 case GST_RTSP_AUTH_DIGEST:{
963 gchar response[33], hex_urp[33];
964 gchar *auth_string, *auth_string2;
971 /* we need to have some params set */
972 if (conn->auth_params == NULL)
975 /* we need the realm and nonce */
976 realm = (gchar *) g_hash_table_lookup (conn->auth_params, "realm");
977 nonce = (gchar *) g_hash_table_lookup (conn->auth_params, "nonce");
978 if (realm == NULL || nonce == NULL)
981 auth_digest_compute_hex_urp (conn->username, realm, conn->passwd,
984 method = gst_rtsp_method_as_text (message->type_data.request.method);
985 uri = message->type_data.request.uri;
987 /* Assume no qop, algorithm=md5, stale=false */
988 /* For algorithm MD5, a1 = urp. */
989 auth_digest_compute_response (method, uri, hex_urp, nonce, response);
990 auth_string = g_strdup_printf ("Digest username=\"%s\", "
991 "realm=\"%s\", nonce=\"%s\", uri=\"%s\", response=\"%s\"",
992 conn->username, realm, nonce, uri, response);
994 opaque = (gchar *) g_hash_table_lookup (conn->auth_params, "opaque");
996 auth_string2 = g_strdup_printf ("%s, opaque=\"%s\"", auth_string,
998 g_free (auth_string);
999 auth_string = auth_string2;
1001 gst_rtsp_message_take_header (message, GST_RTSP_HDR_AUTHORIZATION,
1012 gen_date_string (gchar * date_string, guint len)
1016 #ifdef HAVE_GMTIME_R
1020 g_get_current_time (&tv);
1021 t = (time_t) tv.tv_sec;
1023 #ifdef HAVE_GMTIME_R
1024 strftime (date_string, len, "%a, %d %b %Y %H:%M:%S GMT", gmtime_r (&t, &tm_));
1026 strftime (date_string, len, "%a, %d %b %Y %H:%M:%S GMT", gmtime (&t));
1030 static GstRTSPResult
1031 write_bytes (gint fd, const guint8 * buffer, guint * idx, guint size)
1035 if (G_UNLIKELY (*idx > size))
1036 return GST_RTSP_ERROR;
1043 r = WRITE_SOCKET (fd, &buffer[*idx], left);
1044 if (G_UNLIKELY (r == 0)) {
1045 return GST_RTSP_EINTR;
1046 } else if (G_UNLIKELY (r < 0)) {
1047 if (ERRNO_IS_EAGAIN)
1048 return GST_RTSP_EINTR;
1049 if (!ERRNO_IS_EINTR)
1050 return GST_RTSP_ESYS;
1060 fill_bytes (gint fd, guint8 * buffer, guint size, DecodeCtx * ctx)
1066 guint8 in[sizeof (ctx->out) * 4 / 3];
1069 while (size > 0 && ctx->cout < ctx->coutl) {
1070 /* we have some leftover bytes */
1071 *buffer++ = ctx->out[ctx->cout++];
1076 /* got what we needed? */
1080 /* try to read more bytes */
1081 r = READ_SOCKET (fd, in, sizeof (in));
1090 g_base64_decode_step ((gchar *) in, r, ctx->out, &ctx->state,
1094 out = READ_SOCKET (fd, buffer, size);
1100 static GstRTSPResult
1101 read_bytes (gint fd, guint8 * buffer, guint * idx, guint size, DecodeCtx * ctx)
1105 if (G_UNLIKELY (*idx > size))
1106 return GST_RTSP_ERROR;
1113 r = fill_bytes (fd, &buffer[*idx], left, ctx);
1114 if (G_UNLIKELY (r == 0)) {
1115 return GST_RTSP_EEOF;
1116 } else if (G_UNLIKELY (r < 0)) {
1117 if (ERRNO_IS_EAGAIN)
1118 return GST_RTSP_EINTR;
1119 if (!ERRNO_IS_EINTR)
1120 return GST_RTSP_ESYS;
1129 static GstRTSPResult
1130 read_line (gint fd, guint8 * buffer, guint * idx, guint size, DecodeCtx * ctx)
1136 r = fill_bytes (fd, &c, 1, ctx);
1137 if (G_UNLIKELY (r == 0)) {
1138 return GST_RTSP_EEOF;
1139 } else if (G_UNLIKELY (r < 0)) {
1140 if (ERRNO_IS_EAGAIN)
1141 return GST_RTSP_EINTR;
1142 if (!ERRNO_IS_EINTR)
1143 return GST_RTSP_ESYS;
1145 if (c == '\n') /* end on \n */
1147 if (c == '\r') /* ignore \r */
1150 if (G_LIKELY (*idx < size - 1))
1151 buffer[(*idx)++] = c;
1154 buffer[*idx] = '\0';
1160 * gst_rtsp_connection_write:
1161 * @conn: a #GstRTSPConnection
1162 * @data: the data to write
1163 * @size: the size of @data
1164 * @timeout: a timeout value or #NULL
1166 * Attempt to write @size bytes of @data to the connected @conn, blocking up to
1167 * the specified @timeout. @timeout can be #NULL, in which case this function
1168 * might block forever.
1170 * This function can be cancelled with gst_rtsp_connection_flush().
1172 * Returns: #GST_RTSP_OK on success.
1175 gst_rtsp_connection_write (GstRTSPConnection * conn, const guint8 * data,
1176 guint size, GTimeVal * timeout)
1183 g_return_val_if_fail (conn != NULL, GST_RTSP_EINVAL);
1184 g_return_val_if_fail (data != NULL || size == 0, GST_RTSP_EINVAL);
1185 g_return_val_if_fail (conn->writefd != NULL, GST_RTSP_EINVAL);
1187 gst_poll_set_controllable (conn->fdset, TRUE);
1188 gst_poll_fd_ctl_write (conn->fdset, conn->writefd, TRUE);
1189 gst_poll_fd_ctl_read (conn->fdset, conn->readfd, FALSE);
1190 /* clear all previous poll results */
1191 gst_poll_fd_ignored (conn->fdset, conn->writefd);
1192 gst_poll_fd_ignored (conn->fdset, conn->readfd);
1194 to = timeout ? GST_TIMEVAL_TO_TIME (*timeout) : GST_CLOCK_TIME_NONE;
1200 res = write_bytes (conn->writefd->fd, data, &offset, size);
1201 if (G_LIKELY (res == GST_RTSP_OK))
1203 if (G_UNLIKELY (res != GST_RTSP_EINTR))
1206 /* not all is written, wait until we can write more */
1208 retval = gst_poll_wait (conn->fdset, to);
1209 } while (retval == -1 && (errno == EINTR || errno == EAGAIN));
1211 if (G_UNLIKELY (retval == 0))
1214 if (G_UNLIKELY (retval == -1)) {
1226 return GST_RTSP_ETIMEOUT;
1230 return GST_RTSP_ESYS;
1234 return GST_RTSP_EINTR;
1243 message_to_string (GstRTSPConnection * conn, GstRTSPMessage * message)
1245 GString *str = NULL;
1247 str = g_string_new ("");
1249 switch (message->type) {
1250 case GST_RTSP_MESSAGE_REQUEST:
1251 /* create request string, add CSeq */
1252 g_string_append_printf (str, "%s %s RTSP/1.0\r\n"
1254 gst_rtsp_method_as_text (message->type_data.request.method),
1255 message->type_data.request.uri, conn->cseq++);
1256 /* add session id if we have one */
1257 if (conn->session_id[0] != '\0') {
1258 gst_rtsp_message_add_header (message, GST_RTSP_HDR_SESSION,
1261 /* add any authentication headers */
1262 add_auth_header (conn, message);
1264 case GST_RTSP_MESSAGE_RESPONSE:
1265 /* create response string */
1266 g_string_append_printf (str, "RTSP/1.0 %d %s\r\n",
1267 message->type_data.response.code, message->type_data.response.reason);
1269 case GST_RTSP_MESSAGE_DATA:
1271 guint8 data_header[4];
1273 /* prepare data header */
1274 data_header[0] = '$';
1275 data_header[1] = message->type_data.data.channel;
1276 data_header[2] = (message->body_size >> 8) & 0xff;
1277 data_header[3] = message->body_size & 0xff;
1279 /* create string with header and data */
1280 str = g_string_append_len (str, (gchar *) data_header, 4);
1282 g_string_append_len (str, (gchar *) message->body,
1283 message->body_size);
1287 g_string_free (str, TRUE);
1288 g_return_val_if_reached (NULL);
1292 /* append headers and body */
1293 if (message->type != GST_RTSP_MESSAGE_DATA) {
1294 gchar date_string[100];
1296 gen_date_string (date_string, sizeof (date_string));
1298 /* add date header */
1299 gst_rtsp_message_add_header (message, GST_RTSP_HDR_DATE, date_string);
1301 /* append headers */
1302 gst_rtsp_message_append_headers (message, str);
1304 /* append Content-Length and body if needed */
1305 if (message->body != NULL && message->body_size > 0) {
1308 len = g_strdup_printf ("%d", message->body_size);
1309 g_string_append_printf (str, "%s: %s\r\n",
1310 gst_rtsp_header_as_text (GST_RTSP_HDR_CONTENT_LENGTH), len);
1312 /* header ends here */
1313 g_string_append (str, "\r\n");
1315 g_string_append_len (str, (gchar *) message->body,
1316 message->body_size);
1318 /* just end headers */
1319 g_string_append (str, "\r\n");
1327 * gst_rtsp_connection_send:
1328 * @conn: a #GstRTSPConnection
1329 * @message: the message to send
1330 * @timeout: a timeout value or #NULL
1332 * Attempt to send @message to the connected @conn, blocking up to
1333 * the specified @timeout. @timeout can be #NULL, in which case this function
1334 * might block forever.
1336 * This function can be cancelled with gst_rtsp_connection_flush().
1338 * Returns: #GST_RTSP_OK on success.
1341 gst_rtsp_connection_send (GstRTSPConnection * conn, GstRTSPMessage * message,
1344 GString *string = NULL;
1349 g_return_val_if_fail (conn != NULL, GST_RTSP_EINVAL);
1350 g_return_val_if_fail (message != NULL, GST_RTSP_EINVAL);
1352 if (G_UNLIKELY (!(string = message_to_string (conn, message))))
1355 if (conn->tunneled) {
1356 str = g_base64_encode ((const guchar *) string->str, string->len);
1357 g_string_free (string, TRUE);
1362 g_string_free (string, FALSE);
1366 res = gst_rtsp_connection_write (conn, (guint8 *) str, len, timeout);
1374 g_warning ("Wrong message");
1375 return GST_RTSP_EINVAL;
1380 parse_string (gchar * dest, gint size, gchar ** src)
1386 while (g_ascii_isspace (**src))
1389 while (!g_ascii_isspace (**src) && **src != '\0') {
1391 dest[idx++] = **src;
1399 parse_key (gchar * dest, gint size, gchar ** src)
1404 while (**src != ':' && **src != '\0') {
1406 dest[idx++] = **src;
1413 static GstRTSPResult
1414 parse_response_status (guint8 * buffer, GstRTSPMessage * msg)
1417 gchar versionstr[20];
1422 bptr = (gchar *) buffer;
1424 parse_string (versionstr, sizeof (versionstr), &bptr);
1425 parse_string (codestr, sizeof (codestr), &bptr);
1426 code = atoi (codestr);
1428 while (g_ascii_isspace (*bptr))
1431 if (strcmp (versionstr, "RTSP/1.0") == 0)
1432 GST_RTSP_CHECK (gst_rtsp_message_init_response (msg, code, bptr, NULL),
1434 else if (strncmp (versionstr, "RTSP/", 5) == 0) {
1435 GST_RTSP_CHECK (gst_rtsp_message_init_response (msg, code, bptr, NULL),
1437 msg->type_data.response.version = GST_RTSP_VERSION_INVALID;
1445 return GST_RTSP_EPARSE;
1449 static GstRTSPResult
1450 parse_request_line (GstRTSPConnection * conn, guint8 * buffer,
1451 GstRTSPMessage * msg)
1453 GstRTSPResult res = GST_RTSP_OK;
1454 gchar versionstr[20];
1455 gchar methodstr[20];
1458 GstRTSPMethod method;
1459 GstRTSPTunnelState tstate = TUNNEL_STATE_NONE;
1461 bptr = (gchar *) buffer;
1463 parse_string (methodstr, sizeof (methodstr), &bptr);
1464 method = gst_rtsp_find_method (methodstr);
1465 if (method == GST_RTSP_INVALID) {
1466 /* a tunnel request is allowed when we don't have one yet */
1467 if (conn->tstate != TUNNEL_STATE_NONE)
1468 goto invalid_method;
1469 /* we need GET or POST for a valid tunnel request */
1470 if (!strcmp (methodstr, "GET"))
1471 tstate = TUNNEL_STATE_GET;
1472 else if (!strcmp (methodstr, "POST"))
1473 tstate = TUNNEL_STATE_POST;
1475 goto invalid_method;
1478 parse_string (urlstr, sizeof (urlstr), &bptr);
1479 if (G_UNLIKELY (*urlstr == '\0'))
1482 parse_string (versionstr, sizeof (versionstr), &bptr);
1484 if (G_UNLIKELY (*bptr != '\0'))
1485 goto invalid_version;
1487 if (strcmp (versionstr, "RTSP/1.0") == 0) {
1488 res = gst_rtsp_message_init_request (msg, method, urlstr);
1489 } else if (strncmp (versionstr, "RTSP/", 5) == 0) {
1490 res = gst_rtsp_message_init_request (msg, method, urlstr);
1491 msg->type_data.request.version = GST_RTSP_VERSION_INVALID;
1492 } else if (strcmp (versionstr, "HTTP/1.0") == 0) {
1493 /* tunnel request, we need a tunnel method */
1494 if (tstate == TUNNEL_STATE_NONE) {
1495 res = GST_RTSP_EPARSE;
1497 conn->tstate = tstate;
1500 res = GST_RTSP_EPARSE;
1508 GST_ERROR ("invalid method %s", methodstr);
1509 return GST_RTSP_EPARSE;
1513 GST_ERROR ("invalid url %s", urlstr);
1514 return GST_RTSP_EPARSE;
1518 GST_ERROR ("invalid version");
1519 return GST_RTSP_EPARSE;
1523 static GstRTSPResult
1524 parse_key_value (guint8 * buffer, gchar * key, guint keysize, gchar ** value)
1528 bptr = (gchar *) buffer;
1531 parse_key (key, keysize, &bptr);
1532 if (G_UNLIKELY (*bptr != ':'))
1536 while (g_ascii_isspace (*bptr))
1546 return GST_RTSP_EPARSE;
1550 /* parsing lines means reading a Key: Value pair */
1551 static GstRTSPResult
1552 parse_line (GstRTSPConnection * conn, guint8 * buffer, GstRTSPMessage * msg)
1557 GstRTSPHeaderField field;
1559 res = parse_key_value (buffer, key, sizeof (key), &value);
1560 if (G_UNLIKELY (res != GST_RTSP_OK))
1563 if (conn->tstate == TUNNEL_STATE_GET || conn->tstate == TUNNEL_STATE_POST) {
1564 /* save the tunnel session in the connection */
1565 if (!strcmp (key, "x-sessioncookie")) {
1566 strncpy (conn->tunnelid, value, TUNNELID_LEN);
1567 conn->tunnelid[TUNNELID_LEN - 1] = '\0';
1568 conn->tunneled = TRUE;
1571 field = gst_rtsp_find_header_field (key);
1572 if (field != GST_RTSP_HDR_INVALID)
1573 gst_rtsp_message_add_header (msg, field, value);
1586 * GST_RTSP_OK when a complete message was read.
1587 * GST_RTSP_EEOF: when the socket is closed
1588 * GST_RTSP_EINTR: when more data is needed.
1589 * GST_RTSP_..: some other error occured.
1591 static GstRTSPResult
1592 build_next (GstRTSPBuilder * builder, GstRTSPMessage * message,
1593 GstRTSPConnection * conn)
1598 switch (builder->state) {
1600 builder->offset = 0;
1602 read_bytes (conn->readfd->fd, (guint8 *) builder->buffer,
1603 &builder->offset, 1, conn->ctxp);
1604 if (res != GST_RTSP_OK)
1607 /* we have 1 bytes now and we can see if this is a data message or
1609 if (builder->buffer[0] == '$') {
1610 /* data message, prepare for the header */
1611 builder->state = STATE_DATA_HEADER;
1614 builder->state = STATE_READ_LINES;
1617 case STATE_DATA_HEADER:
1620 read_bytes (conn->readfd->fd, (guint8 *) builder->buffer,
1621 &builder->offset, 4, conn->ctxp);
1622 if (res != GST_RTSP_OK)
1625 gst_rtsp_message_init_data (message, builder->buffer[1]);
1627 builder->body_len = (builder->buffer[2] << 8) | builder->buffer[3];
1628 builder->body_data = g_malloc (builder->body_len + 1);
1629 builder->body_data[builder->body_len] = '\0';
1630 builder->offset = 0;
1631 builder->state = STATE_DATA_BODY;
1634 case STATE_DATA_BODY:
1637 read_bytes (conn->readfd->fd, builder->body_data, &builder->offset,
1638 builder->body_len, conn->ctxp);
1639 if (res != GST_RTSP_OK)
1642 /* we have the complete body now, store in the message adjusting the
1643 * length to include the traling '\0' */
1644 gst_rtsp_message_take_body (message,
1645 (guint8 *) builder->body_data, builder->body_len + 1);
1646 builder->body_data = NULL;
1647 builder->body_len = 0;
1649 builder->state = STATE_END;
1652 case STATE_READ_LINES:
1654 res = read_line (conn->readfd->fd, builder->buffer, &builder->offset,
1655 sizeof (builder->buffer), conn->ctxp);
1656 if (res != GST_RTSP_OK)
1659 /* we have a regular response */
1660 if (builder->buffer[0] == '\r') {
1661 builder->buffer[0] = '\0';
1664 if (builder->buffer[0] == '\0') {
1667 /* empty line, end of message header */
1668 /* see if there is a Content-Length header */
1669 if (gst_rtsp_message_get_header (message,
1670 GST_RTSP_HDR_CONTENT_LENGTH, &hdrval, 0) == GST_RTSP_OK) {
1671 /* there is, prepare to read the body */
1672 builder->body_len = atol (hdrval);
1673 builder->body_data = g_malloc (builder->body_len + 1);
1674 builder->body_data[builder->body_len] = '\0';
1675 builder->offset = 0;
1676 builder->state = STATE_DATA_BODY;
1678 builder->state = STATE_END;
1683 /* we have a line */
1684 if (builder->line == 0) {
1685 /* first line, check for response status */
1686 if (memcmp (builder->buffer, "RTSP", 4) == 0) {
1687 res = parse_response_status (builder->buffer, message);
1689 res = parse_request_line (conn, builder->buffer, message);
1691 /* the first line must parse without errors */
1692 if (res != GST_RTSP_OK)
1695 /* else just parse the line, ignore errors */
1696 parse_line (conn, builder->buffer, message);
1699 builder->offset = 0;
1706 if (conn->tstate == TUNNEL_STATE_GET) {
1707 res = GST_RTSP_ETGET;
1709 } else if (conn->tstate == TUNNEL_STATE_POST) {
1710 res = GST_RTSP_ETPOST;
1714 if (message->type == GST_RTSP_MESSAGE_DATA) {
1715 /* data messages don't have headers */
1720 /* save session id in the connection for further use */
1721 if (message->type == GST_RTSP_MESSAGE_RESPONSE &&
1722 gst_rtsp_message_get_header (message, GST_RTSP_HDR_SESSION,
1723 &session_id, 0) == GST_RTSP_OK) {
1726 maxlen = sizeof (conn->session_id) - 1;
1727 /* the sessionid can have attributes marked with ;
1728 * Make sure we strip them */
1729 for (i = 0; session_id[i] != '\0'; i++) {
1730 if (session_id[i] == ';') {
1735 } while (g_ascii_isspace (session_id[i]));
1736 if (g_str_has_prefix (&session_id[i], "timeout=")) {
1739 /* if we parsed something valid, configure */
1740 if ((to = atoi (&session_id[i + 8])) > 0)
1747 /* make sure to not overflow */
1748 strncpy (conn->session_id, session_id, maxlen);
1749 conn->session_id[maxlen] = '\0';
1755 res = GST_RTSP_ERROR;
1764 * gst_rtsp_connection_read:
1765 * @conn: a #GstRTSPConnection
1766 * @data: the data to read
1767 * @size: the size of @data
1768 * @timeout: a timeout value or #NULL
1770 * Attempt to read @size bytes into @data from the connected @conn, blocking up to
1771 * the specified @timeout. @timeout can be #NULL, in which case this function
1772 * might block forever.
1774 * This function can be cancelled with gst_rtsp_connection_flush().
1776 * Returns: #GST_RTSP_OK on success.
1779 gst_rtsp_connection_read (GstRTSPConnection * conn, guint8 * data, guint size,
1787 g_return_val_if_fail (conn != NULL, GST_RTSP_EINVAL);
1788 g_return_val_if_fail (data != NULL, GST_RTSP_EINVAL);
1789 g_return_val_if_fail (conn->readfd != NULL, GST_RTSP_EINVAL);
1791 if (G_UNLIKELY (size == 0))
1796 /* configure timeout if any */
1797 to = timeout ? GST_TIMEVAL_TO_TIME (*timeout) : GST_CLOCK_TIME_NONE;
1799 gst_poll_set_controllable (conn->fdset, TRUE);
1800 gst_poll_fd_ctl_write (conn->fdset, conn->writefd, FALSE);
1801 gst_poll_fd_ctl_read (conn->fdset, conn->readfd, TRUE);
1804 res = read_bytes (conn->readfd->fd, data, &offset, size, conn->ctxp);
1805 if (G_UNLIKELY (res == GST_RTSP_EEOF))
1807 if (G_LIKELY (res == GST_RTSP_OK))
1809 if (G_UNLIKELY (res != GST_RTSP_EINTR))
1813 retval = gst_poll_wait (conn->fdset, to);
1814 } while (retval == -1 && (errno == EINTR || errno == EAGAIN));
1816 /* check for timeout */
1817 if (G_UNLIKELY (retval == 0))
1818 goto select_timeout;
1820 if (G_UNLIKELY (retval == -1)) {
1826 gst_poll_set_controllable (conn->fdset, FALSE);
1833 return GST_RTSP_ESYS;
1837 return GST_RTSP_ETIMEOUT;
1841 return GST_RTSP_EINTR;
1845 return GST_RTSP_EEOF;
1854 gen_tunnel_reply (GstRTSPConnection * conn, GstRTSPStatusCode code)
1857 gchar date_string[100];
1858 const gchar *status;
1860 gen_date_string (date_string, sizeof (date_string));
1862 status = gst_rtsp_status_as_text (code);
1863 if (status == NULL) {
1864 code = GST_RTSP_STS_INTERNAL_SERVER_ERROR;
1865 status = "Internal Server Error";
1868 str = g_string_new ("");
1871 g_string_append_printf (str, "HTTP/1.0 %d %s\r\n", code, status);
1872 g_string_append_printf (str,
1873 "Server: GStreamer RTSP Server\r\n"
1875 "Connection: close\r\n"
1876 "Cache-Control: no-store\r\n" "Pragma: no-cache\r\n", date_string);
1877 if (code == GST_RTSP_STS_OK) {
1879 g_string_append_printf (str, "x-server-ip-address: %s\r\n", conn->ip);
1880 g_string_append_printf (str,
1881 "Content-Type: application/x-rtsp-tunnelled\r\n");
1883 g_string_append_printf (str, "\r\n");
1888 * gst_rtsp_connection_receive:
1889 * @conn: a #GstRTSPConnection
1890 * @message: the message to read
1891 * @timeout: a timeout value or #NULL
1893 * Attempt to read into @message from the connected @conn, blocking up to
1894 * the specified @timeout. @timeout can be #NULL, in which case this function
1895 * might block forever.
1897 * This function can be cancelled with gst_rtsp_connection_flush().
1899 * Returns: #GST_RTSP_OK on success.
1902 gst_rtsp_connection_receive (GstRTSPConnection * conn, GstRTSPMessage * message,
1906 GstRTSPBuilder builder;
1910 g_return_val_if_fail (conn != NULL, GST_RTSP_EINVAL);
1911 g_return_val_if_fail (message != NULL, GST_RTSP_EINVAL);
1912 g_return_val_if_fail (conn->readfd != NULL, GST_RTSP_EINVAL);
1914 /* configure timeout if any */
1915 to = timeout ? GST_TIMEVAL_TO_TIME (*timeout) : GST_CLOCK_TIME_NONE;
1917 gst_poll_set_controllable (conn->fdset, TRUE);
1918 gst_poll_fd_ctl_write (conn->fdset, conn->writefd, FALSE);
1919 gst_poll_fd_ctl_read (conn->fdset, conn->readfd, TRUE);
1921 memset (&builder, 0, sizeof (GstRTSPBuilder));
1923 res = build_next (&builder, message, conn);
1924 if (G_UNLIKELY (res == GST_RTSP_EEOF))
1926 if (G_LIKELY (res == GST_RTSP_OK))
1928 if (res == GST_RTSP_ETGET) {
1931 /* tunnel GET request, we can reply now */
1932 str = gen_tunnel_reply (conn, GST_RTSP_STS_OK);
1934 gst_rtsp_connection_write (conn, (guint8 *) str->str, str->len,
1936 g_string_free (str, TRUE);
1937 } else if (res == GST_RTSP_ETPOST) {
1938 /* tunnel POST request, return the value, the caller now has to link the
1939 * two connections. */
1941 } else if (G_UNLIKELY (res != GST_RTSP_EINTR))
1945 retval = gst_poll_wait (conn->fdset, to);
1946 } while (retval == -1 && (errno == EINTR || errno == EAGAIN));
1948 /* check for timeout */
1949 if (G_UNLIKELY (retval == 0))
1950 goto select_timeout;
1952 if (G_UNLIKELY (retval == -1)) {
1958 gst_poll_set_controllable (conn->fdset, FALSE);
1961 /* we have a message here */
1962 build_reset (&builder);
1969 res = GST_RTSP_ESYS;
1974 res = GST_RTSP_ETIMEOUT;
1979 res = GST_RTSP_EINTR;
1984 res = GST_RTSP_EEOF;
1990 build_reset (&builder);
1991 gst_rtsp_message_unset (message);
1997 * gst_rtsp_connection_close:
1998 * @conn: a #GstRTSPConnection
2000 * Close the connected @conn. After this call, the connection is in the same
2001 * state as when it was first created.
2003 * Returns: #GST_RTSP_OK on success.
2006 gst_rtsp_connection_close (GstRTSPConnection * conn)
2008 g_return_val_if_fail (conn != NULL, GST_RTSP_EINVAL);
2013 REMOVE_POLLFD (conn->fdset, &conn->fd0);
2014 REMOVE_POLLFD (conn->fdset, &conn->fd1);
2015 conn->writefd = NULL;
2016 conn->readfd = NULL;
2017 conn->tunneled = FALSE;
2018 conn->tstate = TUNNEL_STATE_NONE;
2020 g_free (conn->username);
2021 conn->username = NULL;
2022 g_free (conn->passwd);
2023 conn->passwd = NULL;
2024 gst_rtsp_connection_clear_auth_params (conn);
2027 conn->session_id[0] = '\0';
2033 * gst_rtsp_connection_free:
2034 * @conn: a #GstRTSPConnection
2036 * Close and free @conn.
2038 * Returns: #GST_RTSP_OK on success.
2041 gst_rtsp_connection_free (GstRTSPConnection * conn)
2045 g_return_val_if_fail (conn != NULL, GST_RTSP_EINVAL);
2047 res = gst_rtsp_connection_close (conn);
2048 gst_poll_free (conn->fdset);
2049 g_timer_destroy (conn->timer);
2050 gst_rtsp_url_free (conn->url);
2051 g_free (conn->proxy_host);
2061 * gst_rtsp_connection_poll:
2062 * @conn: a #GstRTSPConnection
2063 * @events: a bitmask of #GstRTSPEvent flags to check
2064 * @revents: location for result flags
2065 * @timeout: a timeout
2067 * Wait up to the specified @timeout for the connection to become available for
2068 * at least one of the operations specified in @events. When the function returns
2069 * with #GST_RTSP_OK, @revents will contain a bitmask of available operations on
2072 * @timeout can be #NULL, in which case this function might block forever.
2074 * This function can be cancelled with gst_rtsp_connection_flush().
2076 * Returns: #GST_RTSP_OK on success.
2081 gst_rtsp_connection_poll (GstRTSPConnection * conn, GstRTSPEvent events,
2082 GstRTSPEvent * revents, GTimeVal * timeout)
2087 g_return_val_if_fail (conn != NULL, GST_RTSP_EINVAL);
2088 g_return_val_if_fail (events != 0, GST_RTSP_EINVAL);
2089 g_return_val_if_fail (revents != NULL, GST_RTSP_EINVAL);
2090 g_return_val_if_fail (conn->readfd != NULL, GST_RTSP_EINVAL);
2091 g_return_val_if_fail (conn->writefd != NULL, GST_RTSP_EINVAL);
2093 gst_poll_set_controllable (conn->fdset, TRUE);
2095 /* add fd to writer set when asked to */
2096 gst_poll_fd_ctl_write (conn->fdset, conn->writefd,
2097 events & GST_RTSP_EV_WRITE);
2099 /* add fd to reader set when asked to */
2100 gst_poll_fd_ctl_read (conn->fdset, conn->readfd, events & GST_RTSP_EV_READ);
2102 /* configure timeout if any */
2103 to = timeout ? GST_TIMEVAL_TO_TIME (*timeout) : GST_CLOCK_TIME_NONE;
2106 retval = gst_poll_wait (conn->fdset, to);
2107 } while (retval == -1 && (errno == EINTR || errno == EAGAIN));
2109 if (G_UNLIKELY (retval == 0))
2110 goto select_timeout;
2112 if (G_UNLIKELY (retval == -1)) {
2120 if (events & GST_RTSP_EV_READ) {
2121 if (gst_poll_fd_can_read (conn->fdset, conn->readfd))
2122 *revents |= GST_RTSP_EV_READ;
2124 if (events & GST_RTSP_EV_WRITE) {
2125 if (gst_poll_fd_can_write (conn->fdset, conn->writefd))
2126 *revents |= GST_RTSP_EV_WRITE;
2133 return GST_RTSP_ETIMEOUT;
2137 return GST_RTSP_ESYS;
2141 return GST_RTSP_EINTR;
2146 * gst_rtsp_connection_next_timeout:
2147 * @conn: a #GstRTSPConnection
2148 * @timeout: a timeout
2150 * Calculate the next timeout for @conn, storing the result in @timeout.
2152 * Returns: #GST_RTSP_OK.
2155 gst_rtsp_connection_next_timeout (GstRTSPConnection * conn, GTimeVal * timeout)
2161 g_return_val_if_fail (conn != NULL, GST_RTSP_EINVAL);
2162 g_return_val_if_fail (timeout != NULL, GST_RTSP_EINVAL);
2164 elapsed = g_timer_elapsed (conn->timer, &usec);
2165 if (elapsed >= conn->timeout) {
2169 sec = conn->timeout - elapsed;
2172 timeout->tv_sec = sec;
2173 timeout->tv_usec = usec;
2179 * gst_rtsp_connection_reset_timeout:
2180 * @conn: a #GstRTSPConnection
2182 * Reset the timeout of @conn.
2184 * Returns: #GST_RTSP_OK.
2187 gst_rtsp_connection_reset_timeout (GstRTSPConnection * conn)
2189 g_return_val_if_fail (conn != NULL, GST_RTSP_EINVAL);
2191 g_timer_start (conn->timer);
2197 * gst_rtsp_connection_flush:
2198 * @conn: a #GstRTSPConnection
2199 * @flush: start or stop the flush
2201 * Start or stop the flushing action on @conn. When flushing, all current
2202 * and future actions on @conn will return #GST_RTSP_EINTR until the connection
2203 * is set to non-flushing mode again.
2205 * Returns: #GST_RTSP_OK.
2208 gst_rtsp_connection_flush (GstRTSPConnection * conn, gboolean flush)
2210 g_return_val_if_fail (conn != NULL, GST_RTSP_EINVAL);
2212 gst_poll_set_flushing (conn->fdset, flush);
2218 * gst_rtsp_connection_set_proxy:
2219 * @conn: a #GstRTSPConnection
2220 * @host: the proxy host
2221 * @port: the proxy port
2223 * Set the proxy host and port.
2225 * Returns: #GST_RTSP_OK.
2230 gst_rtsp_connection_set_proxy (GstRTSPConnection * conn,
2231 const gchar * host, guint port)
2233 g_return_val_if_fail (conn != NULL, GST_RTSP_EINVAL);
2235 g_free (conn->proxy_host);
2236 conn->proxy_host = g_strdup (host);
2237 conn->proxy_port = port;
2243 * gst_rtsp_connection_set_auth:
2244 * @conn: a #GstRTSPConnection
2245 * @method: authentication method
2247 * @pass: the password
2249 * Configure @conn for authentication mode @method with @user and @pass as the
2250 * user and password respectively.
2252 * Returns: #GST_RTSP_OK.
2255 gst_rtsp_connection_set_auth (GstRTSPConnection * conn,
2256 GstRTSPAuthMethod method, const gchar * user, const gchar * pass)
2258 g_return_val_if_fail (conn != NULL, GST_RTSP_EINVAL);
2260 if (method == GST_RTSP_AUTH_DIGEST && ((user == NULL || pass == NULL)
2261 || g_strrstr (user, ":") != NULL))
2262 return GST_RTSP_EINVAL;
2264 /* Make sure the username and passwd are being set for authentication */
2265 if (method == GST_RTSP_AUTH_NONE && (user == NULL || pass == NULL))
2266 return GST_RTSP_EINVAL;
2268 /* ":" chars are not allowed in usernames for basic auth */
2269 if (method == GST_RTSP_AUTH_BASIC && g_strrstr (user, ":") != NULL)
2270 return GST_RTSP_EINVAL;
2272 g_free (conn->username);
2273 g_free (conn->passwd);
2275 conn->auth_method = method;
2276 conn->username = g_strdup (user);
2277 conn->passwd = g_strdup (pass);
2284 * @key: ASCII string to hash
2286 * Hashes @key in a case-insensitive manner.
2288 * Returns: the hash code.
2291 str_case_hash (gconstpointer key)
2293 const char *p = key;
2294 guint h = g_ascii_toupper (*p);
2297 for (p += 1; *p != '\0'; p++)
2298 h = (h << 5) - h + g_ascii_toupper (*p);
2305 * @v1: an ASCII string
2306 * @v2: another ASCII string
2308 * Compares @v1 and @v2 in a case-insensitive manner
2310 * Returns: %TRUE if they are equal (modulo case)
2313 str_case_equal (gconstpointer v1, gconstpointer v2)
2315 const char *string1 = v1;
2316 const char *string2 = v2;
2318 return g_ascii_strcasecmp (string1, string2) == 0;
2322 * gst_rtsp_connection_set_auth_param:
2323 * @conn: a #GstRTSPConnection
2324 * @param: authentication directive
2327 * Setup @conn with authentication directives. This is not necesary for
2328 * methods #GST_RTSP_AUTH_NONE and #GST_RTSP_AUTH_BASIC. For
2329 * #GST_RTSP_AUTH_DIGEST, directives should be taken from the digest challenge
2330 * in the WWW-Authenticate response header and can include realm, domain,
2331 * nonce, opaque, stale, algorithm, qop as per RFC2617.
2336 gst_rtsp_connection_set_auth_param (GstRTSPConnection * conn,
2337 const gchar * param, const gchar * value)
2339 g_return_if_fail (conn != NULL);
2340 g_return_if_fail (param != NULL);
2342 if (conn->auth_params == NULL) {
2344 g_hash_table_new_full (str_case_hash, str_case_equal, g_free, g_free);
2346 g_hash_table_insert (conn->auth_params, g_strdup (param), g_strdup (value));
2350 * gst_rtsp_connection_clear_auth_params:
2351 * @conn: a #GstRTSPConnection
2353 * Clear the list of authentication directives stored in @conn.
2358 gst_rtsp_connection_clear_auth_params (GstRTSPConnection * conn)
2360 g_return_if_fail (conn != NULL);
2362 if (conn->auth_params != NULL) {
2363 g_hash_table_destroy (conn->auth_params);
2364 conn->auth_params = NULL;
2368 static GstRTSPResult
2369 set_qos_dscp (gint fd, guint qos_dscp)
2371 union gst_sockaddr sa;
2372 socklen_t slen = sizeof (sa);
2379 if (getsockname (fd, &sa.sa, &slen) < 0)
2380 goto no_getsockname;
2382 af = sa.sa.sa_family;
2384 /* if this is an IPv4-mapped address then do IPv4 QoS */
2385 if (af == AF_INET6) {
2386 if (IN6_IS_ADDR_V4MAPPED (&sa.sa_in6.sin6_addr))
2390 /* extract and shift 6 bits of the DSCP */
2391 tos = (qos_dscp & 0x3f) << 2;
2395 if (SETSOCKOPT (fd, IPPROTO_IP, IP_TOS, &tos, sizeof (tos)) < 0)
2400 if (SETSOCKOPT (fd, IPPROTO_IPV6, IPV6_TCLASS, &tos, sizeof (tos)) < 0)
2414 return GST_RTSP_ESYS;
2419 return GST_RTSP_ERROR;
2424 * gst_rtsp_connection_set_qos_dscp:
2425 * @conn: a #GstRTSPConnection
2426 * @qos_dscp: DSCP value
2428 * Configure @conn to use the specified DSCP value.
2430 * Returns: #GST_RTSP_OK on success.
2435 gst_rtsp_connection_set_qos_dscp (GstRTSPConnection * conn, guint qos_dscp)
2439 g_return_val_if_fail (conn != NULL, GST_RTSP_EINVAL);
2440 g_return_val_if_fail (conn->readfd != NULL, GST_RTSP_EINVAL);
2441 g_return_val_if_fail (conn->writefd != NULL, GST_RTSP_EINVAL);
2443 res = set_qos_dscp (conn->fd0.fd, qos_dscp);
2444 if (res == GST_RTSP_OK)
2445 res = set_qos_dscp (conn->fd1.fd, qos_dscp);
2452 * gst_rtsp_connection_get_url:
2453 * @conn: a #GstRTSPConnection
2455 * Retrieve the URL of the other end of @conn.
2457 * Returns: The URL. This value remains valid until the
2458 * connection is freed.
2463 gst_rtsp_connection_get_url (const GstRTSPConnection * conn)
2465 g_return_val_if_fail (conn != NULL, NULL);
2471 * gst_rtsp_connection_get_ip:
2472 * @conn: a #GstRTSPConnection
2474 * Retrieve the IP address of the other end of @conn.
2476 * Returns: The IP address as a string. this value remains valid until the
2477 * connection is closed.
2482 gst_rtsp_connection_get_ip (const GstRTSPConnection * conn)
2484 g_return_val_if_fail (conn != NULL, NULL);
2490 * gst_rtsp_connection_set_ip:
2491 * @conn: a #GstRTSPConnection
2492 * @ip: an ip address
2494 * Set the IP address of the server.
2499 gst_rtsp_connection_set_ip (GstRTSPConnection * conn, const gchar * ip)
2501 g_return_if_fail (conn != NULL);
2504 conn->ip = g_strdup (ip);
2508 * gst_rtsp_connection_get_readfd:
2509 * @conn: a #GstRTSPConnection
2511 * Get the file descriptor for reading.
2513 * Returns: the file descriptor used for reading or -1 on error. The file
2514 * descriptor remains valid until the connection is closed.
2519 gst_rtsp_connection_get_readfd (const GstRTSPConnection * conn)
2521 g_return_val_if_fail (conn != NULL, -1);
2522 g_return_val_if_fail (conn->readfd != NULL, -1);
2524 return conn->readfd->fd;
2528 * gst_rtsp_connection_get_writefd:
2529 * @conn: a #GstRTSPConnection
2531 * Get the file descriptor for writing.
2533 * Returns: the file descriptor used for writing or -1 on error. The file
2534 * descriptor remains valid until the connection is closed.
2539 gst_rtsp_connection_get_writefd (const GstRTSPConnection * conn)
2541 g_return_val_if_fail (conn != NULL, -1);
2542 g_return_val_if_fail (conn->writefd != NULL, -1);
2544 return conn->writefd->fd;
2549 * gst_rtsp_connection_set_tunneled:
2550 * @conn: a #GstRTSPConnection
2551 * @tunneled: the new state
2553 * Set the HTTP tunneling state of the connection. This must be configured before
2554 * the @conn is connected.
2559 gst_rtsp_connection_set_tunneled (GstRTSPConnection * conn, gboolean tunneled)
2561 g_return_if_fail (conn != NULL);
2562 g_return_if_fail (conn->readfd == NULL);
2563 g_return_if_fail (conn->writefd == NULL);
2565 conn->tunneled = tunneled;
2569 * gst_rtsp_connection_is_tunneled:
2570 * @conn: a #GstRTSPConnection
2572 * Get the tunneling state of the connection.
2574 * Returns: if @conn is using HTTP tunneling.
2579 gst_rtsp_connection_is_tunneled (const GstRTSPConnection * conn)
2581 g_return_val_if_fail (conn != NULL, FALSE);
2583 return conn->tunneled;
2587 * gst_rtsp_connection_get_tunnelid:
2588 * @conn: a #GstRTSPConnection
2590 * Get the tunnel session id the connection.
2592 * Returns: returns a non-empty string if @conn is being tunneled over HTTP.
2597 gst_rtsp_connection_get_tunnelid (const GstRTSPConnection * conn)
2599 g_return_val_if_fail (conn != NULL, NULL);
2601 if (!conn->tunneled)
2604 return conn->tunnelid;
2608 * gst_rtsp_connection_do_tunnel:
2609 * @conn: a #GstRTSPConnection
2610 * @conn2: a #GstRTSPConnection
2612 * If @conn received the first tunnel connection and @conn2 received
2613 * the second tunnel connection, link the two connections together so that
2614 * @conn manages the tunneled connection.
2616 * After this call, @conn2 cannot be used anymore and must be freed with
2617 * gst_rtsp_connection_free().
2619 * Returns: return GST_RTSP_OK on success.
2624 gst_rtsp_connection_do_tunnel (GstRTSPConnection * conn,
2625 GstRTSPConnection * conn2)
2627 g_return_val_if_fail (conn != NULL, GST_RTSP_EINVAL);
2628 g_return_val_if_fail (conn2 != NULL, GST_RTSP_EINVAL);
2629 g_return_val_if_fail (conn->tstate == TUNNEL_STATE_GET, GST_RTSP_EINVAL);
2630 g_return_val_if_fail (conn2->tstate == TUNNEL_STATE_POST, GST_RTSP_EINVAL);
2631 g_return_val_if_fail (!memcmp (conn2->tunnelid, conn->tunnelid, TUNNELID_LEN),
2634 /* both connections have fd0 as the read/write socket. start by taking the
2635 * socket from conn2 and set it as the socket in conn */
2636 conn->fd1 = conn2->fd0;
2638 /* clean up some of the state of conn2 */
2639 gst_poll_remove_fd (conn2->fdset, &conn2->fd0);
2641 conn2->readfd = conn2->writefd = NULL;
2643 /* We make fd0 the write socket and fd1 the read socket. */
2644 conn->writefd = &conn->fd0;
2645 conn->readfd = &conn->fd1;
2647 conn->tstate = TUNNEL_STATE_COMPLETE;
2649 /* we need base64 decoding for the readfd */
2650 conn->ctx.state = 0;
2653 conn->ctx.coutl = 0;
2654 conn->ctxp = &conn->ctx;
2659 #define READ_COND (G_IO_IN | G_IO_HUP | G_IO_ERR)
2660 #define WRITE_COND (G_IO_OUT | G_IO_ERR)
2669 /* async functions */
2670 struct _GstRTSPWatch
2674 GstRTSPConnection *conn;
2676 GstRTSPBuilder builder;
2677 GstRTSPMessage message;
2681 gboolean write_added;
2683 /* queued message for transmission */
2685 GAsyncQueue *messages;
2691 GstRTSPWatchFuncs funcs;
2694 GDestroyNotify notify;
2698 gst_rtsp_source_prepare (GSource * source, gint * timeout)
2700 GstRTSPWatch *watch = (GstRTSPWatch *) source;
2702 *timeout = (watch->conn->timeout * 1000);
2708 gst_rtsp_source_check (GSource * source)
2710 GstRTSPWatch *watch = (GstRTSPWatch *) source;
2712 if (watch->readfd.revents & READ_COND)
2715 if (watch->writefd.revents & WRITE_COND)
2722 gst_rtsp_source_dispatch (GSource * source, GSourceFunc callback G_GNUC_UNUSED,
2723 gpointer user_data G_GNUC_UNUSED)
2725 GstRTSPWatch *watch = (GstRTSPWatch *) source;
2728 /* first read as much as we can */
2729 if (watch->readfd.revents & READ_COND) {
2731 res = build_next (&watch->builder, &watch->message, watch->conn);
2732 if (res == GST_RTSP_EINTR)
2734 if (G_UNLIKELY (res == GST_RTSP_EEOF))
2736 if (res == GST_RTSP_ETGET) {
2738 GstRTSPStatusCode code;
2741 if (watch->funcs.tunnel_start)
2742 code = watch->funcs.tunnel_start (watch, watch->user_data);
2744 code = GST_RTSP_STS_OK;
2746 /* queue the response string */
2747 str = gen_tunnel_reply (watch->conn, code);
2749 gst_rtsp_watch_queue_data (watch, (guint8 *) g_string_free (str, FALSE),
2751 } else if (res == GST_RTSP_ETPOST) {
2752 /* in the callback the connection should be tunneled with the
2754 if (watch->funcs.tunnel_complete)
2755 watch->funcs.tunnel_complete (watch, watch->user_data);
2756 } else if (G_UNLIKELY (res != GST_RTSP_OK))
2759 if (G_LIKELY (res == GST_RTSP_OK)) {
2760 if (watch->funcs.message_received)
2761 watch->funcs.message_received (watch, &watch->message,
2764 gst_rtsp_message_unset (&watch->message);
2766 build_reset (&watch->builder);
2770 if (watch->writefd.revents & WRITE_COND) {
2772 if (watch->write_data == NULL) {
2775 /* get a new message from the queue */
2776 rec = g_async_queue_try_pop (watch->messages);
2780 watch->write_off = 0;
2781 watch->write_data = rec->data;
2782 watch->write_size = rec->size;
2783 watch->write_id = rec->id;
2785 g_slice_free (GstRTSPRec, rec);
2788 res = write_bytes (watch->writefd.fd, watch->write_data,
2789 &watch->write_off, watch->write_size);
2790 if (res == GST_RTSP_EINTR)
2792 if (G_UNLIKELY (res != GST_RTSP_OK))
2795 if (watch->funcs.message_sent)
2796 watch->funcs.message_sent (watch, watch->write_id, watch->user_data);
2799 if (g_async_queue_length (watch->messages) == 0 && watch->write_added) {
2800 g_source_remove_poll ((GSource *) watch, &watch->writefd);
2801 watch->write_added = FALSE;
2802 watch->writefd.revents = 0;
2804 g_free (watch->write_data);
2805 watch->write_data = NULL;
2814 if (watch->funcs.closed)
2815 watch->funcs.closed (watch, watch->user_data);
2820 if (watch->funcs.error)
2821 watch->funcs.error (watch, res, watch->user_data);
2827 gst_rtsp_rec_free (gpointer data)
2829 GstRTSPRec *rec = data;
2832 g_slice_free (GstRTSPRec, rec);
2836 gst_rtsp_source_finalize (GSource * source)
2838 GstRTSPWatch *watch = (GstRTSPWatch *) source;
2840 build_reset (&watch->builder);
2841 gst_rtsp_message_unset (&watch->message);
2843 g_async_queue_unref (watch->messages);
2844 watch->messages = NULL;
2846 g_free (watch->write_data);
2849 watch->notify (watch->user_data);
2852 static GSourceFuncs gst_rtsp_source_funcs = {
2853 gst_rtsp_source_prepare,
2854 gst_rtsp_source_check,
2855 gst_rtsp_source_dispatch,
2856 gst_rtsp_source_finalize,
2862 * gst_rtsp_watch_new:
2863 * @conn: a #GstRTSPConnection
2864 * @funcs: watch functions
2865 * @user_data: user data to pass to @funcs
2866 * @notify: notify when @user_data is not referenced anymore
2868 * Create a watch object for @conn. The functions provided in @funcs will be
2869 * called with @user_data when activity happened on the watch.
2871 * The new watch is usually created so that it can be attached to a
2872 * maincontext with gst_rtsp_watch_attach().
2874 * @conn must exist for the entire lifetime of the watch.
2876 * Returns: a #GstRTSPWatch that can be used for asynchronous RTSP
2877 * communication. Free with gst_rtsp_watch_unref () after usage.
2882 gst_rtsp_watch_new (GstRTSPConnection * conn,
2883 GstRTSPWatchFuncs * funcs, gpointer user_data, GDestroyNotify notify)
2885 GstRTSPWatch *result;
2887 g_return_val_if_fail (conn != NULL, NULL);
2888 g_return_val_if_fail (funcs != NULL, NULL);
2889 g_return_val_if_fail (conn->readfd != NULL, NULL);
2890 g_return_val_if_fail (conn->writefd != NULL, NULL);
2892 result = (GstRTSPWatch *) g_source_new (&gst_rtsp_source_funcs,
2893 sizeof (GstRTSPWatch));
2895 result->conn = conn;
2896 result->builder.state = STATE_START;
2898 result->messages = g_async_queue_new_full (gst_rtsp_rec_free);
2900 result->readfd.fd = -1;
2901 result->writefd.fd = -1;
2903 gst_rtsp_watch_reset (result);
2905 result->funcs = *funcs;
2906 result->user_data = user_data;
2907 result->notify = notify;
2909 /* only add the read fd, the write fd is only added when we have data
2911 g_source_add_poll ((GSource *) result, &result->readfd);
2917 * gst_rtsp_watch_reset:
2918 * @watch: a #GstRTSPWatch
2920 * Reset @watch, this is usually called after gst_rtsp_connection_do_tunnel()
2921 * when the file descriptors of the connection might have changed.
2926 gst_rtsp_watch_reset (GstRTSPWatch * watch)
2928 if (watch->readfd.fd != -1)
2929 g_source_remove_poll ((GSource *) watch, &watch->readfd);
2930 if (watch->writefd.fd != -1)
2931 g_source_remove_poll ((GSource *) watch, &watch->writefd);
2933 watch->readfd.fd = watch->conn->readfd->fd;
2934 watch->readfd.events = READ_COND;
2935 watch->readfd.revents = 0;
2937 watch->writefd.fd = watch->conn->writefd->fd;
2938 watch->writefd.events = WRITE_COND;
2939 watch->writefd.revents = 0;
2940 watch->write_added = FALSE;
2942 g_source_add_poll ((GSource *) watch, &watch->readfd);
2946 * gst_rtsp_watch_attach:
2947 * @watch: a #GstRTSPWatch
2948 * @context: a GMainContext (if NULL, the default context will be used)
2950 * Adds a #GstRTSPWatch to a context so that it will be executed within that context.
2952 * Returns: the ID (greater than 0) for the watch within the GMainContext.
2957 gst_rtsp_watch_attach (GstRTSPWatch * watch, GMainContext * context)
2959 g_return_val_if_fail (watch != NULL, 0);
2961 return g_source_attach ((GSource *) watch, context);
2965 * gst_rtsp_watch_unref:
2966 * @watch: a #GstRTSPWatch
2968 * Decreases the reference count of @watch by one. If the resulting reference
2969 * count is zero the watch and associated memory will be destroyed.
2974 gst_rtsp_watch_unref (GstRTSPWatch * watch)
2976 g_return_if_fail (watch != NULL);
2978 g_source_unref ((GSource *) watch);
2982 * gst_rtsp_watch_queue_data:
2983 * @watch: a #GstRTSPWatch
2984 * @data: the data to queue
2985 * @size: the size of @data
2987 * Queue @data for transmission in @watch. It will be transmitted when the
2988 * connection of the @watch becomes writable.
2990 * This function will take ownership of @data and g_free() it after use.
2992 * The return value of this function will be used as the id argument in the
2993 * message_sent callback.
3000 gst_rtsp_watch_queue_data (GstRTSPWatch * watch, const guint8 * data,
3005 g_return_val_if_fail (watch != NULL, GST_RTSP_EINVAL);
3006 g_return_val_if_fail (data != NULL, GST_RTSP_EINVAL);
3007 g_return_val_if_fail (size != 0, GST_RTSP_EINVAL);
3009 /* make a record with the data and id */
3010 rec = g_slice_new (GstRTSPRec);
3011 rec->data = (guint8 *) data;
3014 /* make sure rec->id is never 0 */
3015 rec->id = ++watch->id;
3016 } while (G_UNLIKELY (rec->id == 0));
3018 /* add the record to a queue. FIXME we would like to have an upper limit here */
3019 g_async_queue_push (watch->messages, rec);
3021 /* FIXME: does the following need to be made thread-safe? (this might be
3022 * called from a streaming thread, like appsink's render function) */
3023 /* make sure the main context will now also check for writability on the
3025 if (!watch->write_added) {
3026 g_source_add_poll ((GSource *) watch, &watch->writefd);
3027 watch->write_added = TRUE;
3034 * gst_rtsp_watch_queue_message:
3035 * @watch: a #GstRTSPWatch
3036 * @message: a #GstRTSPMessage
3038 * Queue a @message for transmission in @watch. The contents of this
3039 * message will be serialized and transmitted when the connection of the
3040 * @watch becomes writable.
3042 * The return value of this function will be used as the id argument in the
3043 * message_sent callback.
3050 gst_rtsp_watch_queue_message (GstRTSPWatch * watch, GstRTSPMessage * message)
3055 g_return_val_if_fail (watch != NULL, GST_RTSP_EINVAL);
3056 g_return_val_if_fail (message != NULL, GST_RTSP_EINVAL);
3058 /* make a record with the message as a string and id */
3059 str = message_to_string (watch->conn, message);
3061 return gst_rtsp_watch_queue_data (watch,
3062 (guint8 *) g_string_free (str, FALSE), size);