mirror of
https://github.com/RetroDECK/ES-DE.git
synced 2024-11-24 15:15:38 +00:00
102 lines
3.9 KiB
C++
102 lines
3.9 KiB
C++
//
|
|
// ScreenScraper.h
|
|
//
|
|
// Functions specifically for scraping from screenscraper.fr
|
|
// Called from Scraper.
|
|
//
|
|
|
|
#pragma once
|
|
#ifndef ES_APP_SCRAPERS_SCREEN_SCRAPER_H
|
|
#define ES_APP_SCRAPERS_SCREEN_SCRAPER_H
|
|
|
|
#include "scrapers/Scraper.h"
|
|
#include "EmulationStation.h"
|
|
|
|
namespace pugi { class xml_document; }
|
|
|
|
void screenscraper_generate_scraper_requests(
|
|
const ScraperSearchParams& params,
|
|
std::queue< std::unique_ptr<ScraperRequest> >& requests,
|
|
std::vector<ScraperSearchResult>& results);
|
|
|
|
class ScreenScraperRequest : public ScraperHttpRequest
|
|
{
|
|
public:
|
|
// ctor for a GetGameList request.
|
|
ScreenScraperRequest(std::queue< std::unique_ptr<ScraperRequest> >& requestsWrite,
|
|
std::vector<ScraperSearchResult>& resultsWrite,
|
|
const std::string& url) : ScraperHttpRequest(resultsWrite, url),
|
|
mRequestQueue(&requestsWrite) {}
|
|
|
|
// ctor for a GetGame request.
|
|
ScreenScraperRequest(std::vector<ScraperSearchResult>& resultsWrite,
|
|
const std::string& url) : ScraperHttpRequest(resultsWrite, url),
|
|
mRequestQueue(nullptr) {}
|
|
|
|
// Settings for the scraper.
|
|
static const struct ScreenScraperConfig {
|
|
std::string getGameSearchUrl(const std::string gameName) const;
|
|
|
|
// Access to the API.
|
|
const std::string API_DEV_U =
|
|
{ 91, 32, 7, 17 };
|
|
const std::string API_DEV_P =
|
|
{ 108, 28, 54, 55, 83, 43, 91, 44, 30, 22, 41, 12, 0, 108, 38, 29 };
|
|
const std::string API_DEV_KEY =
|
|
{ 54, 73, 115, 100, 101, 67, 111, 107, 79, 66, 68, 66, 67, 56, 118, 77, 54, 88, 101, 54 };
|
|
const std::string API_URL_BASE = "https://www.screenscraper.fr/api2";
|
|
const std::string API_SOFT_NAME = "EmulationStation-DE " +
|
|
static_cast<std::string>(PROGRAM_VERSION_STRING);
|
|
|
|
// Which type of image artwork we need. Possible values (not a comprehensive list):
|
|
// - ss: in-game screenshot
|
|
// - box-3D: 3D boxart
|
|
// - box-2D: 2D boxart (default)
|
|
// - screenmarque : marquee
|
|
// - sstitle: in-game start screenshot
|
|
// - steamgrid: Steam artwork
|
|
// - wheel: spine
|
|
// - support-2D: media showing the 2d boxart on the cart
|
|
// - support-3D: media showing the 3d boxart on the cart
|
|
// - video: gameplay videos
|
|
// - video-normalized: gameplay videos in smaller file sizes with lower audio quality
|
|
//
|
|
// Note that not all games contain values for all these, so we default to "ss".
|
|
//
|
|
|
|
std::string media_3dbox = "box-3D";
|
|
std::string media_cover = "box-2D";
|
|
std::string media_marquee = "wheel";
|
|
std::string media_screenshot = "ss";
|
|
std::string media_video = "video";
|
|
|
|
// Which Region to use when selecting the artwork.
|
|
// Applies to: artwork, name of the game, date of release.
|
|
// This is read from es_settings.cfg, setting 'ScraperRegion'.
|
|
|
|
// Which Language to use when selecting the textual information.
|
|
// Applies to: description, genre.
|
|
// This is read from es_settings.cfg, setting 'ScraperLanguage'.
|
|
|
|
ScreenScraperConfig() {};
|
|
} configuration;
|
|
|
|
protected:
|
|
void process(const std::unique_ptr<HttpReq>& req,
|
|
std::vector<ScraperSearchResult>& results) override;
|
|
|
|
void processList(const pugi::xml_document& xmldoc, std::vector<ScraperSearchResult>& results);
|
|
void processGame(const pugi::xml_document& xmldoc, std::vector<ScraperSearchResult>& results);
|
|
void processMedia(ScraperSearchResult& result,
|
|
const pugi::xml_node& media_list,
|
|
std::string mediaType,
|
|
std::string& fileURL,
|
|
std::string& fileFormat,
|
|
std::string region);
|
|
bool isGameRequest() { return !mRequestQueue; }
|
|
|
|
std::queue< std::unique_ptr<ScraperRequest> >* mRequestQueue;
|
|
};
|
|
|
|
#endif // ES_APP_SCRAPERS_SCREEN_SCRAPER_H
|