src/lyrics.h

   1 /***************************************************************************
   2  *   Copyright (C) 2008-2014 by Andrzej Rybczak                            *
   3  *   electricityispower@gmail.com                                          *
   4  *                                                                         *
   5  *   This program is free software; you can redistribute it and/or modify  *
   6  *   it under the terms of the GNU General Public License as published by  *
   7  *   the Free Software Foundation; either version 2 of the License, or     *
   8  *   (at your option) any later version.                                   *
   9  *                                                                         *
  10  *   This program is distributed in the hope that it will be useful,       *
  11  *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
  12  *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         *
  13  *   GNU General Public License for more details.                          *
  14  *                                                                         *
  15  *   You should have received a copy of the GNU General Public License     *
  16  *   along with this program; if not, write to the                         *
  17  *   Free Software Foundation, Inc.,                                       *
  18  *   51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA.              *
  19  ***************************************************************************/
  20
  21 #ifndef NCMPCPP_LYRICS_H
  22 #define NCMPCPP_LYRICS_H
  23
  24 #include <pthread.h>
  25 #include <queue>
  26
  27 #include "interfaces.h"
  28 #include "lyrics_fetcher.h"
  29 #include "screen.h"
  30 #include "song.h"
  31
  32 struct Lyrics: Screen<NC::Scrollpad>, Tabbable
  33 {
  34         Lyrics();
  35
  36         // Screen<NC::Scrollpad> implementation
  37         virtual void resize() OVERRIDE;
  38         virtual void switchTo() OVERRIDE;
  39
  40         virtual std::wstring title() OVERRIDE;
  41         virtual ScreenType type() OVERRIDE { return ScreenType::Lyrics; }
  42
  43         virtual void update() OVERRIDE;
  44
  45         virtual bool isLockable() OVERRIDE { return false; }
  46         virtual bool isMergable() OVERRIDE { return true; }
  47
  48         // private members
  49         bool SetSong(const MPD::Song &s);
  50         void Edit();
  51
  52 #       ifdef HAVE_CURL_CURL_H
  53         void Refetch();
  54
  55         static void ToggleFetcher();
  56         static void DownloadInBackground(const MPD::Song &s);
  57 #       endif // HAVE_CURL_CURL_H
  58
  59         bool Reload;
  60
  61 private:
  62         void Load();
  63
  64 #       ifdef HAVE_CURL_CURL_H
  65         static void *DownloadInBackgroundImpl(void *song_ptr);
  66         static void DownloadInBackgroundImplHelper(const MPD::Song &s);
  67         // lock for allowing exclusive access to itsToDownload and itsWorkersNumber
  68         static pthread_mutex_t itsDIBLock;
  69         // storage for songs for which lyrics are scheduled to be downloaded
  70         static std::queue<MPD::Song *> itsToDownload;
  71         // current worker threads (ie. downloading lyrics)
  72         static size_t itsWorkersNumber;
  73         // maximum number of worker threads. if it's reached, next lyrics requests
  74         // are put into itsToDownload queue.
  75         static const size_t itsMaxWorkersNumber = 4;
  76
  77         void *Download();
  78         static void *DownloadWrapper(void *);
  79         static void Save(const std::string &filename, const std::string &lyrics);
  80
  81         void Take();
  82         bool isReadyToTake;
  83         bool isDownloadInProgress;
  84         pthread_t itsDownloader;
  85
  86         static LyricsFetcher **itsFetcher;
  87 #       endif // HAVE_CURL_CURL_H
  88
  89         size_t itsScrollBegin;
  90         MPD::Song itsSong;
  91         std::string itsFilename;
  92
  93         static std::string GenerateFilename(const MPD::Song &s);
  94 };
  95
  96 extern Lyrics *myLyrics;
  97
  98 #endif // NCMPCPP_LYRICS_H
  99