obs studio node

libobs через привязки узлов

Эта библиотека предназначена для предоставления привязок к внутренней библиотеке obs-studio, называемой соответственно libobs, с целью использования ее из среды выполнения узла. В настоящее время поддерживаются только Windows и MacOS.

Здание

Предварительные условия

Вам необходимо будет установить следующее:

• Гит
• Node.js
• Пряжа
• CMake

Окна

Для сборки на Windows требуется дополнительное программное обеспечение:

• Visual Studio 2019 или 2022
• Windows SDK (может быть установлен с помощью установщика Visual Studio 2022)

Пример сборки

Мы используем гибкий сценарий cmake, который должен быть как можно более широким и универсальным, чтобы избежать необходимости постоянно управлять сценарием cmake для индивидуального использования, а также предоставлять разумные значения по умолчанию. Он соответствует довольно стандартному макету cmake, и вы можете выполнить его по своему усмотрению.

Пример:

 yarn install
git submodule update --init --recursive
mkdir build
cd build
cmake .. -G"Visual Studio 17 2022" -A x64 -DCMAKE_PREFIX_PATH=%CD%/libobs-src/cmake/
cmake --build . --target install --config RelWithDebInfo

При этом будут загружены все необходимые зависимости, собраны модули, а затем помещены в архив, совместимый с npm или Yarn, который вы можете указать в данном package.json.

Пользовательская сборка OBS

По умолчанию мы загружаем предварительно созданную версию libobs, если она не указана. Однако эта предварительно созданная версия может быть не тем, что вы хотите использовать, или, возможно, вы тестируете новую функцию наблюдения.

Вы можете указать собственный архив. Однако перед сборкой необходимо внести некоторые изменения в конфигурацию obs-studio по умолчанию:

• Для ENABLE_SCRIPTING должно быть установлено значение false
• ENABLE_UI должно быть установлено в false
• QTDIR не следует указывать, поскольку он не используется.

Если вы не знаете, как собрать obs-studio из исходного кода, инструкции можно найти здесь.

cppcheck

Установите cppcheck с http://cppcheck.sourceforge.net/ и добавьте папку cppcheck в PATH. Чтобы запустить проверку из командной строки:

 cd build 
cmake --build . --target CPPCHECK

Также цель можно создать из Visula Studio. Формат вывода отчета установлен как совместимый, а переход к файлу: строка возможен на панели результатов сборки.

Некоторые предупреждения подавлены в файлах obs-studio-client/cppcheck_suppressions_list.txt и obs-studio-server/cppcheck_suppressions_list.txt .

Анализатор лязга

В системе должны быть установлены Ninja и LLVM . Внимание: depot_tool сломал ниндзя.
Чтобы сделать сборку, откройте cmd.exe .

 mkdir build_clang
cd build_clang

"c:Program Files (x86)Microsoft Visual Studio 14.0VCbinamd64vcvars64.bat"
 
set CCC_CC=clang-cl
set CCC_CXX=clang-cl
set CC=ccc-analyzer.bat
set CXX=c++-analyzer.bat
#set CCC_ANALYZER_VERBOSE=1

#make ninja project 
cmake  -G "Ninja" -DCLANG_ANALYZE_CONFIG=1 -DCMAKE_INSTALL_PREFIX:PATH=""  -DCMAKE_LINKER=lld-link -DCMAKE_BUILD_TYPE="Debug"   -DCMAKE_SYSTEM_NAME="Generic" -DCMAKE_MAKE_PROGRAM=ninja.exe ..

#try to build and "fix" errors 
ninja.exe 

#clean build to scan 
ninja.exe clean 

scan-build --keep-empty -internal-stats -stats -v -v -v -o check ninja.exe

Шаг по "fixing" ошибок важен, поскольку база кода и особенно сторонний код не готовы к сборке с помощью clang. А файлы, которые не удалось скомпилировать, не будут проверяться на наличие ошибок.

Тесты

Тесты для узла студии obs написаны на Typescript и используют Mocha в качестве тестовой среды с пакетом Electron-Mocha, позволяющим Mocha работать в Electron, и Chai в качестве среды утверждений.

Вам необходимо собрать obs-studio-node для запуска тестов. Вы можете собрать его любым способом, просто обязательно используйте CMAKE_INSTALL_PREFIX для установки obs-studio-node в выбранную вами папку. Тесты используют эту переменную, чтобы узнать, где находится модуль obs-studio-node. Поскольку мы используем нашу собственную вилку Electron, вам также необходимо создать переменную среды с именем ELECTRON_PATH , указывающую на то, где находится двоичный файл Electron в папке node_modules после запуска yarn install . Ниже приведены три различных способа сборки obs-studio-node:

Команды терминала

В корневой папке obs-studio-node:

1. yarn install
2. git submodule update --init --recursive --force
3. mkdir build
4. cmake -Bbuild -H. -G"Visual Studio 16 2019" -A x64 -DCMAKE_INSTALL_PREFIX="path_of_your_choosing"
5. cmake --build build --target install

Терминал с использованием скриптов package.json

В корневой папке obs-studio-node:

1. mkdir build
2. yarn local:config
3. yarn local:build
4. Необязательно: чтобы очистить папку сборки и снова повторить шаги 2–3, выполните yarn local:clean

CMake графический интерфейс

1. yarn install
2. Создайте папку сборки в корне obs-studio-node.
3. Открыть графический интерфейс CMake
4. Поместите путь к проекту obs-studio-node в поле Where is the source code: ».
5. Укажите путь к папке сборки в поле Where to build the binaries: ».
6. Нажмите Configure
7. Измените CMAKE_INSTALL_PREFIX на путь к папке по вашему выбору.
8. Нажмите Generate
9. Нажмите Open Project , чтобы открыть Visual Studio и построить там проект.

Запуск тестов

Некоторые тесты взаимодействуют с Twitch, и мы используем службу пула пользователей для получения пользователей, но в случае, если мы не можем получить от него пользователя, мы используем ключ потока, предоставляемый переменной среды. Создайте переменную среды под названием SLOBS_BE_STREAMKEY с ключом потока выбранной вами учетной записи Twitch.

• Чтобы запустить все тесты, выполните yarn run test
• Чтобы запустить только один тест, выполните yarn run test --grep describe_name_value , где describe_name_value — это имя теста, передаваемое при вызове описания в каждом тестовом файле. Примеры: yarn run test --grep nodeobs_api или yarn run test -g "Start streaming"