mirror of
https://github.com/onyx-and-iris/simple-recorder.git
synced 2026-04-21 00:33:36 +00:00
Compare commits
7 Commits
add-split-
...
0814678278
| Author | SHA1 | Date | |
|---|---|---|---|
| 0814678278 | |||
| 68041f1406 | |||
| bba2361964 | |||
| d8cdae61a9 | |||
| a43813fc00 | |||
| 87dbd0b8e5 | |||
| 00dbe43479 |
19
README.md
19
README.md
@@ -30,7 +30,7 @@ pipx install simple-recorder
|
||||
|
||||
*with pyz*
|
||||
|
||||
An executable pyz has been included in [Release](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.
|
||||
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.
|
||||
|
||||
## Configuration
|
||||
|
||||
@@ -65,33 +65,32 @@ Just enter the filename and click *Start Recording*.
|
||||
|
||||
#### Themes
|
||||
|
||||
Passing flags is fine, however, for example to set the theme:
|
||||
However, passing flags is fine, for example to set the theme:
|
||||
|
||||
```console
|
||||
simple-recorder --theme="Light Purple"
|
||||
```
|
||||
|
||||
Available themes: Light Purple, Neutral Blue, Reds, Sandy Beach, Kayak, Light Blue 2, Dark Teal1
|
||||
|
||||
### CLI
|
||||
|
||||
```shell
|
||||
Usage: simple-recorder [OPTIONS] COMMAND
|
||||
|
||||
┏━ Subcommands ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓
|
||||
┏━ Subcommands ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓
|
||||
┃ start Start recording ┃
|
||||
┃ stop Stop recording ┃
|
||||
┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛
|
||||
┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛
|
||||
|
||||
┏━ Options ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓
|
||||
┏━ Options ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓
|
||||
┃ --host <HOST> OBS WebSocket host ┃
|
||||
┃ --port <PORT> OBS WebSocket port ┃
|
||||
┃ --password <PASSWORD> OBS WebSocket password ┃
|
||||
┃ --theme <THEME> OBS WebSocket theme ┃
|
||||
┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛
|
||||
┃ --theme <THEME> GUI theme (Light Purple, Neutral Blue, Reds, Sandy Beach, ┃
|
||||
┃ Kayak, Light Blue 2) ┃
|
||||
┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛
|
||||
```
|
||||
|
||||
For example:
|
||||
To launch the CLI pass any subcommand (start/stop etc...), for example:
|
||||
|
||||
```console
|
||||
simple-recorder start "File Name"
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
[project]
|
||||
name = "simple-recorder"
|
||||
version = "0.1.3"
|
||||
version = "0.1.7"
|
||||
description = "A simple OBS recorder"
|
||||
authors = [{ name = "onyx-and-iris", email = "code@onyxandiris.online" }]
|
||||
dependencies = [
|
||||
|
||||
@@ -5,7 +5,6 @@ from typing_extensions import override
|
||||
|
||||
from .errors import SimpleRecorderError
|
||||
from .gui import SimpleRecorderWindow
|
||||
from .split import Split
|
||||
from .start import Start
|
||||
from .stop import Stop
|
||||
|
||||
@@ -16,9 +15,6 @@ config = ClypiConfig(
|
||||
)
|
||||
configure(config)
|
||||
|
||||
|
||||
def theme_parser(value: str) -> str:
|
||||
"""Parse the theme argument."""
|
||||
themes = [
|
||||
"Light Purple",
|
||||
"Neutral Blue",
|
||||
@@ -26,8 +22,11 @@ def theme_parser(value: str) -> str:
|
||||
"Sandy Beach",
|
||||
"Kayak",
|
||||
"Light Blue 2",
|
||||
"Dark Teal1",
|
||||
]
|
||||
|
||||
|
||||
def theme_parser(value: str) -> str:
|
||||
"""Parse the theme argument."""
|
||||
if value not in themes:
|
||||
raise ClypiException(
|
||||
f"Invalid theme: {value}. Available themes: {', '.join(themes)}"
|
||||
@@ -36,19 +35,31 @@ def theme_parser(value: str) -> str:
|
||||
|
||||
|
||||
class SimpleRecorder(Command):
|
||||
subcommand: Start | Stop | Split | None = None
|
||||
subcommand: Start | Stop | 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(
|
||||
default=None, env="OBS_PASSWORD", help="OBS WebSocket password"
|
||||
)
|
||||
theme: str = arg(
|
||||
default="Reds", parser=theme_parser, env="OBS_THEME", help="OBS WebSocket theme"
|
||||
default="Reds",
|
||||
parser=theme_parser,
|
||||
env="OBS_THEME",
|
||||
help=f"GUI theme ({', '.join(themes)})",
|
||||
)
|
||||
debug: bool = arg(
|
||||
default=False,
|
||||
env="DEBUG",
|
||||
help="Enable debug logging",
|
||||
hidden=True,
|
||||
)
|
||||
|
||||
@override
|
||||
async def run(self):
|
||||
"""Run the Simple Recorder GUI."""
|
||||
if self.debug:
|
||||
logging.basicConfig(level=logging.DEBUG)
|
||||
|
||||
window = SimpleRecorderWindow(self.host, self.port, self.password, self.theme)
|
||||
await window.run()
|
||||
|
||||
|
||||
@@ -1,9 +1,8 @@
|
||||
import logging
|
||||
|
||||
import FreeSimpleGUI as fsg
|
||||
from clypi import ClypiException
|
||||
|
||||
from .split import Split
|
||||
from .errors import SimpleRecorderError
|
||||
from .start import Start
|
||||
from .stop import Stop
|
||||
|
||||
@@ -21,27 +20,23 @@ class SimpleRecorderWindow(fsg.Window):
|
||||
layout = [
|
||||
[fsg.Text("Enter recording filename:")],
|
||||
[fsg.InputText("", key="-FILENAME-")],
|
||||
[
|
||||
fsg.Button("Start Recording"),
|
||||
fsg.Button("Stop Recording"),
|
||||
fsg.Button("Split Recording"),
|
||||
],
|
||||
[fsg.Button("Start Recording"), fsg.Button("Stop Recording")],
|
||||
[fsg.Text("Status: Not started", key="-OUTPUT-")],
|
||||
]
|
||||
super().__init__("Simple Recorder", layout, finalize=True)
|
||||
self["-FILENAME-"].bind("<Return>", " || RETURN")
|
||||
self["Start Recording"].bind("<Return>", " || RETURN")
|
||||
self["Stop Recording"].bind("<Return>", " || RETURN")
|
||||
self["Split Recording"].bind("<Return>", " || RETURN")
|
||||
|
||||
async def run(self):
|
||||
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-"],
|
||||
@@ -52,12 +47,12 @@ class SimpleRecorderWindow(fsg.Window):
|
||||
self["-OUTPUT-"].update(
|
||||
"Recording started successfully", text_color="green"
|
||||
)
|
||||
except ClypiException as e:
|
||||
except SimpleRecorderError as e:
|
||||
self["-OUTPUT-"].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
|
||||
@@ -65,25 +60,12 @@ class SimpleRecorderWindow(fsg.Window):
|
||||
self["-OUTPUT-"].update(
|
||||
"Recording stopped successfully", text_color="green"
|
||||
)
|
||||
except ClypiException as e:
|
||||
self["-OUTPUT-"].update(
|
||||
f"Error: {e.raw_message}", text_color="red"
|
||||
)
|
||||
|
||||
case ["Split Recording", "RETURN" | None]:
|
||||
try:
|
||||
await Split(
|
||||
host=self.host, port=self.port, password=self.password
|
||||
).run()
|
||||
self["-OUTPUT-"].update(
|
||||
"Recording split successfully", text_color="green"
|
||||
)
|
||||
except ClypiException as e:
|
||||
except SimpleRecorderError as e:
|
||||
self["-OUTPUT-"].update(
|
||||
f"Error: {e.raw_message}", text_color="red"
|
||||
)
|
||||
|
||||
case _:
|
||||
self.logger.warning(f"Unhandled event: {event}")
|
||||
self.logger.warning(f"Unhandled event: {e}")
|
||||
|
||||
self.close()
|
||||
|
||||
@@ -1,27 +0,0 @@
|
||||
import obsws_python as obsws
|
||||
from clypi import Command, arg
|
||||
|
||||
from .errors import SimpleRecorderError
|
||||
|
||||
|
||||
class Split(Command):
|
||||
"""Split recording."""
|
||||
|
||||
host: str = arg(inherited=True)
|
||||
port: int = arg(inherited=True)
|
||||
password: str = arg(inherited=True)
|
||||
|
||||
async def run(self):
|
||||
with obsws.ReqClient(
|
||||
host=self.host, port=self.port, password=self.password
|
||||
) as client:
|
||||
resp = client.get_record_status()
|
||||
if not resp.output_active:
|
||||
raise SimpleRecorderError("Recording is not active.")
|
||||
if resp.output_paused:
|
||||
raise SimpleRecorderError(
|
||||
"Recording is paused. Please resume before splitting."
|
||||
)
|
||||
|
||||
client.split_record_file()
|
||||
print("Recording split successfully.")
|
||||
Reference in New Issue
Block a user