src/Global.h

   1 ///////////////////////////////////////////////////////////////////////////////
   2 // LameXP - Audio Encoder Front-End
   3 // Copyright (C) 2004-2013 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 #pragma once
  23
  24 //Target version
  25 #include "Targetver.h"
  26
  27 //inlcude C standard library
  28 #define _CRT_RAND_S
  29 #include <stdio.h>
  30 #include <tchar.h>
  31
  32 //Visual Leaks Detector
  33 #include <vld.h>
  34
  35 //Declarations
  36 class QString;
  37 class QStringList;
  38 class QDate;
  39 class QTime;
  40 class QIcon;
  41 class QWidget;
  42 class QProcess;
  43 class LockedFile;
  44 enum QtMsgType;
  45
  46 //Types definitions
  47 typedef struct
  48 {
  49         int family;
  50         int model;
  51         int stepping;
  52         int count;
  53         bool x64;
  54         bool mmx;
  55         bool sse;
  56         bool sse2;
  57         bool sse3;
  58         bool ssse3;
  59         char vendor[0x40];
  60         char brand[0x40];
  61         bool intel;
  62 }
  63 lamexp_cpu_t;
  64
  65 //Known folders
  66 typedef enum
  67 {
  68         lamexp_folder_localappdata = 0,
  69         lamexp_folder_programfiles = 2,
  70         lamexp_folder_systemfolder = 3
  71 }
  72 lamexp_known_folder_t;
  73
  74 //LameXP user-defined events
  75 typedef enum
  76 {
  77         lamexp_event = 1000,           /*QEvent::User*/
  78         lamexp_event_queryendsession = lamexp_event + 666,
  79         lamexp_event_endsession      = lamexp_event + 667
  80 }
  81 lamexp_event_t;
  82
  83 //OS version number
  84 typedef struct
  85 {
  86         unsigned int versionMajor;
  87         unsigned int versionMinor;
  88 }
  89 lamexp_os_version_t;
  90
  91 //Beep types
  92 typedef enum
  93 {
  94         lamexp_beep_info = 0,
  95         lamexp_beep_warning = 1,
  96         lamexp_beep_error = 2
  97 }
  98 lamexp_beep_t;
  99
 100 //LameXP version info
 101 unsigned int lamexp_version_major(void);
 102 unsigned int lamexp_version_minor(void);
 103 unsigned int lamexp_version_build(void);
 104 unsigned int lamexp_version_confg(void);
 105 const QDate &lamexp_version_date(void);
 106 const char *lamexp_version_time(void);
 107 const char *lamexp_version_release(void);
 108 bool lamexp_version_demo(void);
 109 const char *lamexp_version_compiler(void);
 110 const char *lamexp_version_arch(void);
 111 QDate lamexp_version_expires(void);
 112 unsigned int lamexp_toolver_neroaac(void);
 113 unsigned int lamexp_toolver_fhgaacenc(void);
 114 unsigned int lamexp_toolver_qaacenc(void);
 115 unsigned int lamexp_toolver_coreaudio(void);
 116 const char *lamexp_website_url(void);
 117 const char *lamexp_mulders_url(void);
 118 const char *lamexp_support_url(void);
 119 const lamexp_os_version_t *lamexp_get_os_version(void);
 120 bool lamexp_detect_wine(void);
 121
 122 //Public functions
 123 void lamexp_init_console(const QStringList &argv);
 124 bool lamexp_init_qt(int argc, char* argv[]);
 125 int lamexp_init_ipc(void);
 126 void lamexp_invalid_param_handler(const wchar_t*, const wchar_t*, const wchar_t*, unsigned int, uintptr_t);
 127 void lamexp_message_handler(QtMsgType type, const char *msg);
 128 void lamexp_register_tool(const QString &toolName, LockedFile *file, unsigned int version = 0, const QString *tag = NULL);
 129 bool lamexp_check_tool(const QString &toolName);
 130 const QString lamexp_lookup_tool(const QString &toolName);
 131 unsigned int lamexp_tool_version(const QString &toolName, QString *tag = NULL);
 132 void lamexp_finalization(void);
 133 QString lamexp_rand_str(const bool bLong = false);
 134 const QString &lamexp_temp_folder2(void);
 135 void lamexp_ipc_read(unsigned int *command, char* message, size_t buffSize);
 136 void lamexp_ipc_send(unsigned int command, const char* message);
 137 lamexp_cpu_t lamexp_detect_cpu_features(const QStringList &argv);
 138 bool lamexp_portable_mode(void);
 139 bool lamexp_shutdown_computer(const QString &message, const unsigned long timeout = 30, const bool forceShutdown = true, const bool hibernate = false);
 140 bool lamexp_is_hibernation_supported(void);
 141 QIcon lamexp_app_icon(const QDate *date = NULL, const QTime *time = NULL);
 142 const QStringList &lamexp_arguments(void);
 143
 144 //Translation support
 145 QStringList lamexp_query_translations(void);
 146 bool lamexp_translation_register(const QString &langId, const QString &qmFile, const QString &langName, unsigned int &systemId, unsigned int &country);
 147 QString lamexp_translation_name(const QString &language);
 148 unsigned int lamexp_translation_sysid(const QString &langId);
 149 unsigned int lamexp_translation_country(const QString &langId);
 150 bool lamexp_install_translator_from_file(const QString &qmFile);
 151 bool lamexp_install_translator(const QString &language);
 152 QStringList lamexp_available_codepages(bool noAliases = true);
 153 extern const char* LAMEXP_DEFAULT_LANGID;
 154 extern const char* LAMEXP_DEFAULT_TRANSLATION;
 155
 156 //Auxiliary functions
 157 bool lamexp_clean_folder(const QString &folderPath);
 158 const QString lamexp_version2string(const QString &pattern, unsigned int version, const QString &defaultText, const QString *tag = NULL);
 159 const QString &lamexp_known_folder(lamexp_known_folder_t folder_id);
 160 unsigned __int64 lamexp_free_diskspace(const QString &path, bool *ok = NULL);
 161 bool lamexp_remove_file(const QString &filename);
 162 bool lamexp_themes_enabled(void);
 163 void lamexp_blink_window(QWidget *poWindow, unsigned int count = 10, unsigned int delay = 150);
 164 const QString lamexp_clean_filename(const QString &str);
 165 const QString lamexp_clean_filepath(const QString &str);
 166 void lamexp_seed_rand(void);
 167 unsigned int lamexp_rand(void);
 168 QDate lamexp_current_date_safe(void);
 169 void lamexp_sleep(const unsigned int delay);
 170 bool lamexp_beep(int beepType);
 171 bool lamexp_play_sound(const unsigned short uiSoundIdx, const bool bAsync, const wchar_t *alias = NULL);
 172 bool lamexp_play_sound_file(const QString &library, const unsigned short uiSoundIdx, const bool bAsync);
 173 bool lamexp_exec_shell(const QWidget *win, const QString &url, const bool explore = false);
 174 bool lamexp_exec_shell(const QWidget *win, const QString &url, const QString &parameters, const QString &directory, const bool explore = false);
 175 __int64 lamexp_perfcounter_frequ(void);
 176 __int64 lamexp_perfcounter_value(void);
 177 bool lamexp_append_sysmenu(const QWidget *win, const unsigned int identifier, const QString &text);
 178 bool lamexp_update_sysmenu(const QWidget *win, const unsigned int identifier, const QString &text);
 179 bool lamexp_check_sysmenu_msg(void *message, const unsigned int identifier);
 180 bool lamexp_enable_close_button(const QWidget *win, const bool bEnable = true);
 181 bool lamexp_check_escape_state(void);
 182 bool lamexp_change_process_priority(const int priority);
 183 bool lamexp_change_process_priority(const QProcess *proc, const int priority);
 184 bool lamexp_change_process_priority(void *hProcess, const int priority);
 185 bool lamexp_bring_to_front(const QWidget *win);
 186 bool lamexp_bring_process_to_front(const unsigned long pid);
 187 bool lamexp_get_connection_state(void);
 188 unsigned long lamexp_process_id(const QProcess *proc);
 189 unsigned __int64 lamexp_current_file_time(void);
 190 void lamexp_natural_string_sort(QStringList &list, const bool bIgnoreCase);
 191 bool lamexp_open_media_file(const QString &mediaFilePath);
 192 QString lamexp_path_to_short(const QString &longPath);
 193 void lamexp_fatal_exit(const wchar_t* exitMessage, const wchar_t* errorBoxMessage = NULL);
 194
 195 //Debug-only functions
 196 unsigned long lamexp_dbg_private_bytes(void);
 197
 198 //Helper macros
 199 #define LAMEXP_DELETE(PTR) do { if(PTR) { delete PTR; PTR = NULL; } } while(0)
 200 #define LAMEXP_DELETE_ARRAY(PTR) do { if(PTR) { delete [] PTR; PTR = NULL; } } while(0)
 201 #define LAMEXP_SAFE_FREE(PTR) do { if(PTR) { free((void*) PTR); PTR = NULL; } } while(0)
 202 #define LAMEXP_CLOSE(HANDLE) do { if(HANDLE != NULL && HANDLE != INVALID_HANDLE_VALUE) { CloseHandle(HANDLE); HANDLE = NULL; } } while(0)
 203 #define LAMEXP_MIN_OS_VER(VER_INFO, VER_MAJ, VER_MIN) (((VER_INFO)->versionMajor > (VER_MAJ)) || (((VER_INFO)->versionMajor == (VER_MAJ)) && ((VER_INFO)->versionMinor >= (VER_MIN))))
 204 #define LAMEXP_MAX_OS_VER(VER_INFO, VER_MAJ, VER_MIN) (((VER_INFO)->versionMajor < (VER_MAJ)) || (((VER_INFO)->versionMajor == (VER_MAJ)) && ((VER_INFO)->versionMinor <= (VER_MIN))))
 205 #define LAMEXP_EQL_OS_VER(VER_INFO, VER_MAJ, VER_MIN) (((VER_INFO)->versionMajor == (VER_MAJ)) && ((VER_INFO)->versionMinor == (VER_MIN)))
 206 #define QWCHAR(STR) reinterpret_cast<const wchar_t*>((STR).utf16())
 207 #define WCHAR2QSTR(STR) QString::fromUtf16(reinterpret_cast<const unsigned short*>(STR))
 208 #define LAMEXP_BOOL2STR(X) (X ? "1" : "0")
 209 #define LAMEXP_MAKE_STRING_EX(X) #X
 210 #define LAMEXP_MAKE_STRING(X) LAMEXP_MAKE_STRING_EX(X)
 211 #define LAMEXP_COMPILER_WARNING(TXT) __pragma(message(__FILE__ "(" LAMEXP_MAKE_STRING(__LINE__) ") : warning: " TXT))
 212 #define NOBR(STR) (QString("<nobr>%1</nobr>").arg((STR)).replace("-", "&minus;"))
 213
 214 //Check for debug build
 215 #if defined(_DEBUG) && defined(QT_DEBUG) && !defined(NDEBUG) && !defined(QT_NO_DEBUG)
 216         #define LAMEXP_DEBUG (1)
 217 #elif defined(NDEBUG) && defined(QT_NO_DEBUG) && !defined(_DEBUG) && !defined(QT_DEBUG)
 218         #define LAMEXP_DEBUG (0)
 219 #else
 220         #error Inconsistent debug defines detected!
 221 #endif
 222
 223 //Memory check
 224 #if LAMEXP_DEBUG
 225 #define LAMEXP_MEMORY_CHECK(FUNC, RETV,  ...) do \
 226 { \
 227         SIZE_T _privateBytesBefore = lamexp_dbg_private_bytes(); \
 228         RETV = FUNC(__VA_ARGS__); \
 229         SIZE_T _privateBytesLeak = (lamexp_dbg_private_bytes() - _privateBytesBefore) / 1024; \
 230         if(_privateBytesLeak > 0) { \
 231                 char _buffer[128]; \
 232                 _snprintf_s(_buffer, 128, _TRUNCATE, "Memory leak: Lost %u KiloBytes of PrivateUsage memory.\n", _privateBytesLeak); \
 233                 OutputDebugStringA("----------\n"); \
 234                 OutputDebugStringA(_buffer); \
 235                 OutputDebugStringA("----------\n"); \
 236         } \
 237 } \
 238 while(0)
 239 #else
 240 #define LAMEXP_MEMORY_CHECK(FUNC, RETV,  ...) do \
 241 { \
 242         RETV = __noop(__VA_ARGS__); \
 243 } \
 244 while(0)
 245 #endif
 246
 247 //Check for CPU-compatibility options
 248 #if !defined(_M_X64) && defined(_MSC_VER) && defined(_M_IX86_FP)
 249         #if (_M_IX86_FP != 0)
 250                 #error We should not enabled SSE or SSE2 in release builds!
 251         #endif
 252 #endif
 253
 254 //Helper macro for throwing exceptions
 255 #define THROW(MESSAGE) throw std::runtime_error((MESSAGE))
 256 #define THROW_FMT(FORMAT, ...) do \
 257 { \
 258         char error_msg[512]; \
 259         _snprintf_s(error_msg, 512, _TRUNCATE, (FORMAT), __VA_ARGS__); \
 260         throw std::runtime_error(error_msg); \
 261 } \
 262 while(0)