]> git.sesse.net Git - vlc/blobdiff - modules/services_discovery/sap.c
Fix description
[vlc] / modules / services_discovery / sap.c
index 171d756a706227af2e69c6236232dbd843cd986f..9b89a6e3a5f3ba9e2cd87bb4693b4e450a61978d 100644 (file)
 /*****************************************************************************
  * Includes
  *****************************************************************************/
-#include <vlc/vlc.h>
+#ifdef HAVE_CONFIG_H
+# include "config.h"
+#endif
+
+#include <vlc_common.h>
+#include <vlc_plugin.h>
 #include <assert.h>
 
 #include <vlc_playlist.h>
 #define SAP_PARSE_TEXT N_( "Try to parse the announce" )
 #define SAP_PARSE_LONGTEXT N_( \
        "This enables actual parsing of the announces by the SAP module. " \
-       "Otherwise, all announcements are parsed by the \"livedotcom\" " \
+       "Otherwise, all announcements are parsed by the \"live555\" " \
        "(RTP/RTSP) module." )
 #define SAP_STRICT_TEXT N_( "SAP Strict mode" )
 #define SAP_STRICT_LONGTEXT N_( \
     static void CloseDemux ( vlc_object_t * );
 
 vlc_module_begin();
-    set_shortname( _("SAP"));
-    set_description( _("SAP Announcements") );
+    set_shortname( N_("SAP"));
+    set_description( N_("SAP Announcements") );
     set_category( CAT_PLAYLIST );
     set_subcategory( SUBCAT_PLAYLIST_SD );
 
     add_string( "sap-addr", NULL, NULL,
-                SAP_ADDR_TEXT, SAP_ADDR_LONGTEXT, VLC_TRUE );
+                SAP_ADDR_TEXT, SAP_ADDR_LONGTEXT, true );
     add_bool( "sap-ipv4", 1 , NULL,
-               SAP_IPV4_TEXT,SAP_IPV4_LONGTEXT, VLC_TRUE );
+               SAP_IPV4_TEXT,SAP_IPV4_LONGTEXT, true );
     add_bool( "sap-ipv6", 1 , NULL,
-              SAP_IPV6_TEXT, SAP_IPV6_LONGTEXT, VLC_TRUE );
+              SAP_IPV6_TEXT, SAP_IPV6_LONGTEXT, true );
     add_integer( "sap-timeout", 1800, NULL,
-                 SAP_TIMEOUT_TEXT, SAP_TIMEOUT_LONGTEXT, VLC_TRUE );
+                 SAP_TIMEOUT_TEXT, SAP_TIMEOUT_LONGTEXT, true );
     add_bool( "sap-parse", 1 , NULL,
-               SAP_PARSE_TEXT,SAP_PARSE_LONGTEXT, VLC_TRUE );
+               SAP_PARSE_TEXT,SAP_PARSE_LONGTEXT, true );
     add_bool( "sap-strict", 0 , NULL,
-               SAP_STRICT_TEXT,SAP_STRICT_LONGTEXT, VLC_TRUE );
+               SAP_STRICT_TEXT,SAP_STRICT_LONGTEXT, true );
 #if 0
     add_bool( "sap-cache", 0 , NULL,
-               SAP_CACHE_TEXT,SAP_CACHE_LONGTEXT, VLC_TRUE );
+               SAP_CACHE_TEXT,SAP_CACHE_LONGTEXT, true );
 #endif
     add_bool( "sap-timeshift", 0 , NULL,
-              SAP_TIMESHIFT_TEXT,SAP_TIMESHIFT_LONGTEXT, VLC_TRUE );
+              SAP_TIMESHIFT_TEXT,SAP_TIMESHIFT_LONGTEXT, true );
 
     set_capability( "services_discovery", 0 );
     set_callbacks( Open, Close );
 
     add_submodule();
-        set_description( _("SDP Descriptions parser") );
+        set_description( N_("SDP Descriptions parser") );
         add_shortcut( "sdp" );
-        set_capability( "demux2", 51 );
+        set_capability( "demux", 51 );
         set_callbacks( OpenDemux, CloseDemux );
 vlc_module_end();
 
@@ -236,9 +241,9 @@ struct services_discovery_sys_t
     struct sap_announce_t **pp_announces;
 
     /* Modes */
-    vlc_bool_t  b_strict;
-    vlc_bool_t  b_parse;
-    vlc_bool_t  b_timeshift;
+    bool  b_strict;
+    bool  b_parse;
+    bool  b_timeshift;
 
     int i_timeout;
 };
@@ -272,12 +277,12 @@ struct demux_sys_t
     static const char *FindAttribute (const sdp_t *sdp, unsigned media,
                                       const char *name);
 
-    static vlc_bool_t IsSameSession( sdp_t *p_sdp1, sdp_t *p_sdp2 );
+    static bool IsSameSession( sdp_t *p_sdp1, sdp_t *p_sdp2 );
     static int InitSocket( services_discovery_t *p_sd, const char *psz_address, int i_port );
     static int Decompress( const unsigned char *psz_src, unsigned char **_dst, int i_len );
     static void FreeSDP( sdp_t *p_sdp );
 
-static inline int min( int a, int b )
+static inline int min_int( int a, int b )
 {
     return a > b ? b : a;
 }
@@ -290,6 +295,8 @@ static int Open( vlc_object_t *p_this )
     services_discovery_t *p_sd = ( services_discovery_t* )p_this;
     services_discovery_sys_t *p_sys  = (services_discovery_sys_t *)
                                 malloc( sizeof( services_discovery_sys_t ) );
+    if( !p_sys )
+        return VLC_ENOMEM;
 
     p_sys->i_timeout = var_CreateGetInteger( p_sd, "sap-timeout" );
 
@@ -387,10 +394,19 @@ static int OpenDemux( vlc_object_t *p_this )
     {
         p_sdp->psz_uri = NULL;
     }
-    if( p_sdp->i_media_type != 33 && p_sdp->i_media_type != 32 &&
-        p_sdp->i_media_type != 14 )
-        goto error;
-
+    switch (p_sdp->i_media_type)
+    {   /* Should be in sync with modules/demux/rtp.c */
+        case  0: /* PCMU/8000 */
+        case  8: /* PCMA/8000 */
+        case 10: /* L16/44100/2 */
+        case 11: /* L16/44100 */
+        case 14: /* MPA/90000 */
+        case 32: /* MPV/90000 */
+        case 33: /* MP2/90000 */
+            break;
+        default:
+            goto error;
+    }
     if( p_sdp->psz_uri == NULL ) goto error;
 
     p_demux->p_sys = (demux_sys_t *)malloc( sizeof(demux_sys_t) );
@@ -542,11 +558,13 @@ static void Run( services_discovery_t *p_sd )
         return;
     }
 
+    vlc_object_lock( p_sd );
+
     /* read SAP packets */
     while( vlc_object_alive( p_sd ) )
     {
         unsigned n = p_sd->p_sys->i_fd;
-        struct pollfd ufd[n];
+        struct pollfd ufd[n+1];
 
         for (unsigned i = 0; i < n; i++)
         {
@@ -555,12 +573,23 @@ static void Run( services_discovery_t *p_sd )
             ufd[i].revents = 0;
         }
 
-        /* FIXME: remove this stupid evil hack when we have sorted out how to
-         * to cancel threads while doing network I/O */
-        if (timeout > 2000)
-            timeout = 2000;
+        /* Make sure we track vlc_object_signal() */
+        ufd[n].fd = vlc_object_waitpipe( p_sd );
+        ufd[n].events = POLLIN | POLLHUP;
+        ufd[n].revents = 0;
+
+        if( ufd[n].fd == -1 )
+        {
+            /* On windows, fd will be -1, as we can't select on a pipe()-ed
+             * fildes. Because we have no other solution to track that
+             * object is killed, we make sure the timeout won't be to long. */
+            if( timeout > 1000 || timeout == -1 )
+                timeout = 1000;
+        }
+
+        vlc_object_unlock( p_sd );
 
-        if (poll (ufd, n, timeout) > 0)
+        if (poll (ufd, n+1, timeout) > 0)
         {
             for (unsigned i = 0; i < n; i++)
             {
@@ -570,7 +599,7 @@ static void Run( services_discovery_t *p_sd )
                     ssize_t i_read;
 
                     i_read = net_Read (p_sd, ufd[i].fd, NULL, p_buffer,
-                                       MAX_SAP_BUFFER, VLC_FALSE);
+                                       MAX_SAP_BUFFER, false);
                     if (i_read < 0)
                         msg_Warn (p_sd, "receive error: %m");
                     if (i_read > 6)
@@ -608,8 +637,8 @@ static void Run( services_discovery_t *p_sd )
             {
                 /* Compute next timeout */
                 if( p_announce->i_period_trust > 5 )
-                    timeout = min((3 * p_announce->i_period - i_last_period) / 1000, timeout);
-                timeout = min((i_timeout - i_last_period)/1000, timeout);
+                    timeout = min_int((3 * p_announce->i_period - i_last_period) / 1000, timeout);
+                timeout = min_int((i_timeout - i_last_period)/1000, timeout);
             }
         }
 
@@ -617,7 +646,10 @@ static void Run( services_discovery_t *p_sd )
             timeout = -1; /* We can safely poll indefinitly. */
         else if( timeout < 200 )
             timeout = 200; /* Don't wakeup too fast. */
+
+        vlc_object_lock( p_sd );
     }
+    vlc_object_unlock( p_sd );
 }
 
 /**********************************************************************
@@ -652,7 +684,7 @@ static int Demux( demux_t *p_demux )
     if( p_playlist->status.p_item &&
              p_playlist->status.p_item->p_input == p_parent_input )
     {
-        playlist_Control( p_playlist, PLAYLIST_VIEWPLAY, VLC_TRUE,
+        playlist_Control( p_playlist, PLAYLIST_VIEWPLAY, true,
                           p_playlist->status.p_node, p_playlist->status.p_item );
     }
 
@@ -665,6 +697,7 @@ static int Demux( demux_t *p_demux )
 
 static int Control( demux_t *p_demux, int i_query, va_list args )
 {
+    VLC_UNUSED(p_demux); VLC_UNUSED(i_query); VLC_UNUSED(args);
     return VLC_EGENERIC;
 }
 
@@ -692,8 +725,8 @@ static int ParseSAP( services_discovery_t *p_sd, const uint8_t *buf,
     if ((flags >> 5) != 1)
         return VLC_EGENERIC;
 
-    vlc_bool_t b_ipv6 = (flags & 0x10) != 0;
-    vlc_bool_t b_need_delete = (flags & 0x04) != 0;
+    bool b_ipv6 = (flags & 0x10) != 0;
+    bool b_need_delete = (flags & 0x04) != 0;
 
     if (flags & 0x02)
     {
@@ -701,7 +734,7 @@ static int ParseSAP( services_discovery_t *p_sd, const uint8_t *buf,
         return VLC_EGENERIC;
     }
 
-    vlc_bool_t b_compressed = (flags & 0x01) != 0;
+    bool b_compressed = (flags & 0x01) != 0;
 
     uint16_t i_hash = U16_AT (buf + 2);
 
@@ -777,14 +810,18 @@ static int ParseSAP( services_discovery_t *p_sd, const uint8_t *buf,
     if( ( p_sdp->i_media_type != 14
        && p_sdp->i_media_type != 32
        && p_sdp->i_media_type != 33)
-     || p_sd->p_sys->b_parse == VLC_FALSE )
+     || p_sd->p_sys->b_parse == false )
     {
         free( p_sdp->psz_uri );
         if (asprintf( &p_sdp->psz_uri, "sdp://%s", p_sdp->psz_sdp ) == -1)
             p_sdp->psz_uri = NULL;
     }
 
-    if( p_sdp->psz_uri == NULL ) return VLC_EGENERIC;
+    if( p_sdp->psz_uri == NULL )
+    {
+        FreeSDP( p_sdp );
+        return VLC_EGENERIC;
+    }
 
     for( i = 0 ; i< p_sd->p_sys->i_announces ; i++ )
     {
@@ -861,8 +898,7 @@ sap_announce_t *CreateAnnounce( services_discovery_t *p_sd, uint16_t i_hash,
     psz_value = GetAttribute( p_sap->p_sdp->pp_attributes, p_sap->p_sdp->i_attributes, "tool" );
     if( psz_value != NULL )
     {
-        input_ItemAddInfo( p_input, _("Session"), _("Tool"), "%s",
-                           psz_value );
+        input_ItemAddInfo( p_input, _("Session"), _("Tool"), "%s", psz_value );
     }
     if( strcmp( p_sdp->username, "-" ) )
     {
@@ -879,7 +915,7 @@ sap_announce_t *CreateAnnounce( services_discovery_t *p_sd, uint16_t i_hash,
     services_discovery_AddItem( p_sd, p_input, psz_value /* category name */ );
 
     TAB_APPEND( p_sys->i_announces, p_sys->pp_announces, p_sap );
-
+    vlc_gc_decref( p_input );
     return p_sap;
 }
 
@@ -948,15 +984,19 @@ static int ParseConnection( vlc_object_t *p_obj, sdp_t *p_sdp )
     if (subtype == NULL)
     {
         msg_Dbg (p_obj, "missing SDP media subtype: %s", sdp_proto);
-        p_sdp->i_media_type = 0;
+        free (sdp_proto);
+        return VLC_EGENERIC;
     }
     else
     {
         *subtype++ = '\0';
-        p_sdp->i_media_type = atoi (subtype);
+        /* FIXME: check for multiple payload types in RTP/AVP case.
+         * FIXME: check for "mpeg" subtype in raw udp case. */
+        if (!strcasecmp (sdp_proto, "udp"))
+            p_sdp->i_media_type = 33;
+        else
+            p_sdp->i_media_type = atoi (subtype);
     }
-    if (p_sdp->i_media_type == 0)
-         p_sdp->i_media_type = 33;
 
     /* RTP protocol, nul, VLC shortcut, nul, flags byte as follow:
      * 0x1: Connection-Oriented media. */
@@ -1196,7 +1236,7 @@ static sdp_t *ParseSDP (vlc_object_t *p_obj, const char *psz_sdp)
                     goto error;
                 }
 
-                if ((sscanf (data, "%63s "I64Fu" "I64Fu" IN IP%u %1023s",
+                if ((sscanf (data, "%63s %"PRIu64" %"PRIu64" IN IP%u %1023s",
                              p_sdp->username, &p_sdp->session_id,
                              &p_sdp->session_version, &p_sdp->orig_ip_version,
                              p_sdp->orig_host) != 5)
@@ -1498,7 +1538,11 @@ static int RemoveAnnounce( services_discovery_t *p_sd,
     }
 
     if( p_announce->i_input_id > -1 )
-        playlist_DeleteFromInput( pl_Get(p_sd), p_announce->i_input_id, VLC_FALSE );
+    {
+        playlist_DeleteFromInput( pl_Yield( p_sd ),
+                                  p_announce->i_input_id, false );
+        pl_Release( p_sd );
+    }
 
     for( i = 0; i< p_sd->p_sys->i_announces; i++)
     {
@@ -1515,7 +1559,7 @@ static int RemoveAnnounce( services_discovery_t *p_sd,
     return VLC_SUCCESS;
 }
 
-static vlc_bool_t IsSameSession( sdp_t *p_sdp1, sdp_t *p_sdp2 )
+static bool IsSameSession( sdp_t *p_sdp1, sdp_t *p_sdp2 )
 {
     /* A session is identified by
      * - username,
@@ -1528,9 +1572,9 @@ static vlc_bool_t IsSameSession( sdp_t *p_sdp1, sdp_t *p_sdp2 )
      || (p_sdp1->session_id != p_sdp2->session_id)
      || (p_sdp1->orig_ip_version != p_sdp2->orig_ip_version)
      || strcmp (p_sdp1->orig_host, p_sdp2->orig_host))
-        return VLC_FALSE;
+        return false;
 
-    return VLC_TRUE;
+    return true;
 }