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
;
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
;
88 vlc_mutex_init( &rtsp
->lock
);
90 rtsp
->port
= (url
->i_port
> 0) ? url
->i_port
: 554;
91 rtsp
->psz_path
= strdup( ( url
->psz_path
!= NULL
) ? url
->psz_path
: "/" );
92 if( rtsp
->psz_path
== NULL
)
95 msg_Dbg( p_stream
, "RTSP stream: host %s port %d at %s",
96 url
->psz_host
, rtsp
->port
, rtsp
->psz_path
);
98 rtsp
->host
= httpd_HostNew( VLC_OBJECT(p_stream
), url
->psz_host
,
100 if( rtsp
->host
== NULL
)
103 rtsp
->url
= httpd_UrlNewUnique( rtsp
->host
, rtsp
->psz_path
,
105 if( rtsp
->url
== NULL
)
108 httpd_UrlCatch( rtsp
->url
, HTTPD_MSG_DESCRIBE
, RtspCallback
, (void*)rtsp
);
109 httpd_UrlCatch( rtsp
->url
, HTTPD_MSG_SETUP
, RtspCallback
, (void*)rtsp
);
110 httpd_UrlCatch( rtsp
->url
, HTTPD_MSG_PLAY
, RtspCallback
, (void*)rtsp
);
111 httpd_UrlCatch( rtsp
->url
, HTTPD_MSG_PAUSE
, RtspCallback
, (void*)rtsp
);
112 httpd_UrlCatch( rtsp
->url
, HTTPD_MSG_GETPARAMETER
, RtspCallback
,
114 httpd_UrlCatch( rtsp
->url
, HTTPD_MSG_TEARDOWN
, RtspCallback
, (void*)rtsp
);
123 void RtspUnsetup( rtsp_stream_t
*rtsp
)
126 httpd_UrlDelete( rtsp
->url
);
128 while( rtsp
->sessionc
> 0 )
129 RtspClientDel( rtsp
, rtsp
->sessionv
[0] );
132 httpd_HostDelete( rtsp
->host
);
134 free( rtsp
->psz_path
);
135 vlc_mutex_destroy( &rtsp
->lock
);
141 struct rtsp_stream_id_t
143 rtsp_stream_t
*stream
;
144 sout_stream_id_t
*sout_id
;
150 uint16_t loport
, hiport
;
154 typedef struct rtsp_strack_t rtsp_strack_t
;
156 /* For unicast streaming */
157 struct rtsp_session_t
159 rtsp_stream_t
*stream
;
162 /* output (id-access) */
164 rtsp_strack_t
*trackv
;
168 /* Unicast session track */
171 rtsp_stream_id_t
*id
;
177 char *RtspAppendTrackPath( rtsp_stream_id_t
*id
, const char *base
)
179 const char *sep
= strlen( base
) > 0 && base
[strlen( base
) - 1] == '/' ?
183 if( asprintf( &url
, "%s%strackID=%u", base
, sep
, id
->track_id
) == -1 )
189 rtsp_stream_id_t
*RtspAddId( rtsp_stream_t
*rtsp
, sout_stream_id_t
*sid
,
191 /* Multicast stuff - TODO: cleanup */
192 const char *dst
, int ttl
,
193 unsigned loport
, unsigned hiport
)
196 rtsp_stream_id_t
*id
= malloc( sizeof( *id
) );
204 id
->track_id
= rtsp
->track_id
;
206 /* TODO: can we assume that this need not be strdup'd? */
208 if( id
->dst
!= NULL
)
215 urlbuf
= RtspAppendTrackPath( id
, rtsp
->psz_path
);
222 msg_Dbg( rtsp
->owner
, "RTSP: adding %s", urlbuf
);
223 url
= id
->url
= httpd_UrlNewUnique( rtsp
->host
, urlbuf
, NULL
, NULL
, NULL
);
232 httpd_UrlCatch( url
, HTTPD_MSG_DESCRIBE
, RtspCallbackId
, (void *)id
);
233 httpd_UrlCatch( url
, HTTPD_MSG_SETUP
, RtspCallbackId
, (void *)id
);
234 httpd_UrlCatch( url
, HTTPD_MSG_PLAY
, RtspCallbackId
, (void *)id
);
235 httpd_UrlCatch( url
, HTTPD_MSG_PAUSE
, RtspCallbackId
, (void *)id
);
236 httpd_UrlCatch( url
, HTTPD_MSG_GETPARAMETER
, RtspCallbackId
, (void *)id
);
237 httpd_UrlCatch( url
, HTTPD_MSG_TEARDOWN
, RtspCallbackId
, (void *)id
);
245 void RtspDelId( rtsp_stream_t
*rtsp
, rtsp_stream_id_t
*id
)
247 httpd_UrlDelete( id
->url
);
249 vlc_mutex_lock( &rtsp
->lock
);
250 for( int i
= 0; i
< rtsp
->sessionc
; i
++ )
252 rtsp_session_t
*ses
= rtsp
->sessionv
[i
];
254 for( int j
= 0; j
< ses
->trackc
; j
++ )
256 if( ses
->trackv
[j
].id
== id
)
258 rtsp_strack_t
*tr
= ses
->trackv
+ j
;
259 rtp_del_sink( tr
->id
->sout_id
, tr
->fd
);
260 REMOVE_ELEM( ses
->trackv
, ses
->trackc
, j
);
265 vlc_mutex_unlock( &rtsp
->lock
);
270 /** rtsp must be locked */
272 rtsp_session_t
*RtspClientNew( rtsp_stream_t
*rtsp
)
274 rtsp_session_t
*s
= malloc( sizeof( *s
) );
279 vlc_rand_bytes (&s
->id
, sizeof (s
->id
));
283 TAB_APPEND( rtsp
->sessionc
, rtsp
->sessionv
, s
);
289 /** rtsp must be locked */
291 rtsp_session_t
*RtspClientGet( rtsp_stream_t
*rtsp
, const char *name
)
301 id
= strtoull( name
, &end
, 0x10 );
305 /* FIXME: use a hash/dictionary */
306 for( i
= 0; i
< rtsp
->sessionc
; i
++ )
308 if( rtsp
->sessionv
[i
]->id
== id
)
309 return rtsp
->sessionv
[i
];
315 /** rtsp must be locked */
317 void RtspClientDel( rtsp_stream_t
*rtsp
, rtsp_session_t
*session
)
320 TAB_REMOVE( rtsp
->sessionc
, rtsp
->sessionv
, session
);
322 for( i
= 0; i
< session
->trackc
; i
++ )
323 rtp_del_sink( session
->trackv
[i
].id
->sout_id
, session
->trackv
[i
].fd
);
325 free( session
->trackv
);
330 /** Finds the next transport choice */
331 static inline const char *transport_next( const char *str
)
333 /* Looks for comma */
334 str
= strchr( str
, ',' );
336 return NULL
; /* No more transport options */
338 str
++; /* skips comma */
339 while( strchr( "\r\n\t ", *str
) )
342 return (*str
) ? str
: NULL
;
346 /** Finds the next transport parameter */
347 static inline const char *parameter_next( const char *str
)
349 while( strchr( ",;", *str
) == NULL
)
352 return (*str
== ';') ? (str
+ 1) : NULL
;
356 /** RTSP requests handler
357 * @param id selected track for non-aggregate URLs,
358 * NULL for aggregate URLs
360 static int RtspHandler( rtsp_stream_t
*rtsp
, rtsp_stream_id_t
*id
,
362 httpd_message_t
*answer
,
363 const httpd_message_t
*query
)
365 sout_stream_t
*p_stream
= rtsp
->owner
;
367 const char *psz_session
= NULL
, *psz
;
368 char control
[sizeof("rtsp://[]:12345") + NI_MAXNUMERICHOST
369 + strlen( rtsp
->psz_path
)];
374 if( answer
== NULL
|| query
== NULL
|| cl
== NULL
)
378 /* Build self-referential control URL */
379 char ip
[NI_MAXNUMERICHOST
], *ptr
;
381 httpd_ServerIP( cl
, ip
);
382 ptr
= strchr( ip
, '%' );
386 if( strchr( ip
, ':' ) != NULL
)
387 sprintf( control
, "rtsp://[%s]:%u%s", ip
, rtsp
->port
,
390 sprintf( control
, "rtsp://%s:%u%s", ip
, rtsp
->port
,
395 answer
->i_proto
= HTTPD_PROTO_RTSP
;
396 answer
->i_version
= 0;
397 answer
->i_type
= HTTPD_MSG_ANSWER
;
399 answer
->p_body
= NULL
;
401 httpd_MsgAdd( answer
, "Server", "VLC/%s", VERSION
);
403 /* Date: is always allowed, and sometimes mandatory with RTSP/2.0. */
405 if (gmtime_r (&now
, &ut
) != NULL
)
406 { /* RFC1123 format, GMT is mandatory */
407 static const char wdays
[7][4] = {
408 "Sun", "Mon", "Tue", "Wed", "Thu", "Fri", "Sat" };
409 static const char mons
[12][4] = {
410 "Jan", "Feb", "Mar", "Apr", "May", "Jun",
411 "Jul", "Aug", "Sep", "Oct", "Nov", "Dec" };
412 httpd_MsgAdd (answer
, "Date", "%s, %02u %s %04u %02u:%02u:%02u GMT",
413 wdays
[ut
.tm_wday
], ut
.tm_mday
, mons
[ut
.tm_mon
],
414 1900 + ut
.tm_year
, ut
.tm_hour
, ut
.tm_min
, ut
.tm_sec
);
417 if( query
->i_proto
!= HTTPD_PROTO_RTSP
)
419 answer
->i_status
= 505;
422 if( httpd_MsgGet( query
, "Require" ) != NULL
)
424 answer
->i_status
= 551;
425 httpd_MsgAdd( answer
, "Unsupported", "%s",
426 httpd_MsgGet( query
, "Require" ) );
429 switch( query
->i_type
)
431 case HTTPD_MSG_DESCRIBE
:
432 { /* Aggregate-only */
435 answer
->i_status
= 460;
439 answer
->i_status
= 200;
440 httpd_MsgAdd( answer
, "Content-Type", "%s", "application/sdp" );
441 httpd_MsgAdd( answer
, "Content-Base", "%s", control
);
442 answer
->p_body
= (uint8_t *)SDPGenerate( rtsp
->owner
, control
);
443 if( answer
->p_body
!= NULL
)
444 answer
->i_body
= strlen( (char *)answer
->p_body
);
446 answer
->i_status
= 500;
450 case HTTPD_MSG_SETUP
:
451 /* Non-aggregate-only */
454 answer
->i_status
= 459;
458 psz_session
= httpd_MsgGet( query
, "Session" );
459 answer
->i_status
= 461;
461 for( const char *tpt
= httpd_MsgGet( query
, "Transport" );
463 tpt
= transport_next( tpt
) )
465 bool b_multicast
= true, b_unsupp
= false;
466 unsigned loport
= 5004, hiport
= 5005; /* from RFC3551 */
468 /* Check transport protocol. */
469 /* Currently, we only support RTP/AVP over UDP */
470 if( strncmp( tpt
, "RTP/AVP", 7 ) )
473 if( strncmp( tpt
, "/UDP", 4 ) == 0 )
475 if( strchr( ";,", *tpt
) == NULL
)
478 /* Parse transport options */
479 for( const char *opt
= parameter_next( tpt
);
481 opt
= parameter_next( opt
) )
483 if( strncmp( opt
, "multicast", 9 ) == 0)
486 if( strncmp( opt
, "unicast", 7 ) == 0 )
489 if( sscanf( opt
, "client_port=%u-%u", &loport
, &hiport
)
493 if( strncmp( opt
, "mode=", 5 ) == 0 )
495 if( strncasecmp( opt
+ 5, "play", 4 )
496 && strncasecmp( opt
+ 5, "\"PLAY\"", 6 ) )
504 if( strncmp( opt
,"destination=", 12 ) == 0 )
506 answer
->i_status
= 403;
512 * Every other option is unsupported:
514 * "source" and "append" are invalid (server-only);
515 * "ssrc" also (as clarified per RFC2326bis).
517 * For multicast, "port", "layers", "ttl" are set by the
518 * stream output configuration.
520 * For unicast, we want to decide "server_port" values.
522 * "interleaved" is not implemented.
534 const char *dst
= id
->dst
;
538 if( psz_session
== NULL
)
540 /* Create a dummy session ID */
541 snprintf( psz_sesbuf
, sizeof( psz_sesbuf
), "%lu",
543 psz_session
= psz_sesbuf
;
545 answer
->i_status
= 200;
547 httpd_MsgAdd( answer
, "Transport",
548 "RTP/AVP/UDP;destination=%s;port=%u-%u;"
550 dst
, id
->loport
, id
->hiport
,
551 ( id
->ttl
> 0 ) ? id
->ttl
: 1 );
555 char ip
[NI_MAXNUMERICHOST
], src
[NI_MAXNUMERICHOST
];
556 rtsp_session_t
*ses
= NULL
;
557 rtsp_strack_t track
= { id
, -1, false };
560 if( httpd_ClientIP( cl
, ip
) == NULL
)
562 answer
->i_status
= 500;
566 track
.fd
= net_ConnectDgram( p_stream
, ip
, loport
, -1,
571 "cannot create RTP socket for %s port %u",
573 answer
->i_status
= 500;
577 /* Ignore any unexpected incoming packet */
578 setsockopt (track
.fd
, SOL_SOCKET
, SO_RCVBUF
, &(int){ 0 },
580 net_GetSockAddress( track
.fd
, src
, &sport
);
582 vlc_mutex_lock( &rtsp
->lock
);
583 if( psz_session
== NULL
)
585 ses
= RtspClientNew( rtsp
);
586 snprintf( psz_sesbuf
, sizeof( psz_sesbuf
), "%"PRIx64
,
588 psz_session
= psz_sesbuf
;
592 /* FIXME: we probably need to remove an access out,
593 * if there is already one for the same ID */
594 ses
= RtspClientGet( rtsp
, psz_session
);
597 answer
->i_status
= 454;
598 vlc_mutex_unlock( &rtsp
->lock
);
603 INSERT_ELEM( ses
->trackv
, ses
->trackc
, ses
->trackc
,
605 vlc_mutex_unlock( &rtsp
->lock
);
607 httpd_ServerIP( cl
, ip
);
609 if( 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;"
619 "ssrc=%08X;mode=play",
620 src
, loport
, loport
+ 1, sport
,
621 sport
+ 1, id
->ssrc
);
625 httpd_MsgAdd( answer
, "Transport",
626 "RTP/AVP/UDP;unicast;"
627 "client_port=%u-%u;server_port=%u-%u;"
628 "ssrc=%08X;mode=play",
629 loport
, loport
+ 1, sport
, sport
+ 1,
633 answer
->i_status
= 200;
642 answer
->i_status
= 200;
644 psz_session
= httpd_MsgGet( query
, "Session" );
645 const char *range
= httpd_MsgGet (query
, "Range");
646 if (range
&& strncmp (range
, "npt=", 4))
648 answer
->i_status
= 501;
652 vlc_mutex_lock( &rtsp
->lock
);
653 ses
= RtspClientGet( rtsp
, psz_session
);
656 /* The "trackID" part must match what is done in
657 * RtspAppendTrackPath() */
658 /* FIXME: we really need to limit the number of tracks... */
659 char info
[ses
->trackc
* ( strlen( control
)
660 + sizeof("url=/trackID=123;seq=65535;"
661 "rtptime=4294967295, ") ) + 1];
663 int64_t ts
= rtp_get_ts( rtsp
->owner
);
665 for( int i
= 0; i
< ses
->trackc
; i
++ )
667 rtsp_strack_t
*tr
= ses
->trackv
+ i
;
668 if( ( id
== NULL
) || ( tr
->id
== id
) )
674 rtp_add_sink( tr
->id
->sout_id
, tr
->fd
, false,
678 seq
= rtp_get_seq( tr
->id
->sout_id
);
679 char *url
= RtspAppendTrackPath( tr
->id
, control
);
680 infolen
+= sprintf( info
+ infolen
,
681 "url=%s;seq=%u;rtptime=%u, ",
682 url
!= NULL
? url
: "", seq
,
683 rtp_compute_ts( tr
->id
->sout_id
, ts
) );
689 info
[infolen
- 2] = '\0'; /* remove trailing ", " */
690 httpd_MsgAdd( answer
, "RTP-Info", "%s", info
);
693 vlc_mutex_unlock( &rtsp
->lock
);
695 if( httpd_MsgGet( query
, "Scale" ) != NULL
)
696 httpd_MsgAdd( answer
, "Scale", "1." );
700 case HTTPD_MSG_PAUSE
:
701 answer
->i_status
= 405;
702 httpd_MsgAdd( answer
, "Allow",
703 "%s, TEARDOWN, PLAY, GET_PARAMETER",
704 ( id
!= NULL
) ? "SETUP" : "DESCRIBE" );
707 case HTTPD_MSG_GETPARAMETER
:
708 if( query
->i_body
> 0 )
710 answer
->i_status
= 451;
714 psz_session
= httpd_MsgGet( query
, "Session" );
715 answer
->i_status
= 200;
718 case HTTPD_MSG_TEARDOWN
:
722 answer
->i_status
= 200;
724 psz_session
= httpd_MsgGet( query
, "Session" );
726 vlc_mutex_lock( &rtsp
->lock
);
727 ses
= RtspClientGet( rtsp
, psz_session
);
730 if( id
== NULL
) /* Delete the entire session */
731 RtspClientDel( rtsp
, ses
);
732 else /* Delete one track from the session */
733 for( int i
= 0; i
< ses
->trackc
; i
++ )
735 if( ses
->trackv
[i
].id
== id
)
737 rtp_del_sink( id
->sout_id
, ses
->trackv
[i
].fd
);
738 REMOVE_ELEM( ses
->trackv
, ses
->trackc
, i
);
742 vlc_mutex_unlock( &rtsp
->lock
);
751 httpd_MsgAdd( answer
, "Session", "%s"/*;timeout=5*/, psz_session
);
753 httpd_MsgAdd( answer
, "Content-Length", "%d", answer
->i_body
);
754 httpd_MsgAdd( answer
, "Cache-Control", "no-cache" );
756 psz
= httpd_MsgGet( query
, "Cseq" );
758 httpd_MsgAdd( answer
, "Cseq", "%s", psz
);
759 psz
= httpd_MsgGet( query
, "Timestamp" );
761 httpd_MsgAdd( answer
, "Timestamp", "%s", psz
);
767 /** Aggregate RTSP callback */
768 static int RtspCallback( httpd_callback_sys_t
*p_args
,
770 httpd_message_t
*answer
,
771 const httpd_message_t
*query
)
773 return RtspHandler( (rtsp_stream_t
*)p_args
, NULL
, cl
, answer
, query
);
777 /** Non-aggregate RTSP callback */
778 static int RtspCallbackId( httpd_callback_sys_t
*p_args
,
780 httpd_message_t
*answer
,
781 const httpd_message_t
*query
)
783 rtsp_stream_id_t
*id
= (rtsp_stream_id_t
*)p_args
;
784 return RtspHandler( id
->stream
, id
, cl
, answer
, query
);