update: Action build type to MinSizeRel

use cxxopts library to parse command line options

.github/ISSUE_TEMPLATE/bug_report.md

@@ -1,25 +1,21 @@
 ---
 name: "[请按照此模板填写] 报告 Bug"
-about: "创建一个 Bug 报告，不按照模板的 Issue 会被关闭。"
+about: "创建一个 Bug 报告，不按照模板的 Issue 会被直接关闭，不予回复。"
 title: "[Bug] 总结你的 Bug 报告"
 labels: bug
 assignees: taurusxin
 ---
 
 **Bug 描述**
-清晰地描述一下 Bug 的大致问题。
+
+清晰地描述一下 Bug 的大致问题，例如无法转换，或者其他问题。
 
 **复现方法**
 
 复现此 Bug 的方法
 
-1. 打开 '...'
-2. 点击 '....'
-3. 发生报错
-
-**预期行为**
-
-解释一下原本应该出现的结果。
+1. 使用本项目处理文件 '...'
+2. 发生报错
 
 **屏幕截图**
 
@@ -27,9 +23,10 @@ assignees: taurusxin
 
 **环境**
 
-- OS: [e.g. Windows 11]
-- 软件版本: [e.g. 1.3.2]
+- 操作系统: Windows / macOS / Linux
+- 网易云版本（重要）: [e.g. 3.0.1]
+- 所选择的音质: 极高、无损等
 
 **附加内容**
 
-添加更多其他内容以帮助开发者更好地了解这个 Bug。
+如果遇到无法转换的问题，请将样本附加到这里，便于分析。

.github/workflows/autobuild.yml

@@ -1,6 +1,6 @@
 name: CI
 env:
-  BUILD_TYPE: Release
+  BUILD_TYPE: MinSizeRel
   BUILD_PATH: build
 on:
   push:

.gitignore

@@ -5,3 +5,5 @@ ncmdump
 .idea
 
 build
+
+cmake-build-*

README.md

@@ -36,16 +36,41 @@ brew install ncmdump
 ncmdump -h
 ```
 
-命令行下输入一个或多个文件
+使用 `-v` 或 `--version` 参数来打印版本信息
 
 ```shell
-ncmdump file1 file2...
+ncmdump -v
 ```
 
-你可以使用 `-d` 参数来指定一个文件夹，对文件夹下的所有文件批量处理
+处理单个或多个文件
 
 ```shell
-ncmdump -d folder
+ncmdump 1.ncm 2.ncm...
+```
+
+使用 `-d` 参数来指定一个文件夹，对文件夹下的所有以 ncm 为扩展名的文件进行批量处理
+
+```shell
+ncmdump -d source_dir
+```
+
+使用 `-r` 配合 `-d` 参数来递归处理文件夹下的所有以 ncm 为扩展名的文件
+
+```shell
+ncmdump -d source_dir -r
+```
+
+使用 `-o` 参数来指定输出目录，将转换后的文件输出到指定目录，该参数支持与 `-r` 参数一起使用
+
+```shell
+# 处理单个或多个文件并输出到指定目录
+ncmdump 1.ncm 2.ncm -o output_dir
+
+# 处理文件夹下的所有以 ncm 为扩展名并输出到指定目录，不包含子文件夹
+ncmdump -d source_dir -o output_dir
+
+# 递归处理文件夹并输出到指定目录，并保留目录结构
+ncmdump -d source_dir -o output_dir -r
 ```
 
 ### 动态库

example/csharp/NeteaseCrypt.cs

@@ -14,7 +14,7 @@ namespace libncmdump_demo_cli
         private static extern IntPtr CreateNeteaseCrypt(IntPtr path);
 
         [DllImport(DLL_PATH, CallingConvention = CallingConvention.Cdecl)]
-        private static extern int Dump(IntPtr NeteaseCrypt);
+        private static extern int Dump(IntPtr NeteaseCrypt, IntPtr outputPath);
 
         [DllImport(DLL_PATH, CallingConvention = CallingConvention.Cdecl)]
         private static extern void FixMetadata(IntPtr NeteaseCrypt);
@@ -42,10 +42,17 @@ namespace libncmdump_demo_cli
         /// <summary>
         /// 启动转换过程。
         /// </summary>
+        /// <param name="OutputPath">指定一个路径输出，如果为空，则输出到原路径</param>
         /// <returns>返回一个整数，指示转储过程的结果。如果成功，返回0；如果失败，返回1。</returns>
-        public int Dump()
+        public int Dump(string OutputPath)
         {
-            return Dump(NeteaseCryptClass);
+            byte[] bytes = Encoding.UTF8.GetBytes(OutputPath);
+
+            IntPtr outputPtr = Marshal.AllocHGlobal(bytes.Length + 1);
+            Marshal.Copy(bytes, 0, outputPtr, bytes.Length);
+            Marshal.WriteByte(outputPtr, bytes.Length, 0);
+
+            return Dump(NeteaseCryptClass, outputPtr);
         }
 
         /// <summary>

example/csharp/Program.cs

@@ -14,7 +14,7 @@ namespace libncmdump_demo_cli
             NeteaseCrypt neteaseCrypt = new NeteaseCrypt(filePath);
 
             // 启动转换过程
-            int result = neteaseCrypt.Dump();
+            int result = neteaseCrypt.Dump("");  // 为空则输出到源
 
             // 修复元数据
             neteaseCrypt.FixMetadata();

src/include/ncmcrypt.h

@@ -47,7 +47,7 @@ private:
 	NcmFormat mFormat;
 	std::string mImageData;
 	std::ifstream mFile;
-	unsigned char mKeyBox[256];
+	unsigned char mKeyBox[256]{};
 	NeteaseMusicMetadata* mMetaData;
 
 private:
@@ -66,6 +66,6 @@ public:
 	~NeteaseCrypt();
 
 public:
-	void Dump();
+	void Dump(std::string const&);
 	void FixMetadata();
 };

src/include/version.h

@@ -0,0 +1,3 @@
+#define VERSION_MAJOR 1
+#define VERSION_MINOR 5
+#define VERSION_PATCH 0

src/lib/libncmdump.cpp

@@ -9,10 +9,10 @@ extern "C" {
         return new NeteaseCrypt(fPath.u8string());
     }
 
-    API int Dump(NeteaseCrypt* neteaseCrypt) {
+    API int Dump(NeteaseCrypt* neteaseCrypt, const char* outputPath) {
         try
         {
-            neteaseCrypt->Dump();
+            neteaseCrypt->Dump(outputPath);
         }
         catch (const std::invalid_argument& e)
         {

src/lib/libncmdump.h

@@ -8,7 +8,7 @@
 
 extern "C" {
     API NeteaseCrypt* CreateNeteaseCrypt(const char* path);
-    API int Dump(NeteaseCrypt* neteaseCrypt);
+    API int Dump(NeteaseCrypt* neteaseCrypt, const char* outputPath);
     API void FixMetadata(NeteaseCrypt* neteaseCrypt);
     API void DestroyNeteaseCrypt(NeteaseCrypt* neteaseCrypt);
 }

src/main.cpp

@@ -10,115 +10,207 @@
 #endif
 
 #include "color.h"
+#include "version.h"
+#include "cxxopts.hpp"
 
 namespace fs = std::filesystem;
 
-void displayHelp()
-{
-    std::cout << "Usage: ncmdump [-d] [-h] file1 file2 ..." << std::endl;
-    std::cout << "Options:" << std::endl;
-    std::cout << "  -d               Process files in a folder (requires folder path)" << std::endl;
-    std::cout << "  -h, --help       Display this help message" << std::endl;
-}
-
-void processFile(const fs::path &filePath)
+void processFile(const fs::path &filePath, const fs::path &outputFolder)
 {
     if (fs::exists(filePath) == false)
     {
-        std::cerr << BOLDRED << "Error: " << RESET << "file '" << filePath.u8string() << "' does not exist." << std::endl;
+        std::cerr << BOLDRED << "[Error] " << RESET << "file '" << filePath.u8string() << "' does not exist." << std::endl;
+        return;
+    }
+
+    // skip if not ending with ".ncm"
+    if (!filePath.has_extension() || filePath.extension().u8string() != ".ncm")
+    {
         return;
     }
 
     try
     {
         NeteaseCrypt crypt(filePath.u8string());
-        crypt.Dump();
+        crypt.Dump(outputFolder.u8string());
         crypt.FixMetadata();
 
         std::cout << BOLDGREEN << "[Done] " << RESET << "'" << filePath.u8string() << "' -> '" << crypt.dumpFilepath().u8string() << "'" << std::endl;
     }
     catch (const std::invalid_argument &e)
     {
-        std::cerr << BOLDRED << "Exception: " << RESET << RED << e.what() << RESET << " '" << filePath.u8string() << "'" << std::endl;
+        std::cerr << BOLDRED << "[Exception] " << RESET << RED << e.what() << RESET << " '" << filePath.u8string() << "'" << std::endl;
     }
     catch (...)
     {
-        std::cerr << BOLDRED << "Unexpected exception while processing file: " << RESET << filePath.u8string() << std::endl;
-    }
-}
-
-void processFilesInFolder(const fs::path &folderPath)
-{
-    for (const auto &entry : fs::directory_iterator(folderPath))
-    {
-        if (fs::is_regular_file(entry.status()))
-        {
-            processFile(entry.path());
-        }
+        std::cerr << BOLDRED << "[Error] Unexpected exception while processing file: " << RESET << filePath.u8string() << std::endl;
     }
 }
 
 int main(int argc, char **argv)
 {
 #if defined(_WIN32)
-    win32_utf8argv(&argc, &argv);
+    win32_utf8argv(&argc, &argv); // Convert command line arguments to UTF-8 under Windows
 #endif
-    if (argc <= 1)
-    {
-        displayHelp();
+
+    cxxopts::Options options("ncmdump");
+
+    options.add_options()
+    ("h,help", "Print usage")
+    ("d,directory", "Process files in a folder (requires folder path)", cxxopts::value<std::string>())
+    ("r,recursive", "Process files recursively (requires -d option)", cxxopts::value<bool>()->default_value("false"))
+    ("o,output", "Output folder (default: original file folder)", cxxopts::value<std::string>())
+    ("v,version", "Print version information", cxxopts::value<bool>()->default_value("false"))
+    ("filenames", "Input files", cxxopts::value<std::vector<std::string>>());
+
+    options.positional_help("<files>");
+
+    options.parse_positional({"filenames"});
+
+    options.allow_unrecognised_options();
+
+    // Parse options the usual way
+    cxxopts::ParseResult result;
+    try {
+        result = options.parse(argc, argv);
+    } catch(cxxopts::exceptions::parsing const& e) {
+        std::cout << options.help() << std::endl;
         return 1;
     }
 
-    std::vector<fs::path> files;
-    bool processFolders = false;
-
-    bool folderProvided = false;
-
-#define COMPARE_STR(s1, s2) (strcmp(s1, s2) == 0)
-#define HELP_SHORT "-h"
-#define HELP_LONG "--help"
-#define PROCESS_FOLDER "-d"
-    for (int i = 1; i < argc; ++i)
+    // print usage message if unrecognised options are present
+    if (result.unmatched().size() > 0)
     {
-        if (COMPARE_STR(argv[i], HELP_SHORT) || COMPARE_STR(argv[i], HELP_LONG))
+        std::cout << options.help() << std::endl;
+        return 1;
+    }
+
+    // display help message
+    if (result.count("help"))
+    {
+        std::cout << options.help() << std::endl;
+        return 0;
+    }
+
+    // display version information
+    if (result.count("version"))
+    {
+        std::cout << "ncmdump version " << VERSION_MAJOR << "." << VERSION_MINOR << "." << VERSION_PATCH << std::endl;
+        return 0;
+    }
+
+    // no input files or folder provided
+    if (result.count("directory") == 0 && result.count("filenames") == 0)
+    {
+        std::cout << options.help() << std::endl;
+        return 1;
+    }
+
+    // only -r option without -d option
+    if (result.count("recursive") && result.count("directory") == 0)
+    {
+        std::cerr << BOLDRED << "[Error] " << RESET << "-r option requires -d option." << std::endl;
+        return 1;
+    }
+
+    // check output folder
+    fs::path outputDir = fs::u8path("");
+    bool outputDirSpecified = result.count("output") > 0;
+
+    if (outputDirSpecified)
+    {
+        outputDir = fs::u8path(result["output"].as<std::string>());
+        if (fs::exists(outputDir))
         {
-            displayHelp();
-            return 0;
-        }
-        else if (COMPARE_STR(argv[i], PROCESS_FOLDER))
-        {
-            processFolders = true;
-            if (i + 1 < argc && argv[i + 1][0] != '-')
+            if (!fs::is_directory(outputDir))
             {
-                folderProvided = true;
-                processFilesInFolder(fs::u8path(argv[i + 1]));
-                // Skip the folder name
-                ++i;
-            }
-            else
-            {
-                std::cerr << "Error: -d option requires a folder path." << std::endl;
+                std::cerr << BOLDRED << "[Error] " << RESET << "'" << outputDir.u8string() << "' is not a valid directory." << std::endl;
                 return 1;
             }
         }
-        else
-        {
-            fs::path path = fs::u8path(argv[i]);
-            files.push_back(path);
-        }
+        fs::create_directories(outputDir);
     }
 
-    for (const auto &file : files)
+    // process files in a folder
+    if (result.count("directory"))
     {
-        if (processFolders && fs::is_directory(file))
+        fs::path sourceDir = fs::u8path(result["directory"].as<std::string>());
+        if (!fs::is_directory(sourceDir))
         {
-            processFilesInFolder(file);
+            std::cerr << BOLDRED << "[Error] " << RESET << "'" << sourceDir.u8string() << "' is not a valid directory." << std::endl;
+            return 1;
+        }
+
+        bool recursive = result["recursive"].as<bool>();
+
+        if (recursive)
+        {
+            // 递归遍历源目录
+            for (const auto &entry : fs::recursive_directory_iterator(sourceDir))
+            {
+                // 没有指定输出目录，则使用源目录作为输出目录
+                if (!outputDirSpecified)
+                {
+                    outputDir = sourceDir;
+                }
+
+                // 获得递归遍历的相对路径
+                const auto &path = fs::u8path(entry.path().u8string());
+                auto relativePath = fs::relative(path, sourceDir);
+                fs::path destinationPath = outputDir / relativePath;
+
+                if (fs::is_regular_file(path))
+                {
+                    // 确保输出文件的目录存在
+                    fs::create_directories(destinationPath.parent_path());
+
+                    // 处理文件
+                    processFile(path, destinationPath.parent_path());
+                }
+            }
         }
         else
         {
-            processFile(file);
+            for (const auto &entry : fs::directory_iterator(sourceDir))
+            {
+                const auto &path = fs::u8path(entry.path().u8string());
+                if (entry.is_regular_file())
+                {
+                    if (outputDirSpecified)
+                    {
+                        processFile(path, outputDir);
+                    }
+                    else
+                    {
+                        processFile(path, "");
+                    }
+                }
+            }
         }
+        return 0;
     }
 
+    // process individual files
+    if (result.count("filenames"))
+    {
+        for (const auto &filePath : result["filenames"].as<std::vector<std::string>>())
+        {
+            fs::path filePathU8 = fs::u8path(filePath);
+            if (!fs::is_regular_file(filePathU8))
+            {
+                std::cerr << BOLDRED << "[Error] " << RESET << "'" << filePathU8.u8string() << "' is not a valid file." << std::endl;
+                continue;
+            }
+
+            if (outputDirSpecified)
+            {
+                processFile(filePathU8, outputDir);
+            }
+            else
+            {
+                processFile(filePathU8, "");
+            }
+        }
+    }
     return 0;
 }

src/ncmcrypt.cpp

@@ -16,6 +16,9 @@
 #include <string>
 #include <filesystem>
 
+#pragma warning(disable:4267)
+#pragma warning(disable:4244)
+
 const unsigned char NeteaseCrypt::sCoreKey[17] = {0x68, 0x7A, 0x48, 0x52, 0x41, 0x6D, 0x73, 0x6F, 0x35, 0x6B, 0x49, 0x6E, 0x62, 0x61, 0x78, 0x57, 0};
 const unsigned char NeteaseCrypt::sModifyKey[17] = {0x23, 0x31, 0x34, 0x6C, 0x6A, 0x6B, 0x5F, 0x21, 0x5C, 0x5D, 0x26, 0x30, 0x55, 0x3C, 0x27, 0x28, 0};
 
@@ -221,7 +224,7 @@ void NeteaseCrypt::FixMetadata()
         audioFile = new TagLib::MPEG::File(mDumpFilepath.c_str());
         tag = dynamic_cast<TagLib::MPEG::File *>(audioFile)->ID3v2Tag(true);
 
-        if (mImageData.length() > 0)
+        if (!mImageData.empty())
         {
             TagLib::ID3v2::AttachedPictureFrame *frame = new TagLib::ID3v2::AttachedPictureFrame;
 
@@ -236,7 +239,7 @@ void NeteaseCrypt::FixMetadata()
         audioFile = new TagLib::FLAC::File(mDumpFilepath.c_str());
         tag = audioFile->tag();
 
-        if (mImageData.length() > 0)
+        if (!mImageData.empty())
         {
             TagLib::FLAC::Picture *cover = new TagLib::FLAC::Picture;
             cover->setMimeType(mimeType(mImageData));
@@ -254,15 +257,20 @@ void NeteaseCrypt::FixMetadata()
         tag->setAlbum(TagLib::String(mMetaData->album(), TagLib::String::UTF8));
     }
 
-    tag->setComment(TagLib::String("Create by taurusxin/ncmdump.", TagLib::String::UTF8));
+    // tag->setComment(TagLib::String("Create by taurusxin/ncmdump.", TagLib::String::UTF8));
 
     audioFile->save();
     audioFile->~File();
 }
 
-void NeteaseCrypt::Dump()
+void NeteaseCrypt::Dump(std::string const &outputDir = "")
 {
-    mDumpFilepath = std::filesystem::u8path(mFilepath);
+    if (outputDir.empty())
+    {
+        mDumpFilepath = std::filesystem::u8path(mFilepath);
+    } else {
+        mDumpFilepath = std::filesystem::u8path(outputDir) / std::filesystem::u8path(mFilepath).filename();
+    }
 
     std::vector<unsigned char> buffer(0x8000);
 
@@ -293,7 +301,7 @@ void NeteaseCrypt::Dump()
                 mFormat = NeteaseCrypt::FLAC;
             }
 
-            output.open(mDumpFilepath, output.out | output.binary);
+            output.open(mDumpFilepath, std::ofstream::out | std::ofstream::binary);
         }
 
         output.write((char *)buffer.data(), n);

taglib

@@ -1 +1 @@
-Subproject commit 0896fb90920c125e55248360d271d1a1674e2a4d
+Subproject commit e3de03501ff66221d1f1f971022b248d5b38ba06