stephenseo/obs-studio-plugin-unix-socket-control
1
0
Fork 0
Code Issues Pull requests Projects Releases 6 Packages Wiki Activity Actions

Compare commits

base: stephenseo:main
Branches Tags
stephenseo:main
stephenseo:devel
stephenseo:1.4.0
stephenseo:1.3.0
stephenseo:1.2.1
stephenseo:1.2
stephenseo:1.1
stephenseo:1.0
..
compare: stephenseo:1.3.0
Branches Tags
stephenseo:devel
stephenseo:main
stephenseo:1.4.0
stephenseo:1.3.0
stephenseo:1.2.1
stephenseo:1.2
stephenseo:1.1
stephenseo:1.0

No commits in common. "main" and "1.3.0" have entirely different histories.
main ... 1.3.0

8 changed files with 50 additions and 215 deletions
Show stats Expand all files Collapse all files

71
.forgejo/workflows/tag_release_pkg.yaml
View file

@ -1,71 +0,0 @@
name: Create releases with ArchLinux pkg
on:
push:
branches:
- '*'
jobs:
check-and-build-and-release:
runs-on: x86_64_archLinux
steps:
- name: Get tags
run: |
curl --fail-with-body -X 'GET' \
'https://git.seodisparate.com/api/v1/repos/stephenseo/obs-studio-plugin-unix-socket-control/tags' \
-H 'accept: application/json' -o tags.json -w '%output{header_count}%header{x-total-count}' 2>/dev/null \
- name: Fetch repo
run: git clone https://git.seodisparate.com/stephenseo/obs-studio-plugin-unix-socket-control.git obs_usc
- name: Fetch PKGBUILD
run: pushd obs_usc >&/dev/null && git checkout main && popd >&/dev/null && cp obs_usc/archLinuxPackaging/PKGBUILD ./
- name: Check tags and build per release
run: |
SAVED_DIR="$(pwd)"
TAG_COUNT="$(cat ./header_count)"
for ((i=0; i<$TAG_COUNT; ++i)); do
echo "$(jq ".[$i].name" < ./tags.json | tr -d '"')" >> tempList
done
sort -V < tempList > versionList
for ((i=0; i<$TAG_COUNT; ++i)); do
cd "$SAVED_DIR"
TAG_NAME="$(sed -n "$((i+1))p" ./versionList)"
curl -X 'GET' "https://git.seodisparate.com/api/v1/repos/stephenseo/obs-studio-plugin-unix-socket-control/releases/tags/${TAG_NAME}" -H 'accept: application/json' -w '%output{http_code}%{http_code}' >&/dev/null
if [[ $(cat ./http_code) != "404" ]]; then
continue
fi
echo "Trying to build and release \"$TAG_NAME\"..."
mkdir -p "build_${TAG_NAME}" || continue
cp ./PKGBUILD "build_${TAG_NAME}/" || continue
sed -i "s/^pkgver=.*\$/pkgver=${TAG_NAME}/" "build_${TAG_NAME}/PKGBUILD" || continue
sed -i 's/^pkgrel=.*$/pkgrel=1/' "build_${TAG_NAME}/PKGBUILD" || continue
sed -i 's/^sha256sums=.*$/sha256sums=("SKIP")/' "build_${TAG_NAME}/PKGBUILD" || continue
cd "build_${TAG_NAME}" || continue
makepkg || continue
curl --fail-with-body -X 'POST' \
"https://git.seodisparate.com/api/v1/repos/stephenseo/obs-studio-plugin-unix-socket-control/releases" \
-H 'accept: application/json' \
-H "Authorization: token ${GITHUB_TOKEN}" \
-H 'Content-Type: application/json' \
-d "{
\"name\": \"OBS Plugin Unix Socket Control version ${TAG_NAME}\",
\"body\": \"\",
\"tag_name\": \"${TAG_NAME}\"
}" > release_response.json || continue
curl --fail-with-body -X 'POST' \
"https://git.seodisparate.com/api/v1/repos/stephenseo/obs-studio-plugin-unix-socket-control/releases/$(jq .id < release_response.json)/assets" \
-H 'accept: application/json' \
-H "Authorization: token ${GITHUB_TOKEN}" \
-H 'Content-Type: multipart/form-data' \
-F "attachment=@obs-studio-plugin-unix-socket-control-${TAG_NAME}-1-x86_64.pkg.tar.zst;type=application/zstd" > release_asset.json || continue
done

2
CMakeLists.txt
View file

@ -1,7 +1,7 @@
cmake_minimum_required(VERSION 3.25)
set(obs_usc_VERSION_MAJOR 1)
set(obs_usc_VERSION_MINOR 4)
set(obs_usc_VERSION_MINOR 3)
set(obs_usc_VERSION_PATCH 0)
set(obs_usc_VERSION_STR "${obs_usc_VERSION_MAJOR}.${obs_usc_VERSION_MINOR}.${obs_usc_VERSION_PATCH}")

2
LICENSE
View file

@ -1,6 +1,6 @@
MIT License
Copyright (c) 2023-2024 Stephen Seo
Copyright (c) 2023 Stephen Seo
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal

10
archLinuxPackaging/PKGBUILD
View file

@ -1,5 +1,5 @@
pkgname=obs-studio-plugin-unix-socket-control
pkgver=1.4.0
pkgver=1.2.1
pkgrel=1
pkgdesc="An obs studio plugin to command obs to start/stop recording/streaming via unix socket"
arch=(x86_64)
@ -8,12 +8,14 @@ license=('MIT')
depends=(obs-studio)
makedepends=(cmake)
source=("${pkgname}_${pkgver}.tar.gz::$url/archive/$pkgver.tar.gz")
sha256sums=(6e0f1d4d48e9a26382aaea7e1969788373c301b685c49cd916d7f518ac148265)
sha256sums=(ce761a3d044906fc6125077f9a73bca31f2caa44e50cb37e36e124c08752e8ae)
build() {
cd "$pkgname"
cmake -S . -B buildRelease -DCMAKE_BUILD_TYPE=Release
make -C buildRelease
mkdir buildRelease
cd buildRelease
cmake -DCMAKE_BUILD_TYPE=Release ..
make
}
package() {

80
src/client.c
View file

@ -11,7 +11,7 @@
// local includes
#include "common_constants.h"
void print_usage(const char *name) {
void print_usage(char *name) {
printf("Usage:\n");
printf(" %s\n", name);
printf(" [--start-recording \n");
@ -25,7 +25,6 @@ void print_usage(const char *name) {
printf(" | --toggle-replay-buffer\n");
printf(" | --save-replay-buffer\n");
printf(" | --get-status]\n");
printf(" --wait\n");
}
void cleanup_data_socket(int *data_socket) {
@ -37,56 +36,37 @@ void cleanup_data_socket(int *data_socket) {
int main(int argc, char **argv) {
UnixSocketEventType type = UNIX_SOCKET_EVENT_NOP;
const char *program_name = argv[0];
++argv;
--argc;
if (argc == 0) {
print_usage(program_name);
return 1;
}
while (argc != 0) {
if (strncmp(argv[0], "--start-recording", 17) == 0) {
type = UNIX_SOCKET_EVENT_START_RECORDING |
(UNIX_SOCKET_EVENT_WAIT & type);
} else if (strncmp(argv[0], "--stop-recording", 16) == 0) {
type = UNIX_SOCKET_EVENT_STOP_RECORDING |
(UNIX_SOCKET_EVENT_WAIT & type);
} else if (strncmp(argv[0], "--start-streaming", 17) == 0) {
type = UNIX_SOCKET_EVENT_START_STREAMING |
(UNIX_SOCKET_EVENT_WAIT & type);
} else if (strncmp(argv[0], "--toggle-recording", 18) == 0) {
type = UNIX_SOCKET_EVENT_TOGGLE_RECORDING |
(UNIX_SOCKET_EVENT_WAIT & type);
} else if (strncmp(argv[0], "--stop-streaming", 16) == 0) {
type = UNIX_SOCKET_EVENT_STOP_STREAMING |
(UNIX_SOCKET_EVENT_WAIT & type);
} else if (strncmp(argv[0], "--toggle-streaming", 18) == 0) {
type = UNIX_SOCKET_EVENT_TOGGLE_STREAMING |
(UNIX_SOCKET_EVENT_WAIT & type);
} else if (strncmp(argv[0], "--start-replay-buffer", 21) == 0) {
type = UNIX_SOCKET_EVENT_START_REPLAY_BUFFER |
(UNIX_SOCKET_EVENT_WAIT & type);
} else if (strncmp(argv[0], "--stop-replay-buffer", 20) == 0) {
type = UNIX_SOCKET_EVENT_STOP_REPLAY_BUFFER |
(UNIX_SOCKET_EVENT_WAIT & type);
} else if (strncmp(argv[0], "--toggle-replay-buffer", 22) == 0) {
type = UNIX_SOCKET_EVENT_TOGGLE_REPLAY_BUFFER |
(UNIX_SOCKET_EVENT_WAIT & type);
} else if (strncmp(argv[0], "--save-replay-buffer", 20) == 0) {
type = UNIX_SOCKET_EVENT_SAVE_REPLAY_BUFFER |
(UNIX_SOCKET_EVENT_WAIT & type);
} else if (strncmp(argv[0], "--get-status", 12) == 0) {
type = UNIX_SOCKET_EVENT_GET_STATUS |
(UNIX_SOCKET_EVENT_WAIT & type);
} else if (strncmp(argv[0], "--wait", 6) == 0) {
type |= UNIX_SOCKET_EVENT_WAIT;
if (argc == 2) {
if (strncmp(argv[1], "--start-recording", 17) == 0) {
type = UNIX_SOCKET_EVENT_START_RECORDING;
} else if (strncmp(argv[1], "--stop-recording", 16) == 0) {
type = UNIX_SOCKET_EVENT_STOP_RECORDING;
} else if (strncmp(argv[1], "--start-streaming", 17) == 0) {
type = UNIX_SOCKET_EVENT_START_STREAMING;
} else if (strncmp(argv[1], "--toggle-recording", 18) == 0) {
type = UNIX_SOCKET_EVENT_TOGGLE_RECORDING;
} else if (strncmp(argv[1], "--stop-streaming", 16) == 0) {
type = UNIX_SOCKET_EVENT_STOP_STREAMING;
} else if (strncmp(argv[1], "--toggle-streaming", 18) == 0) {
type = UNIX_SOCKET_EVENT_TOGGLE_STREAMING;
} else if (strncmp(argv[1], "--start-replay-buffer", 21) == 0) {
type = UNIX_SOCKET_EVENT_START_REPLAY_BUFFER;
} else if (strncmp(argv[1], "--stop-replay-buffer", 20) == 0) {
type = UNIX_SOCKET_EVENT_STOP_REPLAY_BUFFER;
} else if (strncmp(argv[1], "--toggle-replay-buffer", 22) == 0) {
type = UNIX_SOCKET_EVENT_TOGGLE_REPLAY_BUFFER;
} else if (strncmp(argv[1], "--save-replay-buffer", 20) == 0) {
type = UNIX_SOCKET_EVENT_SAVE_REPLAY_BUFFER;
} else if (strncmp(argv[1], "--get-status", 12) == 0) {
type = UNIX_SOCKET_EVENT_GET_STATUS;
} else {
puts("ERROR: Invalid arg!");
print_usage(program_name);
print_usage(argv[0]);
return 2;
}
++argv;
--argc;
} else {
print_usage(argv[0]);
return 1;
}
char socket_filename[108];
@ -96,7 +76,7 @@ int main(int argc, char **argv) {
struct sockaddr_un addr;
int ret;
__attribute__((cleanup(cleanup_data_socket))) int data_socket = -1;
unsigned char send_buf = (unsigned char)type;
char send_buf = (char)type;
char buffer[8];
memset(buffer, 0, sizeof(buffer));
@ -143,7 +123,7 @@ int main(int argc, char **argv) {
// Error. TODO handle this.
return 7;
} else {
switch(type & UNIX_SOCKET_EVENT_MASK) {
switch(type) {
case UNIX_SOCKET_EVENT_START_RECORDING:
puts("Sent event \"start recording\"!");
break;

4
src/common_constants.h
View file

@ -15,9 +15,7 @@ typedef enum UnixSocketEventType {
UNIX_SOCKET_EVENT_SAVE_REPLAY_BUFFER,
UNIX_SOCKET_EVENT_TOGGLE_RECORDING,
UNIX_SOCKET_EVENT_TOGGLE_STREAMING,
UNIX_SOCKET_EVENT_TOGGLE_REPLAY_BUFFER,
UNIX_SOCKET_EVENT_WAIT = 0x80,
UNIX_SOCKET_EVENT_MASK = 0x7F
UNIX_SOCKET_EVENT_TOGGLE_REPLAY_BUFFER
} UnixSocketEventType;
#endif

90
src/socket.c
View file

@ -16,22 +16,6 @@
// obs-studio includes
#include <obs-frontend-api.h>
void internal_wait_on_obs_frontend_event(UnixSocketHandler *handler, UnixSocketEventType event) {
if (is_unix_socket_handler_valid(handler) && (event & UNIX_SOCKET_EVENT_WAIT) != 0) {
struct timespec duration;
duration.tv_sec = 0;
duration.tv_nsec = 1000000;
unsigned int ticks = 0;
while(atomic_load(&handler->callback_var) != (event & UNIX_SOCKET_EVENT_MASK)) {
if (++ticks > 5000) {
break;
} else {
thrd_sleep(&duration, 0);
}
}
}
}
int unix_socket_handler_thread_function(void *ud) {
UnixSocketHandler *handler = (UnixSocketHandler*)ud;
@ -73,8 +57,6 @@ int unix_socket_handler_thread_function(void *ud) {
}
mtx_unlock(handler->mutex);
atomic_store(&handler->callback_var, 0);
ret = read(data_socket, buffer, sizeof(buffer));
if (ret == -1) {
if (errno == EAGAIN || errno == EWOULDBLOCK) {
@ -90,45 +72,37 @@ int unix_socket_handler_thread_function(void *ud) {
break;
}
if ((buffer[0] & UNIX_SOCKET_EVENT_MASK) == UNIX_SOCKET_EVENT_START_RECORDING) {
if (buffer[0] == UNIX_SOCKET_EVENT_START_RECORDING) {
obs_frontend_recording_start();
internal_wait_on_obs_frontend_event(handler, buffer[0]);
ret_buffer[0] = UNIX_SOCKET_EVENT_NOP;
} else if ((buffer[0] & UNIX_SOCKET_EVENT_MASK) == UNIX_SOCKET_EVENT_STOP_RECORDING) {
} else if (buffer[0] == UNIX_SOCKET_EVENT_STOP_RECORDING) {
obs_frontend_recording_stop();
internal_wait_on_obs_frontend_event(handler, buffer[0]);
ret_buffer[0] = UNIX_SOCKET_EVENT_NOP;
} else if ((buffer[0] & UNIX_SOCKET_EVENT_MASK) == UNIX_SOCKET_EVENT_TOGGLE_RECORDING) {
} else if (buffer[0] == UNIX_SOCKET_EVENT_TOGGLE_RECORDING) {
ret_buffer[0] = UNIX_SOCKET_EVENT_TOGGLE_RECORDING;
if (obs_frontend_recording_active()) {
obs_frontend_recording_stop();
internal_wait_on_obs_frontend_event(handler, UNIX_SOCKET_EVENT_STOP_RECORDING | (buffer[0] & UNIX_SOCKET_EVENT_WAIT));
ret_buffer[1] = UNIX_SOCKET_EVENT_STOP_RECORDING;
} else {
obs_frontend_recording_start();
internal_wait_on_obs_frontend_event(handler, UNIX_SOCKET_EVENT_START_RECORDING | (buffer[0] & UNIX_SOCKET_EVENT_WAIT));
ret_buffer[1] = UNIX_SOCKET_EVENT_START_RECORDING;
}
} else if ((buffer[0] & UNIX_SOCKET_EVENT_MASK) == UNIX_SOCKET_EVENT_START_STREAMING) {
} else if (buffer[0] == UNIX_SOCKET_EVENT_START_STREAMING) {
obs_frontend_streaming_start();
internal_wait_on_obs_frontend_event(handler, buffer[0]);
ret_buffer[0] = UNIX_SOCKET_EVENT_NOP;
} else if ((buffer[0] & UNIX_SOCKET_EVENT_MASK) == UNIX_SOCKET_EVENT_STOP_STREAMING) {
} else if (buffer[0] == UNIX_SOCKET_EVENT_STOP_STREAMING) {
obs_frontend_streaming_stop();
internal_wait_on_obs_frontend_event(handler, buffer[0]);
ret_buffer[0] = UNIX_SOCKET_EVENT_NOP;
} else if ((buffer[0] & UNIX_SOCKET_EVENT_MASK) == UNIX_SOCKET_EVENT_TOGGLE_STREAMING) {
} else if (buffer[0] == UNIX_SOCKET_EVENT_TOGGLE_STREAMING) {
ret_buffer[0] = UNIX_SOCKET_EVENT_TOGGLE_STREAMING;
if (obs_frontend_streaming_active()) {
obs_frontend_streaming_stop();
internal_wait_on_obs_frontend_event(handler, UNIX_SOCKET_EVENT_STOP_STREAMING | (buffer[0] & UNIX_SOCKET_EVENT_WAIT));
ret_buffer[1] = UNIX_SOCKET_EVENT_STOP_STREAMING;
} else {
obs_frontend_streaming_start();
internal_wait_on_obs_frontend_event(handler, UNIX_SOCKET_EVENT_START_STREAMING | (buffer[0] & UNIX_SOCKET_EVENT_WAIT));
ret_buffer[1] = UNIX_SOCKET_EVENT_START_STREAMING;
}
} else if ((buffer[0] & UNIX_SOCKET_EVENT_MASK) == UNIX_SOCKET_EVENT_GET_STATUS) {
} else if (buffer[0] == UNIX_SOCKET_EVENT_GET_STATUS) {
ret_buffer[0] = UNIX_SOCKET_EVENT_GET_STATUS;
if (obs_frontend_recording_active()) {
ret_buffer[1] |= 1;
@ -139,29 +113,24 @@ int unix_socket_handler_thread_function(void *ud) {
if (obs_frontend_replay_buffer_active()) {
ret_buffer[1] |= 4;
}
} else if ((buffer[0] & UNIX_SOCKET_EVENT_MASK) == UNIX_SOCKET_EVENT_START_REPLAY_BUFFER) {
} else if (buffer[0] == UNIX_SOCKET_EVENT_START_REPLAY_BUFFER) {
obs_frontend_replay_buffer_start();
internal_wait_on_obs_frontend_event(handler, buffer[0]);
ret_buffer[0] = UNIX_SOCKET_EVENT_NOP;
} else if ((buffer[0] & UNIX_SOCKET_EVENT_MASK) == UNIX_SOCKET_EVENT_STOP_REPLAY_BUFFER) {
} else if (buffer[0] == UNIX_SOCKET_EVENT_STOP_REPLAY_BUFFER) {
obs_frontend_replay_buffer_stop();
internal_wait_on_obs_frontend_event(handler, buffer[0]);
ret_buffer[0] = UNIX_SOCKET_EVENT_NOP;
} else if ((buffer[0] & UNIX_SOCKET_EVENT_MASK) == UNIX_SOCKET_EVENT_TOGGLE_REPLAY_BUFFER) {
} else if (buffer[0] == UNIX_SOCKET_EVENT_TOGGLE_REPLAY_BUFFER) {
ret_buffer[0] = UNIX_SOCKET_EVENT_TOGGLE_REPLAY_BUFFER;
if (obs_frontend_replay_buffer_active()) {
obs_frontend_replay_buffer_stop();
internal_wait_on_obs_frontend_event(handler, UNIX_SOCKET_EVENT_STOP_REPLAY_BUFFER | (buffer[0] & UNIX_SOCKET_EVENT_WAIT));
ret_buffer[1] = UNIX_SOCKET_EVENT_STOP_REPLAY_BUFFER;
} else {
obs_frontend_replay_buffer_start();
internal_wait_on_obs_frontend_event(handler, UNIX_SOCKET_EVENT_START_REPLAY_BUFFER | (buffer[0] & UNIX_SOCKET_EVENT_WAIT));
ret_buffer[1] = UNIX_SOCKET_EVENT_START_REPLAY_BUFFER;
}
} else if ((buffer[0] & UNIX_SOCKET_EVENT_MASK) == UNIX_SOCKET_EVENT_SAVE_REPLAY_BUFFER) {
} else if (buffer[0] == UNIX_SOCKET_EVENT_SAVE_REPLAY_BUFFER) {
if (obs_frontend_replay_buffer_active()) {
obs_frontend_replay_buffer_save();
internal_wait_on_obs_frontend_event(handler, buffer[0]);
ret_buffer[0] = UNIX_SOCKET_EVENT_NOP;
} else {
ret = -1;
@ -195,11 +164,6 @@ void init_unix_socket_handler(UnixSocketHandler *handler) {
umask(S_IRWXO);
// Set up atomic value.
atomic_init(&handler->callback_var, 0);
obs_frontend_add_event_callback(unix_socket_handler_frontend_event_callback, handler);
// Set up unix socket.
handler->socket_descriptor = socket(AF_UNIX, SOCK_SEQPACKET, 0);
if (handler->socket_descriptor == -1) {
@ -302,35 +266,3 @@ void cleanup_unix_socket_handler(UnixSocketHandler *handler) {
int is_unix_socket_handler_valid(const UnixSocketHandler *handler) {
return handler->flags == 0xFFFFFFFFFFFFFFFF ? 0 : 1;
}
void unix_socket_handler_frontend_event_callback(enum obs_frontend_event event,
void *ud) {
UnixSocketHandler *handler = ud;
if (is_unix_socket_handler_valid(handler)) {
switch (event) {
case OBS_FRONTEND_EVENT_RECORDING_STARTED:
atomic_store(&handler->callback_var, UNIX_SOCKET_EVENT_START_RECORDING);
break;
case OBS_FRONTEND_EVENT_RECORDING_STOPPED:
atomic_store(&handler->callback_var, UNIX_SOCKET_EVENT_STOP_RECORDING);
break;
case OBS_FRONTEND_EVENT_STREAMING_STARTED:
atomic_store(&handler->callback_var, UNIX_SOCKET_EVENT_START_STREAMING);
break;
case OBS_FRONTEND_EVENT_STREAMING_STOPPED:
atomic_store(&handler->callback_var, UNIX_SOCKET_EVENT_STOP_STREAMING);
break;
case OBS_FRONTEND_EVENT_REPLAY_BUFFER_STARTED:
atomic_store(&handler->callback_var, UNIX_SOCKET_EVENT_START_REPLAY_BUFFER);
break;
case OBS_FRONTEND_EVENT_REPLAY_BUFFER_STOPPED:
atomic_store(&handler->callback_var, UNIX_SOCKET_EVENT_STOP_REPLAY_BUFFER);
break;
case OBS_FRONTEND_EVENT_REPLAY_BUFFER_SAVED:
atomic_store(&handler->callback_var, UNIX_SOCKET_EVENT_SAVE_REPLAY_BUFFER);
break;
default:
break;
}
}
}

6
src/socket.h
View file

@ -4,15 +4,11 @@
// standard library includes
#include <stdint.h>
#include <threads.h>
#include <stdatomic.h>
// unix includes
#include <sys/socket.h>
#include <sys/un.h>
// third party includes
#include <obs-frontend-api.h>
// local includes
#include "common_constants.h"
@ -24,7 +20,6 @@ typedef struct UnixSocketHandler {
struct sockaddr_un name;
thrd_t *thread;
mtx_t *mutex;
atomic_uint callback_var;
/*
* ???? 0001 - thread should stop
*/
@ -37,6 +32,5 @@ typedef struct UnixSocketHandler {
void init_unix_socket_handler(UnixSocketHandler *handler);
void cleanup_unix_socket_handler(UnixSocketHandler *handler);
int is_unix_socket_handler_valid(const UnixSocketHandler *handler);
void unix_socket_handler_frontend_event_callback(enum obs_frontend_event event, void *ud);
#endif