]> git.sesse.net Git - vlc/blob - src/stream_output/sap.c
size_t / int confusion
[vlc] / src / stream_output / sap.c
1 /*****************************************************************************
2  * sap.c : SAP announce handler
3  *****************************************************************************
4  * Copyright (C) 2002-2007 the VideoLAN team
5  * $Id$
6  *
7  * Authors: Clément Stenac <zorglub@videolan.org>
8  *          Rémi Denis-Courmont <rem # videolan.org>
9  *
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.
14  *
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.
19  *
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  *****************************************************************************/
24
25 /*****************************************************************************
26  * Preamble
27  *****************************************************************************/
28
29 #include <vlc/vlc.h>
30
31 #include <stdlib.h>                                                /* free() */
32 #include <stdio.h>                                              /* sprintf() */
33 #include <string.h>                                            /* strerror() */
34 #include <ctype.h>                                  /* tolower(), isxdigit() */
35
36 #include <vlc_sout.h>
37 #include <vlc_network.h>
38 #include <vlc_charset.h>
39
40 #include "stream_output.h"
41
42 /* SAP is always on that port */
43 #define SAP_PORT 9875
44
45 #define DEFAULT_PORT "1234"
46
47 #undef EXTRA_DEBUG
48
49 /* SAP Specific structures */
50
51 /* 100ms */
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
56
57 /* A SAP announce address. For each of these, we run the
58  * control flow algorithm */
59 struct sap_address_t
60 {
61     char *psz_address;
62     struct sockaddr_storage orig;
63     socklen_t origlen;
64     int i_rfd; /* Read socket */
65     int i_wfd; /* Write socket */
66
67     /* Used for flow control */
68     mtime_t t1;
69     vlc_bool_t b_enabled;
70     vlc_bool_t b_ready;
71     int i_interval;
72     int i_buff;
73     int i_limit;
74 };
75
76 /* A SAP session descriptor, enqueued in the SAP handler queue */
77 struct sap_session_t {
78     uint8_t       *psz_data;
79     unsigned      i_length;
80     sap_address_t *p_address;
81     session_descriptor_t *p_sd;
82
83     /* Last and next send */
84     mtime_t        i_last;
85     mtime_t        i_next;
86 };
87
88 /*****************************************************************************
89  * Local prototypes
90  *****************************************************************************/
91 static void RunThread( vlc_object_t *p_this);
92 static int ComputeRate( sap_address_t *p_address );
93 static char *SDPGenerate( sap_handler_t *p_sap,
94                           const session_descriptor_t *p_session,
95                           vlc_bool_t b_ssm );
96
97 static int announce_SendSAPAnnounce( sap_handler_t *p_sap,
98                                      sap_session_t *p_session );
99
100
101 static int announce_SAPAnnounceAdd( sap_handler_t *p_sap,
102                              session_descriptor_t *p_session );
103
104 static int announce_SAPAnnounceDel( sap_handler_t *p_sap,
105                              session_descriptor_t *p_session );
106
107
108 /**
109  * Create the SAP handler
110  *
111  * \param p_announce the parent announce_handler
112  * \return the newly created SAP handler or NULL on error
113  */
114 sap_handler_t *announce_SAPHandlerCreate( announce_handler_t *p_announce )
115 {
116     sap_handler_t *p_sap;
117
118     p_sap = vlc_object_create( p_announce, sizeof( sap_handler_t ) );
119
120     if( !p_sap )
121     {
122         msg_Err( p_announce, "out of memory" );
123         return NULL;
124     }
125
126     vlc_mutex_init( p_sap, &p_sap->object_lock );
127
128     p_sap->pf_add = announce_SAPAnnounceAdd;
129     p_sap->pf_del = announce_SAPAnnounceDel;
130
131     p_sap->i_sessions = 0;
132     p_sap->i_addresses = 0;
133     p_sap->i_current_session = 0;
134
135     p_sap->b_control = config_GetInt( p_sap, "sap-flow-control");
136
137     if( vlc_thread_create( p_sap, "sap handler", RunThread,
138                        VLC_THREAD_PRIORITY_LOW, VLC_FALSE ) )
139     {
140         msg_Dbg( p_announce, "unable to spawn SAP handler thread");
141         free( p_sap );
142         return NULL;
143     };
144     msg_Dbg( p_announce, "thread created, %i sessions", p_sap->i_sessions);
145     return p_sap;
146 }
147
148 /**
149  *  Destroy the SAP handler
150  *  \param p_this the SAP Handler to destroy
151  *  \return nothing
152  */
153 void announce_SAPHandlerDestroy( sap_handler_t *p_sap )
154 {
155     int i;
156
157     vlc_mutex_destroy( &p_sap->object_lock );
158
159     /* Free the remaining sessions */
160     for( i = 0 ; i< p_sap->i_sessions ; i++)
161     {
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 );
166     }
167
168     /* Free the remaining addresses */
169     for( i = 0 ; i< p_sap->i_addresses ; i++)
170     {
171         sap_address_t *p_address = p_sap->pp_addresses[i];
172         FREENULL( p_address->psz_address );
173         if( p_address->i_rfd > -1 )
174         {
175             net_Close( p_address->i_rfd );
176         }
177         if( p_address->i_wfd > -1 && p_sap->b_control )
178         {
179             net_Close( p_address->i_wfd );
180         }
181         REMOVE_ELEM( p_sap->pp_addresses, p_sap->i_addresses, i );
182         FREENULL( p_address );
183     }
184
185     /* Free the structure */
186     vlc_object_destroy( p_sap );
187 }
188
189 /**
190  * main SAP handler thread
191  * \param p_this the SAP Handler object
192  * \return nothing
193  */
194 static void RunThread( vlc_object_t *p_this)
195 {
196     sap_handler_t *p_sap = (sap_handler_t*)p_this;
197     sap_session_t *p_session;
198
199     while( !p_sap->b_die )
200     {
201         int i;
202
203         /* If needed, get the rate info */
204         if( p_sap->b_control == VLC_TRUE )
205         {
206             for( i = 0 ; i< p_sap->i_addresses ; i++)
207             {
208                 if( p_sap->pp_addresses[i]->b_enabled == VLC_TRUE )
209                 {
210                     ComputeRate( p_sap->pp_addresses[i] );
211                 }
212             }
213         }
214
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)
218         {
219             p_sap->i_current_session++;
220         }
221         else if( p_sap->i_sessions > 0)
222         {
223             p_sap->i_current_session = 0;
224         }
225         else
226         {
227             vlc_mutex_unlock( &p_sap->object_lock );
228             msleep( SAP_IDLE );
229             continue;
230         }
231         p_session = p_sap->pp_sessions[p_sap->i_current_session];
232         vlc_mutex_unlock( &p_sap->object_lock );
233
234         /* And announce it */
235         if( p_session->p_address->b_enabled == VLC_TRUE &&
236             p_session->p_address->b_ready == VLC_TRUE )
237         {
238             announce_SendSAPAnnounce( p_sap, p_session );
239         }
240
241         msleep( SAP_IDLE );
242     }
243 }
244
245 /* Add a SAP announce */
246 static int announce_SAPAnnounceAdd( sap_handler_t *p_sap,
247                              session_descriptor_t *p_session )
248 {
249     int i;
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;
253     mtime_t i_hash;
254     struct sockaddr_storage addr;
255     socklen_t addrlen;
256
257     vlc_mutex_lock( &p_sap->object_lock );
258     addrlen = p_session->addrlen;
259     if ((addrlen == 0) || (addrlen > sizeof (addr)))
260     {
261         vlc_mutex_unlock( &p_sap->object_lock );
262         msg_Err( p_sap, "No/invalid address specified for SAP announce" );
263         return VLC_EGENERIC;
264     }
265
266     /* Determine SAP multicast address automatically */
267     memcpy (&addr, &p_session->addr, addrlen);
268
269     switch( p_session->addr.ss_family )
270     {
271 #if defined (HAVE_INET_PTON) || defined (WIN32)
272         case AF_INET6:
273         {
274             /* See RFC3513 for list of valid IPv6 scopes */
275             struct in6_addr *a6 = &((struct sockaddr_in6 *)&addr)->sin6_addr;
276
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 ) )
280             {
281                 /* SSM <=> ff3x::/32 */
282                 b_ssm = (U32_AT (a6->s6_addr) & 0xfff0ffff) == 0xff300000;
283
284                 /* force flags to zero, preserve scope */
285                 a6->s6_addr[1] &= 0xf;
286             }
287             else
288                 /* Unicast IPv6 - assume global scope */
289                 memcpy( a6->s6_addr, "\xff\x0e", 2 );
290
291             b_ipv6 = VLC_TRUE;
292             break;
293         }
294 #endif
295
296         case AF_INET:
297         {
298             /* See RFC2365 for IPv4 scopes */
299             uint32_t ipv4;
300
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)
304                 ipv4 =  0xe00000ff;
305             else
306             /* 239.255.0.0/16 => 239.255.255.255 */
307             if ((ipv4 & 0xffff0000) == 0xefff0000)
308                 ipv4 =  0xefffffff;
309             else
310             /* 239.192.0.0/14 => 239.195.255.255 */
311             if ((ipv4 & 0xfffc0000) == 0xefc00000)
312                 ipv4 =  0xefc3ffff;
313             else
314             if ((ipv4 & 0xff000000) == 0xef000000)
315                 ipv4 = 0;
316             else
317             /* other addresses => 224.2.127.254 */
318             {
319                 /* SSM: 232.0.0.0/8 */
320                 b_ssm = (ipv4 >> 24) == 232;
321                 ipv4 = 0xe0027ffe;
322             }
323
324             if( ipv4 == 0 )
325             {
326                 msg_Err( p_sap, "Out-of-scope multicast address "
327                          "not supported by SAP" );
328                 vlc_mutex_unlock( &p_sap->object_lock );
329                 return VLC_EGENERIC;
330             }
331
332             ((struct sockaddr_in *)&addr)->sin_addr.s_addr = htonl( ipv4 );
333             break;
334         }
335
336         default:
337             vlc_mutex_unlock( &p_sap->object_lock );
338             msg_Err( p_sap, "Address family %d not supported by SAP",
339                      addr.ss_family );
340             return VLC_EGENERIC;
341     }
342
343     i = vlc_getnameinfo( (struct sockaddr *)&addr, addrlen,
344                          psz_addr, sizeof( psz_addr ), NULL, NI_NUMERICHOST );
345
346     if( i )
347     {
348         vlc_mutex_unlock( &p_sap->object_lock );
349         msg_Err( p_sap, "%s", vlc_gai_strerror( i ) );
350         return VLC_EGENERIC;
351     }
352
353     msg_Dbg( p_sap, "using SAP address: %s", psz_addr);
354
355     /* XXX: Check for dupes */
356     p_sap_session = (sap_session_t*)malloc(sizeof(sap_session_t));
357     p_sap_session->p_sd = p_session;
358     p_sap_session->p_address = NULL;
359
360     /* Add the address to the buffer */
361     for( i = 0; i < p_sap->i_addresses; i++)
362     {
363         if( !strcmp( psz_addr, p_sap->pp_addresses[i]->psz_address ) )
364         {
365             p_sap_session->p_address = p_sap->pp_addresses[i];
366             break;
367         }
368     }
369
370     if( p_sap_session->p_address == NULL )
371     {
372         sap_address_t *p_address = (sap_address_t *)
373                                     malloc( sizeof(sap_address_t) );
374         if( !p_address )
375         {
376             vlc_mutex_unlock( &p_sap->object_lock );
377             return VLC_ENOMEM;
378         }
379         p_address->psz_address = strdup( psz_addr );
380         p_address->i_wfd = net_ConnectUDP( VLC_OBJECT(p_sap), psz_addr, SAP_PORT, 255 );
381         if( p_address->i_wfd != -1 )
382         {
383             shutdown( p_address->i_wfd, SHUT_RD );
384             p_address->origlen = sizeof (p_address->orig);
385             getsockname (p_address->i_wfd, (struct sockaddr *)&p_address->orig,
386                          &p_address->origlen);
387         }
388
389         if( p_sap->b_control == VLC_TRUE )
390         {
391             p_address->i_rfd = net_ListenUDP1( (vlc_object_t*)p_sap, psz_addr, SAP_PORT );
392             if( p_address->i_rfd != -1 )
393                 shutdown( p_address->i_rfd, SHUT_WR );
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 */
398             p_address->t1 = 0;
399         }
400         else
401         {
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;
406         }
407
408         if( p_address->i_wfd == -1 || (p_address->i_rfd == -1
409                                         && p_sap->b_control ) )
410         {
411             msg_Warn( p_sap, "disabling address" );
412             p_address->b_enabled = VLC_FALSE;
413         }
414
415         INSERT_ELEM( p_sap->pp_addresses,
416                      p_sap->i_addresses,
417                      p_sap->i_addresses,
418                      p_address );
419         p_sap_session->p_address = p_address;
420     }
421
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);
425
426     size_t headsize = 20;
427     switch (p_session->orig.ss_family)
428     {
429 #ifdef AF_INET6
430         case AF_INET6:
431             headsize += 16;
432             break;
433 #endif
434         case AF_INET:
435             headsize += 4;
436             break;
437         default:
438             msg_Err( p_sap, "Address family %d not supported by SAP",
439                      addr.ss_family );
440             vlc_mutex_unlock( &p_sap->object_lock );
441             return VLC_EGENERIC;
442     }
443
444     /* If needed, build the SDP */
445     if( p_session->psz_sdp == NULL )
446     {
447         p_session->psz_sdp = SDPGenerate( p_sap, p_session, b_ssm );
448         if( p_session->psz_sdp == NULL )
449         {
450             vlc_mutex_unlock( &p_sap->object_lock );
451             return VLC_ENOMEM;
452         }
453     }
454
455     p_sap_session->i_last = 0;
456     p_sap_session->i_length = headsize + strlen (p_session->psz_sdp);
457     p_sap_session->psz_data = malloc (p_sap_session->i_length + 1);
458     if (p_sap_session->psz_data == NULL)
459     {
460         free (p_session->psz_sdp);
461         vlc_mutex_unlock( &p_sap->object_lock );
462         return VLC_ENOMEM;
463     }
464
465     /* Build the SAP Headers */
466     uint8_t *psz_head = p_sap_session->psz_data;
467
468     /* SAPv1, not encrypted, not compressed */
469     psz_head[0] = 0x20;
470     psz_head[1] = 0x00; /* No authentification length */
471
472     i_hash = mdate();
473     psz_head[2] = i_hash >> 8; /* Msg id hash */
474     psz_head[3] = i_hash;      /* Msg id hash 2 */
475
476     headsize = 4;
477     switch (p_session->orig.ss_family)
478     {
479 #ifdef AF_INET6
480         case AF_INET6:
481         {
482             struct in6_addr *a6 =
483                 &((struct sockaddr_in6 *)&p_session->orig)->sin6_addr;
484             memcpy (psz_head + headsize, a6, 16);
485             psz_head[0] |= 0x10; /* IPv6 flag */
486             headsize += 16;
487             break;
488         }
489 #endif
490         case AF_INET:
491         {
492             uint32_t ipv4 =
493                 (((struct sockaddr_in *)&p_session->orig)->sin_addr.s_addr);
494             memcpy (psz_head + headsize, &ipv4, 4);
495             headsize += 4;
496             break;
497         }
498
499     }
500
501     memcpy (psz_head + headsize, "application/sdp", 16);
502     headsize += 16;
503
504     /* Build the final message */
505     strcpy( (char *)psz_head + headsize, p_session->psz_sdp);
506
507     /* Enqueue the announce */
508     INSERT_ELEM( p_sap->pp_sessions,
509                  p_sap->i_sessions,
510                  p_sap->i_sessions,
511                  p_sap_session );
512     msg_Dbg( p_sap,"%i addresses, %i sessions",
513                    p_sap->i_addresses,p_sap->i_sessions);
514
515     vlc_mutex_unlock( &p_sap->object_lock );
516
517     return VLC_SUCCESS;
518 }
519
520 /* Remove a SAP Announce */
521 static int announce_SAPAnnounceDel( sap_handler_t *p_sap,
522                              session_descriptor_t *p_session )
523 {
524     int i;
525     vlc_mutex_lock( &p_sap->object_lock );
526
527     msg_Dbg( p_sap, "removing session %p from SAP", p_session);
528
529     /* Dequeue the announce */
530     for( i = 0; i< p_sap->i_sessions; i++)
531     {
532         if( p_session == p_sap->pp_sessions[i]->p_sd )
533         {
534             sap_session_t *p_mysession = p_sap->pp_sessions[i];
535             REMOVE_ELEM( p_sap->pp_sessions,
536                          p_sap->i_sessions,
537                          i );
538
539             free( p_mysession->psz_data );
540             free( p_mysession );
541             break;
542         }
543     }
544
545     /* XXX: Dequeue the address too if it is not used anymore
546      * TODO: - address refcount
547              - send a SAP deletion packet */
548
549     msg_Dbg( p_sap,"%i announcements remaining", p_sap->i_sessions );
550
551     vlc_mutex_unlock( &p_sap->object_lock );
552
553     return VLC_SUCCESS;
554 }
555
556 static int announce_SendSAPAnnounce( sap_handler_t *p_sap,
557                                      sap_session_t *p_session )
558 {
559     int i_ret;
560
561     /* This announce has never been sent yet */
562     if( p_session->i_last == 0 )
563     {
564         p_session->i_next = mdate()+ p_session->p_address->i_interval*1000000;
565         p_session->i_last = 1;
566         return VLC_SUCCESS;
567     }
568
569     if( p_session->i_next < mdate() )
570     {
571 #ifdef EXTRA_DEBUG
572         msg_Dbg( p_sap, "sending announce");
573 #endif
574         i_ret = net_Write( p_sap, p_session->p_address->i_wfd, NULL,
575                            p_session->psz_data,
576                            p_session->i_length );
577         if( i_ret != (int)p_session->i_length )
578         {
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 );
582         }
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;
586     }
587     else
588     {
589         return VLC_SUCCESS;
590     }
591     return VLC_SUCCESS;
592 }
593
594 static char *SDPGenerate( sap_handler_t *p_sap,
595                           const session_descriptor_t *p_session,
596                           vlc_bool_t b_ssm )
597 {
598     char *psz_group, *psz_name, *psz_sdp;
599
600      char *head = StartSDP (p_session->psz_name, p_session->description,
601         p_session->url, p_session->email, p_session->phone,
602         (const struct sockaddr *)&p_session->orig, p_session->origlen,
603         (const struct sockaddr *)&p_session->addr, p_session->addrlen);
604     if (head == NULL)
605         return NULL;
606
607     psz_group = p_session->psz_group;
608     psz_name = p_session->psz_name;
609
610     char *plgroup;
611     if ((psz_group == NULL)
612      || (asprintf (&plgroup, "a=x-plgroup:%s\r\n", psz_group) == -1))
613         plgroup = NULL;
614
615     const char *comedia = NULL;
616     if (!strncasecmp (p_session->sdpformat, "DCCP", 4)
617      || !strncasecmp (p_session->sdpformat, "TCP", 3))
618         comedia = "a=setup:passive\r\n"
619                   "a=connection:new\r\n";
620
621     int res = asprintf (&psz_sdp, "%s" "%s" "%s"
622                         "m=video %d %s\r\n",
623                         head,
624                         plgroup ?: "",
625                         comedia ?: "",
626                         ntohs (net_GetPort ((const struct sockaddr *)&p_session->addr)),
627                         p_session->sdpformat);
628     free (plgroup);
629
630     if (res == -1)
631         return NULL;
632
633     msg_Dbg( p_sap, "Generated SDP (%u bytes):\n%s",
634              (unsigned)strlen(psz_sdp), psz_sdp );
635     return psz_sdp;
636 }
637
638 static int ComputeRate( sap_address_t *p_address )
639 {
640     uint8_t buffer[SAP_MAX_BUFFER];
641     ssize_t i_tot = 0;
642     mtime_t i_temp;
643     int i_rate;
644
645     if( p_address->t1 == 0 )
646     {
647         p_address->t1 = mdate();
648         return VLC_SUCCESS;
649     }
650     for (;;)
651     {
652         /* Might be too slow if we have huge data */
653         ssize_t i_read = recv( p_address->i_rfd, buffer, SAP_MAX_BUFFER, 0 );
654         if (i_read == -1)
655             break;
656         i_tot += i_read;
657     }
658
659     i_temp = mdate();
660
661     /* We calculate the rate every 5 seconds */
662     if( i_temp - p_address->t1 < 5000000 )
663     {
664         p_address->i_buff += i_tot;
665         return VLC_SUCCESS;
666     }
667
668     /* Bits/second */
669     i_rate = (int)(8*1000000*((mtime_t)p_address->i_buff + (mtime_t)i_tot ) /
670                         (i_temp - p_address->t1 ));
671
672     p_address->i_limit = 10000;
673
674     p_address->i_interval = ((1000*i_rate / p_address->i_limit) *
675                             (MAX_INTERVAL - MIN_INTERVAL))/1000 + MIN_INTERVAL;
676
677     if( p_address->i_interval > MAX_INTERVAL || p_address->i_interval < 0 )
678     {
679         p_address->i_interval = MAX_INTERVAL;
680     }
681 #ifdef EXTRA_DEBUG
682     msg_Dbg( p_sap,"%s:%i: rate=%i, interval = %i s",
683              p_address->psz_address,SAP_PORT, i_rate, p_address->i_interval );
684 #endif
685
686     p_address->b_ready = VLC_TRUE;
687
688     p_address->t1 = i_temp;
689     p_address->i_buff = 0;
690
691     return VLC_SUCCESS;
692 }