Merge pull request #1 from HR1025/private/dev

HR1025 · web-flow · commit f50f19df895c · 2024-09-06T19:00:33.000+08:00
[what][feture] 添加 test_gl_compositor 用例
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -15,4 +15,4 @@ jobs:
       - run : rm -rf build
       - run : mkdir build
       - run : git submodule update --init --recursive
-      - run : cd build && cmake .. -DUSE_OPENGL=ON -DUSE_EGL=ON -DUSE_GBM=ON -DUSE_SDL=ON -DUSE_SPRIV_CROSS=ON -DUSE_VULKAN=ON -DUSE_X11=ON -DUSE_VAAPI=ON -DUSE_OPENH264=ON && make -j4
+      - run : cd build && cmake .. -DUSE_OPENGL=ON -DUSE_GBM=ON -DUSE_SDL=ON -DUSE_SPRIV_CROSS=ON -DUSE_VULKAN=ON -DUSE_X11=ON -DUSE_VAAPI=ON -DUSE_OPENH264=ON && make -j4
diff --git a/.vscode/launch.json b/.vscode/launch.json
@@ -0,0 +1,25 @@
+{
+    "version": "0.2.0",
+    "configurations": [
+        {
+            "name": "test_gl_compositor",
+            "type": "cppdbg",
+            "request": "launch",
+            "program": "${workspaceFolder}/build/test_gl_compositor",
+            "args": [
+            ],
+            "stopAtEntry": false,
+            "cwd": "${workspaceFolder}",
+            "environment": [],
+            "externalConsole": false,
+            "MIMode": "gdb",
+            "setupCommands": [
+                {
+                    "description": "为 gdb 启用整齐打印",
+                    "text": "-enable-pretty-printing",
+                    "ignoreFailures": true
+                }
+            ]
+        }
+    ]
+}
diff --git a/CMakeLists.txt b/CMakeLists.txt
@@ -12,9 +12,10 @@ list(APPEND MMP_SAMPLE_INCS
 )
 
 list(APPEND MMP_SAMPLE_SRCS
-    ${CMAKE_CURRENT_SOURCE_DIR}/PngA.c
-    ${CMAKE_CURRENT_SOURCE_DIR}/PngB.c
-    ${CMAKE_CURRENT_SOURCE_DIR}/AbstractDisplay.cpp
+    ${CMAKE_CURRENT_SOURCE_DIR}/source/PngA.c
+    ${CMAKE_CURRENT_SOURCE_DIR}/source/PngB.c
+    ${CMAKE_CURRENT_SOURCE_DIR}/source/AbstractDisplay.cpp
+    ${CMAKE_CURRENT_SOURCE_DIR}/source/SampleUtils.cpp
 )
 
 list(APPEND MMP_SAMPLE_LIBS
@@ -39,13 +40,14 @@ if (SDL2_FOUND)
     message("  -- SDL LIBS : ${SDL2_LIBRARIES}")
     list(APPEND MMP_SAMPLE_INCS ${SDL2_INCLUDE_DIRS})
     list(APPEND MMP_SAMPLE_SRCS
-        ${CMAKE_CURRENT_SOURCE_DIR}/DisplaySDL.cpp
+        ${CMAKE_CURRENT_SOURCE_DIR}/source/DisplaySDL.cpp
     )
     list(APPEND MMP_SAMPLE_LIBS ${SDL2_LIBRARIES})
     add_definitions(-DSAMPLE_WITH_SDL)
 endif()
 
 add_subdirectory(Core)
 
-add_executable(test_gl_compositor ${CMAKE_CURRENT_SOURCE_DIR}/test_gl_compositor.cpp)
-target_link_libraries(test_gl_compositor ${MMP_SAMPLE_LIBS})
+add_executable(test_gl_compositor ${MMP_SAMPLE_SRCS} ${CMAKE_CURRENT_SOURCE_DIR}/test_gl_compositor.cpp)
+target_link_libraries(test_gl_compositor ${MMP_SAMPLE_LIBS})
+target_include_directories(test_gl_compositor PUBLIC ${MMP_SAMPLE_INCS})
diff --git a/Core b/Core
@@ -1 +1 @@
-Subproject commit 9a1a589b557dc60faf59a88a7e8ad8d0f43e1922
+Subproject commit ff610dcd4ce7373ae3000839ff51885116e04017
diff --git a/README.md b/README.md
@@ -1 +1,63 @@
-# mmp_sample
+# README
+
+简体中文
+
+## 简介
+
+`mmp_sample` 提供 [MMP-Core](https://github.com/HR1025/MMP-Core) 一些接口的使用方法, 示例以单独 *main.cpp* 展示.
+
+也就是说, 不用特意去关注 `include` 和 `source` 下的代码, 都是一些简单的辅助接口.
+
+更进一步, 只需要关心 `xxx.cpp` 中的 `int App::main(const ArgVec& args)` 实现.
+
+示例都集中在项目的根目录, 以 `xxx.cpp` 命名; `.cpp` 的名称即为对应用例可执行程序名称.
+
+## 编译
+
+### Linux (Debian System)
+
+```shell
+sudo apt install libgbm-dev libsdl2-dev libgl1-mesa-dev* nasm libx11-dev libdrm-dev libva-dev
+rm -rf build
+mkdir build
+git submodule update --init --recursive
+cd build && cmake .. -DUSE_OPENGL=ON -DUSE_GBM=ON -DUSE_SDL=ON -DUSE_SPRIV_CROSS=ON -DUSE_VULKAN=ON -DUSE_X11=ON -DUSE_VAAPI=ON -DUSE_OPENH264=ON && make -j4
+```
+
+## 如何调试
+
+选择一个能与 `CMake` 结合的 `IDE` 工具即可, `demo` 附带了 `vscode` 使用的 `launch.json`.
+
+## 用例
+
+>
+> 详细的配置可以通过 `-h` 进行查看.
+>  
+
+### test_gl_compositor
+
+`test_gl_compositor` 展示了如何实现多画面合成的效果, `MMP-Core` 定义了三个术语 `Item` 、`Layer` 及 `Compositor`;
+
+多个 `Item` 可以被添加入同一个 `Layer`, 需要保证其互不相交;
+
+多个 `Layer` 可以被添加入同一个 `Compositor`, 从而实现画面合成的功能.
+
+`test_gl_compositor` 支持一些配置项, 如下:
+
+- backend : 处理节点, 可能可选 OPENGL, OPENGL_ES, D3D11 和 VULKAN
+- split_num : 分屏数量, 如默认为 4, 会显示四分屏的效果
+- frame_per_second : 刷新帧率, 默认 60 帧
+- merry_go_around : 跑马灯效果, 按照每秒 2 帧的速度移动画面
+- duration : 持续时间, 单位为 s
+
+效果图:
+
+![test_gl_compositor](./images/test_gl_compositor.png)
+
+## 其他
+
+在不同的平台上, 或者不同的驱动上, 相同的测试用例可能出现不同的效果, 或者更严重点甚至无法运行或者崩溃.
+
+这是由于跨平台和驱动所相关的兼容性问题, 难以在开发阶段发现并处理, 或者就是 `MMP-Core` 程序本身的逻辑错误.
+
+一般来说简易的兼容性问题经过自己简单的定位以及修改, 基本上还是可以让程序运行起来的.
diff --git a/images/test_gl_compositor.png b/images/test_gl_compositor.png
diff --git a/include/SampleUtils.h b/include/SampleUtils.h
@@ -0,0 +1,17 @@
+#pragma once
+
+#include <string>
+
+#include "Common/AbstractPicture.h"
+#include "GPU/GL/GLCommon.h"
+
+namespace Mmp
+{
+
+AbstractPicture::ptr GetFrame1920x1080A();
+
+AbstractPicture::ptr GetFrame1920x1080B();
+
+GPUBackend GetGPUBackend(const std::string& str);
+
+} // namespace Mmp
diff --git a/source/AbstractDisplay.cpp b/source/AbstractDisplay.cpp
@@ -3,7 +3,7 @@
 #include <vector>
 
 #ifdef SAMPLE_WITH_SDL
-    #include "SDL/DisplaySDL.h"
+    #include "DisplaySDL.h"
 #endif /* SAMPLE_WITH_SDL */
 
 namespace Mmp
diff --git a/source/DisplaySDL.cpp b/source/DisplaySDL.cpp
@@ -198,18 +198,6 @@ void DisplaySDL::UpdateWindow(const uint32_t* frameBuffer, PixelsInfo info)
             SDL_UpdateTexture(_texture, NULL, reinterpret_cast<const void*>(frameBuffer), sizeof(uint32_t)*_windowWidth);
             break;
         }
-        case PixelFormat::NV12:
-        {
-            SDL_Rect rect;
-            {
-                rect.x = 0;
-                rect.y = 0;
-                rect.w = info.width;
-                rect.h = info.height;
-            }
-            SDL_UpdateNVTexture(_texture, &rect, (uint8_t*)frameBuffer, info.width, (uint8_t*)frameBuffer + info.width * info.height, info.width);
-            break;
-        }
         default:
         {
             return;
diff --git a/source/SampleUtils.cpp b/source/SampleUtils.cpp
@@ -0,0 +1,95 @@
+#include "SampleUtils.h"
+
+#include <cstring>
+#include <memory.h>
+
+#include "GPU/GL/GLCommon.h"
+#include "Codec/CodecFactory.h"
+
+#include "PngA.h"
+#include "PngB.h"
+
+namespace Mmp
+{
+
+AbstractPicture::ptr GetFrame1920x1080A()
+{
+    using namespace Codec;
+    // 1 - Read compress data from png array
+    NormalPack::ptr pack = std::make_shared<NormalPack>(0);
+    pack->SetCapacity(sizeof(bin2c_A_png));
+    pack->SetSize((size_t)(sizeof(bin2c_A_png)));
+    memcpy(pack->GetData(), bin2c_A_png, sizeof(bin2c_A_png));
+    // 2 - decoder to pixel data
+    AbstractFrame::ptr frame;
+    {
+        auto pngDecoder = DecoderFactory::DefaultFactory().CreateDecoder("PngDecoder");
+        pngDecoder->Init();
+        pngDecoder->Start();
+        PngDecoderParameter parameter;
+        parameter.format = PixelFormat::RGBA8888;
+        pngDecoder->SetParameter(parameter);
+        pngDecoder->Push(pack);
+        if (!pngDecoder->Pop(frame))
+        {
+            assert(false);
+        }
+        pngDecoder->Stop();
+        pngDecoder->Uninit();
+    }
+    return std::dynamic_pointer_cast<AbstractPicture>(frame);
+}
+
+AbstractPicture::ptr GetFrame1920x1080B()
+{
+    using namespace Codec;
+    // 1 - Read compress data from png array
+    NormalPack::ptr pack = std::make_shared<NormalPack>(0);
+    pack->SetCapacity(sizeof(bin2c_B_png));
+    pack->SetSize((size_t)(sizeof(bin2c_B_png)));
+    memcpy(pack->GetData(), bin2c_B_png, sizeof(bin2c_B_png));
+    // 2 - decoder to pixel data
+    AbstractFrame::ptr frame;
+    {
+        auto pngDecoder = DecoderFactory::DefaultFactory().CreateDecoder("PngDecoder");
+        pngDecoder->Init();
+        pngDecoder->Start();
+        PngDecoderParameter parameter;
+        parameter.format = PixelFormat::RGBA8888;
+        pngDecoder->SetParameter(parameter);
+        pngDecoder->Push(pack);
+        if (!pngDecoder->Pop(frame))
+        {
+            assert(false);
+        }
+        pngDecoder->Stop();
+        pngDecoder->Uninit();
+    }
+    return std::dynamic_pointer_cast<AbstractPicture>(frame);
+}
+
+GPUBackend GetGPUBackend(const std::string& str)
+{
+    if ("OPENGL" == str)
+    {
+        return  GPUBackend::OPENGL;
+    }
+    else if ("OPENGL_ES" == str)
+    {
+        return GPUBackend::OPENGL_ES;
+    }
+    else if ("D3D11" == str)
+    {
+        return GPUBackend::D3D11;
+    }
+    else if ("VULKAN" == str)
+    {
+        return GPUBackend::VULKAN;
+    }
+    else
+    {
+        return GPUBackend::OPENGL;
+    }
+}
+
+} // namespace Mmp
diff --git a/test_gl_compositor.cpp b/test_gl_compositor.cpp
