source/RELEASENOTE.txt

   1 ** Qt porting and FM-7/77/AV/AV40/EX for Common Source Code Project **
   2
   3                                                        October 15, 2019
   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_20191015
  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 j. Now for Win32 build, using LLVM CLANG cross toolchains on Docker environment.Because exception handling of MinGW-w64's gcc is very slowly (this cause by *evil* Borland).
  56   See https://github.com/Artanejp/llvm-mingw and https://hub.docker.com/r/artanejp/llvm-mingw64-ubuntu-cosmic for datails.
  57
  58 * 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).
  59
  60 3.How to build:
  61
  62 After extracting (or git pulled) sourcecodes:
  63
  64 $ cd {srctop}/source/build-cmake/{Machine name}/
  65
  66 $ mkdir build
  67
  68 $ cd build
  69
  70 To configure:
  71
  72 $ cmake ..
  73
  74 or
  75
  76 $ ccmake ..
  77
  78 To build:
  79
  80 $ make
  81
  82 To install:
  83
  84 $ sudo make install
  85
  86 4.Qt specified notice:
  87
  88    ・Config file (scancode.cfg and foo.ini) has placed (moved) to
  89      "~/.config/CommonSourceCodeProject/emufoo/"
  90      (for Windows, ".\CommonSourceCodeProject\emudfoo\" ).
  91
  92    ・BIOS, WAVS, BINS and SAVED STATES have placed (moved) to
  93      "~/CommonSourceCodeProject/emufoo/"
  94      (for Windows, ".\CommonSourceCodeProject\emudfoo\" ).
  95
  96    ・All of recorded products (PNG Screenshots, MOVIES, SOUNDS)
  97      have *temporally* written to "~/.config/CommonSourceCodeProject/emufoo/"
  98      (for Windows, ".\CommonSourceCodeProject\emudfoo\" ).
  99
 100    ・Added ToolTips and Japanese translations.(2017-01-24)
 101
 102    ・Place R@Ms under $HOME/CommonSourceCodeProject/emu{Machine Name}/ , this directory has made
 103      after first using.
 104
 105    ・Config file, {foo}.ini is written on $HOME/.config/CommonSourceCodeProject/emu{Machine Name}/ .
 106
 107    ・Saved state file, {foo}.sta is written on $HOME/CommonSourceCodeProject/emu{Machine Name}/ .
 108
 109    ・Key code conversion file is written on $HOME/.config/CommonSourceCodeProject/emu{Machine Name}/scancode.cfg .
 110
 111      This file contains comma separated fields, written at hex-decimal (not decimal),
 112        first is M$ Virtual Key Code,
 113        second is Qt's scan code.
 114
 115    ・Common UI components (at src/qt/gui ) are moved to shared lib. libCSPgui.so .
 116
 117    ・Installer (bash) script is available now; src/tool/installer_unix.sh .
 118
 119    ・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.
 120
 121 5.Status
 122
 123 a. I tested to build only under Debian GNU/Linux "sid",Ubuntu Linux 16.04LTS "Xenial" for AMD64 (x86_64)
 124 and MinGW with GCC6 (Windows 32bit).
 125
 126    But, perhaps, will succed to build another GNU/Linux OSs or BSD OS variants.
 127
 128    * On windows, using MinGW is already okay, but not tested drawing.
 129
 130    * Cross building with GNU/Linux's MinGW32 and Qt5.5.1 (for MinGW) is available.
 131      Modify and use build-cmake/config_build_cross_win32.sh and related *.cmake files.
 132
 133    * And, you can also build with M$ Visual Studio 2013 or 2015.
 134
 135 b. Now, I using Qt5 as toolkit, because authors of Qt announced "Qt4 is obsolete, will be updated no longer".
 136
 137 c. All of virtual machines are already ported to Qt (On Oct 29, 2015).
 138
 139 d. Now using GCC-6.1 with Link Time Optimize to build for distrubuted binaries.
 140
 141 e. Implemented socket, networking for MZ-2500, but, not tested yet (；´Д｀)
 142
 143 Repositry:
 144
 145    https://github.com/Artanejp/common_source_project-fm7
 146
 147    https://osdn.net/projects/csp-qt/scm/git/common_source_project-fm7
 148
 149
 150 Project Page:
 151
 152    https://osdn.jp/projects/csp-qt/
 153
 154 Upstream (Takeda Toshiya San's original code):
 155
 156    http://takeda-toshiya.my.coocan.jp/
 157
 158 Special thanks to:
 159    Ryu Takegami-san, to assist debugging FM-7/77/AV/40/EX .
 160    Haserin-san, to assist debugging FM-7/77/AV/40/EX .
 161    Developers of Ootake, give hints of emuPCEngine (from source code).
 162
 163 Changes:
 164
 165 * To see older changes, read ChangeLog and 000_gitlog.txt.
 166
 167 * SNAPSHOT Oct 15, 2019
 168   * Upstream 2019-04-30.
 169   * This is point release, still exists some issues (i.e.EMM386(NEC/PC98) and FreeBSD(98) don't work) for PC-9801 and PC-Engine and some VMs, will fix them.
 170   * [Tools] Add DUMP LIST CHECKER.
 171   * [BUILD/Win32] Build with LLVM CLANG (for MinGW-w64).Because GCC for MinGW-w64/Win32 has very slow exception handling (due to Borland's patent).
 172   * [BUILD/Win32] See https://github.com/Artanejp/llvm-mingw and https://hub.docker.com/r/artanejp/llvm-mingw64-ubuntu-cosmic for datails.
 173   * [BUILD/Win32] Build against FFMpeg 4.2.
 174   * [FM7/SOUND] Fix reading value of PSG register(s).Fix sound of FM-7's demonstration with FM-7/77 (not with 77AV variants).
 175   * [FM7/SOUND] Separate reset sequence for OPN/WHG/THG/PSG to a common function.
 176   * [VM/FM7] Replace printf debug messages to out_debug_log().
 177   * [VM/FAMILYBASIC] WIP: Fix wrong string for romaji-kana (and auto key).Still imcoplete, implementing DAKUION,will fix.
 178   * [VM/PC9801] CPUREG: V30 SUB CPU works.
 179   * [VM/PC9801] Re-define DIPSW, to work with V30@PC-9801RA.
 180   * [VM/PC8801] Fix double install DEBUGGER:: for OPN#1,#2.Thanks to https://matsuri.5ch.net/test/read.cgi/i4004/1526806551/598 .
 181   * [VM/MC6809] Fix duplicate signal; SIG_CPU_HALT.
 182   * [VM/DEBUGGER] Fix FTBFSs with LLVM CLANG.
 183   * [VM/AY_3_891X] Fix pop noise when enabling lpf or hpf.
 184   * [VM/Z80DMA] OOPS: Disable debug spam.
 185   * [VM/Ix86] More correctness wait.
 186   * [VM/Ix86] Implement wait by memory-wait-factor.
 187   * [VM/Ix86] Add SIG_CPU_HALTREQ.
 188   * [VM/I386][VM/V30] Fix cloick handling when BUSREQ/HALT.
 189   * [VM/I8259] PC9801: Fix crash when changing V30 Sub CPU <-> i286/i386 Main CPU.
 190   * [VM/EVENT] Update comment of scheduler (EVENT::drive()).
 191   * [EMU/ROMAJI_KANA] Some characters are enabled to input via ROMAJI-KANA conversion.
 192   * [EMU/AUTOKEY]  Some characters are enabled to input via pasting from clipboard.This using UCS-4(aka UTF-32) internal format.
 193   * [Qt/OpenGL] Don't makeCurrent()/doneCurrent() inside of resizeGL().Fixed crash running within Docker container.
 194   * [UI/Qt] ROMAJI_KANA: Some characters input from KANA mode (by host) are enabled.
 195   * [UI/Qt] VM: Add keycode - vk - name table listing features.See vm/fm7/keyboard.cpp and qt/osd_base.h and gui/dialog_set_key.cpp.
 196   * [Qt/LOGGER] Threaded console logging.
 197   * [Qt/AVIO] Update FFMPEG's API: Revoke to use functions marked as deprecate.
 198   * [Qt/AVIO] Drop to use deprecated functions for FFMpeg 4.x.
 199   * [Qt/AVIO] Add some codec entries (still not implement).
 200   * [OSD/Qt] Update sound APIs: for sound sampling.Still be imcomplete.Will implement.
 201   * [OSD/SOUND] Simplify sound callback for SDL.
 202   * [OSD/SOUND] SDL: Convert sound rate/bitwidth.
 203   * [OSD/General] Fix not reply version of libvCSPosd.Display OSD version at "about this software".
 204   * [QT/MOVIE_LOADER] Fix weird initilaizing memory.
 205   * [Qt/MOVIE_SAVER] CONFIG: Some functions make dllexport.
 206   * [Qt/HOMEBREW] Fix not detected SDL at configuration of Qt::Gamepad.
 207   * [Qt/JOY_THREAD] Fix memory leak when plug/unplug joystick.
 208   * [UI/Qt] Add font selection to debugger and log view dialogs.
 209   * [UI/Qt] AUTO_KEY: Copy and paste: Paste even Zenkaku KATAKANA/HIRAGNA/ASCII to VM (converted to Hankaku letters).
 210   * [Qt/CONFIG] Keep font metrics and window size of debugger and log viewer.Save to foo.ini file.
 211   * [Qt/OpenGL] GLES: Fix texture format for float/half float.May work "TV RENDERER" with Win32 build (via ANGLE).
 212   * [Qt/OpenGL] Use half float texture for float textures to reduce GPU usage.
 213   * Built with 74c7914381802640510c76f176b3c3ffeceb678d (or later).
 214
 215 -- Oct 15, 2019 02:40:49 +0900 K.Ohta <whatisthis.sowhat@gmail.com>
 216
 217 Upstream changes:
 218 * To see older upstream's changes, read history.txt.
 219
 220 4/30/2019
 221
 222 [VM/DEVICE] add is_primary_cpu() and update_extra_event()
 223 [VM/EVENT] support to udpate event while cpu is running one opecode
 224 [VM/I8259] fix reading isr register (thanks Mr.rednow)
 225 [VM/SCSI_HOST] fix to raise irq at command/message phase
 226 [VM/Z80] improve to update event in every read/write cycle
 227
 228 [CEFUCOM21] support Hino Electronics CEFUCOM-21 (not work)
 229 [MZ2500/CRTC] apply crtc patch (thanks Mr.Koucha-Youkan)
 230 [PC8801MA] improve to enable/disable cmdsing and pcg
 231 [PC8801MA] improve to enable/disable changing palette for each scan line
 232
 233 -----
 234
 235
 236 Have fun!
 237 -- Ohta.
 238