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 struct sockaddr_storage orig;
64 int i_rfd; /* Read socket */
65 int i_wfd; /* Write socket */
67 /* Used for flow control */
76 /* A SAP session descriptor, enqueued in the SAP handler queue */
77 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_data );
164 REMOVE_ELEM( p_sap->pp_sessions, p_sap->i_sessions , i );
165 FREENULL( p_session );
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 FREENULL( 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 );
182 FREENULL( p_address );
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 )
250 char psz_addr[NI_MAXNUMERICHOST];
251 vlc_bool_t b_ipv6 = VLC_FALSE, b_ssm = VLC_FALSE;
252 sap_session_t *p_sap_session;
254 struct sockaddr_storage addr;
257 vlc_mutex_lock( &p_sap->object_lock );
258 addrlen = p_session->addrlen;
259 if ((addrlen == 0) || (addrlen > sizeof (addr)))
261 vlc_mutex_unlock( &p_sap->object_lock );
262 msg_Err( p_sap, "No/invalid address specified for SAP announce" );
266 /* Determine SAP multicast address automatically */
267 memcpy (&addr, &p_session->addr, addrlen);
269 switch( p_session->addr.ss_family )
271 #if defined (HAVE_INET_PTON) || defined (WIN32)
274 /* See RFC3513 for list of valid IPv6 scopes */
275 struct in6_addr *a6 = &((struct sockaddr_in6 *)&addr)->sin6_addr;
277 memcpy( a6->s6_addr + 2, "\x00\x00\x00\x00\x00\x00"
278 "\x00\x00\x00\x00\x00\x02\x7f\xfe", 14 );
279 if( IN6_IS_ADDR_MULTICAST( a6 ) )
281 /* SSM <=> ff3x::/32 */
282 b_ssm = (U32_AT (a6->s6_addr) & 0xfff0ffff) == 0xff300000;
284 /* force flags to zero, preserve scope */
285 a6->s6_addr[1] &= 0xf;
288 /* Unicast IPv6 - assume global scope */
289 memcpy( a6->s6_addr, "\xff\x0e", 2 );
298 /* See RFC2365 for IPv4 scopes */
301 ipv4 = ntohl( ((struct sockaddr_in *)&addr)->sin_addr.s_addr );
302 /* 224.0.0.0/24 => 224.0.0.255 */
303 if ((ipv4 & 0xffffff00) == 0xe0000000)
306 /* 239.255.0.0/16 => 239.255.255.255 */
307 if ((ipv4 & 0xffff0000) == 0xefff0000)
310 /* 239.192.0.0/14 => 239.195.255.255 */
311 if ((ipv4 & 0xfffc0000) == 0xefc00000)
314 if ((ipv4 & 0xff000000) == 0xef000000)
317 /* other addresses => 224.2.127.254 */
319 /* SSM: 232.0.0.0/8 */
320 b_ssm = (ipv4 >> 24) == 232;
324 /* FIXME FIXME FIXME */
327 msg_Err( p_sap, "Out-of-scope multicast address "
328 "not supported by SAP" );
329 vlc_mutex_unlock( &p_sap->object_lock );
333 ((struct sockaddr_in *)&addr)->sin_addr.s_addr = htonl( ipv4 );
338 vlc_mutex_unlock( &p_sap->object_lock );
339 msg_Err( p_sap, "Address family %d not supported by SAP",
344 i = vlc_getnameinfo( (struct sockaddr *)&addr, addrlen,
345 psz_addr, sizeof( psz_addr ), NULL, NI_NUMERICHOST );
349 vlc_mutex_unlock( &p_sap->object_lock );
350 msg_Err( p_sap, "%s", vlc_gai_strerror( i ) );
354 msg_Dbg( p_sap, "using SAP address: %s", psz_addr);
356 /* XXX: Check for dupes */
357 p_sap_session = (sap_session_t*)malloc(sizeof(sap_session_t));
358 p_sap_session->p_sd = p_session;
359 p_sap_session->p_address = NULL;
361 /* Add the address to the buffer */
362 for( i = 0; i < p_sap->i_addresses; i++)
364 if( !strcmp( psz_addr, p_sap->pp_addresses[i]->psz_address ) )
366 p_sap_session->p_address = p_sap->pp_addresses[i];
371 if( p_sap_session->p_address == NULL )
373 sap_address_t *p_address = (sap_address_t *)
374 malloc( sizeof(sap_address_t) );
377 vlc_mutex_unlock( &p_sap->object_lock );
380 p_address->psz_address = strdup( psz_addr );
381 p_address->i_wfd = net_ConnectUDP( VLC_OBJECT(p_sap), psz_addr, SAP_PORT, 255 );
382 if( p_address->i_wfd != -1 )
384 net_StopRecv( p_address->i_wfd );
385 getsockname (p_address->i_wfd, (struct sockaddr *)&p_address->orig,
386 &p_address->origlen);
389 if( p_sap->b_control == VLC_TRUE )
391 p_address->i_rfd = net_ListenUDP1( (vlc_object_t*)p_sap, psz_addr, SAP_PORT );
392 if( p_address->i_rfd != -1 )
393 net_StopSend( p_address->i_rfd );
394 p_address->i_buff = 0;
395 p_address->b_enabled = VLC_TRUE;
396 p_address->b_ready = VLC_FALSE;
397 p_address->i_limit = 10000; /* 10000 bps */
402 p_address->b_enabled = VLC_TRUE;
403 p_address->b_ready = VLC_TRUE;
404 p_address->i_interval = config_GetInt( p_sap,"sap-interval");
405 p_address->i_rfd = -1;
408 if( p_address->i_wfd == -1 || (p_address->i_rfd == -1
409 && p_sap->b_control ) )
411 msg_Warn( p_sap, "disabling address" );
412 p_address->b_enabled = VLC_FALSE;
415 INSERT_ELEM( p_sap->pp_addresses,
419 p_sap_session->p_address = p_address;
422 if (p_session->origlen == 0)
423 memcpy (&p_session->orig, &p_sap_session->p_address->orig,
424 p_session->origlen = p_sap_session->p_address->origlen);
426 size_t headsize = 20;
427 switch (p_session->orig.ss_family)
438 msg_Err( p_sap, "Address family %d not supported by SAP",
440 vlc_mutex_unlock( &p_sap->object_lock );
444 /* If needed, build the SDP */
445 if( p_session->psz_sdp == NULL )
447 p_session->psz_sdp = SDPGenerate( p_sap, p_session,
448 p_sap_session->p_address, b_ssm );
449 if( p_session->psz_sdp == NULL )
451 vlc_mutex_unlock( &p_sap->object_lock );
456 p_sap_session->i_last = 0;
457 p_sap_session->i_length = headsize + strlen (p_session->psz_sdp);
458 p_sap_session->psz_data = malloc (p_sap_session->i_length + 1);
459 if (p_sap_session->psz_data == NULL)
461 free (p_session->psz_sdp);
462 vlc_mutex_unlock( &p_sap->object_lock );
466 /* Build the SAP Headers */
467 uint8_t *psz_head = p_sap_session->psz_data;
469 /* SAPv1, not encrypted, not compressed */
471 psz_head[1] = 0x00; /* No authentification length */
474 psz_head[2] = i_hash >> 8; /* Msg id hash */
475 psz_head[3] = i_hash; /* Msg id hash 2 */
478 switch (p_session->orig.ss_family)
483 struct in6_addr *a6 =
484 &((struct sockaddr_in6 *)&p_session->orig)->sin6_addr;
485 memcpy (psz_head + headsize, a6, 16);
486 psz_head[0] |= 0x10; /* IPv6 flag */
494 (((struct sockaddr_in *)&p_session->orig)->sin_addr.s_addr);
495 memcpy (psz_head + headsize, &ipv4, 4);
502 memcpy (psz_head + headsize, "application/sdp", 16);
505 /* Build the final message */
506 strcpy( (char *)psz_head + headsize, p_session->psz_sdp);
508 /* Enqueue the announce */
509 INSERT_ELEM( p_sap->pp_sessions,
513 msg_Dbg( p_sap,"%i addresses, %i sessions",
514 p_sap->i_addresses,p_sap->i_sessions);
516 vlc_mutex_unlock( &p_sap->object_lock );
521 /* Remove a SAP Announce */
522 static int announce_SAPAnnounceDel( sap_handler_t *p_sap,
523 session_descriptor_t *p_session )
526 vlc_mutex_lock( &p_sap->object_lock );
528 msg_Dbg( p_sap, "removing session %p from SAP", p_session);
530 /* Dequeue the announce */
531 for( i = 0; i< p_sap->i_sessions; i++)
533 if( p_session == p_sap->pp_sessions[i]->p_sd )
535 sap_session_t *p_mysession = p_sap->pp_sessions[i];
536 REMOVE_ELEM( p_sap->pp_sessions,
540 free( p_mysession->psz_data );
546 /* XXX: Dequeue the address too if it is not used anymore
547 * TODO: - address refcount
548 - send a SAP deletion packet */
550 msg_Dbg( p_sap,"%i announcements remaining", p_sap->i_sessions );
552 vlc_mutex_unlock( &p_sap->object_lock );
557 static int announce_SendSAPAnnounce( sap_handler_t *p_sap,
558 sap_session_t *p_session )
562 /* This announce has never been sent yet */
563 if( p_session->i_last == 0 )
565 p_session->i_next = mdate()+ p_session->p_address->i_interval*1000000;
566 p_session->i_last = 1;
570 if( p_session->i_next < mdate() )
573 msg_Dbg( p_sap, "sending announce");
575 i_ret = net_Write( p_sap, p_session->p_address->i_wfd, NULL,
577 p_session->i_length );
578 if( i_ret != (int)p_session->i_length )
580 msg_Warn( p_sap, "SAP send failed on address %s (%i %i)",
581 p_session->p_address->psz_address,
582 i_ret, p_session->i_length );
584 p_session->i_last = p_session->i_next;
585 p_session->i_next = p_session->i_last
586 + p_session->p_address->i_interval*1000000;
595 static char *SDPGenerate( sap_handler_t *p_sap,
596 const session_descriptor_t *p_session,
597 const sap_address_t *p_addr, vlc_bool_t b_ssm )
599 char *psz_group, *psz_name, *psz_sdp;
601 char *head = StartSDP (p_session->psz_name, p_session->description,
602 p_session->url, p_session->email, p_session->phone,
603 (const struct sockaddr *)&p_session->orig, p_session->origlen,
604 (const struct sockaddr *)&p_session->addr, p_session->addrlen);
608 psz_group = p_session->psz_group;
609 psz_name = p_session->psz_name;
612 if ((psz_group == NULL)
613 || (asprintf (&plgroup, "a=x-plgroup:%s\r\n", psz_group) == -1))
619 || (asprintf (&sfilter, "a=source-filter: incl IN IP%c * %s\r\n",
620 ipv, p_addr->psz_machine) == -1))
622 # warning FIXME: repair Source Specific Multicast
626 int res = asprintf (&psz_sdp, "%s" "%s" "%s"
627 "m=video %d %s %d\r\n",
631 net_GetPort ((const struct sockaddr *)&p_session->addr),
632 p_session->b_rtp ? "RTP/AVP" : "udp",
633 p_session->i_payload);
640 msg_Dbg( p_sap, "Generated SDP (%i bytes):\n%s", strlen(psz_sdp),
645 static int CalculateRate( sap_handler_t *p_sap, sap_address_t *p_address )
648 uint8_t buffer[SAP_MAX_BUFFER];
653 if( p_address->t1 == 0 )
655 p_address->t1 = mdate();
660 /* Might be too slow if we have huge data */
661 i_read = net_ReadNonBlock( p_sap, p_address->i_rfd, NULL, buffer,
664 } while( i_read > 0 );
668 /* We calculate the rate every 5 seconds */
669 if( i_temp - p_address->t1 < 5000000 )
671 p_address->i_buff += i_tot;
676 i_rate = (int)(8*1000000*((mtime_t)p_address->i_buff + (mtime_t)i_tot ) /
677 (i_temp - p_address->t1 ));
679 p_address->i_limit = 10000;
681 p_address->i_interval = ((1000*i_rate / p_address->i_limit) *
682 (MAX_INTERVAL - MIN_INTERVAL))/1000 + MIN_INTERVAL;
684 if( p_address->i_interval > MAX_INTERVAL || p_address->i_interval < 0 )
686 p_address->i_interval = MAX_INTERVAL;
689 msg_Dbg( p_sap,"%s:%i: rate=%i, interval = %i s",
690 p_address->psz_address,SAP_PORT, i_rate, p_address->i_interval );
693 p_address->b_ready = VLC_TRUE;
695 p_address->t1 = i_temp;
696 p_address->i_buff = 0;