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() */
37 #include <vlc_network.h>
38 #include <vlc_charset.h>
40 #include "stream_output.h"
42 /* SAP is always on that port */
45 #define DEFAULT_PORT "1234"
49 /* SAP Specific structures */
52 #define SAP_IDLE ((mtime_t)(0.100*CLOCK_FREQ))
53 #define SAP_MAX_BUFFER 65534
54 #define MIN_INTERVAL 2
55 #define MAX_INTERVAL 300
57 /* A SAP announce address. For each of these, we run the
58 * control flow algorithm */
62 char psz_machine[NI_MAXNUMERICHOST];
63 int i_rfd; /* Read socket */
64 int i_wfd; /* Write socket */
66 /* Used for flow control */
75 /* A SAP session descriptor, enqueued in the SAP handler queue */
76 struct sap_session_t {
80 sap_address_t *p_address;
81 session_descriptor_t *p_sd;
83 /* Last and next send */
88 /*****************************************************************************
90 *****************************************************************************/
91 static void RunThread( vlc_object_t *p_this);
92 static int CalculateRate( sap_handler_t *p_sap, sap_address_t *p_address );
93 static char *SDPGenerate( sap_handler_t *p_sap,
94 const session_descriptor_t *p_session,
95 const sap_address_t *p_addr, vlc_bool_t b_ssm );
97 static int announce_SendSAPAnnounce( sap_handler_t *p_sap,
98 sap_session_t *p_session );
101 static int announce_SAPAnnounceAdd( sap_handler_t *p_sap,
102 session_descriptor_t *p_session );
104 static int announce_SAPAnnounceDel( sap_handler_t *p_sap,
105 session_descriptor_t *p_session );
109 * Create the SAP handler
111 * \param p_announce the parent announce_handler
112 * \return the newly created SAP handler or NULL on error
114 sap_handler_t *announce_SAPHandlerCreate( announce_handler_t *p_announce )
116 sap_handler_t *p_sap;
118 p_sap = vlc_object_create( p_announce, sizeof( sap_handler_t ) );
122 msg_Err( p_announce, "out of memory" );
126 vlc_mutex_init( p_sap, &p_sap->object_lock );
128 p_sap->pf_add = announce_SAPAnnounceAdd;
129 p_sap->pf_del = announce_SAPAnnounceDel;
131 p_sap->i_sessions = 0;
132 p_sap->i_addresses = 0;
133 p_sap->i_current_session = 0;
135 p_sap->b_control = config_GetInt( p_sap, "sap-flow-control");
137 if( vlc_thread_create( p_sap, "sap handler", RunThread,
138 VLC_THREAD_PRIORITY_LOW, VLC_FALSE ) )
140 msg_Dbg( p_announce, "unable to spawn SAP handler thread");
144 msg_Dbg( p_announce, "thread created, %i sessions", p_sap->i_sessions);
149 * Destroy the SAP handler
150 * \param p_this the SAP Handler to destroy
153 void announce_SAPHandlerDestroy( sap_handler_t *p_sap )
157 vlc_mutex_destroy( &p_sap->object_lock );
159 /* Free the remaining sessions */
160 for( i = 0 ; i< p_sap->i_sessions ; i++)
162 sap_session_t *p_session = p_sap->pp_sessions[i];
163 FREENULL( p_session->psz_sdp );
164 FREENULL( p_session->psz_data );
165 REMOVE_ELEM( p_sap->pp_sessions, p_sap->i_sessions , i );
166 FREENULL( p_session );
169 /* Free the remaining addresses */
170 for( i = 0 ; i< p_sap->i_addresses ; i++)
172 sap_address_t *p_address = p_sap->pp_addresses[i];
173 FREENULL( p_address->psz_address );
174 if( p_address->i_rfd > -1 )
176 net_Close( p_address->i_rfd );
178 if( p_address->i_wfd > -1 && p_sap->b_control )
180 net_Close( p_address->i_wfd );
182 REMOVE_ELEM( p_sap->pp_addresses, p_sap->i_addresses, i );
183 FREENULL( p_address );
186 /* Free the structure */
187 vlc_object_destroy( p_sap );
191 * main SAP handler thread
192 * \param p_this the SAP Handler object
195 static void RunThread( vlc_object_t *p_this)
197 sap_handler_t *p_sap = (sap_handler_t*)p_this;
198 sap_session_t *p_session;
200 while( !p_sap->b_die )
204 /* If needed, get the rate info */
205 if( p_sap->b_control == VLC_TRUE )
207 for( i = 0 ; i< p_sap->i_addresses ; i++)
209 if( p_sap->pp_addresses[i]->b_enabled == VLC_TRUE )
211 CalculateRate( p_sap, p_sap->pp_addresses[i] );
216 /* Find the session to announce */
217 vlc_mutex_lock( &p_sap->object_lock );
218 if( p_sap->i_sessions > p_sap->i_current_session + 1)
220 p_sap->i_current_session++;
222 else if( p_sap->i_sessions > 0)
224 p_sap->i_current_session = 0;
228 vlc_mutex_unlock( &p_sap->object_lock );
232 p_session = p_sap->pp_sessions[p_sap->i_current_session];
233 vlc_mutex_unlock( &p_sap->object_lock );
235 /* And announce it */
236 if( p_session->p_address->b_enabled == VLC_TRUE &&
237 p_session->p_address->b_ready == VLC_TRUE )
239 announce_SendSAPAnnounce( p_sap, p_session );
246 /* Add a SAP announce */
247 static int announce_SAPAnnounceAdd( sap_handler_t *p_sap,
248 session_descriptor_t *p_session )
250 int i_header_size, i;
251 char *psz_head, psz_addr[NI_MAXNUMERICHOST];
252 vlc_bool_t b_ipv6 = VLC_FALSE, b_ssm = VLC_FALSE;
253 sap_session_t *p_sap_session;
255 struct addrinfo hints, *res;
256 struct sockaddr_storage addr;
259 vlc_mutex_lock( &p_sap->object_lock );
261 if( p_session->psz_uri == NULL )
263 vlc_mutex_unlock( &p_sap->object_lock );
264 msg_Err( p_sap, "*FIXME* unexpected NULL URI for SAP announce" );
265 msg_Err( p_sap, "This should not happen. VLC needs fixing." );
268 /* Determine SAP multicast address automatically */
269 memset( &hints, 0, sizeof( hints ) );
270 hints.ai_socktype = SOCK_DGRAM;
271 hints.ai_flags = AI_NUMERICHOST;
273 i = vlc_getaddrinfo( (vlc_object_t *)p_sap, p_session->psz_uri, 0,
277 vlc_mutex_unlock( &p_sap->object_lock );
278 msg_Err( p_sap, "Invalid URI for SAP announce: %s: %s",
279 p_session->psz_uri, vlc_gai_strerror( i ) );
283 addrlen = res->ai_addrlen;
284 if ((unsigned)addrlen > sizeof (addr))
286 vlc_mutex_unlock( &p_sap->object_lock );
287 vlc_freeaddrinfo( res );
288 msg_Err( p_sap, "Unsupported address family of size %d > %u",
289 res->ai_addrlen, (unsigned) sizeof( addr ) );
293 memcpy (&addr, res->ai_addr, addrlen);
294 vlc_freeaddrinfo (res);
296 switch( addr.ss_family )
298 #if defined (HAVE_INET_PTON) || defined (WIN32)
301 /* See RFC3513 for list of valid IPv6 scopes */
302 struct in6_addr *a6 = &((struct sockaddr_in6 *)&addr)->sin6_addr;
304 memcpy( a6->s6_addr + 2, "\x00\x00\x00\x00\x00\x00"
305 "\x00\x00\x00\x00\x00\x02\x7f\xfe", 14 );
306 if( IN6_IS_ADDR_MULTICAST( a6 ) )
308 /* SSM <=> ff3x::/32 */
309 b_ssm = (U32_AT (a6->s6_addr) & 0xfff0ffff) == 0xff300000;
311 /* force flags to zero, preserve scope */
312 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 if ((ipv4 & 0xff000000) == 0xef000000)
344 /* other addresses => 224.2.127.254 */
346 /* SSM: 232.0.0.0/8 */
347 b_ssm = (ipv4 >> 24) == 232;
353 msg_Err( p_sap, "Out-of-scope multicast address "
354 "not supported by SAP: %s", p_session->psz_uri );
355 vlc_mutex_unlock( &p_sap->object_lock );
359 ((struct sockaddr_in *)&addr)->sin_addr.s_addr = htonl( ipv4 );
364 vlc_mutex_unlock( &p_sap->object_lock );
365 msg_Err( p_sap, "Address family %d not supported by SAP",
370 i = vlc_getnameinfo( (struct sockaddr *)&addr, addrlen,
371 psz_addr, sizeof( psz_addr ), NULL, NI_NUMERICHOST );
375 vlc_mutex_unlock( &p_sap->object_lock );
376 msg_Err( p_sap, "%s", vlc_gai_strerror( i ) );
380 msg_Dbg( p_sap, "using SAP address: %s", psz_addr);
382 /* XXX: Check for dupes */
383 p_sap_session = (sap_session_t*)malloc(sizeof(sap_session_t));
384 p_sap_session->p_sd = p_session;
385 p_sap_session->p_address = NULL;
387 /* Add the address to the buffer */
388 for( i = 0; i < p_sap->i_addresses; i++)
390 if( !strcmp( psz_addr, p_sap->pp_addresses[i]->psz_address ) )
392 p_sap_session->p_address = p_sap->pp_addresses[i];
397 if( p_sap_session->p_address == NULL )
399 sap_address_t *p_address = (sap_address_t *)
400 malloc( sizeof(sap_address_t) );
403 msg_Err( p_sap, "out of memory" );
406 p_address->psz_address = strdup( psz_addr );
407 p_address->i_wfd = net_ConnectUDP( VLC_OBJECT(p_sap), psz_addr, SAP_PORT, 255 );
408 if( p_address->i_wfd != -1 )
412 net_StopRecv( p_address->i_wfd );
413 net_GetSockAddress( p_address->i_wfd, p_address->psz_machine,
416 /* removes scope if present */
417 ptr = strchr( p_address->psz_machine, '%' );
422 if( p_sap->b_control == VLC_TRUE )
424 p_address->i_rfd = net_ListenUDP1( (vlc_object_t*)p_sap, psz_addr, SAP_PORT );
425 if( p_address->i_rfd != -1 )
426 net_StopSend( p_address->i_rfd );
427 p_address->i_buff = 0;
428 p_address->b_enabled = VLC_TRUE;
429 p_address->b_ready = VLC_FALSE;
430 p_address->i_limit = 10000; /* 10000 bps */
435 p_address->b_enabled = VLC_TRUE;
436 p_address->b_ready = VLC_TRUE;
437 p_address->i_interval = config_GetInt( p_sap,"sap-interval");
438 p_address->i_rfd = -1;
441 if( p_address->i_wfd == -1 || (p_address->i_rfd == -1
442 && p_sap->b_control ) )
444 msg_Warn( p_sap, "disabling address" );
445 p_address->b_enabled = VLC_FALSE;
448 INSERT_ELEM( p_sap->pp_addresses,
452 p_sap_session->p_address = p_address;
456 /* Build the SAP Headers */
457 i_header_size = ( b_ipv6 ? 16 : 4 ) + 20;
458 psz_head = (char *) malloc( i_header_size * sizeof( char ) );
459 if( psz_head == NULL )
461 msg_Err( p_sap, "out of memory" );
465 /* SAPv1, not encrypted, not compressed */
466 psz_head[0] = b_ipv6 ? 0x30 : 0x20;
467 psz_head[1] = 0x00; /* No authentification length */
470 psz_head[2] = (i_hash & 0xFF00) >> 8; /* Msg id hash */
471 psz_head[3] = (i_hash & 0xFF); /* Msg id hash 2 */
473 #if defined (HAVE_INET_PTON) || defined (WIN32)
476 inet_pton( AF_INET6, /* can't fail */
477 p_sap_session->p_address->psz_machine,
483 inet_pton( AF_INET, /* can't fail */
484 p_sap_session->p_address->psz_machine,
488 memcpy( psz_head + (b_ipv6 ? 20 : 8), "application/sdp", 15 );
490 /* If needed, build the SDP */
491 if( p_session->psz_sdp == NULL )
493 p_session->psz_sdp = SDPGenerate( p_sap, p_session,
494 p_sap_session->p_address, b_ssm );
495 if( p_session->psz_sdp == NULL )
497 vlc_mutex_unlock( &p_sap->object_lock );
502 p_sap_session->psz_sdp = strdup( p_session->psz_sdp );
503 p_sap_session->i_last = 0;
505 psz_head[ i_header_size-1 ] = '\0';
506 p_sap_session->i_length = i_header_size + strlen( p_sap_session->psz_sdp);
508 p_sap_session->psz_data = (uint8_t *)malloc( sizeof(char)*
509 p_sap_session->i_length );
511 /* Build the final message */
512 memcpy( p_sap_session->psz_data, psz_head, i_header_size );
513 memcpy( p_sap_session->psz_data+i_header_size, p_sap_session->psz_sdp,
514 strlen( p_sap_session->psz_sdp) );
518 /* Enqueue the announce */
519 INSERT_ELEM( p_sap->pp_sessions,
523 msg_Dbg( p_sap,"%i addresses, %i sessions",
524 p_sap->i_addresses,p_sap->i_sessions);
526 vlc_mutex_unlock( &p_sap->object_lock );
531 /* Remove a SAP Announce */
532 static int announce_SAPAnnounceDel( sap_handler_t *p_sap,
533 session_descriptor_t *p_session )
536 vlc_mutex_lock( &p_sap->object_lock );
538 msg_Dbg( p_sap, "removing session %p from SAP", p_session);
540 /* Dequeue the announce */
541 for( i = 0; i< p_sap->i_sessions; i++)
543 if( p_session == p_sap->pp_sessions[i]->p_sd )
545 sap_session_t *p_mysession = p_sap->pp_sessions[i];
546 REMOVE_ELEM( p_sap->pp_sessions,
550 free( p_mysession->psz_sdp );
551 free( p_mysession->psz_data );
557 /* XXX: Dequeue the address too if it is not used anymore
558 * TODO: - address refcount
559 - send a SAP deletion packet */
561 msg_Dbg( p_sap,"%i announcements remaining", p_sap->i_sessions );
563 vlc_mutex_unlock( &p_sap->object_lock );
568 static int announce_SendSAPAnnounce( sap_handler_t *p_sap,
569 sap_session_t *p_session )
573 /* This announce has never been sent yet */
574 if( p_session->i_last == 0 )
576 p_session->i_next = mdate()+ p_session->p_address->i_interval*1000000;
577 p_session->i_last = 1;
581 if( p_session->i_next < mdate() )
584 msg_Dbg( p_sap, "sending announce");
586 i_ret = net_Write( p_sap, p_session->p_address->i_wfd, NULL,
588 p_session->i_length );
589 if( i_ret != (int)p_session->i_length )
591 msg_Warn( p_sap, "SAP send failed on address %s (%i %i)",
592 p_session->p_address->psz_address,
593 i_ret, p_session->i_length );
595 p_session->i_last = p_session->i_next;
596 p_session->i_next = p_session->i_last
597 + p_session->p_address->i_interval*1000000;
606 static char *SDPGenerate( sap_handler_t *p_sap,
607 const session_descriptor_t *p_session,
608 const sap_address_t *p_addr, vlc_bool_t b_ssm )
610 int64_t i_sdp_id = mdate();
611 int i_sdp_version = 1 + p_sap->i_sessions + (rand()&0xfff);
612 char *psz_group, *psz_name, psz_uribuf[NI_MAXNUMERICHOST], *psz_uri,
616 psz_group = p_session->psz_group;
617 psz_name = p_session->psz_name;
619 /* FIXME: really check that psz_uri is a real IP address
620 * FIXME: make a common function to obtain a canonical IP address */
621 ipv = ( strchr( p_session->psz_uri, ':' ) != NULL) ? '6' : '4';
622 if( *p_session->psz_uri == '[' )
626 strlcpy( psz_uribuf, p_session->psz_uri + 1, sizeof( psz_uribuf ) );
627 ptr = strchr( psz_uribuf, '%' );
630 ptr = strchr( psz_uribuf, ']' );
633 psz_uri = psz_uribuf;
636 psz_uri = p_session->psz_uri;
638 char *sfilter = NULL;
641 if (asprintf (&sfilter, "a=source-filter: incl IN IP%c * %s\r\n",
642 ipv, p_addr->psz_machine) == -1)
646 int res = asprintf (&psz_sdp,
648 "o=- "I64Fd" %d IN IP%c %s\r\n"
650 "c=IN IP%c %s/255\r\n"
652 "a=tool:"PACKAGE_STRING"\r\n"
656 "m=video %d %s %d\r\n"
658 i_sdp_id, i_sdp_version,
659 ipv, p_addr->psz_machine,
660 psz_name, ipv, psz_uri,
661 (sfilter != NULL) ? sfilter : "",
663 p_session->b_rtp ? "RTP/AVP" : "udp",
664 p_session->i_payload,
665 psz_group ? "a=x-plgroup:" : "",
666 psz_group ? psz_group : "", psz_group ? "\r\n" : "");
673 msg_Dbg( p_sap, "Generated SDP (%i bytes):\n%s", strlen(psz_sdp),
678 static int CalculateRate( sap_handler_t *p_sap, sap_address_t *p_address )
681 uint8_t buffer[SAP_MAX_BUFFER];
686 if( p_address->t1 == 0 )
688 p_address->t1 = mdate();
693 /* Might be too slow if we have huge data */
694 i_read = net_ReadNonBlock( p_sap, p_address->i_rfd, NULL, buffer,
697 } while( i_read > 0 );
701 /* We calculate the rate every 5 seconds */
702 if( i_temp - p_address->t1 < 5000000 )
704 p_address->i_buff += i_tot;
709 i_rate = (int)(8*1000000*((mtime_t)p_address->i_buff + (mtime_t)i_tot ) /
710 (i_temp - p_address->t1 ));
712 p_address->i_limit = 10000;
714 p_address->i_interval = ((1000*i_rate / p_address->i_limit) *
715 (MAX_INTERVAL - MIN_INTERVAL))/1000 + MIN_INTERVAL;
717 if( p_address->i_interval > MAX_INTERVAL || p_address->i_interval < 0 )
719 p_address->i_interval = MAX_INTERVAL;
722 msg_Dbg( p_sap,"%s:%i: rate=%i, interval = %i s",
723 p_address->psz_address,SAP_PORT, i_rate, p_address->i_interval );
726 p_address->b_ready = VLC_TRUE;
728 p_address->t1 = i_temp;
729 p_address->i_buff = 0;