本分支用于 64 位 Windows 平台的 MSVC 工具链的 BesLyric-for-X 开发环境配置。查看其他平台的文档：
按照本文档进行配置后，通过测试的操作系统与开发环境的版本组合：
| OS & ReleaseID & Kernel |
%VCToolsVersion% | Windows SDK | Qt | SDL | FFmpeg | TLS Impl. | |||
|---|---|---|---|---|---|---|---|---|---|
|
14.26.28801 | 10.0.18362.1 | 5.15.0 | 2.0.12 | ffmpeg version 4.3.1 built with gcc 10.2.1 (GCC) 20200726 | OpenSSL 1.1.1g 21 Apr 2020 | |||
|
14.16.27023 | 10.0.17763.0 | 5.12.9 | 2.0.12 | ffmpeg version 4.3.1 built with gcc 10.2.1 (GCC) 20200726 | OpenSSL 1.1.1g 21 Apr 2020 | |||
|
14.24.28314 | 10.0.18362.1 | 5.14.1 | 2.0.10 | ffmpeg version 4.2.2 built with gcc 9.2.1 (GCC) 20200122 | OpenSSL 1.1.1d 10 Sep 2019 |
BesLyric-for-X 需要一些第三方库，在 Windows 平台，开发 BesLyric-for-X 需要环境变量B4X_DEP_PATH（ macOS 也使用该环境变量）。
典型的B4X_DEP_PATH值为C:\b4x-lib。 BesLyric-for-X 中的 qmake 指令向$$INCLUDEPATH变量添加${B4X_DEP_PATH}/include，使 Qt 和 MSVC 能够找到第三方库的头文件；同时，向$$LIB添加-L${B4X_DEP_PATH}/lib，使 Qt 和 MSVC 能够找到第三方库的库文件。
不建议将该环境变量配置到操作系统或当前用户中，而是配置到项目内（ 过 Qt Creator 左侧列表切换到“ Project ”页面，在“ Build Settings ”-“ Build Environment ”中配置环境变量）。
注意：即使B4X_DEP_PATH指向的文件夹的路径包含空格，也不需要在路径两端加上引号。
MSVC 工具集包含 C/C++ 编译器（cl.exe）、资源编译器（rc.exe）、链接器（link.exe）、构建工具（nmake.exe）等程序。
Windows SDK 包含 Windows 开发所需要的文档、头文件（例如Windows.h和stdio.h）、库文件（例如ncrypt.lib和libucrt.lib）、调试器（例如 CDB ）等组件。
MSVC 、 Visual Studio 与 Windows SDK 的版本对应关系（版本不对应也能用，但是过低版本 Visual Studio 不能发现高版本 Windows SDK [20]）如下表[9]：
| MSVC | Visual Studio | Windows SDK | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|
| v140 |
|
|
||||||||
| v141 |
|
|
||||||||
| v142 |
|
|
推荐使用 Visual Studio Installer 安装 MSVC 工具集和 Windows SDK 。
对于 Qt 开发来说，在 Visual Studio Installer 中，勾选“ Desktop development with C++ ”工作负载后安装即可。
CDB 与 WinDbg 同为 Windows 上的调试器[8]， Qt Creator 需要使用它调试程序。
通过 Visual Studio Installer 安装 Windows SDK 后，在“应用和功能”列表中找到“ Windows Software Development Kit - Windows 10.N ”，选择它并单击“修改”，弹出“ Windows Software Development Kit - Windows 10.N ”窗口。在“ Maintain your Windows Software Development Kit - Windows 10.N features ”页面选择“ Change ”，下一步后，在“ Select the features you want to change ”页面勾选“ Debugging Tools for Windows ”并单击“ Change ”以安装 CDB 。
- 从 Index of /official_releases/online_installers 下载在线安装程序；
- 安装时记得勾选当前编译环境对应的预构建组件（ Pre-built Components ），例如“ Qt / Qt 5.15.0 / MSVC 2019 64-bit ”；
- 同时记得勾选调试器的支持组件，例如“ Qt / Developer and Designer Tools / Qt Creator 4.12.3 CDB Debugger Support ”;
- 如果之前已经安装了 CDB ，记得取消勾选默认勾选的调试器，例如“ Qt / Developer and Designer Tools / Debugging Tools for Windows ”
Qt 5.15 已能自动探测到 MSVC 2019 ，请忽略本节。
由于低于 5.15 版本的 Qt 不能自动探测到 MSVC 2019 ，所以需要手动配置构建套件。
由于 MSVC 2017 与 2019 是二进制兼容的[5]，所以“ MSVC 2017 ”版本的 Qt 组件可用于 MSVC 2019[10] 。
- 单击菜单栏“ Tools ”-“ Options... ”打开“ Options - Qt Creator ”窗口，单击左侧列表中的“ Kits ”切换到构建套件上下文并切换到“ Kits ”选项卡；
- 列表中有自动探测到的构建套件，例如“ Desktop Qt 5.14.1 MSVC2017 64bit ”，而且其头部有黄色叹号，提示“ Warning: No compile set in kit. ”；
- 单击该构建套件，为其选择对应平台（“x86”与“amd64”）的 C 和 C++ 的编译器。注意，“amd64_x86”和“x86_amd64”是交叉编译（“{开发平台}_{目标平台}”）的选项，可以忽略；
- 检查该构建套件的调试器配置，为其选择对应平台的 CDB ；
- 完成上述配置后，该 Kit 头部依然有黄色叹号，提示“ The compiler "..." (...) may not produce code compatible with the Qt version "..." (...). ”，这是正常现象，可以忽略。
SDL（英语：Simple DirectMedia Layer）是一套开放源代码的跨平台多媒体开发库，使用C语言写成。[18]
- 下载用于 Windows 的， devel 版本的，用于 Visual C++ 的 SDL 2 ；
- 对于头文件，从压缩包中提取
\SDL2-2.N.N\include\下的所有.h文件到%B4X_DEP_PATH%\include\SDL2\下； - 对于静态库文件，从压缩包中提取
\SDL2-2.N.N\lib\x64\下的SDL2.lib和SDL2main.lib文件到%B4X_DEP_PATH%\lib\下； - 对于动态库文件，从压缩包中提取
\SDL2-2.N.N\lib\x64\下的SDL2.dll文件到%B4X_DEP_PATH%\bin\下。
完整的 SDL 2 库文件的文件夹结构如下（点击展开）：
> tree /A /F %B4X_DEP_PATH%
%B4X_DEP_PATH%
+---include
| \---SDL2
| begin_code.h
| close_code.h
| SDL.h
| SDL_assert.h
| SDL_atomic.h
| SDL_audio.h
| SDL_bits.h
| SDL_blendmode.h
| SDL_clipboard.h
| SDL_config.h
| SDL_config.h.cmake
| SDL_config.h.in
| SDL_config_android.h
| SDL_config_iphoneos.h
| SDL_config_macosx.h
| SDL_config_macosx.h.orig
| SDL_config_minimal.h
| SDL_config_pandora.h
| SDL_config_psp.h
| SDL_config_windows.h
| SDL_config_winrt.h
| SDL_config_wiz.h
| SDL_copying.h
| SDL_cpuinfo.h
| SDL_egl.h
| SDL_endian.h
| SDL_error.h
| SDL_events.h
| SDL_filesystem.h
| SDL_gamecontroller.h
| SDL_gesture.h
| SDL_haptic.h
| SDL_hints.h
| SDL_joystick.h
| SDL_keyboard.h
| SDL_keycode.h
| SDL_loadso.h
| SDL_log.h
| SDL_main.h
| SDL_messagebox.h
| SDL_mouse.h
| SDL_mutex.h
| SDL_name.h
| SDL_opengl.h
| SDL_opengles.h
| SDL_opengles2.h
| SDL_opengles2_gl2.h
| SDL_opengles2_gl2ext.h
| SDL_opengles2_gl2platform.h
| SDL_opengles2_khrplatform.h
| SDL_opengl_glext.h
| SDL_pixels.h
| SDL_platform.h
| SDL_power.h
| SDL_quit.h
| SDL_rect.h
| SDL_render.h
| SDL_revision.h
| SDL_rwops.h
| SDL_scancode.h
| SDL_sensor.h
| SDL_shape.h
| SDL_stdinc.h
| SDL_surface.h
| SDL_system.h
| SDL_syswm.h
| SDL_test.h
| SDL_test_assert.h
| SDL_test_common.h
| SDL_test_compare.h
| SDL_test_crc32.h
| SDL_test_font.h
| SDL_test_fuzzer.h
| SDL_test_harness.h
| SDL_test_images.h
| SDL_test_log.h
| SDL_test_md5.h
| SDL_test_memory.h
| SDL_test_random.h
| SDL_thread.h
| SDL_timer.h
| SDL_touch.h
| SDL_types.h
| SDL_version.h
| SDL_video.h
| SDL_vulkan.h
|
+---dll
| SDL2.dll
|
\---lib
SDL2.lib
SDL2main.libFFmpeg是一套可以用来记录、转换数字音频、视频，并能将其转化为流的开源计算机程序。[19]
- 下载用于 64 位 Windows 的， Shared 和 Dev 版本的 FFmpeg ；
- 对于头文件，从 Dev 版本的压缩包中提取
\ffmpeg-4.N-winNN-dev\include\下的所有文件夹以及其中的文件到%B4X_DEP_PATH%\include\下； - 对于静态库文件，从 Dev 版本的压缩包中提取
\ffmpeg-4.N-wi64-dev\lib\下的所有.lib文件到%B4X_DEP_PATH%\lib\下； - 对于动态库文件，从 Shared 版本的压缩包中提取
\ffmpeg-4.N-win64-shared\bin\下的所有.dll文件到%B4X_DEP_PATH%\bin\下。
完整的 FFmpeg 4 库文件的文件夹结构如下（点击展开）：
> tree /A /F %B4X_DEP_PATH%
%B4X_DEP_PATH%
+---include
| +---libavcodec
| | ac3_parser.h
| | adts_parser.h
| | avcodec.h
| | avdct.h
| | avfft.h
| | d3d11va.h
| | dirac.h
| | dv_profile.h
| | dxva2.h
| | jni.h
| | mediacodec.h
| | qsv.h
| | vaapi.h
| | vdpau.h
| | version.h
| | videotoolbox.h
| | vorbis_parser.h
| | xvmc.h
| |
| +---libavdevice
| | avdevice.h
| | version.h
| |
| +---libavfilter
| | avfilter.h
| | buffersink.h
| | buffersrc.h
| | version.h
| |
| +---libavformat
| | avformat.h
| | avio.h
| | version.h
| |
| +---libavutil
| | adler32.h
| | aes.h
| | aes_ctr.h
| | attributes.h
| | audio_fifo.h
| | avassert.h
| | avconfig.h
| | avstring.h
| | avutil.h
| | base64.h
| | blowfish.h
| | bprint.h
| | bswap.h
| | buffer.h
| | camellia.h
| | cast5.h
| | channel_layout.h
| | common.h
| | cpu.h
| | crc.h
| | des.h
| | dict.h
| | display.h
| | downmix_info.h
| | encryption_info.h
| | error.h
| | eval.h
| | ffversion.h
| | fifo.h
| | file.h
| | frame.h
| | hash.h
| | hdr_dynamic_metadata.h
| | hmac.h
| | hwcontext.h
| | hwcontext_cuda.h
| | hwcontext_d3d11va.h
| | hwcontext_drm.h
| | hwcontext_dxva2.h
| | hwcontext_mediacodec.h
| | hwcontext_qsv.h
| | hwcontext_vaapi.h
| | hwcontext_vdpau.h
| | hwcontext_videotoolbox.h
| | imgutils.h
| | intfloat.h
| | intreadwrite.h
| | lfg.h
| | log.h
| | lzo.h
| | macros.h
| | mastering_display_metadata.h
| | mathematics.h
| | md5.h
| | mem.h
| | motion_vector.h
| | murmur3.h
| | opt.h
| | parseutils.h
| | pixdesc.h
| | pixelutils.h
| | pixfmt.h
| | random_seed.h
| | rational.h
| | rc4.h
| | replaygain.h
| | ripemd.h
| | samplefmt.h
| | sha.h
| | sha512.h
| | spherical.h
| | stereo3d.h
| | tea.h
| | threadmessage.h
| | time.h
| | timecode.h
| | timestamp.h
| | tree.h
| | twofish.h
| | tx.h
| | version.h
| | xtea.h
| |
| +---libpostproc
| | postprocess.h
| | version.h
| |
| +---libswresample
| | swresample.h
| | version.h
| |
| \---libswscale
| swscale.h
| version.h
|
+---dll
| avcodec-58.dll
| avdevice-58.dll
| avfilter-7.dll
| avformat-58.dll
| avutil-56.dll
| postproc-55.dll
| swresample-3.dll
| swscale-5.dll
|
\---lib
avcodec.lib
avdevice.lib
avfilter.lib
avformat.lib
avutil.lib
postproc.lib
swresample.lib
swscale.lib在计算机网络上，OpenSSL是一个开放源代码的软件库包，应用程序可以使用这个包来进行安全通信，避免窃听，同时确认另一端连线者的身份。这个包广泛被应用在互联网的网页服务器上。[21]
一些程序是在运行时加载 OpenSSL 库（是只要包含QT += network便在启动时加载，还是仅在进行 HTTPS 访问时？），因此并不能通过 lucasg/Dependencies 等类似工具在程序的导入表中找到相关的信息，但这些程序（例如 BesLyric-for-X ）的确需要它们。
Qt 5 使用的 TLS 实现默认为 OpenSSL ，无法使用 Windows 的 Schannel SSP [23][24][25]。
由于某些国家和地区的法律对密码学的限制[14][22]， Qt 不能（通过windeployqt等途径）将 OpenSSL 一并交付[13]，所以需要开发者自行编译，或者从第三方获得 OpenSSL 库的二进制文件，并将其添加到输出文件夹下[16]。
Qt for Windows 与 OpenSSL 的版本兼容关系如下表（点击展开）：
注意：出现“更高版本” Qt 使用更低版本 OpenSSL ，是因为同时有多个分支的 Qt 在进行开发。
| Qt for Windows | OpenSSL |
|---|---|
| ~5.2 | Unknown |
| 5.3.0 | 1.0.1g |
| 5.4.0 | 1.0.1j |
| 5.5 | 1.0.2 |
| 5.6.0 LTS for Windows 7 X86 and Windows 8.1 X64 | 1.0.1e[15] |
| 5.6.0 LTS for other Windows | 1.0.2d |
| 5.6.1 LTS | 1.0.2g |
| 5.8 | 1.0.2h |
| 5.9.1 LTS for Windows 10 X64 | 1.0.2j |
| 5.9.2 LTS for Windows 8.1 X64 | 1.0.2j |
| 5.9.3 LTS for Windows 7 X86 and Windows 8.1 X86 | 1.0.2j |
| 5.9.6 LTS | 1.0.2j |
| 5.10.0 for Windows 10 X86 | 1.0.2h |
| 5.11.3 | 1.0.2p |
| 5.12.9 LTS | 1.1.1d |
| 5.13.0 | 1.1.1b |
| 5.14 | 1.1.1b |
| 5.15 LTS | 1.1.1d |
Binaries - OpenSSLWiki 上有一个表格，包含一些提供预编译的 OpenSSL 库文件的第三方网站的链接。为了避免 OpenSSL 库本身的依赖所造成的问题（例如 BesLyric-for-X#27 ），同时结合库文件的获取难易程度，经过对比，最终选择了用于 ICS 项目的 OpenSSL 库文件。
注意：使用这些 OpenSSL 衍生产品，后果自负。这些产品尚未经过 OpenSSL 项目的评估或测试。[11]
OpenSSL 的 1.0 与 1.1 版本并非二进制兼容[12]，本项目仅使用 OpenSSL 1.1 。
- 下载用于 64 位 Windows 的 OpenSSL ；
- 对于动态库文件，从压缩包中提取
libcrypto-1_1-x64.dll和libssl-1_1-x64.dll文件到%B4X_DEP_PATH%\win64\bin\下。
完整的 OpenSSL 1.1 库文件的文件夹结构如下（点击展开）：
> tree /A /F %B4X_DEP_PATH%
%B4X_DEP_PATH%
\---bin
libcrypto-1_1-x64.dll
libssl-1_1-x64.dll使用 lucasg/Dependencies 查看依赖（点击展开）：
> Dependencies_x64_Release_22298477> .\Dependencies.exe -imports %B4X_DEP_PATH%\dll\libcrypto-1_1-x64.dll
[-] Import listing for file : %B4X_DEP_PATH%\dll\libcrypto-1_1-x64.dll
Import from module WS2_32.dll :
...
Import from module ADVAPI32.dll :
...
Import from module USER32.dll :
...
Import from module bcrypt.dll :
...
Import from module KERNEL32.dll :
...
[-] Import listing done
> Dependencies_x64_Release_22298477> .\Dependencies.exe -imports %B4X_DEP_PATH%\dll\libssl-1_1-x64.dll
[-] Import listing for file : %B4X_DEP_PATH%\dll\libssl-1_1-x64.dll
Import from module libcrypto-1_1-x64.dll :
...
Import from module KERNEL32.dll :
...
[-] Import listing done- ^ 在 Windows 10 1809 上进行调试时输出大量
Invalid parameter passed to C runtime function.的问题。
https://blog.csdn.net/u014132751/article/details/91876385
https://bugreports.qt.io/browse/QTBUG-70917
https://developercommunity.visualstudio.com/content/problem/363323/getadaptersaddresses-invalid-parameter-passed-to-c.html
https://blog.csdn.net/u014132751/article/details/91876385 - ^ Windows 10 的生命周期。
https://docs.microsoft.com/windows/release-information/ - ^ Visual Studio 的生命周期。
https://docs.microsoft.com/visualstudio/releases/2019/servicing#support-for-older-versions-of-visual-studio - ^ Qt 5 的生命周期。
https://en.wikipedia.org/wiki/Qt_version_history#Qt_5 - ^ C++ 二进制兼容性 (2015-2019)。
https://docs.microsoft.com/cpp/porting/binary-compat-2015-2017 - ^ Qt Visual Studio Tools - Visual Studio Marketplace
https://marketplace.visualstudio.com/items?itemName=TheQtCompany.QtVisualStudioTools2019 - ^ 使用 Visual Studio Installer 进行命令行安装。
https://docs.microsoft.com/visualstudio/install/use-command-line-parameters-to-install-visual-studio
https://docs.microsoft.com/visualstudio/install/workload-component-id-vs-community - ^ The debugger that comes with Debugging Tools for Windows goes by the name WinDbg, short for Windows Debugger, and generally pronounced win-debug or win-dee-bee-gee. It’s part of a suite of lightweight debuggers, along with
ntsd(short for NT Symbolic Debugger) andcdb(Console Debugger), which are all based on the same debugging engine, creatively namedDbgEng...
How do you pronounce WinDbg? | The Old New Thing
https://devblogs.microsoft.com/oldnewthing/20200128-00/?p=103371 - ^ Microsoft Windows SDK - Wikipedia
https://en.wikipedia.org/wiki/Microsoft_Windows_SDK - ^ Qt Tools and Versions & MSVC 2019 | Qt Forum
https://forum.qt.io/topic/104123/qt-tools-and-versions-msvc-2019 - ^ Use these OpenSSL derived products at your own risk; these products have not been evaluated or tested by the OpenSSL project.
Binaries - OpenSSLWiki
https://wiki.openssl.org/index.php/Binaries - ^ ...Unfortunately OpenSSL 1.1 is binary incompatible with 1.0, so users need to switch to the new one and repackage their applications...
Qt 5.12.4 Released with support for OpenSSL 1.1.1
https://www.qt.io/blog/2019/06/17/qt-5-12-4-released-support-openssl-1-1-1 - ^ ...It's not handled because by default, OpenSSL is dlopened and Qt doesn't ship OpenSSL because of international laws about cryptographic software...
How to properly include openssl for a windows deployment when using mingw? | Qt Forum
https://forum.qt.io/topic/86420/how-to-properly-include-openssl-for-a-windows-deployment-when-using-mingw/2
By default Qt is build to dlopen the OpenSSL dlls. This allows Qt to be build to support cryptographie while letting the developer handle all related paperwork for its application to be distributed (different countries have different rules regarding cryptographically enabled software).
Windows and OpenSSL Woes | Qt Forum
https://forum.qt.io/topic/91255/windows-and-openssl-woes/12 - ^ Legal Restrictions on Cryptography - Web Security, Privacy & Commerce, 2nd Edition [Book]
https://www.oreilly.com/library/view/web-security-privacy/0596000456/ch04s04.html - ^ The affected versions of OpenSSL are OpenSSL 1.0.1 through 1.0.1f (inclusive). Subsequent versions (1.0.1g and later) and previous versions (1.0.0 branch and older) are not vulnerable...
Affected OpenSSL installations # Heartbleed - Wikipedia
https://en.wikipedia.org/wiki/Heartbleed#Affected_OpenSSL_installations - ^ The application may require additional 3rd-party libraries (for example, database libraries), which are not taken into account by windeployqt...If Qt was configured to link against ICU or OpenSSL, the respective DLL's need to be added to the release folder, too.
Qt for Windows - Deployment | Qt 5.14
https://doc.qt.io/qt-5/windows-deployment.html#creating-the-application-package - ^ git - 维基百科，自由的百科全书
https://zh.wikipedia.org/wiki/Git - ^ SDL - 维基百科，自由的百科全书
https://zh.wikipedia.org/wiki/SDL - ^ FFmpeg首页、文档和下载 - 多媒体处理工具 - OSCHINA
https://www.oschina.net/p/ffmpeg - ^ Windows 10 development targeting Windows 10, version 2004 (or later) requires Visual Studio 2017 (or later). This SDK will not be discovered by previous versions of Visual Studio.
Windows 10 SDK - Windows app development
https://developer.microsoft.com/windows/downloads/windows-10-sdk/ - ^ OpenSSL - 维基百科，自由的百科全书
https://zh.wikipedia.org/wiki/OpenSSL - ^ OpenSSL # Qt 5.15.0 Known Issues - Qt Wiki
https://wiki.qt.io/Qt_5.15.0_Known_Issues#OpenSSL - ^ [QTBUG-62637] [Windows]: Add support for using Secure Channel for SSL sockets - Qt Bug Tracker
https://bugreports.qt.io/browse/QTBUG-62637 - ^ Windows: Secure Channel support for SSL socket (QTBUG-62637)
New Features in Qt 5.13 - Qt Wiki
https://wiki.qt.io/New_Features_in_Qt_5.13 - ^ [QTBUG-82876] [Windows]: Switch default builds to use Secure Channel for SSL sockets - Qt Bug Tracker
https://bugreports.qt.io/browse/QTBUG-82876 - ^ How to Find Your Windows 10 Build Number, Version, Edition and Bitness
https://www.winhelponline.com/blog/find-windows-10-build-version-edition-bit/ - ^ Windows: Get Windows Feature Version/Release ID
https://michlstechblog.info/blog/windows-get-windows-feature-version-release-id/
- https://doc.qt.io/qt-5/windows.html
- https://stackoverflow.com/questions/47773289/debugging-in-qtcreator-using-msvc2017-compiler
- 本文档在 VSCode 上使用 Markdown All in One 辅助编辑；
- 本文档中嵌套表格使用 HTML Table generator - TablesGenerator.com 辅助编辑。