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., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, 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() */
39 /* SAP is always on that port */
42 #define DEFAULT_PORT "1234"
46 /* SAP Specific structures */
49 #define SAP_IDLE ((mtime_t)(0.100*CLOCK_FREQ))
50 #define SAP_MAX_BUFFER 65534
51 #define MIN_INTERVAL 2
52 #define MAX_INTERVAL 300
54 /* A SAP announce address. For each of these, we run the
55 * control flow algorithm */
59 char psz_machine[NI_MAXNUMERICHOST];
60 int i_rfd; /* Read socket */
61 int i_wfd; /* Write socket */
63 /* Used for flow control */
72 /*****************************************************************************
74 *****************************************************************************/
75 static void RunThread( vlc_object_t *p_this);
76 static int CalculateRate( sap_handler_t *p_sap, sap_address_t *p_address );
77 static char *SDPGenerate( sap_handler_t *p_sap,
78 const session_descriptor_t *p_session,
79 const sap_address_t *p_addr );
81 static int announce_SendSAPAnnounce( sap_handler_t *p_sap,
82 sap_session_t *p_session );
85 static int announce_SAPAnnounceAdd( sap_handler_t *p_sap,
86 session_descriptor_t *p_session );
88 static int announce_SAPAnnounceDel( sap_handler_t *p_sap,
89 session_descriptor_t *p_session );
91 #define FREE( p ) if( p ) { free( p ); (p) = NULL; }
95 * Create the SAP handler
97 * \param p_announce the parent announce_handler
98 * \return the newly created SAP handler or NULL on error
100 sap_handler_t *announce_SAPHandlerCreate( announce_handler_t *p_announce )
102 sap_handler_t *p_sap;
104 p_sap = vlc_object_create( p_announce, sizeof( sap_handler_t ) );
108 msg_Err( p_announce, "out of memory" );
112 vlc_mutex_init( p_sap, &p_sap->object_lock );
114 p_sap->pf_add = announce_SAPAnnounceAdd;
115 p_sap->pf_del = announce_SAPAnnounceDel;
117 p_sap->i_sessions = 0;
118 p_sap->i_addresses = 0;
119 p_sap->i_current_session = 0;
121 p_sap->b_control = config_GetInt( p_sap, "sap-flow-control");
123 if( vlc_thread_create( p_sap, "sap handler", RunThread,
124 VLC_THREAD_PRIORITY_LOW, VLC_FALSE ) )
126 msg_Dbg( p_announce, "Unable to spawn SAP handler thread");
130 msg_Dbg( p_announce, "thread created, %i sessions", p_sap->i_sessions);
135 * Destroy the SAP handler
136 * \param p_this the SAP Handler to destroy
139 void announce_SAPHandlerDestroy( sap_handler_t *p_sap )
143 vlc_mutex_destroy( &p_sap->object_lock );
145 /* Free the remaining sessions */
146 for( i = 0 ; i< p_sap->i_sessions ; i++)
148 sap_session_t *p_session = p_sap->pp_sessions[i];
149 FREE( p_session->psz_sdp );
150 FREE( p_session->psz_data );
151 REMOVE_ELEM( p_sap->pp_sessions, p_sap->i_sessions , i );
155 /* Free the remaining addresses */
156 for( i = 0 ; i< p_sap->i_addresses ; i++)
158 sap_address_t *p_address = p_sap->pp_addresses[i];
159 FREE( p_address->psz_address );
160 if( p_address->i_rfd > -1 )
162 net_Close( p_address->i_rfd );
164 if( p_address->i_wfd > -1 && p_sap->b_control )
166 net_Close( p_address->i_wfd );
168 REMOVE_ELEM( p_sap->pp_addresses, p_sap->i_addresses, i );
172 /* Free the structure */
173 vlc_object_destroy( p_sap );
177 * main SAP handler thread
178 * \param p_this the SAP Handler object
181 static void RunThread( vlc_object_t *p_this)
183 sap_handler_t *p_sap = (sap_handler_t*)p_this;
184 sap_session_t *p_session;
186 while( !p_sap->b_die )
190 /* If needed, get the rate info */
191 if( p_sap->b_control == VLC_TRUE )
193 for( i = 0 ; i< p_sap->i_addresses ; i++)
195 if( p_sap->pp_addresses[i]->b_enabled == VLC_TRUE )
197 CalculateRate( p_sap, p_sap->pp_addresses[i] );
202 /* Find the session to announce */
203 vlc_mutex_lock( &p_sap->object_lock );
204 if( p_sap->i_sessions > p_sap->i_current_session + 1)
206 p_sap->i_current_session++;
208 else if( p_sap->i_sessions > 0)
210 p_sap->i_current_session = 0;
214 vlc_mutex_unlock( &p_sap->object_lock );
218 p_session = p_sap->pp_sessions[p_sap->i_current_session];
219 vlc_mutex_unlock( &p_sap->object_lock );
221 /* And announce it */
222 if( p_session->p_address->b_enabled == VLC_TRUE &&
223 p_session->p_address->b_ready == VLC_TRUE )
225 announce_SendSAPAnnounce( p_sap, p_session );
232 /* Add a SAP announce */
233 static int announce_SAPAnnounceAdd( sap_handler_t *p_sap,
234 session_descriptor_t *p_session )
236 int i_header_size, i;
237 char *psz_head, psz_addr[NI_MAXNUMERICHOST];
238 vlc_bool_t b_ipv6 = VLC_FALSE;
239 sap_session_t *p_sap_session;
241 struct addrinfo hints, *res;
242 struct sockaddr_storage addr;
244 vlc_mutex_lock( &p_sap->object_lock );
246 if( p_session->psz_uri == NULL )
248 vlc_mutex_unlock( &p_sap->object_lock );
249 msg_Err( p_sap, "*FIXME* Unexpected NULL URI for SAP announce" );
250 msg_Err( p_sap, "This should not happen. VLC needs fixing." );
254 /* Determine SAP multicast address automatically */
255 memset( &hints, 0, sizeof( hints ) );
256 hints.ai_socktype = SOCK_DGRAM;
257 hints.ai_flags = AI_NUMERICHOST;
259 i = vlc_getaddrinfo( (vlc_object_t *)p_sap, p_session->psz_uri, 0,
263 vlc_mutex_unlock( &p_sap->object_lock );
264 msg_Err( p_sap, "Invalid URI for SAP announce: %s: %s",
265 p_session->psz_uri, vlc_gai_strerror( i ) );
269 if( (unsigned)res->ai_addrlen > sizeof( addr ) )
271 vlc_mutex_unlock( &p_sap->object_lock );
272 vlc_freeaddrinfo( res );
273 msg_Err( p_sap, "Unsupported address family of size %d > %u",
274 res->ai_addrlen, (unsigned) sizeof( addr ) );
278 memcpy( &addr, res->ai_addr, res->ai_addrlen );
280 switch( addr.ss_family )
282 #if defined (HAVE_INET_PTON) || defined (WIN32)
285 /* See RFC3513 for list of valid IPv6 scopes */
286 struct in6_addr *a6 = &((struct sockaddr_in6 *)&addr)->sin6_addr;
288 memcpy( a6->s6_addr + 2, "\x00\x00\x00\x00\x00\x00"
289 "\x00\x00\x00\x00\x00\x02\x7f\xfe", 14 );
290 if( IN6_IS_ADDR_MULTICAST( a6 ) )
291 /* force flags to zero, preserve scope */
292 a6->s6_addr[1] &= 0xf;
294 /* Unicast IPv6 - assume global scope */
295 memcpy( a6->s6_addr, "\xff\x0e", 2 );
304 /* See RFC2365 for IPv4 scopes */
307 ipv4 = ntohl( ((struct sockaddr_in *)&addr)->sin_addr.s_addr );
308 /* 224.0.0.0/24 => 224.0.0.255 */
309 if ((ipv4 & 0xffffff00) == 0xe0000000)
312 /* 239.255.0.0/16 => 239.255.255.255 */
313 if ((ipv4 & 0xffff0000) == 0xefff0000)
316 /* 239.192.0.0/14 => 239.195.255.255 */
317 if ((ipv4 & 0xfffc0000) == 0xefc00000)
320 /* other addresses => 224.2.127.254 */
323 ((struct sockaddr_in *)&addr)->sin_addr.s_addr = htonl( ipv4 );
328 vlc_mutex_unlock( &p_sap->object_lock );
329 vlc_freeaddrinfo( res );
330 msg_Err( p_sap, "Address family %d not supported by SAP",
335 i = vlc_getnameinfo( (struct sockaddr *)&addr, res->ai_addrlen,
336 psz_addr, sizeof( psz_addr ), NULL, NI_NUMERICHOST );
337 vlc_freeaddrinfo( res );
341 vlc_mutex_unlock( &p_sap->object_lock );
342 msg_Err( p_sap, "%s", vlc_gai_strerror( i ) );
346 msg_Dbg( p_sap, "using SAP address: %s", psz_addr);
348 /* XXX: Check for dupes */
349 p_sap_session = (sap_session_t*)malloc(sizeof(sap_session_t));
350 p_sap_session->p_address = NULL;
352 /* Add the address to the buffer */
353 for( i = 0; i < p_sap->i_addresses; i++)
355 if( !strcmp( psz_addr, p_sap->pp_addresses[i]->psz_address ) )
357 p_sap_session->p_address = p_sap->pp_addresses[i];
362 if( p_sap_session->p_address == NULL )
364 sap_address_t *p_address = (sap_address_t *)
365 malloc( sizeof(sap_address_t) );
368 msg_Err( p_sap, "out of memory" );
371 p_address->psz_address = strdup( psz_addr );
372 p_address->i_wfd = net_ConnectUDP( p_sap, psz_addr, SAP_PORT, 0 );
373 if( p_address->i_wfd != -1 )
377 net_StopRecv( p_address->i_wfd );
378 net_GetSockAddress( p_address->i_wfd, p_address->psz_machine,
381 /* removes scope if present */
382 ptr = strchr( p_address->psz_machine, '%' );
387 if( p_sap->b_control == VLC_TRUE )
389 p_address->i_rfd = net_OpenUDP( p_sap, psz_addr, SAP_PORT, "", 0 );
390 if( p_address->i_rfd != -1 )
391 net_StopSend( p_address->i_rfd );
392 p_address->i_buff = 0;
393 p_address->b_enabled = VLC_TRUE;
394 p_address->b_ready = VLC_FALSE;
395 p_address->i_limit = 10000; /* 10000 bps */
400 p_address->b_enabled = VLC_TRUE;
401 p_address->b_ready = VLC_TRUE;
402 p_address->i_interval = config_GetInt( p_sap,"sap-interval");
403 p_address->i_rfd = -1;
406 if( p_address->i_wfd == -1 || (p_address->i_rfd == -1
407 && p_sap->b_control ) )
409 msg_Warn( p_sap, "disabling address" );
410 p_address->b_enabled = VLC_FALSE;
413 INSERT_ELEM( p_sap->pp_addresses,
417 p_sap_session->p_address = p_address;
421 /* Build the SAP Headers */
422 i_header_size = ( b_ipv6 ? 16 : 4 ) + 20;
423 psz_head = (char *) malloc( i_header_size * sizeof( char ) );
424 if( psz_head == NULL )
426 msg_Err( p_sap, "out of memory" );
430 /* SAPv1, not encrypted, not compressed */
431 psz_head[0] = b_ipv6 ? 0x30 : 0x20;
432 psz_head[1] = 0x00; /* No authentification length */
435 psz_head[2] = (i_hash & 0xFF00) >> 8; /* Msg id hash */
436 psz_head[3] = (i_hash & 0xFF); /* Msg id hash 2 */
438 #if defined (HAVE_INET_PTON) || defined (WIN32)
441 inet_pton( AF_INET6, /* can't fail */
442 p_sap_session->p_address->psz_machine,
448 inet_pton( AF_INET, /* can't fail */
449 p_sap_session->p_address->psz_machine,
453 memcpy( psz_head + (b_ipv6 ? 20 : 8), "application/sdp", 15 );
455 /* If needed, build the SDP */
456 if( p_session->psz_sdp == NULL )
458 p_session->psz_sdp = SDPGenerate( p_sap, p_session,
459 p_sap_session->p_address );
460 if( p_session->psz_sdp == NULL )
462 vlc_mutex_unlock( &p_sap->object_lock );
467 p_sap_session->psz_sdp = strdup( p_session->psz_sdp );
468 p_sap_session->i_last = 0;
470 psz_head[ i_header_size-1 ] = '\0';
471 p_sap_session->i_length = i_header_size + strlen( p_sap_session->psz_sdp);
473 p_sap_session->psz_data = (uint8_t *)malloc( sizeof(char)*
474 p_sap_session->i_length );
476 /* Build the final message */
477 memcpy( p_sap_session->psz_data, psz_head, i_header_size );
478 memcpy( p_sap_session->psz_data+i_header_size, p_sap_session->psz_sdp,
479 strlen( p_sap_session->psz_sdp) );
483 /* Enqueue the announce */
484 INSERT_ELEM( p_sap->pp_sessions,
488 msg_Dbg( p_sap,"Addresses: %i Sessions: %i",
489 p_sap->i_addresses,p_sap->i_sessions);
491 /* Remember the SAP session for later deletion */
492 p_session->p_sap = p_sap_session;
494 vlc_mutex_unlock( &p_sap->object_lock );
499 /* Remove a SAP Announce */
500 static int announce_SAPAnnounceDel( sap_handler_t *p_sap,
501 session_descriptor_t *p_session )
504 vlc_mutex_lock( &p_sap->object_lock );
506 msg_Dbg( p_sap,"removing SAP announce %p",p_session->p_sap);
508 /* Dequeue the announce */
509 for( i = 0; i< p_sap->i_sessions; i++)
511 if( p_session->p_sap == p_sap->pp_sessions[i] )
513 REMOVE_ELEM( p_sap->pp_sessions,
517 FREE( p_session->p_sap->psz_sdp );
518 FREE( p_session->p_sap->psz_data );
519 free( p_session->p_sap );
524 /* XXX: Dequeue the address too if it is not used anymore
525 * TODO: - address refcount
526 - send a SAP deletion packet */
528 msg_Dbg( p_sap,"%i announcements remaining", p_sap->i_sessions );
530 vlc_mutex_unlock( &p_sap->object_lock );
535 static int announce_SendSAPAnnounce( sap_handler_t *p_sap,
536 sap_session_t *p_session )
540 /* This announce has never been sent yet */
541 if( p_session->i_last == 0 )
543 p_session->i_next = mdate()+ p_session->p_address->i_interval*1000000;
544 p_session->i_last = 1;
548 if( p_session->i_next < mdate() )
551 msg_Dbg( p_sap, "Sending announce");
553 i_ret = net_Write( p_sap, p_session->p_address->i_wfd, NULL,
555 p_session->i_length );
556 if( i_ret != (int)p_session->i_length )
558 msg_Warn( p_sap, "SAP send failed on address %s (%i %i)",
559 p_session->p_address->psz_address,
560 i_ret, p_session->i_length );
562 p_session->i_last = p_session->i_next;
563 p_session->i_next = p_session->i_last
564 + p_session->p_address->i_interval*1000000;
573 static char *SDPGenerate( sap_handler_t *p_sap,
574 const session_descriptor_t *p_session,
575 const sap_address_t *p_addr )
577 int64_t i_sdp_id = mdate();
578 int i_sdp_version = 1 + p_sap->i_sessions + (rand()&0xfff);
579 char *psz_group, *psz_name, psz_uribuf[NI_MAXNUMERICHOST], *psz_uri,
583 psz_group = p_session->psz_group;
584 psz_name = p_session->psz_name;
586 /* FIXME: really check that psz_uri is a real IP address
587 * FIXME: make a common function to obtain a canonical IP address */
588 ipv = ( strchr( p_session->psz_uri, ':' ) != NULL) ? '6' : '4';
589 if( *p_session->psz_uri == '[' )
593 strncpy( psz_uribuf, p_session->psz_uri + 1, sizeof( psz_uribuf ) );
594 psz_uribuf[sizeof( psz_uribuf ) - 1] = '\0';
595 ptr = strchr( psz_uribuf, '%' );
598 ptr = strchr( psz_uribuf, ']' );
601 psz_uri = psz_uribuf;
604 psz_uri = p_session->psz_uri;
606 /* see the lists in modules/stream_out/rtp.c for compliance stuff */
607 if( asprintf( &psz_sdp,
609 "o=- "I64Fd" %d IN IP%c %s\r\n"
612 "c=IN IP%c %s/%d\r\n"
613 "m=video %d %s %d\r\n"
614 "a=tool:"PACKAGE_STRING"\r\n"
615 "a=type:broadcast\r\n"
617 i_sdp_id, i_sdp_version,
618 ipv, p_addr->psz_machine,
619 psz_name, ipv, psz_uri, p_session->i_ttl,
621 p_session->b_rtp ? "RTP/AVP" : "udp",
622 p_session->i_payload,
623 psz_group ? "a=x-plgroup:" : "",
624 psz_group ? psz_group : "", psz_group ? "\r\n" : "" ) == -1 )
627 msg_Dbg( p_sap, "Generated SDP (%i bytes):\n%s", strlen(psz_sdp),
632 static int CalculateRate( sap_handler_t *p_sap, sap_address_t *p_address )
635 uint8_t buffer[SAP_MAX_BUFFER];
640 if( p_address->t1 == 0 )
642 p_address->t1 = mdate();
647 /* Might be too slow if we have huge data */
648 i_read = net_ReadNonBlock( p_sap, p_address->i_rfd, NULL, buffer,
651 } while( i_read > 0 && i_tot < SAP_MAX_BUFFER );
655 /* We calculate the rate every 5 seconds */
656 if( i_temp - p_address->t1 < 5000000 )
658 p_address->i_buff += i_tot;
663 i_rate = (int)(8*1000000*((mtime_t)p_address->i_buff + (mtime_t)i_tot ) /
664 (i_temp - p_address->t1 ));
666 p_address->i_limit = 10000;
668 p_address->i_interval = ((1000*i_rate / p_address->i_limit) *
669 (MAX_INTERVAL - MIN_INTERVAL))/1000 + MIN_INTERVAL;
671 if( p_address->i_interval > MAX_INTERVAL || p_address->i_interval < 0 )
673 p_address->i_interval = MAX_INTERVAL;
676 msg_Dbg( p_sap,"%s:%i : Rate=%i, Interval = %i s",
677 p_address->psz_address,SAP_PORT, i_rate, p_address->i_interval );
680 p_address->b_ready = VLC_TRUE;
682 p_address->t1 = i_temp;
683 p_address->i_buff = 0;