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 *****************************************************************************/
31 #include <stdlib.h> /* free() */
32 #include <stdio.h> /* sprintf() */
33 #include <string.h> /* strerror() */
34 #include <ctype.h> /* tolower(), isxdigit() */
41 /* SAP is always on that port */
44 #define DEFAULT_PORT "1234"
48 /* SAP Specific structures */
51 #define SAP_IDLE ((mtime_t)(0.100*CLOCK_FREQ))
52 #define SAP_MAX_BUFFER 65534
53 #define MIN_INTERVAL 2
54 #define MAX_INTERVAL 300
56 /* A SAP announce address. For each of these, we run the
57 * control flow algorithm */
61 char psz_machine[NI_MAXNUMERICHOST];
62 int i_rfd; /* Read socket */
63 int i_wfd; /* Write socket */
65 /* Used for flow control */
74 /*****************************************************************************
76 *****************************************************************************/
77 static void RunThread( vlc_object_t *p_this);
78 static int CalculateRate( sap_handler_t *p_sap, sap_address_t *p_address );
79 static char *SDPGenerate( sap_handler_t *p_sap,
80 const session_descriptor_t *p_session,
81 const sap_address_t *p_addr, vlc_bool_t b_ssm );
83 static int announce_SendSAPAnnounce( sap_handler_t *p_sap,
84 sap_session_t *p_session );
87 static int announce_SAPAnnounceAdd( sap_handler_t *p_sap,
88 session_descriptor_t *p_session );
90 static int announce_SAPAnnounceDel( sap_handler_t *p_sap,
91 session_descriptor_t *p_session );
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 FREENULL( p_session->psz_sdp );
150 FREENULL( p_session->psz_data );
151 REMOVE_ELEM( p_sap->pp_sessions, p_sap->i_sessions , i );
152 FREENULL( p_session );
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 FREENULL( 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 );
169 FREENULL( p_address );
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, b_ssm = VLC_FALSE;
239 sap_session_t *p_sap_session;
241 struct addrinfo hints, *res;
242 struct sockaddr_storage addr;
245 vlc_mutex_lock( &p_sap->object_lock );
247 if( p_session->psz_uri == NULL )
249 vlc_mutex_unlock( &p_sap->object_lock );
250 msg_Err( p_sap, "*FIXME* unexpected NULL URI for SAP announce" );
251 msg_Err( p_sap, "This should not happen. VLC needs fixing." );
255 /* Determine SAP multicast address automatically */
256 memset( &hints, 0, sizeof( hints ) );
257 hints.ai_socktype = SOCK_DGRAM;
258 hints.ai_flags = AI_NUMERICHOST;
260 i = vlc_getaddrinfo( (vlc_object_t *)p_sap, p_session->psz_uri, 0,
264 vlc_mutex_unlock( &p_sap->object_lock );
265 msg_Err( p_sap, "Invalid URI for SAP announce: %s: %s",
266 p_session->psz_uri, vlc_gai_strerror( i ) );
270 addrlen = res->ai_addrlen;
271 if ((unsigned)addrlen > sizeof (addr))
273 vlc_mutex_unlock( &p_sap->object_lock );
274 vlc_freeaddrinfo( res );
275 msg_Err( p_sap, "Unsupported address family of size %d > %u",
276 res->ai_addrlen, (unsigned) sizeof( addr ) );
280 memcpy (&addr, res->ai_addr, addrlen);
281 vlc_freeaddrinfo (res);
283 switch( addr.ss_family )
285 #if defined (HAVE_INET_PTON) || defined (WIN32)
288 /* See RFC3513 for list of valid IPv6 scopes */
289 struct in6_addr *a6 = &((struct sockaddr_in6 *)&addr)->sin6_addr;
291 memcpy( a6->s6_addr + 2, "\x00\x00\x00\x00\x00\x00"
292 "\x00\x00\x00\x00\x00\x02\x7f\xfe", 14 );
293 if( IN6_IS_ADDR_MULTICAST( a6 ) )
295 /* SSM <=> ff3x::/32 */
296 b_ssm = (GetDWLE (a6->s6_addr) & 0xfff0ffff) == 0xff300000;
298 /* force flags to zero, preserve scope */
299 a6->s6_addr[1] &= 0xf;
302 /* Unicast IPv6 - assume global scope */
303 memcpy( a6->s6_addr, "\xff\x0e", 2 );
312 /* See RFC2365 for IPv4 scopes */
315 ipv4 = ntohl( ((struct sockaddr_in *)&addr)->sin_addr.s_addr );
316 /* 224.0.0.0/24 => 224.0.0.255 */
317 if ((ipv4 & 0xffffff00) == 0xe0000000)
320 /* 239.255.0.0/16 => 239.255.255.255 */
321 if ((ipv4 & 0xffff0000) == 0xefff0000)
324 /* 239.192.0.0/14 => 239.195.255.255 */
325 if ((ipv4 & 0xfffc0000) == 0xefc00000)
328 if ((ipv4 & 0xff000000) == 0xef000000)
331 /* other addresses => 224.2.127.254 */
333 /* SSM: 232.0.0.0/8 */
334 b_ssm = (ipv4 >> 24) == 232;
340 msg_Err( p_sap, "Out-of-scope multicast address "
341 "not supported by SAP: %s", p_session->psz_uri );
342 vlc_mutex_unlock( &p_sap->object_lock );
346 ((struct sockaddr_in *)&addr)->sin_addr.s_addr = htonl( ipv4 );
351 vlc_mutex_unlock( &p_sap->object_lock );
352 msg_Err( p_sap, "Address family %d not supported by SAP",
357 i = vlc_getnameinfo( (struct sockaddr *)&addr, addrlen,
358 psz_addr, sizeof( psz_addr ), NULL, NI_NUMERICHOST );
362 vlc_mutex_unlock( &p_sap->object_lock );
363 msg_Err( p_sap, "%s", vlc_gai_strerror( i ) );
367 msg_Dbg( p_sap, "using SAP address: %s", psz_addr);
369 /* XXX: Check for dupes */
370 p_sap_session = (sap_session_t*)malloc(sizeof(sap_session_t));
371 p_sap_session->p_address = NULL;
373 /* Add the address to the buffer */
374 for( i = 0; i < p_sap->i_addresses; i++)
376 if( !strcmp( psz_addr, p_sap->pp_addresses[i]->psz_address ) )
378 p_sap_session->p_address = p_sap->pp_addresses[i];
383 if( p_sap_session->p_address == NULL )
385 sap_address_t *p_address = (sap_address_t *)
386 malloc( sizeof(sap_address_t) );
389 msg_Err( p_sap, "out of memory" );
392 p_address->psz_address = strdup( psz_addr );
393 p_address->i_wfd = net_ConnectUDP( p_sap, psz_addr, SAP_PORT, 255 );
394 if( p_address->i_wfd != -1 )
398 net_StopRecv( p_address->i_wfd );
399 net_GetSockAddress( p_address->i_wfd, p_address->psz_machine,
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_ListenUDP1( (vlc_object_t*)p_sap, psz_addr, SAP_PORT );
411 if( p_address->i_rfd != -1 )
412 net_StopSend( p_address->i_rfd );
413 p_address->i_buff = 0;
414 p_address->b_enabled = VLC_TRUE;
415 p_address->b_ready = VLC_FALSE;
416 p_address->i_limit = 10000; /* 10000 bps */
421 p_address->b_enabled = VLC_TRUE;
422 p_address->b_ready = VLC_TRUE;
423 p_address->i_interval = config_GetInt( p_sap,"sap-interval");
424 p_address->i_rfd = -1;
427 if( p_address->i_wfd == -1 || (p_address->i_rfd == -1
428 && p_sap->b_control ) )
430 msg_Warn( p_sap, "disabling address" );
431 p_address->b_enabled = VLC_FALSE;
434 INSERT_ELEM( p_sap->pp_addresses,
438 p_sap_session->p_address = p_address;
442 /* Build the SAP Headers */
443 i_header_size = ( b_ipv6 ? 16 : 4 ) + 20;
444 psz_head = (char *) malloc( i_header_size * sizeof( char ) );
445 if( psz_head == NULL )
447 msg_Err( p_sap, "out of memory" );
451 /* SAPv1, not encrypted, not compressed */
452 psz_head[0] = b_ipv6 ? 0x30 : 0x20;
453 psz_head[1] = 0x00; /* No authentification length */
456 psz_head[2] = (i_hash & 0xFF00) >> 8; /* Msg id hash */
457 psz_head[3] = (i_hash & 0xFF); /* Msg id hash 2 */
459 #if defined (HAVE_INET_PTON) || defined (WIN32)
462 inet_pton( AF_INET6, /* can't fail */
463 p_sap_session->p_address->psz_machine,
469 inet_pton( AF_INET, /* can't fail */
470 p_sap_session->p_address->psz_machine,
474 memcpy( psz_head + (b_ipv6 ? 20 : 8), "application/sdp", 15 );
476 /* If needed, build the SDP */
477 if( p_session->psz_sdp == NULL )
479 p_session->psz_sdp = SDPGenerate( p_sap, p_session,
480 p_sap_session->p_address, b_ssm );
481 if( p_session->psz_sdp == NULL )
483 vlc_mutex_unlock( &p_sap->object_lock );
488 p_sap_session->psz_sdp = strdup( p_session->psz_sdp );
489 p_sap_session->i_last = 0;
491 psz_head[ i_header_size-1 ] = '\0';
492 p_sap_session->i_length = i_header_size + strlen( p_sap_session->psz_sdp);
494 p_sap_session->psz_data = (uint8_t *)malloc( sizeof(char)*
495 p_sap_session->i_length );
497 /* Build the final message */
498 memcpy( p_sap_session->psz_data, psz_head, i_header_size );
499 memcpy( p_sap_session->psz_data+i_header_size, p_sap_session->psz_sdp,
500 strlen( p_sap_session->psz_sdp) );
504 /* Enqueue the announce */
505 INSERT_ELEM( p_sap->pp_sessions,
509 msg_Dbg( p_sap,"%i addresses, %i sessions",
510 p_sap->i_addresses,p_sap->i_sessions);
512 /* Remember the SAP session for later deletion */
513 p_session->p_sap = p_sap_session;
515 vlc_mutex_unlock( &p_sap->object_lock );
520 /* Remove a SAP Announce */
521 static int announce_SAPAnnounceDel( sap_handler_t *p_sap,
522 session_descriptor_t *p_session )
525 vlc_mutex_lock( &p_sap->object_lock );
527 msg_Dbg( p_sap,"removing SAP announce %p",p_session->p_sap);
529 /* Dequeue the announce */
530 for( i = 0; i< p_sap->i_sessions; i++)
532 if( p_session->p_sap == p_sap->pp_sessions[i] )
534 REMOVE_ELEM( p_sap->pp_sessions,
538 FREENULL( p_session->p_sap->psz_sdp );
539 FREENULL( p_session->p_sap->psz_data );
540 free( p_session->p_sap );
545 /* XXX: Dequeue the address too if it is not used anymore
546 * TODO: - address refcount
547 - send a SAP deletion packet */
549 msg_Dbg( p_sap,"%i announcements remaining", p_sap->i_sessions );
551 vlc_mutex_unlock( &p_sap->object_lock );
556 static int announce_SendSAPAnnounce( sap_handler_t *p_sap,
557 sap_session_t *p_session )
561 /* This announce has never been sent yet */
562 if( p_session->i_last == 0 )
564 p_session->i_next = mdate()+ p_session->p_address->i_interval*1000000;
565 p_session->i_last = 1;
569 if( p_session->i_next < mdate() )
572 msg_Dbg( p_sap, "sending announce");
574 i_ret = net_Write( p_sap, p_session->p_address->i_wfd, NULL,
576 p_session->i_length );
577 if( i_ret != (int)p_session->i_length )
579 msg_Warn( p_sap, "SAP send failed on address %s (%i %i)",
580 p_session->p_address->psz_address,
581 i_ret, p_session->i_length );
583 p_session->i_last = p_session->i_next;
584 p_session->i_next = p_session->i_last
585 + p_session->p_address->i_interval*1000000;
594 static char *SDPGenerate( sap_handler_t *p_sap,
595 const session_descriptor_t *p_session,
596 const sap_address_t *p_addr, vlc_bool_t b_ssm )
598 int64_t i_sdp_id = mdate();
599 int i_sdp_version = 1 + p_sap->i_sessions + (rand()&0xfff);
600 char *psz_group, *psz_name, psz_uribuf[NI_MAXNUMERICHOST], *psz_uri,
604 psz_group = p_session->psz_group;
605 psz_name = p_session->psz_name;
607 /* FIXME: really check that psz_uri is a real IP address
608 * FIXME: make a common function to obtain a canonical IP address */
609 ipv = ( strchr( p_session->psz_uri, ':' ) != NULL) ? '6' : '4';
610 if( *p_session->psz_uri == '[' )
614 strlcpy( psz_uribuf, p_session->psz_uri + 1, sizeof( psz_uribuf ) );
615 ptr = strchr( psz_uribuf, '%' );
618 ptr = strchr( psz_uribuf, ']' );
621 psz_uri = psz_uribuf;
624 psz_uri = p_session->psz_uri;
626 char *sfilter = NULL;
629 if (asprintf (&sfilter, "a=source-filter: incl IN IP%c * %s\r\n",
630 ipv, p_addr->psz_machine) == -1)
634 /* see the lists in modules/stream_out/rtp.c for compliance stuff */
635 int res = asprintf (&psz_sdp,
637 "o=- "I64Fd" %d IN IP%c %s\r\n"
639 "c=IN IP%c %s/%d\r\n"
641 "a=tool:"PACKAGE_STRING"\r\n"
645 "m=video %d %s %d\r\n"
647 i_sdp_id, i_sdp_version,
648 ipv, p_addr->psz_machine,
649 psz_name, ipv, psz_uri,
650 (p_session->i_ttl != -1) ? p_session->i_ttl : 255,
651 (sfilter != NULL) ? sfilter : "",
653 p_session->b_rtp ? "RTP/AVP" : "udp",
654 p_session->i_payload,
655 psz_group ? "a=x-plgroup:" : "",
656 psz_group ? psz_group : "", psz_group ? "\r\n" : "");
663 msg_Dbg( p_sap, "Generated SDP (%i bytes):\n%s", strlen(psz_sdp),
668 static int CalculateRate( sap_handler_t *p_sap, sap_address_t *p_address )
671 uint8_t buffer[SAP_MAX_BUFFER];
676 if( p_address->t1 == 0 )
678 p_address->t1 = mdate();
683 /* Might be too slow if we have huge data */
684 i_read = net_ReadNonBlock( p_sap, p_address->i_rfd, NULL, buffer,
687 } while( i_read > 0 );
691 /* We calculate the rate every 5 seconds */
692 if( i_temp - p_address->t1 < 5000000 )
694 p_address->i_buff += i_tot;
699 i_rate = (int)(8*1000000*((mtime_t)p_address->i_buff + (mtime_t)i_tot ) /
700 (i_temp - p_address->t1 ));
702 p_address->i_limit = 10000;
704 p_address->i_interval = ((1000*i_rate / p_address->i_limit) *
705 (MAX_INTERVAL - MIN_INTERVAL))/1000 + MIN_INTERVAL;
707 if( p_address->i_interval > MAX_INTERVAL || p_address->i_interval < 0 )
709 p_address->i_interval = MAX_INTERVAL;
712 msg_Dbg( p_sap,"%s:%i: rate=%i, interval = %i s",
713 p_address->psz_address,SAP_PORT, i_rate, p_address->i_interval );
716 p_address->b_ready = VLC_TRUE;
718 p_address->t1 = i_temp;
719 p_address->i_buff = 0;