source/readme_by_artane.txt

   1 ** Qt porting for Common Source Code Project **
   2                                          August 16, 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_20190816
  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    * Windows もしくは GNU/Linux のcross tool chain (要Wine)で、MinGW (gcc6) と Qt 5.10 でのビルドができることを確認しました。
  64    * TIPS:
  65
  66      * Windows等で動かした時に、画面の書き替えが表示されない場合は、環境変数 QT_OPENGL を software にしてみてください。（例えば、
  67        WindowsをVirtualBoxのゲストで使ってる場合など）
  68
  69      * Windows版バイナリには、ソフトウェアレンダリングのopengl32.dllが添付されてますが、最近のパソコンの専用GPUドライバなら、
  70        もっと程度のいいOpenGLが入ってるはずです。
  71        添付版opengl32.dllを適当な名前に変更して動くかどうか試してみて下さい。
  72
  73 3. ビルドの方法
  74
  75    ソースコードを解凍するか、git clone / pull した後で:
  76
  77    $ cd {srctop}/source/build-cmake/{Machine name}/
  78    $ mkdir build
  79    $ cd build
  80
  81    To configure:
  82
  83    $ cmake ..
  84
  85    or
  86
  87    $ ccmake ..
  88
  89    To build:
  90
  91    $ make
  92
  93    To install:
  94
  95    $ sudo make install
  96
  97 4. Qt固有の話
  98
  99    * 設定ファイル(scancode.cfg と foo.ini)は、"~/.config/CommonSourceCodeProject/emufoo/" (Windowsの場合は".\CommonSourceCodeProject\emudfoo\" ) におかれます（移動しました）。
 100
 101    * BIOSや効果音WAVやセーブステートは、、"~/CommonSourceCodeProject/emufoo/" (Windowsの場合は".\CommonSourceCodeProject\emudfoo\" ) におかれます（移動しました）。
 102
 103    * 全ての記録物(スクリーンショットや動画や録音WAV）は、*当面の間* "~/CommonSourceCodeProject/emufoo/" (Windowsの場合は".\CommonSourceCodeProject\emudfoo\" ) におかれます。
 104
 105    * ToolTipsを付けました。(2017-01-24)
 106
 107    * 日本語に翻訳しました。(2017-01-24)
 108
 109
 110    * キーコード変換テーブルファイルが、$HOME/.config/CommonSourceCodeProject/emu{Machine Name}/scancode.cfg に書き込まれます。
 111
 112      書式は、カンマで区切られた16進データです(10進ではないので注意) .
 113
 114      1カラム目はM$ ヴァーチャルキーコード。
 115
 116      2カラム目はQtネィティブのスキャンキーコードです。
 117
 118    * UI部分の共通コンポーネント (src/qt/gui) を共有ライブラリlibCSPgui.soにまとめました。
 119
 120    * インストール用のBASHスクリプトを用意しました。src/tool/installer_unix.shです。
 121
 122    * ROMと同じところに、特定のWAVファイル(VMによって異なる)を入れると、FDDのシーク音やテープのボタン音・リレー音を鳴らすことが出来ます。
 123
 124    * ローマ字カタカナ変換支援機構が一部の機種に実装されてます。romaji_kana.ja.txt をお読みください。
 125
 126 5. 移植状況
 127
 128    a.現在、Debian GNU/Linux "sid"と、Ubuntu Linux 16.04LTS "Xenial"
 129      の AMD64版でしかテストしていません。
 130    　が、多分他のGNU/Linux OSやBSD系のOS (Mac含む) でもビルドすれば
 131    　動くでしょう。
 132      Windows もしくは GNU/Linux(要Wineとbinfmt-support)上でのMinGWと
 133      Qt community edition でのビルドが通るようになりました。
 134
 135    b. 今は、Qtの開発側が「Qt4おわりね」とアナウンスしたので、Qt4ではなく
 136       Qt5を使っています。
 137       添付してあるバイナリは、Qt 5.5でビルドしました(が、Qt 5.1以降なら動くはずです)。
 138
 139    c. Linux用ビルドでは、GCCをリンク時最適化(LTO)モードで使っています。
 140    d. MZ-2500のソケット機能を実装してみていますが、マトモにテストできてません(；´Д｀)
 141
 142 6. Upstream repositry:
 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 7. Project Page:
 148       https://osdn.jp/projects/csp-qt/
 149
 150 8. Upstream (Takeda Toshiyaさんのオリジナル)
 151       http://takeda-toshiya.my.coocan.jp/
 152
 153
 154 Special thanks to:
 155   Ryu Takegamiさん     : eFM-8/7/77/AV/40/EX のデバッグに協力していただいています。
 156   はせりんさん         : eFM-8/7/77/AV/40/EX のデバッグに協力していただいています。
 157   Ootake 開発者の皆さん: ePCENGINEの改善のヒントをソースコードから勉強させていただいてます。
 158
 159 Changes:
 160
 161 * 前の変更点をお読みになる場合には、ChangeLogと000_gitlog.txtをお読み下さい。
 162
 163 * SNAPSHOT Aug 16, 2019
 164   * Upstream 2019-04-30.
 165   * 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.
 166   * [UI/Qt] DEBUGGER: Add history for debugger command line.
 167   * [UI/Qt] DEBUGGER: Add auto-completion for command-line.
 168   * [VM/DEVICE] Use __FASTCALL with interfaces, read_*() ,write_*(), fetch_op() and some functions.Make this faster emulation (i.e.PC-9801RA and EMM386 under FreeDOS).
 169   * [VM/PC9801] Separate EGC functions.
 170   * [VM/PC9801] Add V30@8.0MHz with some I286/I386 machines.
 171   * [VM/PC9801] Check differnt of system work area (0000:0400-0000:05FF) both mame(pc9801rs) and emupc9801ra .
 172   * [VM/PC9801] Add "UPPER_I386" flag for detect using later than HAS_I386.
 173   * [VM/PC9801] CPUREG: (Maybe) improve changing cpu sequence around I/O 00F0h.
 174   * [VM/PC9801] CPUREG: Redirect interrupt signal via CPUREG:: .VMs with V30 sub CPU (i.e.PC9801RA) work with V30.
 175   * [VM/PC9801] Fix wrong initialize SYS_PORT_B.
 176   * [VM/PC9801] Fix wrong initialize memory switch.
 177   * [VM/PC9801] Add DIPSWITCH object.
 178   * [VM/PC9801] Fix different value at [0000:0501].
 179   * [VM/PC9801] MEMBUS: Split update_bios() to functions.
 180   * [VM/FP1100] Fix lacking some key symbols.Thanks to https://matsuri.5ch.net/test/read.cgi/i4004/1526806551/540 .
 181   * [VM/AY_3_891X] Fix not supported defines, replace flags.
 182   * [VM/AY_3_891X] Add feature ; dump/set register via debugger.
 183   * [VM/YM2151] Add feature ; dump/set register via debugger.
 184   * [VM/YM2203] Add feature ; dump/set register via debugger.
 185   * [VM/SN74689AN] Add feature ; dump/set register via debugger.
 186   * [VM/BEEP] Add feature ; dump register via debugger.
 187   * [VM/PCM1BIT] Add feature ; dump register via debugger.
 188   * [VM/I80x86/V30] Start debugger even halting.
 189   * [VM/I80x86/8088/V30] Make i86/186/88/286 and V30 to common_vm.
 190   * [VM/I386] Fix WRONG flag mask at LMSW.
 191   * [VM/I386] MOV CR0 EyX : Fix wrong flags handling.
 192   * [VM/I386] Exitable when falling into infinite TRAP-Loop.
 193   * [VM/I386] mov CRx,R32/mov r32,CRx : Adjusting.
 194   * [VM/i8259] Add PIC HACKing flag for PC9801.
 195   * [VM/uPD7810/uPD7907] PC2001: Include uPD7810 variants and uPD7907 to libCSP_common_VM.
 196   * [VM/MB8877] Fix buffer overflow with logging.
 197   * [VM/Z80DMA] TODO/WIP: Workaround for https://tablacus.github.io/LSX-Dodgers/ .This still be not resolved issue.
 198   * [VM/EVENT] Add remove_context_cpu().This may not effect to MAIN_CPU(id==0).
 199   * [DOC/FM7] Fix typo (*ﾉω・*)てへぺろ
 200   * [Qt/LOGGER] Improve locking.
 201   * [UI/Qt] OOPs: Fix LACK of DATARECORDER BUTTONS(abolish of USE_TAPE_BUTTON): Lack of merging UPSTREAM 2018/10/07.
 202   * [UI/Qt] MENU: Split some methods (of Ui_MainMenuBase::) to menu_emulator.cpp and menu_machine.cpp .
 203   * [UI/Qt] MENU: Simplify menu creation.
 204   * [CONFIG/Qt] Fix bit order of logging configure.
 205   * [BUILD/CMAKE] Add CPU affinity mask when compiling.This may work only with GNU/Linux host.
 206   * [BUILD/CMAKE] Improve build message with finished.
 207   * [BUILD/MINGW] Update optimize parameter.
 208   * [BUILD] Separate definitions of archtecture flags.
 209   * [BUILD] Add ARM32/64 definitions (initial).Still not testing.
 210   * Built with 0810a8f8b9ba44cedc19bf6b8e903c9c1b5d6f04 (or later).
 211
 212 -- Aug 16, 2019 20:38:06 +0900 K.Ohta <whatisthis.sowhat@gmail.com>
 213
 214 本家の変更:
 215 * 前の変更点をお読みになる場合には、history.txtをお読み下さい。
 216
 217 4/30/2019
 218
 219 [VM/DEVICE] add is_primary_cpu() and update_extra_event()
 220 [VM/EVENT] support to udpate event while cpu is running one opecode
 221 [VM/I8259] fix reading isr register (thanks Mr.rednow)
 222 [VM/SCSI_HOST] fix to raise irq at command/message phase
 223 [VM/Z80] improve to update event in every read/write cycle
 224
 225 [CEFUCOM21] support Hino Electronics CEFUCOM-21 (not work)
 226 [MZ2500/CRTC] apply crtc patch (thanks Mr.Koucha-Youkan)
 227 [PC8801MA] improve to enable/disable cmdsing and pcg
 228 [PC8801MA] improve to enable/disable changing palette for each scan line
 229
 230 -----
 231
 232 お楽しみあれ!
 233 -- Ohta.