ScrobSubmitter.h

/***************************************************************************
 *   Copyright (C) 2005 - 2006 by                                          *
 *      Erik Jälevik, Last.fm Ltd <erik@last.fm>                           *
 *                                                                         *
 *   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  *
 *   the Free Software Foundation; either version 2 of the License, or     *
 *   (at your option) any later version.                                   *
 *                                                                         *
 *   This program is distributed in the hope that it will be useful,       *
 *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
 *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         *
 *   GNU General Public License for more details.                          *
 *                                                                         *
 *   You should have received a copy of the GNU General Public License     *
 *   along with this program; if not, write to the                         *
 *   Free Software Foundation, Inc.,                                       *
 *   51 Franklin Steet, Fifth Floor, Boston, MA  02111-1307, USA.          *
 ***************************************************************************/

/*************************************************************************/ 
#ifndef SCROBSUBMITTER_H
#define SCROBSUBMITTER_H

#include "BlockingClient.h"

#include <string>
#include <deque>

/*************************************************************************/ 
class ScrobSubmitter 
{
public:

    /*********************************************************************/ 
    typedef void (*StatusCallback)(
        int  reqId,
        bool error,
        std::string msg,
        void* userData);

    /*********************************************************************/ 
    enum Encoding
    {
        ISO_8859_1, // standard Windows western codepage
        UTF_8
    };

    /*********************************************************************/ 
        ScrobSubmitter();

    /*********************************************************************/ 
        virtual
        ~ScrobSubmitter();

    /*********************************************************************/ 
    void
    Init(
        const std::string& pluginId,
        StatusCallback callback,
        void* userData);

    /*********************************************************************/ 
    void
    Term();

    /*********************************************************************/ 
    int
    Start(
        std::string artist,
        std::string track,
        std::string album,
        std::string mbId,
        int         length,
        std::string filename,
        Encoding    encoding = UTF_8);

    /*********************************************************************/ 
    int
    Stop();

    /*********************************************************************/ 
    int
    Pause();

    /*********************************************************************/ 
    int
    Resume();

    /*********************************************************************/ 
    std::string
    GetVersion();

    /*********************************************************************/ 
    static std::string
    GetLogPath();

private:

    /**************************************************************************
        Copy ctor private because a CRITICAL_SECTION cannot be copied.
    **************************************************************************/
        ScrobSubmitter(
            const ScrobSubmitter&);

    /**************************************************************************
        Sends the command cmd down the socket.
    **************************************************************************/
    int
        SendToAS(
            const std::string& cmd);

    /**************************************************************************
        Socket thread starter.
    **************************************************************************/
    static unsigned __stdcall
    SendToASThreadMain(
        LPVOID p)
        { reinterpret_cast<ScrobSubmitter*>(p)->SendToASThread(); return 0; }
         
    /**************************************************************************
        Socket worker thread function.
    **************************************************************************/
    void
        SendToASThread();

    /**************************************************************************
        Connects to AS. Returns true if successful.
    **************************************************************************/
    bool
    ConnectToAS(
        int reqId);

    /**************************************************************************
        Reports status back to caller through callback.
    **************************************************************************/
    void
    ReportStatus(
        int reqId,
        bool error,
        const std::string& msg);

    /**************************************************************************
        Converts the passed in string to UTF-8 from the encoding specified
        as the second parameter.
    **************************************************************************/
    void
        ConvertToUTF8(
            std::string& text,
            Encoding encoding);

    /*********************************************************************/ 
    std::string&
        Escape(
            std::string& text);


    std::string      mPluginId;
    
    int              mActualPort;
    BlockingClient   mSocket;
    
    int              mNextId;
    std::deque<std::pair<int, std::string> > mRequestQueue;

    HANDLE           mSocketThread;
    HANDLE           mRequestAvailable;
    HANDLE           mExit;
    CRITICAL_SECTION mMutex;
    bool             mStopThread;
    
    StatusCallback   mpReportStatus;
    void*            mpUserData;

    DWORD            mLaunchTime;
};

#endif // SCROBSUBMITTER_H

---