1 /*****************************************************************************
2 * rtsp.c: minimalistic implementation of rtsp protocol.
3 * Not RFC 2326 compilant yet and only handle REAL RTSP.
4 *****************************************************************************
5 * Copyright (C) 2002-2004 the xine project
6 * Copyright (C) 2005 VideoLAN
9 * Authors: Gildas Bazin <gbazin@videolan.org>
10 * Adapted from xine which itself adapted it from joschkas real tools.
12 * This program is free software; you can redistribute it and/or modify
13 * it under the terms of the GNU General Public License as published by
14 * the Free Software Foundation; either version 2 of the License, or
15 * (at your option) any later version.
17 * This program is distributed in the hope that it will be useful,
18 * but WITHOUT ANY WARRANTY; without even the implied warranty of
19 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20 * GNU General Public License for more details.
22 * You should have received a copy of the GNU General Public License
23 * along with this program; if not, write to the Free Software
24 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
25 *****************************************************************************/
31 #include <vlc_common.h>
36 #define HEADER_SIZE 1024
37 #define MAX_FIELDS 256
50 unsigned int server_state;
56 char *answers[MAX_FIELDS]; /* data of last message */
57 char *scheduled[MAX_FIELDS]; /* will be sent with next message */
64 const char rtsp_protocol_version[]="RTSP/1.0";
67 #define RTSP_CONNECTED 1
70 #define RTSP_PLAYING 8
71 #define RTSP_RECORDING 16
73 /* server capabilities */
74 #define RTSP_OPTIONS 0x001
75 #define RTSP_DESCRIBE 0x002
76 #define RTSP_ANNOUNCE 0x004
77 #define RTSP_SETUP 0x008
78 #define RTSP_GET_PARAMETER 0x010
79 #define RTSP_SET_PARAMETER 0x020
80 #define RTSP_TEARDOWN 0x040
81 #define RTSP_PLAY 0x080
82 #define RTSP_RECORD 0x100
85 * rtsp_get gets a line from stream
86 * and returns a null terminated string (must be freed).
89 static char *rtsp_get( rtsp_client_t *rtsp )
91 char *psz_buffer = malloc( BUF_SIZE );
92 char *psz_string = NULL;
94 if( rtsp->pf_read_line( rtsp->p_userdata, (uint8_t*)psz_buffer, (unsigned int)BUF_SIZE ) >= 0 )
96 //printf( "<< '%s'\n", psz_buffer );
97 psz_string = strdup( psz_buffer );
106 * rtsp_put puts a line on stream
109 static int rtsp_put( rtsp_client_t *rtsp, const char *psz_string )
111 unsigned int i_buffer = strlen( psz_string );
112 char *psz_buffer = malloc( i_buffer + 3 );
115 strcpy( psz_buffer, psz_string );
116 psz_buffer[i_buffer] = '\r'; psz_buffer[i_buffer+1] = '\n';
117 psz_buffer[i_buffer+2] = 0;
119 i_ret = rtsp->pf_write( rtsp->p_userdata, (uint8_t*)psz_buffer, i_buffer + 2 );
126 * extract server status code
129 static int rtsp_get_status_code( rtsp_client_t *rtsp, const char *psz_string )
134 if( !strncmp( psz_string, "RTSP/1.0", sizeof("RTSP/1.0") - 1 ) )
136 memcpy( psz_buffer, psz_string + sizeof("RTSP/1.0"), 3 );
138 i_code = atoi( psz_buffer );
140 else if( !strncmp( psz_string, "SET_PARAMETER", 8 ) )
142 return RTSP_STATUS_SET_PARAMETER;
147 //fprintf( stderr, "librtsp: server responds: '%s'\n", psz_string );
157 static int rtsp_send_request( rtsp_client_t *rtsp, const char *psz_type,
158 const char *psz_what )
160 char **ppsz_payload = rtsp->p_private->scheduled;
164 psz_buffer = malloc( strlen(psz_type) + strlen(psz_what) +
165 sizeof("RTSP/1.0") + 2 );
167 sprintf( psz_buffer, "%s %s %s", psz_type, psz_what, "RTSP/1.0" );
168 i_ret = rtsp_put( rtsp, psz_buffer );
172 while( *ppsz_payload )
174 rtsp_put( rtsp, *ppsz_payload );
177 rtsp_put( rtsp, "" );
178 rtsp_unschedule_all( rtsp );
184 * schedule standard fields
187 static void rtsp_schedule_standard( rtsp_client_t *rtsp )
191 sprintf( tmp, "Cseq: %u", rtsp->p_private->cseq);
192 rtsp_schedule_field( rtsp, tmp );
194 if( rtsp->p_private->session )
197 buf = malloc( strlen(rtsp->p_private->session) + 15 );
198 sprintf( buf, "Session: %s", rtsp->p_private->session );
199 rtsp_schedule_field( rtsp, buf );
205 * get the answers, if server responses with something != 200, return NULL
208 static int rtsp_get_answers( rtsp_client_t *rtsp )
211 unsigned int answer_seq;
212 char **answer_ptr = rtsp->p_private->answers;
216 answer = rtsp_get( rtsp );
217 if( !answer ) return 0;
218 code = rtsp_get_status_code( rtsp, answer );
221 rtsp_free_answers( rtsp );
223 do { /* while we get answer lines */
225 answer = rtsp_get( rtsp );
226 if( !answer ) return 0;
228 if( !strncasecmp( answer, "Cseq:", 5 ) )
230 sscanf( answer, "%*s %u", &answer_seq );
231 if( rtsp->p_private->cseq != answer_seq )
233 //fprintf( stderr, "warning: Cseq mismatch. got %u, assumed %u",
234 // answer_seq, rtsp->p_private->cseq );
236 rtsp->p_private->cseq = answer_seq;
239 if( !strncasecmp( answer, "Server:", 7 ) )
241 char *buf = malloc( strlen(answer) );
242 sscanf( answer, "%*s %s", buf );
243 free( rtsp->p_private->server );
244 rtsp->p_private->server = buf;
246 if( !strncasecmp( answer, "Session:", 8 ) )
248 char *buf = malloc( strlen(answer) );
249 sscanf( answer, "%*s %s", buf );
250 if( rtsp->p_private->session )
252 if( strcmp( buf, rtsp->p_private->session ) )
255 // "rtsp: warning: setting NEW session: %s\n", buf );
256 free( rtsp->p_private->session );
257 rtsp->p_private->session = strdup( buf );
262 //fprintf( stderr, "setting session id to: %s\n", buf );
263 rtsp->p_private->session = strdup( buf );
268 *answer_ptr = answer;
270 } while( (strlen(answer) != 0) && (++ans_count < MAX_FIELDS) );
272 rtsp->p_private->cseq++;
275 rtsp_schedule_standard( rtsp );
284 int rtsp_send_ok( rtsp_client_t *rtsp )
288 rtsp_put( rtsp, "RTSP/1.0 200 OK" );
289 sprintf( cseq, "CSeq: %u", rtsp->p_private->cseq );
290 rtsp_put( rtsp, cseq );
291 rtsp_put( rtsp, "" );
296 * implementation of must-have rtsp requests; functions return
297 * server status code.
300 int rtsp_request_options( rtsp_client_t *rtsp, const char *what )
304 if( what ) buf = strdup(what);
307 buf = malloc( strlen(rtsp->p_private->host) + 16 );
308 sprintf( buf, "rtsp://%s:%i", rtsp->p_private->host,
309 rtsp->p_private->port );
311 rtsp_send_request( rtsp, "OPTIONS", buf );
314 return rtsp_get_answers( rtsp );
317 int rtsp_request_describe( rtsp_client_t *rtsp, const char *what )
327 buf = malloc( strlen(rtsp->p_private->host) +
328 strlen(rtsp->p_private->path) + 16 );
329 sprintf( buf, "rtsp://%s:%i/%s", rtsp->p_private->host,
330 rtsp->p_private->port, rtsp->p_private->path );
332 rtsp_send_request( rtsp, "DESCRIBE", buf );
335 return rtsp_get_answers( rtsp );
338 int rtsp_request_setup( rtsp_client_t *rtsp, const char *what )
340 rtsp_send_request( rtsp, "SETUP", what );
341 return rtsp_get_answers( rtsp );
344 int rtsp_request_setparameter( rtsp_client_t *rtsp, const char *what )
354 buf = malloc( strlen(rtsp->p_private->host) +
355 strlen(rtsp->p_private->path) + 16 );
356 sprintf( buf, "rtsp://%s:%i/%s", rtsp->p_private->host,
357 rtsp->p_private->port, rtsp->p_private->path );
360 rtsp_send_request( rtsp, "SET_PARAMETER", buf );
363 return rtsp_get_answers( rtsp );
366 int rtsp_request_play( rtsp_client_t *rtsp, const char *what )
372 buf = strdup( what );
376 buf = malloc( strlen(rtsp->p_private->host) +
377 strlen(rtsp->p_private->path) + 16 );
378 sprintf( buf, "rtsp://%s:%i/%s", rtsp->p_private->host,
379 rtsp->p_private->port, rtsp->p_private->path );
382 rtsp_send_request( rtsp, "PLAY", buf );
385 return rtsp_get_answers( rtsp );
388 int rtsp_request_tearoff( rtsp_client_t *rtsp, const char *what )
390 rtsp_send_request( rtsp, "TEAROFF", what );
391 return rtsp_get_answers( rtsp );
395 * read opaque data from stream
398 int rtsp_read_data( rtsp_client_t *rtsp, uint8_t *buffer, unsigned int size )
404 i = rtsp->pf_read( rtsp->p_userdata, (uint8_t*)buffer, (unsigned int) 4 );
405 if( i < 4 ) return i;
407 if( buffer[0]=='S' && buffer[1]=='E' && buffer[2]=='T' &&
410 char *rest = rtsp_get( rtsp );
411 if( !rest ) return -1;
417 rest = rtsp_get( rtsp );
418 if( !rest ) return -1;
420 if( !strncasecmp( rest, "Cseq:", 5 ) )
421 sscanf( rest, "%*s %u", &seq );
427 //fprintf(stderr, "warning: cseq not recognized!\n");
431 /* lets make the server happy */
432 rtsp_put( rtsp, "RTSP/1.0 451 Parameter Not Understood" );
434 sprintf( rest,"CSeq: %u", seq );
435 rtsp_put( rtsp, rest );
436 rtsp_put( rtsp, "" );
438 i = rtsp->pf_read( rtsp->p_userdata, (unsigned char*)buffer, size );
442 i = rtsp->pf_read( rtsp->p_userdata, (unsigned char*)buffer + 4, size - 4 );
446 else i = rtsp->pf_read( rtsp->p_userdata, (unsigned char*)buffer, size );
448 //fprintf( stderr, "<< %d of %d bytes\n", i, size );
454 * connect to a rtsp server
457 int rtsp_connect( rtsp_client_t *rtsp, const char *psz_mrl,
458 const char *psz_user_agent )
463 unsigned int hostend, pathbegin, i;
465 if( !psz_mrl ) return -1;
466 s = malloc( sizeof(rtsp_t) );
469 if( !strncmp( psz_mrl, "rtsp://", 7 ) ) psz_mrl += 7;
470 mrl_ptr = strdup( psz_mrl );
472 for( i=0; i<MAX_FIELDS; i++ )
475 s->scheduled[i]=NULL;
479 s->port = 554; /* rtsp standard port */
481 s->mrl = strdup(psz_mrl);
490 if( psz_user_agent ) s->user_agent = strdup( psz_user_agent );
491 else s->user_agent = strdup( "User-Agent: RealMedia Player Version "
492 "6.0.9.1235 (linux-2.0-libc6-i386-gcc2.95)" );
494 slash = strchr( mrl_ptr, '/' );
495 colon = strchr( mrl_ptr, ':' );
497 if( !slash ) slash = mrl_ptr + strlen(mrl_ptr) + 1;
498 if( !colon ) colon = slash;
499 if( colon > slash ) colon = slash;
501 pathbegin = slash - mrl_ptr;
502 hostend = colon - mrl_ptr;
504 s->host = malloc(hostend+1);
505 strncpy( s->host, mrl_ptr, hostend );
506 s->host[hostend] = 0;
508 if( pathbegin < strlen(mrl_ptr) ) s->path = strdup(mrl_ptr+pathbegin+1);
511 char buffer[pathbegin-hostend];
513 strncpy( buffer, mrl_ptr+hostend+1, pathbegin-hostend-1 );
514 buffer[pathbegin-hostend-1] = 0;
515 s->port = atoi(buffer);
516 if( s->port < 0 || s->port > 65535 ) s->port = 554;
520 //fprintf( stderr, "got mrl: %s %i %s\n", s->host, s->port, s->path );
522 s->s = rtsp->pf_connect( rtsp->p_userdata, s->host, s->port );
526 //fprintf(stderr, "rtsp: failed to connect to '%s'\n", s->host);
531 s->server_state = RTSP_CONNECTED;
533 /* now lets send an options request. */
534 rtsp_schedule_field( rtsp, "CSeq: 1");
535 rtsp_schedule_field( rtsp, s->user_agent);
536 rtsp_schedule_field( rtsp, "ClientChallenge: "
537 "9e26d33f2984236010ef6253fb1887f7");
538 rtsp_schedule_field( rtsp, "PlayerStarttime: [28/03/2003:22:50:23 00:00]");
539 rtsp_schedule_field( rtsp, "CompanyID: KnKV4M4I/B2FjJ1TToLycw==" );
540 rtsp_schedule_field( rtsp, "GUID: 00000000-0000-0000-0000-000000000000" );
541 rtsp_schedule_field( rtsp, "RegionData: 0" );
542 rtsp_schedule_field( rtsp, "ClientID: "
543 "Linux_2.4_6.0.9.1235_play32_RN01_EN_586" );
544 /*rtsp_schedule_field( rtsp, "Pragma: initiate-session" );*/
545 rtsp_request_options( rtsp, NULL );
551 * closes an rtsp connection
554 void rtsp_close( rtsp_client_t *rtsp )
556 if( rtsp->p_private->server_state )
558 /* TODO: send a TEAROFF */
559 rtsp->pf_disconnect( rtsp->p_userdata );
562 free( rtsp->p_private->path );
563 free( rtsp->p_private->host );
564 free( rtsp->p_private->mrl );
565 free( rtsp->p_private->session );
566 free( rtsp->p_private->user_agent );
567 free( rtsp->p_private->server );
568 rtsp_free_answers( rtsp );
569 rtsp_unschedule_all( rtsp );
570 free( rtsp->p_private );
574 * search in answers for tags. returns a pointer to the content
575 * after the first matched tag. returns NULL if no match found.
578 char *rtsp_search_answers( rtsp_client_t *rtsp, const char *tag )
583 if( !rtsp->p_private->answers ) return NULL;
584 answer = rtsp->p_private->answers;
588 if( !strncasecmp( *answer, tag, strlen(tag) ) )
590 ptr = strchr(*answer, ':');
592 while( *ptr == ' ' ) ptr++;
602 * session id management
605 void rtsp_set_session( rtsp_client_t *rtsp, const char *id )
607 free( rtsp->p_private->session );
608 rtsp->p_private->session = strdup(id);
611 char *rtsp_get_session( rtsp_client_t *rtsp )
613 return rtsp->p_private->session;
616 char *rtsp_get_mrl( rtsp_client_t *rtsp )
618 return rtsp->p_private->mrl;
622 * schedules a field for transmission
625 void rtsp_schedule_field( rtsp_client_t *rtsp, const char *string )
629 if( !string ) return;
631 while( rtsp->p_private->scheduled[i] ) i++;
633 rtsp->p_private->scheduled[i] = strdup(string);
637 * removes the first scheduled field which prefix matches string.
640 void rtsp_unschedule_field( rtsp_client_t *rtsp, const char *string )
642 char **ptr = rtsp->p_private->scheduled;
644 if( !string ) return;
648 if( !strncmp(*ptr, string, strlen(string)) ) break;
659 * unschedule all fields
662 void rtsp_unschedule_all( rtsp_client_t *rtsp )
666 if( !rtsp->p_private->scheduled ) return;
667 ptr = rtsp->p_private->scheduled;
680 void rtsp_free_answers( rtsp_client_t *rtsp )
684 if( !rtsp->p_private->answers ) return;
685 answer = rtsp->p_private->answers;