OSDN Git Service

[DOC] Update documents.
[csp-qt/common_source_project-fm7.git] / source / readme_by_artane.txt
1 ** Qt porting for Common Source Code Project **
2                                           Mar 17, 2017
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_20170517
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は必要です。 (New!)
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は、それぞれのランタイムに必要なものをバンドルしてありますので、動かない時はインストールしてみてください。
58       
59    h. GNU/Linuxビルドでは、Qt5.5(Ubuntu 16.04LTS向け)もしくはQt5.7(Debian GNU/Linux sid向け)でビルドしてあります。
60    
61    * Windows もしくは GNU/Linux のcross tool chain (要Wine)で、MinGW (gcc6) と Qt 5.7 でのビルドができることを確認しました。
62      
63    * TIPS:
64    
65      Windows等で動かした時に、画面の書き替えが表示されない場合は、
66      
67      環境変数 QT_OPENGL を software にしてみてください。(例えば、
68      
69      WindowsをVirtualBoxのゲストで使ってる場合など)
70      
71 3. ビルドの方法
72
73    ソースコードを解凍するか、git clone / pull した後で:
74    
75    $ cd {srctop}/source/build-cmake/{Machine name}/
76    $ mkdir build
77    $ cd build
78    
79    To configure:
80    
81    $ cmake ..
82    
83    or
84    
85    $ ccmake ..
86
87    To build:
88    
89    $ make
90
91    To install:
92    
93    $ sudo make install
94
95 4. Qt固有の話(Windows除く)
96
97    *ToolTipsを付けました。(2017-01-24)
98       
99    *日本語に翻訳しました。(2017-01-24)
100    
101    *R@Mを $HOME/emu{Machine Name}/ に配置してください。(Windowsの場合は今の所 .\emu{Machine Name}\)。なお、このディレクトリは最初起動した後で作成されます。
102    
103    *設定ファイルは、$HOME/.config/emu{Machine Name}/ に書き込まれます。(Windowsの場合は今の所 .\.config\emu{Machine Name}\)
104    
105    *ステートセーブファイルは、$HOME/emu{Machine Name}/{Machine Name}.sta に書き込まれます。
106    
107    *キーコード変換テーブルファイルが、$HOME/.config/emu{Machine Name}/scancode.cfg に書き込まれます。
108    
109      書式は、カンマで区切られた16進データです(10進ではないので注意) .
110      
111      1カラム目はM$ ヴァーチャルキーコード。
112      
113      2カラム目はQtネィティブのスキャンキーコードです。
114      
115    *UI部分の共通コンポーネント (src/qt/gui) を共有ライブラリlibCSPgui.soにまとめました。
116    
117    *インストール用のBASHスクリプトを用意しました。src/tool/installer_unix.shです。
118    
119    *ROMと同じところに、特定のWAVファイル(VMによって異なる)を入れると、FDDのシーク音やテープのボタン音・リレー音を鳴らすことが出来ます。
120    
121    *ローマ字カタカナ変換支援機構が一部の機種に実装されてます。romaji_kana.ja.txt をお読みください。
122     
123 5. 移植状況
124    
125    a.現在、Debian GNU/Linux "sid"と、Ubuntu Linux 16.04LTS "Xenial"
126      の AMD64版でしかテストしていません。
127     が、多分他のGNU/Linux OSやBSD系のOS (Mac含む) でもビルドすれば
128     動くでしょう。
129      Windows もしくは GNU/Linux(要Wineとbinfmt-support)上でのMinGWと
130      Qt community edition でのビルドが通るようになりました。
131      安定したWindowsビルドを必要な方は、Visual Studio 2013 か 2015 のCommunity Edition
132      でビルドしてください。(もう少ししたら、MinGWに切り替えようとは思ってます。)
133       
134    b. 今は、Qtの開発側が「Qt4おわりね」とアナウンスしたので、Qt4ではなく
135       Qt5を使っています。
136       添付してあるバイナリは、Qt 5.5でビルドしました(が、Qt 5.1以降なら動くはずです)。
137
138    c. Linux用ビルドでは、GCC 6をリンク時最適化(LTO)モードで使っています。
139    d. MZ-2500のソケット機能を実装してみていますが、マトモにテストできてません(;´Д`)
140    
141 6. Upstream repositry:
142       https://github.com/Artanejp/common_source_project-fm7
143       https://www.pikacode.com/Artanejp/common_source_project-fm7/
144
145 7. Project Page:
146       https://osdn.jp/projects/csp-qt/
147
148 8. Upstream (Takeda Toshiyaさんのオリジナル) 
149       http://takeda-toshiya.my.coocan.jp/
150
151 Changes:
152
153 ChangeLog:
154
155 * SNAPSHOT April 09, 2017
156   * Upstream 2017-04-02
157   * [General] Add National JR-800.
158   * [UI/Qt] Move drive status from status-bar to right dock.
159   * [FILEIO] Fix FTBFS with ZLIB 1.2.8 or earlier.
160   * [VM/General] EMU/COMMON : Fix bugs around handling filename and directories.
161   * [VM/General] common.cpp : Use buffer sized functions for some string functions.
162   * [VM/FM77AV] DISPLAY: HSYNC:Don't register event(s) per HDISP.
163   * [VM/FM7] DISPLAY: Reduce address calculation.
164   * [VM/FM7] DISPLAY: Fix auto skip feature.
165   * [VM/FM7] Use function table(s) to access memories within display sub-system and main-system.
166   * [VM/FM77AV40EX] Fix wrong display timing.
167   * [Build/CMake] Add supporting for ZLIB.
168   * [BUILD/LINUX] Fix linking order.
169   * [General/BUILD] Linux: Use -D_UNICODE to build.
170
171 -- Apr 09, 2017 23:04:45 +0900 K.Ohta <whatisthis.sowhat@gmail.com>
172
173 * SNAPSHOT March 07, 2017
174   * Upstream 2017-03-04
175   * [VM] Some devices have prepared to move to libCSPcommon_vm .
176   * [VM/FMGEN] Move FMGEN to libCSPfmgen .
177   * [WIN32] Ready to build with DLLs contain GUI and AVIO and some features.
178   * [BUILD] Selectable building.
179   * [BUILD] Add logging build-status.
180   * [Qt] Fix break device files when exiting emulator with some situations.
181   * [Win32/OpenGL/WIP] TRY: Fixing crash with OpenGL3.0 at Corei5-2420M (and Windows7) PC. See Issues.txt or Issues.ja.txt.
182   * [DOC] Update Issues.See http://hanabi.2ch.net/test/read.cgi/i4004/1483504365/30 .
183   * [EMU/DEBUGGER] Use pthread_t instead of SDL_Thread.
184   * [Qt/OSD] Remove do_call_debugger_command().
185   * [SOUND/VM] Fix choppy sounds with some devices. i.e. PCM1BIT. Thanks to Takeda-San and Umaiboux-San.
186   * [VM/FMGEN] Fix crash with GCC-5.This is issue of optimization, add "volatile" to any member(s).
187   * [BUILD/LINUX] GCC5: (MAYBE) Enable to set "USE_RADICAL_OPTIMIZE" to "YES".
188   * Built with 2dac70eb1743e2a0b778a57a1f520fce59aa6371 or newer.
189
190 -- Mar 07, 2017 15:55:25 +0900 K.Ohta <whatisthis.sowhat@gmail.com>
191
192
193 本家の変更:
194
195 4/2/2017
196
197 [RESOURCE] improve menu items
198 [WINMAIN] improve menu items
199
200 [EX80] support to show/hide crt monitor
201
202
203 3/30/2017
204
205 [COMMON] add functions to convert char, wchar_t, and _TCHAR to each other
206 [COMMON] add _fgetts, _ftprintf, my_ftprintf_s, and my_swprintf_s
207 [COMMON/FILEIO] add Fgetts and Ftprintf for _TCHAR
208 [COMMON/FILEIO] fix functions using ZLIB for _UNICODE case
209 [EMU/DEBUGGER] fix for _UNICODE case
210 [WINMAIN] improve to update status only when status is changed
211
212 [VM/HUC6280] improve disassembler to support symbols (thanks Mr.Kei Moroboshi)
213 [VM/I8080] improve disassembler to support symbols
214 [VM/M6502] support debugger and disassembler (thanks MAME)
215 [VM/MCS48] improve disassembler to support symbols
216 [VM/TMS9995] fix disassembler for _UNICODE case
217 [VM/UPD7810] improve disassembler to support symbols
218 [VM/UPD7810] fix disassembler for _UNICODE case
219
220 [BABBAGE2ND] support debugger and save/load state
221 [FAMILYBASIC] support debugger
222 [YS6464A] support debugger and save/load state
223
224
225 3/28/2017
226
227 [COMMON] add _tcscat and my_tcscat_s
228 [COMMON] add structure and functions to support symbols
229 [EMU/DEBUGGER] improve debugger to support symbols (thanks Mr.Kei Moroboshi)
230
231 [VM/MC6800] improve disassembler to support symbols (thanks Mr.Kei Moroboshi)
232 [VM/MC6809] improve disassembler to support symbols (thanks Mr.Kei Moroboshi)
233 [VM/TMS9995] improve disassembler to support symbols (thanks Mr.Kei Moroboshi)
234 [VM/UPD7801] improve disassembler to support symbols (thanks Mr.Kei Moroboshi)
235 [VM/Z80] improve disassembler to support symbols (thanks Mr.Kei Moroboshi)
236
237
238 3/26/2017
239
240 [VM/YM2413] support mute
241
242 [FAMILYBASIC] support Family BASIC MMC5/VRC7 MOD
243 [FAMILYBASIC] support correct scanlines
244 [FAMILYBASIC/MEMORY] support MMC5/ VRC7 based on unofficial nester
245 [FAMILYBASIC/MEMORY] fix data recorder signal (thanks MESS)
246
247
248 3/20/2017
249
250 [COMMON] suport to read ascii/binary file compressed by gzip
251 [RESOURCE] fix fm8/fm7/fm77 dipswitch menu items
252 [WINMAIN] fix to update status bar twice/second to supress flickar
253
254 [VM/SCSI_CDROM] support CD-ROM bin/img file compressed by gzip
255 [VM/DATAREC] support tape image file compressed by gzip
256 [VM/DATAREC] support to save FUJITSU FM-7/77 t77 format tape image
257
258 [BMJR/MEMORY] fix sound mixer not to clear previously mixed sound
259
260
261 3/18/2017
262
263 [WINMAIN] support multiple data recorder
264 [EMU] support multiple data recorder
265
266 [VM/DATAREC] support HITACH BASIC Master Jr bin format tape image
267 [VM/PTF20] support access lamp signal
268
269 [BMJR/MEMORY] fix reading cmt signal
270 [BMJR/MEMORY] fix sound mixer
271 [TK80BS/CMT] support TK-80 cmt i/f
272
273
274 3/15/2017
275
276 [WINMAIN] add status bar to draw access lamps
277 [EMU] add interfaces to get access status of floppy/quick/hard disk drives
278 [EMU] add interface to get cmt status message
279
280 [VM/DATAREC] support cmt status message
281 [VM/HD44102] fix build error
282 [VM/MC6800] fix M_RDOP and M_RDOP_ARG macros (thanks PockEmul)
283 [VM/LD700] support access lamp signal
284 [VM/SCSI_CDROM] support access lamp signal
285 [VM/SCSI_DEV] support access lamp signal
286 [VM/SCSI_HDD] support access lamp signal
287
288 [HC20] fix issue that we cannot debug TF-20 CPU
289 [JR800] support National JR-800 (thanks PockEmul)
290
291
292 3/12/2017
293
294 [VM/DATAREC] fix issue that fast forward noise may not stop
295
296
297 3/11/2017
298
299 [VM/DATAREC] support to play play/stop/fast-fwd noise
300 [VM/MB8877] support to play seek/load/unload noise
301 [VM/HD44102] support HD44102 based on MAME 0.171
302 [VM/T3444A] support to play seek/load/unload noise
303 [VM/UPD765A] support to play seek/load/unload noise
304 [VM/UPD765A] fix seek time (thanks Mr.Artane.)
305
306 [MZ80B/MEMORY80B] fix vgate signal (thanks Mr.Suga)
307
308
309 3/8/2017
310
311 [VM/DISK] improve to check if disk image is modified more strictly
312 [VM/DISK] import yaya2016-04-13plus1 (thanks Mr.umaiboux)
313 [VM/V9938] import yaya2016-04-13plus1 (thanks Mr.umaiboux and MAME)
314 [VM/YM2413] import yaya2016-04-13plus1 (thanks Mr.umaiboux)
315
316 [FMR30] split project for i86 and i286
317 [MSX/*] import yaya2016-04-13plus1 (thanks Mr.umaiboux)
318
319
320 3/7/2017
321
322 [WIN32/INPUT] improve to accept shift + caps/kana/kanji
323
324 [VM/DISK] support device name (thanks Mr.Aratane.)
325 [VM/EVENT] improve to check abnormal scanline number (thanks Mr.Sato)
326 [VM/EVENT] fix light weight sound rendering (thanks Mr.168)
327 [VM/*] add device name to all devices of each machine (thanks Mr.Aratane.)
328
329 [MZ80B] change floppy drive type from 2D to 2DD (thanks Mr.Suga)
330 [MZ80B/MEMORY80B] support I-O DATA PIO-3039 (thanks Mr.Suga)
331
332 -----
333
334
335 お楽しみあれ!
336 -- Ohta.