X-Git-Url: https://git.sesse.net/?a=blobdiff_plain;f=modules%2Fmisc%2Faudioscrobbler.c;h=76d8ca6697436ac43fed875178dbfe4e402ff6ce;hb=61662db54c85ada5dbac8dc5918c419eb508a85c;hp=5b5935b6471c01664a6a3025c33fb1570332835a;hpb=1fd58a36c7f7083ad5153835c9268577164dabd2;p=vlc diff --git a/modules/misc/audioscrobbler.c b/modules/misc/audioscrobbler.c index 5b5935b647..76d8ca6697 100644 --- a/modules/misc/audioscrobbler.c +++ b/modules/misc/audioscrobbler.c @@ -1,10 +1,11 @@ /***************************************************************************** * audioscrobbler.c : audioscrobbler submission plugin ***************************************************************************** - * Copyright © 2006-2008 the VideoLAN team + * Copyright © 2006-2009 the VideoLAN team * $Id$ * * Author: Rafaël Carré + * Ilkka Ollakka * * This program is free software; you can redistribute it and/or modify * it under the terms of the GNU General Public License as published by @@ -25,6 +26,7 @@ * http://www.audioscrobbler.net/development/protocol/ * * TODO: "Now Playing" feature (not mandatory) + * Update to new API? http://www.lastfm.fr/api */ /***************************************************************************** * Preamble @@ -41,13 +43,12 @@ #include #include #include +#include #include #include -#include #include #include #include -#include #include /***************************************************************************** @@ -75,6 +76,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 */ @@ -91,7 +93,7 @@ struct intf_sys_t int i_nowp_port; /**< port to which submit */ char *psz_nowp_file; /**< file to which submit */ #endif - bool b_handshaked; /**< are we authenticated ? */ + bool b_handshaked; /**< are we authenticated ? */ char psz_auth_token[33]; /**< Authentication token */ /* data about song currently playing */ @@ -100,12 +102,12 @@ struct intf_sys_t mtime_t time_pause; /**< time when vlc paused */ mtime_t time_total_pauses; /**< total time in pause */ - bool b_submit; /**< do we have to submit ? */ + bool b_submit; /**< do we have to submit ? */ - bool b_state_cb; /**< if we registered the + bool b_state_cb; /**< if we registered the * "state" callback */ - bool b_meta_read; /**< if we read the song's + bool b_meta_read; /**< if we read the song's * metadata already */ }; @@ -133,6 +135,8 @@ static void HandleInterval ( mtime_t *, unsigned int * ); #define USERNAME_LONGTEXT N_("The username of your last.fm account") #define PASSWORD_TEXT N_("Password") #define PASSWORD_LONGTEXT N_("The password of your last.fm account") +#define URL_TEXT N_("Scrobbler URL") +#define URL_LONGTEXT N_("The URL set for an alternative scrobbler engine") /* This error value is used when last.fm plugin has to be unloaded. */ #define VLC_AUDIOSCROBBLER_EFATAL -69 @@ -148,30 +152,31 @@ static void HandleInterval ( mtime_t *, unsigned int * ); "Connection: close\n" \ "Content-type: application/x-www-form-urlencoded\n" \ "Host: %s\n" \ - "User-agent: VLC Media Player/%s\r\n" \ + "User-agent: VLC media player/%s\r\n" \ "\r\n" \ "%s\r\n" \ "\r\n" -vlc_module_begin(); - set_category( CAT_INTERFACE ); - set_subcategory( SUBCAT_INTERFACE_CONTROL ); - set_shortname( N_( "Audioscrobbler" ) ); - set_description( N_("Submission of played songs to last.fm") ); +vlc_module_begin () + set_category( CAT_INTERFACE ) + set_subcategory( SUBCAT_INTERFACE_CONTROL ) + set_shortname( N_( "Audioscrobbler" ) ) + set_description( N_("Submission of played songs to last.fm") ) add_string( "lastfm-username", "", NULL, - USERNAME_TEXT, USERNAME_LONGTEXT, false ); + USERNAME_TEXT, USERNAME_LONGTEXT, false ) add_password( "lastfm-password", "", NULL, - PASSWORD_TEXT, PASSWORD_LONGTEXT, false ); - set_capability( "interface", 0 ); - set_callbacks( Open, Close ); -vlc_module_end(); + PASSWORD_TEXT, PASSWORD_LONGTEXT, false ) + add_string( "scrobbler-url", "post.audioscrobbler.com", NULL, + URL_TEXT, URL_LONGTEXT, false ) + set_capability( "interface", 0 ) + set_callbacks( Open, Close ) +vlc_module_end () /***************************************************************************** * Open: initialize and create stuff *****************************************************************************/ static int Open( vlc_object_t *p_this ) { - playlist_t *p_playlist; intf_thread_t *p_intf = ( intf_thread_t* ) p_this; intf_sys_t *p_sys = calloc( 1, sizeof( intf_sys_t ) ); @@ -181,12 +186,9 @@ static int Open( vlc_object_t *p_this ) p_intf->p_sys = p_sys; vlc_mutex_init( &p_sys->lock ); + vlc_cond_init( &p_sys->wait ); - p_playlist = pl_Yield( p_intf ); - PL_LOCK; - var_AddCallback( p_playlist, "playlist-current", ItemChange, p_intf ); - PL_UNLOCK; - pl_Release( p_intf ); + var_AddCallback( pl_Get( p_intf ), "item-current", ItemChange, p_intf ); p_intf->pf_run = Run; @@ -198,36 +200,21 @@ static int Open( vlc_object_t *p_this ) *****************************************************************************/ static void Close( vlc_object_t *p_this ) { - playlist_t *p_playlist; + playlist_t *p_playlist = pl_Get( p_this ); input_thread_t *p_input; 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 ); - if( p_playlist ) - { - PL_LOCK; - - var_DelCallback( p_playlist, "playlist-current", ItemChange, p_intf ); - - p_input = p_playlist->p_input; - if ( p_input ) - { - vlc_object_yield( p_input ); - - if( p_sys->b_state_cb ) - var_DelCallback( p_input, "state", PlayingChange, p_intf ); - - vlc_object_release( p_input ); - } + var_DelCallback( p_playlist, "item-current", ItemChange, p_intf ); - PL_UNLOCK; - pl_Release( p_intf ); + p_input = playlist_CurrentInput( p_playlist ); + if ( p_input ) + { + if( p_sys->b_state_cb ) + var_DelCallback( p_input, "intf-event", PlayingChange, p_intf ); + vlc_object_release( p_input ); } - p_intf->b_dead = 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] ); @@ -237,7 +224,7 @@ 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 ); } @@ -254,6 +241,7 @@ 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; @@ -262,21 +250,21 @@ static void Run( intf_thread_t *p_intf ) { bool b_wait = false; - vlc_object_lock( p_intf ); - if( !vlc_object_alive( p_intf ) ) - { - vlc_object_unlock( p_intf ); - msg_Dbg( p_intf, "audioscrobbler is dying"); - return; - } + + 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_object_timedwait( p_intf, p_sys->next_exchange ) == 0; + 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_object_wait( p_intf ); - vlc_object_unlock( p_intf ); + vlc_cond_wait( &p_sys->wait, &p_sys->lock ); + vlc_cleanup_run(); + canc = vlc_savecancel(); if( b_wait ) continue; /* holding on until next_exchange */ @@ -293,9 +281,9 @@ static void Run( intf_thread_t *p_intf ) case VLC_ENOVAR: /* username not set */ - intf_UserFatal( p_intf, false, + dialog_Fatal( p_intf, _("Last.fm username not set"), - _("Please set a username or disable the " + "%s", _("Please set a username or disable the " "audioscrobbler plugin, and restart VLC.\n" "Visit http://www.last.fm/join/ to get an account.") ); @@ -393,9 +381,9 @@ static void Run( intf_thread_t *p_intf ) /* we transmit the data */ i_net_ret = net_Printf( - VLC_OBJECT( p_intf ), i_post_socket, NULL, + p_intf, i_post_socket, NULL, POST_REQUEST, p_sys->psz_submit_file, - (unsigned)strlen( psz_submit ), p_sys->psz_submit_file, + (unsigned)strlen( psz_submit ), p_sys->psz_submit_host, VERSION, psz_submit ); @@ -456,6 +444,7 @@ static void Run( intf_thread_t *p_intf ) continue; } } + vlc_restorecancel( canc ); } /***************************************************************************** @@ -464,26 +453,38 @@ static void Run( intf_thread_t *p_intf ) static int PlayingChange( vlc_object_t *p_this, const char *psz_var, vlc_value_t oldval, vlc_value_t newval, void *p_data ) { + VLC_UNUSED( oldval ); + intf_thread_t *p_intf = ( intf_thread_t* ) p_data; intf_sys_t *p_sys = p_intf->p_sys; + input_thread_t *p_input = ( input_thread_t* )p_this; + vlc_value_t state_value; VLC_UNUSED( p_this ); VLC_UNUSED( psz_var ); - if( p_intf->b_dead ) - return VLC_SUCCESS; + if( newval.i_int != INPUT_EVENT_STATE ) return VLC_SUCCESS; + + state_value.i_int = 0; - if( p_sys->b_meta_read == false && newval.i_int >= PLAYING_S ) + var_Get( p_input, "state", &state_value ); + + + if( p_sys->b_meta_read == false && state_value.i_int >= PLAYING_S ) { ReadMetaData( p_intf ); return VLC_SUCCESS; } - if( newval.i_int >= END_S ) + + if( state_value.i_int >= END_S ) AddToQueue( p_intf ); - else if( oldval.i_int == PLAYING_S && newval.i_int == PAUSE_S ) + else if( state_value.i_int == PAUSE_S ) p_sys->time_pause = mdate(); - else if( oldval.i_int == PAUSE_S && newval.i_int == PLAYING_S ) + else if( p_sys->time_pause > 0 && state_value.i_int == PLAYING_S ) + { p_sys->time_total_pauses += ( mdate() - p_sys->time_pause ); + p_sys->time_pause = 0; + } return VLC_SUCCESS; } @@ -494,7 +495,6 @@ static int PlayingChange( vlc_object_t *p_this, const char *psz_var, static int ItemChange( vlc_object_t *p_this, const char *psz_var, vlc_value_t oldval, vlc_value_t newval, void *p_data ) { - playlist_t *p_playlist; input_thread_t *p_input; intf_thread_t *p_intf = ( intf_thread_t* ) p_data; intf_sys_t *p_sys = p_intf->p_sys; @@ -504,27 +504,14 @@ 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_playlist = pl_Yield( p_intf ); - PL_LOCK; - p_input = p_playlist->p_input; + p_input = playlist_CurrentInput( pl_Get( p_intf ) ); if( !p_input || p_input->b_dead ) - { - PL_UNLOCK; - pl_Release( p_intf ); return VLC_SUCCESS; - } - - vlc_object_yield( p_input ); - PL_UNLOCK; - pl_Release( p_intf ); p_item = input_GetItem( p_input ); if( !p_item ) @@ -534,9 +521,9 @@ static int ItemChange( vlc_object_t *p_this, const char *psz_var, } var_Change( p_input, "video-es", VLC_VAR_CHOICESCOUNT, &video_val, NULL ); - if( ( video_val.i_int > 0 ) || p_item->i_type == ITEM_TYPE_NET ) + if( video_val.i_int > 0 ) { - msg_Dbg( p_this, "Not an audio local file, not submitting"); + msg_Dbg( p_this, "Not an audio-only input, not submitting"); vlc_object_release( p_input ); return VLC_SUCCESS; } @@ -545,7 +532,7 @@ static int ItemChange( vlc_object_t *p_this, const char *psz_var, 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 ); + var_AddCallback( p_input, "intf-event", PlayingChange, p_intf ); p_sys->b_state_cb = true; if( input_item_IsPreparsed( p_item ) ) @@ -574,30 +561,31 @@ static void AddToQueue ( intf_thread_t *p_this ) p_sys->time_total_pauses; played_time /= 1000000; /* µs → s */ - if( ( played_time < 60 ) && - ( 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 ) ) ) { - if( played_time < 30 ) - { - msg_Dbg( p_this, "Song too short (< 30s), not submitting" ); - goto end; - } - else - /* This is a HACK to avoid length = 0 (seems to be rejected by audioscrobbler) */ - p_sys->p_current_song.i_l = played_time; + 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; } @@ -629,7 +617,7 @@ 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 ); @@ -656,26 +644,34 @@ static int ParseURL( char *psz_url, char **psz_host, char **psz_file, { int i_pos; int i_len = strlen( psz_url ); + bool b_no_port = false; FREENULL( *psz_host ); FREENULL( *psz_file ); i_pos = strcspn( psz_url, ":" ); if( i_pos == i_len ) - return VLC_EGENERIC; + { + *i_port = 80; + i_pos = strcspn( psz_url, "/" ); + b_no_port = true; + } *psz_host = strndup( psz_url, i_pos ); if( !*psz_host ) return VLC_ENOMEM; - i_pos++; /* skip the ':' */ - *i_port = atoi( psz_url + i_pos ); - if( *i_port <= 0 ) + if( !b_no_port ) { - FREENULL( *psz_host ); - return VLC_EGENERIC; - } + i_pos++; /* skip the ':' */ + *i_port = atoi( psz_url + i_pos ); + if( *i_port <= 0 ) + { + FREENULL( *psz_host ); + return VLC_EGENERIC; + } - i_pos = strcspn( psz_url, "/" ); + i_pos = strcspn( psz_url, "/" ); + } if( i_pos == i_len ) return VLC_EGENERIC; @@ -698,6 +694,7 @@ static int ParseURL( char *psz_url, char **psz_host, char **psz_file, static int Handshake( intf_thread_t *p_this ) { char *psz_username, *psz_password; + char *psz_scrobbler_url; time_t timestamp; char psz_timestamp[21]; @@ -714,11 +711,11 @@ static int Handshake( intf_thread_t *p_this ) intf_thread_t *p_intf = ( intf_thread_t* ) p_this; intf_sys_t *p_sys = p_this->p_sys; - psz_username = config_GetPsz( p_this, "lastfm-username" ); + psz_username = var_InheritString( p_this, "lastfm-username" ); if( !psz_username ) return VLC_ENOMEM; - psz_password = config_GetPsz( p_this, "lastfm-password" ); + psz_password = var_InheritString( p_this, "lastfm-password" ); if( !psz_password ) { free( psz_username ); @@ -771,14 +768,23 @@ static int Handshake( intf_thread_t *p_this ) strncpy( p_sys->psz_auth_token, psz_auth_token, 33 ); free( psz_auth_token ); + psz_scrobbler_url = var_InheritString( p_this, "scrobbler-url" ); + if( !psz_scrobbler_url ) + { + free( psz_username ); + return VLC_ENOMEM; + } + if( !asprintf( &psz_handshake_url, - "http://post.audioscrobbler.com/?hs=true&p=1.2&c=%s&v=%s&u=%s&t=%s&a=%s", + "http://%s/?hs=true&p=1.2&c=%s&v=%s&u=%s&t=%s&a=%s", psz_scrobbler_url, CLIENT_NAME, CLIENT_VERSION, psz_username, psz_timestamp, p_sys->psz_auth_token ) ) { + free( psz_scrobbler_url ); free( psz_username ); return VLC_ENOMEM; } + free( psz_scrobbler_url ); free( psz_username ); /* send the http handshake request */ @@ -810,9 +816,9 @@ static int Handshake( intf_thread_t *p_this ) if ( p_buffer_pos ) { /* authentication failed, bad username/password combination */ - intf_UserFatal( p_this, false, + dialog_Fatal( p_this, _("last.fm: Authentication failed"), - _("last.fm username or password is incorrect. " + "%s", _("last.fm username or password is incorrect. " "Please verify your settings and relaunch VLC." ) ); return VLC_AUDIOSCROBBLER_EFATAL; } @@ -919,25 +925,14 @@ static void DeleteSong( audioscrobbler_song_t* p_song ) *****************************************************************************/ static int ReadMetaData( intf_thread_t *p_this ) { - playlist_t *p_playlist; input_thread_t *p_input; input_item_t *p_item; intf_sys_t *p_sys = p_this->p_sys; - p_playlist = pl_Yield( p_this ); - PL_LOCK; - p_input = p_playlist->p_input; + p_input = playlist_CurrentInput( pl_Get( p_this ) ); if( !p_input ) - { - PL_UNLOCK; - pl_Release( p_this ); return( VLC_SUCCESS ); - } - - vlc_object_yield( p_input ); - PL_UNLOCK; - pl_Release( p_this ); p_item = input_GetItem( p_input ); if( !p_item ) @@ -951,6 +946,8 @@ 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; \ } \