OSDN Git Service

[DOC] Update documents and SOVERSIONs.
[csp-qt/common_source_project-fm7.git] / source / readme_by_artane.txt
1 ** Qt porting for Common Source Code Project **
2                                          December 18, 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_20181218
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 December 18, 2018
164   * Upstream 2018-12-09 .
165   * [VM/PC9801] Add pseudo SASI (HDD) BIOS for PC-9801.WIP.
166   * [VM/EVENT] Improve error message at cancel_event().
167   * [VM/HUC2680] Improve around timer.Thanks to  Ootake v2.83.
168   * [VM/PCENGINE] Improve process around NEC extended command (0xd*).
169   * [VM/PCENGINE] PCE_ADPCM: Fix not sound data length >= 65536 bytes.This still don't fix some softwares.i.e. Megami-Paradise.
170   * [VM/PCENGINE] Porting from Ootake v2.83.This still WORK-IN-PROGRESS.
171   * [VM/PCENGINE] CDROM: Don't reset ADPCM more than once at CDROM makes "NOT BUSY".
172   * [VM/PCENGINE] Most of CD-ROM^2 softwares maybe work.Excepts LASERSOFT's products and using "ARCADE card".
173   * [VM/SCSI_CDROM] Add write_signal() to control CDDA from MACHINE.
174   * [VM/SCSI_CDROM] Fix CD-DA buffer handling.Reading buffer should be per 2352 bytes.
175   * [VM/SCSI_CDROM] CUE: More correctness cue parsing.
176   * [VM/SCSI_CDROM] CUE: Set default pre-gap to 2Sec (150frames).Fix audio problems of most softwares.Maybe fixed issues on Manhole.
177   * [VM/SCSI_CDROM] More correctness SEEK/Interrupt timing.
178   * [VM/FM7] DISPLAY: Fix for logging "[EVENT] EVENT: device (name=DISPLAY SUBSYSTEM, id=25) tries to cancel event 6 that is not its own (owned by (name=PRINTER I/F id=20))!!!"
179   * [Draw/Qt] OpenGL: Abondon depth test.
180   * [UI/Qt] OOPS: Fix OOPs around mounting virtual D88/D77 image(s).
181   * [UI/MENU] HARDDISK: OOPS: I missed update directory.
182   * [UI/MENU] Fix oops dialog of opening virtual HDD.
183   * Built with ee880845ec85aa431df3c7a937611e9c20dd591d (or later).
184   
185 -- December 18, 2018 16:31:55 +0900 K.Ohta <whatisthis.sowhat@gmail.com>
186
187 本家の変更:
188 * 前の変更点をお読みになる場合には、history.txtをお読み下さい。
189
190 12/9/2018
191
192 [VM/SCSI_CDROM] add vendor specific command for NEC CD-ROM^2
193
194 [PC8801/PC88] support CD-ROM drive (thanks M88/cdif)
195 [PC8801/PC88] support Video Art Boad (thanks X88000)
196
197
198 12/5/2018
199
200 [VM/MB8877] improve reset() to finish previous command and reset fdc completely
201 [VM/Z80] add read_signal() to read irq status
202
203 [PC8801/PC88] improve to render scan line with black if color graphic mode
204 [SMC70/MEMORY] support 640x400 and 160x100 graphic mode
205 [SMC777/MEMORY] fix issue that text blink is not working
206 [SMC777/MEMORY] improve inport 21h to read vsync irq status
207 [SMC777/MEMORY] improve inport 51h to read cursor and space keys as joystick #1
208 [VM/*] improve tape interfaces for each virtual machine
209
210
211 12/4/2018
212
213 [CONFIG] remove fmgen_dll_path and add mame2151_dll_path/mame2608_dll_path
214
215 [VM/YM2203] remove HAS_YM2608 and YM2203_PORT_MODE to simplify code
216
217 [PC8801] support HMB-20 sound board
218
219
220 12/2/2018-2
221
222 [PC8801/PC88] fix text/graph renderer again (thanks Mr.Bookworm)
223
224
225 12/2/2018
226
227 [PC8801/PC88] fix not to apply reverse attribute to monochrome graphic screen
228
229
230 12/1/2018
231
232 [PC8801] enable/disable drawing scan line when monitor type is hireso/standard
233 [PC8801/PC88] improve text attributes/rederer (thanks ePC-8801MA\89ü)
234 [PC8801/PC88] fix analog back color
235 [PC8801/PC88] improve routine to change palette for each scan line
236
237
238 11/28/2018
239
240 [WIN32/INPUT] support joystick with multiple axes and hat key
241 [WIN32/INPUT] improve joystick to keyboard function for numpad key 5
242
243
244 11/27/2018
245
246 [WIN32/INPUT] support joystick to keyboard function
247 [WIN32/SCREEN] support Window x1.5 mode
248
249 [PC8801/PC88] support PC key, that is mapped to F11
250
251 -----
252
253 お楽しみあれ!
254 -- Ohta.