Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions Cargo.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

65 changes: 38 additions & 27 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ cargo run --release -p moq-studio --features capture,openh264 -- \
- `show.toml` is the scene collection. If it does not exist yet,
[guided setup](#first-launch) proposes one and creates it. Changes are saved
to it a second after you stop editing, with no save step.
- `--recordings <dir>` is where recordings are saved, by default beside
- `--recordings <dir>` is where recordings and clips are saved, by default beside
`show.toml`.
- Without `--connect`, the studio composes, previews, and records but
publishes nothing, and broadcast sources stay offline.
Expand Down Expand Up @@ -141,9 +141,9 @@ macOS the system's buttons and edges stay. It holds, from the left:
- The health dot, the stream's worst grade at a glance. Click it for each
relay, who is watching, the encoder, and each problem, and **Details** for
the [Health](#health) window. It reads **Not live** without `--connect`.
- Record, which starts or stops a [recording](#recording) with REVIEW's
picks. Its dot pulses while recording, and says for how long under the
pointer.
- Record, which starts or stops a [recording](#recording) from any page, with
the picks in Settings' Recording tab. Its dot pulses while recording, with
how long it has been recording beside it.
- The live control: **LIVE** and how long the studio has been live, with
`--connect`, or **NOT LIVE** without it. The studio goes live at launch,
so it starts and ends nothing yet.
Expand Down Expand Up @@ -184,7 +184,7 @@ The **strip** holds:
| LIVE | Watch the program while on air, and TAKE or AUTO a cued scene. |
| BUILD | Edit the scene on program, or the one open off air, shown in the middle, with its layers and what can be added on the left and the inspector on the right (see [BUILD](#build)). |
| MIX | Add, rename, reorder, and remove audio scenes, pick the audio scene on program and the one to listen to and on which output, set each sound's gain, pan, mute, and delay, and send each sound and audio scene into audio scenes, with a meter on every one. The program shows small in the strip's place for the sound. |
| REVIEW | Replay the last moments of the program or a source in a replay source, slowed down if you like, or save them as a clip (see [Replay](#replay)), and start and stop recording and pick the picture and the audio scene it records (see [Recording](#recording)), beside the program. |
| REVIEW | Pick a stretch of the last 30 seconds of the program or a source from a strip of its pictures, and replay it in a replay source, slowed down if you like, or save it as a clip (see [Replay](#replay)). Beside it, this show's recordings and clips as cards with their length and size, one repaired after a crash marked so, and **Open the folder**. The program's card is the live picture. |

The layout follows the program's shape and the window's size, giving the
picture the most room it can. A landscape program sits above the strip; a
Expand Down Expand Up @@ -297,6 +297,7 @@ the [hotkeys](#hotkeys), not in the scene file.
| Tab | Use it to |
| --- | --- |
| Show | Set the canvas size and frame rate and each scene's size, see the broadcast path, whether the program is encoding, the encoder sessions open, and the encoder work of the program, the recording, and each published scene, and turn the virtual camera of the program or of each published scene on. |
| Recording | See and open the recordings folder, and pick the picture and the audio scene a recording holds, and whether each source records a file of its own too (see [Recording](#recording)). |
| Hotkeys | Bind keys to the panic key, TAKE, AUTO, Studio mode, replay, save a clip, start or stop recording, and take or cue each scene, and clear them (see [Hotkeys](#hotkeys)). |
| Effects | Pick how the window's [effects](#effects) move. |
| Advanced | See the sources, scenes, and audio scenes as nodes, wired left to right to what draws or holds them, and wire them there (see [Scene graph](#scene-graph)). |
Expand Down Expand Up @@ -503,7 +504,7 @@ each other audio scene. A source added from BUILD's Add, or
pasted, is sent to the audio scene on program, so it is heard at once.
**On program** picks the audio scene the broadcast carries, and switching
it, or editing an audio scene, never drops or repeats audio. A recording holds
the audio scene on program unless REVIEW picks another, such as one
the audio scene on program unless Settings' Recording tab picks another, such as one
keeping music the stream leaves out, and each published scene carries the one
on program unless BUILD's inspector picks another beside its **Publish** switch;
switching either while it runs never drops or repeats audio either. The audio
Expand Down Expand Up @@ -1143,7 +1144,7 @@ placed, and so does every audio scene's mix. The studio draws it only as
viewers will: over the program, on every page and in the program's
virtual camera, so both show what viewers see. It goes over every other layer of its scene, and over the always-on-top layers,
however the scene stacks it. Recordings hold the program as published,
without it, and recording **each source too** gives a published camera,
without it, and recording **Each source too** gives a published camera,
display, window, or microphone a file of its own. Published and recorded
scenes, and a scene that shows the program, leave it out too. While viewers read its track, it claims its bitrate of the connection beside the program's, and its video encodes at what the connection grants it. Its track carries one rendition, the
plain capture before any filter or gain, and encodes for as long as it is
Expand Down Expand Up @@ -1228,14 +1229,14 @@ once `moq play` plays layers.

### Recording

**Start recording** on REVIEW, or record in the title bar, saves the program at the canvas size,
or the scene picked beside it at its own size,
The record button in the title bar, on any page, saves the program at the
canvas size, or the scene picked in Settings' Recording tab at its own size,
to `<scene file name> <UTC start time>.mp4` in the `--recordings` directory,
live or not. The recording has an encoder of its own, opened only while it
records, at full quality whatever the uplink grants the live stream, as OBS's
advanced output mode records apart from streaming. It costs one more encode
session and one more copy of each program frame while recording. With
**each source too**, every camera, display, window, microphone, and system
**Each source too** in Settings' Recording tab, every camera, display, window, microphone, and system
audio records its own track into a file of its own beside it,
`<scene file name> <UTC start time> <source>.mp4`, holding the capture before
any filter, or the sound before its gain and mute; a source being recorded
Expand All @@ -1258,7 +1259,7 @@ program and local sources are read from the studio's own broadcasts, never what
the relay serves, so a recording starts and stops without touching the live
stream. The audio scene it holds is
encoded a second time for it while recording: the one on program, so the file
holds what viewers hear, or the one REVIEW picks, which viewers never
holds what viewers hear, or the one Settings' Recording tab picks, which viewers never
can. Without `--connect`, only the
recording's encoder encodes the program.

Expand All @@ -1275,7 +1276,7 @@ beside it, numbered if a file already has that name, a regular MP4 of
everything the file holds up to its last complete fragment, leaves the
original untouched, and removes the marker, so the file is repaired
only once. The repair runs in the background and appears at the top of the
Health window and in the log. A file another studio is still recording into the
Health window and in the log, and REVIEW marks its card **Repaired after a crash**. A file another studio is still recording into the
same directory is left alone.

### Source frames
Expand Down Expand Up @@ -1303,8 +1304,10 @@ which its key takes, or cues in Studio mode, as its pad does; the tab says
which. Press **Bind**, then the key with any modifiers; Escape, or leaving
the window or the tab, cancels. Every action starts unbound, so no key a game
uses is taken unasked, and a key bound to one action is refused for another
until it is cleared there. Replay, Save clip, and a recording use REVIEW's
picks.
until it is cleared there. Replay and Save clip use REVIEW's picks, but take
the last seconds as long as the stretch picked there, so a key pressed from
another page acts on what just happened, as the clip button beside the panic
key does; a recording uses Settings' Recording tab.

The key pressed is the key that fires, wherever it sits, on any keyboard layout
and after a layout change: the tab names it as the layout printed it when it
Expand Down Expand Up @@ -1362,19 +1365,27 @@ and on Linux the desktop's, through its Settings portal.
## Replay

Add a `replay` source and place it like any other, such as full screen in a
scene of its own. On REVIEW, pick the program or a source, a length
up to 30 seconds, and a speed of 100%, 50%, or 25%, then **Replay** plays that
many seconds up to the click in the replay source, which is transparent before
and after. Take its scene to put it on program. Sound replays only at
100%, through the replay source's strip on MIX, so a replay of a
microphone or system audio, which has only sound, plays only at 100%. A new
replay cuts
off the one playing, and a stretch the source was offline or paused replays
as the gap it was.

**Save clip** writes the same seconds, in real time, beside the scene file as a
regular MP4: `show-clip-1.mp4` for `show.toml`, then `show-clip-2.mp4`, and so
on. Nothing is re-encoded, so a clip starts at the keyframe before those
scene of its own. On REVIEW, pick what to replay, the program or a source, by
its card, and a speed of 100%, 50%, or 25%. The strip shows the last 30
seconds of what is picked, a picture each time its track starts a group,
which is each keyframe. Drag the amber handles to pick any stretch of it,
and click or drag elsewhere on the strip to move the scrub head: the large
picture is the one under the head. With the right handle at the strip's right
edge, the stretch is the last that many seconds up to the click; dragged
left of it, the stretch stays on the moments picked as time goes on, until it
ages out of the 30 seconds. **Replay** plays the stretch in the replay source,
which is transparent before and after; with more than one replay source,
pick which one under the speed. Take its scene to put it on program.
Sound replays only at 100%, through the replay source's strip on MIX, so a
replay of a microphone or system audio, which has only sound, plays only at
100%. A new replay cuts off the one playing, and a stretch the source was
offline or paused replays as the gap it was. When Replay or Save clip cannot
act, such as off air with no relay or for a source with no past, it says why
in place of what it would do.

**Save clip** writes the same stretch, in real time, into the recordings
folder as a regular MP4: `show-clip-1.mp4` for `show.toml`, then
`show-clip-2.mp4`, and so on. Nothing is re-encoded, so a clip starts at the keyframe before those
seconds, up to one keyframe interval earlier. It shows nothing after them, so
video with B-frames can end early: the pictures shown before the end that refer
to one shown after it are left out, along with everything decoded after that
Expand Down
42 changes: 0 additions & 42 deletions quest/m0/ux/review.md

This file was deleted.

30 changes: 30 additions & 0 deletions quest/m0/ux/try-review.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
# [XS] Try the REVIEW page

## Goal

The maintainer tries the REVIEW page on their own machine and either signs it
off or files what they find as quests: what the epic's
[What a person must check](/quest/m0/ux/README.md) asks of it, which no
headless run exercises.

## Plan

The REVIEW page is on `main` (`cargo run -p moq-studio --features capture`).
What to try, on a show going live to a relay:

- **Feel:** scrubbing the strip's head and dragging the two amber handles to
pick a stretch, then Replay and Save clip; whether the strip keeps up.
- **Look:** whether the page reads like its
[mock-up](/quest/m0/ux/mock/review-review.webp).
- **Readability:** the strip's ruler and AIR/AGO labels, and the cards'
length, size, and age, at a normal window size.

An agent then turns each finding into a quest, or an edit to the quest that
owns that part of the page, and deletes this one.

## Waiting

- Maintainer: try the REVIEW page as the Plan lists and report what to change,
or that nothing needs to. An agent cannot judge feel or taste; a kittest run
and `just shots` already cover the clicks and the layout. Check: a comment
or quest records the result.
4 changes: 0 additions & 4 deletions quest/m2/markers.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,3 @@ Planned 2026-11-09 (maintainer, /quest-plan), and held for later: ✅ m2
same keyframe limits apply.
- Chapters are written when a recording becomes a regular MP4.
- Marker is a hotkey action.

## Required

- [The REVIEW page](/quest/m0/ux/review.md) - the strip and the list markers appear on
24 changes: 24 additions & 0 deletions quest/m3/card-pictures.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
# [S] Pictures on REVIEW's recording and clip cards

## Goal

Each finished recording's and clip's card on the REVIEW page of
[`mock/review.html`](/quest/m0/ux/mock/review.html) shows the file's first
picture, where it shows a placeholder tile today.

## Plan

Decided 2026-11-15 (agent's recommendation on moq-dev/studio#177, which the
maintainer kept when picking it to merge): ✅ decode through moq-mux's regular MP4 import
(rejected: reading the first sample here with `mp4-atom`, since demuxing
belongs in moq; dropping the pictures from the mock-up).

The picture is the file's first video sample, imported through moq-mux and
decoded small once per file in the shelf's background listing
(`rs/moq-studio/src/shelf.rs`), as the strip decodes keyframes
(`rs/moq-studio/src/past.rs`). A recording under way already shows the live
picture. The placeholder is painted in `rs/moq-studio/src/ui/review.rs`.

## Required

- [MP4 import pinned](/quest/m3/pin-mp4-import.md) - brings moq-mux's regular MP4 import into the `moq` submodule
22 changes: 22 additions & 0 deletions quest/m3/pin-mp4-import.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
# [XS] moq-mux's regular MP4 import is pinned

## Goal

The `moq` submodule includes moq-mux's import of a regular, non-fragmented
MP4, from
[moq-mux imports a regular MP4](https://github.com/moq-dev/moq/blob/main/quest/m3/mp4-import.md).

## Plan

Once the wait clears, advance it with `just upgrade-moq` in its own PR,
fixing whatever the new API breaks here.

Here in m3 because the upstream quest is in moq's m3 (maintainer, 2026-11-05);
move both up together if the studio needs it sooner.

## Waiting

- moq-dev/moq: the upstream quest above lands. Check: that quest's PR has
merged on moq's `main`, deleting its file, and `ContainerFormat` in
`rs/moq-mux/src/import/format.rs` offers regular MP4. A quest file that
moved, or went away without its work landing, does not count.
14 changes: 10 additions & 4 deletions rs/moq-studio/Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -68,6 +68,9 @@ moq-scene = { workspace = true }
moq-stats = { workspace = true, features = ["async"] }
moq-tokio = { workspace = true, default-features = false, features = ["net"] }
moq-video = { workspace = true }
# A recording's length, from its movie header; the version moq-mux writes it
# with.
mp4-atom = "0.17.0"
pollster = { workspace = true }
# The join link's QR code. No dependencies of its own.
qrcodegen = "1.8"
Expand Down Expand Up @@ -110,6 +113,10 @@ raw-window-handle = "0.6"
# tells a held key's repeats from new presses.
x11rb = { version = "0.13", features = ["xkb"] }

[target.'cfg(unix)'.dependencies]
# The room left on the recordings folder's disk. moq-scene's release.
rustix = { version = "1", features = ["fs"] }

[target.'cfg(any(target_os = "macos", windows))'.dependencies]
# System-wide hotkeys on macOS and Windows; X11 grabs keys itself, and Wayland
# goes through the GlobalShortcuts portal.
Expand All @@ -123,8 +130,9 @@ objc2-app-kit = { version = "0.3", default-features = false, features = ["std",
[target.'cfg(windows)'.dependencies]
# Which virtual key the foreground window's layout puts on each key, so a
# hotkey registers the key pressed, and whether the system asks apps to
# reduce motion, for the effects.
windows-sys = { version = "0.61", features = ["Win32_UI_Input_KeyboardAndMouse", "Win32_UI_WindowsAndMessaging"] }
# reduce motion, for the effects, and the room left on the recordings folder's
# disk.
windows-sys = { version = "0.61", features = ["Win32_Storage_FileSystem", "Win32_UI_Input_KeyboardAndMouse", "Win32_UI_WindowsAndMessaging"] }

[build-dependencies]
# Rasterizes the app icon's SVG for the window. No text or embedded images, so
Expand All @@ -138,8 +146,6 @@ egui_kittest = { version = "0.36", features = ["eframe", "wgpu"] }
image = { version = "0.25", default-features = false, features = ["png"] }
# A clock that moves wall time too, which renewed tokens' expiries read.
kio = { workspace = true, features = ["manual"] }
# Reads a saved clip's timeline back; the version moq-mux writes it with.
mp4-atom = "0.17.0"
# The auth server a test relay verifies guest tokens with.
moq-auth = { workspace = true, features = ["serve"] }
moq-relay = { workspace = true, features = ["test-support"] }
Expand Down
16 changes: 16 additions & 0 deletions rs/moq-studio/assets/icons/download.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
14 changes: 14 additions & 0 deletions rs/moq-studio/assets/icons/folder.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading