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;
157 sout_access_out_t *access;
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\n", 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;
220 sout_AccessOutDelete( tr->access );
221 REMOVE_ELEM( ses->trackv, ses->trackc, j );
222 /* FIXME: are we supposed to notify the client? */
227 vlc_mutex_unlock( &rtsp->lock );
228 httpd_UrlDelete( id->url );
233 /** rtsp must be locked */
235 rtsp_session_t *RtspClientNew( rtsp_stream_t *rtsp )
237 rtsp_session_t *s = malloc( sizeof( *s ) );
242 vlc_rand_bytes (&s->id, sizeof (s->id));
246 TAB_APPEND( rtsp->sessionc, rtsp->sessionv, s );
252 /** rtsp must be locked */
254 rtsp_session_t *RtspClientGet( rtsp_stream_t *rtsp, const char *name )
264 id = strtoull( name, &end, 0x10 );
268 /* FIXME: use a hash/dictionary */
269 for( i = 0; i < rtsp->sessionc; i++ )
271 if( rtsp->sessionv[i]->id == id )
272 return rtsp->sessionv[i];
278 /** rtsp must be locked */
280 void RtspClientDel( rtsp_stream_t *rtsp, rtsp_session_t *session )
283 TAB_REMOVE( rtsp->sessionc, rtsp->sessionv, session );
285 for( i = 0; i < session->trackc; i++ )
287 rtp_del_sink( session->trackv[i].id, session->trackv[i].access );
288 sout_AccessOutDelete( session->trackv[i].access );
291 free( session->trackv );
296 /** Finds the next transport choice */
297 static inline const char *transport_next( const char *str )
299 /* Looks for comma */
300 str = strchr( str, ',' );
302 return NULL; /* No more transport options */
304 str++; /* skips comma */
305 while( strchr( "\r\n\t ", *str ) )
308 return (*str) ? str : NULL;
312 /** Finds the next transport parameter */
313 static inline const char *parameter_next( const char *str )
315 while( strchr( ",;", *str ) == NULL )
318 return (*str == ';') ? (str + 1) : NULL;
322 /** RTSP requests handler
323 * @param id selected track for non-aggregate URLs,
324 * NULL for aggregate URLs
326 static int RtspHandler( rtsp_stream_t *rtsp, rtsp_stream_id_t *id,
328 httpd_message_t *answer,
329 const httpd_message_t *query )
331 sout_stream_t *p_stream = id->stream->owner;
333 const char *psz_session = NULL, *psz;
335 if( answer == NULL || query == NULL )
339 answer->i_proto = HTTPD_PROTO_RTSP;
340 answer->i_version= query->i_version;
341 answer->i_type = HTTPD_MSG_ANSWER;
343 answer->p_body = NULL;
345 if( httpd_MsgGet( query, "Require" ) != NULL )
347 answer->i_status = 551;
348 httpd_MsgAdd( answer, "Unsupported", "%s",
349 httpd_MsgGet( query, "Require" ) );
352 switch( query->i_type )
354 case HTTPD_MSG_DESCRIBE:
355 { /* Aggregate-only */
358 answer->i_status = 460;
362 char ip[NI_MAXNUMERICHOST], *ptr;
363 char control[sizeof("rtsp://[]:12345/") + sizeof( ip )
364 + strlen( rtsp->psz_path )];
366 /* Build self-referential URL */
367 httpd_ServerIP( cl, ip );
368 ptr = strchr( ip, '%' );
372 if( strchr( ip, ':' ) != NULL )
373 sprintf( control, "rtsp://[%s]:%u/%s", ip, rtsp->port,
374 ( rtsp->psz_path != NULL ) ? rtsp->psz_path : "" );
376 sprintf( control, "rtsp://%s:%u/%s", ip, rtsp->port,
377 ( rtsp->psz_path != NULL ) ? rtsp->psz_path : "" );
379 ptr = SDPGenerate( rtsp->owner, control );
381 answer->i_status = 200;
382 httpd_MsgAdd( answer, "Content-Type", "%s", "application/sdp" );
383 httpd_MsgAdd( answer, "Content-Base", "%s", control );
384 answer->p_body = (uint8_t *)ptr;
385 answer->i_body = strlen( ptr );
389 case HTTPD_MSG_SETUP:
390 /* Non-aggregate-only */
393 answer->i_status = 459;
397 psz_session = httpd_MsgGet( query, "Session" );
398 answer->i_status = 461;
400 for( const char *tpt = httpd_MsgGet( query, "Transport" );
402 tpt = transport_next( tpt ) )
404 vlc_bool_t b_multicast = VLC_TRUE, b_unsupp = VLC_FALSE;
405 unsigned loport = 5004, hiport = 5005; /* from RFC3551 */
407 /* Check transport protocol. */
408 /* Currently, we only support RTP/AVP over UDP */
409 if( strncmp( tpt, "RTP/AVP", 7 ) )
412 if( strncmp( tpt, "/UDP", 4 ) == 0 )
414 if( strchr( ";,", *tpt ) == NULL )
417 /* Parse transport options */
418 for( const char *opt = parameter_next( tpt );
420 opt = parameter_next( opt ) )
422 if( strncmp( opt, "multicast", 9 ) == 0)
423 b_multicast = VLC_TRUE;
425 if( strncmp( opt, "unicast", 7 ) == 0 )
426 b_multicast = VLC_FALSE;
428 if( sscanf( opt, "client_port=%u-%u", &loport, &hiport )
432 if( strncmp( opt, "mode=", 5 ) == 0 )
434 if( strncasecmp( opt + 5, "play", 4 )
435 && strncasecmp( opt + 5, "\"PLAY\"", 6 ) )
443 if( strncmp( opt,"destination=", 12 ) == 0 )
445 answer->i_status = 403;
451 * Every other option is unsupported:
453 * "source" and "append" are invalid (server-only);
454 * "ssrc" also (as clarified per RFC2326bis).
456 * For multicast, "port", "layers", "ttl" are set by the
457 * stream output configuration.
459 * For unicast, we want to decide "server_port" values.
461 * "interleaved" is not implemented.
473 const char *dst = id->dst;
477 if( psz_session == NULL )
479 /* Create a dummy session ID */
480 snprintf( psz_sesbuf, sizeof( psz_sesbuf ), "%d",
482 psz_session = psz_sesbuf;
484 answer->i_status = 200;
486 httpd_MsgAdd( answer, "Transport",
487 "RTP/AVP/UDP;destination=%s;port=%u-%u;"
489 dst, id->loport, id->hiport,
490 ( id->ttl > 0 ) ? id->ttl : 1 );
494 char ip[NI_MAXNUMERICHOST], url[NI_MAXNUMERICHOST + 8];
495 static const char access[] = "udp{raw,rtcp}";
496 rtsp_session_t *ses = NULL;
497 rtsp_strack_t track = { id->sout_id, NULL, VLC_FALSE };
499 if( httpd_ClientIP( cl, ip ) == NULL )
501 answer->i_status = 500;
505 snprintf( url, sizeof( url ),
506 ( strchr( ip, ':' ) != NULL )
507 ? "[%s]:%d" : "%s:%d",
510 track.access = sout_AccessOutNew( p_stream->p_sout,
512 if( track.access == NULL )
515 "cannot create access output for %s://%s",
517 answer->i_status = 500;
521 char *src = var_GetNonEmptyString( track.access,
523 int sport = var_GetInteger( track.access, "src-port" );
525 vlc_mutex_lock( &rtsp->lock );
526 if( psz_session == NULL )
528 ses = RtspClientNew( rtsp );
529 snprintf( psz_sesbuf, sizeof( psz_sesbuf ), I64Fx,
531 psz_session = psz_sesbuf;
535 /* FIXME: we probably need to remove an access out,
536 * if there is already one for the same ID */
537 ses = RtspClientGet( rtsp, psz_session );
540 answer->i_status = 454;
541 vlc_mutex_unlock( &rtsp->lock );
546 INSERT_ELEM( ses->trackv, ses->trackc, ses->trackc,
548 vlc_mutex_unlock( &rtsp->lock );
550 httpd_ServerIP( cl, ip );
552 if( ( src != NULL ) && strcmp( src, ip ) )
554 /* Specify source IP if it is different from the RTSP
555 * control connection server address */
556 char *ptr = strchr( src, '%' );
557 if( ptr != NULL ) *ptr = '\0'; /* remove scope ID */
559 httpd_MsgAdd( answer, "Transport",
560 "RTP/AVP/UDP;unicast;source=%s;"
561 "client_port=%u-%u;server_port=%u-%u;"
563 src, loport, loport + 1, sport,
568 httpd_MsgAdd( answer, "Transport",
569 "RTP/AVP/UDP;unicast;"
570 "client_port=%u-%u;server_port=%u-%u;"
572 loport, loport + 1, sport, sport + 1 );
575 answer->i_status = 200;
585 answer->i_status = 200;
587 psz_session = httpd_MsgGet( query, "Session" );
588 if( httpd_MsgGet( query, "Range" ) != NULL )
590 answer->i_status = 456; /* cannot seek */
594 vlc_mutex_lock( &rtsp->lock );
595 ses = RtspClientGet( rtsp, psz_session );
598 for( int i = 0; i < ses->trackc; i++ )
600 rtsp_strack_t *tr = ses->trackv + i;
602 && ( ( id == NULL ) || ( tr->id == id->sout_id ) ) )
604 tr->playing = VLC_TRUE;
605 rtp_add_sink( tr->id, tr->access );
609 vlc_mutex_unlock( &rtsp->lock );
611 if( httpd_MsgGet( query, "Scale" ) != NULL )
612 httpd_MsgAdd( answer, "Scale", "1." );
616 case HTTPD_MSG_PAUSE:
617 answer->i_status = 405;
618 httpd_MsgAdd( answer, "Allow",
619 "%s, TEARDOWN, PLAY, GET_PARAMETER",
620 ( id != NULL ) ? "SETUP" : "DESCRIBE" );
623 case HTTPD_MSG_GETPARAMETER:
624 if( query->i_body > 0 )
626 answer->i_status = 451;
630 psz_session = httpd_MsgGet( query, "Session" );
631 answer->i_status = 200;
634 case HTTPD_MSG_TEARDOWN:
638 answer->i_status = 200;
640 psz_session = httpd_MsgGet( query, "Session" );
642 vlc_mutex_lock( &rtsp->lock );
643 ses = RtspClientGet( rtsp, psz_session );
646 if( id == NULL ) /* Delete the entire session */
647 RtspClientDel( rtsp, ses );
648 else /* Delete one track from the session */
649 for( int i = 0; i < ses->trackc; i++ )
651 if( ses->trackv[i].id == id->sout_id )
653 rtp_del_sink( id->sout_id, ses->trackv[i].access );
654 sout_AccessOutDelete( ses->trackv[i].access );
655 REMOVE_ELEM( ses->trackv, ses->trackc, i );
659 vlc_mutex_unlock( &rtsp->lock );
667 httpd_MsgAdd( answer, "Server", "%s", PACKAGE_STRING );
669 httpd_MsgAdd( answer, "Session", "%s"/*;timeout=5*/, psz_session );
671 httpd_MsgAdd( answer, "Content-Length", "%d", answer->i_body );
672 httpd_MsgAdd( answer, "Cache-Control", "no-cache" );
674 psz = httpd_MsgGet( query, "Cseq" );
676 httpd_MsgAdd( answer, "Cseq", "%s", psz );
677 psz = httpd_MsgGet( query, "Timestamp" );
679 httpd_MsgAdd( answer, "Timestamp", "%s", psz );
685 /** Aggregate RTSP callback */
686 static int RtspCallback( httpd_callback_sys_t *p_args,
688 httpd_message_t *answer,
689 const httpd_message_t *query )
691 return RtspHandler( (rtsp_stream_t *)p_args, NULL, cl, answer, query );
695 /** Non-aggregate RTSP callback */
696 static int RtspCallbackId( httpd_callback_sys_t *p_args,
698 httpd_message_t *answer,
699 const httpd_message_t *query )
701 rtsp_stream_id_t *id = (rtsp_stream_id_t *)p_args;
702 return RtspHandler( id->stream, id, cl, answer, query );