source/RELEASENOTE.txt

   1 ** Qt porting and FM-7/77/AV/AV40/EX for Common Source Code Project **
   2
   3                                                        July 13 , 2018
   4                             K.Ohta  (whatisthis.sowhat _at_ gmail.com)
   5
   6 1.About
   7
   8 This package is Qt5 porting of Common Source Code Project (CSP)
   9 and built with Qt5, for Windows, built with MinGW(32bit).
  10
  11 Source Code:
  12
  13    https://github.com/Artanejp/common_source_project-fm7/releases/tag/SNAPSHOT_20180713
  14
  15 Additional INFO:
  16
  17    Binaries will be available, distibute from osdn.net.
  18
  19    See, https://osdn.net/projects/csp-qt/  and
  20         https://osdn.net/projects/csp-qt/releases/ .
  21
  22    Released at:
  23
  24
  25 2.Background
  26
  27 Common Source Code Project (CSP) is good emulator writing.
  28 It also distributed with GPLv2, this is good for me.
  29
  30 But codes are specified to M$ Visual C.
  31 I'm using GNU/Linux, and I starting to apply FM-7(or later).
  32
  33 So, I start to port to GNU/Linux and using Qt4/Qt5.
  34
  35 What you need at least:
  36
  37 a. Qt5 (neither Qt3 and Qt4) toolkit: Qt5.3 or later.
  38
  39 b. Some OpenGL implementation, maybe at leaset OpenGL v2.x .
  40
  41 c. gcc / g++ (5.0 or later? ) or llvm clang / clang++ (3.5 or later?) toolchain.
  42
  43 d. SDL2 (not SDL1.x).
  44
  45 e. CMake 2.8 or later.
  46
  47 f. Needs ffmpeg.See https://ffmpeg.org/ .
  48
  49 g. FFMpeg has bundled only for Win32.Please install for other OSs if not working.
  50
  51 h. Built with Qt5.5 (for Ubuntu 16.04LTS) or Qt 5.10 (for Win32 and Debian/Sid).
  52
  53 i. Now, changed default drawing infrastructure to OpenGL ES2.You can change --opengl option via comman line (or GUI).
  54
  55 * TIPS: If emufoo.exe don't show screen drawing, set environment variable QT_OPENGL to software (i.e. Using Windows as VirtualBox's gueat OS).
  56
  57
  58 3.How to build:
  59
  60 After extracting (or git pulled) sourcecodes:
  61
  62 $ cd {srctop}/source/build-cmake/{Machine name}/
  63
  64 $ mkdir build
  65
  66 $ cd build
  67
  68 To configure:
  69
  70 $ cmake ..
  71
  72 or
  73
  74 $ ccmake ..
  75
  76 To build:
  77
  78 $ make
  79
  80 To install:
  81
  82 $ sudo make install
  83
  84 4.Qt specified notice:
  85
  86    ・Config file (scancode.cfg and foo.ini) has placed (moved) to
  87      "~/.config/CommonSourceCodeProject/emufoo/"
  88      (for Windows, ".\CommonSourceCodeProject\emudfoo\" ).
  89
  90    ・BIOS, WAVS, BINS and SAVED STATES have placed (moved) to
  91      "~/CommonSourceCodeProject/emufoo/"
  92      (for Windows, ".\CommonSourceCodeProject\emudfoo\" ).
  93
  94    ・All of recorded products (PNG Screenshots, MOVIES, SOUNDS)
  95      have *temporally* written to "~/.config/CommonSourceCodeProject/emufoo/"
  96      (for Windows, ".\CommonSourceCodeProject\emudfoo\" ).
  97
  98    ・Added ToolTips and Japanese translations.(2017-01-24)
  99
 100    ・Place R@Ms under $HOME/CommonSourceCodeProject/emu{Machine Name}/ , this directory has made
 101      after first using.
 102
 103    ・Config file, {foo}.ini is written on $HOME/.config/CommonSourceCodeProject/emu{Machine Name}/ .
 104
 105    ・Saved state file, {foo}.sta is written on $HOME/CommonSourceCodeProject/emu{Machine Name}/ .
 106
 107    ・Key code conversion file is written on $HOME/.config/CommonSourceCodeProject/emu{Machine Name}/scancode.cfg .
 108
 109      This file contains comma separated fields, written at hex-decimal (not decimal),
 110        first is M$ Virtual Key Code,
 111        second is Qt's scan code.
 112
 113    ・Common UI components (at src/qt/gui ) are moved to shared lib. libCSPgui.so .
 114
 115    ・Installer (bash) script is available now; src/tool/installer_unix.sh .
 116
 117    ・When you place specified WAV files(differ per VM) same directory as ROMs, you can sound sounds: i.e. FDD seek, CMT relay and buttons.
 118
 119 5.Status
 120
 121 a. I tested to build only under Debian GNU/Linux "sid",Ubuntu Linux 16.04LTS "Xenial" for AMD64 (x86_64)
 122 and MinGW with GCC6 (Windows 32bit).
 123
 124    But, perhaps, will succed to build another GNU/Linux OSs or BSD OS variants.
 125
 126    * On windows, using MinGW is already okay, but not tested drawing.
 127
 128    * Cross building with GNU/Linux's MinGW32 and Qt5.5.1 (for MinGW) is available.
 129      Modify and use build-cmake/config_build_cross_win32.sh and related *.cmake files.
 130
 131    * And, you can also build with M$ Visual Studio 2013 or 2015.
 132
 133 b. Now, I using Qt5 as toolkit, because authors of Qt announced "Qt4 is obsolete, will be updated no longer".
 134
 135 c. All of virtual machines are already ported to Qt (On Oct 29, 2015).
 136
 137 d. Now using GCC-6.1 with Link Time Optimize to build for distrubuted binaries.
 138
 139 e. Implemented socket, networking for MZ-2500, but, not tested yet (；´Д｀)
 140
 141 Repositry:
 142
 143    https://github.com/Artanejp/common_source_project-fm7
 144
 145    https://osdn.net/projects/csp-qt/scm/git/common_source_project-fm7
 146
 147
 148 Project Page:
 149
 150    https://osdn.jp/projects/csp-qt/
 151
 152 Upstream (Takeda Toshiya San's original code):
 153
 154    http://takeda-toshiya.my.coocan.jp/
 155
 156 Special thanks to:
 157    Ryu Takegami-san, to assist debugging FM-7/77/AV/40/EX .
 158    Haserin-san, to assist debugging FM-7/77/AV/40/EX .
 159
 160 Changes:
 161
 162 * To see older changes, read ChangeLog and 000_gitlog.txt.
 163
 164 * SNAPSHOT July 13, 2018
 165   * Upstream 2018-05-24 .
 166   * [STATE] Apply new state save/load framework.See doc/a_new_state_save_load_framework.ja.txt (still only written in Japanese).
 167   * [STATE] Use CRC32 protection to data.
 168   * [STATE] Add header per devices.
 169   * [EMU/STATE] Enable to Gzip'ed state saving / loading.
 170   * [CONFIG/Bug] I forgot change top default of renderer. X-)
 171   * [VM/X1] Copy VRAMs to shadow data at starting a frame.Reduce flickering a lot.
 172   * [VM/PC9801] DISPLAY: Keep memory switch settings (saved to MEMSW.BIN).
 173   * [VM/I386] Remove compiler warning conversion float64 (a.k.a UINT64) <-> double.
 174               This still not regard when sizeof(double) != sizeof(UINT64).
 175   * [VM/FM7][SOUND/BEEP] Set samplerate to 6000Hz.Simplize logic.
 176   * [VM/DATAREC] Fix crash at removing CMT when not stopping to play.
 177   * [VM/DATAREC] Fix crash with MZT data.
 178   * [VM/NOISE] Adjust endian of WAV data.
 179   * [VM/NOISE] Fix infinity loop with corruptWAV data.
 180   * [VM/MC6809] Collect CPU statistics always, printing is controlled by menu immediately.
 181   * [VM/Z80] Add collecting cpu status feature for Z80.
 182   * [OSD/SOUND] Qt: Fix hang-up with resetting at some situations.
 183                 Try to fix issue of http://matsuri.5ch.net/test/read.cgi/i4004/1526806551/38 .
 184   * [COMMON] Fix buffer overflow around strncpy().
 185   * [COMMON] Add pair16_t and pair64_t.
 186   * [COMMON] Add immediate value functions for pair_t.
 187   * [COMMON][VM/Qt] Add common wav-loading / saving helper functions to common.cpp .
 188   * [COMMON] Update min() and max().
 189   * [FILEIO] Add FILEIO::Fflush().
 190   * [FMGEN/PSG] Fix weird noise generation for SSG/PSG.
 191   * [FMGEN/OPNBASE] Force to calculate frequency factors around prescaler when OPNBase::LoadState().
 192                     Fix wrong sound after loding state.
 193   * [FMGEN/OPNA] Fix infinity loop at loading rhythm WAVs.
 194   * [FMGEN/OPNA] Adjust endian of WAV data (maybe).
 195   * [Qt/OpenGL] Fix buffer overflow when changing VM's screen size.
 196   * [Qt/Bug] Remove using_flags->get_config_ptr()->foo.
 197   * [Qt/MAIN] LOGGER: Fix crash on exit.
 198   * [Qt/LOGGER] CSP_Logger makes daughter of QObject.Add messaging slot entry.
 199   * [Qt/LOGGER] Use QVector insterad of QQueue to reduce CPU usage.
 200   * [Qt/LOGGER] Bug: Logging all devices.
 201   * [Qt/OpenGLES] TRY: Reduce power consumption.
 202   * [Qt/OpenGL] Prepare to use OpenGL 4.x (CORE).
 203   * [Qt/OpenGLES] Prepare to use OpenGL ES 3.1.
 204   * [Qt/OpenGLES] Delete condition branch in shader, use #ifdef and const values.
 205   * [Qt/OpenGL] Re-Add screen rotate.
 206   * [BUILD/CMAKE] Add "USE_SANITIZER" and "USE_STACK_PROTECTOR" entries to buildvars_foo.dat[.tmpl]
 207                   to detect wrong usage of variables / protect from stack overflow.
 208   * [BUILD/CMAKE] FM7: Not build IO::, this is not used.
 209   * [Qt/WIN32] Move config and logger to inner pointer, now, libCSPavio is separated to single DLL.
 210   * [Qt/WIN32] Move CSP_Logger to libCSPemu_utils.[foo.so|dll] from libCSPgui.[foo.so|dll] .
 211   * [WIN32] Update cross build script.
 212   * Built with 9275209c6bed03ccd06716a486e29451c446751d or later.
 213
 214 -- July 13, 2018 13:09:15 +0900 K.Ohta <whatisthis.sowhat@gmail.com>
 215
 216 Upstream changes:
 217 * To see older upstream's changes, read history.txt.
 218
 219 5/24/2018
 220
 221 [COMMON] import Mr.Artane.'s fixes (Commits on May 10, 2018)
 222 [COMMON/FIFO] import Mr.Artane.'s fixes (Commits on May 10, 2018)
 223 [EMU] support set_vm_screen_lines() (thanks Mr.Artane.)
 224 [EMU] fix interfaces for bubble cassette
 225 [EMU] add interfaces for hard disk
 226 [WINMAIN] add interfaces for hard disk
 227
 228 [VM/DEVICE] support read_debug_reg()
 229 [VM/DISK] import Mr.Artane.'s fixes (Commits on May 10, 2018)
 230 [VM/HARDDISK] support hard disk handler
 231 [VM/I286] improve i286 core based on MAME 0.197
 232 [VM/I286] support read_debug_reg()
 233 [VM/I386] support read_debug_reg()
 234 [VM/I8237] fix verify command
 235 [VM/I8237] support to read bank register by read_signal()
 236 [VM/MC6809] import Mr.Artane.'s fixes (Commits on May 10, 2018)
 237 [VM/SCSI_DEV] support SASI specify command
 238 [VM/SCSI_HDD] improve to use hard disk handler
 239 [VM/SCSI_HOST] support to read ack signal
 240
 241 [BUBCOM80] support Systems Formulate BUBCOM80
 242 [FM77AV] import Mr.Artane.'s fixes (Commits on May 10, 2018)
 243 [FMR30] support to change hard disk image
 244 [FMR50] support to change hard disk image
 245 [FMR50/BIOS] improve to use hard disk handler
 246 [MZ2500] support to select floppy drive type 2DD/2D
 247 [MZ2500] support to change hard disk image
 248 [MZ2500/MZ1E30] reimplent SASI I/F with general SCSI host/hard disk device
 249 [PC9801/CPUREG] support NMI enable/disable
 250 [PC9801/MEMBUS] improve for 24bit/32bit address
 251 [PC9801/SASI] support SASI I/F and hard disk drives
 252 [X1TURBO/SASI] support SASI I/F and hard disk drives
 253
 254 -----
 255
 256
 257 Have fun!
 258 -- Ohta.
 259