src/Global.cpp

   1 ///////////////////////////////////////////////////////////////////////////////
   2 // LameXP - Audio Encoder Front-End
   3 // Copyright (C) 2004-2010 LoRd_MuldeR <MuldeR2@GMX.de>
   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 along
  16 // with this program; if not, write to the Free Software Foundation, Inc.,
  17 // 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
  18 //
  19 // http://www.gnu.org/licenses/gpl-2.0.txt
  20 ///////////////////////////////////////////////////////////////////////////////
  21
  22 #include "Global.h"
  23
  24 //Qt includes
  25 #include <QApplication>
  26 #include <QMessageBox>
  27 #include <QDir>
  28 #include <QUuid>
  29 #include <QMap>
  30 #include <QDate>
  31 #include <QIcon>
  32 #include <QPlastiqueStyle>
  33 #include <QImageReader>
  34 #include <QSharedMemory>
  35 #include <QSysInfo>
  36 #include <QStringList>
  37
  38 //LameXP includes
  39 #include "Resource.h"
  40 #include "LockedFile.h"
  41
  42 //CRT includes
  43 #include <stdio.h>
  44 #include <io.h>
  45 #include <fcntl.h>
  46
  47 //Debug only includes
  48 #ifdef _DEBUG
  49 #include <Psapi.h>
  50 #endif //_DEBUG
  51
  52 ///////////////////////////////////////////////////////////////////////////////
  53 // GLOBAL VARS
  54 ///////////////////////////////////////////////////////////////////////////////
  55
  56 //Build version
  57 static const unsigned int g_lamexp_version_major = VER_LAMEXP_MAJOR;
  58 static const unsigned int g_lamexp_version_minor = VER_LAMEXP_MINOR;
  59 static const unsigned int g_lamexp_version_build = VER_LAMEXP_BUILD;
  60 static const char *g_lamexp_version_release = VER_LAMEXP_SUFFIX_STR;
  61
  62 //Build date
  63 static QDate g_lamexp_version_date;
  64 static const char *g_lamexp_months[] = {"Jan", "Feb", "Mar", "Apr", "May", "Jun", "Jul", "Aug", "Sep", "Oct", "Nov", "Dec"};
  65 static const char *g_lamexp_version_raw_date = __DATE__;
  66
  67 //Special folders
  68 static QString g_lamexp_temp_folder;
  69
  70 //Tools
  71 static QMap<QString, LockedFile*> g_lamexp_tool_registry;
  72
  73 //Shared memory
  74 static const char *g_lamexp_sharedmem_uuid = "{21A68A42-6923-43bb-9CF6-64BF151942EE}";
  75 static QSharedMemory *g_lamexp_sharedmem_ptr = NULL;
  76
  77 ///////////////////////////////////////////////////////////////////////////////
  78 // GLOBAL FUNCTIONS
  79 ///////////////////////////////////////////////////////////////////////////////
  80
  81 /*
  82  * Version getters
  83  */
  84 unsigned int lamexp_version_major(void) { return g_lamexp_version_major; }
  85 unsigned int lamexp_version_minor(void) { return g_lamexp_version_minor; }
  86 unsigned int lamexp_version_build(void) { return g_lamexp_version_build; }
  87 const char *lamexp_version_release(void) { return g_lamexp_version_release; }
  88
  89 bool lamexp_version_demo(void)
  90 {
  91         return !(strstr(g_lamexp_version_release, "Final") || strstr(g_lamexp_version_release, "Hotfix"));
  92 }
  93
  94 /*
  95  * Get build date date
  96  */
  97 const QDate &lamexp_version_date(void)
  98 {
  99         if(!g_lamexp_version_date.isValid())
 100         {
 101                 char temp[32];
 102                 int date[3];
 103
 104                 char *this_token = NULL;
 105                 char *next_token = NULL;
 106
 107                 strcpy_s(temp, 32, g_lamexp_version_raw_date);
 108                 this_token = strtok_s(temp, " ", &next_token);
 109
 110                 for(int i = 0; i < 3; i++)
 111                 {
 112                         date[i] = -1;
 113                         if(this_token)
 114                         {
 115                                 for(int j = 0; j < 12; j++)
 116                                 {
 117                                         if(!_strcmpi(this_token, g_lamexp_months[j]))
 118                                         {
 119                                                 date[i] = j+1;
 120                                                 break;
 121                                         }
 122                                 }
 123                                 if(date[i] < 0)
 124                                 {
 125                                         date[i] = atoi(this_token);
 126                                 }
 127                                 this_token = strtok_s(NULL, " ", &next_token);
 128                         }
 129                 }
 130
 131                 if(date[0] >= 0 && date[1] >= 0 && date[2] >= 0)
 132                 {
 133                         g_lamexp_version_date = QDate(date[2], date[0], date[1]);
 134                 }
 135         }
 136
 137         return g_lamexp_version_date;
 138 }
 139
 140 /*
 141  * Initialize the console
 142  */
 143 void lamexp_init_console(int argc, char* argv[])
 144 {
 145         for(int i = 0; i < argc; i++)
 146         {
 147                 if(lamexp_version_demo() || !_stricmp(argv[i], "--console"))
 148                 {
 149                         if(AllocConsole())
 150                         {
 151                                 //See: http://support.microsoft.com/default.aspx?scid=kb;en-us;105305
 152                                 int hCrtStdOut = _open_osfhandle((long) GetStdHandle(STD_OUTPUT_HANDLE), _O_TEXT);
 153                                 int hCrtStdErr = _open_osfhandle((long) GetStdHandle(STD_ERROR_HANDLE), _O_TEXT);
 154                                 FILE *hfStdOut = _fdopen(hCrtStdOut, "w");
 155                                 FILE *hfStderr = _fdopen(hCrtStdErr, "w");
 156                                 *stdout = *hfStdOut;
 157                                 *stderr = *hfStderr;
 158                                 setvbuf(stdout, NULL, _IONBF, 0);
 159                                 setvbuf(stderr, NULL, _IONBF, 0);
 160                         }
 161
 162                         HMENU hMenu = GetSystemMenu(GetConsoleWindow(), 0);
 163                         EnableMenuItem(hMenu, SC_CLOSE, MF_BYCOMMAND | MF_GRAYED);
 164                         RemoveMenu(hMenu, SC_CLOSE, MF_BYCOMMAND);
 165
 166                         SetConsoleCtrlHandler(NULL, TRUE);
 167                         SetConsoleTitle(L"LameXP - Audio Encoder Front-End | Debug Console");
 168                         SetConsoleOutputCP(CP_UTF8);
 169
 170                         break;
 171                 }
 172         }
 173 }
 174
 175 /*
 176  * Initialize Qt framework
 177  */
 178 bool lamexp_init_qt(int argc, char* argv[])
 179 {
 180         static bool qt_initialized = false;
 181
 182         //Don't initialized again, if done already
 183         if(qt_initialized)
 184         {
 185                 return true;
 186         }
 187
 188         //Check Qt version
 189         qDebug("Using Qt Framework v%s, compiled with Qt v%s", qVersion(), QT_VERSION_STR);
 190         QT_REQUIRE_VERSION(argc, argv, QT_VERSION_STR);
 191
 192         //Check the Windows version
 193         switch(QSysInfo::WindowsVersion)
 194         {
 195         case QSysInfo::WV_2000:
 196                 qDebug("Running on Windows 2000 (not offically supported!).\n");
 197                 break;
 198         case QSysInfo::WV_XP:
 199                 qDebug("Running on Windows XP.\n\n");
 200                 break;
 201         case QSysInfo::WV_2003:
 202                 qDebug("Running on Windows Server 2003 or Windows XP Professional x64 Edition.\n");
 203                 break;
 204         case QSysInfo::WV_VISTA:
 205                 qDebug("Running on Windows Vista or Windows Server 200.8\n");
 206                 break;
 207         case QSysInfo::WV_WINDOWS7:
 208                 qDebug("Running on Windows 7 or Windows Server 2008 R2.\n");
 209                 break;
 210         default:
 211                 qFatal("Unsupported OS, only Windows 2000 or later is supported!");
 212                 break;
 213         }
 214
 215         //Create Qt application instance and setup version info
 216         QApplication *application = new QApplication(argc, argv);
 217         application->setApplicationName("LameXP - Audio Encoder Front-End");
 218         application->setApplicationVersion(QString().sprintf("%d.%02d.%04d", lamexp_version_major(), lamexp_version_minor(), lamexp_version_build()));
 219         application->setOrganizationName("LoRd_MuldeR");
 220         application->setOrganizationDomain("mulder.dummwiedeutsch.de");
 221         application->setWindowIcon(QIcon(":/MainIcon.png"));
 222
 223         //Load plugins from application directory
 224         QCoreApplication::setLibraryPaths(QStringList() << QApplication::applicationDirPath());
 225         qDebug("Library Path:\n%s\n", QApplication::libraryPaths().first().toUtf8().constData());
 226
 227         //Check for supported image formats
 228         QList<QByteArray> supportedFormats = QImageReader::supportedImageFormats();
 229         if(!(supportedFormats.contains("png") && supportedFormats.contains("gif")  && supportedFormats.contains("ico") && supportedFormats.contains("svg")))
 230         {
 231                 qFatal("Qt initialization error: At least one image format plugin is missing!");
 232                 return false;
 233         }
 234
 235         //Change application look
 236         QApplication::setStyle(new QPlastiqueStyle());
 237
 238         //Done
 239         qt_initialized = true;
 240         return true;
 241 }
 242
 243 /*
 244  * Check for running instances of LameXP
 245  */
 246 bool lamexp_check_instances(void)
 247 {
 248         if(g_lamexp_sharedmem_ptr)
 249         {
 250                 return true;
 251         }
 252
 253         QSharedMemory *sharedMemory = new QSharedMemory(g_lamexp_sharedmem_uuid, NULL);
 254
 255         if(!sharedMemory->create(1048576))
 256         {
 257                 if(sharedMemory->error() == QSharedMemory::AlreadyExists)
 258                 {
 259                         LAMEXP_DELETE(sharedMemory);
 260                         qWarning("Another instance of LameXP is already running on this computer!");
 261                         QMessageBox::warning(NULL, "LameXP", "LameXP is already running. Please use the running instance!");
 262                         return false;
 263                 }
 264                 else
 265                 {
 266                         QString errorMessage = sharedMemory->errorString();
 267                         LAMEXP_DELETE(sharedMemory);
 268                         qFatal("Failed to create shared memory: %s", errorMessage.toUtf8().constData());
 269                         return false;
 270                 }
 271         }
 272
 273         g_lamexp_sharedmem_ptr = sharedMemory;
 274         return true;
 275 }
 276
 277 /*
 278  * Get LameXP temp folder
 279  */
 280 const QString &lamexp_temp_folder(void)
 281 {
 282         if(g_lamexp_temp_folder.isEmpty())
 283         {
 284                 QDir tempFolder(QDir::tempPath());
 285                 QString uuid = QUuid::createUuid().toString();
 286                 tempFolder.mkdir(uuid);
 287
 288                 if(tempFolder.cd(uuid))
 289                 {
 290                         g_lamexp_temp_folder = tempFolder.absolutePath();
 291                 }
 292                 else
 293                 {
 294                         g_lamexp_temp_folder = QDir::tempPath();
 295                 }
 296         }
 297
 298         return g_lamexp_temp_folder;
 299 }
 300
 301 /*
 302  * Clean folder
 303  */
 304 bool lamexp_clean_folder(const QString folderPath)
 305 {
 306         QDir tempFolder(folderPath);
 307         QFileInfoList entryList = tempFolder.entryInfoList();
 308
 309         for(int i = 0; i < entryList.count(); i++)
 310         {
 311                 if(entryList.at(i).fileName().compare(".") == 0 || entryList.at(i).fileName().compare("..") == 0)
 312                 {
 313                         continue;
 314                 }
 315
 316                 if(entryList.at(i).isDir())
 317                 {
 318                         lamexp_clean_folder(entryList.at(i).absoluteFilePath());
 319                 }
 320                 else
 321                 {
 322                         QFile::remove(entryList.at(i).absoluteFilePath());
 323                 }
 324         }
 325
 326         tempFolder.rmdir(".");
 327         return !tempFolder.exists();
 328 }
 329
 330 /*
 331  * Finalization function (final clean-up)
 332  */
 333 void lamexp_finalization(void)
 334 {
 335         //Free all tools
 336         if(!g_lamexp_tool_registry.isEmpty())
 337         {
 338                 QStringList keys = g_lamexp_tool_registry.keys();
 339                 for(int i = 0; i < keys.count(); i++)
 340                 {
 341                         LAMEXP_DELETE(g_lamexp_tool_registry[keys.at(i)]);
 342                 }
 343                 g_lamexp_tool_registry.clear();
 344         }
 345
 346         //Delete temporary files
 347         if(!g_lamexp_temp_folder.isEmpty())
 348         {
 349                 for(int i = 0; i < 100; i++)
 350                 {
 351                         if(lamexp_clean_folder(g_lamexp_temp_folder)) break;
 352                         Sleep(125);
 353                 }
 354                 g_lamexp_temp_folder.clear();
 355         }
 356
 357         //Destroy Qt application object
 358         QApplication *application = dynamic_cast<QApplication*>(QApplication::instance());
 359         LAMEXP_DELETE(application);
 360
 361         //Detach from shared memory
 362         if(g_lamexp_sharedmem_ptr) g_lamexp_sharedmem_ptr->detach();
 363         LAMEXP_DELETE(g_lamexp_sharedmem_ptr);
 364 }
 365
 366 /*
 367  * Register tool
 368  */
 369 void lamexp_register_tool(const QString &toolName, LockedFile *file)
 370 {
 371         if(g_lamexp_tool_registry.contains(toolName))
 372         {
 373                 throw "lamexp_register_tool: Tool is already registered!";
 374         }
 375
 376         g_lamexp_tool_registry.insert(toolName, file);
 377 }
 378
 379 /*
 380  * Register tool
 381  */
 382 const QString lamexp_lookup_tool(const QString &toolName)
 383 {
 384         if(g_lamexp_tool_registry.contains(toolName))
 385         {
 386                 return g_lamexp_tool_registry.value(toolName)->filePath();
 387         }
 388         else
 389         {
 390                 return QString();
 391         }
 392 }
 393
 394 /*
 395  * Get number private bytes [debug only]
 396  */
 397 SIZE_T lamexp_dbg_private_bytes(void)
 398 {
 399 #ifdef _DEBUG
 400         PROCESS_MEMORY_COUNTERS_EX memoryCounters;
 401         memoryCounters.cb = sizeof(PROCESS_MEMORY_COUNTERS_EX);
 402         GetProcessMemoryInfo(GetCurrentProcess(), (PPROCESS_MEMORY_COUNTERS) &memoryCounters, sizeof(PROCESS_MEMORY_COUNTERS_EX));
 403         return memoryCounters.PrivateUsage;
 404 #else
 405         throw "Cannot call this function in a non-debug build!";
 406 #endif //_DEBUG
 407 }