]> git.sesse.net Git - vlc/blobdiff - modules/misc/audioscrobbler.c
s/pl_Yield/pl_Hold/
[vlc] / modules / misc / audioscrobbler.c
index 47fa29671373d49439b1b255503ca0a65b28a770..839f8fa4b52c9029507adad004fa0375a1b615fd 100644 (file)
 #include <time.h> 
 #endif 
 
-#include <vlc/vlc.h>
+#ifdef HAVE_CONFIG_H
+# include "config.h"
+#endif
+
+#include <vlc_common.h>
+#include <vlc_plugin.h>
 #include <vlc_interface.h>
 #include <vlc_meta.h>
 #include <vlc_md5.h>
@@ -61,6 +66,7 @@ typedef struct audioscrobbler_song_t
     int         i_l;                /**< track length     */
     char        *psz_m;             /**< musicbrainz id   */
     time_t      date;               /**< date since epoch */
+    mtime_t     i_start;            /**< playing start    */
 } audioscrobbler_song_t;
 
 struct intf_sys_t
@@ -69,6 +75,7 @@ struct intf_sys_t
     int                     i_songs;            /**< number of songs        */
 
     vlc_mutex_t             lock;               /**< p_sys mutex            */
+    vlc_cond_t              wait;               /**< song to submit event   */
 
     /* data about audioscrobbler session */
     mtime_t                 next_exchange;      /**< when can we send data  */
@@ -85,7 +92,7 @@ struct intf_sys_t
     int                     i_nowp_port;        /**< port to which submit   */
     char                    *psz_nowp_file;     /**< file to which submit   */
 #endif
-    vlc_bool_t              b_handshaked;       /**< are we authenticated ? */
+    bool                    b_handshaked;       /**< are we authenticated ? */
     char                    psz_auth_token[33]; /**< Authentication token */
 
     /* data about song currently playing */
@@ -94,18 +101,17 @@ struct intf_sys_t
     mtime_t                 time_pause;         /**< time when vlc paused   */
     mtime_t                 time_total_pauses;  /**< total time in pause    */
 
-    vlc_bool_t              b_submit;           /**< do we have to submit ? */
+    bool                    b_submit;           /**< do we have to submit ? */
 
-    vlc_bool_t              b_state_cb;         /**< if we registered the
+    bool                    b_state_cb;         /**< if we registered the
                                                  * "state" callback         */
 
-    vlc_bool_t              b_meta_read;        /**< if we read the song's
+    bool                    b_meta_read;        /**< if we read the song's
                                                  * metadata already         */
 };
 
 static int  Open            ( vlc_object_t * );
 static void Close           ( vlc_object_t * );
-static void Unload          ( intf_thread_t * );
 static void Run             ( intf_thread_t * );
 
 static int ItemChange       ( vlc_object_t *, const char *, vlc_value_t,
@@ -154,9 +160,9 @@ vlc_module_begin();
     set_shortname( N_( "Audioscrobbler" ) );
     set_description( N_("Submission of played songs to last.fm") );
     add_string( "lastfm-username", "", NULL,
-                USERNAME_TEXT, USERNAME_LONGTEXT, VLC_FALSE );
+                USERNAME_TEXT, USERNAME_LONGTEXT, false );
     add_password( "lastfm-password", "", NULL,
-                PASSWORD_TEXT, PASSWORD_LONGTEXT, VLC_FALSE );
+                PASSWORD_TEXT, PASSWORD_LONGTEXT, false );
     set_capability( "interface", 0 );
     set_callbacks( Open, Close );
 vlc_module_end();
@@ -175,13 +181,14 @@ static int Open( vlc_object_t *p_this )
 
     p_intf->p_sys = p_sys;
 
-    vlc_mutex_init( p_this, &p_sys->lock );
+    vlc_mutex_init( &p_sys->lock );
+    vlc_cond_init( &p_sys->wait );
 
-    p_playlist = pl_Yield( p_intf );
+    p_playlist = pl_Hold( p_intf );
     PL_LOCK;
     var_AddCallback( p_playlist, "playlist-current", ItemChange, p_intf );
     PL_UNLOCK;
-    pl_Release( p_playlist );
+    pl_Release( p_intf );
 
     p_intf->pf_run = Run;
 
@@ -198,28 +205,28 @@ static void Close( vlc_object_t *p_this )
     intf_thread_t               *p_intf = ( intf_thread_t* ) p_this;
     intf_sys_t                  *p_sys  = p_intf->p_sys;
 
-    p_playlist = pl_Yield( p_intf );
-    PL_LOCK;
+    p_playlist = pl_Hold( p_intf );
+    if( p_playlist )
+    {
+        PL_LOCK;
 
-    var_DelCallback( p_playlist, "playlist-current", ItemChange, p_intf );
+        var_DelCallback( p_playlist, "playlist-current", ItemChange, p_intf );
 
-    p_input = p_playlist->p_input;
-    if ( p_input )
-    {
-        vlc_object_yield( p_input );
+        p_input = p_playlist->p_input;
+        if ( p_input )
+        {
+            vlc_object_hold( p_input );
 
-        if( p_sys->b_state_cb )
-            var_DelCallback( p_input, "state", PlayingChange, p_intf );
+            if( p_sys->b_state_cb )
+                var_DelCallback( p_input, "state", PlayingChange, p_intf );
 
-        vlc_object_release( p_input );
-    }
+            vlc_object_release( p_input );
+        }
 
-    PL_UNLOCK;
-    pl_Release( p_playlist );
+        PL_UNLOCK;
+        pl_Release( p_intf );
+    }
 
-    p_intf->b_dead = VLC_TRUE;
-    /* we lock the mutex in case p_sys is being accessed from a callback */
-    vlc_mutex_lock ( &p_sys->lock );
     int i;
     for( i = 0; i < p_sys->i_songs; i++ )
         DeleteSong( &p_sys->p_queue[i] );
@@ -229,25 +236,12 @@ static void Close( vlc_object_t *p_this )
     free( p_sys->psz_nowp_host );
     free( p_sys->psz_nowp_file );
 #endif
-    vlc_mutex_unlock ( &p_sys->lock );
+    vlc_cond_destroy( &p_sys->wait );
     vlc_mutex_destroy( &p_sys->lock );
     free( p_sys );
 }
 
 
-/*****************************************************************************
- * Unload: Unloads the audioscrobbler when encountering fatal errors
- *****************************************************************************/
-static void Unload( intf_thread_t *p_this )
-{
-    vlc_object_kill( p_this );
-    vlc_object_detach( p_this );
-    if( p_this->p_module )
-        module_Unneed( p_this, p_this->p_module );
-    vlc_mutex_destroy( &p_this->change_lock );
-    vlc_object_destroy( p_this );
-}
-
 /*****************************************************************************
  * Run : call Handshake() then submit songs
  *****************************************************************************/
@@ -259,69 +253,62 @@ static void Run( intf_thread_t *p_intf )
     uint8_t                 p_buffer[1024];
     char                    *p_buffer_pos;
     int                     i_post_socket;
+    int                     canc = vlc_savecancel();
 
     intf_sys_t *p_sys = p_intf->p_sys;
 
     /* main loop */
     for( ;; )
     {
-        vlc_bool_t b_die = VLC_FALSE, b_wait = VLC_FALSE;
+        bool b_wait = false;
 
-        vlc_object_lock( p_intf );
-        if( vlc_object_alive( p_intf ) )
-        {
-           if( mdate() < p_sys->next_exchange )
-                /* wait until we can resubmit, i.e.  */
-                b_wait = !vlc_object_timedwait( p_intf,
-                                                p_sys->next_exchange );
-            else
-                /* wait for data to submit */
-                /* we are signaled each time there is a song to submit */
-               vlc_object_wait( p_intf );
-        }
-        b_die = !vlc_object_alive( p_intf );
-        vlc_object_unlock( p_intf );
+        vlc_restorecancel( canc );
+        vlc_mutex_lock( &p_sys->lock );
+        mutex_cleanup_push( &p_sys->lock );
+
+        if( mdate() < p_sys->next_exchange )
+            /* wait until we can resubmit, i.e.  */
+            b_wait = vlc_cond_timedwait( &p_sys->wait, &p_sys->lock,
+                                          p_sys->next_exchange ) == 0;
+        else
+            /* wait for data to submit */
+            /* we are signaled each time there is a song to submit */
+            vlc_cond_wait( &p_sys->wait, &p_sys->lock );
+        vlc_cleanup_run();
+        canc = vlc_savecancel();
 
-        if( b_die )
-        {
-            msg_Dbg( p_intf, "audioscrobbler is dying");
-            return;
-        }
         if( b_wait )
             continue; /* holding on until next_exchange */
 
         /* handshake if needed */
-        if( p_sys->b_handshaked == VLC_FALSE )
+        if( p_sys->b_handshaked == false )
         {
             msg_Dbg( p_intf, "Handshaking with last.fm ..." );
 
             switch( Handshake( p_intf ) )
             {
                 case VLC_ENOMEM:
-                    Unload( p_intf );
                     return;
 
                 case VLC_ENOVAR:
                     /* username not set */
-                    intf_UserFatal( p_intf, VLC_FALSE,
+                    intf_UserFatal( p_intf, false,
                         _("Last.fm username not set"),
                         _("Please set a username or disable the "
                         "audioscrobbler plugin, and restart VLC.\n"
                         "Visit http://www.last.fm/join/ to get an account.")
                     );
-                    Unload( p_intf );
                     return;
 
                 case VLC_SUCCESS:
                     msg_Dbg( p_intf, "Handshake successfull :)" );
-                    p_sys->b_handshaked = VLC_TRUE;
+                    p_sys->b_handshaked = true;
                     p_sys->i_interval = 0;
                     p_sys->next_exchange = mdate();
                     break;
 
                 case VLC_AUDIOSCROBBLER_EFATAL:
-                    msg_Warn( p_intf, "Unloading..." );
-                    Unload( p_intf );
+                    msg_Warn( p_intf, "Exiting..." );
                     return;
 
                 case VLC_EGENERIC:
@@ -331,15 +318,19 @@ static void Run( intf_thread_t *p_intf )
                     break;
             }
             /* if handshake failed let's restart the loop */
-            if( p_sys->b_handshaked == VLC_FALSE )
+            if( p_sys->b_handshaked == false )
                 continue;
         }
 
         msg_Dbg( p_intf, "Going to submit some data..." );
 
+        /* The session may be invalid if there is a trailing \n */
+        char *psz_ln = strrchr( p_sys->psz_auth_token, '\n' );
+        if( psz_ln )
+            *psz_ln = '\0';
+
         if( !asprintf( &psz_submit, "s=%s", p_sys->psz_auth_token ) )
         {   /* Out of memory */
-            Unload( p_intf );
             return;
         }
 
@@ -350,18 +341,27 @@ static void Run( intf_thread_t *p_intf )
         {
             p_song = &p_sys->p_queue[i_song];
             if( !asprintf( &psz_submit_song,
-                    "&a%%5B%d%%5D=%s&t%%5B%d%%5D=%s"
-                    "&i%%5B%d%%5D=%llu&o%%5B%d%%5D=P&r%%5B%d%%5D="
-                    "&l%%5B%d%%5D=%d&b%%5B%d%%5D=%s"
-                    "&n%%5B%d%%5D=%s&m%%5B%d%%5D=%s",
-                    i_song, p_song->psz_a,           i_song, p_song->psz_t,
-                    i_song, (uintmax_t)p_song->date, i_song, i_song,
-                    i_song, p_song->i_l,             i_song, p_song->psz_b,
-                    i_song, p_song->psz_n,           i_song, p_song->psz_m
+                    "&a%%5B%d%%5D=%s"
+                    "&t%%5B%d%%5D=%s"
+                    "&i%%5B%d%%5D=%u"
+                    "&o%%5B%d%%5D=P"
+                    "&r%%5B%d%%5D="
+                    "&l%%5B%d%%5D=%d"
+                    "&b%%5B%d%%5D=%s"
+                    "&n%%5B%d%%5D=%s"
+                    "&m%%5B%d%%5D=%s",
+                    i_song, p_song->psz_a,
+                    i_song, p_song->psz_t,
+                    i_song, (unsigned)p_song->date, /* HACK: %ju (uintmax_t) unsupported on Windows */
+                    i_song,
+                    i_song,
+                    i_song, p_song->i_l,
+                    i_song, p_song->psz_b,
+                    i_song, p_song->psz_n,
+                    i_song, p_song->psz_m
             ) )
             {   /* Out of memory */
                 vlc_mutex_unlock( &p_sys->lock );
-                Unload( p_intf );
                 return;
             }
             psz_submit_tmp = psz_submit;
@@ -371,7 +371,6 @@ static void Run( intf_thread_t *p_intf )
                 free( psz_submit_tmp );
                 free( psz_submit_song );
                 vlc_mutex_unlock( &p_sys->lock );
-                Unload( p_intf );
                 return;
             }
             free( psz_submit_song );
@@ -386,7 +385,7 @@ static void Run( intf_thread_t *p_intf )
         {
             /* If connection fails, we assume we must handshake again */
             HandleInterval( &p_sys->next_exchange, &p_sys->i_interval );
-            p_sys->b_handshaked = VLC_FALSE;
+            p_sys->b_handshaked = false;
             free( psz_submit );
             continue;
         }
@@ -404,12 +403,12 @@ static void Run( intf_thread_t *p_intf )
         {
             /* If connection fails, we assume we must handshake again */
             HandleInterval( &p_sys->next_exchange, &p_sys->i_interval );
-            p_sys->b_handshaked = VLC_FALSE;
+            p_sys->b_handshaked = false;
             continue;
         }
 
         i_net_ret = net_Read( p_intf, i_post_socket, NULL,
-                    p_buffer, 1023, VLC_FALSE );
+                    p_buffer, 1023, false );
         if ( i_net_ret <= 0 )
         {
             /* if we get no answer, something went wrong : try again */
@@ -431,7 +430,7 @@ static void Run( intf_thread_t *p_intf )
         if ( p_buffer_pos )
         {
             msg_Err( p_intf, "Authentication failed (BADSESSION), are you connected to last.fm with another program ?" );
-            p_sys->b_handshaked = VLC_FALSE;
+            p_sys->b_handshaked = false;
             HandleInterval( &p_sys->next_exchange, &p_sys->i_interval );
             continue;
         }
@@ -451,11 +450,12 @@ static void Run( intf_thread_t *p_intf )
         {
             msg_Err( p_intf, "Authentication failed, handshaking again (%s)", 
                              p_buffer );
-            p_sys->b_handshaked = VLC_FALSE;
+            p_sys->b_handshaked = false;
             HandleInterval( &p_sys->next_exchange, &p_sys->i_interval );
             continue;
         }
     }
+    vlc_restorecancel( canc );
 }
 
 /*****************************************************************************
@@ -469,10 +469,7 @@ static int PlayingChange( vlc_object_t *p_this, const char *psz_var,
 
     VLC_UNUSED( p_this ); VLC_UNUSED( psz_var );
 
-    if( p_intf->b_dead )
-        return VLC_SUCCESS;
-
-    if( p_sys->b_meta_read == VLC_FALSE && newval.i_int >= PLAYING_S )
+    if( p_sys->b_meta_read == false && newval.i_int >= PLAYING_S )
     {
         ReadMetaData( p_intf );
         return VLC_SUCCESS;
@@ -504,27 +501,24 @@ static int ItemChange( vlc_object_t *p_this, const char *psz_var,
     VLC_UNUSED( p_this ); VLC_UNUSED( psz_var );
     VLC_UNUSED( oldval ); VLC_UNUSED( newval );
 
-    if( p_intf->b_dead )
-        return VLC_SUCCESS;
+    p_sys->b_state_cb       = false;
+    p_sys->b_meta_read      = false;
+    p_sys->b_submit         = false;
 
-    p_sys->b_state_cb       = VLC_FALSE;
-    p_sys->b_meta_read      = VLC_FALSE;
-    p_sys->b_submit         = VLC_FALSE;
-
-    p_playlist = pl_Yield( p_intf );
+    p_playlist = pl_Hold( p_intf );
     PL_LOCK;
     p_input = p_playlist->p_input;
 
     if( !p_input || p_input->b_dead )
     {
         PL_UNLOCK;
-        pl_Release( p_playlist );
+        pl_Release( p_intf );
         return VLC_SUCCESS;
     }
 
-    vlc_object_yield( p_input );
+    vlc_object_hold( p_input );
     PL_UNLOCK;
-    pl_Release( p_playlist );
+    pl_Release( p_intf );
 
     p_item = input_GetItem( p_input );
     if( !p_item )
@@ -542,10 +536,11 @@ static int ItemChange( vlc_object_t *p_this, const char *psz_var,
     }
 
     p_sys->time_total_pauses = 0;
-    time( &p_sys->p_current_song.date );
+    time( &p_sys->p_current_song.date );        /* to be sent to last.fm */
+    p_sys->p_current_song.i_start = mdate();    /* only used locally */
 
     var_AddCallback( p_input, "state", PlayingChange, p_intf );
-    p_sys->b_state_cb = VLC_TRUE;
+    p_sys->b_state_cb = true;
 
     if( input_item_IsPreparsed( p_item ) )
         ReadMetaData( p_intf );
@@ -569,29 +564,35 @@ static void AddToQueue ( intf_thread_t *p_this )
         goto end;
 
     /* wait for the user to listen enough before submitting */
-    played_time = mdate();
-    played_time -= p_sys->p_current_song.date;
-    played_time -= p_sys->time_total_pauses;
+    played_time = mdate() - p_sys->p_current_song.i_start -
+                            p_sys->time_total_pauses;
     played_time /= 1000000; /* µs → s */
 
-    if( ( played_time < 240 ) &&
-        ( played_time < ( p_sys->p_current_song.i_l / 2 ) ) )
+    /*HACK: it seam that the preparsing sometime fail,
+            so use the playing time as the song length */
+    if( p_sys->p_current_song.i_l == 0 )
+        p_sys->p_current_song.i_l = played_time;
+
+    /* Don't send song shorter than 30s */
+    if( p_sys->p_current_song.i_l < 30 )
     {
-        msg_Dbg( p_this, "Song not listened long enough, not submitting" );
+        msg_Dbg( p_this, "Song too short (< 30s), not submitting" );
         goto end;
     }
 
-    if( p_sys->p_current_song.i_l < 30 )
+    /* Send if the user had listen more than 240s OR half the track length */
+    if( ( played_time < 240 ) &&
+        ( played_time < ( p_sys->p_current_song.i_l / 2 ) ) )
     {
-        msg_Dbg( p_this, "Song too short (< 30s), not submitting" );
+        msg_Dbg( p_this, "Song not listened long enough, not submitting" );
         goto end;
     }
 
+    /* Check that all meta are present */
     if( !p_sys->p_current_song.psz_a || !*p_sys->p_current_song.psz_a ||
         !p_sys->p_current_song.psz_t || !*p_sys->p_current_song.psz_t )
     {
         msg_Dbg( p_this, "Missing artist or title, not submitting" );
-/*XXX*/        msg_Dbg( p_this, "%s %s", p_sys->p_current_song.psz_a, p_sys->p_current_song.psz_t );
         goto end;
     }
 
@@ -623,11 +624,11 @@ static void AddToQueue ( intf_thread_t *p_this )
     p_sys->i_songs++;
 
     /* signal the main loop we have something to submit */
-    vlc_object_signal( VLC_OBJECT( p_this ) );
+    vlc_cond_signal( &p_sys->wait );
 
 end:
     DeleteSong( &p_sys->p_current_song );
-    p_sys->b_submit = VLC_FALSE;
+    p_sys->b_submit = false;
     vlc_mutex_unlock( &p_sys->lock );
 }
 
@@ -693,7 +694,7 @@ static int Handshake( intf_thread_t *p_this )
 {
     char                *psz_username, *psz_password;
     time_t              timestamp;
-    char                psz_timestamp[33];
+    char                psz_timestamp[21];
 
     struct md5_s        p_struct_md5;
 
@@ -743,7 +744,8 @@ static int Handshake( intf_thread_t *p_this )
         return VLC_ENOMEM;
     }
 
-    snprintf( psz_timestamp, 33, "%llu", (uintmax_t)timestamp );
+    snprintf( psz_timestamp, sizeof( psz_timestamp ), "%"PRIu64,
+              (uint64_t)timestamp );
 
     /* generates a md5 hash of :
      * - md5 hash of the password, plus
@@ -803,7 +805,7 @@ static int Handshake( intf_thread_t *p_this )
     if ( p_buffer_pos )
     {
         /* authentication failed, bad username/password combination */
-        intf_UserFatal( p_this, VLC_FALSE,
+        intf_UserFatal( p_this, false,
             _("last.fm: Authentication failed"),
             _("last.fm username or password is incorrect. "
               "Please verify your settings and relaunch VLC." ) );
@@ -918,19 +920,19 @@ static int ReadMetaData( intf_thread_t *p_this )
 
     intf_sys_t          *p_sys = p_this->p_sys;
 
-    p_playlist = pl_Yield( p_this );
+    p_playlist = pl_Hold( p_this );
     PL_LOCK;
     p_input = p_playlist->p_input;
     if( !p_input )
     {
         PL_UNLOCK;
-        pl_Release( p_playlist );
+        pl_Release( p_this );
         return( VLC_SUCCESS );
     }
 
-    vlc_object_yield( p_input );
+    vlc_object_hold( p_input );
     PL_UNLOCK;
-    pl_Release( p_playlist );
+    pl_Release( p_this );
 
     p_item = input_GetItem( p_input );
     if( !p_item )
@@ -944,15 +946,16 @@ static int ReadMetaData( intf_thread_t *p_this )
         a = encode_URI_component( psz_meta ); \
         if( !a ) \
         { \
+            vlc_mutex_unlock( &p_sys->lock ); \
+            vlc_object_release( p_input ); \
             free( psz_meta ); \
             return VLC_ENOMEM; \
         } \
-        free( psz_meta ); \
     }
 
     vlc_mutex_lock( &p_sys->lock );
 
-    p_sys->b_meta_read = VLC_TRUE;
+    p_sys->b_meta_read = true;
 
     ALLOC_ITEM_META( p_sys->p_current_song.psz_a, Artist )
     else
@@ -963,6 +966,7 @@ static int ReadMetaData( intf_thread_t *p_this )
         free( psz_meta );
         return VLC_EGENERIC;
     }
+    free( psz_meta );
 
     ALLOC_ITEM_META( p_sys->p_current_song.psz_t, Title )
     else
@@ -974,23 +978,27 @@ static int ReadMetaData( intf_thread_t *p_this )
         free( psz_meta );
         return VLC_EGENERIC;
     }
+    free( psz_meta );
 
     /* Now we have read the mandatory meta data, so we can submit that info */
-    p_sys->b_submit = VLC_TRUE;
+    p_sys->b_submit = true;
 
     ALLOC_ITEM_META( p_sys->p_current_song.psz_b, Album )
     else
         p_sys->p_current_song.psz_b = calloc( 1, 1 );
+    free( psz_meta );
 
     ALLOC_ITEM_META( p_sys->p_current_song.psz_m, TrackID )
     else
         p_sys->p_current_song.psz_m = calloc( 1, 1 );
+    free( psz_meta );
 
     p_sys->p_current_song.i_l = input_item_GetDuration( p_item ) / 1000000;
 
     ALLOC_ITEM_META( p_sys->p_current_song.psz_n, TrackNum )
     else
         p_sys->p_current_song.psz_n = calloc( 1, 1 );
+    free( psz_meta );
 #undef ALLOC_ITEM_META
 
     msg_Dbg( p_this, "Meta data registered" );