OSDN Git Service

[VM][FMTOWNS][SPRITE][WIP] Implementing sprite.
[csp-qt/common_source_project-fm7.git] / source / readme_by_artane.txt
1 ** Qt porting for Common Source Code Project **
2                                          August 07, 2018
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_20180807
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 Changes:
158
159 * 前の変更点をお読みになる場合には、ChangeLogと000_gitlog.txtをお読み下さい。
160
161 * SNAPSHOT August 07, 2018
162   * Upstream 2018-05-24 .
163   * [VM] Use VM_TEMPLATE, META-Class of VM::
164   * [VM/FM7] Clear OPN/WHG/THG interrupt on resetting. Fix freeze when resetting after using RELICS.
165   * [VM/FM7] DISPLAY: Not use CLR_HACK for MC6809 and delay using CLR to set busy flag.May be working MAGUS.Thanks to Anna_Wu.
166   * [VM/MC6809] Remove dirty CLR insn hack.
167   * [VM/DEVICE] Add DEVICE:: to libCSPcommon_vm.
168   * [COMMON/Qt] Fix BYTEORDER of PIXEL@RGB888.
169   * [UI/Qt][BUG] Fix crash with using LaserDisc(s).
170   * [Qt/OpenGL] Initial support of OpenGL 4.3 Core profile.
171   * [Qt/OpenGL] OpenGL 4.3 : Upload SCREEN using glMapBuffer().
172   * [Qt/OpenGL] Use template class instead of GL2.0.
173   * [UI/Qt] Separate some command line parsing to sub-routines.
174   * [BUILD/WIN32] Update toolchain to Qt5.11.1.
175   * [BUILD] Set SOVERSION and GIT hash automatically.
176   * Built with df3888ca1199c6f75c1500dbb479d152ba6e2ad0 (or later).
177
178 -- August 07, 2018 03:58:14 +0900 K.Ohta <whatisthis.sowhat@gmail.com>
179
180 本家の変更:
181 * 前の変更点をお読みになる場合には、history.txtをお読み下さい。
182
183 5/24/2018
184
185 [COMMON] import Mr.Artane.'s fixes (Commits on May 10, 2018)
186 [COMMON/FIFO] import Mr.Artane.'s fixes (Commits on May 10, 2018)
187 [EMU] support set_vm_screen_lines() (thanks Mr.Artane.)
188 [EMU] fix interfaces for bubble cassette
189 [EMU] add interfaces for hard disk
190 [WINMAIN] add interfaces for hard disk
191
192 [VM/DEVICE] support read_debug_reg()
193 [VM/DISK] import Mr.Artane.'s fixes (Commits on May 10, 2018)
194 [VM/HARDDISK] support hard disk handler
195 [VM/I286] improve i286 core based on MAME 0.197
196 [VM/I286] support read_debug_reg()
197 [VM/I386] support read_debug_reg()
198 [VM/I8237] fix verify command
199 [VM/I8237] support to read bank register by read_signal()
200 [VM/MC6809] import Mr.Artane.'s fixes (Commits on May 10, 2018)
201 [VM/SCSI_DEV] support SASI specify command
202 [VM/SCSI_HDD] improve to use hard disk handler
203 [VM/SCSI_HOST] support to read ack signal
204
205 [BUBCOM80] support Systems Formulate BUBCOM80
206 [FM77AV] import Mr.Artane.'s fixes (Commits on May 10, 2018)
207 [FMR30] support to change hard disk image
208 [FMR50] support to change hard disk image
209 [FMR50/BIOS] improve to use hard disk handler
210 [MZ2500] support to select floppy drive type 2DD/2D
211 [MZ2500] support to change hard disk image
212 [MZ2500/MZ1E30] reimplent SASI I/F with general SCSI host/hard disk device
213 [PC9801/CPUREG] support NMI enable/disable
214 [PC9801/MEMBUS] improve for 24bit/32bit address
215 [PC9801/SASI] support SASI I/F and hard disk drives
216 [X1TURBO/SASI] support SASI I/F and hard disk drives
217
218 -----
219
220 お楽しみあれ!
221 -- Ohta.