Shamusworld >> Repos - virtualjaguar/blob - src/gui/filethread.cpp

   1 //
   2 // filethread.cpp - File discovery thread
   3 //
   4 // by James Hammons
   5 // (C) 2010 Underground Software
   6 //
   7 // JLH = James Hammons <jlhamm@acm.org>
   8 //
   9 // Who  When        What
  10 // ---  ----------  -------------------------------------------------------------
  11 // JLH  01/28/2010  Created this file
  12 // JLH  02/16/2010  Moved RomIdentifier stuff to its own file
  13 // JLH  03/02/2010  Added .ZIP file fishing
  14 // JLH  06/28/2011  Cleanup in the file parsing/fishing code, to make it easier
  15 //                  to follow the flow of the logic
  16 //
  17
  18 #include "filethread.h"
  19
  20 #include <QtGui>
  21 #include "crc32.h"
  22 #include "file.h"
  23 #include "filedb.h"
  24 //#include "memory.h"
  25 #include "settings.h"
  26
  27 #define VERBOSE_LOGGING
  28
  29 FileThread::FileThread(QObject * parent/*= 0*/): QThread(parent), abort(false)
  30 {
  31 }
  32
  33 FileThread::~FileThread()
  34 {
  35         mutex.lock();
  36         abort = true;
  37         condition.wakeOne();
  38         mutex.unlock();
  39
  40         wait();
  41 }
  42
  43 void FileThread::Go(bool allowUnknown/*= false*/)
  44 {
  45         allowUnknownSoftware = allowUnknown;
  46         QMutexLocker locker(&mutex);
  47         start();
  48 }
  49
  50 /*
  51 Our strategy here is like so:
  52 Look at the files in the directory pointed to by ROMPath.
  53 For each file in the directory, take the CRC32 of it and compare it to the CRC
  54 in the romList[]. If there's a match, put it in a list and note it's index value
  55 in romList for future reference.
  56
  57 When constructing the list, use the index to pull up an image of the cart and
  58 put that in the list. User picks from a graphical image of the cart.
  59
  60 Ideally, the label will go into the archive along with the ROM image, but that's
  61 for the future...
  62 Maybe box art, screenshots will go as well...
  63 The future is NOW! :-)
  64 */
  65
  66 //
  67 // Here's the thread's actual execution path...
  68 //
  69 void FileThread::run(void)
  70 {
  71         QDir romDir(vjs.ROMPath);
  72         QFileInfoList list = romDir.entryInfoList();
  73
  74         for(int i=0; i<list.size(); i++)
  75         {
  76                 if (abort)
  77 #ifdef VERBOSE_LOGGING
  78 {
  79 printf("FileThread: Aborting!!!\n");
  80 #endif
  81                         return;
  82 #ifdef VERBOSE_LOGGING
  83 }
  84 #endif
  85
  86                 HandleFile(list.at(i));
  87         }
  88 }
  89
  90 //
  91 // This handles file identification and ZIP extraction.
  92 //
  93 void FileThread::HandleFile(QFileInfo fileInfo)
  94 {
  95         bool haveZIPFile = (fileInfo.suffix().compare("zip", Qt::CaseInsensitive) == 0
  96                 ? true : false);
  97         uint32_t fileSize = 0;
  98         uint8 * buffer = NULL;
  99
 100         if (haveZIPFile)
 101         {
 102                 // ZIP files are special: They contain more than just the software now... ;-)
 103                 // So now we fish around inside them to pull out the stuff we want.
 104                 // Probably also need more stringent error checking as well... :-O
 105                 fileSize = GetFileFromZIP(fileInfo.filePath().toAscii(), FT_SOFTWARE, buffer);
 106
 107                 if (fileSize == 0)
 108                         return;
 109         }
 110         else
 111         {
 112                 QFile file(fileInfo.filePath());
 113
 114                 if (!file.open(QIODevice::ReadOnly))
 115                         return;
 116
 117                 fileSize = fileInfo.size();
 118
 119                 if (fileSize == 0)
 120                         return;
 121
 122                 buffer = new uint8[fileSize];
 123                 file.read((char *)buffer, fileSize);
 124                 file.close();
 125         }
 126
 127         // Try to divine the file type by size & header
 128         int fileType = ParseFileType(buffer[0], buffer[1], fileSize);
 129
 130         // Check for Alpine ROM w/Universal Header
 131         bool foundUniversalHeader = HasUniversalHeader(buffer, fileSize);
 132         uint32 crc;
 133
 134 //printf("FileThread: About to calc checksum on file with size %u... (buffer=%08X)\n", size, buffer);
 135         if (foundUniversalHeader)
 136                 crc = crc32_calcCheckSum(buffer + 8192, fileSize - 8192);
 137         else
 138                 crc = crc32_calcCheckSum(buffer, fileSize);
 139
 140         uint32 index = FindCRCIndexInFileList(crc);
 141         delete[] buffer;
 142
 143         // Here we filter out files that are *not* in the DB and of unknown type,
 144         // and BIOS files. If desired, this can be overriden with a config option.
 145         if ((index == 0xFFFFFFFF) && (fileType == JST_NONE))
 146         {
 147                 // If we allow unknown software, we pass the (-1) index on, otherwise...
 148                 if (!allowUnknownSoftware)
 149                         return;                                                         // CRC wasn't found, so bail...
 150         }
 151         else if ((index != 0xFFFFFFFF) && romList[index].flags & FF_BIOS)
 152                 return;
 153
 154 //Here's a little problem. When we create the image here and pass it off to FilePicker,
 155 //we can clobber this image before we have a chance to copy it out in the FilePicker function
 156 //because we can be back here before FilePicker can respond.
 157 // So now we create the image on the heap, problem solved. :-)
 158         QImage * img = NULL;
 159
 160         // See if we can fish out a label. :-)
 161         if (haveZIPFile)
 162         {
 163                 uint32 size = GetFileFromZIP(fileInfo.filePath().toAscii(), FT_LABEL, buffer);
 164 //printf("FT: Label size = %u bytes.\n", size);
 165
 166                 if (size > 0)
 167                 {
 168                         QImage label;
 169                         bool successful = label.loadFromData(buffer, size);
 170                         img = new QImage;
 171                         *img = label.scaled(365, 168, Qt::IgnoreAspectRatio, Qt::SmoothTransformation);
 172 //printf("FT: Label %s: %ux%u.\n", (successful ? "succeeded" : "did not succeed"), img->width(), img->height());
 173                         delete[] buffer;
 174                 }
 175 //printf("FileThread: Attempted to load image. Size: %u x %u...\n", img.width(), img.height());
 176         }
 177
 178 //      emit FoundAFile2(index, fileInfo.canonicalFilePath(), img, fileSize);
 179         emit FoundAFile3(index, fileInfo.canonicalFilePath(), img, fileSize, foundUniversalHeader, fileType, crc);
 180 }
 181
 182 //
 183 // Find a CRC in the ROM list (simple brute force algorithm).
 184 // If it's there, return the index, otherwise return $FFFFFFFF
 185 //
 186 uint32 FileThread::FindCRCIndexInFileList(uint32 crc)
 187 {
 188         // Instead of a simple brute-force search, we should probably do a binary
 189         // partition search instead, since the CRCs are sorted numerically.
 190 #warning "!!! Should do binary partition search here !!!"
 191         for(int i=0; romList[i].crc32!=0xFFFFFFFF; i++)
 192         {
 193                 if (romList[i].crc32 == crc)
 194                         return i;
 195         }
 196
 197         return 0xFFFFFFFF;
 198 }