table_data.h

Go to the documentation of this file.

 
#ifndef TABLE_DATA_H
#define TABLE_DATA_H
 
#include <string>
#include <cstdint>
 
 // vpx = visual pinball X file
 // vbs = visual basic script file
 // vps = virtual pinball spreadsheet (database)
struct TableData {
    // ------------------ FILE PATHS ------------------
    // We need to get the most out of the files before trying to
    // match with vpsdb. We should get the most without any tool, than
    // upgrade the metadata with vpin to get best of both, than finally
    // try to match with the online db to get the best match possible.
    // ----------------- BEST MATCHES --------------------
    // Sorting metadata (calculated best results)
    // title is a generic string to be shown on the UI.
    // with filename it uses the filename, with vpin it uses the best
    // of both (for bad metadata), used to match against vpsdb.
    std::string title;           
    // if all fails we should try to extract these from the file name.
    std::string manufacturer;    
    std::string year;            
    
    std::string vpxFile;         
    std::string folder;          
    std::string playfieldImage;  
    std::string wheelImage;      
    std::string backglassImage;  
    std::string dmdImage;        
    std::string topperImage;     
    std::string playfieldVideo;  
    std::string backglassVideo;  
    std::string dmdVideo;        
    std::string topperVideo;     
    std::string music;           
    std::string launchAudio;     
    std::string romPath;         
    std::string romName;         
    bool hasAltSound = false;    
    bool hasAltColor = false;    
    bool hasPup = false;         
    bool hasAltMusic = false;    
    bool hasUltraDMD = false;    
 
    // ------------ FILE METADATA (vpin/vpxtool) -----------
    // we must keep repeated fields if found for better vpsdb matching 
    std::string tableName;       
    std::string tableAuthor;     
    std::string tableDescription;
    std::string tableSaveDate;   
    std::string tableLastModified;
    std::string tableReleaseDate;
    std::string tableVersion;    
    std::string tableRevision;   
    std::string tableBlurb;      
    std::string tableRules;      
    std::string tableAuthorEmail;
    std::string tableAuthorWebsite;
    // These are inside 'properties' dictionary in 'table_info'
    std::string tableType;       
    std::string tableManufacturer;
    std::string tableYear;       
 
    // --------------- VPSDB METADATA -------------
    // These fields will be populated ONLY IF a match is found in the VPS database.
    std::string vpsId;           
    std::string vpsName;         
    std::string vpsType;         
    std::string vpsThemes;       
    std::string vpsDesigners;    
    std::string vpsPlayers;      
    std::string vpsIpdbUrl;      
    std::string vpsVersion;      
    std::string vpsAuthors;      
    std::string vpsFeatures;     
    std::string vpsComment;      
    std::string vpsManufacturer; 
    std::string vpsYear;         
    std::string vpsTableImgUrl;  
    std::string vpsTableUrl;     
    std::string vpsB2SImgUrl;    
    std::string vpsB2SUrl;       
    std::string vpsFormat;       
    
    // --------------- OPERATIONAL TAGS ------------------
    float matchConfidence = 0.0f;
    uint64_t fileLastModified;   
    // vbs script patcher related
    std::string hashFromVpx;     
    std::string hashFromVbs;     
    bool hasDiffVbs = false;     
    // table launch related
    int playCount = 0;           
    bool isBroken = false;       
    float playTimeLast = 0.0f;   
    float playTimeTotal = 0.0f;  
 
    //TODO: use this to control which scanner to use/increment so we dont have to rebuild
    std::string jsonOwner;       
};
 
#endif // TABLE_DATA_H