annotate src/lastfm/lastfm.c @ 1220:4730e246f536

Remove metadata debugging notices.

/* Audacious lastfm transport plugin
 * Copyright (c) 2007 Cristi Magherusan <[e-mail]>
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without modification,
 * are permitted provided that the following conditions are met:
 * 
 *       Redistributions of source code must retain the above copyright notice,
 *       this list of conditions and the following disclaimer.
 * 
 *       Redistributions in binary form must reproduce the above copyright notice,
 *       this list of conditions and the following disclaimer in the documentation
 *       and/or other materials provided with the distribution.
 * 
 *       Neither the name of the author nor the names of its contributors may be
 *       used to endorse or promote products derived from this software without
 *       specific prior written permission.
 * 
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
 * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
 * ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */

/*
  Current status and known issues:
   - Works fine ant is relatively stable unless DEBUG is enabled (read below)
   - The adjust fails when having 2 or more opened streams at the same time.
        * It will randomly adjust to any one of them, because the playlist keeps 
        pulling metadata
   - When the network is disconnected opening a new track freezes the player 
        * This seems to recover after the connection is restablished
        * Ordinary mp3 streams seem to share this behavior. Didnt tested if others do.
*/

#include <audacious/vfs.h>
#include <audacious/plugin.h>
#include <audacious/configdb.h>
#include <libmowgli/mowgli_global_storage.h>
#include <curl/curl.h>
#include <glib.h>
#include <string.h>
#include "lastfm.h"

#define DEBUG 1
/*Caution!!! setting DEBUG to 1 is very likely to crash the player because the g_print-ed values
aren't checked of being !=NULL
*/

size_t lastfm_store_res(void *ptr, size_t size, size_t nmemb, void *udata)
{
        GString *data = (GString *) udata;
        g_string_append_len(data, ptr, nmemb);
        return size * nmemb;
}

gint lastfm_get_data_from_uri(gchar *url, GString * result)
{
        CURL *curl = curl_easy_init();
        curl_easy_setopt(curl, CURLOPT_NOPROGRESS, 1);
        curl_easy_setopt(curl, CURLOPT_USERAGENT, "Audacious");
        curl_easy_setopt(curl, CURLOPT_WRITEFUNCTION, lastfm_store_res);
        curl_easy_setopt(curl, CURLOPT_HTTP_VERSION, CURL_HTTP_VERSION_1_0);
        curl_easy_setopt(curl, CURLOPT_NOSIGNAL, 1);
        curl_easy_setopt(curl, CURLOPT_CONNECTTIMEOUT, LASTFM_CURL_TIMEOUT);
        curl_easy_setopt(curl, CURLOPT_URL, url);
        curl_easy_setopt(curl, CURLOPT_WRITEDATA, result);
        gint status = curl_easy_perform(curl);
        curl_easy_cleanup(curl);
        return status;
}

gchar* lastfm_get_login_uri()  /* reads the audioscrobbler login data from the config */
{                              /* and then uses them to create a login URL*/
        ConfigDb *cfg = NULL;
        gchar   *buf=NULL,
                *username = NULL, 
                *password = NULL;
        if ((cfg = bmp_cfg_db_open()) != NULL)
        {
                bmp_cfg_db_get_string(cfg, "audioscrobbler","username",
                                &username);
                bmp_cfg_db_get_string(cfg, "audioscrobbler","password",
                                &password);
                g_free(cfg);
        }
        if (username != NULL && password != NULL)
        {
                buf=g_strdup_printf(LASTFM_HANDSHAKE_URL, username, password);
                g_free(password);
                g_free(username);
                return buf;
        }
        else 
        {
#if DEBUG
                g_print("Couldn't find the login data. Use the scrobbler plugin to set it up.\n");
#endif
                return NULL;
        }
}

void lastfm_store(gchar *var_name,gchar* var){  /*mowgli storage wrapper*/
        if (mowgli_global_storage_get(var_name))
                mowgli_global_storage_free(var_name);

        mowgli_global_storage_put(var_name,var);
}

int lastfm_login(void)  /*gets the session ID and the mp3 stream URL and stores them*/
{
        gint    status, i,
                ret=LASTFM_LOGIN_OK; /*suppose everything goes fine*/
        gchar   *login_uri=NULL,
                **split = NULL;
        GString *res;
        login_uri=lastfm_get_login_uri();
        if(login_uri==NULL)
        {
                g_free(login_uri);
                return LASTFM_MISSING_LOGIN_DATA;
        }
        res = g_string_new(NULL);
        status = lastfm_get_data_from_uri(login_uri, res);
#if DEBUG
        g_print("Opened login URI: '%s'\n", login_uri);
        g_print("Got following data: '%s'\n", res->str);
#endif
        if (status == CURLE_OK)
        {
                split = g_strsplit(res->str, "\n", 20);
                for (i = 0; split && split[i]; i++)
                {
                        if (g_str_has_prefix(split[i], "session="))
                                lastfm_store("lastfm_session_id",g_strndup(split[i] + 8, 32));
                        else if (g_str_has_prefix(split[i], "stream_url="))
                                lastfm_store("lastfm_stream_uri" ,g_strdup(split[i] + 11));
                }
        }
        else
                ret = LASTFM_LOGIN_ERROR;
        g_strfreev(split);
        g_string_erase(res, 0, -1);
        g_free(login_uri);
        return ret;
}

static gchar* parse(gchar* input_string,gchar* token)
{
	if (!g_str_has_prefix(input_string, token))
		return NULL;

        return g_strdup(strchr(input_string, '=') + 1);
}

gint lastfm_adjust(const gchar * uri)  /*tunes into a channel*/
{
        gint status, i,ret = LASTFM_ADJUST_FAILED;
        gchar *fetch_url=NULL,
              *session_id,
              **split = NULL;
        GString *res;        
        session_id=mowgli_global_storage_get("lastfm_session_id");
        if (!session_id)
        {
#if DEBUG
                g_print("Adjust failed! Session ID not set.\n");
#endif
                return LASTFM_SESSION_MISSING;
        }
        fetch_url=g_strdup_printf(LASTFM_ADJUST_URL, session_id, uri);
        res= g_string_new(NULL);
        status = lastfm_get_data_from_uri(fetch_url, res);
#if 0
        g_print("\nAdjusting: \nSession ID:%s\n",session_id);
        g_print("Fetch URL:%s\n",fetch_url);
        g_print("Adjust OK, \nReceived data:\n%s\n", res->str);
#endif
        if (status == CURLE_OK)
        {
                split = g_strsplit(res->str, "\n", 20);
                for (i = 0; split && split[i]; i++)
                {
                        if (g_str_has_prefix(split[i], "response=OK"))
                                ret = LASTFM_ADJUST_OK;
                        if (g_str_has_prefix(split[i], "url="))
                                lastfm_store("lastfm_tuned_to_url", parse(split[i], "url="));
                }
        }
        g_string_erase(res, 0, -1);
        g_strfreev(split);
        return ret;
}

gboolean parse_metadata(LastFM * handle,GString * metadata_strings)
{
        int i;

        if(metadata_strings == NULL)
                return FALSE;
        gchar **split = g_strsplit(metadata_strings->str, "\n", 20);
        if(g_str_has_prefix(split[0],"streaming=false"))
                return FALSE;
        handle->lastfm_duration=0;
        handle->lastfm_progress=0;

	if (handle->lastfm_artist)
	        g_free(handle->lastfm_artist);

	if (handle->lastfm_title)
	        g_free(handle->lastfm_title);

	if (handle->lastfm_album)
	        g_free(handle->lastfm_album);

	if (handle->lastfm_cover)
	        g_free(handle->lastfm_cover);

	if (handle->lastfm_station_name)
	        g_free(handle->lastfm_station_name);

        for (i = 0; split && split[i]; i++)
        {
		if (g_str_has_prefix(split[i], "artist="))
	                handle->lastfm_artist = parse(split[i],"artist=");

		if (g_str_has_prefix(split[i], "track="))
	                handle->lastfm_title  = parse(split[i],"track=");

		if (g_str_has_prefix(split[i], "album="))
	                handle->lastfm_album  = parse(split[i],"album=" );

		if (g_str_has_prefix(split[i], "albumcover_medium="))
	                handle->lastfm_cover  = parse(split[i],"albumcover_medium=");

		if (g_str_has_prefix(split[i], "station="))
	                handle->lastfm_station_name = parse(split[i],"station=");

                if (g_str_has_prefix(split[i], "trackduration="))
                        handle->lastfm_duration = g_ascii_strtoull(g_strdup(split[i] + 14), NULL, 10);
                if (g_str_has_prefix(split[i], "trackprogress="))
                        handle->lastfm_progress = g_ascii_strtoull(g_strdup(split[i] + 14), NULL, 10);
        }
#if DEBUG
        g_print("\nDuration:%d\n", handle->lastfm_duration);
        if(handle->lastfm_station_name!=NULL)
                g_print("Station Name: %s\n", handle->lastfm_station_name);
#endif
        g_strfreev(split);
        g_string_erase(metadata_strings, 0, -1);
        return TRUE;
}

int fetch_metadata(LastFM * handle)
{
        gchar *uri=NULL;
        gint status,res=METADATA_FETCH_FAILED;
        handle->lastfm_session_id=mowgli_global_storage_get("lastfm_session_id");
        if (handle->lastfm_session_id == NULL)
                return res;  
        uri=g_strdup_printf(LASTFM_METADATA_URL, handle->lastfm_session_id);
        GString *fetched_metadata = g_string_new(NULL);
        status = lastfm_get_data_from_uri(uri, fetched_metadata);
        if (status == CURLE_OK)
        {
#if DEBUG
                g_print("Received metadata:'%s'\n", fetched_metadata->str);
#endif
                if(parse_metadata( handle,fetched_metadata))
                {
                        res=METADATA_FETCH_SUCCEEDED;
#if DEBUG
                        g_print("metadata was parsed ok\n");
#endif
                }

        }
        return res;
}

gpointer lastfm_metadata_thread_func(gpointer arg)
{    
        gint    err=0,
                sleep_duration=1,
                previous_track_duration=-1,
                count=0,
                status=0;
        gboolean track_end_expected=FALSE;
        gchar* previous_track_title=NULL;
        LastFM *handle = (LastFM *)arg;
        // metadata is fetched 1 second after the stream is opened.
        // if it's fetched ok i'm waiting for track_length-10 seconds
        // then start polling for new metadata each 2 seconds, until
        // the track gets changed from the previous iteration
        do
        {
                sleep(1);
                count++;
                if(count%sleep_duration==0)
                {               
                        status=fetch_metadata(handle);
                        if(status==METADATA_FETCH_SUCCEEDED)
                        {        
                                if(!track_end_expected)
                                {               
                                        sleep_duration=handle->lastfm_duration-10; 
                                        previous_track_duration=handle->lastfm_duration;
                                        previous_track_title=g_strdup(handle->lastfm_title);
                                        track_end_expected=TRUE; /*then the track_end will follow*/
                                        count=err=0;
                                }
                                else
                                {       //two tracks are considered identical if they have the same length and the same title
                                        if((handle->lastfm_duration == previous_track_duration)&&
                                                        g_str_has_prefix(handle->lastfm_title, previous_track_title))
                                        {
                                                sleep_duration=2;
                                                err++;
                                        }
                                        else //the tracks are different so i'm at the beginning of a new one
                                        {
                                                track_end_expected=FALSE;
                                                g_free(previous_track_title);
                                        }
                                }
#if DEBUG
                                g_print("Current thread, ID = %p\n", (void *)g_thread_self());
#endif
                        }
                        else
                                err+=5;
                }
#if DEBUG
                g_print("Thread_count: %d\n",thread_count);
#endif
        }
        while (err<=7 && (g_thread_self()==metadata_thread ));

#if DEBUG
        g_print("Exiting thread, ID = %p\n", (void *)g_thread_self());
#endif
        thread_count--;
        return NULL;
}

VFSFile *lastfm_vfs_fopen_impl(const gchar * path, const gchar * mode)
{
        VFSFile *file = g_new0(VFSFile, 1);
        LastFM  *handle = g_new0(LastFM, 1);
        gchar* lastfm_uri=NULL;
        int login_count = 0;
        while((login_count++ <= 3)&&(lastfm_login()!= LASTFM_LOGIN_OK))
                sleep(5);

        handle->lastfm_session_id = mowgli_global_storage_get("lastfm_session_id");
        handle->lastfm_mp3_stream_url = mowgli_global_storage_get("lastfm_stream_uri");
        lastfm_uri=mowgli_global_storage_get("lastfm_tuned_to_url");
        //only tune in if the existinfg uri is NULL or != our new one(from path)
        //adjust doesnt work as it should when having more than one lastfm stream opened at a time
        if (!lastfm_uri || (!g_str_has_prefix(path,lastfm_uri)) ) 
                if(!lastfm_adjust(path)==LASTFM_ADJUST_OK)
                        return NULL;

        metadata_thread = g_thread_create(lastfm_metadata_thread_func, handle, FALSE, NULL);
        thread_count++;
        handle->proxy_fd = vfs_fopen(handle->lastfm_mp3_stream_url, mode);
        file->handle = handle;
        return file;
}

gint lastfm_vfs_fclose_impl(VFSFile * file)
{
        gint ret = 0;

        if (file == NULL)
                return -1;
        LastFM *handle = file->handle;
        ret = vfs_fclose(handle->proxy_fd);
        if (!ret)
                handle->proxy_fd = NULL;
        g_free(handle);
        handle=NULL;
        return ret;
}

size_t lastfm_vfs_fread_impl(gpointer ptr, size_t size, size_t nmemb, VFSFile * file)
{
        LastFM *handle = file->handle;
        size_t ret = vfs_fread(ptr, size, nmemb, handle->proxy_fd);
        return ret;
}

size_t lastfm_vfs_fwrite_impl(gconstpointer ptr, size_t size, size_t nmemb, VFSFile * file)
{
        return -1;
}

gint lastfm_vfs_getc_impl(VFSFile * stream)
{
        LastFM *handle = stream->handle;
        return vfs_getc(handle->proxy_fd);
}

gint lastfm_vfs_ungetc_impl(gint c, VFSFile * stream)
{
        LastFM *handle = stream->handle;

        return vfs_ungetc(c, handle->proxy_fd);
}

gint lastfm_vfs_fseek_impl(VFSFile * file, glong offset, gint whence)
{
        return -1;
}

void lastfm_vfs_rewind_impl(VFSFile * file)
{
        return;
}

glong lastfm_vfs_ftell_impl(VFSFile * file)
{
        LastFM *handle = file->handle;

        return vfs_ftell(handle->proxy_fd);
}

gboolean lastfm_vfs_feof_impl(VFSFile * file)
{
        LastFM *handle = file->handle;

        return vfs_feof(handle->proxy_fd);
}

gint lastfm_vfs_truncate_impl(VFSFile * file, glong size)
{
        return -1;
}

off_t lastfm_vfs_fsize_impl(VFSFile * file)
{
        return 0;
}

gchar *lastfm_vfs_metadata_impl(VFSFile * file, const gchar * field)
{
        LastFM *handle = file->handle;

        if (!g_ascii_strncasecmp(field, "stream-name", 11) && (handle->lastfm_station_name != NULL))
                return g_strdup(handle->lastfm_station_name);
        if (!g_ascii_strncasecmp(field, "track-name", 10) && (handle->lastfm_title != NULL) && (handle->lastfm_artist != NULL))
                return g_strdup_printf("%s - %s", handle->lastfm_artist, handle->lastfm_title);

        return NULL;
}

VFSConstructor lastfm_const = {
        "lastfm://",
        lastfm_vfs_fopen_impl,
        lastfm_vfs_fclose_impl,
        lastfm_vfs_fread_impl,
        lastfm_vfs_fwrite_impl,
        lastfm_vfs_getc_impl,
        lastfm_vfs_ungetc_impl,
        lastfm_vfs_fseek_impl,
        lastfm_vfs_rewind_impl,
        lastfm_vfs_ftell_impl,
        lastfm_vfs_feof_impl,
        lastfm_vfs_truncate_impl,
        lastfm_vfs_fsize_impl,
        lastfm_vfs_metadata_impl
};

static void init(void)
{       
        vfs_register_transport(&lastfm_const);
}

static void cleanup(void)
{

        mowgli_global_storage_free("lastfm_session_id");
        mowgli_global_storage_free("lastfm_stream_uri");
#if DEBUG
        g_print ("Cleanup finished\n");
#endif
}

DECLARE_PLUGIN(lastfm, init, cleanup, NULL, NULL, NULL, NULL, NULL)