1 /*****************************************************************************
2 * rtsp.c: RTSP support for RTP stream output module
3 *****************************************************************************
4 * Copyright (C) 2003-2004 the VideoLAN team
5 * Copyright © 2007 Rémi Denis-Courmont
9 * Authors: Laurent Aimar <fenrir@via.ecp.fr>
11 * This program is free software; you can redistribute it and/or modify
12 * it under the terms of the GNU General Public License as published by
13 * the Free Software Foundation; either version 2 of the License, or
14 * (at your option) any later version.
16 * This program is distributed in the hope that it will be useful,
17 * but WITHOUT ANY WARRANTY; without even the implied warranty of
18 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 * GNU General Public License for more details.
21 * You should have received a copy of the GNU General Public License
22 * along with this program; if not, write to the Free Software
23 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
24 *****************************************************************************/
26 /*****************************************************************************
28 *****************************************************************************/
33 #include <vlc_common.h>
36 #include <vlc_httpd.h>
38 #include <vlc_network.h>
46 typedef struct rtsp_session_t rtsp_session_t;
55 const char *track_fmt;
59 rtsp_session_t **sessionv;
63 static int RtspCallback( httpd_callback_sys_t *p_args,
64 httpd_client_t *cl, httpd_message_t *answer,
65 const httpd_message_t *query );
66 static int RtspCallbackId( httpd_callback_sys_t *p_args,
67 httpd_client_t *cl, httpd_message_t *answer,
68 const httpd_message_t *query );
69 static void RtspClientDel( rtsp_stream_t *rtsp, rtsp_session_t *session );
71 rtsp_stream_t *RtspSetup( sout_stream_t *p_stream, const vlc_url_t *url )
73 rtsp_stream_t *rtsp = malloc( sizeof( *rtsp ) );
75 if( rtsp == NULL || ( url->i_port > 99999 ) )
81 rtsp->owner = p_stream;
83 rtsp->sessionv = NULL;
86 rtsp->psz_path = NULL;
87 vlc_mutex_init( &rtsp->lock );
89 rtsp->port = (url->i_port > 0) ? url->i_port : 554;
90 rtsp->psz_path = strdup( ( url->psz_path != NULL ) ? url->psz_path : "/" );
91 if( rtsp->psz_path == NULL )
94 assert( strlen( rtsp->psz_path ) > 0 );
95 if( rtsp->psz_path[strlen( rtsp->psz_path ) - 1] == '/' )
96 rtsp->track_fmt = "%strackID=%u";
98 rtsp->track_fmt = "%s/trackID=%u";
100 msg_Dbg( p_stream, "RTSP stream: host %s port %d at %s",
101 url->psz_host, rtsp->port, rtsp->psz_path );
103 rtsp->host = httpd_HostNew( VLC_OBJECT(p_stream), url->psz_host,
105 if( rtsp->host == NULL )
108 rtsp->url = httpd_UrlNewUnique( rtsp->host, rtsp->psz_path,
110 if( rtsp->url == NULL )
113 httpd_UrlCatch( rtsp->url, HTTPD_MSG_DESCRIBE, RtspCallback, (void*)rtsp );
114 httpd_UrlCatch( rtsp->url, HTTPD_MSG_SETUP, RtspCallback, (void*)rtsp );
115 httpd_UrlCatch( rtsp->url, HTTPD_MSG_PLAY, RtspCallback, (void*)rtsp );
116 httpd_UrlCatch( rtsp->url, HTTPD_MSG_PAUSE, RtspCallback, (void*)rtsp );
117 httpd_UrlCatch( rtsp->url, HTTPD_MSG_GETPARAMETER, RtspCallback,
119 httpd_UrlCatch( rtsp->url, HTTPD_MSG_TEARDOWN, RtspCallback, (void*)rtsp );
128 void RtspUnsetup( rtsp_stream_t *rtsp )
130 while( rtsp->sessionc > 0 )
131 RtspClientDel( rtsp, rtsp->sessionv[0] );
134 httpd_UrlDelete( rtsp->url );
137 httpd_HostDelete( rtsp->host );
139 free( rtsp->psz_path );
140 vlc_mutex_destroy( &rtsp->lock );
146 struct rtsp_stream_id_t
148 rtsp_stream_t *stream;
149 sout_stream_id_t *sout_id;
154 uint16_t loport, hiport;
158 typedef struct rtsp_strack_t rtsp_strack_t;
160 /* For unicast streaming */
161 struct rtsp_session_t
163 rtsp_stream_t *stream;
166 /* output (id-access) */
168 rtsp_strack_t *trackv;
172 /* Unicast session track */
175 sout_stream_id_t *id;
181 rtsp_stream_id_t *RtspAddId( rtsp_stream_t *rtsp, sout_stream_id_t *sid,
182 unsigned num, uint32_t ssrc,
183 /* Multicast stuff - TODO: cleanup */
184 const char *dst, int ttl,
185 unsigned loport, unsigned hiport )
187 char urlbuf[sizeof( "/trackID=123" ) + strlen( rtsp->psz_path )];
188 rtsp_stream_id_t *id = malloc( sizeof( *id ) );
197 /* TODO: can we assume that this need not be strdup'd? */
199 if( id->dst != NULL )
206 /* FIXME: num screws up if any ES has been removed and re-added */
207 snprintf( urlbuf, sizeof( urlbuf ), rtsp->track_fmt, rtsp->psz_path,
209 msg_Dbg( rtsp->owner, "RTSP: adding %s", urlbuf );
210 url = id->url = httpd_UrlNewUnique( rtsp->host, urlbuf, NULL, NULL, NULL );
218 httpd_UrlCatch( url, HTTPD_MSG_DESCRIBE, RtspCallbackId, (void *)id );
219 httpd_UrlCatch( url, HTTPD_MSG_SETUP, RtspCallbackId, (void *)id );
220 httpd_UrlCatch( url, HTTPD_MSG_PLAY, RtspCallbackId, (void *)id );
221 httpd_UrlCatch( url, HTTPD_MSG_PAUSE, RtspCallbackId, (void *)id );
222 httpd_UrlCatch( url, HTTPD_MSG_GETPARAMETER, RtspCallbackId, (void *)id );
223 httpd_UrlCatch( url, HTTPD_MSG_TEARDOWN, RtspCallbackId, (void *)id );
229 void RtspDelId( rtsp_stream_t *rtsp, rtsp_stream_id_t *id )
231 vlc_mutex_lock( &rtsp->lock );
232 for( int i = 0; i < rtsp->sessionc; i++ )
234 rtsp_session_t *ses = rtsp->sessionv[i];
236 for( int j = 0; j < ses->trackc; j++ )
238 if( ses->trackv[j].id == id->sout_id )
240 rtsp_strack_t *tr = ses->trackv + j;
242 REMOVE_ELEM( ses->trackv, ses->trackc, j );
247 vlc_mutex_unlock( &rtsp->lock );
248 httpd_UrlDelete( id->url );
253 /** rtsp must be locked */
255 rtsp_session_t *RtspClientNew( rtsp_stream_t *rtsp )
257 rtsp_session_t *s = malloc( sizeof( *s ) );
262 vlc_rand_bytes (&s->id, sizeof (s->id));
266 TAB_APPEND( rtsp->sessionc, rtsp->sessionv, s );
272 /** rtsp must be locked */
274 rtsp_session_t *RtspClientGet( rtsp_stream_t *rtsp, const char *name )
284 id = strtoull( name, &end, 0x10 );
288 /* FIXME: use a hash/dictionary */
289 for( i = 0; i < rtsp->sessionc; i++ )
291 if( rtsp->sessionv[i]->id == id )
292 return rtsp->sessionv[i];
298 /** rtsp must be locked */
300 void RtspClientDel( rtsp_stream_t *rtsp, rtsp_session_t *session )
303 TAB_REMOVE( rtsp->sessionc, rtsp->sessionv, session );
305 for( i = 0; i < session->trackc; i++ )
306 rtp_del_sink( session->trackv[i].id, session->trackv[i].fd );
308 free( session->trackv );
313 /** Finds the next transport choice */
314 static inline const char *transport_next( const char *str )
316 /* Looks for comma */
317 str = strchr( str, ',' );
319 return NULL; /* No more transport options */
321 str++; /* skips comma */
322 while( strchr( "\r\n\t ", *str ) )
325 return (*str) ? str : NULL;
329 /** Finds the next transport parameter */
330 static inline const char *parameter_next( const char *str )
332 while( strchr( ",;", *str ) == NULL )
335 return (*str == ';') ? (str + 1) : NULL;
339 /** RTSP requests handler
340 * @param id selected track for non-aggregate URLs,
341 * NULL for aggregate URLs
343 static int RtspHandler( rtsp_stream_t *rtsp, rtsp_stream_id_t *id,
345 httpd_message_t *answer,
346 const httpd_message_t *query )
348 sout_stream_t *p_stream = rtsp->owner;
350 const char *psz_session = NULL, *psz;
351 char control[sizeof("rtsp://[]:12345") + NI_MAXNUMERICHOST
352 + strlen( rtsp->psz_path )];
357 if( answer == NULL || query == NULL || cl == NULL )
361 /* Build self-referential control URL */
362 char ip[NI_MAXNUMERICHOST], *ptr;
364 httpd_ServerIP( cl, ip );
365 ptr = strchr( ip, '%' );
369 if( strchr( ip, ':' ) != NULL )
370 sprintf( control, "rtsp://[%s]:%u%s", ip, rtsp->port,
373 sprintf( control, "rtsp://%s:%u%s", ip, rtsp->port,
378 answer->i_proto = HTTPD_PROTO_RTSP;
379 answer->i_version= 0;
380 answer->i_type = HTTPD_MSG_ANSWER;
382 answer->p_body = NULL;
384 httpd_MsgAdd( answer, "Server", "%s", PACKAGE_STRING );
386 /* Date: is always allowed, and sometimes mandatory with RTSP/2.0. */
388 if (gmtime_r (&now, &ut) != NULL)
389 { /* RFC1123 format, GMT is mandatory */
390 static const char wdays[7][4] = {
391 "Sun", "Mon", "Tue", "Wed", "Thu", "Fri", "Sat" };
392 static const char mons[12][4] = {
393 "Jan", "Feb", "Mar", "Apr", "May", "Jun",
394 "Jul", "Aug", "Sep", "Oct", "Nov", "Dec" };
395 httpd_MsgAdd (answer, "Date", "%s, %02u %s %04u %02u:%02u:%02u GMT",
396 wdays[ut.tm_wday], ut.tm_mday, mons[ut.tm_mon],
397 1900 + ut.tm_year, ut.tm_hour, ut.tm_min, ut.tm_sec);
400 if( query->i_proto != HTTPD_PROTO_RTSP )
402 answer->i_status = 505;
405 if( httpd_MsgGet( query, "Require" ) != NULL )
407 answer->i_status = 551;
408 httpd_MsgAdd( answer, "Unsupported", "%s",
409 httpd_MsgGet( query, "Require" ) );
412 switch( query->i_type )
414 case HTTPD_MSG_DESCRIBE:
415 { /* Aggregate-only */
418 answer->i_status = 460;
422 answer->i_status = 200;
423 httpd_MsgAdd( answer, "Content-Type", "%s", "application/sdp" );
424 httpd_MsgAdd( answer, "Content-Base", "%s", control );
425 answer->p_body = (uint8_t *)SDPGenerate( rtsp->owner, control );
426 if( answer->p_body != NULL )
427 answer->i_body = strlen( (char *)answer->p_body );
429 answer->i_status = 500;
433 case HTTPD_MSG_SETUP:
434 /* Non-aggregate-only */
437 answer->i_status = 459;
441 psz_session = httpd_MsgGet( query, "Session" );
442 answer->i_status = 461;
444 for( const char *tpt = httpd_MsgGet( query, "Transport" );
446 tpt = transport_next( tpt ) )
448 bool b_multicast = true, b_unsupp = false;
449 unsigned loport = 5004, hiport = 5005; /* from RFC3551 */
451 /* Check transport protocol. */
452 /* Currently, we only support RTP/AVP over UDP */
453 if( strncmp( tpt, "RTP/AVP", 7 ) )
456 if( strncmp( tpt, "/UDP", 4 ) == 0 )
458 if( strchr( ";,", *tpt ) == NULL )
461 /* Parse transport options */
462 for( const char *opt = parameter_next( tpt );
464 opt = parameter_next( opt ) )
466 if( strncmp( opt, "multicast", 9 ) == 0)
469 if( strncmp( opt, "unicast", 7 ) == 0 )
472 if( sscanf( opt, "client_port=%u-%u", &loport, &hiport )
476 if( strncmp( opt, "mode=", 5 ) == 0 )
478 if( strncasecmp( opt + 5, "play", 4 )
479 && strncasecmp( opt + 5, "\"PLAY\"", 6 ) )
487 if( strncmp( opt,"destination=", 12 ) == 0 )
489 answer->i_status = 403;
495 * Every other option is unsupported:
497 * "source" and "append" are invalid (server-only);
498 * "ssrc" also (as clarified per RFC2326bis).
500 * For multicast, "port", "layers", "ttl" are set by the
501 * stream output configuration.
503 * For unicast, we want to decide "server_port" values.
505 * "interleaved" is not implemented.
517 const char *dst = id->dst;
521 if( psz_session == NULL )
523 /* Create a dummy session ID */
524 snprintf( psz_sesbuf, sizeof( psz_sesbuf ), "%d",
526 psz_session = psz_sesbuf;
528 answer->i_status = 200;
530 httpd_MsgAdd( answer, "Transport",
531 "RTP/AVP/UDP;destination=%s;port=%u-%u;"
533 dst, id->loport, id->hiport,
534 ( id->ttl > 0 ) ? id->ttl : 1 );
538 char ip[NI_MAXNUMERICHOST], src[NI_MAXNUMERICHOST];
539 rtsp_session_t *ses = NULL;
540 rtsp_strack_t track = { id->sout_id, -1, false };
543 if( httpd_ClientIP( cl, ip ) == NULL )
545 answer->i_status = 500;
549 track.fd = net_ConnectDgram( p_stream, ip, loport, -1,
554 "cannot create RTP socket for %s port %u",
556 answer->i_status = 500;
560 net_GetSockAddress( track.fd, src, &sport );
562 vlc_mutex_lock( &rtsp->lock );
563 if( psz_session == NULL )
565 ses = RtspClientNew( rtsp );
566 snprintf( psz_sesbuf, sizeof( psz_sesbuf ), "%"PRIx64,
568 psz_session = psz_sesbuf;
572 /* FIXME: we probably need to remove an access out,
573 * if there is already one for the same ID */
574 ses = RtspClientGet( rtsp, psz_session );
577 answer->i_status = 454;
578 vlc_mutex_unlock( &rtsp->lock );
583 INSERT_ELEM( ses->trackv, ses->trackc, ses->trackc,
585 vlc_mutex_unlock( &rtsp->lock );
587 httpd_ServerIP( cl, ip );
589 if( strcmp( src, ip ) )
591 /* Specify source IP if it is different from the RTSP
592 * control connection server address */
593 char *ptr = strchr( src, '%' );
594 if( ptr != NULL ) *ptr = '\0'; /* remove scope ID */
596 httpd_MsgAdd( answer, "Transport",
597 "RTP/AVP/UDP;unicast;source=%s;"
598 "client_port=%u-%u;server_port=%u-%u;"
599 "ssrc=%08X;mode=play",
600 src, loport, loport + 1, sport,
601 sport + 1, id->ssrc );
605 httpd_MsgAdd( answer, "Transport",
606 "RTP/AVP/UDP;unicast;"
607 "client_port=%u-%u;server_port=%u-%u;"
608 "ssrc=%08X;mode=play",
609 loport, loport + 1, sport, sport + 1,
613 answer->i_status = 200;
622 answer->i_status = 200;
624 psz_session = httpd_MsgGet( query, "Session" );
625 const char *range = httpd_MsgGet (query, "Range");
626 if (range && strncmp (range, "npt=", 4))
628 answer->i_status = 501;
632 vlc_mutex_lock( &rtsp->lock );
633 ses = RtspClientGet( rtsp, psz_session );
636 /* FIXME: we really need to limit the number of tracks... */
637 char info[ses->trackc * ( strlen( control )
638 + sizeof("url=/trackID=123;seq=65535, ") ) + 1];
641 for( int i = 0; i < ses->trackc; i++ )
643 rtsp_strack_t *tr = ses->trackv + i;
644 if( ( id == NULL ) || ( tr->id == id->sout_id ) )
649 rtp_add_sink( tr->id, tr->fd, false );
651 infolen += sprintf( info + infolen,
652 "url=%s/trackID=%u;seq=%u, ",
654 rtp_get_num( tr->id ),
655 rtp_get_seq( tr->id ) );
660 info[infolen - 2] = '\0'; /* remove trailing ", " */
661 httpd_MsgAdd( answer, "RTP-Info", "%s", info );
664 vlc_mutex_unlock( &rtsp->lock );
666 if( httpd_MsgGet( query, "Scale" ) != NULL )
667 httpd_MsgAdd( answer, "Scale", "1." );
671 case HTTPD_MSG_PAUSE:
672 answer->i_status = 405;
673 httpd_MsgAdd( answer, "Allow",
674 "%s, TEARDOWN, PLAY, GET_PARAMETER",
675 ( id != NULL ) ? "SETUP" : "DESCRIBE" );
678 case HTTPD_MSG_GETPARAMETER:
679 if( query->i_body > 0 )
681 answer->i_status = 451;
685 psz_session = httpd_MsgGet( query, "Session" );
686 answer->i_status = 200;
689 case HTTPD_MSG_TEARDOWN:
693 answer->i_status = 200;
695 psz_session = httpd_MsgGet( query, "Session" );
697 vlc_mutex_lock( &rtsp->lock );
698 ses = RtspClientGet( rtsp, psz_session );
701 if( id == NULL ) /* Delete the entire session */
702 RtspClientDel( rtsp, ses );
703 else /* Delete one track from the session */
704 for( int i = 0; i < ses->trackc; i++ )
706 if( ses->trackv[i].id == id->sout_id )
708 rtp_del_sink( id->sout_id, ses->trackv[i].fd );
709 REMOVE_ELEM( ses->trackv, ses->trackc, i );
713 vlc_mutex_unlock( &rtsp->lock );
722 httpd_MsgAdd( answer, "Session", "%s"/*;timeout=5*/, psz_session );
724 httpd_MsgAdd( answer, "Content-Length", "%d", answer->i_body );
725 httpd_MsgAdd( answer, "Cache-Control", "no-cache" );
727 psz = httpd_MsgGet( query, "Cseq" );
729 httpd_MsgAdd( answer, "Cseq", "%s", psz );
730 psz = httpd_MsgGet( query, "Timestamp" );
732 httpd_MsgAdd( answer, "Timestamp", "%s", psz );
738 /** Aggregate RTSP callback */
739 static int RtspCallback( httpd_callback_sys_t *p_args,
741 httpd_message_t *answer,
742 const httpd_message_t *query )
744 return RtspHandler( (rtsp_stream_t *)p_args, NULL, cl, answer, query );
748 /** Non-aggregate RTSP callback */
749 static int RtspCallbackId( httpd_callback_sys_t *p_args,
751 httpd_message_t *answer,
752 const httpd_message_t *query )
754 rtsp_stream_id_t *id = (rtsp_stream_id_t *)p_args;
755 return RtspHandler( id->stream, id, cl, answer, query );