Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Canvases - Part Tres (Multitrack Changes) #11833

Draft
wants to merge 18 commits into
base: master
Choose a base branch
from
Draft

Canvases - Part Tres (Multitrack Changes) #11833

wants to merge 18 commits into from

Conversation

dsaedtler
Copy link
Contributor

@dsaedtler dsaedtler commented Feb 5, 2025 •
edited
Loading

Description

Note

This contains the two previous PRs (#11823, #11832) and hence is a draft.

Adds canvases to the multitrack output and settings.

  • Updates multitrack schema to the latest version (2025-01-25)
  • Adds combobox to select an additional canvas for use with multitrack
  • Adds selected canvases to API request
  • Configures encoders to use canvas video instead of always using the main video
  • Bumps the limit for encoders per output to 10
    • In the future we might want to do 4+3 or 5+2 on GPUs capaable enough to not sacrifice too much on the landscape canvas, raising this to 10 should be relatively unproblematic, and it's a limit we have used in our closed beta builds for the past year

Motivation and Context

Allow multi-format (landscape + portrait) streaming. Plus potentially other multi-canvas use-cases in the future.

Documentation for the changes to the GetClientConfiguration API schema is here: https://d50yg09cghihd.cloudfront.net/other/20250207-DualFormatApiSpecification.pdf

How Has This Been Tested?

This was tested with this fork of the vertical canvas plugin that makes use of the new APIs: https://github.com/dsaedtler/obs-vertical-canvas

Note that the server-side changes are not yet live, and once they are live this feature will be restricted to select users while the Twitch/IVS components are being built.

Types of changes

  • New feature (non-breaking change which adds functionality)

Checklist:

  • My code has been run through clang-format.
  • I have read the contributing document.
  • My code is not on the master branch.
  • The code has been tested.
  • All commit messages are properly formatted and commits squashed where appropriate.
  • I have included updates to all appropriate documentation.

@dsaedtler @derrod
libobs: Add view type to view object
78edf37 
Allos creating additional views that act like a MAIN_VIEW instead of AUX_VIEW.
@dsaedtler
libobs: Introduce Canvases
c32757f 
This adds a new obs_canvas object that acts as a shareable
(reference-counted) owner of views, mixes, and (optionally) scenes.

This is a step towards faciliatating multi-canvas and multi-output
features in OBS Studio.

It solves a number of complications that exist with the manual approach
of using views, such as audio mixing, source active-state tracking, and
scenes not havinga  reliable way of identifying the actual available
canvas size.
@dsaedtler
libobs: Add Canvas object RAII wrappers
b8a8f72
@dsaedtler
libobs: Use UUIDs in scene undo/redo data
3f25c89 
Since scenes now can have non-unique names by being part of different
canvases, use UUIDs instead.
@dsaedtler
libobs: Add video_reset signal
0c72738 
Signals when a video reset has completed. This is mainly useful when
canvases or views are used, whose mixes will have been freed or
recreated during the reset.
@dsaedtler
libobs: Add video_reset signal for canvases
7ae8309 
In addition to the global reset, canvas video can be reset
independently. This signal can be used to detect if the canvas video
was reset, whether by another API user or through a global reset.
@dsaedtler
docs: Add canvases documentation
8b1352e
@dsaedtler
libobs: Add canvas rendering APIs
0cd0b70
@dsaedtler
libobs: Remove groups from scenes when removing from old canvas
4979769
@dsaedtler
libobs: Do not enumerate groups in obs_canvas_enum_scenes
415ac57
@dsaedtler
libobs: Only send source_create for main canvas
ef8da66
@dsaedtler
libobs: Add source_create_canvas signal
63f97a8
@dsaedtler
frontend: Add support loading/saving additional canvases
b03f302
@dsaedtler
frontend: Add frontend API canvas methods
be49017
@dsaedtler
frontend: Update multitrack API model
ffdf11c 
"revision" was defined to be a string in the schema but accepted
integers, this is enforced with the new schema version.
@dsaedtler
frontend: Always limit multitrack video encoders to libobs maximum
715c890
@dsaedtler
libobs: Raise max number of output encoders to 10
523860b
@dsaedtler
frontend: Allow selecting additional canvases for multitrack
ac89ae2
@dsaedtler dsaedtler force-pushed the rodney/multi-canvas-multitrack branch from 59c2394 to 63f97a8 Compare February 6, 2025 21:56
@WizardCM WizardCM added the New Feature New feature or plugin label Feb 12, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
New Feature New feature or plugin
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@dsaedtler @WizardCM