]> git.sesse.net Git - vlc/blobdiff - modules/services_discovery/sap.c
vlc_plugin: fix non-LGPL plugins meta infos
[vlc] / modules / services_discovery / sap.c
index 288d307d33e78e41c31b4b1544c2d7de02d3bc68..392d213671afc573508fabc8d5d22486ba2fcd81 100644 (file)
@@ -30,6 +30,7 @@
 # include "config.h"
 #endif
 
+#define VLC_MODULE_LICENSE VLC_LICENSE_GPL_2_PLUS
 #include <vlc_common.h>
 #include <vlc_plugin.h>
 #include <assert.h>
 #include <vlc_network.h>
 #include <vlc_charset.h>
 
-#include <ctype.h>
-
-#ifdef HAVE_UNISTD_H
-#    include <unistd.h>
-#endif
-#ifdef HAVE_SYS_TIME_H
-#    include <sys/time.h>
+#include <errno.h>
+#include <unistd.h>
+#ifdef HAVE_ARPA_INET_H
+# include <arpa/inet.h>
 #endif
 #ifdef HAVE_POLL
 # include <poll.h>
@@ -56,7 +54,7 @@
 #   include <zlib.h>
 #endif
 
-#ifndef WIN32
+#ifndef _WIN32
 #   include <net/if.h>
 #endif
 
 #define SAP_ADDR_LONGTEXT N_( "The SAP module normally chooses itself the " \
                               "right addresses to listen to. However, you " \
                               "can specify a specific address." )
-#define SAP_IPV4_TEXT N_( "IPv4 SAP" )
-#define SAP_IPV4_LONGTEXT N_( \
-      "Listen to IPv4 announcements on the standard addresses." )
-#define SAP_IPV6_TEXT N_( "IPv6 SAP" )
-#define SAP_IPV6_LONGTEXT N_( \
-      "Listen to IPv6 announcements on the standard addresses." )
-#define SAP_SCOPE_TEXT N_( "IPv6 SAP scope" )
-#define SAP_SCOPE_LONGTEXT N_( \
-       "Scope for IPv6 announcements (default is 8)." )
 #define SAP_TIMEOUT_TEXT N_( "SAP timeout (seconds)" )
 #define SAP_TIMEOUT_LONGTEXT N_( \
        "Delay after which SAP items get deleted if no new announcement " \
 #define SAP_STRICT_LONGTEXT N_( \
        "When this is set, the SAP parser will discard some non-compliant " \
        "announcements." )
-#define SAP_CACHE_TEXT N_("Use SAP cache")
-#define SAP_CACHE_LONGTEXT N_( \
-       "This enables a SAP caching mechanism. " \
-       "This will result in lower SAP startup time, but you could end up " \
-       "with items corresponding to legacy streams." )
 
 /* Callbacks */
     static int  Open ( vlc_object_t * );
     static int  OpenDemux ( vlc_object_t * );
     static void CloseDemux ( vlc_object_t * );
 
-VLC_SD_PROBE_HELPER("sap", N_("Network streams (SAP)"))
+VLC_SD_PROBE_HELPER("sap", "Network streams (SAP)", SD_CAT_LAN)
 
 vlc_module_begin ()
     set_shortname( N_("SAP"))
-    set_description( N_("SAP Announcements") )
+    set_description( N_("Network streams (SAP)") )
     set_category( CAT_PLAYLIST )
     set_subcategory( SUBCAT_PLAYLIST_SD )
 
-    add_string( "sap-addr", NULL, NULL,
+    add_string( "sap-addr", NULL,
                 SAP_ADDR_TEXT, SAP_ADDR_LONGTEXT, true )
-    add_bool( "sap-ipv4", true, NULL,
-               SAP_IPV4_TEXT,SAP_IPV4_LONGTEXT, true )
-    add_bool( "sap-ipv6", true, NULL,
-              SAP_IPV6_TEXT, SAP_IPV6_LONGTEXT, true )
-    add_integer( "sap-timeout", 1800, NULL,
+    add_obsolete_bool( "sap-ipv4" ) /* since 2.0.0 */
+    add_obsolete_bool( "sap-ipv6" ) /* since 2.0.0 */
+    add_integer( "sap-timeout", 1800,
                  SAP_TIMEOUT_TEXT, SAP_TIMEOUT_LONGTEXT, true )
-    add_bool( "sap-parse", true, NULL,
+    add_bool( "sap-parse", true,
                SAP_PARSE_TEXT,SAP_PARSE_LONGTEXT, true )
-    add_bool( "sap-strict", false, NULL,
+    add_bool( "sap-strict", false,
                SAP_STRICT_TEXT,SAP_STRICT_LONGTEXT, true )
-#if 0
-    add_bool( "sap-cache", false, NULL,
-               SAP_CACHE_TEXT,SAP_CACHE_LONGTEXT, true )
-#endif
     add_obsolete_bool( "sap-timeshift" ) /* Redumdant since 1.0.0 */
 
     set_capability( "services_discovery", 0 )
@@ -194,6 +172,9 @@ struct  sdp_t
     /* s= field */
     char *psz_sessionname;
 
+    /* i= field */
+    char *psz_sessioninfo;
+
     /* old cruft */
     /* "computed" URI */
     char *psz_uri;
@@ -268,7 +249,7 @@ struct demux_sys_t
     static int ParseConnection( vlc_object_t *p_obj, sdp_t *p_sdp );
     static int ParseSAP( services_discovery_t *p_sd, const uint8_t *p_buffer, size_t i_read );
     static sdp_t *ParseSDP (vlc_object_t *p_sd, const char *psz_sdp);
-    static sap_announce_t *CreateAnnounce( services_discovery_t *, uint16_t, sdp_t * );
+    static sap_announce_t *CreateAnnounce( services_discovery_t *, uint32_t *, uint16_t, sdp_t * );
     static int RemoveAnnounce( services_discovery_t *p_sd, sap_announce_t *p_announce );
 
 /* Helper functions */
@@ -324,15 +305,8 @@ static int Open( vlc_object_t *p_this )
     p_sys->pi_fd = NULL;
     p_sys->i_fd = 0;
 
-    p_sys->b_strict = var_CreateGetInteger( p_sd, "sap-strict");
-    p_sys->b_parse = var_CreateGetInteger( p_sd, "sap-parse" );
-
-#if 0
-    if( var_CreateGetInteger( p_sd, "sap-cache" ) )
-    {
-        CacheLoad( p_sd );
-    }
-#endif
+    p_sys->b_strict = var_CreateGetBool( p_sd, "sap-strict");
+    p_sys->b_parse = var_CreateGetBool( p_sd, "sap-parse" );
 
     p_sys->i_announces = 0;
     p_sys->pp_announces = NULL;
@@ -358,7 +332,7 @@ static int OpenDemux( vlc_object_t *p_this )
     int errval = VLC_EGENERIC;
     size_t i_len;
 
-    if( !var_CreateGetInteger( p_demux, "sap-parse" ) )
+    if( !var_CreateGetBool( p_demux, "sap-parse" ) )
     {
         /* We want livedotcom module to parse this SDP file */
         return VLC_EGENERIC;
@@ -377,7 +351,7 @@ static int OpenDemux( vlc_object_t *p_this )
     for( i_len = 0, psz_sdp = NULL; i_len < 65536; )
     {
         const int i_read_max = 1024;
-        char *psz_sdp_new = realloc( psz_sdp, i_len + i_read_max );
+        char *psz_sdp_new = realloc( psz_sdp, i_len + i_read_max + 1 );
         size_t i_read;
         if( psz_sdp_new == NULL )
         {
@@ -451,13 +425,6 @@ static void Close( vlc_object_t *p_this )
     }
     FREENULL( p_sys->pi_fd );
 
-#if 0
-    if( config_GetInt( p_sd, "sap-cache" ) )
-    {
-        CacheSave( p_sd );
-    }
-#endif
-
     for( i = p_sys->i_announces  - 1;  i>= 0; i-- )
     {
         RemoveAnnounce( p_sd, p_sys->pp_announces[i] );
@@ -500,29 +467,24 @@ static void *Run( void *data )
      * Winsock 1.1 from Windows 95, if not Windows 3.1.
      * Anyway, to avoid a 30 seconds delay for failed IPv6 socket creation,
      * we have to open sockets in Run() rather than Open(). */
-    if( var_CreateGetInteger( p_sd, "sap-ipv4" ) )
+    InitSocket( p_sd, SAP_V4_GLOBAL_ADDRESS, SAP_PORT );
+    InitSocket( p_sd, SAP_V4_ORG_ADDRESS, SAP_PORT );
+    InitSocket( p_sd, SAP_V4_LOCAL_ADDRESS, SAP_PORT );
+    InitSocket( p_sd, SAP_V4_LINK_ADDRESS, SAP_PORT );
+
+    char psz_address[NI_MAXNUMERICHOST] = "ff02::2:7ffe%";
+#ifndef _WIN32
+    struct if_nameindex *l = if_nameindex ();
+    if (l != NULL)
     {
-        InitSocket( p_sd, SAP_V4_GLOBAL_ADDRESS, SAP_PORT );
-        InitSocket( p_sd, SAP_V4_ORG_ADDRESS, SAP_PORT );
-        InitSocket( p_sd, SAP_V4_LOCAL_ADDRESS, SAP_PORT );
-        InitSocket( p_sd, SAP_V4_LINK_ADDRESS, SAP_PORT );
-    }
-    if( var_CreateGetInteger( p_sd, "sap-ipv6" ) )
-    {
-        char psz_address[NI_MAXNUMERICHOST] = "ff02::2:7ffe%";
-
-#ifndef WIN32
-        struct if_nameindex *l = if_nameindex ();
-        if (l != NULL)
+        char *ptr = strchr (psz_address, '%') + 1;
+        for (unsigned i = 0; l[i].if_index; i++)
         {
-            char *ptr = strchr (psz_address, '%') + 1;
-            for (unsigned i = 0; l[i].if_index; i++)
-            {
-                strcpy (ptr, l[i].if_name);
-                InitSocket (p_sd, psz_address, SAP_PORT);
-            }
-            if_freenameindex (l);
+            strcpy (ptr, l[i].if_name);
+            InitSocket (p_sd, psz_address, SAP_PORT);
         }
+        if_freenameindex (l);
+    }
 #else
         /* this is the Winsock2 equivalant of SIOCGIFCONF on BSD stacks,
            which if_nameindex uses internally anyway */
@@ -532,7 +494,7 @@ static void *Run( void *data )
         if( s != INVALID_SOCKET )
         {
             INTERFACE_INFO ifaces[10]; // Assume there will be no more than 10 IP interfaces
-            size_t len = sizeof(ifaces);
+            DWORD len = sizeof(ifaces);
 
             if( SOCKET_ERROR != WSAIoctl(s, SIO_GET_INTERFACE_LIST, NULL, 0, &ifaces, len, &len, NULL, NULL) )
             {
@@ -547,14 +509,13 @@ static void *Run( void *data )
             closesocket(s);
         }
 #endif
-        *strchr (psz_address, '%') = '\0';
+    *strchr (psz_address, '%') = '\0';
 
-        static const char ipv6_scopes[] = "1456789ABCDE";
-        for (const char *c_scope = ipv6_scopes; *c_scope; c_scope++)
-        {
-            psz_address[3] = *c_scope;
-            InitSocket( p_sd, psz_address, SAP_PORT );
-        }
+    static const char ipv6_scopes[] = "1456789ABCDE";
+    for (const char *c_scope = ipv6_scopes; *c_scope; c_scope++)
+    {
+        psz_address[3] = *c_scope;
+        InitSocket( p_sd, psz_address, SAP_PORT );
     }
 
     psz_addr = var_CreateGetString( p_sd, "sap-addr" );
@@ -596,7 +557,8 @@ static void *Run( void *data )
                     i_read = net_Read (p_sd, ufd[i].fd, NULL, p_buffer,
                                        MAX_SAP_BUFFER, false);
                     if (i_read < 0)
-                        msg_Warn (p_sd, "receive error: %m");
+                        msg_Warn (p_sd, "receive error: %s",
+                                  vlc_strerror_c(errno));
                     if (i_read > 6)
                     {
                         /* Parse the packet */
@@ -609,7 +571,7 @@ static void *Run( void *data )
 
         mtime_t now = mdate();
 
-        /* A 1 hour timeout correspong to the RFC Implicit timeout.
+        /* A 1 hour timeout correspond to the RFC Implicit timeout.
          * This timeout is tuned in the following loop. */
         timeout = 1000 * 60 * 60;
 
@@ -620,10 +582,10 @@ static void *Run( void *data )
             sap_announce_t * p_announce = p_sd->p_sys->pp_announces[i];
             mtime_t i_last_period = now - p_announce->i_last;
 
-            /* Remove the annoucement, if the last announcement was 1 hour ago
-             * or if the last packet emitted was 3 times the average time
+            /* Remove the announcement, if the last announcement was 1 hour ago
+             * or if the last packet emitted was 10 times the average time
              * between two packets */
-            if( ( p_announce->i_period_trust > 5 && i_last_period > 3 * p_announce->i_period ) ||
+            if( ( p_announce->i_period_trust > 5 && i_last_period > 10 * p_announce->i_period ) ||
                 i_last_period > i_timeout )
             {
                 RemoveAnnounce( p_sd, p_announce );
@@ -632,17 +594,17 @@ static void *Run( void *data )
             {
                 /* Compute next timeout */
                 if( p_announce->i_period_trust > 5 )
-                    timeout = min_int((3 * p_announce->i_period - i_last_period) / 1000, timeout);
+                    timeout = min_int((10 * p_announce->i_period - i_last_period) / 1000, timeout);
                 timeout = min_int((i_timeout - i_last_period)/1000, timeout);
             }
         }
 
         if( !p_sd->p_sys->i_announces )
-            timeout = -1; /* We can safely poll indefinitly. */
+            timeout = -1; /* We can safely poll indefinitely. */
         else if( timeout < 200 )
             timeout = 200; /* Don't wakeup too fast. */
     }
-    assert (0);
+    vlc_assert_unreachable ();
 }
 
 /**********************************************************************
@@ -706,6 +668,7 @@ static int ParseSAP( services_discovery_t *p_sd, const uint8_t *buf,
     const char          *psz_sdp;
     const uint8_t *end = buf + len;
     sdp_t               *p_sdp;
+    uint32_t            i_source[4];
 
     assert (buf[len] == '\0');
 
@@ -713,6 +676,7 @@ static int ParseSAP( services_discovery_t *p_sd, const uint8_t *buf,
         return VLC_EGENERIC;
 
     uint8_t flags = buf[0];
+    uint8_t auth_len = buf[1];
 
     /* First, check the sap announce is correct */
     if ((flags >> 5) != 1)
@@ -737,8 +701,20 @@ static int ParseSAP( services_discovery_t *p_sd, const uint8_t *buf,
         return VLC_EGENERIC;
     }
 
-    // Skips source address and auth data
-    buf += 4 + (b_ipv6 ? 16 : 4) + buf[1];
+    buf += 4;
+    if( b_ipv6 )
+    {
+        for( int i = 0; i < 4; i++,buf+=4)
+            i_source[i] = U32_AT(buf);
+    }
+    else
+    {
+        memset(i_source, 0, sizeof(i_source));
+        i_source[3] = U32_AT(buf);
+        buf+=4;
+    }
+    // Skips auth data
+    buf += auth_len;
     if (buf > end)
         return VLC_EGENERIC;
 
@@ -775,12 +751,12 @@ static int ParseSAP( services_discovery_t *p_sd, const uint8_t *buf,
         if (strcmp (psz_sdp, "application/sdp"))
         {
             msg_Dbg (p_sd, "unsupported content type: %s", psz_sdp);
-            return VLC_EGENERIC;
+            goto error;
         }
 
         // skips content type
         if (len <= clen)
-            return VLC_EGENERIC;
+            goto error;
 
         len -= clen;
         psz_sdp += clen;
@@ -790,7 +766,7 @@ static int ParseSAP( services_discovery_t *p_sd, const uint8_t *buf,
     p_sdp = ParseSDP( VLC_OBJECT(p_sd), psz_sdp );
 
     if( p_sdp == NULL )
-        return VLC_EGENERIC;
+        goto error;
 
     p_sdp->psz_sdp = psz_sdp;
 
@@ -810,19 +786,20 @@ static int ParseSAP( services_discovery_t *p_sd, const uint8_t *buf,
     if( p_sdp->psz_uri == NULL )
     {
         FreeSDP( p_sdp );
-        return VLC_EGENERIC;
+        goto error;
     }
 
     for( i = 0 ; i< p_sd->p_sys->i_announces ; i++ )
     {
         sap_announce_t * p_announce = p_sd->p_sys->pp_announces[i];
         /* FIXME: slow */
-        /* FIXME: we create a new announce each time the sdp changes */
-        if( IsSameSession( p_announce->p_sdp, p_sdp ) )
+        if( ( !i_hash && IsSameSession( p_announce->p_sdp, p_sdp ) )
+            || ( i_hash && p_announce->i_hash == i_hash
+                 && !memcmp(p_announce->i_source, i_source, sizeof(i_source)) ) )
         {
             /* We don't support delete announcement as they can easily
              * Be used to highjack an announcement by a third party.
-             * Intead we cleverly implement Implicit Announcement removal.
+             * Instead we cleverly implement Implicit Announcement removal.
              *
              * if( b_need_delete )
              *    RemoveAnnounce( p_sd, p_sd->p_sys->pp_announces[i]);
@@ -838,21 +815,25 @@ static int ParseSAP( services_discovery_t *p_sd, const uint8_t *buf,
 
                 /* Compute the average period */
                 mtime_t now = mdate();
-                p_announce->i_period = (p_announce->i_period + (now - p_announce->i_last)) / 2;
+                p_announce->i_period = ( p_announce->i_period * (p_announce->i_period_trust-1) + (now - p_announce->i_last) ) / p_announce->i_period_trust;
                 p_announce->i_last = now;
             }
-            FreeSDP( p_sdp ); p_sdp = NULL;
+            FreeSDP( p_sdp );
+            free (decomp);
             return VLC_SUCCESS;
         }
     }
 
-    CreateAnnounce( p_sd, i_hash, p_sdp );
+    CreateAnnounce( p_sd, i_source, i_hash, p_sdp );
 
-    FREENULL (decomp);
+    free (decomp);
     return VLC_SUCCESS;
+error:
+    free (decomp);
+    return VLC_EGENERIC;
 }
 
-sap_announce_t *CreateAnnounce( services_discovery_t *p_sd, uint16_t i_hash,
+sap_announce_t *CreateAnnounce( services_discovery_t *p_sd, uint32_t *i_source, uint16_t i_hash,
                                 sdp_t *p_sdp )
 {
     input_item_t *p_input;
@@ -869,19 +850,26 @@ sap_announce_t *CreateAnnounce( services_discovery_t *p_sd, uint16_t i_hash,
     p_sap->i_period = 0;
     p_sap->i_period_trust = 0;
     p_sap->i_hash = i_hash;
+    memcpy (p_sap->i_source, i_source, sizeof(p_sap->i_source));
     p_sap->p_sdp = p_sdp;
 
     /* Released in RemoveAnnounce */
-    p_input = input_item_NewWithType( VLC_OBJECT(p_sd),
-                                     p_sap->p_sdp->psz_uri,
-                                     p_sdp->psz_sessionname,
-                                     0, NULL, 0, -1, ITEM_TYPE_NET );
-    p_sap->p_item = p_input;
-    if( !p_input )
+    p_input = input_item_NewWithType( p_sap->p_sdp->psz_uri,
+                                      p_sdp->psz_sessionname,
+                                      0, NULL, 0, -1, ITEM_TYPE_NET );
+    if( unlikely(p_input == NULL) )
     {
         free( p_sap );
         return NULL;
     }
+    p_sap->p_item = p_input;
+
+    vlc_meta_t *p_meta = vlc_meta_New();
+    if( likely(p_meta != NULL) )
+    {
+        vlc_meta_Set( p_meta, vlc_meta_Description, p_sdp->psz_sessioninfo );
+        p_input->p_meta = p_meta;
+    }
 
     if( p_sdp->rtcp_port )
     {
@@ -904,13 +892,27 @@ sap_announce_t *CreateAnnounce( services_discovery_t *p_sd, uint16_t i_hash,
                            p_sdp->username );
     }
 
-    /* Handle group */
-    if (p_sap->p_sdp->mediac >= 1)
-        psz_value = FindAttribute (p_sap->p_sdp, 0, "x-plgroup");
+    /* Handle category */
+    psz_value = GetAttribute(p_sap->p_sdp->pp_attributes,
+                             p_sap->p_sdp->i_attributes, "cat");
+    if (psz_value != NULL)
+    {
+        /* a=cat provides a dot-separated hierarchy.
+         * For the time being only replace dots with pipe. TODO: FIXME */
+        char *str = strdup(psz_value);
+        if (likely(str != NULL))
+            for (char *p = strchr(str, '.'); p != NULL; p = strchr(p, '.'))
+                *(p++) = '|';
+        services_discovery_AddItem(p_sd, p_input, str ? str : psz_value);
+        free(str);
+    }
     else
-        psz_value = GetAttribute( p_sap->p_sdp->pp_attributes, p_sap->p_sdp->i_attributes, "x-plgroup" );
-
-    services_discovery_AddItem( p_sd, p_input, psz_value /* category name */ );
+    {
+        /* backward compatibility with VLC 0.7.3-2.0.0 senders */
+        psz_value = GetAttribute(p_sap->p_sdp->pp_attributes,
+                                 p_sap->p_sdp->i_attributes, "x-plgroup");
+        services_discovery_AddItem(p_sd, p_input, psz_value);
+    }
 
     TAB_APPEND( p_sys->i_announces, p_sys->pp_announces, p_sap );
 
@@ -1258,7 +1260,7 @@ static sdp_t *ParseSDP (vlc_object_t *p_obj, const char *psz_sdp)
                 {
                     msg_Dbg (p_obj, "SDP origin not supported: %s", data);
                     /* Or maybe out-of-range, but this looks suspicious */
-                    return NULL;
+                    goto error;
                 }
                 EnsureUTF8 (p_sdp->orig_host);
                 break;
@@ -1282,9 +1284,20 @@ static sdp_t *ParseSDP (vlc_object_t *p_obj, const char *psz_sdp)
             }
 
             case 'I':
+            {
                 expect = 'U';
+                /* optional (and may be empty) */
                 if (cat == 'i')
+                {
+                    assert (p_sdp->psz_sessioninfo == NULL);
+                    p_sdp->psz_sessioninfo = strdup (data);
+                    if (p_sdp->psz_sessioninfo == NULL)
+                        goto error;
+                    EnsureUTF8 (p_sdp->psz_sessioninfo);
                     break;
+                }
+            }
+
             case 'U':
                 expect = 'E';
                 if (cat == 'u')
@@ -1437,12 +1450,8 @@ static sdp_t *ParseSDP (vlc_object_t *p_obj, const char *psz_sdp)
                 if (cat == 'm')
                     goto media;
 
-                if (cat != 'm')
-                {
-                    msg_Dbg (p_obj, "unexpected SDP line: 0x%02x", (int)cat);
-                    goto error;
-                }
-                break;
+                msg_Dbg (p_obj, "unexpected SDP line: 0x%02x", (int)cat);
+                goto error;
 
             default:
                 msg_Err (p_obj, "*** BUG in SDP parser! ***");
@@ -1522,6 +1531,7 @@ static int Decompress( const unsigned char *psz_src, unsigned char **_dst, int i
 static void FreeSDP( sdp_t *p_sdp )
 {
     free( p_sdp->psz_sessionname );
+    free( p_sdp->psz_sessioninfo );
     free( p_sdp->psz_uri );
 
     for (unsigned j = 0; j < p_sdp->mediac; j++)
@@ -1573,6 +1583,9 @@ static int RemoveAnnounce( services_discovery_t *p_sd,
     return VLC_SUCCESS;
 }
 
+/*
+ * Compare two sessions, when hash is not set (SAP v0)
+ */
 static bool IsSameSession( sdp_t *p_sdp1, sdp_t *p_sdp2 )
 {
     /* A session is identified by
@@ -1591,7 +1604,6 @@ static bool IsSameSession( sdp_t *p_sdp1, sdp_t *p_sdp2 )
     return true;
 }
 
-
 static inline attribute_t *MakeAttribute (const char *str)
 {
     attribute_t *a = malloc (sizeof (*a) + strlen (str) + 1);