1 /*****************************************************************************
2 * rtsp.c: RTSP support for RTP stream output module
3 *****************************************************************************
4 * Copyright (C) 2003-2007 the VideoLAN team
5 * $Id: rtp.c 21407 2007-08-22 20:10:41Z courmisch $
7 * Authors: Laurent Aimar <fenrir@via.ecp.fr>
9 * This program is free software; you can redistribute it and/or modify
10 * it under the terms of the GNU General Public License as published by
11 * the Free Software Foundation; either version 2 of the License, or
12 * (at your option) any later version.
14 * This program is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 * GNU General Public License for more details.
19 * You should have received a copy of the GNU General Public License
20 * along with this program; if not, write to the Free Software
21 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
22 *****************************************************************************/
24 /*****************************************************************************
26 *****************************************************************************/
30 #include <vlc_httpd.h>
32 #include <vlc_network.h>
37 typedef struct rtsp_session_t rtsp_session_t;
49 rtsp_session_t **sessionv;
53 static int RtspCallback( httpd_callback_sys_t *p_args,
55 httpd_message_t *answer, httpd_message_t *query );
56 static int RtspCallbackId( httpd_callback_sys_t *p_args,
58 httpd_message_t *answer, httpd_message_t *query );
59 static void RtspClientDel( rtsp_stream_t *rtsp, rtsp_session_t *session );
61 rtsp_stream_t *RtspSetup( sout_stream_t *p_stream, const vlc_url_t *url )
63 rtsp_stream_t *rtsp = malloc( sizeof( *rtsp ) );
68 rtsp->owner = p_stream;
70 rtsp->sessionv = NULL;
71 vlc_mutex_init( p_stream, &rtsp->lock );
73 msg_Dbg( p_stream, "rtsp setup: %s : %d / %s\n",
74 url->psz_host, url->i_port, url->psz_path );
76 rtsp->psz_path = strdup( url->psz_path ? url->psz_path : "/" );
77 if( rtsp->psz_path == NULL )
80 if( asprintf( &rtsp->psz_control, "rtsp://%s:%d%s",
81 url->psz_host, url->i_port > 0 ? url->i_port : 554,
82 rtsp->psz_path ) == -1 )
84 rtsp->psz_control = NULL;
88 rtsp->host = httpd_HostNew( VLC_OBJECT(p_stream), url->psz_host,
89 url->i_port > 0 ? url->i_port : 554 );
90 if( rtsp->host == NULL )
93 rtsp->url = httpd_UrlNewUnique( rtsp->host, rtsp->psz_path, NULL, NULL,
95 if( rtsp->url == NULL )
98 httpd_UrlCatch( rtsp->url, HTTPD_MSG_DESCRIBE, RtspCallback, (void*)rtsp );
99 httpd_UrlCatch( rtsp->url, HTTPD_MSG_SETUP, RtspCallback, (void*)rtsp );
100 httpd_UrlCatch( rtsp->url, HTTPD_MSG_PLAY, RtspCallback, (void*)rtsp );
101 httpd_UrlCatch( rtsp->url, HTTPD_MSG_PAUSE, RtspCallback, (void*)rtsp );
102 httpd_UrlCatch( rtsp->url, HTTPD_MSG_TEARDOWN, RtspCallback, (void*)rtsp );
111 void RtspUnsetup( rtsp_stream_t *rtsp )
113 while( rtsp->sessionc > 0 )
114 RtspClientDel( rtsp, rtsp->sessionv[0] );
117 httpd_UrlDelete( rtsp->url );
120 httpd_HostDelete( rtsp->host );
122 vlc_mutex_destroy( &rtsp->lock );
126 struct rtsp_stream_id_t
128 rtsp_stream_t *stream;
129 sout_stream_id_t *sout_id;
133 unsigned loport, hiport;
137 typedef struct rtsp_strack_t rtsp_strack_t;
139 /* For unicast streaming */
140 struct rtsp_session_t
142 rtsp_stream_t *stream;
144 /* output (id-access) */
146 rtsp_strack_t *trackv;
152 /* Unicast session track */
155 sout_stream_id_t *id;
156 sout_access_out_t *access;
161 rtsp_stream_id_t *RtspAddId( rtsp_stream_t *rtsp, sout_stream_id_t *sid,
163 /* Multicast stuff - TODO: cleanup */
164 const char *dst, int ttl,
165 unsigned loport, unsigned hiport )
167 char urlbuf[strlen( rtsp->psz_control ) + 1 + 10];
168 rtsp_stream_id_t *id = malloc( sizeof( *id ) );
176 /* TODO: can we assume that this need not be strdup'd? */
178 if( id->dst != NULL )
185 sprintf( urlbuf, "%s/trackID=%d", rtsp->psz_path, num );
186 msg_Dbg( rtsp->owner, "RTSP: adding %s\n", urlbuf );
187 url = id->url = httpd_UrlNewUnique( rtsp->host, urlbuf, NULL, NULL, NULL );
195 httpd_UrlCatch( url, HTTPD_MSG_DESCRIBE, RtspCallbackId, (void *)id );
196 httpd_UrlCatch( url, HTTPD_MSG_SETUP, RtspCallbackId, (void *)id );
197 httpd_UrlCatch( url, HTTPD_MSG_PLAY, RtspCallbackId, (void *)id );
198 httpd_UrlCatch( url, HTTPD_MSG_PAUSE, RtspCallbackId, (void *)id );
199 httpd_UrlCatch( url, HTTPD_MSG_TEARDOWN, RtspCallbackId, (void *)id );
205 void RtspDelId( rtsp_stream_t *rtsp, rtsp_stream_id_t *id )
207 vlc_mutex_lock( &rtsp->lock );
208 for( int i = 0; i < rtsp->sessionc; i++ )
210 rtsp_session_t *ses = rtsp->sessionv[i];
212 for( int j = 0; j < ses->trackc; j++ )
214 if( ses->trackv[j].id == id->sout_id )
216 rtsp_strack_t *tr = ses->trackv + j;
217 sout_AccessOutDelete( tr->access );
218 REMOVE_ELEM( ses->trackv, ses->trackc, j );
219 /* FIXME: are we supposed to notify the client? */
224 vlc_mutex_unlock( &rtsp->lock );
225 httpd_UrlDelete( id->url );
230 /** rtsp must be locked */
232 rtsp_session_t *RtspClientNew( rtsp_stream_t *rtsp, const char *name )
234 rtsp_session_t *s = malloc( sizeof( *s ) + strlen( name ) + 1 );
239 strcpy( s->name, name );
241 TAB_APPEND( rtsp->sessionc, rtsp->sessionv, s );
247 /** rtsp must be locked */
249 rtsp_session_t *RtspClientGet( rtsp_stream_t *rtsp, const char *name )
256 /* FIXME: use a hash/dictionary */
257 for( i = 0; i < rtsp->sessionc; i++ )
259 if( !strcmp( rtsp->sessionv[i]->name, name ) )
260 return rtsp->sessionv[i];
266 /** rtsp must be locked */
268 void RtspClientDel( rtsp_stream_t *rtsp, rtsp_session_t *session )
271 TAB_REMOVE( rtsp->sessionc, rtsp->sessionv, session );
273 for( i = 0; i < session->trackc; i++ )
275 rtp_del_sink( session->trackv[i].id, session->trackv[i].access );
276 sout_AccessOutDelete( session->trackv[i].access );
279 free( session->trackv );
284 /** Aggregate RTSP callback */
285 static int RtspCallback( httpd_callback_sys_t *p_args,
287 httpd_message_t *answer, httpd_message_t *query )
289 rtsp_stream_t *rtsp = (rtsp_stream_t *)p_args;
290 const char *psz_session = NULL, *psz;
292 if( answer == NULL || query == NULL )
296 //fprintf( stderr, "RtspCallback query: type=%d\n", query->i_type );
298 answer->i_proto = HTTPD_PROTO_RTSP;
299 answer->i_version= query->i_version;
300 answer->i_type = HTTPD_MSG_ANSWER;
302 answer->p_body = NULL;
304 if( httpd_MsgGet( query, "Require" ) != NULL )
306 answer->i_status = 551;
307 httpd_MsgAdd( query, "Unsupported", "%s",
308 httpd_MsgGet( query, "Require" ) );
311 switch( query->i_type )
313 case HTTPD_MSG_DESCRIBE:
315 char *psz_sdp = SDPGenerate( rtsp->owner, rtsp->psz_control );
317 answer->i_status = 200;
318 httpd_MsgAdd( answer, "Content-Type", "%s", "application/sdp" );
319 httpd_MsgAdd( answer, "Content-Base", "%s", rtsp->psz_control );
320 answer->p_body = (uint8_t *)psz_sdp;
321 answer->i_body = strlen( psz_sdp );
325 case HTTPD_MSG_SETUP:
326 answer->i_status = 459;
332 answer->i_status = 200;
334 psz_session = httpd_MsgGet( query, "Session" );
335 if( httpd_MsgGet( query, "Range" ) != NULL )
337 answer->i_status = 456; /* cannot seek */
341 vlc_mutex_lock( &rtsp->lock );
342 ses = RtspClientGet( rtsp, psz_session );
345 for( int i = 0; i < ses->trackc; i++ )
347 rtsp_strack_t *tr = ses->trackv + i;
350 tr->playing = VLC_TRUE;
351 rtp_add_sink( tr->id, tr->access );
355 vlc_mutex_unlock( &rtsp->lock );
357 if( httpd_MsgGet( query, "Scale" ) != NULL )
358 httpd_MsgAdd( answer, "Scale", "1." );
362 case HTTPD_MSG_PAUSE:
363 answer->i_status = 405;
364 httpd_MsgAdd( answer, "Allow", "DESCRIBE, PLAY, TEARDOWN" );
367 case HTTPD_MSG_TEARDOWN:
371 /* for now only multicast so easy again */
372 answer->i_status = 200;
374 psz_session = httpd_MsgGet( query, "Session" );
376 vlc_mutex_lock( &rtsp->lock );
377 ses = RtspClientGet( rtsp, psz_session );
379 RtspClientDel( rtsp, ses );
380 vlc_mutex_unlock( &rtsp->lock );
388 httpd_MsgAdd( answer, "Server", "%s", PACKAGE_STRING );
389 httpd_MsgAdd( answer, "Content-Length", "%d", answer->i_body );
391 psz = httpd_MsgGet( query, "Cseq" );
393 httpd_MsgAdd( answer, "Cseq", "%s", psz );
394 psz = httpd_MsgGet( query, "Timestamp" );
396 httpd_MsgAdd( answer, "Timestamp", "%s", psz );
398 httpd_MsgAdd( answer, "Cache-Control", "%s", "no-cache" );
401 httpd_MsgAdd( answer, "Session", "%s;timeout=5", psz_session );
406 /** Finds the next transport choice */
407 static inline const char *transport_next( const char *str )
409 /* Looks for comma */
410 str = strchr( str, ',' );
412 return NULL; /* No more transport options */
414 str++; /* skips comma */
415 while( strchr( "\r\n\t ", *str ) )
418 return (*str) ? str : NULL;
422 /** Finds the next transport parameter */
423 static inline const char *parameter_next( const char *str )
425 while( strchr( ",;", *str ) == NULL )
428 return (*str == ';') ? (str + 1) : NULL;
432 /** Non-aggregate RTSP callback */
433 static int RtspCallbackId( httpd_callback_sys_t *p_args,
435 httpd_message_t *answer, httpd_message_t *query )
437 rtsp_stream_id_t *id = (rtsp_stream_id_t *)p_args;
438 rtsp_stream_t *rtsp = id->stream;
439 sout_stream_t *p_stream = id->stream->owner;
440 char psz_session_init[21];
441 const char *psz_session, *psz;
443 if( answer == NULL || query == NULL )
445 //fprintf( stderr, "RtspCallback query: type=%d\n", query->i_type );
448 answer->i_proto = HTTPD_PROTO_RTSP;
449 answer->i_version= query->i_version;
450 answer->i_type = HTTPD_MSG_ANSWER;
452 answer->p_body = NULL;
454 /* Create new session ID if needed */
455 psz_session = httpd_MsgGet( query, "Session" );
456 if( psz_session == NULL )
458 /* FIXME: should be somewhat secure randomness */
459 snprintf( psz_session_init, sizeof(psz_session_init), I64Fu,
460 NTPtime64() + rand() );
463 if( httpd_MsgGet( query, "Require" ) != NULL )
465 answer->i_status = 551;
466 httpd_MsgAdd( query, "Unsupported", "%s",
467 httpd_MsgGet( query, "Require" ) );
470 switch( query->i_type )
472 case HTTPD_MSG_SETUP:
474 answer->i_status = 461;
476 for( const char *tpt = httpd_MsgGet( query, "Transport" );
478 tpt = transport_next( tpt ) )
480 vlc_bool_t b_multicast = VLC_TRUE, b_unsupp = VLC_FALSE;
481 unsigned loport = 5004, hiport = 5005; /* from RFC3551 */
483 /* Check transport protocol. */
484 /* Currently, we only support RTP/AVP over UDP */
485 if( strncmp( tpt, "RTP/AVP", 7 ) )
488 if( strncmp( tpt, "/UDP", 4 ) == 0 )
490 if( strchr( ";,", *tpt ) == NULL )
493 /* Parse transport options */
494 for( const char *opt = parameter_next( tpt );
496 opt = parameter_next( opt ) )
498 if( strncmp( opt, "multicast", 9 ) == 0)
499 b_multicast = VLC_TRUE;
501 if( strncmp( opt, "unicast", 7 ) == 0 )
502 b_multicast = VLC_FALSE;
504 if( sscanf( opt, "client_port=%u-%u", &loport, &hiport ) == 2 )
507 if( strncmp( opt, "mode=", 5 ) == 0 )
509 if( strncasecmp( opt + 5, "play", 4 )
510 && strncasecmp( opt + 5, "\"PLAY\"", 6 ) )
520 * Every other option is unsupported:
522 * "source" and "append" are invalid.
524 * For multicast, "port", "layers", "ttl" are set by the
525 * stream output configuration.
527 * For unicast, we do not allow "destination" as it
528 * carries a DoS risk, and we decide on "server_port".
530 * "interleaved" and "ssrc" are not implemented.
542 const char *dst = id->dst;
546 answer->i_status = 200;
548 httpd_MsgAdd( answer, "Transport",
549 "RTP/AVP/UDP;destination=%s;port=%u-%u;"
551 dst, id->loport, id->hiport,
552 ( id->ttl > 0 ) ? id->ttl : 1 );
556 char ip[NI_MAXNUMERICHOST], url[NI_MAXNUMERICHOST + 8];
557 static const char access[] = "udp{raw,rtcp}";
558 rtsp_session_t *ses = NULL;
559 rtsp_strack_t track = { id->sout_id, NULL, VLC_FALSE };
561 if( httpd_ClientIP( cl, ip ) == NULL )
563 answer->i_status = 500;
567 snprintf( url, sizeof( url ),
568 ( strchr( ip, ':' ) != NULL ) ? "[%s]:%d" : "%s:%d",
571 track.access = sout_AccessOutNew( p_stream->p_sout,
573 if( track.access == NULL )
576 "cannot create access output for %s://%s",
578 answer->i_status = 500;
582 char *src = var_GetNonEmptyString( track.access, "src-addr" );
583 int sport = var_GetInteger( track.access, "src-port" );
585 vlc_mutex_lock( &rtsp->lock );
586 if( psz_session == NULL )
588 psz_session = psz_session_init;
589 ses = RtspClientNew( rtsp, psz_session );
593 /* FIXME: we probably need to remove an access out,
594 * if there is already one for the same ID */
595 ses = RtspClientGet( rtsp, psz_session );
598 answer->i_status = 454;
599 vlc_mutex_unlock( &rtsp->lock );
604 INSERT_ELEM( ses->trackv, ses->trackc, ses->trackc, track );
605 vlc_mutex_unlock( &rtsp->lock );
607 httpd_ServerIP( cl, ip );
609 if( ( src != NULL ) && strcmp( src, ip ) )
611 /* Specify source IP if it is different from the RTSP
612 * control connection server address */
613 char *ptr = strchr( src, '%' );
614 if( ptr != NULL ) *ptr = '\0'; /* remove scope ID */
616 httpd_MsgAdd( answer, "Transport",
617 "RTP/AVP/UDP;unicast;source=%s;"
618 "client_port=%u-%u;server_port=%u-%u;"
620 src, loport, loport + 1, sport, sport + 1 );
624 httpd_MsgAdd( answer, "Transport",
625 "RTP/AVP/UDP;unicast;"
626 "client_port=%u-%u;server_port=%u-%u;"
628 loport, loport + 1, sport, sport + 1 );
631 answer->i_status = 200;
642 answer->i_status = 200;
644 psz_session = httpd_MsgGet( query, "Session" );
645 if( httpd_MsgGet( query, "Range" ) != NULL )
647 answer->i_status = 456; /* cannot seek */
651 vlc_mutex_lock( &rtsp->lock );
652 ses = RtspClientGet( rtsp, psz_session );
655 for( int i = 0; i < ses->trackc; i++ )
657 rtsp_strack_t *tr = ses->trackv + i;
658 if( !tr->playing && ( tr->id == id->sout_id ) )
660 tr->playing = VLC_TRUE;
661 rtp_add_sink( tr->id, tr->access );
665 vlc_mutex_unlock( &rtsp->lock );
667 if( httpd_MsgGet( query, "Scale" ) != NULL )
668 httpd_MsgAdd( answer, "Scale", "1." );
672 case HTTPD_MSG_PAUSE:
673 answer->i_status = 405;
674 httpd_MsgAdd( answer, "Allow", "SETUP, PLAY, TEARDOWN" );
677 case HTTPD_MSG_TEARDOWN:
681 answer->i_status = 200;
683 psz_session = httpd_MsgGet( query, "Session" );
685 vlc_mutex_lock( &rtsp->lock );
686 ses = RtspClientGet( rtsp, psz_session );
689 for( int i = 0; i < ses->trackc; i++ )
691 if( ses->trackv[i].id == id->sout_id )
693 rtp_del_sink( id->sout_id, ses->trackv[i].access );
694 sout_AccessOutDelete( ses->trackv[i].access );
695 REMOVE_ELEM( ses->trackv, ses->trackc, i );
699 vlc_mutex_unlock( &rtsp->lock );
704 answer->i_status = 460;
708 psz = httpd_MsgGet( query, "Cseq" );
710 httpd_MsgAdd( answer, "Cseq", "%s", psz );
711 psz = httpd_MsgGet( query, "Timestamp" );
713 httpd_MsgAdd( answer, "Timestamp", "%s", psz );
714 httpd_MsgAdd( answer, "Server", "%s", PACKAGE_STRING );
715 httpd_MsgAdd( answer, "Content-Length", "%d", answer->i_body );
716 httpd_MsgAdd( answer, "Cache-Control", "%s", "no-cache" );
719 httpd_MsgAdd( answer, "Session", "%s"/*;timeout=5*/, psz_session );