/*****************************************************************************
* audioscrobbler.c : audioscrobbler submission plugin
*****************************************************************************
- * Copyright (C) 2006-2007 the VideoLAN team
+ * Copyright © 2006-2008 the VideoLAN team
* $Id$
*
* Author: Rafaël Carré <funman at videolanorg>
* Preamble
*****************************************************************************/
-#if defined( WIN32 )
-#include <time.h>
+#if defined( WIN32 )
+#include <time.h>
+#endif
+
+#ifdef HAVE_CONFIG_H
+# include "config.h"
#endif
-#include <vlc/vlc.h>
+#include <vlc_common.h>
+#include <vlc_plugin.h>
#include <vlc_interface.h>
#include <vlc_meta.h>
#include <vlc_md5.h>
* Local prototypes
*****************************************************************************/
+#define QUEUE_MAX 50
+
/* Keeps track of metadata to be submitted */
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
{
- audioscrobbler_song_t p_queue[50]; /**< songs not submitted yet*/
+ audioscrobbler_song_t p_queue[QUEUE_MAX]; /**< songs not submitted yet*/
int i_songs; /**< number of songs */
vlc_mutex_t lock; /**< p_sys mutex */
/* data about audioscrobbler session */
- time_t next_exchange; /**< when can we send data */
+ mtime_t next_exchange; /**< when can we send data */
unsigned int i_interval; /**< waiting interval (secs)*/
/* submission of played songs */
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 ? */
- char psz_auth_token[33]; /**< authentification token */
+ bool b_handshaked; /**< are we authenticated ? */
+ char psz_auth_token[33]; /**< Authentication token */
/* data about song currently playing */
audioscrobbler_song_t p_current_song; /**< song being played */
- time_t time_pause; /**< time when vlc paused */
- time_t time_total_pauses; /**< total time in pause */
+ 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_preparsed_cb; /**< if we registered the
- * "meta-preparsed" callback*/
+
+ bool b_meta_read; /**< if we read the song's
+ * metadata already */
};
static int Open ( vlc_object_t * );
vlc_value_t, void * );
static int PlayingChange ( vlc_object_t *, const char *, vlc_value_t,
vlc_value_t, void * );
-static int MetaPreparsed ( vlc_object_t *, const char *, vlc_value_t,
- vlc_value_t, void * );
-static int AddToQueue ( intf_thread_t * );
+static void AddToQueue ( intf_thread_t * );
static int Handshake ( intf_thread_t * );
static int ReadMetaData ( intf_thread_t * );
static void DeleteSong ( audioscrobbler_song_t* );
static int ParseURL ( char *, char **, char **, int * );
-static void HandleInterval ( time_t *, unsigned int * );
+static void HandleInterval ( mtime_t *, unsigned int * );
/*****************************************************************************
* Module descriptor
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();
p_intf->p_sys = p_sys;
- vlc_mutex_init( p_this, &p_sys->lock );
+ vlc_mutex_init( &p_sys->lock );
p_playlist = pl_Yield( 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;
if( p_sys->b_state_cb )
var_DelCallback( p_input, "state", PlayingChange, p_intf );
- if( p_sys->b_preparsed_cb )
- var_DelCallback( p_input, "meta-preparsed", MetaPreparsed, p_intf );
vlc_object_release( p_input );
}
PL_UNLOCK;
- pl_Release( p_playlist );
+ pl_Release( p_intf );
- p_intf->b_dead = VLC_TRUE;
+ 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;
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 );
+ vlc_object_release( p_this );
}
/*****************************************************************************
uint8_t p_buffer[1024];
char *p_buffer_pos;
int i_post_socket;
- vlc_bool_t b_die;
intf_sys_t *p_sys = p_intf->p_sys;
/* main loop */
- while( !p_intf->b_die && !p_intf->p_libvlc->b_die )
+ for( ;; )
{
- /* waiting for data to submit, if waiting interval is elapsed */
- vlc_object_lock( p_intf );
- if( time( NULL ) < p_sys->next_exchange )
- b_die = vlc_object_timedwait( p_intf, p_sys->next_exchange );
- else
- b_die = vlc_object_wait( p_intf );
- vlc_object_unlock( p_intf );
+ bool b_wait = false;
- if( b_die )
+ vlc_object_lock( p_intf );
+ if( !vlc_object_alive( p_intf ) )
{
- msg_Dbg( p_intf, "audioscrobbler is dying\n");
+ vlc_object_unlock( p_intf );
+ msg_Dbg( p_intf, "audioscrobbler is dying");
return;
}
+ 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;
+ 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 );
+
+ 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 ..." );
case VLC_ENOVAR:
/* username not set */
- intf_UserFatal( p_intf, VLC_FALSE,
+ intf_UserFatal( p_intf, false,
_("Last.fm username not set"),
- _("Please set an username or disable "
- "audioscrobbler plugin, and then restart VLC.\n"
- "Visit https://www.last.fm/join/ to get an account")
+ _("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;
- time( &p_sys->next_exchange );
+ p_sys->next_exchange = mdate();
break;
case VLC_AUDIOSCROBBLER_EFATAL:
break;
}
/* if handshake failed let's restart the loop */
- if( p_sys->b_handshaked == VLC_FALSE )
+ if( p_sys->b_handshaked == false )
continue;
}
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="
+ "&i%%5B%d%%5D=%ju&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,
{
/* 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;
}
{
/* 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 */
p_buffer_pos = strstr( ( char * ) p_buffer, "BADSESSION" );
if ( p_buffer_pos )
{
- msg_Dbg( p_intf, "Authentification failed, handshaking again" );
- p_sys->b_handshaked = VLC_FALSE;
+ msg_Err( p_intf, "Authentication failed (BADSESSION), are you connected to last.fm with another program ?" );
+ p_sys->b_handshaked = false;
HandleInterval( &p_sys->next_exchange, &p_sys->i_interval );
continue;
}
DeleteSong( &p_sys->p_queue[i] );
p_sys->i_songs = 0;
p_sys->i_interval = 0;
- time( &p_sys->next_exchange );
- msg_Dbg( p_intf, "Submission successfull!" );
+ p_sys->next_exchange = mdate();
+ msg_Dbg( p_intf, "Submission successful!" );
}
else
{
- msg_Dbg( p_intf, "Authentification failed, handshaking again" );
- p_sys->b_handshaked = VLC_FALSE;
+ msg_Err( p_intf, "Authentication failed, handshaking again (%s)",
+ p_buffer );
+ p_sys->b_handshaked = false;
HandleInterval( &p_sys->next_exchange, &p_sys->i_interval );
continue;
}
if( p_intf->b_dead )
return VLC_SUCCESS;
- if( newval.i_int == END_S || newval.i_int == ERROR_S )
+ if( p_sys->b_meta_read == false && newval.i_int >= PLAYING_S )
{
- playlist_t *p_playlist = pl_Yield( p_intf );
- PL_LOCK;
- if( p_playlist->request.i_status == PLAYLIST_STOPPED )
- {
- /* if we stopped, we won't submit playing song */
- p_sys->b_submit = VLC_FALSE;
- }
- PL_UNLOCK;
- pl_Release( p_playlist );
+ ReadMetaData( p_intf );
+ return VLC_SUCCESS;
}
+
+ if( newval.i_int >= END_S )
+ AddToQueue( p_intf );
else if( oldval.i_int == PLAYING_S && newval.i_int == PAUSE_S )
- time( &p_sys->time_pause );
+ p_sys->time_pause = mdate();
else if( oldval.i_int == PAUSE_S && newval.i_int == PLAYING_S )
- p_sys->time_total_pauses += time( NULL ) - p_sys->time_pause;
+ p_sys->time_total_pauses += ( mdate() - p_sys->time_pause );
return VLC_SUCCESS;
}
-/*****************************************************************************
- * MetaPreparsed: Meta data reading callback
- *****************************************************************************/
-static int MetaPreparsed( vlc_object_t *p_this, const char *psz_var,
- vlc_value_t oldval, vlc_value_t newval, void *p_data )
-{
- intf_thread_t *p_intf = ( intf_thread_t* ) p_data;
-
- if( p_intf->b_dead )
- return VLC_SUCCESS;
-
- ReadMetaData( p_intf );
- return VLC_SUCCESS;
-}
-
/*****************************************************************************
* ItemChange: Playlist item change callback
*****************************************************************************/
if( p_intf->b_dead )
return VLC_SUCCESS;
- p_sys->b_preparsed_cb = VLC_FALSE;
- p_sys->b_state_cb = VLC_FALSE;
-
- /* We'll try to add the previously playing song in the queue */
- if( AddToQueue( p_intf ) == VLC_ENOMEM )
- return VLC_ENOMEM;
+ 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;
if( !p_input || p_input->b_dead )
{
PL_UNLOCK;
- pl_Release( p_playlist );
- p_sys->b_submit = VLC_FALSE;
+ pl_Release( p_intf );
return VLC_SUCCESS;
}
vlc_object_yield( p_input );
PL_UNLOCK;
- pl_Release( p_playlist );
+ pl_Release( p_intf );
p_item = input_GetItem( p_input );
if( !p_item )
{
vlc_object_release( p_input );
- p_sys->b_submit = VLC_FALSE;
return VLC_SUCCESS;
}
{
msg_Dbg( p_this, "Not an audio local file, not submitting");
vlc_object_release( p_input );
- p_sys->b_submit = VLC_FALSE;
return VLC_SUCCESS;
}
- p_sys->b_submit = VLC_TRUE;
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 );
- vlc_object_release( p_input );
- return VLC_SUCCESS;
- }
- else
- {
- /* We'll read the meta data when it will be preparsed */
- var_AddCallback( p_input, "meta-preparsed", MetaPreparsed, p_intf );
- p_sys->b_preparsed_cb = VLC_TRUE;
- vlc_object_release( p_input );
- return VLC_SUCCESS;
- }
+ /* if the input item was not preparsed, we'll do it in PlayingChange()
+ * callback, when "state" == PLAYING_S */
+
+ vlc_object_release( p_input );
+ return VLC_SUCCESS;
}
/*****************************************************************************
* AddToQueue: Add the played song to the queue to be submitted
*****************************************************************************/
-static int AddToQueue ( intf_thread_t *p_this )
+static void AddToQueue ( intf_thread_t *p_this )
{
- time_t played_time;
+ mtime_t played_time;
intf_sys_t *p_sys = p_this->p_sys;
vlc_mutex_lock( &p_sys->lock );
if( !p_sys->b_submit )
- {
- DeleteSong( &p_sys->p_current_song );
- vlc_mutex_unlock( &p_sys->lock );
- return VLC_SUCCESS;
- }
+ goto end;
/* wait for the user to listen enough before submitting */
- time ( &played_time );
- 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 ) ) )
{
msg_Dbg( p_this, "Song not listened long enough, not submitting" );
- DeleteSong( &p_sys->p_current_song );
- vlc_mutex_unlock( &p_sys->lock );
- return VLC_SUCCESS;
+ goto end;
}
if( p_sys->p_current_song.i_l < 30 )
{
msg_Dbg( p_this, "Song too short (< 30s), not submitting" );
- DeleteSong( &p_sys->p_current_song );
- vlc_mutex_unlock( &p_sys->lock );
- return VLC_SUCCESS;
+ goto end;
}
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" );
- DeleteSong( &p_sys->p_current_song );
- vlc_mutex_unlock( &p_sys->lock );
- return VLC_SUCCESS;
+/*XXX*/ msg_Dbg( p_this, "%s %s", p_sys->p_current_song.psz_a, p_sys->p_current_song.psz_t );
+ goto end;
}
- if( p_sys->i_songs == 50 )
+ if( p_sys->i_songs >= QUEUE_MAX )
{
msg_Warn( p_this, "Submission queue is full, not submitting" );
- DeleteSong( &p_sys->p_current_song );
- vlc_mutex_unlock( &p_sys->lock );
- return VLC_SUCCESS;
+ goto end;
}
msg_Dbg( p_this, "Song will be submitted." );
p_sys->i_songs++;
/* signal the main loop we have something to submit */
- vlc_object_lock( p_this );
- vlc_cond_signal( &p_this->object_wait );
- vlc_object_unlock( p_this );
+ vlc_object_signal( VLC_OBJECT( p_this ) );
+end:
+ DeleteSong( &p_sys->p_current_song );
+ p_sys->b_submit = false;
vlc_mutex_unlock( &p_sys->lock );
- return VLC_SUCCESS;
}
/*****************************************************************************
{
char *psz_username, *psz_password;
time_t timestamp;
- char psz_timestamp[33];
+ char psz_timestamp[21];
struct md5_s p_struct_md5;
- char psz_password_md5[33];
stream_t *p_stream;
char *psz_handshake_url;
free( psz_password );
- int i;
- for ( i = 0; i < 4; i++ )
+ char *psz_password_md5 = psz_md5_hash( &p_struct_md5 );
+ if( !psz_password_md5 )
{
- sprintf( &psz_password_md5[8*i], "%02x%02x%02x%02x",
- p_struct_md5.p_digest[i] & 0xff,
- ( p_struct_md5.p_digest[i] >> 8 ) & 0xff,
- ( p_struct_md5.p_digest[i] >> 16 ) & 0xff,
- p_struct_md5.p_digest[i] >> 24
- );
+ free( psz_username );
+ 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
AddMD5( &p_struct_md5, ( uint8_t* ) psz_password_md5, 32 );
AddMD5( &p_struct_md5, ( uint8_t* ) psz_timestamp, strlen( psz_timestamp ));
EndMD5( &p_struct_md5 );
+ free( psz_password_md5 );
- for ( i = 0; i < 4; i++ )
+ char *psz_auth_token = psz_md5_hash( &p_struct_md5 );
+ if( !psz_auth_token )
{
- sprintf( &p_sys->psz_auth_token[8*i], "%02x%02x%02x%02x",
- p_struct_md5.p_digest[i] & 0xff,
- ( p_struct_md5.p_digest[i] >> 8 ) & 0xff,
- ( p_struct_md5.p_digest[i] >> 16 ) & 0xff,
- p_struct_md5.p_digest[i] >> 24
- );
+ free( psz_username );
+ return VLC_ENOMEM;
}
-
- p_sys->psz_auth_token[32] = '\0';
+ strncpy( p_sys->psz_auth_token, psz_auth_token, 33 );
+ free( psz_auth_token );
if( !asprintf( &psz_handshake_url,
"http://post.audioscrobbler.com/?hs=true&p=1.2&c=%s&v=%s&u=%s&t=%s&a=%s",
if ( p_buffer_pos )
{
/* handshake request failed, sorry */
- msg_Warn( p_this, "last.fm handshake failed: %s", p_buffer_pos + 7 );
+ msg_Err( p_this, "last.fm handshake failed: %s", p_buffer_pos + 7 );
return VLC_EGENERIC;
}
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." ) );
+ _("last.fm username or password is incorrect. "
+ "Please verify your settings and relaunch VLC." ) );
return VLC_AUDIOSCROBBLER_EFATAL;
}
{
/* oops, our version of vlc has been banned by last.fm servers */
msg_Err( p_intf, "This version of VLC has been banned by last.fm. "
- "You should upgrade VLC, or disable last.fm plugin." );
+ "You should upgrade VLC, or disable the last.fm plugin." );
return VLC_AUDIOSCROBBLER_EFATAL;
}
p_buffer_pos++; /* we skip the '\n' */
/* save the session ID */
- snprintf( &p_sys->psz_auth_token[0], 33, "%s", p_buffer_pos );
+ snprintf( p_sys->psz_auth_token, 33, "%s", p_buffer_pos );
p_buffer_pos = strstr( p_buffer_pos, "http://" );
if( !p_buffer_pos || strlen( p_buffer_pos ) == 7 )
return VLC_ENOMEM;
proto:
- msg_Warn( p_intf, "Handshake: can't recognize server protocol" );
+ msg_Err( p_intf, "Handshake: can't recognize server protocol" );
return VLC_EGENERIC;
}
if( !p_input )
{
PL_UNLOCK;
- pl_Release( p_playlist );
+ pl_Release( p_this );
return( VLC_SUCCESS );
}
vlc_object_yield( p_input );
PL_UNLOCK;
- pl_Release( p_playlist );
+ pl_Release( p_this );
p_item = input_GetItem( p_input );
if( !p_item )
vlc_mutex_lock( &p_sys->lock );
+ p_sys->b_meta_read = true;
+
ALLOC_ITEM_META( p_sys->p_current_song.psz_a, Artist )
else
{
return VLC_EGENERIC;
}
+ /* Now we have read the mandatory meta data, so we can submit that info */
+ 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 );
}
-static void HandleInterval( time_t *next, unsigned int *i_interval )
+static void HandleInterval( mtime_t *next, unsigned int *i_interval )
{
if( *i_interval == 0 )
{
/* first interval is 1 minute */
- *i_interval = 60;
+ *i_interval = 1;
}
else
{
/* else we double the previous interval, up to 120 minutes */
- *i_interval = *i_interval * 2;
- if( *i_interval > 60*120 )
- *i_interval = 60*120;
+ *i_interval <<= 1;
+ if( *i_interval > 120 )
+ *i_interval = 120;
}
- *next = time( NULL ) + *i_interval;
+ *next = mdate() + ( *i_interval * 1000000 * 60 );
}
projects / vlc / blobdiff