OSDN Git Service

[DOC] Update to SNAPSHOT 2016-09-09.
[csp-qt/common_source_project-fm7.git] / source / readme_by_artane.txt
1 ** Qt porting for Common Source Code Project **
2                                           Sep 09, 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_20160909
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 2.1は必要です。 (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    g. ffmpegは、それぞれのランタイムに必要なものをバンドルしてあります
41       ので、動かない時はインストールしてみてください。
42    h. GNU/Linuxビルドでは、Qt5.3でビルドしてあります(Ubuntu 16.04LTS向け)
43    * Windows もしくは GNU/Linux のcross tool chain (要Wine)で、
44      MinGW と Qt 5.7 でのビルドができることを確認しました。
45      
46    * TIPS:
47      Windows等で動かした時に、画面の書き替えが表示されない場合は、
48      環境変数 QT_OPENGL を software にしてみてください。(例えば、
49      WindowsをVirtualBoxのゲストで使ってる場合など)
50      
51 3. ビルドの方法
52    ソースコードを解凍するか、git clone / pull した後で:
53    $ cd {srctop}/source/build-cmake/{Machine name}/
54    $ mkdir build
55    $ cd build
56    
57    To configure:
58    $ cmake ..
59    or
60    $ ccmake ..
61
62    To build:
63    $ make
64
65    To install:
66    $ sudo make install
67
68 4. Qt固有の話(Windows除く)
69    ・R@Mを $HOME/emu{Machine Name}/ に配置してください。(Windowsの場合は今の所 .\emu{Machine Name}\)
70     なお、このディレクトリは最初起動した後で作成されます。
71    ・設定ファイルは、$HOME/.config/emu{Machine Name}/ に書き込まれます。(Windowsの場合は今の所 .\.config\emu{Machine Name}\)
72    ・ステートセーブファイルは、$HOME/emu{Machine Name}/{Machine Name}.sta に書き込まれます。
73    ・キーコード変換テーブルファイルが、$HOME/.config/emu{Machine Name}/scancode.cfg に書き込まれます。
74      書式は、カンマで区切られた16進データです(10進ではないので注意) .
75      1カラム目はM$ ヴァーチャルキーコード。
76      2カラム目はQtネィティブのスキャンキーコードです。
77    ・UI部分の共通コンポーネント (src/qt/gui) を共有ライブラリlibCSPgui.soにまとめました。
78    ・インストール用のBASHスクリプトを用意しました。src/tool/installer_unix.shです。
79    
80      
81 5. 移植状況
82    a. 現在、Debian GNU/Linux "sid" の AMD64版でしかテストしていません。
83      が、多分他のGNU/Linux OSやBSD系のOS (Mac含む) でもビルドすれば
84      動くでしょう。
85       Windows もしくは GNU/Linux(要Wineとbinfmt-support)上でのMinGWと
86       Qt community edition でのビルドが通るようになりました。
87       安定したWindowsビルドを必要な方は、Visual Studio 2013 か 2015 のCommunity Edition
88       でビルドしてください。(もう少ししたら、MinGWに切り替えようとは思ってます。)
89       
90    b. 今は、Qtの開発側が「Qt4おわりね」とアナウンスしたので、Qt4ではなく
91       Qt5を使っています。
92       添付してあるバイナリは、Qt 5.5でビルドしました(が、Qt 5.1以降なら動くはずです)。
93
94    c.上流の2016-04-17現在でのPX7以外の全ての仮想マシンがQtに移植出来ています。
95    d. Linux用ビルドでは、GCC 6をリンク時最適化(LTO)モードで使っています。
96    e. MZ-2500のソケット機能を実装してみていますが、マトモにテストできてません(;´Д`)
97    
98 6. Upstream repositry:
99       https://github.com/Artanejp/common_source_project-fm7
100       https://www.pikacode.com/Artanejp/common_source_project-fm7/
101
102 7. Project Page:
103       https://osdn.jp/projects/csp-qt/
104
105 8. Upstream (Takeda Toshiyaさんのオリジナル) 
106       http://takeda-toshiya.my.coocan.jp/
107
108 Changes:
109 * SNAPSHOT September 09, 2016
110   * Upstream 2016-04-13
111   * [LOGGER] Add extend logger.
112   * [LOGGER/Qt] Rename agar_logger.[cpp|h] to csp_logger.[cpp|h] .
113   * [VM] Ready to enable log per device.
114   * [VM] Update emu->out_debug_log to [DEVICE]->out_debug_log .
115   * [UI/Qt] Add log viewer window.
116   * [Qt/EMUTHREAD] Move commonly blocks to gui/ .
117   * [Qt/KEY] Use queue for keyin/out.
118   * [VM/OSD] Add socket (networking) featuers, but still not test (;´Д`)
119   * [VM/FM77AV] MB61VH010 : Faster drawing lines.
120   * [VM/FM7] MAINIO: Comment out logging around FIRQ, temporally.
121   * [OSD/KEYBOARD] Fix handling around SHIFT for some machines(i.e. PC8801).
122   * [MOVIE_SAVER] Use SIMD to transfer a picture OSD(VM)->MOVIE_SAVER .
123   * [DOC] Update updtream's URL, moved to takeda-toshiya.my.coocan.jp .
124   * Built with GIT 771e6376ee9da1f2d466381d834fa40bc2310f60 (or later).
125
126 -- Sep 09, 2016 01:02:51 +0900 K.Ohta <whatisthis.sowhat@gmail.com>
127
128 * SNAPSHOT August 19, 2016
129   * Upstream 2016-04-13
130   * [WIN32] Replace libICU to homebrew, fix not starting.
131   * [OSD/MOVIE_SAVER] Fix frames to enqueue to MOVIUE_SAVER, as if VIDEO FPS >= RECORD FPS.
132   * [MOVIE_LOADER] Sync A/V on playing MOVIE.
133   * Built with GIT 77380a77b25ca06965b912c84509e5c91085aeb1 (or later) .
134
135 -- Aug 19, 2016 23:12:36 +0900 K.Ohta <whatisthis.sowhat@gmail.com>
136
137 * SNAPSHOT August 15, 2016
138   * Upstream 2016-04-13
139   * [OSD][MOVIE_SAVER] Maybe correctness frame(s) counting with 60fps ヽ(=´▽=)ノ
140   * [MOVIE_SAVER] Fix sometimes crashing when stop to save movie.
141   * [PX7/MOVIE_LOADER] Sound Laser Disc, but not be smooth.
142   * [MOVIE_SAVER][PC8801][PC9801] Adjust sound frequency when OVERRIDE_48000Hz , still choppy.
143   * Built with GIT 3f4c809912dc92cdeb34d8ecdebe0087aa7f37b3 (or later) .
144  
145 -- Aug 16, 2016 02:40:55 +0900 K.Ohta <whatisthis.sowhat@gmail.com>
146
147 * SNAPSHOT August 09, 2016
148   * Upstream 2016-04-13
149   * [PX7] Add movie loader for LD, but not tested enough yet.
150   * [MOVIE_SAVER/OpenGL] Add locking around drawing buffer.
151   * [BUILD] Update FFMPEG to 3.1.1 .
152   * [FFMPEG/LINUX] Enable OpenCL for ffmpeg @linux.You need libOpenCL.so.1 to use homebrew build.
153   * [FFMPEG/WIN32] Enable DXVA2 for video-decoding accelerator.
154   * [MOVIE_SAVER] Synchronous OPEN->ENCODEING->CLOSING.
155   * [UI/MOVIE_SAVER] DO NOT change state of "Save as movie" without *real* starting/stopping.
156   * [Draw/OpenGL] Optimize GLSL's by https://github.com/aras-p/glsl-optimizer .
157   * Built with GIT fc7a03a9337287414e00777464ab273c4f44ea44 (or later) .
158  
159 -- Aug 10, 2016 01:42:51 +0900 K.Ohta <whatisthis.sowhat@gmail.com>
160
161 Upstream changes:
162 -----
163 4/13/2016
164
165 [WINMAIN] improve auto key for the case to switch upper/lowercase with capslock
166 [EMU/DEBUGGER] fix issue that u command may cause the infinite loop
167
168 [VM/DATAREC] support to detect the frequency of signal
169 [VM/DATAREC] fix to always adjust zero position of wave signal
170 [VM/UPD1990A] fix not to check clk signal is low when stb signal is raised
171 [VM/UPD7810] support debugger
172 [VM/UPD7810] support MOV A,S opecode
173 [VM/UPD7810] fix not to change V register (thanks PockEmul)
174
175 [PC2001] support NEC PC-2001
176 [PC2001] fix cpu clock
177 [PC2001] support beep sound
178 [PC2001/IO] support rtc control signals
179 [YALKY] support Yuasa Kyouiku System YALKY
180 [YALKY/IO] improve data recorder controller
181
182 -----
183
184
185 お楽しみあれ!
186 -- Ohta.