1 /*****************************************************************************
2 * sap.c : SAP announce handler
3 *****************************************************************************
4 * Copyright (C) 2002-2005 the VideoLAN team
7 * Authors: Clément Stenac <zorglub@videolan.org>
8 * Rémi Denis-Courmont <rem # videolan.org>
10 * This program is free software; you can redistribute it and/or modify
11 * it under the terms of the GNU General Public License as published by
12 * the Free Software Foundation; either version 2 of the License, or
13 * (at your option) any later version.
15 * This program is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 * GNU General Public License for more details.
20 * You should have received a copy of the GNU General Public License
21 * along with this program; if not, write to the Free Software
22 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111, USA.
23 *****************************************************************************/
25 /*****************************************************************************
27 *****************************************************************************/
28 #include <stdlib.h> /* free() */
29 #include <stdio.h> /* sprintf() */
30 #include <string.h> /* strerror() */
31 #include <ctype.h> /* tolower(), isxdigit() */
37 #if defined( WIN32 ) || defined( UNDER_CE )
38 # if defined(UNDER_CE) && defined(sockaddr_storage)
39 # undef sockaddr_storage
41 # include <winsock2.h>
42 # include <ws2tcpip.h>
48 /* SAP is always on that port */
51 #define DEFAULT_PORT "1234"
55 /* SAP Specific structures */
58 #define SAP_IDLE ((mtime_t)(0.100*CLOCK_FREQ))
59 #define SAP_MAX_BUFFER 65534
60 #define MIN_INTERVAL 2
61 #define MAX_INTERVAL 300
63 /* A SAP announce address. For each of these, we run the
64 * control flow algorithm */
68 char psz_machine[NI_MAXNUMERICHOST];
70 int i_rfd; /* Read socket */
71 int i_wfd; /* Write socket */
73 /* Used for flow control */
82 /*****************************************************************************
84 *****************************************************************************/
85 static void RunThread( vlc_object_t *p_this);
86 static int CalculateRate( sap_handler_t *p_sap, sap_address_t *p_address );
87 static char *SDPGenerate( sap_handler_t *p_sap,
88 const session_descriptor_t *p_session,
89 const sap_address_t *p_addr );
91 static int announce_SendSAPAnnounce( sap_handler_t *p_sap,
92 sap_session_t *p_session );
95 static int announce_SAPAnnounceAdd( sap_handler_t *p_sap,
96 session_descriptor_t *p_session );
98 static int announce_SAPAnnounceDel( sap_handler_t *p_sap,
99 session_descriptor_t *p_session );
100 static char *convert_to_utf8( struct sap_handler_t *p_this, char *psz_local );
102 #define FREE( p ) if( p ) { free( p ); (p) = NULL; }
106 * Create the SAP handler
108 * \param p_announce the parent announce_handler
109 * \return the newly created SAP handler or NULL on error
111 sap_handler_t *announce_SAPHandlerCreate( announce_handler_t *p_announce )
113 sap_handler_t *p_sap;
116 p_sap = vlc_object_create( p_announce, sizeof( sap_handler_t ) );
120 msg_Err( p_announce, "out of memory" );
124 vlc_mutex_init( p_sap, &p_sap->object_lock );
126 vlc_current_charset( &psz_charset );
127 p_sap->iconvHandle = vlc_iconv_open( "UTF-8", psz_charset );
129 if( p_sap->iconvHandle == (vlc_iconv_t)(-1) )
130 msg_Warn( p_sap, "Unable to do requested conversion" );
132 p_sap->pf_add = announce_SAPAnnounceAdd;
133 p_sap->pf_del = announce_SAPAnnounceDel;
135 p_sap->i_sessions = 0;
136 p_sap->i_addresses = 0;
137 p_sap->i_current_session = 0;
139 p_sap->b_control = config_GetInt( p_sap, "sap-flow-control");
141 if( vlc_thread_create( p_sap, "sap handler", RunThread,
142 VLC_THREAD_PRIORITY_LOW, VLC_FALSE ) )
144 msg_Dbg( p_announce, "Unable to spawn SAP handler thread");
148 msg_Dbg( p_announce, "thread created, %i sessions", p_sap->i_sessions);
153 * Destroy the SAP handler
154 * \param p_this the SAP Handler to destroy
157 void announce_SAPHandlerDestroy( sap_handler_t *p_sap )
161 vlc_mutex_destroy( &p_sap->object_lock );
163 /* Free the remaining sessions */
164 for( i = 0 ; i< p_sap->i_sessions ; i++)
166 sap_session_t *p_session = p_sap->pp_sessions[i];
167 FREE( p_session->psz_sdp );
168 FREE( p_session->psz_data );
169 REMOVE_ELEM( p_sap->pp_sessions, p_sap->i_sessions , i );
173 /* Free the remaining addresses */
174 for( i = 0 ; i< p_sap->i_addresses ; i++)
176 sap_address_t *p_address = p_sap->pp_addresses[i];
177 FREE( p_address->psz_address );
178 if( p_address->i_rfd > -1 )
180 net_Close( p_address->i_rfd );
182 if( p_address->i_wfd > -1 && p_sap->b_control )
184 net_Close( p_address->i_wfd );
186 REMOVE_ELEM( p_sap->pp_addresses, p_sap->i_addresses, i );
190 if( p_sap->iconvHandle != (vlc_iconv_t)(-1) )
191 vlc_iconv_close( p_sap->iconvHandle );
193 /* Free the structure */
194 vlc_object_destroy( p_sap );
198 * main SAP handler thread
199 * \param p_this the SAP Handler object
202 static void RunThread( vlc_object_t *p_this)
204 sap_handler_t *p_sap = (sap_handler_t*)p_this;
205 sap_session_t *p_session;
207 while( !p_sap->b_die )
211 /* If needed, get the rate info */
212 if( p_sap->b_control == VLC_TRUE )
214 for( i = 0 ; i< p_sap->i_addresses ; i++)
216 if( p_sap->pp_addresses[i]->b_enabled == VLC_TRUE )
218 CalculateRate( p_sap, p_sap->pp_addresses[i] );
223 /* Find the session to announce */
224 vlc_mutex_lock( &p_sap->object_lock );
225 if( p_sap->i_sessions > p_sap->i_current_session + 1)
227 p_sap->i_current_session++;
229 else if( p_sap->i_sessions > 0)
231 p_sap->i_current_session = 0;
235 vlc_mutex_unlock( &p_sap->object_lock );
239 p_session = p_sap->pp_sessions[p_sap->i_current_session];
240 vlc_mutex_unlock( &p_sap->object_lock );
242 /* And announce it */
243 if( p_session->p_address->b_enabled == VLC_TRUE &&
244 p_session->p_address->b_ready == VLC_TRUE )
246 announce_SendSAPAnnounce( p_sap, p_session );
253 /* Add a SAP announce */
254 static int announce_SAPAnnounceAdd( sap_handler_t *p_sap,
255 session_descriptor_t *p_session )
257 int i_header_size, i;
258 char *psz_head, psz_addr[NI_MAXNUMERICHOST];
259 vlc_bool_t b_ipv6 = VLC_FALSE;
260 sap_session_t *p_sap_session;
262 struct addrinfo hints, *res;
263 struct sockaddr_storage addr;
265 vlc_mutex_lock( &p_sap->object_lock );
267 if( p_session->psz_uri == NULL )
269 vlc_mutex_unlock( &p_sap->object_lock );
270 msg_Err( p_sap, "*FIXME* Unexpected NULL URI for SAP announce" );
271 msg_Err( p_sap, "This should not happen. VLC needs fixing." );
275 /* Determine SAP multicast address automatically */
276 memset( &hints, 0, sizeof( hints ) );
277 hints.ai_socktype = SOCK_DGRAM;
278 hints.ai_flags = AI_NUMERICHOST;
280 i = vlc_getaddrinfo( (vlc_object_t *)p_sap, p_session->psz_uri, 0,
284 vlc_mutex_unlock( &p_sap->object_lock );
285 msg_Err( p_sap, "Invalid URI for SAP announce: %s: %s",
286 p_session->psz_uri, vlc_gai_strerror( i ) );
290 if( (unsigned)res->ai_addrlen > sizeof( addr ) )
292 vlc_mutex_unlock( &p_sap->object_lock );
293 vlc_freeaddrinfo( res );
294 msg_Err( p_sap, "Unsupported address family of size %d > %u",
295 res->ai_addrlen, sizeof( addr ) );
299 memcpy( &addr, res->ai_addr, res->ai_addrlen );
301 switch( addr.ss_family )
303 #if defined (INET_PTON) || defined (WIN32)
306 /* See RFC3513 for list of valid IPv6 scopes */
307 struct in6_addr *a6 = &((struct sockaddr_in6 *)&addr)->sin6_addr;
309 memcpy( a6->s6_addr + 2, "\x00\x00\x00\x00\x00\x00"
310 "\x00\x00\x00\x00\x00\x02\x7f\xfe", 14 );
311 if( IN6_IS_ADDR_MULTICAST( a6 ) )
312 /* force flags to zero, preserve scope */
313 a6->s6_addr[1] &= 0xf;
315 /* Unicast IPv6 - assume global scope */
316 memcpy( a6->s6_addr, "\xff\x0e", 2 );
325 /* See RFC2365 for IPv4 scopes */
328 ipv4 = ntohl( ((struct sockaddr_in *)&addr)->sin_addr.s_addr );
329 /* 224.0.0.0/24 => 224.0.0.255 */
330 if ((ipv4 & 0xffffff00) == 0xe0000000)
333 /* 239.255.0.0/16 => 239.255.255.255 */
334 if ((ipv4 & 0xffff0000) == 0xefff0000)
337 /* 239.192.0.0/14 => 239.195.255.255 */
338 if ((ipv4 & 0xfffc0000) == 0xefc00000)
341 /* other addresses => 224.2.127.254 */
347 vlc_mutex_unlock( &p_sap->object_lock );
348 vlc_freeaddrinfo( res );
349 msg_Err( p_sap, "Address family %d not supported by SAP",
354 i = vlc_getnameinfo( (struct sockaddr *)&addr, res->ai_addrlen,
355 psz_addr, sizeof( psz_addr ), NULL, NI_NUMERICHOST );
356 vlc_freeaddrinfo( res );
360 vlc_mutex_unlock( &p_sap->object_lock );
361 msg_Err( p_sap, "%s", vlc_gai_strerror( i ) );
365 msg_Dbg( p_sap, "using SAP address: %s", psz_addr);
367 /* XXX: Check for dupes */
368 p_sap_session = (sap_session_t*)malloc(sizeof(sap_session_t));
369 p_sap_session->p_address = NULL;
371 /* Add the address to the buffer */
372 for( i = 0; i < p_sap->i_addresses; i++)
374 if( !strcmp( psz_addr, p_sap->pp_addresses[i]->psz_address ) )
376 p_sap_session->p_address = p_sap->pp_addresses[i];
381 if( p_sap_session->p_address == NULL )
383 sap_address_t *p_address = (sap_address_t *)
384 malloc( sizeof(sap_address_t) );
387 msg_Err( p_sap, "out of memory" );
390 p_address->psz_address = strdup( psz_addr );
391 p_address->i_port = 9875;
392 p_address->i_wfd = net_OpenUDP( p_sap, "", 0, psz_addr,
394 if( p_address->i_wfd != -1 )
398 net_StopRecv( p_address->i_wfd );
399 net_GetSockAddress( p_sap, p_address->i_wfd,
400 p_address->psz_machine, NULL );
402 /* removes scope if present */
403 ptr = strchr( p_address->psz_machine, '%' );
408 if( p_sap->b_control == VLC_TRUE )
410 p_address->i_rfd = net_OpenUDP( p_sap, psz_addr,
411 p_address->i_port, "", 0 );
412 if( p_address->i_rfd != -1 )
413 net_StopSend( p_address->i_rfd );
414 p_address->i_buff = 0;
415 p_address->b_enabled = VLC_TRUE;
416 p_address->b_ready = VLC_FALSE;
417 p_address->i_limit = 10000; /* 10000 bps */
422 p_address->b_enabled = VLC_TRUE;
423 p_address->b_ready = VLC_TRUE;
424 p_address->i_interval = config_GetInt( p_sap,"sap-interval");
425 p_address->i_rfd = -1;
428 if( p_address->i_wfd == -1 || (p_address->i_rfd == -1
429 && p_sap->b_control ) )
431 msg_Warn( p_sap, "disabling address" );
432 p_address->b_enabled = VLC_FALSE;
435 INSERT_ELEM( p_sap->pp_addresses,
439 p_sap_session->p_address = p_address;
443 /* Build the SAP Headers */
444 i_header_size = ( b_ipv6 ? 16 : 4 ) + 20;
445 psz_head = (char *) malloc( i_header_size * sizeof( char ) );
446 if( psz_head == NULL )
448 msg_Err( p_sap, "out of memory" );
452 /* SAPv1, not encrypted, not compressed */
453 psz_head[0] = b_ipv6 ? 0x30 : 0x20;
454 psz_head[1] = 0x00; /* No authentification length */
457 psz_head[2] = (i_hash & 0xFF00) >> 8; /* Msg id hash */
458 psz_head[3] = (i_hash & 0xFF); /* Msg id hash 2 */
460 inet_pton( b_ipv6 ? AF_INET6 : AF_INET, /* can't fail */
461 p_sap_session->p_address->psz_machine, psz_head + 4 );
463 memcpy( psz_head + (b_ipv6 ? 20 : 8), "application/sdp", 15 );
465 /* If needed, build the SDP */
466 if( p_session->psz_sdp == NULL )
468 p_session->psz_sdp = SDPGenerate( p_sap, p_session,
469 p_sap_session->p_address );
470 if( p_session->psz_sdp == NULL )
472 vlc_mutex_unlock( &p_sap->object_lock );
477 p_sap_session->psz_sdp = strdup( p_session->psz_sdp );
478 p_sap_session->i_last = 0;
480 psz_head[ i_header_size-1 ] = '\0';
481 p_sap_session->i_length = i_header_size + strlen( p_sap_session->psz_sdp);
483 p_sap_session->psz_data = (uint8_t *)malloc( sizeof(char)*
484 p_sap_session->i_length );
486 /* Build the final message */
487 memcpy( p_sap_session->psz_data, psz_head, i_header_size );
488 memcpy( p_sap_session->psz_data+i_header_size, p_sap_session->psz_sdp,
489 strlen( p_sap_session->psz_sdp) );
493 /* Enqueue the announce */
494 INSERT_ELEM( p_sap->pp_sessions,
498 msg_Dbg( p_sap,"Addresses: %i Sessions: %i",
499 p_sap->i_addresses,p_sap->i_sessions);
501 /* Remember the SAP session for later deletion */
502 p_session->p_sap = p_sap_session;
504 vlc_mutex_unlock( &p_sap->object_lock );
509 /* Remove a SAP Announce */
510 static int announce_SAPAnnounceDel( sap_handler_t *p_sap,
511 session_descriptor_t *p_session )
514 vlc_mutex_lock( &p_sap->object_lock );
516 msg_Dbg( p_sap,"removing SAP announce %p",p_session->p_sap);
518 /* Dequeue the announce */
519 for( i = 0; i< p_sap->i_sessions; i++)
521 if( p_session->p_sap == p_sap->pp_sessions[i] )
523 REMOVE_ELEM( p_sap->pp_sessions,
527 FREE( p_session->p_sap->psz_sdp );
528 FREE( p_session->p_sap->psz_data );
529 free( p_session->p_sap );
534 /* XXX: Dequeue the address too if it is not used anymore
535 * TODO: - address refcount
536 - send a SAP deletion packet */
538 msg_Dbg( p_sap,"%i announces remaining", p_sap->i_sessions );
540 vlc_mutex_unlock( &p_sap->object_lock );
545 static int announce_SendSAPAnnounce( sap_handler_t *p_sap,
546 sap_session_t *p_session )
550 /* This announce has never been sent yet */
551 if( p_session->i_last == 0 )
553 p_session->i_next = mdate()+ p_session->p_address->i_interval*1000000;
554 p_session->i_last = 1;
558 if( p_session->i_next < mdate() )
561 msg_Dbg( p_sap, "Sending announce");
563 i_ret = net_Write( p_sap, p_session->p_address->i_wfd, NULL,
565 p_session->i_length );
566 if( i_ret != (int)p_session->i_length )
568 msg_Warn( p_sap, "SAP send failed on address %s (%i %i)",
569 p_session->p_address->psz_address,
570 i_ret, p_session->i_length );
572 p_session->i_last = p_session->i_next;
573 p_session->i_next = p_session->i_last
574 + p_session->p_address->i_interval*1000000;
583 static char *SDPGenerate( sap_handler_t *p_sap,
584 const session_descriptor_t *p_session,
585 const sap_address_t *p_addr )
587 int64_t i_sdp_id = mdate();
588 int i_sdp_version = 1 + p_sap->i_sessions + (rand()&0xfff);
589 char *psz_group, *psz_name, psz_uribuf[NI_MAXNUMERICHOST], *psz_uri,
593 psz_group = convert_to_utf8( p_sap, p_session->psz_group );
594 psz_name = convert_to_utf8( p_sap, p_session->psz_name );
595 if( psz_name == NULL )
601 /* FIXME: really check that psz_uri is a real IP address
602 * FIXME: make a common function to obtain a canonical IP address */
603 ipv = ( strchr( p_session->psz_uri, ':' ) != NULL) ? '6' : '4';
604 if( *p_session->psz_uri == '[' )
608 strncpy( psz_uribuf, p_session->psz_uri + 1, sizeof( psz_uribuf ) );
609 psz_uribuf[sizeof( psz_uribuf ) - 1] = '\0';
610 ptr = strchr( psz_uribuf, '%' );
613 ptr = strchr( psz_uribuf, ']' );
616 psz_uri = psz_uribuf;
619 psz_uri = p_session->psz_uri;
621 /* see the lists in modules/stream_out/rtp.c for compliance stuff */
622 if( asprintf( &psz_sdp,
624 "o=- "I64Fd" %d IN IP%c %s\r\n"
627 "c=IN IP%c %s/%d\r\n"
628 "m=video %d udp %d\r\n"
629 "a=tool:"PACKAGE_STRING"\r\n"
630 "a=type:broadcast\r\n",
631 i_sdp_id, i_sdp_version,
632 ipv, p_addr->psz_machine,
634 psz_uri, p_session->i_ttl,
635 p_session->i_port, p_session->i_payload ) == -1 )
646 /* FIXME: this is illegal use of sprintf */
647 sprintf( psz_sdp, "%sa=x-plgroup:%s\r\n", psz_sdp, psz_group );
651 msg_Dbg( p_sap, "Generated SDP (%i bytes):\n%s", strlen(psz_sdp),
656 static int CalculateRate( sap_handler_t *p_sap, sap_address_t *p_address )
659 uint8_t buffer[SAP_MAX_BUFFER];
664 if( p_address->t1 == 0 )
666 p_address->t1 = mdate();
671 /* Might be too slow if we have huge data */
672 i_read = net_ReadNonBlock( p_sap, p_address->i_rfd, NULL, buffer,
675 } while( i_read > 0 && i_tot < SAP_MAX_BUFFER );
679 /* We calculate the rate every 5 seconds */
680 if( i_temp - p_address->t1 < 5000000 )
682 p_address->i_buff += i_tot;
687 i_rate = (int)(8*1000000*((mtime_t)p_address->i_buff + (mtime_t)i_tot ) /
688 (i_temp - p_address->t1 ));
690 p_address->i_limit = 10000;
692 p_address->i_interval = ((1000*i_rate / p_address->i_limit) *
693 (MAX_INTERVAL - MIN_INTERVAL))/1000 + MIN_INTERVAL;
695 if( p_address->i_interval > MAX_INTERVAL || p_address->i_interval < 0 )
697 p_address->i_interval = MAX_INTERVAL;
700 msg_Dbg( p_sap,"%s:%i : Rate=%i, Interval = %i s",
701 p_address->psz_address,p_address->i_port,
703 p_address->i_interval );
706 p_address->b_ready = VLC_TRUE;
708 p_address->t1 = i_temp;
709 p_address->i_buff = 0;
715 static char *convert_to_utf8( struct sap_handler_t *p_this, char *psz_local )
717 char *psz_unicode, *psz_in, *psz_out;
718 size_t ret, i_in, i_out;
720 if( psz_local == NULL )
722 if ( p_this->iconvHandle == (vlc_iconv_t)(-1) )
723 return strdup( psz_local );
726 i_in = strlen( psz_local );
729 psz_unicode = malloc( i_out + 1 );
730 if( psz_unicode == NULL )
731 return strdup( psz_local );
732 psz_out = psz_unicode;
734 ret = vlc_iconv( p_this->iconvHandle,
735 &psz_in, &i_in, &psz_out, &i_out);
736 if( ret == (size_t)(-1) || i_in )
738 msg_Warn( p_this, "Failed to convert \"%s\" to UTF-8", psz_local );
739 return strdup( psz_local );