aja: Capture and Output plugin for AJA Video Systems IO devices

* aja: Initial commit of AJA capture/output plugin

* aja: Fix clang-format on aja-output-ui code

* aja: Remove script used during dev/testing

* aja: Address pull request feedback from @RytoEX

* aja: Remove the SDK sources and update CMakeLists to point to new headers-only/static libs dependency distribution.

* aja: Only build AJA plugin on x64 on macOS for now

* aja: Remove the non-English placeholder locale files. The english strings/files will be produced via crowdin, according to @ddrboxman.

* aja: Add FindLibAJANTV2.cmake script to locate the ajantv2 headers and static libs in the OBS external deps package(s). Tested on Windows x64. macOS and Linux x64 TBD.

* aja: Add ajantv2/includes to FindLibAJANTV2 include search paths

* aja: Remove commented code from aja CMakeLists

* aja: Remove debug code and comments that are no longer needed.

* aja: Fix indentation

* aja: Remove disablement of clang-format in routing table and SDIWireFormat map

* aja: Use spaces for all indentation in widget crosspoint arrays where we disable clang-format

* aja: Address code style comments made by @RytoEX

* aja: Fix uneven indentation

* aja: More fixes to if/else placement and remove superfluous comments.

* aja: Rename 'dwns' to 'deactivateWhileNotShowing' for clarity. The DeckLink plugin still uses the variable name 'dwns' and should be changed, if desired, in a separate PR.

* aja: Remove X11Extras dependency from AJA Output frontend plugin

* aja: Add patch from Jim to find AJA release/debug libs

* aja: Improve AV sync of queued video/audio sent to the AJA card in the AJA Output plugin.
This commit is contained in:
Paul Hindt
2021-11-23 18:31:11 -08:00
committed by GitHub
parent b387047632
commit ce3ae8e423
42 changed files with 9746 additions and 0 deletions

View File

@@ -1,3 +1,4 @@
add_subdirectory(decklink-output-ui)
add_subdirectory(frontend-tools)
add_subdirectory(decklink-captions)
add_subdirectory(aja-output-ui)

View File

@@ -0,0 +1,169 @@
#include "AJAOutputUI.h"
#include "aja-ui-main.h"
#include "../../../plugins/aja/aja-ui-props.hpp"
#include "../../../plugins/aja/aja-enums.hpp"
#include <ajantv2/includes/ntv2enums.h>
#include <obs-module.h>
#include <util/platform.h>
#include <util/util.hpp>
AJAOutputUI::AJAOutputUI(QWidget *parent) : QDialog(parent), ui(new Ui_Output)
{
ui->setupUi(this);
setSizeGripEnabled(true);
setWindowFlags(windowFlags() & ~Qt::WindowContextHelpButtonHint);
propertiesView = nullptr;
previewPropertiesView = nullptr;
}
void AJAOutputUI::ShowHideDialog()
{
SetupPropertiesView();
SetupPreviewPropertiesView();
setVisible(!isVisible());
}
void AJAOutputUI::SetupPropertiesView()
{
if (propertiesView)
delete propertiesView;
obs_data_t *settings = obs_data_create();
OBSData data = load_settings(kProgramPropsFilename);
if (data) {
obs_data_apply(settings, data);
} else {
// apply default settings
obs_data_set_int(settings, kUIPropOutput.id,
static_cast<long long>(IOSelection::Invalid));
obs_data_set_int(settings, kUIPropVideoFormatSelect.id,
static_cast<long long>(NTV2_FORMAT_720p_5994));
obs_data_set_int(settings, kUIPropPixelFormatSelect.id,
static_cast<long long>(NTV2_FBF_8BIT_YCBCR));
obs_data_set_int(settings, kUIPropSDI4KTransport.id,
static_cast<long long>(
SDI4KTransport::TwoSampleInterleave));
}
// Assign an ID to the program output plugin instance for channel usage tracking
obs_data_set_string(settings, kUIPropAJAOutputID.id, kProgramOutputID);
propertiesView = new OBSPropertiesView(
settings, "aja_output",
(PropertiesReloadCallback)obs_get_output_properties, 170);
ui->propertiesLayout->addWidget(propertiesView);
obs_data_release(settings);
connect(propertiesView, SIGNAL(Changed()), this,
SLOT(PropertiesChanged()));
}
void AJAOutputUI::SaveSettings(const char *filename, obs_data_t *settings)
{
BPtr<char> modulePath =
obs_module_get_config_path(obs_current_module(), "");
os_mkdirs(modulePath);
BPtr<char> path =
obs_module_get_config_path(obs_current_module(), filename);
if (settings)
obs_data_save_json_safe(settings, path, "tmp", "bak");
}
void AJAOutputUI::SetupPreviewPropertiesView()
{
if (previewPropertiesView)
delete previewPropertiesView;
obs_data_t *settings = obs_data_create();
OBSData data = load_settings(kPreviewPropsFilename);
if (data) {
obs_data_apply(settings, data);
} else {
// apply default settings
obs_data_set_int(settings, kUIPropOutput.id,
static_cast<long long>(IOSelection::Invalid));
obs_data_set_int(settings, kUIPropVideoFormatSelect.id,
static_cast<long long>(NTV2_FORMAT_720p_5994));
obs_data_set_int(settings, kUIPropPixelFormatSelect.id,
static_cast<long long>(NTV2_FBF_8BIT_YCBCR));
obs_data_set_int(settings, kUIPropSDI4KTransport.id,
static_cast<long long>(
SDI4KTransport::TwoSampleInterleave));
}
// Assign an ID to the program output plugin instance for channel usage tracking
obs_data_set_string(settings, kUIPropAJAOutputID.id, kPreviewOutputID);
previewPropertiesView = new OBSPropertiesView(
settings, "aja_output",
(PropertiesReloadCallback)obs_get_output_properties, 170);
ui->previewPropertiesLayout->addWidget(previewPropertiesView);
obs_data_release(settings);
connect(previewPropertiesView, SIGNAL(Changed()), this,
SLOT(PreviewPropertiesChanged()));
}
void AJAOutputUI::on_outputButton_clicked()
{
SaveSettings(kProgramPropsFilename, propertiesView->GetSettings());
output_toggle();
}
void AJAOutputUI::PropertiesChanged()
{
SaveSettings(kProgramPropsFilename, propertiesView->GetSettings());
}
void AJAOutputUI::OutputStateChanged(bool active)
{
QString text;
if (active) {
text = QString(obs_module_text("Stop"));
} else {
text = QString(obs_module_text("Start"));
}
ui->outputButton->setChecked(active);
ui->outputButton->setText(text);
}
void AJAOutputUI::on_previewOutputButton_clicked()
{
SaveSettings(kPreviewPropsFilename,
previewPropertiesView->GetSettings());
preview_output_toggle();
}
void AJAOutputUI::PreviewPropertiesChanged()
{
SaveSettings(kPreviewPropsFilename,
previewPropertiesView->GetSettings());
}
void AJAOutputUI::PreviewOutputStateChanged(bool active)
{
QString text;
if (active) {
text = QString(obs_module_text("Stop"));
} else {
text = QString(obs_module_text("Start"));
}
ui->previewOutputButton->setChecked(active);
ui->previewOutputButton->setText(text);
}

View File

@@ -0,0 +1,33 @@
#pragma once
#include <QDialog>
#include "ui_output.h"
#include "../../UI/properties-view.hpp"
class AJAOutputUI : public QDialog {
Q_OBJECT
private:
OBSPropertiesView *propertiesView;
OBSPropertiesView *previewPropertiesView;
public slots:
void on_outputButton_clicked();
void PropertiesChanged();
void OutputStateChanged(bool);
void on_previewOutputButton_clicked();
void PreviewPropertiesChanged();
void PreviewOutputStateChanged(bool);
public:
std::unique_ptr<Ui_Output> ui;
AJAOutputUI(QWidget *parent);
void ShowHideDialog();
void SaveSettings(const char *filename, obs_data_t *settings);
void SetupPropertiesView();
void SetupPreviewPropertiesView();
};

View File

@@ -0,0 +1,113 @@
project(aja-output-ui)
if(DISABLE_AJA)
message(STATUS "aja-output-ui plugin disabled")
return()
endif()
if(CMAKE_SIZEOF_VOID_P EQUAL 8)
find_package(LibAJANTV2)
if (NOT LIBAJANTV2_FOUND)
message(STATUS "aja-output-ui plugin disabled (deps not found)")
return()
else()
message("aja-output-ui includes: ${LIBAJANTV2_INCLUDE_DIRS}")
message("aja-output-ui libs: ${LIBAJANTV2_LIBRARIES}")
endif()
else()
message(STATUS "aja-output-ui disabled (32-bit not supported)")
return()
endif()
if(APPLE)
find_library(COCOA Cocoa)
include_directories(${COCOA})
endif()
if(UNIX AND NOT APPLE)
find_package(X11 REQUIRED)
link_libraries(${X11_LIBRARIES})
include_directories(${X11_INCLUDE_DIR})
find_package(Qt5X11Extras REQUIRED)
endif()
set(aja-output-ui_HEADERS
${aja-output-ui_HEADERS}
../../qt-wrappers.hpp
../../properties-view.hpp
../../properties-view.moc.hpp
../../vertical-scroll-area.hpp
../../double-slider.hpp
../../slider-ignorewheel.hpp
../../combobox-ignorewheel.hpp
../../spinbox-ignorewheel.hpp
AJAOutputUI.h
aja-ui-main.h
../../../plugins/aja/aja-ui-props.hpp
../../../plugins/aja/aja-enums.hpp)
set(aja-output-ui_SOURCES
${aja-output-ui_SOURCES}
../../qt-wrappers.cpp
../../properties-view.cpp
../../vertical-scroll-area.cpp
../../double-slider.cpp
../../slider-ignorewheel.cpp
../../combobox-ignorewheel.cpp
../../spinbox-ignorewheel.cpp
AJAOutputUI.cpp
aja-ui-main.cpp)
set(aja-output-ui_UI
${aja-output-ui_UI}
forms/output.ui)
if(WIN32)
set(MODULE_DESCRIPTION "OBS AJA Output UI")
configure_file(${CMAKE_SOURCE_DIR}/cmake/winrc/obs-module.rc.in aja-output-ui.rc)
list(APPEND aja-output-ui_SOURCES
aja-output-ui.rc)
endif()
if(APPLE)
set(aja-output-ui_PLATFORM_LIBS
${COCOA})
endif()
qt5_wrap_ui(aja-output-ui_UI_HEADERS
${aja-output-ui_UI})
add_library(aja-output-ui MODULE
${aja-output-ui_HEADERS}
${aja-output-ui_SOURCES}
${aja-output-ui_UI_HEADERS})
if (APPLE)
target_compile_definitions(aja-output-ui PUBLIC
AJAMac
AJA_MAC)
elseif(WIN32)
target_compile_definitions(aja-output-ui PUBLIC
AJA_WINDOWS
_WINDOWS
WIN32
MSWindows)
elseif(UNIX AND NOT APPLE)
target_compile_definitions(aja-output-ui PUBLIC
AJA_LINUX
AJALinux)
endif()
target_include_directories(aja-output-ui PUBLIC
${LIBAJANTV2_INCLUDE_DIRS})
target_link_libraries(aja-output-ui
${frontend-tools_PLATFORM_LIBS}
obs-frontend-api
Qt5::Widgets
libobs)
set_target_properties(aja-output-ui PROPERTIES FOLDER "frontend")
install_obs_plugin_with_data(aja-output-ui data)

View File

@@ -0,0 +1,318 @@
#include "aja-ui-main.h"
#include "AJAOutputUI.h"
#include "../../../plugins/aja/aja-ui-props.hpp"
#include <obs-module.h>
#include <obs-frontend-api.h>
#include <QMainWindow>
#include <QAction>
#include <util/util.hpp>
#include <util/platform.h>
#include <media-io/video-io.h>
#include <media-io/video-frame.h>
OBS_DECLARE_MODULE()
OBS_MODULE_USE_DEFAULT_LOCALE("aja-output-ui", "en-US")
AJAOutputUI *doUI;
bool main_output_running = false;
bool preview_output_running = false;
obs_output_t *output;
struct preview_output {
bool enabled;
obs_source_t *current_source;
obs_output_t *output;
video_t *video_queue;
gs_texrender_t *texrender;
gs_stagesurf_t *stagesurface;
uint8_t *video_data;
uint32_t video_linesize;
obs_video_info ovi;
};
static struct preview_output context = {0};
OBSData load_settings(const char *filename)
{
BPtr<char> path =
obs_module_get_config_path(obs_current_module(), filename);
BPtr<char> jsonData = os_quick_read_utf8_file(path);
if (!!jsonData) {
obs_data_t *data = obs_data_create_from_json(jsonData);
OBSData dataRet(data);
obs_data_release(data);
return dataRet;
}
return nullptr;
}
void output_stop()
{
obs_output_stop(output);
obs_output_release(output);
main_output_running = false;
doUI->OutputStateChanged(false);
}
void output_start()
{
OBSData settings = load_settings(kProgramPropsFilename);
if (settings != nullptr) {
output = obs_output_create("aja_output", kProgramOutputID,
settings, NULL);
bool started = obs_output_start(output);
obs_data_release(settings);
main_output_running = started;
doUI->OutputStateChanged(started);
if (!started)
output_stop();
}
}
void output_toggle()
{
if (main_output_running)
output_stop();
else
output_start();
}
void on_preview_scene_changed(enum obs_frontend_event event, void *param);
void render_preview_source(void *param, uint32_t cx, uint32_t cy);
void preview_output_stop()
{
obs_output_stop(context.output);
obs_output_release(context.output);
video_output_stop(context.video_queue);
obs_remove_main_render_callback(render_preview_source, &context);
obs_frontend_remove_event_callback(on_preview_scene_changed, &context);
obs_source_release(context.current_source);
obs_enter_graphics();
gs_stagesurface_destroy(context.stagesurface);
gs_texrender_destroy(context.texrender);
obs_leave_graphics();
video_output_close(context.video_queue);
preview_output_running = false;
doUI->PreviewOutputStateChanged(false);
}
void preview_output_start()
{
OBSData settings = load_settings(kPreviewPropsFilename);
if (settings != nullptr) {
context.output = obs_output_create(
"aja_output", kPreviewOutputID, settings, NULL);
obs_get_video_info(&context.ovi);
uint32_t width = context.ovi.base_width;
uint32_t height = context.ovi.base_height;
obs_enter_graphics();
context.texrender = gs_texrender_create(GS_BGRA, GS_ZS_NONE);
context.stagesurface =
gs_stagesurface_create(width, height, GS_BGRA);
obs_leave_graphics();
const video_output_info *mainVOI =
video_output_get_info(obs_get_video());
video_output_info vi = {0};
vi.format = VIDEO_FORMAT_BGRA;
vi.width = width;
vi.height = height;
vi.fps_den = context.ovi.fps_den;
vi.fps_num = context.ovi.fps_num;
vi.cache_size = 16;
vi.colorspace = mainVOI->colorspace;
vi.range = mainVOI->range;
vi.name = kPreviewOutputID;
video_output_open(&context.video_queue, &vi);
obs_frontend_add_event_callback(on_preview_scene_changed,
&context);
if (obs_frontend_preview_program_mode_active()) {
context.current_source =
obs_frontend_get_current_preview_scene();
} else {
context.current_source =
obs_frontend_get_current_scene();
}
obs_add_main_render_callback(render_preview_source, &context);
obs_output_set_media(context.output, context.video_queue,
obs_get_audio());
bool started = obs_output_start(context.output);
obs_data_release(settings);
preview_output_running = started;
doUI->PreviewOutputStateChanged(started);
if (!started)
preview_output_stop();
}
}
void preview_output_toggle()
{
if (preview_output_running)
preview_output_stop();
else
preview_output_start();
}
void on_preview_scene_changed(enum obs_frontend_event event, void *param)
{
auto ctx = (struct preview_output *)param;
switch (event) {
case OBS_FRONTEND_EVENT_STUDIO_MODE_ENABLED:
case OBS_FRONTEND_EVENT_PREVIEW_SCENE_CHANGED:
obs_source_release(ctx->current_source);
ctx->current_source = obs_frontend_get_current_preview_scene();
break;
case OBS_FRONTEND_EVENT_STUDIO_MODE_DISABLED:
obs_source_release(ctx->current_source);
ctx->current_source = obs_frontend_get_current_scene();
break;
case OBS_FRONTEND_EVENT_SCENE_CHANGED:
if (!obs_frontend_preview_program_mode_active()) {
obs_source_release(ctx->current_source);
ctx->current_source = obs_frontend_get_current_scene();
}
break;
default:
break;
}
}
void render_preview_source(void *param, uint32_t cx, uint32_t cy)
{
UNUSED_PARAMETER(cx);
UNUSED_PARAMETER(cy);
auto ctx = (struct preview_output *)param;
if (!ctx->current_source)
return;
uint32_t width = obs_source_get_base_width(ctx->current_source);
uint32_t height = obs_source_get_base_height(ctx->current_source);
gs_texrender_reset(ctx->texrender);
if (gs_texrender_begin(ctx->texrender, width, height)) {
struct vec4 background;
vec4_zero(&background);
gs_clear(GS_CLEAR_COLOR, &background, 0.0f, 0);
gs_ortho(0.0f, (float)width, 0.0f, (float)height, -100.0f,
100.0f);
gs_blend_state_push();
gs_blend_function(GS_BLEND_ONE, GS_BLEND_ZERO);
obs_source_video_render(ctx->current_source);
gs_blend_state_pop();
gs_texrender_end(ctx->texrender);
struct video_frame output_frame;
if (video_output_lock_frame(ctx->video_queue, &output_frame, 1,
os_gettime_ns())) {
gs_stage_texture(
ctx->stagesurface,
gs_texrender_get_texture(ctx->texrender));
if (gs_stagesurface_map(ctx->stagesurface,
&ctx->video_data,
&ctx->video_linesize)) {
uint32_t linesize = output_frame.linesize[0];
for (uint32_t i = 0; i < ctx->ovi.base_height;
i++) {
uint32_t dst_offset = linesize * i;
uint32_t src_offset =
ctx->video_linesize * i;
memcpy(output_frame.data[0] +
dst_offset,
ctx->video_data + src_offset,
linesize);
}
gs_stagesurface_unmap(ctx->stagesurface);
ctx->video_data = nullptr;
}
video_output_unlock_frame(ctx->video_queue);
}
}
}
void addOutputUI(void)
{
QAction *action = (QAction *)obs_frontend_add_tools_menu_qaction(
"AJA I/O Device Output");
QMainWindow *window = (QMainWindow *)obs_frontend_get_main_window();
obs_frontend_push_ui_translation(obs_module_get_string);
doUI = new AJAOutputUI(window);
obs_frontend_pop_ui_translation();
auto cb = []() { doUI->ShowHideDialog(); };
action->connect(action, &QAction::triggered, cb);
}
static void OBSEvent(enum obs_frontend_event event, void *)
{
if (event == OBS_FRONTEND_EVENT_FINISHED_LOADING) {
OBSData settings = load_settings(kProgramPropsFilename);
if (settings &&
obs_data_get_bool(settings, kUIPropAutoStartOutput.id))
output_start();
OBSData previewSettings = load_settings(kPreviewPropsFilename);
if (previewSettings &&
obs_data_get_bool(previewSettings,
kUIPropAutoStartOutput.id))
preview_output_start();
} else if (event == OBS_FRONTEND_EVENT_EXIT) {
if (main_output_running)
output_stop();
if (preview_output_running)
preview_output_stop();
}
}
bool obs_module_load(void)
{
addOutputUI();
obs_frontend_add_event_callback(OBSEvent, nullptr);
return true;
}

View File

@@ -0,0 +1,10 @@
#pragma once
#include <obs.hpp>
static const char *kProgramPropsFilename = "ajaOutputProps.json";
static const char *kPreviewPropsFilename = "ajaPreviewOutputProps.json";
OBSData load_settings(const char *filename);
void output_toggle();
void preview_output_toggle();

View File

@@ -0,0 +1,3 @@
AJAOutput.Device="AJA I/O Device Output"
AJAOutput.ProgramOutput="Program Output"
AJAOutput.PreviewOutput="Preview Output"

View File

@@ -0,0 +1,113 @@
<?xml version="1.0" encoding="UTF-8"?>
<ui version="4.0">
<class>Output</class>
<widget class="QDialog" name="Output">
<property name="geometry">
<rect>
<x>0</x>
<y>0</y>
<width>800</width>
<height>540</height>
</rect>
</property>
<property name="sizePolicy">
<sizepolicy hsizetype="Expanding" vsizetype="Expanding">
<horstretch>0</horstretch>
<verstretch>0</verstretch>
</sizepolicy>
</property>
<property name="windowTitle">
<string>AJAOutput.Device</string>
</property>
<property name="sizeGripEnabled">
<bool>true</bool>
</property>
<property name="modal">
<bool>false</bool>
</property>
<layout class="QVBoxLayout" name="verticalLayout">
<property name="sizeConstraint">
<enum>QLayout::SetDefaultConstraint</enum>
</property>
<item>
<widget class="QLabel" name="label">
<property name="text">
<string>AJAOutput.ProgramOutput</string>
</property>
</widget>
</item>
<item>
<layout class="QVBoxLayout" name="propertiesLayout"/>
</item>
<item>
<layout class="QHBoxLayout" name="horizontalLayout">
<property name="spacing">
<number>6</number>
</property>
<item>
<spacer name="horizontalSpacer">
<property name="orientation">
<enum>Qt::Horizontal</enum>
</property>
<property name="sizeHint" stdset="0">
<size>
<width>40</width>
<height>20</height>
</size>
</property>
</spacer>
</item>
<item>
<widget class="QPushButton" name="outputButton">
<property name="text">
<string>Start</string>
</property>
<property name="checkable">
<bool>true</bool>
</property>
</widget>
</item>
</layout>
</item>
<item>
<widget class="QLabel" name="label_2">
<property name="text">
<string>AJAOutput.PreviewOutput</string>
</property>
</widget>
</item>
<item>
<layout class="QVBoxLayout" name="previewPropertiesLayout"/>
</item>
<item>
<layout class="QHBoxLayout" name="horizontalLayout_2">
<item>
<spacer name="horizontalSpacer_2">
<property name="orientation">
<enum>Qt::Horizontal</enum>
</property>
<property name="sizeHint" stdset="0">
<size>
<width>40</width>
<height>20</height>
</size>
</property>
</spacer>
</item>
<item>
<widget class="QPushButton" name="previewOutputButton">
<property name="text">
<string>Start</string>
</property>
<property name="checkable">
<bool>true</bool>
</property>
</widget>
</item>
</layout>
</item>
</layout>
</widget>
<resources/>
<connections/>
</ui>