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                                           June 21, 2016
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      https://github.com/Artanejp/common_source_project-fm7/releases/tag/SNAPSHOT_20160618-3
15
16    追加情報:
17      各機種バイナリーは、osdn.jp もしくはミラーサイトより入手可能です。
18     https://osdn.jp/projects/csp-qt/  
19      https://osdn.jp/projects/csp-qt/releases/ をチェックしてください。
20
21     Win32: 
22     GNU/Linux(amd64) : 
23
24
25 1. 背景
26    CSPは、非常に優れた構造のエミュレータです(しかし、些か重くてコンパイラ
27    がいい最適化をしないと重めですが)。
28    しかし、このコードはM$ Visual C++依存の部分が非常に多いです。
29    そこで、GNU/Linuxでこれを動かすためにQtに色々と移植していきましょう。
30    と言う感じで作業をはじめました。
31
32 2. 最低限必要なもの(Qt版)
33    a. Qt5 ツールキット
34    b. OpenGL, 多分、最低OpenGL 3.0は必要です。 (New!)
35    c. gcc / g++ (4.7以降?)もしくは llvm clang / clang++ (3.5以降?)
36       コンパイラツールチェーン。
37    d. SDL2 (SDL 1.xではないので注意)
38    e. CMake 2.8以降。
39    f. ffmpegから、libavとlibswが必要です。 http://ffmpeg.org/ より。
40    
41    * Windows もしくは GNU/Linux のcross tool chain (要Wine)で、
42      MinGW と Qt 5.5.1 でのビルドができることを確認しました。
43      
44    * TIPS:
45      Windows等で動かした時に、画面の書き替えが表示されない場合は、
46      環境変数 QT_OPENGL を software にしてみてください。(例えば、
47      WindowsをVirtualBoxのゲストで使ってる場合など)
48      
49 3. ビルドの方法
50    ソースコードを解凍するか、git clone / pull した後で:
51    $ cd {srctop}/source/build-cmake/{Machine name}/
52    $ mkdir build
53    $ cd build
54    
55    To configure:
56    $ cmake ..
57    or
58    $ ccmake ..
59
60    To build:
61    $ make
62
63    To install:
64    $ sudo make install
65
66 4. Qt固有の話(Windows除く)
67    ・R@Mを $HOME/emu{Machine Name}/ に配置してください。(Windowsの場合は今の所 .\emu{Machine Name}\)
68     なお、このディレクトリは最初起動した後で作成されます。
69    ・設定ファイルは、$HOME/.config/emu{Machine Name}/ に書き込まれます。(Windowsの場合は今の所 .\.config\emu{Machine Name}\)
70    ・ステートセーブファイルは、$HOME/emu{Machine Name}/{Machine Name}.sta に書き込まれます。
71    ・キーコード変換テーブルファイルが、$HOME/.config/emu{Machine Name}/scancode.cfg に書き込まれます。
72      書式は、カンマで区切られた16進データです(10進ではないので注意) .
73      1カラム目はM$ ヴァーチャルキーコード。
74      2カラム目はQtネィティブのスキャンキーコードです。
75    ・UI部分の共通コンポーネント (src/qt/gui) を共有ライブラリlibCSPgui.soにまとめました。
76    ・インストール用のBASHスクリプトを用意しました。src/tool/installer_unix.shです。
77    
78      
79 5. 移植状況
80    a. 現在、Debian GNU/Linux "sid" の AMD64版でしかテストしていません。
81      が、多分他のGNU/Linux OSやBSD系のOS (Mac含む) でもビルドすれば
82      動くでしょう。
83       Windows もしくは GNU/Linux(要Wineとbinfmt-support)上でのMinGWと
84       Qt community edition でのビルドが通るようになりました。
85       安定したWindowsビルドを必要な方は、Visual Studio 2013 か 2015 のCommunity Edition
86       でビルドしてください。(もう少ししたら、MinGWに切り替えようとは思ってます。)
87       
88    b. 今は、Qtの開発側が「Qt4おわりね」とアナウンスしたので、Qt4ではなく
89       Qt5を使っています。
90       添付してあるバイナリは、Qt 5.5でビルドしました(が、Qt 5.1以降なら動くはずです)。
91
92    c.上流の2016-04-17現在でのPX7以外の全ての仮想マシンがQtに移植出来ています。
93    d. Linux用ビルドでは、GCC 6をリンク時最適化(LTO)モードで使っています。
94    
95 6. Upstream repositry:
96       https://github.com/Artanejp/common_source_project-fm7
97       https://www.pikacode.com/Artanejp/common_source_project-fm7/
98
99 7. Upstream (Takeda Toshiyaさんのオリジナル) 
100       http://homepage3.nifty.com/takeda-toshiya/
101
102 Changes:
103
104 * SNAPSHOT June 21, 2016
105   * Upstream 2016-04-13
106   * Build with FFMPEG 3.0.2 supported libmp3lame.
107   * [Linux] Build with qt.io's official Qt 5.3.1 expect to work with 
108     Ubuntu 16.04 LTS and Debian 8 "Jessie".
109   * [MOVIE_SAVER] (Maybe mostly?) Fix asynchronous both video and audio.
110   * [MOVIE_SAVER] Add libmp3lame and vorbis (disable from UI) for audio codec.
111   * [Qt] Not linking config and using_flags directly from libCSPgui , libCSPavio and libCSPosd .
112   * [MOVIE_SAVER][EMU] Fix stop/restart recording movie when changing/ejecting CARTRIDGEs.
113                        Now, don't stop when changing/eject cartridge.
114     See, http://hanabi.2ch.net/test/read.cgi/i4004/1430836648/699 .
115   * [MOVIE_SAVER] Re-enable (and selectable) H.264 for video codec.
116   * Build with 85c331b7635ca713e819218b86d65a877b7478f3 (or later).
117   
118 -- Jun 21, 2016 01:07:44 +0900 K.Ohta <whatisthis.sowhat@gmail.com>
119
120 * SNAPSHOT June 18, 2016
121   * Upstream 2016-04-13 .
122   * Build with FFMPEG 3.0.2 .
123   * [MOVIE_SAVER] More safer open/close.
124   * [MOVIE_SAVER] Fix deadlock when closing movie.
125   * [MOVIE_SAVER] Selectable both MPEG4v1 and H.264(libx264) for video codec.
126   * [MOVIE_SAVER][Qt] Temporally set video-codec to MPEG4 (not AVC).
127     This is issue of discard frames with libx264 by ffmpeg's libavcodec/libavformat.
128     This seems to be ffmpeg's issue, not my program.
129   * Build with 629f7d70816c04b38c3ab8cc277147a6bd2c2d2a (or later).
130   
131 -- Jun 18, 2016 03:32:06 +0900 K.Ohta <whatisthis.sowhat@gmail.com>
132
133 * SNAPSHOT June 11, 2016
134   * Upstream 2016-04-13 .
135   * Use osdn.jp to distibute binaries.
136     https://osdn.jp/projects/csp-qt .
137   * [MOVIE_SAVER] Use ffmpeg internal aac codec, because faac or fdk_aac are not *Free* .
138   * [VM/MOVIE_SAVER] Fix stopping when changing cartridge, now refer to upstream (split movies).
139   * [Qt/Win32] Fix not work with WindowsXP, using homebrew version of ffmpeg-2.8.7.
140   * Build with 89d31ce8daa733ea4a0c38f0a1890d3a0fcfce38 (or later).
141   
142 -- Jun 11, 2016 05:09:55 +0900 K.Ohta <whatisthis.sowhat@gmail.com>
143
144 * SNAPSHOT June 09, 2016
145   * Upstream 2016-04-13 .
146   * Now, all of binaries are built with ffmpeg-2.8.7 at GNU/Linux,  with ffmpeg-3.0 at Windows.
147   * Please read README.ffmpeg.txt .
148   * [FM7/Disk] Add exceptions for Xanadu Scenario 2, this has not booted with changes 49dceaca9401d3c6037cb51ec013ca032ff0e83c .
149   * Build with 64df71cd492be91289f883224640f42cace090ed (or later).
150
151 -- Jun 09, 2016 05:50:50 +0900 K.Ohta <whatisthis.sowhat@gmail.com>
152
153 * SNAPSHOT June 08, 2016
154   * Upstream 2016-04-13 .
155   * Add movie saver, using libav with x264.
156   * Now, all of binaries are built with ffmpeg-3.0.
157   * Build with 2142d5c7426e21cfeedbaea0450f238f8b4d7d38 (or later).
158
159 -- Jun 08, 2016 07:34:45 +0900 K.Ohta <whatisthis.sowhat@gmail.com>
160
161 * SNAPSHOT May 23-2, 2016
162   * Win32 binary only RELEASE
163   * Fix unable to run with some natibve Windows environment.
164   * Build with c1448dc84f5439c7c8931614a8397dbefb6383da .
165
166 -- May 24, 2016 22:42:00 +0900 K.Ohta <whatisthis.sowhat@gmail.com>
167
168 * SNAPSHOT May 23, 2016
169   * Upstream 2016-04-13 .
170   * [Win32] Now built with -msse -msse2 . You can run only later than Pentium4 .
171   * Move FILEIO:: FIFO:: COMMON:: to libCSPemu_utils .
172   * Make OSD:: to inherited by OSD_BASE:: .
173   * [Win32] Disable LINKFLAGS with "-static-libgcc -static-libstdc++" to reduce size of executions, now, bundled libstc++ is for gcc-5 .
174   * [Win32/Build] Support build with MSYS2 (but not display because MSYS2's Qt was build without OpenGL).
175   * [Linux] Build shared libraries with Link-Time-Optimize, reduce size of libs.
176   * [X1/VM] Configurable buttons for X1/Turbo/Turbo Z.
177   * [FM7/FDC] Set MB8877_NO_BUSY_AFTER_SEEK. Fixed unable to boot OS0. Thanks to Anna_Wu.
178   * [FM77AV/MB61VH010] ALULINE: Reduce CPU usage (at delta X > delta Y).
179   * [UI/Qt/DRAW] Fix crash sometimes when exit emulator.
180   * Build with 1c1ddc85dfa7456b1ce48662c2e2930dcc4fc9d8 (or later).
181
182 -- May 23, 2016 02:22:07 +0900 K.Ohta <whatisthis.sowhat@gmail.com>
183
184 Upstream changes:
185 -----
186 4/13/2016
187
188 [WINMAIN] improve auto key for the case to switch upper/lowercase with capslock
189 [EMU/DEBUGGER] fix issue that u command may cause the infinite loop
190
191 [VM/DATAREC] support to detect the frequency of signal
192 [VM/DATAREC] fix to always adjust zero position of wave signal
193 [VM/UPD1990A] fix not to check clk signal is low when stb signal is raised
194 [VM/UPD7810] support debugger
195 [VM/UPD7810] support MOV A,S opecode
196 [VM/UPD7810] fix not to change V register (thanks PockEmul)
197
198 [PC2001] support NEC PC-2001
199 [PC2001] fix cpu clock
200 [PC2001] support beep sound
201 [PC2001/IO] support rtc control signals
202 [YALKY] support Yuasa Kyouiku System YALKY
203 [YALKY/IO] improve data recorder controller
204
205 -----
206
207
208 お楽しみあれ!
209 -- Ohta.