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>
45 # ifdef HAVE_ARPA_INET_H
46 # include <arpa/inet.h>
51 /* SAP is always on that port */
54 #define DEFAULT_PORT "1234"
58 /* SAP Specific structures */
61 #define SAP_IDLE ((mtime_t)(0.100*CLOCK_FREQ))
62 #define SAP_MAX_BUFFER 65534
63 #define MIN_INTERVAL 2
64 #define MAX_INTERVAL 300
66 /* A SAP announce address. For each of these, we run the
67 * control flow algorithm */
71 char psz_machine[NI_MAXNUMERICHOST];
73 int i_rfd; /* Read socket */
74 int i_wfd; /* Write socket */
76 /* Used for flow control */
85 /*****************************************************************************
87 *****************************************************************************/
88 static void RunThread( vlc_object_t *p_this);
89 static int CalculateRate( sap_handler_t *p_sap, sap_address_t *p_address );
90 static char *SDPGenerate( sap_handler_t *p_sap,
91 const session_descriptor_t *p_session,
92 const sap_address_t *p_addr );
94 static int announce_SendSAPAnnounce( sap_handler_t *p_sap,
95 sap_session_t *p_session );
98 static int announce_SAPAnnounceAdd( sap_handler_t *p_sap,
99 session_descriptor_t *p_session );
101 static int announce_SAPAnnounceDel( sap_handler_t *p_sap,
102 session_descriptor_t *p_session );
104 #define FREE( p ) if( p ) { free( p ); (p) = NULL; }
108 * Create the SAP handler
110 * \param p_announce the parent announce_handler
111 * \return the newly created SAP handler or NULL on error
113 sap_handler_t *announce_SAPHandlerCreate( announce_handler_t *p_announce )
115 sap_handler_t *p_sap;
117 p_sap = vlc_object_create( p_announce, sizeof( sap_handler_t ) );
121 msg_Err( p_announce, "out of memory" );
125 vlc_mutex_init( p_sap, &p_sap->object_lock );
127 p_sap->pf_add = announce_SAPAnnounceAdd;
128 p_sap->pf_del = announce_SAPAnnounceDel;
130 p_sap->i_sessions = 0;
131 p_sap->i_addresses = 0;
132 p_sap->i_current_session = 0;
134 p_sap->b_control = config_GetInt( p_sap, "sap-flow-control");
136 if( vlc_thread_create( p_sap, "sap handler", RunThread,
137 VLC_THREAD_PRIORITY_LOW, VLC_FALSE ) )
139 msg_Dbg( p_announce, "Unable to spawn SAP handler thread");
143 msg_Dbg( p_announce, "thread created, %i sessions", p_sap->i_sessions);
148 * Destroy the SAP handler
149 * \param p_this the SAP Handler to destroy
152 void announce_SAPHandlerDestroy( sap_handler_t *p_sap )
156 vlc_mutex_destroy( &p_sap->object_lock );
158 /* Free the remaining sessions */
159 for( i = 0 ; i< p_sap->i_sessions ; i++)
161 sap_session_t *p_session = p_sap->pp_sessions[i];
162 FREE( p_session->psz_sdp );
163 FREE( p_session->psz_data );
164 REMOVE_ELEM( p_sap->pp_sessions, p_sap->i_sessions , i );
168 /* Free the remaining addresses */
169 for( i = 0 ; i< p_sap->i_addresses ; i++)
171 sap_address_t *p_address = p_sap->pp_addresses[i];
172 FREE( p_address->psz_address );
173 if( p_address->i_rfd > -1 )
175 net_Close( p_address->i_rfd );
177 if( p_address->i_wfd > -1 && p_sap->b_control )
179 net_Close( p_address->i_wfd );
181 REMOVE_ELEM( p_sap->pp_addresses, p_sap->i_addresses, i );
185 /* Free the structure */
186 vlc_object_destroy( p_sap );
190 * main SAP handler thread
191 * \param p_this the SAP Handler object
194 static void RunThread( vlc_object_t *p_this)
196 sap_handler_t *p_sap = (sap_handler_t*)p_this;
197 sap_session_t *p_session;
199 while( !p_sap->b_die )
203 /* If needed, get the rate info */
204 if( p_sap->b_control == VLC_TRUE )
206 for( i = 0 ; i< p_sap->i_addresses ; i++)
208 if( p_sap->pp_addresses[i]->b_enabled == VLC_TRUE )
210 CalculateRate( p_sap, p_sap->pp_addresses[i] );
215 /* Find the session to announce */
216 vlc_mutex_lock( &p_sap->object_lock );
217 if( p_sap->i_sessions > p_sap->i_current_session + 1)
219 p_sap->i_current_session++;
221 else if( p_sap->i_sessions > 0)
223 p_sap->i_current_session = 0;
227 vlc_mutex_unlock( &p_sap->object_lock );
231 p_session = p_sap->pp_sessions[p_sap->i_current_session];
232 vlc_mutex_unlock( &p_sap->object_lock );
234 /* And announce it */
235 if( p_session->p_address->b_enabled == VLC_TRUE &&
236 p_session->p_address->b_ready == VLC_TRUE )
238 announce_SendSAPAnnounce( p_sap, p_session );
245 /* Add a SAP announce */
246 static int announce_SAPAnnounceAdd( sap_handler_t *p_sap,
247 session_descriptor_t *p_session )
249 int i_header_size, i;
250 char *psz_head, psz_addr[NI_MAXNUMERICHOST];
251 vlc_bool_t b_ipv6 = VLC_FALSE;
252 sap_session_t *p_sap_session;
254 struct addrinfo hints, *res;
255 struct sockaddr_storage addr;
257 vlc_mutex_lock( &p_sap->object_lock );
259 if( p_session->psz_uri == NULL )
261 vlc_mutex_unlock( &p_sap->object_lock );
262 msg_Err( p_sap, "*FIXME* Unexpected NULL URI for SAP announce" );
263 msg_Err( p_sap, "This should not happen. VLC needs fixing." );
267 /* Determine SAP multicast address automatically */
268 memset( &hints, 0, sizeof( hints ) );
269 hints.ai_socktype = SOCK_DGRAM;
270 hints.ai_flags = AI_NUMERICHOST;
272 i = vlc_getaddrinfo( (vlc_object_t *)p_sap, p_session->psz_uri, 0,
276 vlc_mutex_unlock( &p_sap->object_lock );
277 msg_Err( p_sap, "Invalid URI for SAP announce: %s: %s",
278 p_session->psz_uri, vlc_gai_strerror( i ) );
282 if( (unsigned)res->ai_addrlen > sizeof( addr ) )
284 vlc_mutex_unlock( &p_sap->object_lock );
285 vlc_freeaddrinfo( res );
286 msg_Err( p_sap, "Unsupported address family of size %d > %u",
287 res->ai_addrlen, sizeof( addr ) );
291 memcpy( &addr, res->ai_addr, res->ai_addrlen );
293 switch( addr.ss_family )
295 #if defined (HAVE_INET_PTON) || defined (WIN32)
298 /* See RFC3513 for list of valid IPv6 scopes */
299 struct in6_addr *a6 = &((struct sockaddr_in6 *)&addr)->sin6_addr;
301 memcpy( a6->s6_addr + 2, "\x00\x00\x00\x00\x00\x00"
302 "\x00\x00\x00\x00\x00\x02\x7f\xfe", 14 );
303 if( IN6_IS_ADDR_MULTICAST( a6 ) )
304 /* force flags to zero, preserve scope */
305 a6->s6_addr[1] &= 0xf;
307 /* Unicast IPv6 - assume global scope */
308 memcpy( a6->s6_addr, "\xff\x0e", 2 );
317 /* See RFC2365 for IPv4 scopes */
320 ipv4 = ntohl( ((struct sockaddr_in *)&addr)->sin_addr.s_addr );
321 /* 224.0.0.0/24 => 224.0.0.255 */
322 if ((ipv4 & 0xffffff00) == 0xe0000000)
325 /* 239.255.0.0/16 => 239.255.255.255 */
326 if ((ipv4 & 0xffff0000) == 0xefff0000)
329 /* 239.192.0.0/14 => 239.195.255.255 */
330 if ((ipv4 & 0xfffc0000) == 0xefc00000)
333 /* other addresses => 224.2.127.254 */
336 ((struct sockaddr_in *)&addr)->sin_addr.s_addr = htonl( ipv4 );
341 vlc_mutex_unlock( &p_sap->object_lock );
342 vlc_freeaddrinfo( res );
343 msg_Err( p_sap, "Address family %d not supported by SAP",
348 i = vlc_getnameinfo( (struct sockaddr *)&addr, res->ai_addrlen,
349 psz_addr, sizeof( psz_addr ), NULL, NI_NUMERICHOST );
350 vlc_freeaddrinfo( res );
354 vlc_mutex_unlock( &p_sap->object_lock );
355 msg_Err( p_sap, "%s", vlc_gai_strerror( i ) );
359 msg_Dbg( p_sap, "using SAP address: %s", psz_addr);
361 /* XXX: Check for dupes */
362 p_sap_session = (sap_session_t*)malloc(sizeof(sap_session_t));
363 p_sap_session->p_address = NULL;
365 /* Add the address to the buffer */
366 for( i = 0; i < p_sap->i_addresses; i++)
368 if( !strcmp( psz_addr, p_sap->pp_addresses[i]->psz_address ) )
370 p_sap_session->p_address = p_sap->pp_addresses[i];
375 if( p_sap_session->p_address == NULL )
377 sap_address_t *p_address = (sap_address_t *)
378 malloc( sizeof(sap_address_t) );
381 msg_Err( p_sap, "out of memory" );
384 p_address->psz_address = strdup( psz_addr );
385 p_address->i_port = 9875;
386 p_address->i_wfd = net_OpenUDP( p_sap, "", 0, psz_addr,
388 if( p_address->i_wfd != -1 )
392 net_StopRecv( p_address->i_wfd );
393 net_GetSockAddress( p_address->i_wfd, p_address->psz_machine,
396 /* removes scope if present */
397 ptr = strchr( p_address->psz_machine, '%' );
402 if( p_sap->b_control == VLC_TRUE )
404 p_address->i_rfd = net_OpenUDP( p_sap, psz_addr,
405 p_address->i_port, "", 0 );
406 if( p_address->i_rfd != -1 )
407 net_StopSend( p_address->i_rfd );
408 p_address->i_buff = 0;
409 p_address->b_enabled = VLC_TRUE;
410 p_address->b_ready = VLC_FALSE;
411 p_address->i_limit = 10000; /* 10000 bps */
416 p_address->b_enabled = VLC_TRUE;
417 p_address->b_ready = VLC_TRUE;
418 p_address->i_interval = config_GetInt( p_sap,"sap-interval");
419 p_address->i_rfd = -1;
422 if( p_address->i_wfd == -1 || (p_address->i_rfd == -1
423 && p_sap->b_control ) )
425 msg_Warn( p_sap, "disabling address" );
426 p_address->b_enabled = VLC_FALSE;
429 INSERT_ELEM( p_sap->pp_addresses,
433 p_sap_session->p_address = p_address;
437 /* Build the SAP Headers */
438 i_header_size = ( b_ipv6 ? 16 : 4 ) + 20;
439 psz_head = (char *) malloc( i_header_size * sizeof( char ) );
440 if( psz_head == NULL )
442 msg_Err( p_sap, "out of memory" );
446 /* SAPv1, not encrypted, not compressed */
447 psz_head[0] = b_ipv6 ? 0x30 : 0x20;
448 psz_head[1] = 0x00; /* No authentification length */
451 psz_head[2] = (i_hash & 0xFF00) >> 8; /* Msg id hash */
452 psz_head[3] = (i_hash & 0xFF); /* Msg id hash 2 */
454 #if defined (HAVE_INET_PTON) || defined (WIN32)
457 inet_pton( AF_INET6, /* can't fail */
458 p_sap_session->p_address->psz_machine,
464 inet_pton( AF_INET, /* can't fail */
465 p_sap_session->p_address->psz_machine,
470 memcpy( psz_head + (b_ipv6 ? 20 : 8), "application/sdp", 15 );
472 /* If needed, build the SDP */
473 if( p_session->psz_sdp == NULL )
475 p_session->psz_sdp = SDPGenerate( p_sap, p_session,
476 p_sap_session->p_address );
477 if( p_session->psz_sdp == NULL )
479 vlc_mutex_unlock( &p_sap->object_lock );
484 p_sap_session->psz_sdp = strdup( p_session->psz_sdp );
485 p_sap_session->i_last = 0;
487 psz_head[ i_header_size-1 ] = '\0';
488 p_sap_session->i_length = i_header_size + strlen( p_sap_session->psz_sdp);
490 p_sap_session->psz_data = (uint8_t *)malloc( sizeof(char)*
491 p_sap_session->i_length );
493 /* Build the final message */
494 memcpy( p_sap_session->psz_data, psz_head, i_header_size );
495 memcpy( p_sap_session->psz_data+i_header_size, p_sap_session->psz_sdp,
496 strlen( p_sap_session->psz_sdp) );
500 /* Enqueue the announce */
501 INSERT_ELEM( p_sap->pp_sessions,
505 msg_Dbg( p_sap,"Addresses: %i Sessions: %i",
506 p_sap->i_addresses,p_sap->i_sessions);
508 /* Remember the SAP session for later deletion */
509 p_session->p_sap = p_sap_session;
511 vlc_mutex_unlock( &p_sap->object_lock );
516 /* Remove a SAP Announce */
517 static int announce_SAPAnnounceDel( sap_handler_t *p_sap,
518 session_descriptor_t *p_session )
521 vlc_mutex_lock( &p_sap->object_lock );
523 msg_Dbg( p_sap,"removing SAP announce %p",p_session->p_sap);
525 /* Dequeue the announce */
526 for( i = 0; i< p_sap->i_sessions; i++)
528 if( p_session->p_sap == p_sap->pp_sessions[i] )
530 REMOVE_ELEM( p_sap->pp_sessions,
534 FREE( p_session->p_sap->psz_sdp );
535 FREE( p_session->p_sap->psz_data );
536 free( p_session->p_sap );
541 /* XXX: Dequeue the address too if it is not used anymore
542 * TODO: - address refcount
543 - send a SAP deletion packet */
545 msg_Dbg( p_sap,"%i announces remaining", p_sap->i_sessions );
547 vlc_mutex_unlock( &p_sap->object_lock );
552 static int announce_SendSAPAnnounce( sap_handler_t *p_sap,
553 sap_session_t *p_session )
557 /* This announce has never been sent yet */
558 if( p_session->i_last == 0 )
560 p_session->i_next = mdate()+ p_session->p_address->i_interval*1000000;
561 p_session->i_last = 1;
565 if( p_session->i_next < mdate() )
568 msg_Dbg( p_sap, "Sending announce");
570 i_ret = net_Write( p_sap, p_session->p_address->i_wfd, NULL,
572 p_session->i_length );
573 if( i_ret != (unsigned int)p_session->i_length )
575 msg_Warn( p_sap, "SAP send failed on address %s (%i %i)",
576 p_session->p_address->psz_address,
577 i_ret, p_session->i_length );
579 p_session->i_last = p_session->i_next;
580 p_session->i_next = p_session->i_last
581 + p_session->p_address->i_interval*1000000;
590 static char *SDPGenerate( sap_handler_t *p_sap,
591 const session_descriptor_t *p_session,
592 const sap_address_t *p_addr )
594 int64_t i_sdp_id = mdate();
595 int i_sdp_version = 1 + p_sap->i_sessions + (rand()&0xfff);
596 char *psz_group, *psz_name, psz_uribuf[NI_MAXNUMERICHOST], *psz_uri,
600 psz_group = p_session->psz_group;
601 psz_name = p_session->psz_name;
603 /* FIXME: really check that psz_uri is a real IP address
604 * FIXME: make a common function to obtain a canonical IP address */
605 ipv = ( strchr( p_session->psz_uri, ':' ) != NULL) ? '6' : '4';
606 if( *p_session->psz_uri == '[' )
610 strncpy( psz_uribuf, p_session->psz_uri + 1, sizeof( psz_uribuf ) );
611 psz_uribuf[sizeof( psz_uribuf ) - 1] = '\0';
612 ptr = strchr( psz_uribuf, '%' );
615 ptr = strchr( psz_uribuf, ']' );
618 psz_uri = psz_uribuf;
621 psz_uri = p_session->psz_uri;
623 /* see the lists in modules/stream_out/rtp.c for compliance stuff */
624 if( asprintf( &psz_sdp,
626 "o=- "I64Fd" %d IN IP%c %s\r\n"
629 "c=IN IP%c %s/%d\r\n"
630 "m=video %d udp %d\r\n"
631 "a=tool:"PACKAGE_STRING"\r\n"
632 "a=type:broadcast\r\n"
634 i_sdp_id, i_sdp_version,
635 ipv, p_addr->psz_machine,
637 psz_uri, p_session->i_ttl,
638 p_session->i_port, p_session->i_payload,
639 psz_group ? "a=x-plgroup:" : "",
640 psz_group ? psz_group : "", psz_group ? "\r\n" : "" ) == -1 )
643 msg_Dbg( p_sap, "Generated SDP (%i bytes):\n%s", strlen(psz_sdp),
648 static int CalculateRate( sap_handler_t *p_sap, sap_address_t *p_address )
651 uint8_t buffer[SAP_MAX_BUFFER];
656 if( p_address->t1 == 0 )
658 p_address->t1 = mdate();
663 /* Might be too slow if we have huge data */
664 i_read = net_ReadNonBlock( p_sap, p_address->i_rfd, NULL, buffer,
667 } while( i_read > 0 && i_tot < SAP_MAX_BUFFER );
671 /* We calculate the rate every 5 seconds */
672 if( i_temp - p_address->t1 < 5000000 )
674 p_address->i_buff += i_tot;
679 i_rate = (int)(8*1000000*((mtime_t)p_address->i_buff + (mtime_t)i_tot ) /
680 (i_temp - p_address->t1 ));
682 p_address->i_limit = 10000;
684 p_address->i_interval = ((1000*i_rate / p_address->i_limit) *
685 (MAX_INTERVAL - MIN_INTERVAL))/1000 + MIN_INTERVAL;
687 if( p_address->i_interval > MAX_INTERVAL || p_address->i_interval < 0 )
689 p_address->i_interval = MAX_INTERVAL;
692 msg_Dbg( p_sap,"%s:%i : Rate=%i, Interval = %i s",
693 p_address->psz_address,p_address->i_port,
695 p_address->i_interval );
698 p_address->b_ready = VLC_TRUE;
700 p_address->t1 = i_temp;
701 p_address->i_buff = 0;