source/readme_by_artane.txt

   1 ** Qt porting for Common Source Code Project **
   2                                          October 15, 2019
   3               K.Ohta <whatisthis.sowhat _at_ gmail.com>
   4
   5 * If you can't read Japanese, read readme.qt.txt .
   6
   7 0. 概要
   8    このパッケージは、Common Source Code Project (以下、CSP)
   9    をQt5に移植したものです。
  10    バイナリはGNU/Linux(64bit)用とMinGW (32bit Windows)用を
  11    用意しています。
  12
  13    ソースコード：
  14
  15      https://github.com/Artanejp/common_source_project-fm7/releases/tag/SNAPSHOT_20191015
  16
  17    追加情報:
  18
  19     　各機種バイナリーは、osdn.net　もしくはミラーサイトより入手可能です。
  20
  21    　https://osdn.net/projects/csp-qt/
  22
  23      https://osdn.net/projects/csp-qt/releases/　をチェックしてください。
  24
  25 　   Win32:
  26
  27   　 GNU/Linux(amd64) :
  28
  29 【おねがい】
  30      　doc/以下の文書で日本語しかなかったものを英語に翻訳していますが、機械翻訳を使ってるのであやしいです。
  31
  32        英語の上手い方、校正などお願いします m(_ _)m
  33
  34 1. 背景
  35
  36    CSPは、非常に優れた構造のエミュレータです（しかし、些か重くてコンパイラ
  37    がいい最適化をしないと重めですが）。
  38    しかし、このコードはM$ Visual C++依存の部分が非常に多いです。
  39    そこで、GNU/Linuxでこれを動かすためにQtに色々と移植していきましょう。
  40    と言う感じで作業をはじめました。
  41
  42 2. 最低限必要なもの(Qt版)
  43
  44    a. Qt5 ツールキット。Qt 5.5以降を推奨します。
  45
  46    b. OpenGL, 多分、最低OpenGL 2.1は必要です。（注：ひょっとしたら、OpenGLES2以降ならば動くように変えるかも知れない）
  47
  48    c. gcc / g++ (5.0以降？)もしくは llvm clang / clang++ (3.5以降?)
  49       コンパイラツールチェーン。
  50
  51    d. SDL2 (SDL 1.xではないので注意)
  52
  53    e. CMake 2.8以降。
  54
  55    f. ffmpegから、libavとlibswが必要です。 http://ffmpeg.org/ より。
  56
  57    g. ffmpegは、Windowsに関してはバンドルしてありますので、動かない時はインストールしてみてください。
  58
  59    h. Qt5.5(Ubuntu 16.04LTS向け)もしくはQt5.10(Win32とDebian GNU/Linux sid向け)でビルドしてあります。
  60
  61    i. 表示基盤のデフォルトが、OpenGL ES2.0になりました。コマンドラインオプション --opengl で変更が可能です(--helpで参照)
  62
  63    j. Windows のビルドを、Docker環境上のLLVM CLANG (9) にしました。例外処理に関して、MinGW-w64のgccは非常に遅い方法を取ってるためです（Borlandが悪いのですが）。
  64      詳細は、 https://github.com/Artanejp/llvm-mingw と https://hub.docker.com/r/artanejp/llvm-mingw64-ubuntu-cosmic を参照して下さい。
  65
  66    * Windows もしくは GNU/Linux のcross tool chain (要Wine)で、MinGW (gcc6) と Qt 5.10 でのビルドができることを確認しました。
  67
  68    * TIPS:
  69
  70      * Windows等で動かした時に、画面の書き替えが表示されない場合は、環境変数 QT_OPENGL を software にしてみてください。（例えば、
  71        WindowsをVirtualBoxのゲストで使ってる場合など）
  72
  73      * Windows版バイナリには、ソフトウェアレンダリングのopengl32.dllが添付されてますが、最近のパソコンの専用GPUドライバなら、
  74        もっと程度のいいOpenGLが入ってるはずです。
  75        添付版opengl32.dllを適当な名前に変更して動くかどうか試してみて下さい。
  76
  77 3. ビルドの方法
  78
  79    ソースコードを解凍するか、git clone / pull した後で:
  80
  81    $ cd {srctop}/source/build-cmake/{Machine name}/
  82    $ mkdir build
  83    $ cd build
  84
  85    To configure:
  86
  87    $ cmake ..
  88
  89    or
  90
  91    $ ccmake ..
  92
  93    To build:
  94
  95    $ make
  96
  97    To install:
  98
  99    $ sudo make install
 100
 101 4. Qt固有の話
 102
 103    * 設定ファイル(scancode.cfg と foo.ini)は、"~/.config/CommonSourceCodeProject/emufoo/" (Windowsの場合は".\CommonSourceCodeProject\emudfoo\" ) におかれます（移動しました）。
 104
 105    * BIOSや効果音WAVやセーブステートは、、"~/CommonSourceCodeProject/emufoo/" (Windowsの場合は".\CommonSourceCodeProject\emudfoo\" ) におかれます（移動しました）。
 106
 107    * 全ての記録物(スクリーンショットや動画や録音WAV）は、*当面の間* "~/CommonSourceCodeProject/emufoo/" (Windowsの場合は".\CommonSourceCodeProject\emudfoo\" ) におかれます。
 108
 109    * ToolTipsを付けました。(2017-01-24)
 110
 111    * 日本語に翻訳しました。(2017-01-24)
 112
 113
 114    * キーコード変換テーブルファイルが、$HOME/.config/CommonSourceCodeProject/emu{Machine Name}/scancode.cfg に書き込まれます。
 115
 116      書式は、カンマで区切られた16進データです(10進ではないので注意) .
 117
 118      1カラム目はM$ ヴァーチャルキーコード。
 119
 120      2カラム目はQtネィティブのスキャンキーコードです。
 121
 122    * UI部分の共通コンポーネント (src/qt/gui) を共有ライブラリlibCSPgui.soにまとめました。
 123
 124    * インストール用のBASHスクリプトを用意しました。src/tool/installer_unix.shです。
 125
 126    * ROMと同じところに、特定のWAVファイル(VMによって異なる)を入れると、FDDのシーク音やテープのボタン音・リレー音を鳴らすことが出来ます。
 127
 128    * ローマ字カタカナ変換支援機構が一部の機種に実装されてます。romaji_kana.ja.txt をお読みください。
 129
 130 5. 移植状況
 131
 132    a.現在、Debian GNU/Linux "sid"と、Ubuntu Linux 16.04LTS "Xenial"
 133      の AMD64版でしかテストしていません。
 134    　が、多分他のGNU/Linux OSやBSD系のOS (Mac含む) でもビルドすれば
 135    　動くでしょう。
 136      Windows もしくは GNU/Linux(要Wineとbinfmt-support)上でのMinGWと
 137      Qt community edition でのビルドが通るようになりました。
 138
 139    b. 今は、Qtの開発側が「Qt4おわりね」とアナウンスしたので、Qt4ではなく
 140       Qt5を使っています。
 141       添付してあるバイナリは、Qt 5.5でビルドしました(が、Qt 5.1以降なら動くはずです)。
 142
 143    c. Linux用ビルドでは、GCCをリンク時最適化(LTO)モードで使っています。
 144    d. MZ-2500のソケット機能を実装してみていますが、マトモにテストできてません(；´Д｀)
 145
 146 6. Upstream repositry:
 147       https://github.com/Artanejp/common_source_project-fm7
 148
 149       https://osdn.net/projects/csp-qt/scm/git/common_source_project-fm7
 150
 151 7. Project Page:
 152       https://osdn.jp/projects/csp-qt/
 153
 154 8. Upstream (Takeda Toshiyaさんのオリジナル)
 155       http://takeda-toshiya.my.coocan.jp/
 156
 157
 158 Special thanks to:
 159   Ryu Takegamiさん     : eFM-8/7/77/AV/40/EX のデバッグに協力していただいています。
 160   はせりんさん         : eFM-8/7/77/AV/40/EX のデバッグに協力していただいています。
 161   Ootake 開発者の皆さん: ePCENGINEの改善のヒントをソースコードから勉強させていただいてます。
 162
 163 Changes:
 164
 165 * 前の変更点をお読みになる場合には、ChangeLogと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 本家の変更:
 218 * 前の変更点をお読みになる場合には、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 -- Ohta.