17d6844457ade45e31b718aec252b8c3d232af9f
[vlc.git] / modules / stream_out / rtsp.c
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
6  *
7  * $Id: rtp.c 21407 2007-08-22 20:10:41Z courmisch $
8  *
9  * Authors: Laurent Aimar <fenrir@via.ecp.fr>
10  *
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.
15  *
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.
20  *
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  *****************************************************************************/
25
26 /*****************************************************************************
27  * Preamble
28  *****************************************************************************/
29 #include <vlc/vlc.h>
30 #include <vlc_sout.h>
31
32 #include <vlc_httpd.h>
33 #include <vlc_url.h>
34 #include <vlc_network.h>
35 #include <vlc_rand.h>
36 #include <assert.h>
37 #include <errno.h>
38 #include <stdlib.h>
39
40 #include "rtp.h"
41
42 typedef struct rtsp_session_t rtsp_session_t;
43
44 struct rtsp_stream_t
45 {
46     vlc_mutex_t     lock;
47     sout_stream_t  *owner;
48     httpd_host_t   *host;
49     httpd_url_t    *url;
50     char           *psz_path;
51     const char     *track_fmt;
52     unsigned        port;
53
54     int             sessionc;
55     rtsp_session_t **sessionv;
56 };
57
58
59 static int  RtspCallback( httpd_callback_sys_t *p_args,
60                           httpd_client_t *cl, httpd_message_t *answer,
61                           const httpd_message_t *query );
62 static int  RtspCallbackId( httpd_callback_sys_t *p_args,
63                             httpd_client_t *cl, httpd_message_t *answer,
64                             const httpd_message_t *query );
65 static void RtspClientDel( rtsp_stream_t *rtsp, rtsp_session_t *session );
66
67 rtsp_stream_t *RtspSetup( sout_stream_t *p_stream, const vlc_url_t *url )
68 {
69     rtsp_stream_t *rtsp = malloc( sizeof( *rtsp ) );
70
71     if( rtsp == NULL || ( url->i_port > 99999 ) )
72     {
73         free( rtsp );
74         return NULL;
75     }
76
77     rtsp->owner = p_stream;
78     rtsp->sessionc = 0;
79     rtsp->sessionv = NULL;
80     rtsp->host = NULL;
81     rtsp->url = NULL;
82     rtsp->psz_path = NULL;
83     vlc_mutex_init( p_stream, &rtsp->lock );
84
85     rtsp->port = (url->i_port > 0) ? url->i_port : 554;
86     rtsp->psz_path = strdup( ( url->psz_path != NULL ) ? url->psz_path : "/" );
87     if( rtsp->psz_path == NULL )
88         goto error;
89
90     assert( strlen( rtsp->psz_path ) > 0 );
91     if( rtsp->psz_path[strlen( rtsp->psz_path ) - 1] == '/' )
92         rtsp->track_fmt = "%strackID=%u";
93     else
94         rtsp->track_fmt = "%s/trackID=%u";
95
96     msg_Dbg( p_stream, "RTSP stream: host %s port %d at %s",
97              url->psz_host, rtsp->port, rtsp->psz_path );
98
99     rtsp->host = httpd_HostNew( VLC_OBJECT(p_stream), url->psz_host,
100                                 rtsp->port );
101     if( rtsp->host == NULL )
102         goto error;
103
104     rtsp->url = httpd_UrlNewUnique( rtsp->host, rtsp->psz_path,
105                                     NULL, NULL, NULL );
106     if( rtsp->url == NULL )
107         goto error;
108
109     httpd_UrlCatch( rtsp->url, HTTPD_MSG_DESCRIBE, RtspCallback, (void*)rtsp );
110     httpd_UrlCatch( rtsp->url, HTTPD_MSG_SETUP,    RtspCallback, (void*)rtsp );
111     httpd_UrlCatch( rtsp->url, HTTPD_MSG_PLAY,     RtspCallback, (void*)rtsp );
112     httpd_UrlCatch( rtsp->url, HTTPD_MSG_PAUSE,    RtspCallback, (void*)rtsp );
113     httpd_UrlCatch( rtsp->url, HTTPD_MSG_GETPARAMETER, RtspCallback,
114                     (void*)rtsp );
115     httpd_UrlCatch( rtsp->url, HTTPD_MSG_TEARDOWN, RtspCallback, (void*)rtsp );
116     return rtsp;
117
118 error:
119     RtspUnsetup( rtsp );
120     return NULL;
121 }
122
123
124 void RtspUnsetup( rtsp_stream_t *rtsp )
125 {
126     while( rtsp->sessionc > 0 )
127         RtspClientDel( rtsp, rtsp->sessionv[0] );
128
129     if( rtsp->url )
130         httpd_UrlDelete( rtsp->url );
131
132     if( rtsp->host )
133         httpd_HostDelete( rtsp->host );
134
135     free( rtsp->psz_path );
136     vlc_mutex_destroy( &rtsp->lock );
137 }
138
139
140 struct rtsp_stream_id_t
141 {
142     rtsp_stream_t    *stream;
143     sout_stream_id_t *sout_id;
144     httpd_url_t      *url;
145     const char       *dst;
146     int               ttl;
147     unsigned          loport, hiport;
148 };
149
150
151 typedef struct rtsp_strack_t rtsp_strack_t;
152
153 /* For unicast streaming */
154 struct rtsp_session_t
155 {
156     rtsp_stream_t *stream;
157     uint64_t       id;
158
159     /* output (id-access) */
160     int            trackc;
161     rtsp_strack_t *trackv;
162 };
163
164
165 /* Unicast session track */
166 struct rtsp_strack_t
167 {
168     sout_stream_id_t  *id;
169     int                fd;
170     vlc_bool_t         playing;
171 };
172
173
174 rtsp_stream_id_t *RtspAddId( rtsp_stream_t *rtsp, sout_stream_id_t *sid,
175                              unsigned num,
176                              /* Multicast stuff - TODO: cleanup */
177                              const char *dst, int ttl,
178                              unsigned loport, unsigned hiport )
179 {
180     char urlbuf[sizeof( "/trackID=123" ) + strlen( rtsp->psz_path )];
181     rtsp_stream_id_t *id = malloc( sizeof( *id ) );
182     httpd_url_t *url;
183
184     if( id == NULL )
185         return NULL;
186
187     id->stream = rtsp;
188     id->sout_id = sid;
189     /* TODO: can we assume that this need not be strdup'd? */
190     id->dst = dst;
191     if( id->dst != NULL )
192     {
193         id->ttl = ttl;
194         id->loport = loport;
195         id->hiport = hiport;
196     }
197
198     snprintf( urlbuf, sizeof( urlbuf ), rtsp->track_fmt, rtsp->psz_path,
199               num );
200     msg_Dbg( rtsp->owner, "RTSP: adding %s", urlbuf );
201     url = id->url = httpd_UrlNewUnique( rtsp->host, urlbuf, NULL, NULL, NULL );
202
203     if( url == NULL )
204     {
205         free( id );
206         return NULL;
207     }
208
209     httpd_UrlCatch( url, HTTPD_MSG_DESCRIBE, RtspCallbackId, (void *)id );
210     httpd_UrlCatch( url, HTTPD_MSG_SETUP,    RtspCallbackId, (void *)id );
211     httpd_UrlCatch( url, HTTPD_MSG_PLAY,     RtspCallbackId, (void *)id );
212     httpd_UrlCatch( url, HTTPD_MSG_PAUSE,    RtspCallbackId, (void *)id );
213     httpd_UrlCatch( url, HTTPD_MSG_GETPARAMETER, RtspCallbackId, (void *)id );
214     httpd_UrlCatch( url, HTTPD_MSG_TEARDOWN, RtspCallbackId, (void *)id );
215
216     return id;
217 }
218
219
220 void RtspDelId( rtsp_stream_t *rtsp, rtsp_stream_id_t *id )
221 {
222     vlc_mutex_lock( &rtsp->lock );
223     for( int i = 0; i < rtsp->sessionc; i++ )
224     {
225         rtsp_session_t *ses = rtsp->sessionv[i];
226
227         for( int j = 0; j < ses->trackc; j++ )
228         {
229             if( ses->trackv[j].id == id->sout_id )
230             {
231                 rtsp_strack_t *tr = ses->trackv + j;
232                 net_Close( tr->fd );
233                 REMOVE_ELEM( ses->trackv, ses->trackc, j );
234             }
235         }
236     }
237
238     vlc_mutex_unlock( &rtsp->lock );
239     httpd_UrlDelete( id->url );
240     free( id );
241 }
242
243
244 /** rtsp must be locked */
245 static
246 rtsp_session_t *RtspClientNew( rtsp_stream_t *rtsp )
247 {
248     rtsp_session_t *s = malloc( sizeof( *s ) );
249     if( s == NULL )
250         return NULL;
251
252     s->stream = rtsp;
253     vlc_rand_bytes (&s->id, sizeof (s->id));
254     s->trackc = 0;
255     s->trackv = NULL;
256
257     TAB_APPEND( rtsp->sessionc, rtsp->sessionv, s );
258
259     return s;
260 }
261
262
263 /** rtsp must be locked */
264 static
265 rtsp_session_t *RtspClientGet( rtsp_stream_t *rtsp, const char *name )
266 {
267     char *end;
268     uint64_t id;
269     int i;
270
271     if( name == NULL )
272         return NULL;
273
274     errno = 0;
275     id = strtoull( name, &end, 0x10 );
276     if( errno || *end )
277         return NULL;
278
279     /* FIXME: use a hash/dictionary */
280     for( i = 0; i < rtsp->sessionc; i++ )
281     {
282         if( rtsp->sessionv[i]->id == id )
283             return rtsp->sessionv[i];
284     }
285     return NULL;
286 }
287
288
289 /** rtsp must be locked */
290 static
291 void RtspClientDel( rtsp_stream_t *rtsp, rtsp_session_t *session )
292 {
293     int i;
294     TAB_REMOVE( rtsp->sessionc, rtsp->sessionv, session );
295
296     for( i = 0; i < session->trackc; i++ )
297         rtp_del_sink( session->trackv[i].id, session->trackv[i].fd );
298
299     free( session->trackv );
300     free( session );
301 }
302
303
304 /** Finds the next transport choice */
305 static inline const char *transport_next( const char *str )
306 {
307     /* Looks for comma */
308     str = strchr( str, ',' );
309     if( str == NULL )
310         return NULL; /* No more transport options */
311
312     str++; /* skips comma */
313     while( strchr( "\r\n\t ", *str ) )
314         str++;
315
316     return (*str) ? str : NULL;
317 }
318
319
320 /** Finds the next transport parameter */
321 static inline const char *parameter_next( const char *str )
322 {
323     while( strchr( ",;", *str ) == NULL )
324         str++;
325
326     return (*str == ';') ? (str + 1) : NULL;
327 }
328
329
330 /** RTSP requests handler
331  * @param id selected track for non-aggregate URLs,
332  *           NULL for aggregate URLs
333  */
334 static int RtspHandler( rtsp_stream_t *rtsp, rtsp_stream_id_t *id,
335                         httpd_client_t *cl,
336                         httpd_message_t *answer,
337                         const httpd_message_t *query )
338 {
339     sout_stream_t *p_stream = rtsp->owner;
340     char psz_sesbuf[17];
341     const char *psz_session = NULL, *psz;
342
343     if( answer == NULL || query == NULL || cl == NULL )
344         return VLC_SUCCESS;
345
346     /* */
347     answer->i_proto = HTTPD_PROTO_RTSP;
348     answer->i_version= query->i_version;
349     answer->i_type   = HTTPD_MSG_ANSWER;
350     answer->i_body = 0;
351     answer->p_body = NULL;
352
353     if( httpd_MsgGet( query, "Require" ) != NULL )
354     {
355         answer->i_status = 551;
356         httpd_MsgAdd( answer, "Unsupported", "%s",
357                       httpd_MsgGet( query, "Require" ) );
358     }
359     else
360     switch( query->i_type )
361     {
362         case HTTPD_MSG_DESCRIBE:
363         {   /* Aggregate-only */
364             if( id != NULL )
365             {
366                 answer->i_status = 460;
367                 break;
368             }
369
370             char ip[NI_MAXNUMERICHOST], *ptr;
371             char control[sizeof("rtsp://[]:12345") + sizeof( ip )
372                             + strlen( rtsp->psz_path )];
373
374             /* Build self-referential URL */
375             httpd_ServerIP( cl, ip );
376             ptr = strchr( ip, '%' );
377             if( ptr != NULL )
378                 *ptr = '\0';
379
380             if( strchr( ip, ':' ) != NULL )
381                 sprintf( control, "rtsp://[%s]:%u%s", ip, rtsp->port,
382                          rtsp->psz_path );
383             else
384                 sprintf( control, "rtsp://%s:%u%s", ip, rtsp->port,
385                          rtsp->psz_path );
386
387             ptr = SDPGenerate( rtsp->owner, control );
388
389             answer->i_status = 200;
390             httpd_MsgAdd( answer, "Content-Type",  "%s", "application/sdp" );
391             httpd_MsgAdd( answer, "Content-Base",  "%s", control );
392             answer->p_body = (uint8_t *)ptr;
393             answer->i_body = strlen( ptr );
394             break;
395         }
396
397         case HTTPD_MSG_SETUP:
398             /* Non-aggregate-only */
399             if( id == NULL )
400             {
401                 answer->i_status = 459;
402                 break;
403             }
404
405             psz_session = httpd_MsgGet( query, "Session" );
406             answer->i_status = 461;
407
408             for( const char *tpt = httpd_MsgGet( query, "Transport" );
409                  tpt != NULL;
410                  tpt = transport_next( tpt ) )
411             {
412                 vlc_bool_t b_multicast = VLC_TRUE, b_unsupp = VLC_FALSE;
413                 unsigned loport = 5004, hiport = 5005; /* from RFC3551 */
414
415                 /* Check transport protocol. */
416                 /* Currently, we only support RTP/AVP over UDP */
417                 if( strncmp( tpt, "RTP/AVP", 7 ) )
418                     continue;
419                 tpt += 7;
420                 if( strncmp( tpt, "/UDP", 4 ) == 0 )
421                     tpt += 4;
422                 if( strchr( ";,", *tpt ) == NULL )
423                     continue;
424
425                 /* Parse transport options */
426                 for( const char *opt = parameter_next( tpt );
427                      opt != NULL;
428                      opt = parameter_next( opt ) )
429                 {
430                     if( strncmp( opt, "multicast", 9 ) == 0)
431                         b_multicast = VLC_TRUE;
432                     else
433                     if( strncmp( opt, "unicast", 7 ) == 0 )
434                         b_multicast = VLC_FALSE;
435                     else
436                     if( sscanf( opt, "client_port=%u-%u", &loport, &hiport )
437                                 == 2 )
438                         ;
439                     else
440                     if( strncmp( opt, "mode=", 5 ) == 0 )
441                     {
442                         if( strncasecmp( opt + 5, "play", 4 )
443                          && strncasecmp( opt + 5, "\"PLAY\"", 6 ) )
444                         {
445                             /* Not playing?! */
446                             b_unsupp = VLC_TRUE;
447                             break;
448                         }
449                     }
450                     else
451                     if( strncmp( opt,"destination=", 12 ) == 0 )
452                     {
453                         answer->i_status = 403;
454                         b_unsupp = VLC_TRUE;
455                     }
456                     else
457                     {
458                     /*
459                      * Every other option is unsupported:
460                      *
461                      * "source" and "append" are invalid (server-only);
462                      * "ssrc" also (as clarified per RFC2326bis).
463                      *
464                      * For multicast, "port", "layers", "ttl" are set by the
465                      * stream output configuration.
466                      *
467                      * For unicast, we want to decide "server_port" values.
468                      *
469                      * "interleaved" is not implemented.
470                      */
471                         b_unsupp = VLC_TRUE;
472                         break;
473                     }
474                 }
475
476                 if( b_unsupp )
477                     continue;
478
479                 if( b_multicast )
480                 {
481                     const char *dst = id->dst;
482                     if( dst == NULL )
483                         continue;
484
485                     if( psz_session == NULL )
486                     {
487                         /* Create a dummy session ID */
488                         snprintf( psz_sesbuf, sizeof( psz_sesbuf ), "%d",
489                                   rand() );
490                         psz_session = psz_sesbuf;
491                     }
492                     answer->i_status = 200;
493
494                     httpd_MsgAdd( answer, "Transport",
495                                   "RTP/AVP/UDP;destination=%s;port=%u-%u;"
496                                   "ttl=%d;mode=play",
497                                   dst, id->loport, id->hiport,
498                                   ( id->ttl > 0 ) ? id->ttl : 1 );
499                 }
500                 else
501                 {
502                     char ip[NI_MAXNUMERICHOST], src[NI_MAXNUMERICHOST];
503                     rtsp_session_t *ses = NULL;
504                     rtsp_strack_t track = { id->sout_id, -1, VLC_FALSE };
505                     int sport;
506
507                     if( httpd_ClientIP( cl, ip ) == NULL )
508                     {
509                         answer->i_status = 500;
510                         continue;
511                     }
512
513                     track.fd = net_ConnectDgram( p_stream, ip, loport, -1,
514                                                  IPPROTO_UDP );
515                     if( track.fd == -1 )
516                     {
517                         msg_Err( p_stream,
518                                  "cannot create RTP socket for %s port %u",
519                                  ip, loport );
520                         answer->i_status = 500;
521                         continue;
522                     }
523
524                     net_GetSockAddress( track.fd, src, &sport );
525
526                     vlc_mutex_lock( &rtsp->lock );
527                     if( psz_session == NULL )
528                     {
529                         ses = RtspClientNew( rtsp );
530                         snprintf( psz_sesbuf, sizeof( psz_sesbuf ), I64Fx,
531                                   ses->id );
532                         psz_session = psz_sesbuf;
533                     }
534                     else
535                     {
536                         /* FIXME: we probably need to remove an access out,
537                          * if there is already one for the same ID */
538                         ses = RtspClientGet( rtsp, psz_session );
539                         if( ses == NULL )
540                         {
541                             answer->i_status = 454;
542                             vlc_mutex_unlock( &rtsp->lock );
543                             continue;
544                         }
545                     }
546
547                     INSERT_ELEM( ses->trackv, ses->trackc, ses->trackc,
548                                  track );
549                     vlc_mutex_unlock( &rtsp->lock );
550
551                     httpd_ServerIP( cl, ip );
552
553                     if( strcmp( src, ip ) )
554                     {
555                         /* Specify source IP if it is different from the RTSP
556                          * control connection server address */
557                         char *ptr = strchr( src, '%' );
558                         if( ptr != NULL ) *ptr = '\0'; /* remove scope ID */
559
560                         httpd_MsgAdd( answer, "Transport",
561                                       "RTP/AVP/UDP;unicast;source=%s;"
562                                       "client_port=%u-%u;server_port=%u-%u;"
563                                       "mode=play",
564                                       src, loport, loport + 1, sport,
565                                       sport + 1 );
566                     }
567                     else
568                     {
569                         httpd_MsgAdd( answer, "Transport",
570                                       "RTP/AVP/UDP;unicast;"
571                                       "client_port=%u-%u;server_port=%u-%u;"
572                                       "mode=play",
573                                       loport, loport + 1, sport, sport + 1 );
574                     }
575
576                     answer->i_status = 200;
577                 }
578                 break;
579             }
580             break;
581
582         case HTTPD_MSG_PLAY:
583         {
584             rtsp_session_t *ses;
585             answer->i_status = 200;
586
587             psz_session = httpd_MsgGet( query, "Session" );
588             if( httpd_MsgGet( query, "Range" ) != NULL )
589             {
590                 answer->i_status = 456; /* cannot seek */
591                 break;
592             }
593
594             vlc_mutex_lock( &rtsp->lock );
595             ses = RtspClientGet( rtsp, psz_session );
596             if( ses != NULL )
597             {
598                 for( int i = 0; i < ses->trackc; i++ )
599                 {
600                     rtsp_strack_t *tr = ses->trackv + i;
601                     if( !tr->playing
602                      && ( ( id == NULL ) || ( tr->id == id->sout_id ) ) )
603                     {
604                         tr->playing = VLC_TRUE;
605                         rtp_add_sink( tr->id, tr->fd, VLC_FALSE );
606                     }
607                 }
608             }
609             vlc_mutex_unlock( &rtsp->lock );
610
611             if( httpd_MsgGet( query, "Scale" ) != NULL )
612                 httpd_MsgAdd( answer, "Scale", "1." );
613             break;
614         }
615
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" );
621             break;
622
623         case HTTPD_MSG_GETPARAMETER:
624             if( query->i_body > 0 )
625             {
626                 answer->i_status = 451;
627                 break;
628             }
629
630             psz_session = httpd_MsgGet( query, "Session" );
631             answer->i_status = 200;
632             break;
633
634         case HTTPD_MSG_TEARDOWN:
635         {
636             rtsp_session_t *ses;
637
638             answer->i_status = 200;
639
640             psz_session = httpd_MsgGet( query, "Session" );
641
642             vlc_mutex_lock( &rtsp->lock );
643             ses = RtspClientGet( rtsp, psz_session );
644             if( ses != NULL )
645             {
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++ )
650                 {
651                     if( ses->trackv[i].id == id->sout_id )
652                     {
653                         rtp_del_sink( id->sout_id, ses->trackv[i].fd );
654                         REMOVE_ELEM( ses->trackv, ses->trackc, i );
655                     }
656                 }
657             }
658             vlc_mutex_unlock( &rtsp->lock );
659             break;
660         }
661
662         default:
663             return VLC_EGENERIC;
664     }
665
666     httpd_MsgAdd( answer, "Server", "%s", PACKAGE_STRING );
667     if( psz_session )
668         httpd_MsgAdd( answer, "Session", "%s"/*;timeout=5*/, psz_session );
669
670     httpd_MsgAdd( answer, "Content-Length", "%d", answer->i_body );
671     httpd_MsgAdd( answer, "Cache-Control", "no-cache" );
672
673     psz = httpd_MsgGet( query, "Cseq" );
674     if( psz != NULL )
675         httpd_MsgAdd( answer, "Cseq", "%s", psz );
676     psz = httpd_MsgGet( query, "Timestamp" );
677     if( psz != NULL )
678         httpd_MsgAdd( answer, "Timestamp", "%s", psz );
679
680     return VLC_SUCCESS;
681 }
682
683
684 /** Aggregate RTSP callback */
685 static int RtspCallback( httpd_callback_sys_t *p_args,
686                          httpd_client_t *cl,
687                          httpd_message_t *answer,
688                          const httpd_message_t *query )
689 {
690     return RtspHandler( (rtsp_stream_t *)p_args, NULL, cl, answer, query );
691 }
692
693
694 /** Non-aggregate RTSP callback */
695 static int RtspCallbackId( httpd_callback_sys_t *p_args,
696                            httpd_client_t *cl,
697                            httpd_message_t *answer,
698                            const httpd_message_t *query )
699 {
700     rtsp_stream_id_t *id = (rtsp_stream_id_t *)p_args;
701     return RtspHandler( id->stream, id, cl, answer, query );
702 }