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
7 * $Id: rtp.c 21407 2007-08-22 20:10:41Z courmisch $
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 *****************************************************************************/
32 #include <vlc_httpd.h>
34 #include <vlc_network.h>
42 typedef struct rtsp_session_t rtsp_session_t;
54 rtsp_session_t **sessionv;
58 static int RtspCallback( httpd_callback_sys_t *p_args,
59 httpd_client_t *cl, httpd_message_t *answer,
60 const httpd_message_t *query );
61 static int RtspCallbackId( httpd_callback_sys_t *p_args,
62 httpd_client_t *cl, httpd_message_t *answer,
63 const httpd_message_t *query );
64 static void RtspClientDel( rtsp_stream_t *rtsp, rtsp_session_t *session );
66 rtsp_stream_t *RtspSetup( sout_stream_t *p_stream, const vlc_url_t *url )
68 rtsp_stream_t *rtsp = malloc( sizeof( *rtsp ) );
70 if( rtsp == NULL || ( url->i_port > 99999 ) )
73 rtsp->owner = p_stream;
75 rtsp->sessionv = NULL;
76 vlc_mutex_init( p_stream, &rtsp->lock );
78 msg_Dbg( p_stream, "rtsp setup: %s : %d / %s\n",
79 url->psz_host, url->i_port, url->psz_path );
81 rtsp->port = (url->i_port > 0) ? url->i_port : 554;
82 if( url->psz_path != NULL )
83 rtsp->psz_path = strdup( url->psz_path + 1 );
85 rtsp->psz_path = NULL;
87 rtsp->host = httpd_HostNew( VLC_OBJECT(p_stream), url->psz_host,
89 if( rtsp->host == NULL )
92 rtsp->url = httpd_UrlNewUnique( rtsp->host,
93 url->psz_path ? url->psz_path : "/", 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_GETPARAMETER, RtspCallback,
104 httpd_UrlCatch( rtsp->url, HTTPD_MSG_TEARDOWN, RtspCallback, (void*)rtsp );
113 void RtspUnsetup( rtsp_stream_t *rtsp )
115 while( rtsp->sessionc > 0 )
116 RtspClientDel( rtsp, rtsp->sessionv[0] );
119 httpd_UrlDelete( rtsp->url );
122 httpd_HostDelete( rtsp->host );
124 vlc_mutex_destroy( &rtsp->lock );
128 struct rtsp_stream_id_t
130 rtsp_stream_t *stream;
131 sout_stream_id_t *sout_id;
135 unsigned loport, hiport;
139 typedef struct rtsp_strack_t rtsp_strack_t;
141 /* For unicast streaming */
142 struct rtsp_session_t
144 rtsp_stream_t *stream;
147 /* output (id-access) */
149 rtsp_strack_t *trackv;
153 /* Unicast session track */
156 sout_stream_id_t *id;
162 rtsp_stream_id_t *RtspAddId( rtsp_stream_t *rtsp, sout_stream_id_t *sid,
164 /* Multicast stuff - TODO: cleanup */
165 const char *dst, int ttl,
166 unsigned loport, unsigned hiport )
168 char urlbuf[sizeof( "//trackID=123" ) + strlen( rtsp->psz_path )];
169 rtsp_stream_id_t *id = malloc( sizeof( *id ) );
177 /* TODO: can we assume that this need not be strdup'd? */
179 if( id->dst != NULL )
186 snprintf( urlbuf, sizeof( urlbuf ), "/%s/trackID=%u", rtsp->psz_path,
188 msg_Dbg( rtsp->owner, "RTSP: adding %s", urlbuf );
189 url = id->url = httpd_UrlNewUnique( rtsp->host, urlbuf, NULL, NULL, NULL );
197 httpd_UrlCatch( url, HTTPD_MSG_DESCRIBE, RtspCallbackId, (void *)id );
198 httpd_UrlCatch( url, HTTPD_MSG_SETUP, RtspCallbackId, (void *)id );
199 httpd_UrlCatch( url, HTTPD_MSG_PLAY, RtspCallbackId, (void *)id );
200 httpd_UrlCatch( url, HTTPD_MSG_PAUSE, RtspCallbackId, (void *)id );
201 httpd_UrlCatch( url, HTTPD_MSG_GETPARAMETER, RtspCallbackId, (void *)id );
202 httpd_UrlCatch( url, HTTPD_MSG_TEARDOWN, RtspCallbackId, (void *)id );
208 void RtspDelId( rtsp_stream_t *rtsp, rtsp_stream_id_t *id )
210 vlc_mutex_lock( &rtsp->lock );
211 for( int i = 0; i < rtsp->sessionc; i++ )
213 rtsp_session_t *ses = rtsp->sessionv[i];
215 for( int j = 0; j < ses->trackc; j++ )
217 if( ses->trackv[j].id == id->sout_id )
219 rtsp_strack_t *tr = ses->trackv + j;
221 REMOVE_ELEM( ses->trackv, ses->trackc, j );
226 vlc_mutex_unlock( &rtsp->lock );
227 httpd_UrlDelete( id->url );
232 /** rtsp must be locked */
234 rtsp_session_t *RtspClientNew( rtsp_stream_t *rtsp )
236 rtsp_session_t *s = malloc( sizeof( *s ) );
241 vlc_rand_bytes (&s->id, sizeof (s->id));
245 TAB_APPEND( rtsp->sessionc, rtsp->sessionv, s );
251 /** rtsp must be locked */
253 rtsp_session_t *RtspClientGet( rtsp_stream_t *rtsp, const char *name )
263 id = strtoull( name, &end, 0x10 );
267 /* FIXME: use a hash/dictionary */
268 for( i = 0; i < rtsp->sessionc; i++ )
270 if( rtsp->sessionv[i]->id == id )
271 return rtsp->sessionv[i];
277 /** rtsp must be locked */
279 void RtspClientDel( rtsp_stream_t *rtsp, rtsp_session_t *session )
282 TAB_REMOVE( rtsp->sessionc, rtsp->sessionv, session );
284 for( i = 0; i < session->trackc; i++ )
285 rtp_del_sink( session->trackv[i].id, session->trackv[i].fd );
287 free( session->trackv );
292 /** Finds the next transport choice */
293 static inline const char *transport_next( const char *str )
295 /* Looks for comma */
296 str = strchr( str, ',' );
298 return NULL; /* No more transport options */
300 str++; /* skips comma */
301 while( strchr( "\r\n\t ", *str ) )
304 return (*str) ? str : NULL;
308 /** Finds the next transport parameter */
309 static inline const char *parameter_next( const char *str )
311 while( strchr( ",;", *str ) == NULL )
314 return (*str == ';') ? (str + 1) : NULL;
318 /** RTSP requests handler
319 * @param id selected track for non-aggregate URLs,
320 * NULL for aggregate URLs
322 static int RtspHandler( rtsp_stream_t *rtsp, rtsp_stream_id_t *id,
324 httpd_message_t *answer,
325 const httpd_message_t *query )
327 sout_stream_t *p_stream = rtsp->owner;
329 const char *psz_session = NULL, *psz;
331 if( answer == NULL || query == NULL || cl == NULL )
335 answer->i_proto = HTTPD_PROTO_RTSP;
336 answer->i_version= query->i_version;
337 answer->i_type = HTTPD_MSG_ANSWER;
339 answer->p_body = NULL;
341 if( httpd_MsgGet( query, "Require" ) != NULL )
343 answer->i_status = 551;
344 httpd_MsgAdd( answer, "Unsupported", "%s",
345 httpd_MsgGet( query, "Require" ) );
348 switch( query->i_type )
350 case HTTPD_MSG_DESCRIBE:
351 { /* Aggregate-only */
354 answer->i_status = 460;
358 char ip[NI_MAXNUMERICHOST], *ptr;
359 char control[sizeof("rtsp://[]:12345/") + sizeof( ip )
360 + strlen( rtsp->psz_path )];
362 /* Build self-referential URL */
363 httpd_ServerIP( cl, ip );
364 ptr = strchr( ip, '%' );
368 if( strchr( ip, ':' ) != NULL )
369 sprintf( control, "rtsp://[%s]:%u/%s", ip, rtsp->port,
370 ( rtsp->psz_path != NULL ) ? rtsp->psz_path : "" );
372 sprintf( control, "rtsp://%s:%u/%s", ip, rtsp->port,
373 ( rtsp->psz_path != NULL ) ? rtsp->psz_path : "" );
375 ptr = SDPGenerate( rtsp->owner, control );
377 answer->i_status = 200;
378 httpd_MsgAdd( answer, "Content-Type", "%s", "application/sdp" );
379 httpd_MsgAdd( answer, "Content-Base", "%s", control );
380 answer->p_body = (uint8_t *)ptr;
381 answer->i_body = strlen( ptr );
385 case HTTPD_MSG_SETUP:
386 /* Non-aggregate-only */
389 answer->i_status = 459;
393 psz_session = httpd_MsgGet( query, "Session" );
394 answer->i_status = 461;
396 for( const char *tpt = httpd_MsgGet( query, "Transport" );
398 tpt = transport_next( tpt ) )
400 vlc_bool_t b_multicast = VLC_TRUE, b_unsupp = VLC_FALSE;
401 unsigned loport = 5004, hiport = 5005; /* from RFC3551 */
403 /* Check transport protocol. */
404 /* Currently, we only support RTP/AVP over UDP */
405 if( strncmp( tpt, "RTP/AVP", 7 ) )
408 if( strncmp( tpt, "/UDP", 4 ) == 0 )
410 if( strchr( ";,", *tpt ) == NULL )
413 /* Parse transport options */
414 for( const char *opt = parameter_next( tpt );
416 opt = parameter_next( opt ) )
418 if( strncmp( opt, "multicast", 9 ) == 0)
419 b_multicast = VLC_TRUE;
421 if( strncmp( opt, "unicast", 7 ) == 0 )
422 b_multicast = VLC_FALSE;
424 if( sscanf( opt, "client_port=%u-%u", &loport, &hiport )
428 if( strncmp( opt, "mode=", 5 ) == 0 )
430 if( strncasecmp( opt + 5, "play", 4 )
431 && strncasecmp( opt + 5, "\"PLAY\"", 6 ) )
439 if( strncmp( opt,"destination=", 12 ) == 0 )
441 answer->i_status = 403;
447 * Every other option is unsupported:
449 * "source" and "append" are invalid (server-only);
450 * "ssrc" also (as clarified per RFC2326bis).
452 * For multicast, "port", "layers", "ttl" are set by the
453 * stream output configuration.
455 * For unicast, we want to decide "server_port" values.
457 * "interleaved" is not implemented.
469 const char *dst = id->dst;
473 if( psz_session == NULL )
475 /* Create a dummy session ID */
476 snprintf( psz_sesbuf, sizeof( psz_sesbuf ), "%d",
478 psz_session = psz_sesbuf;
480 answer->i_status = 200;
482 httpd_MsgAdd( answer, "Transport",
483 "RTP/AVP/UDP;destination=%s;port=%u-%u;"
485 dst, id->loport, id->hiport,
486 ( id->ttl > 0 ) ? id->ttl : 1 );
490 char ip[NI_MAXNUMERICHOST], src[NI_MAXNUMERICHOST];
491 rtsp_session_t *ses = NULL;
492 rtsp_strack_t track = { id->sout_id, -1, VLC_FALSE };
495 if( httpd_ClientIP( cl, ip ) == NULL )
497 answer->i_status = 500;
501 track.fd = net_ConnectDgram( p_stream, ip, loport, -1,
506 "cannot create RTP socket for %s port %u",
508 answer->i_status = 500;
512 net_GetSockAddress( track.fd, src, &sport );
514 vlc_mutex_lock( &rtsp->lock );
515 if( psz_session == NULL )
517 ses = RtspClientNew( rtsp );
518 snprintf( psz_sesbuf, sizeof( psz_sesbuf ), I64Fx,
520 psz_session = psz_sesbuf;
524 /* FIXME: we probably need to remove an access out,
525 * if there is already one for the same ID */
526 ses = RtspClientGet( rtsp, psz_session );
529 answer->i_status = 454;
530 vlc_mutex_unlock( &rtsp->lock );
535 INSERT_ELEM( ses->trackv, ses->trackc, ses->trackc,
537 vlc_mutex_unlock( &rtsp->lock );
539 httpd_ServerIP( cl, ip );
541 if( strcmp( src, ip ) )
543 /* Specify source IP if it is different from the RTSP
544 * control connection server address */
545 char *ptr = strchr( src, '%' );
546 if( ptr != NULL ) *ptr = '\0'; /* remove scope ID */
548 httpd_MsgAdd( answer, "Transport",
549 "RTP/AVP/UDP;unicast;source=%s;"
550 "client_port=%u-%u;server_port=%u-%u;"
552 src, loport, loport + 1, sport,
557 httpd_MsgAdd( answer, "Transport",
558 "RTP/AVP/UDP;unicast;"
559 "client_port=%u-%u;server_port=%u-%u;"
561 loport, loport + 1, sport, sport + 1 );
564 answer->i_status = 200;
573 answer->i_status = 200;
575 psz_session = httpd_MsgGet( query, "Session" );
576 if( httpd_MsgGet( query, "Range" ) != NULL )
578 answer->i_status = 456; /* cannot seek */
582 vlc_mutex_lock( &rtsp->lock );
583 ses = RtspClientGet( rtsp, psz_session );
586 for( int i = 0; i < ses->trackc; i++ )
588 rtsp_strack_t *tr = ses->trackv + i;
590 && ( ( id == NULL ) || ( tr->id == id->sout_id ) ) )
592 tr->playing = VLC_TRUE;
593 rtp_add_sink( tr->id, tr->fd );
597 vlc_mutex_unlock( &rtsp->lock );
599 if( httpd_MsgGet( query, "Scale" ) != NULL )
600 httpd_MsgAdd( answer, "Scale", "1." );
604 case HTTPD_MSG_PAUSE:
605 answer->i_status = 405;
606 httpd_MsgAdd( answer, "Allow",
607 "%s, TEARDOWN, PLAY, GET_PARAMETER",
608 ( id != NULL ) ? "SETUP" : "DESCRIBE" );
611 case HTTPD_MSG_GETPARAMETER:
612 if( query->i_body > 0 )
614 answer->i_status = 451;
618 psz_session = httpd_MsgGet( query, "Session" );
619 answer->i_status = 200;
622 case HTTPD_MSG_TEARDOWN:
626 answer->i_status = 200;
628 psz_session = httpd_MsgGet( query, "Session" );
630 vlc_mutex_lock( &rtsp->lock );
631 ses = RtspClientGet( rtsp, psz_session );
634 if( id == NULL ) /* Delete the entire session */
635 RtspClientDel( rtsp, ses );
636 else /* Delete one track from the session */
637 for( int i = 0; i < ses->trackc; i++ )
639 if( ses->trackv[i].id == id->sout_id )
641 rtp_del_sink( id->sout_id, ses->trackv[i].fd );
642 REMOVE_ELEM( ses->trackv, ses->trackc, i );
646 vlc_mutex_unlock( &rtsp->lock );
654 httpd_MsgAdd( answer, "Server", "%s", PACKAGE_STRING );
656 httpd_MsgAdd( answer, "Session", "%s"/*;timeout=5*/, psz_session );
658 httpd_MsgAdd( answer, "Content-Length", "%d", answer->i_body );
659 httpd_MsgAdd( answer, "Cache-Control", "no-cache" );
661 psz = httpd_MsgGet( query, "Cseq" );
663 httpd_MsgAdd( answer, "Cseq", "%s", psz );
664 psz = httpd_MsgGet( query, "Timestamp" );
666 httpd_MsgAdd( answer, "Timestamp", "%s", psz );
672 /** Aggregate RTSP callback */
673 static int RtspCallback( httpd_callback_sys_t *p_args,
675 httpd_message_t *answer,
676 const httpd_message_t *query )
678 return RtspHandler( (rtsp_stream_t *)p_args, NULL, cl, answer, query );
682 /** Non-aggregate RTSP callback */
683 static int RtspCallbackId( httpd_callback_sys_t *p_args,
685 httpd_message_t *answer,
686 const httpd_message_t *query )
688 rtsp_stream_id_t *id = (rtsp_stream_id_t *)p_args;
689 return RtspHandler( id->stream, id, cl, answer, query );