mirror of
https://github.com/onyx-and-iris/simple-recorder.git
synced 2026-04-20 16:23:34 +00:00
Compare commits
32 Commits
bba2361964
...
main
| Author | SHA1 | Date | |
|---|---|---|---|
| 5aae021aed | |||
| a2e1c5280b | |||
| d5b7991584 | |||
| d7edaab2d1 | |||
| 09270683d9 | |||
| b7c25525a1 | |||
| c39b909d11 | |||
| 856ab6cbec | |||
| c7baa9ffd6 | |||
| d0401d0457 | |||
| 8813c25819 | |||
| 6035e09e43 | |||
| 0fe22debb6 | |||
| d8d7fce5cc | |||
| ca7604c279 | |||
| 2eb48556ed | |||
| cb892d66d8 | |||
| fccef1e2bf | |||
| 3c77be2ff9 | |||
| e8d0fcf56d | |||
| 69a0f607e4 | |||
| 40429892e8 | |||
| 1a5c0d4537 | |||
| ebad2f51c9 | |||
| 528573cd5a | |||
| 3eb37295c2 | |||
| ef68915f6a | |||
| b161c1ec3d | |||
| e37ae8dddc | |||
| 1d6fbd0bda | |||
| 0814678278 | |||
| 68041f1406 |
62
.github/workflows/build.yml
vendored
62
.github/workflows/build.yml
vendored
@@ -1,62 +0,0 @@
|
||||
name: Build PYZ
|
||||
|
||||
on:
|
||||
push:
|
||||
tags:
|
||||
- 'v*.*.*'
|
||||
|
||||
pull_request:
|
||||
branches: [main]
|
||||
|
||||
workflow_dispatch:
|
||||
|
||||
permissions:
|
||||
contents: write
|
||||
|
||||
jobs:
|
||||
build:
|
||||
runs-on: ubuntu-latest
|
||||
|
||||
steps:
|
||||
- name: Checkout code
|
||||
uses: actions/checkout@v4
|
||||
|
||||
- name: Set up PDM
|
||||
uses: pdm-project/setup-pdm@v4
|
||||
with:
|
||||
python-version: '3.11'
|
||||
|
||||
- name: Install dependencies
|
||||
run: |
|
||||
pdm sync -d -G build
|
||||
|
||||
- name: Build addon
|
||||
run: pdm run compile
|
||||
|
||||
- name: Upload build artifacts
|
||||
if: success()
|
||||
uses: actions/upload-artifact@v4
|
||||
with:
|
||||
name: pyz_build
|
||||
path: ./bin/simple-recorder.pyz
|
||||
|
||||
upload_release:
|
||||
runs-on: ubuntu-latest
|
||||
if: ${{ startsWith(github.ref, 'refs/tags/') }}
|
||||
needs: build
|
||||
|
||||
steps:
|
||||
- name: Download releases files
|
||||
uses: actions/download-artifact@v4.1.7
|
||||
with:
|
||||
name: pyz_build
|
||||
|
||||
- name: Display structure of downloaded files
|
||||
run: tree
|
||||
|
||||
- name: Release
|
||||
uses: softprops/action-gh-release@v1
|
||||
with:
|
||||
files: simple-recorder.pyz
|
||||
fail_on_unmatched_files: true
|
||||
prerelease: ${{ contains(github.ref, '-') }}
|
||||
26
.github/workflows/publish.yml
vendored
Normal file
26
.github/workflows/publish.yml
vendored
Normal file
@@ -0,0 +1,26 @@
|
||||
name: Publish to PyPI
|
||||
|
||||
on:
|
||||
release:
|
||||
types: [published]
|
||||
push:
|
||||
tags:
|
||||
- 'v*.*.*'
|
||||
|
||||
jobs:
|
||||
pypi-publish:
|
||||
name: upload release to PyPI
|
||||
runs-on: ubuntu-latest
|
||||
environment: pypi
|
||||
permissions:
|
||||
# This permission is needed for private repositories.
|
||||
contents: read
|
||||
# IMPORTANT: this permission is mandatory for trusted publishing
|
||||
id-token: write
|
||||
steps:
|
||||
- uses: actions/checkout@v4
|
||||
|
||||
- uses: pdm-project/setup-pdm@v4
|
||||
|
||||
- name: Publish package distributions to PyPI
|
||||
run: pdm publish
|
||||
66
.github/workflows/release.yml
vendored
66
.github/workflows/release.yml
vendored
@@ -1,26 +1,62 @@
|
||||
name: Release
|
||||
name: Release PYZ
|
||||
|
||||
on:
|
||||
release:
|
||||
types: [published]
|
||||
push:
|
||||
tags:
|
||||
- 'v*.*.*'
|
||||
|
||||
pull_request:
|
||||
branches: [main]
|
||||
|
||||
workflow_dispatch:
|
||||
|
||||
permissions:
|
||||
contents: write
|
||||
|
||||
jobs:
|
||||
pypi-publish:
|
||||
name: upload release to PyPI
|
||||
build:
|
||||
runs-on: ubuntu-latest
|
||||
environment: pypi
|
||||
permissions:
|
||||
# This permission is needed for private repositories.
|
||||
contents: read
|
||||
# IMPORTANT: this permission is mandatory for trusted publishing
|
||||
id-token: write
|
||||
|
||||
steps:
|
||||
- uses: actions/checkout@v4
|
||||
- name: Checkout code
|
||||
uses: actions/checkout@v4
|
||||
|
||||
- uses: pdm-project/setup-pdm@v4
|
||||
- name: Set up PDM
|
||||
uses: pdm-project/setup-pdm@v4
|
||||
with:
|
||||
python-version: '3.11'
|
||||
|
||||
- name: Publish package distributions to PyPI
|
||||
run: pdm publish
|
||||
- name: Install dependencies
|
||||
run: |
|
||||
pdm sync -d -G build
|
||||
|
||||
- name: Build addon
|
||||
run: pdm run compile
|
||||
|
||||
- name: Upload build artifacts
|
||||
if: success()
|
||||
uses: actions/upload-artifact@v4
|
||||
with:
|
||||
name: pyz_build
|
||||
path: ./bin/simple-recorder.pyz
|
||||
|
||||
upload_release:
|
||||
runs-on: ubuntu-latest
|
||||
if: ${{ startsWith(github.ref, 'refs/tags/') }}
|
||||
needs: build
|
||||
|
||||
steps:
|
||||
- name: Download releases files
|
||||
uses: actions/download-artifact@v4.1.7
|
||||
with:
|
||||
name: pyz_build
|
||||
|
||||
- name: Display structure of downloaded files
|
||||
run: tree
|
||||
|
||||
- name: Release
|
||||
uses: softprops/action-gh-release@v1
|
||||
with:
|
||||
files: simple-recorder.pyz
|
||||
fail_on_unmatched_files: true
|
||||
prerelease: ${{ contains(github.ref, '-') }}
|
||||
|
||||
19
.github/workflows/ruff.yml
vendored
Normal file
19
.github/workflows/ruff.yml
vendored
Normal file
@@ -0,0 +1,19 @@
|
||||
name: Ruff
|
||||
|
||||
on:
|
||||
push:
|
||||
branches: [main]
|
||||
|
||||
pull_request:
|
||||
branches: [main]
|
||||
|
||||
workflow_dispatch:
|
||||
|
||||
jobs:
|
||||
ruff:
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- uses: actions/checkout@v4
|
||||
- uses: astral-sh/ruff-action@v3
|
||||
with:
|
||||
args: 'format --check --diff'
|
||||
73
README.md
73
README.md
@@ -3,9 +3,7 @@
|
||||
[](https://pdm-project.org)
|
||||
[](https://github.com/astral-sh/ruff)
|
||||
|
||||
A single purpose application for naming file recording in OBS.
|
||||
|
||||
Run it as a CLI or a GUI.
|
||||
A simple OBS recorder app. Run it as a CLI or a GUI.
|
||||
|
||||
---
|
||||
|
||||
@@ -30,7 +28,18 @@ pipx install simple-recorder
|
||||
|
||||
*with pyz*
|
||||
|
||||
An executable pyz has been included in [Releases](https://github.com/onyx-and-iris/simple-recorder/releases) which you can run in Windows. Follow the steps in this [Setting up Windows for Zipapps](https://jhermann.github.io/blog/python/deployment/2020/02/29/python_zippapps_on_windows.html#Setting-Up-Windows-10-for-Zipapps) guide.
|
||||
- Download the pyz file in [Releases](https://github.com/onyx-and-iris/simple-recorder/releases)
|
||||
- Optional step: for automatic discovery of the pyz file follow this guide on [Setting Up Windows for Zippapps](https://jhermann.github.io/blog/python/deployment/2020/02/29/python_zippapps_on_windows.html#Setting-Up-Windows-10-for-Zipapps)
|
||||
|
||||
Finally run the pyz with python (CLI)/pythonw (GUI):
|
||||
|
||||
```console
|
||||
python simple-recorder.pyz <subcommand>
|
||||
|
||||
pythonw simple-recorder.pyz
|
||||
```
|
||||
|
||||
note, the pyz extension won't be required if you followed the optional step and made it discoverable.
|
||||
|
||||
## Configuration
|
||||
|
||||
@@ -51,34 +60,29 @@ OBS_THEME=Reds
|
||||
|
||||
## Use
|
||||
|
||||
### GUI
|
||||
|
||||
To launch the GUI run the root command without any subcommands:
|
||||
|
||||
```console
|
||||
simple-recorder
|
||||
```
|
||||
|
||||

|
||||
|
||||
Just enter the filename and click *Start Recording*.
|
||||
|
||||
#### Themes
|
||||
|
||||
However, passing flags is fine, for example to set the theme:
|
||||
|
||||
```console
|
||||
simple-recorder --theme="Light Purple"
|
||||
```
|
||||
|
||||
### CLI
|
||||
|
||||
To launch the CLI:
|
||||
|
||||
```console
|
||||
simple-recorder start "File Name"
|
||||
|
||||
simple-recorder stop
|
||||
```
|
||||
|
||||
#### Commands:
|
||||
|
||||
```shell
|
||||
Usage: simple-recorder [OPTIONS] COMMAND
|
||||
|
||||
┏━ Subcommands ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓
|
||||
┃ start Start recording ┃
|
||||
┃ stop Stop recording ┃
|
||||
┃ pause Pause recording ┃
|
||||
┃ resume Resume recording ┃
|
||||
┃ split Split the current recording into a new file ┃
|
||||
┃ chapter Create a chapter in the current recording ┃
|
||||
┃ directory Get or set the recording directory ┃
|
||||
┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛
|
||||
|
||||
┏━ Options ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓
|
||||
@@ -90,15 +94,24 @@ Usage: simple-recorder [OPTIONS] COMMAND
|
||||
┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛
|
||||
```
|
||||
|
||||
To launch the CLI pass any subcommand (start/stop etc...), for example:
|
||||
### GUI
|
||||
|
||||
To launch the GUI:
|
||||
|
||||
```console
|
||||
simple-recorder start "File Name"
|
||||
|
||||
simple-recorder stop
|
||||
simple-recorder-gui
|
||||
```
|
||||
|
||||
- If no filename is passed to start then you will be prompted for one.
|
||||
- A default_name will be used if none is supplied to the prompt.
|
||||

|
||||
|
||||
Just enter the filename and click *Start*.
|
||||
|
||||
#### Themes
|
||||
|
||||
You can change the colour theme with the --theme option:
|
||||
|
||||
```console
|
||||
simple-recorder-gui --theme="Light Purple"
|
||||
```
|
||||
|
||||
[obs-studio]: https://obsproject.com/
|
||||
Binary file not shown.
|
Before Width: | Height: | Size: 58 KiB After Width: | Height: | Size: 78 KiB |
8
pdm.lock
generated
8
pdm.lock
generated
@@ -5,7 +5,7 @@
|
||||
groups = ["default", "build"]
|
||||
strategy = ["inherit_metadata"]
|
||||
lock_version = "4.5.0"
|
||||
content_hash = "sha256:292c5ea319597e3539895c1ac50004c884c5d46edd5f7b195ede79156558feab"
|
||||
content_hash = "sha256:e744505d4be91a30830dd1d57d956a6c8775ea75385351b3f4c0d29faddd9ce3"
|
||||
|
||||
[[metadata.targets]]
|
||||
requires_python = ">=3.11"
|
||||
@@ -63,7 +63,7 @@ files = [
|
||||
|
||||
[[package]]
|
||||
name = "obsws-python"
|
||||
version = "1.7.2"
|
||||
version = "1.8.0"
|
||||
requires_python = ">=3.9"
|
||||
summary = "A Python SDK for OBS Studio WebSocket v5.0"
|
||||
groups = ["default"]
|
||||
@@ -72,8 +72,8 @@ dependencies = [
|
||||
"websocket-client",
|
||||
]
|
||||
files = [
|
||||
{file = "obsws_python-1.7.2-py3-none-any.whl", hash = "sha256:acda31852ad9d7165de915b0603c13f6df527d3f61619970bf5fb562e300bc85"},
|
||||
{file = "obsws_python-1.7.2.tar.gz", hash = "sha256:b5cdaad30fbe1f6d4787b6530048b9882f070c3ee7830abb6dad4a47f84d7fa0"},
|
||||
{file = "obsws_python-1.8.0-py3-none-any.whl", hash = "sha256:537bde416e149b6f59e0b2f31761d4a40329feafec171bde6fc1346ab8516e28"},
|
||||
{file = "obsws_python-1.8.0.tar.gz", hash = "sha256:e082894f80deb0836861fdc3c222e497308c8f66328da6075baba5b456a20971"},
|
||||
]
|
||||
|
||||
[[package]]
|
||||
|
||||
@@ -1,12 +1,12 @@
|
||||
[project]
|
||||
name = "simple-recorder"
|
||||
version = "0.1.5"
|
||||
version = "0.5.0"
|
||||
description = "A simple OBS recorder"
|
||||
authors = [{ name = "onyx-and-iris", email = "code@onyxandiris.online" }]
|
||||
dependencies = [
|
||||
"clypi>=1.8.1",
|
||||
"FreeSimpleGUI>=5.2.0.post1",
|
||||
"obsws-python>=1.7.2",
|
||||
"obsws-python>=1.8.0",
|
||||
]
|
||||
requires-python = ">=3.11"
|
||||
readme = "README.md"
|
||||
@@ -15,6 +15,9 @@ license = { text = "MIT" }
|
||||
[project.scripts]
|
||||
simple-recorder = "simple_recorder:run"
|
||||
|
||||
[project.gui-scripts]
|
||||
simple-recorder-gui = "simple_recorder:run"
|
||||
|
||||
[build-system]
|
||||
requires = ["pdm-backend"]
|
||||
build-backend = "pdm.backend"
|
||||
@@ -28,6 +31,4 @@ compile = "shiv -c simple-recorder -o bin/simple-recorder.pyz ."
|
||||
|
||||
|
||||
[dependency-groups]
|
||||
build = [
|
||||
"shiv>=1.0.8",
|
||||
]
|
||||
build = ["shiv>=1.0.8"]
|
||||
|
||||
48
src/simple_recorder/chapter.py
Normal file
48
src/simple_recorder/chapter.py
Normal file
@@ -0,0 +1,48 @@
|
||||
import obsws_python as obsws
|
||||
from clypi import Command, Positional, arg
|
||||
from typing_extensions import override
|
||||
|
||||
from .errors import SimpleRecorderError
|
||||
from .styler import highlight
|
||||
|
||||
|
||||
class Chapter(Command):
|
||||
"""Create a chapter in the current recording."""
|
||||
|
||||
chapter_name: Positional[str] = arg(
|
||||
help="Name of the chapter to create.",
|
||||
prompt="Enter the name for the chapter.",
|
||||
default="unnamed",
|
||||
)
|
||||
host: str = arg(inherited=True)
|
||||
port: int = arg(inherited=True)
|
||||
password: str = arg(inherited=True)
|
||||
|
||||
@override
|
||||
async def run(self):
|
||||
"""Run the chapter command."""
|
||||
try:
|
||||
with obsws.ReqClient(
|
||||
host=self.host, port=self.port, password=self.password, timeout=3
|
||||
) as client:
|
||||
resp = client.get_record_status()
|
||||
if not resp.output_active:
|
||||
raise SimpleRecorderError(
|
||||
"No active recording to create a chapter."
|
||||
)
|
||||
|
||||
# Allow OBS to set unnamed chapters (it will increment the name)
|
||||
if self.chapter_name == "unnamed":
|
||||
client.create_record_chapter()
|
||||
else:
|
||||
client.create_record_chapter(self.chapter_name)
|
||||
print(f"Chapter {highlight(self.chapter_name)} created successfully.")
|
||||
except (ConnectionRefusedError, TimeoutError):
|
||||
raise SimpleRecorderError("Failed to connect to OBS. Is it running?")
|
||||
except obsws.error.OBSSDKRequestError as e:
|
||||
if e.code == 702:
|
||||
raise SimpleRecorderError(
|
||||
"Unable to create chapter, please check your OBS settings."
|
||||
)
|
||||
else:
|
||||
raise SimpleRecorderError(f"Error: {e}")
|
||||
@@ -3,13 +3,16 @@ import logging
|
||||
from clypi import ClypiConfig, ClypiException, Command, arg, configure
|
||||
from typing_extensions import override
|
||||
|
||||
from .chapter import Chapter
|
||||
from .directory import Directory
|
||||
from .errors import SimpleRecorderError
|
||||
from .gui import SimpleRecorderWindow
|
||||
from .pause import Pause
|
||||
from .resume import Resume
|
||||
from .split import Split
|
||||
from .start import Start
|
||||
from .stop import Stop
|
||||
|
||||
logger = logging.getLogger(__name__)
|
||||
|
||||
config = ClypiConfig(
|
||||
nice_errors=(SimpleRecorderError,),
|
||||
)
|
||||
@@ -34,8 +37,11 @@ def theme_parser(value: str) -> str:
|
||||
return value
|
||||
|
||||
|
||||
SUBCOMMANDS = Start | Stop | Pause | Resume | Split | Chapter | Directory
|
||||
|
||||
|
||||
class SimpleRecorder(Command):
|
||||
subcommand: Start | Stop | None = None
|
||||
subcommand: SUBCOMMANDS | None = None
|
||||
host: str = arg(default="localhost", env="OBS_HOST", help="OBS WebSocket host")
|
||||
port: int = arg(default=4455, env="OBS_PORT", help="OBS WebSocket port")
|
||||
password: str | None = arg(
|
||||
@@ -47,6 +53,18 @@ class SimpleRecorder(Command):
|
||||
env="OBS_THEME",
|
||||
help=f"GUI theme ({', '.join(themes)})",
|
||||
)
|
||||
debug: bool = arg(
|
||||
default=False,
|
||||
help="Enable debug logging",
|
||||
hidden=True,
|
||||
)
|
||||
|
||||
@override
|
||||
async def pre_run_hook(self):
|
||||
if self.debug:
|
||||
logging.basicConfig(level=logging.DEBUG)
|
||||
else:
|
||||
logging.basicConfig(level=logging.disable())
|
||||
|
||||
@override
|
||||
async def run(self):
|
||||
|
||||
36
src/simple_recorder/directory.py
Normal file
36
src/simple_recorder/directory.py
Normal file
@@ -0,0 +1,36 @@
|
||||
import obsws_python as obsws
|
||||
from clypi import Command, Positional, arg
|
||||
from typing_extensions import override
|
||||
|
||||
from .errors import SimpleRecorderError
|
||||
from .styler import highlight
|
||||
|
||||
|
||||
class Directory(Command):
|
||||
"""Get or set the recording directory."""
|
||||
|
||||
directory: Positional[str] = arg(
|
||||
default=None,
|
||||
help="Directory to set for recordings. If not provided, the current directory will be displayed.",
|
||||
)
|
||||
host: str = arg(inherited=True)
|
||||
port: int = arg(inherited=True)
|
||||
password: str = arg(inherited=True)
|
||||
|
||||
@override
|
||||
async def run(self):
|
||||
try:
|
||||
with obsws.ReqClient(
|
||||
host=self.host, port=self.port, password=self.password, timeout=3
|
||||
) as client:
|
||||
if self.directory:
|
||||
client.set_record_directory(self.directory)
|
||||
print(f"Recording directory set to: {highlight(self.directory)}")
|
||||
else:
|
||||
resp = client.get_record_directory()
|
||||
print(
|
||||
f"Current recording directory: {highlight(resp.record_directory)}"
|
||||
)
|
||||
return resp.record_directory
|
||||
except (ConnectionRefusedError, TimeoutError):
|
||||
raise SimpleRecorderError("Failed to connect to OBS. Is it running?")
|
||||
@@ -1,8 +1,14 @@
|
||||
import logging
|
||||
|
||||
import FreeSimpleGUI as fsg
|
||||
from clypi import ClypiException
|
||||
import obsws_python as obsws
|
||||
|
||||
from .chapter import Chapter
|
||||
from .directory import Directory
|
||||
from .errors import SimpleRecorderError
|
||||
from .pause import Pause
|
||||
from .resume import Resume
|
||||
from .split import Split
|
||||
from .start import Start
|
||||
from .stop import Stop
|
||||
|
||||
@@ -17,25 +23,104 @@ class SimpleRecorderWindow(fsg.Window):
|
||||
self.password = password
|
||||
fsg.theme(theme)
|
||||
|
||||
layout = [
|
||||
[fsg.Text("Enter recording filename:")],
|
||||
[fsg.InputText("", key="-FILENAME-")],
|
||||
[fsg.Button("Start Recording"), fsg.Button("Stop Recording")],
|
||||
[fsg.Text("Status: Not started", key="-OUTPUT-")],
|
||||
try:
|
||||
with obsws.ReqClient(
|
||||
host=self.host, port=self.port, password=self.password, timeout=3
|
||||
) as client:
|
||||
resp = client.get_version()
|
||||
status_message = f"Connected to OBS {resp.obs_version} ✓"
|
||||
resp = client.get_record_directory()
|
||||
current_directory = resp.record_directory
|
||||
except (ConnectionRefusedError, TimeoutError):
|
||||
status_message = "Failed to connect to OBS. Is it running?"
|
||||
current_directory = ""
|
||||
|
||||
recorder_layout = [
|
||||
[fsg.Text("Enter recording filename:", key="-PROMPT-")],
|
||||
[fsg.InputText("default_name", key="-FILENAME-", focus=True)],
|
||||
[
|
||||
fsg.Button("Start", key="Start Recording", size=(20, 1)),
|
||||
fsg.Button("Stop", key="Stop Recording", size=(20, 1)),
|
||||
],
|
||||
[
|
||||
fsg.Button("Pause", key="Pause Recording", size=(20, 1)),
|
||||
fsg.Button("Resume", key="Resume Recording", size=(20, 1)),
|
||||
],
|
||||
[
|
||||
fsg.Button("Split", key="Split Recording", size=(20, 1)),
|
||||
fsg.Button("Add Chapter", key="Add Chapter", size=(20, 1)),
|
||||
],
|
||||
]
|
||||
super().__init__("Simple Recorder", layout, finalize=True)
|
||||
|
||||
frame = fsg.Frame(
|
||||
"",
|
||||
recorder_layout,
|
||||
relief=fsg.RELIEF_SUNKEN,
|
||||
)
|
||||
|
||||
recorder_tab = fsg.Tab(
|
||||
"Recorder",
|
||||
[
|
||||
[frame],
|
||||
[
|
||||
fsg.Text(
|
||||
f"Status: {status_message}",
|
||||
key="-OUTPUT-RECORDER-",
|
||||
text_color="white"
|
||||
if status_message.startswith("Connected")
|
||||
else "red",
|
||||
)
|
||||
],
|
||||
],
|
||||
)
|
||||
|
||||
settings_layout = [
|
||||
[fsg.Text("Enter the filepath for the recording:")],
|
||||
[fsg.InputText(current_directory, key="-FILEPATH-", size=(45, 1))],
|
||||
[
|
||||
fsg.Button("Get Current", key="-GET-CURRENT-", size=(10, 1)),
|
||||
fsg.Button("Update", key="-UPDATE-", size=(10, 1)),
|
||||
],
|
||||
[fsg.Text("", key="-OUTPUT-SETTINGS-", text_color="white")],
|
||||
]
|
||||
|
||||
settings_tab = fsg.Tab("Settings", settings_layout)
|
||||
|
||||
mainframe = [
|
||||
[fsg.TabGroup([[recorder_tab, settings_tab]])],
|
||||
]
|
||||
|
||||
super().__init__("Simple Recorder", mainframe, finalize=True)
|
||||
self["-FILENAME-"].bind("<Return>", " || RETURN")
|
||||
self["Start Recording"].bind("<Return>", " || RETURN")
|
||||
self["Stop Recording"].bind("<Return>", " || RETURN")
|
||||
self["Pause Recording"].bind("<Return>", " || RETURN")
|
||||
self["Resume Recording"].bind("<Return>", " || RETURN")
|
||||
self["Split Recording"].bind("<Return>", " || RETURN")
|
||||
self["Add Chapter"].bind("<Return>", " || RETURN")
|
||||
self["Add Chapter"].bind("<Shift-Return>", " || SHIFT-RETURN")
|
||||
|
||||
self["-FILENAME-"].update(select=True)
|
||||
self["Add Chapter"].bind("<FocusIn>", " || FOCUS")
|
||||
self["Add Chapter"].bind("<Enter>", " || FOCUS")
|
||||
self["Add Chapter"].bind("<FocusOut>", " || LEAVE")
|
||||
self["Add Chapter"].bind("<Leave>", " || LEAVE")
|
||||
self["Add Chapter"].bind("<Button-3>", " || RIGHT_CLICK")
|
||||
|
||||
self["-GET-CURRENT-"].bind("<Return>", " || RETURN")
|
||||
self["-UPDATE-"].bind("<Return>", " || RETURN")
|
||||
|
||||
async def run(self):
|
||||
chapter_name = "unnamed"
|
||||
|
||||
while True:
|
||||
event, values = self.read()
|
||||
self.logger.debug(f"Event: {event}, Values: {values}")
|
||||
if event == fsg.WIN_CLOSED:
|
||||
break
|
||||
|
||||
match event.split(" || "):
|
||||
case ["Start Recording", "RETURN" | None] | ["-FILENAME-", "RETURN"]:
|
||||
match e := event.split(" || "):
|
||||
case ["Start Recording"] | ["Start Recording" | "-FILENAME-", "RETURN"]:
|
||||
try:
|
||||
await Start(
|
||||
filename=values["-FILENAME-"],
|
||||
@@ -43,28 +128,136 @@ class SimpleRecorderWindow(fsg.Window):
|
||||
port=self.port,
|
||||
password=self.password,
|
||||
).run()
|
||||
self["-OUTPUT-"].update(
|
||||
self["-OUTPUT-RECORDER-"].update(
|
||||
"Recording started successfully", text_color="green"
|
||||
)
|
||||
except ClypiException as e:
|
||||
self["-OUTPUT-"].update(
|
||||
except SimpleRecorderError as e:
|
||||
self["-OUTPUT-RECORDER-"].update(
|
||||
f"Error: {e.raw_message}", text_color="red"
|
||||
)
|
||||
|
||||
case ["Stop Recording", "RETURN" | None]:
|
||||
case ["Stop Recording"] | ["Stop Recording", "RETURN"]:
|
||||
try:
|
||||
await Stop(
|
||||
host=self.host, port=self.port, password=self.password
|
||||
).run()
|
||||
self["-OUTPUT-"].update(
|
||||
self["-OUTPUT-RECORDER-"].update(
|
||||
"Recording stopped successfully", text_color="green"
|
||||
)
|
||||
except ClypiException as e:
|
||||
self["-OUTPUT-"].update(
|
||||
except SimpleRecorderError as e:
|
||||
self["-OUTPUT-RECORDER-"].update(
|
||||
f"Error: {e.raw_message}", text_color="red"
|
||||
)
|
||||
|
||||
case ["Pause Recording"] | ["Pause Recording", "RETURN"]:
|
||||
try:
|
||||
await Pause(
|
||||
host=self.host, port=self.port, password=self.password
|
||||
).run()
|
||||
self["-OUTPUT-RECORDER-"].update(
|
||||
"Recording paused successfully", text_color="green"
|
||||
)
|
||||
except SimpleRecorderError as e:
|
||||
self["-OUTPUT-RECORDER-"].update(
|
||||
f"Error: {e.raw_message}", text_color="red"
|
||||
)
|
||||
|
||||
case ["Resume Recording"] | ["Resume Recording", "RETURN"]:
|
||||
try:
|
||||
await Resume(
|
||||
host=self.host, port=self.port, password=self.password
|
||||
).run()
|
||||
self["-OUTPUT-RECORDER-"].update(
|
||||
"Recording resumed successfully", text_color="green"
|
||||
)
|
||||
except SimpleRecorderError as e:
|
||||
self["-OUTPUT-RECORDER-"].update(
|
||||
f"Error: {e.raw_message}", text_color="red"
|
||||
)
|
||||
|
||||
case ["Add Chapter", "FOCUS" | "LEAVE" as focus_event]:
|
||||
if focus_event == "FOCUS":
|
||||
self["-OUTPUT-RECORDER-"].update(
|
||||
"Right-click to set a chapter name", text_color="white"
|
||||
)
|
||||
else:
|
||||
self["-OUTPUT-RECORDER-"].update("", text_color="white")
|
||||
|
||||
case ["Split Recording"] | ["Split Recording", "RETURN"]:
|
||||
try:
|
||||
await Split(
|
||||
host=self.host, port=self.port, password=self.password
|
||||
).run()
|
||||
self["-OUTPUT-RECORDER-"].update(
|
||||
"Recording split successfully", text_color="green"
|
||||
)
|
||||
except SimpleRecorderError as e:
|
||||
self["-OUTPUT-RECORDER-"].update(
|
||||
f"Error: {e.raw_message}", text_color="red"
|
||||
)
|
||||
|
||||
case ["Add Chapter", "RIGHT_CLICK" | "SHIFT-RETURN"]:
|
||||
chapter_name = fsg.popup_get_text(
|
||||
"Enter chapter name:",
|
||||
"Add Chapter",
|
||||
default_text="unnamed",
|
||||
)
|
||||
|
||||
case ["Add Chapter"] | ["Add Chapter", "RETURN"]:
|
||||
try:
|
||||
await Chapter(
|
||||
chapter_name=chapter_name,
|
||||
host=self.host,
|
||||
port=self.port,
|
||||
password=self.password,
|
||||
).run()
|
||||
self["-OUTPUT-RECORDER-"].update(
|
||||
f"Chapter {chapter_name if chapter_name else 'unnamed'} added successfully",
|
||||
text_color="green",
|
||||
)
|
||||
except SimpleRecorderError:
|
||||
fsg.popup_error(
|
||||
"Unable to create chapter, please check your OBS settings.\n"
|
||||
"Note, currently only Hybrid MP4 is supported for chapters.",
|
||||
title="Chapter Error",
|
||||
keep_on_top=True,
|
||||
)
|
||||
|
||||
case ["-GET-CURRENT-"] | ["-GET-CURRENT-", "RETURN"]:
|
||||
try:
|
||||
current_directory = await Directory(
|
||||
host=self.host, port=self.port, password=self.password
|
||||
).run()
|
||||
self["-FILEPATH-"].update(current_directory)
|
||||
except SimpleRecorderError as e:
|
||||
self["-OUTPUT-SETTINGS-"].update(
|
||||
f"Error: {e.raw_message}", text_color="red"
|
||||
)
|
||||
|
||||
case ["-UPDATE-"] | ["-UPDATE-", "RETURN"]:
|
||||
filepath = values["-FILEPATH-"]
|
||||
if not filepath:
|
||||
self["-OUTPUT-SETTINGS-"].update(
|
||||
"Filepath cannot be empty", text_color="red"
|
||||
)
|
||||
else:
|
||||
try:
|
||||
await Directory(
|
||||
directory=filepath,
|
||||
host=self.host,
|
||||
port=self.port,
|
||||
password=self.password,
|
||||
).run()
|
||||
self["-OUTPUT-SETTINGS-"].update(
|
||||
"Recording directory updated successfully.",
|
||||
text_color="green",
|
||||
)
|
||||
except SimpleRecorderError as e:
|
||||
self["-OUTPUT-SETTINGS-"].update(
|
||||
f"Error: {e.raw_message}", text_color="red"
|
||||
)
|
||||
|
||||
case _:
|
||||
self.logger.warning(f"Unhandled event: {event}")
|
||||
self.logger.debug(f"Unhandled event: {e}")
|
||||
|
||||
self.close()
|
||||
|
||||
30
src/simple_recorder/pause.py
Normal file
30
src/simple_recorder/pause.py
Normal file
@@ -0,0 +1,30 @@
|
||||
import obsws_python as obsws
|
||||
from clypi import Command, arg
|
||||
from typing_extensions import override
|
||||
|
||||
from .errors import SimpleRecorderError
|
||||
|
||||
|
||||
class Pause(Command):
|
||||
"""Pause recording."""
|
||||
|
||||
host: str = arg(inherited=True)
|
||||
port: int = arg(inherited=True)
|
||||
password: str = arg(inherited=True)
|
||||
|
||||
@override
|
||||
async def run(self):
|
||||
try:
|
||||
with obsws.ReqClient(
|
||||
host=self.host, port=self.port, password=self.password, timeout=3
|
||||
) as client:
|
||||
resp = client.get_record_status()
|
||||
if not resp.output_active:
|
||||
raise SimpleRecorderError("No active recording to pause.")
|
||||
if resp.output_paused:
|
||||
raise SimpleRecorderError("Recording is already paused.")
|
||||
|
||||
client.pause_record()
|
||||
print("Recording paused successfully.")
|
||||
except (ConnectionRefusedError, TimeoutError):
|
||||
raise SimpleRecorderError("Failed to connect to OBS. Is it running?")
|
||||
30
src/simple_recorder/resume.py
Normal file
30
src/simple_recorder/resume.py
Normal file
@@ -0,0 +1,30 @@
|
||||
import obsws_python as obsws
|
||||
from clypi import Command, arg
|
||||
from typing_extensions import override
|
||||
|
||||
from .errors import SimpleRecorderError
|
||||
|
||||
|
||||
class Resume(Command):
|
||||
"""Resume recording."""
|
||||
|
||||
host: str = arg(inherited=True)
|
||||
port: int = arg(inherited=True)
|
||||
password: str = arg(inherited=True)
|
||||
|
||||
@override
|
||||
async def run(self):
|
||||
try:
|
||||
with obsws.ReqClient(
|
||||
host=self.host, port=self.port, password=self.password, timeout=3
|
||||
) as client:
|
||||
resp = client.get_record_status()
|
||||
if not resp.output_active:
|
||||
raise SimpleRecorderError("No active recording to resume.")
|
||||
if not resp.output_paused:
|
||||
raise SimpleRecorderError("Recording is not paused.")
|
||||
|
||||
client.resume_record()
|
||||
print("Recording resumed successfully.")
|
||||
except (ConnectionRefusedError, TimeoutError):
|
||||
raise SimpleRecorderError("Failed to connect to OBS. Is it running?")
|
||||
36
src/simple_recorder/split.py
Normal file
36
src/simple_recorder/split.py
Normal file
@@ -0,0 +1,36 @@
|
||||
import obsws_python as obsws
|
||||
from clypi import Command, arg
|
||||
from typing_extensions import override
|
||||
|
||||
from .errors import SimpleRecorderError
|
||||
|
||||
|
||||
class Split(Command):
|
||||
"""Split the current recording into a new file."""
|
||||
|
||||
host: str = arg(inherited=True)
|
||||
port: int = arg(inherited=True)
|
||||
password: str = arg(inherited=True)
|
||||
|
||||
@override
|
||||
async def run(self):
|
||||
"""Run the split command."""
|
||||
try:
|
||||
with obsws.ReqClient(
|
||||
host=self.host, port=self.port, password=self.password, timeout=3
|
||||
) as client:
|
||||
resp = client.get_record_status()
|
||||
if not resp.output_active:
|
||||
raise SimpleRecorderError("No active recording to split.")
|
||||
|
||||
client.split_record_file()
|
||||
print("Recording split successfully.")
|
||||
except (ConnectionRefusedError, TimeoutError):
|
||||
raise SimpleRecorderError("Failed to connect to OBS. Is it running?")
|
||||
except obsws.error.OBSSDKRequestError as e:
|
||||
if e.code == 702:
|
||||
raise SimpleRecorderError(
|
||||
"Unable to split file, please check your OBS settings."
|
||||
)
|
||||
else:
|
||||
raise SimpleRecorderError(f"Error: {e.code} - {e.message}")
|
||||
@@ -29,8 +29,9 @@ class Start(Command):
|
||||
if not self.filename:
|
||||
raise SimpleRecorderError("Recording name cannot be empty.")
|
||||
|
||||
try:
|
||||
with obsws.ReqClient(
|
||||
host=self.host, port=self.port, password=self.password
|
||||
host=self.host, port=self.port, password=self.password, timeout=3
|
||||
) as client:
|
||||
resp = client.get_record_status()
|
||||
if resp.output_active:
|
||||
@@ -44,3 +45,5 @@ class Start(Command):
|
||||
)
|
||||
client.start_record()
|
||||
print(f"Recording started with filename: {highlight(filename)}")
|
||||
except (ConnectionRefusedError, TimeoutError):
|
||||
raise SimpleRecorderError("Failed to connect to OBS. Is it running?")
|
||||
|
||||
@@ -3,7 +3,6 @@ from clypi import Command, arg
|
||||
from typing_extensions import override
|
||||
|
||||
from .errors import SimpleRecorderError
|
||||
from .styler import highlight
|
||||
|
||||
|
||||
class Stop(Command):
|
||||
@@ -15,12 +14,15 @@ class Stop(Command):
|
||||
|
||||
@override
|
||||
async def run(self):
|
||||
try:
|
||||
with obsws.ReqClient(
|
||||
host=self.host, port=self.port, password=self.password
|
||||
host=self.host, port=self.port, password=self.password, timeout=3
|
||||
) as client:
|
||||
resp = client.get_record_status()
|
||||
if not resp.output_active:
|
||||
raise SimpleRecorderError("Recording is not active.")
|
||||
|
||||
client.stop_record()
|
||||
print(highlight("Recording stopped successfully."))
|
||||
print("Recording stopped successfully.")
|
||||
except (ConnectionRefusedError, TimeoutError):
|
||||
raise SimpleRecorderError("Failed to connect to OBS. Is it running?")
|
||||
|
||||
Reference in New Issue
Block a user