obs-ffmpeg: Add end action UI property for local file source #6239

mvji · 2022-03-28T20:31:10Z

For local file, replace UI properties :
"Loop" and "Show nothing when playback ends"
by a property list call End Action
with three possible values : Hide, Freeze, Loop

Description

Currently in Obs FFmpeg source, when using local file
the end action of a video file, can be set to three mode,
using two checkbox (loop and Show nothing when playback ends)
If loop is choose, the checkbox "Show nothing when playback ends", do nothing.
The UI proposal, is to use a property list, with the three mode when local file is checked
Doesn't change the UI when Local file is unchecked.
Internally, doesn't change the way is_looping and clear_media_end works.

Motivation and Context

Having something more easy to understand for user, to define end action of a local video file.

How Has This Been Tested?

Mac os 11.6.2
Mac intel, Xcode
Tested using local file, and checking the three mode.

Types of changes

Tweak (non-breaking change to improve existing functionality)

Checklist:

I'm not sure it's the cleanest way to implement it.
Mainly for UI change for non local file, and using integer or enum for property list.

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.

RytoEX · 2022-03-28T20:35:42Z

When changing properties like this, you need to account for existing setups in the wild. You should cleanly migrate such settings to the equivalent value in the new settings or version the source such that old versions still work unchanged while newly added sources use the new behavior.

mvji · 2022-03-29T10:40:50Z

I update the patch. And let the previous property "looping", but hide it.
And add callback, when parameter change, to update the new property list.
Tested with a scene with 3 local file (in each end action mode). Opening and modify it in previous version and current version. Behaviour stay the same when switching between the two version

WizardCM · 2022-04-02T02:09:18Z

I'm not 100% sold on terminology. I think at the very least, "Freeze on final frame" (if that's what happens) would be better than "Freeze". If the "Hide" action doesn't actually toggle the eye to automatically hide the source, then I'd like to avoid the term "Hide" in favour of the previous "Show nothing".

I'm unsure how better to communicate the term "End Action" without it being very long. "When Playback Ends.." maybe? I don't know.

mvji · 2022-04-02T10:19:02Z

I'm not 100% sold on terminology. I think at the very least, "Freeze on final frame" (if that's what happens) would be better than "Freeze". If the "Hide" action doesn't actually toggle the eye to automatically hide the source, then I'd like to avoid the term "Hide" in favour of the previous "Show nothing".

Yes we can use Show nothing, who avoid confusion with show/hide property.

Another name for the "Freeze" action (who keep the last frame), can be "Frame hold" (is something close to what Premiere Pro used for this), or "Freeze last frame" who is shorter than "Freeze on final frame".

I'm unsure how better to communicate the term "End Action" without it being very long. "When Playback Ends.." maybe? I don't know.

I think shorter text are cleaner for UI. But if you prefer another text, will update.

Username69992872 · 2022-04-19T20:50:43Z

Will this function finally auto disable Media Sources which finshed playing? Streamdeck is a pain to use with OBS Studio right now as Media Sources stay active, event they finished playing. IF changing scenes, all Medisa Sources will re-start which is a pain.

mvji · 2022-04-20T08:37:03Z

This PR doesn't change the existing behaviour (it change UI in local file mode).
There is already other properties for Media source, for what you want to do.

Username69992872 · 2022-04-21T14:35:40Z

This PR doesn't change the existing behaviour (it change UI in local file mode). There is already other properties for Media source, for what you want to do.

yes I was referring to local video files indeed. So with this new "Hide" option, after the local Video has played, it would hide the local media source in OBS right?

Is there a way I could test that allready witihout having to compile myself for win 64 bit? I guess it requires only 1 updated dll

mvji · 2022-04-21T19:30:12Z

There is no new options in this PR, only a proposal for reorganize two checkbox to a property list with 3 parameters.

Currently the behaviour is :

Hide = Show nothing when playback ends (Checked) / Loop (Unchecked)
Freeze = Show nothing when playback ends (Unchecked) / Loop (Unchecked)
Loop = Loop (Checked)

Is there a way I could test that allready witihout having to compile myself for win 64 bit? I guess it requires only 1 updated dll

Sorry didn't know how to enable test build in a PR.

gxalpha · 2022-04-21T20:13:13Z

@Username69992872 I added the required label and restarted CI, once it's finished you should be able to download test artifacts from the "Checks" section of this PR.

SuslikV · 2022-06-22T21:27:01Z

Show nothing
Freeze last frame
Play media again

tooltip:
Show nothing = make transparent
Freeze last frame = pause at the last frame
Play media again = make endless loop

mvji · 2022-06-24T19:24:17Z

Hello,

Thanks for your comments.

Don't see a function to add tooltip to a property list item.
"obs_property_set_long_description", seems to be able to set tooltip only for the entire property list.

Warchamp7

I like this as a UX improvement.

Only suggestions I have are to phrasing and keeping familiar wording where we can.

End Action -> End of Playback
Freeze -> Freeze on last frame
Hide -> Show Nothing

For local file, replace UI properties : "Loop" and "Show nothing when playback ends" by a property list call End of Playback with three possible values : Show Nothing, Freeze on last frame, Loop Keep previous looping property for compatibility with previous version

SuslikV · 2022-07-22T07:29:51Z

Don't forget to explain to translators that "loop" is verb here.

mvji · 2022-07-30T18:40:50Z

Don't forget to explain to translators that "loop" is verb here.

How to do that ?

SuslikV · 2022-09-06T10:42:00Z

The way you can do this:

reword
ask translations maintainer (@Gol-D-Ace or whoever is now)

PatTheMav · 2024-01-12T18:59:30Z

plugins/obs-ffmpeg/obs-ffmpeg-source.c

+		end_playback = 1;
+	}
+
+	obs_data_set_int(settings, "end_playback", end_playback);


You probably also want to use obs_data_erase to remove the old setting when upgrading it to the new variant. Otherwise the old setting will persist in a user's configuration and you will always go and update it.

Probably worthwhile to check if the old setting exists first and only go through the effort to upgrade when it's necessary in the first place.

A "safer" method would be to only upgrade the setting if the old setting exists and the new setting does not. Erasing old setting values completely breaks configs for older versions.

Isn't that expected? If I were to create the source anew after the change, I could not go back to an older version of OBS and expect the setting to be "downgraded" either.

I'm aware of programs commonly upgrading settings but not that these upgraded settings are still expected to work with older versions (new settings would just be ignored).

I'm not saying that the upgraded settings should work with old versions. I'm saying that if you open a newer OBS one time that deletes settings entirely, and then you open an older OBS because you only wanted to run the newer OBS once to check it out, your settings are gone. I'm aware that we don't want to encourage or support downgrading, but purposefully breaking stuff seems a bit risky for users who just want to test stuff (and don't know that we encourage using portable mode or backing up your settings beforehand).

Fine with me, there's no issue with keeping it. The property should be removed nevertheless though.

Fine with me, there's no issue with keeping it. The property should be removed nevertheless though.

Agree with that.

PatTheMav · 2024-01-12T19:14:51Z

plugins/obs-ffmpeg/obs-ffmpeg-source.c

 	dstr_free(&path);

-	obs_properties_add_bool(props, "looping", obs_module_text("Looping"));
+	prop = obs_properties_add_bool(props, "looping",


If the property is upgraded, it should not be retained and hidden. ~~As I outlined above, the config value should be upgraded when it exists, but from then on this property will not have any use.~~

Properties can and will be queried by other code which will not take visibility into account, so for those consumers it will be confusing that there is a bespoke property for looping and another one that also enables looping.

WizardCM added the New Feature New feature or plugin label Mar 29, 2022

mvji force-pushed the media_src_end_action branch from 7bf8778 to 4aaba5b Compare March 29, 2022 10:36

WizardCM requested a review from Warchamp7 April 2, 2022 02:09

RytoEX added this to the OBS Studio 28.0 milestone Apr 2, 2022

gxalpha added the Seeking Testers Build artifacts on CI label Apr 21, 2022

Fenrirthviti mentioned this pull request Jun 15, 2022

Provide more nuanced control for when media sources start playing obsproject/rfcs#40

Closed

Warchamp7 requested changes Jun 25, 2022

View reviewed changes

mvji force-pushed the media_src_end_action branch from 4aaba5b to ae96c4a Compare June 26, 2022 18:36

mvji mentioned this pull request Jul 15, 2022

obs-ffmpeg: Add pause visibility behaviour #6739

Open

6 tasks

gxalpha modified the milestones: OBS Studio 28.0, OBS Studio 28.1 / 29.0 Jul 31, 2022

RytoEX modified the milestones: OBS Studio 29.0, OBS Studio 29.1 Nov 11, 2022

RytoEX modified the milestones: OBS Studio 29.1, OBS Studio (Next Release) May 2, 2023

RytoEX modified the milestones: OBS Studio 30.0, OBS Studio (Next Version) Oct 27, 2023

PatTheMav reviewed Jan 12, 2024

View reviewed changes

RytoEX modified the milestones: OBS Studio 30.1, OBS Studio (Next Version) Feb 1, 2024

RytoEX modified the milestones: OBS Studio (Next Version), OBS Studio (Next Major Version) Jun 7, 2024

Uh oh!

obs-ffmpeg: Add end action UI property for local file source #6239

Are you sure you want to change the base?

obs-ffmpeg: Add end action UI property for local file source #6239

Uh oh!

Conversation

mvji commented Mar 28, 2022

Description

Motivation and Context

How Has This Been Tested?

Types of changes

Checklist:

Uh oh!

RytoEX commented Mar 28, 2022

Uh oh!

mvji commented Mar 29, 2022

Uh oh!

WizardCM commented Apr 2, 2022

Uh oh!

mvji commented Apr 2, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Username69992872 commented Apr 19, 2022

Uh oh!

mvji commented Apr 20, 2022

Uh oh!

Username69992872 commented Apr 21, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

mvji commented Apr 21, 2022

Uh oh!

gxalpha commented Apr 21, 2022

Uh oh!

SuslikV commented Jun 22, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

mvji commented Jun 24, 2022

Uh oh!

Warchamp7 left a comment

Choose a reason for hiding this comment

Uh oh!

SuslikV commented Jul 22, 2022

Uh oh!

mvji commented Jul 30, 2022

Uh oh!

SuslikV commented Sep 6, 2022

Uh oh!

PatTheMav Jan 12, 2024

Choose a reason for hiding this comment

Uh oh!

RytoEX Jan 12, 2024

Choose a reason for hiding this comment

Uh oh!

PatTheMav Jan 12, 2024

Choose a reason for hiding this comment

Uh oh!

RytoEX Jan 12, 2024

Choose a reason for hiding this comment

Uh oh!

PatTheMav Jan 12, 2024

Choose a reason for hiding this comment

Uh oh!

RytoEX Jan 12, 2024

Choose a reason for hiding this comment

Uh oh!

PatTheMav Jan 12, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

8 participants

mvji commented Apr 2, 2022 •

edited

Loading

Username69992872 commented Apr 21, 2022 •

edited

Loading

SuslikV commented Jun 22, 2022 •

edited

Loading

PatTheMav Jan 12, 2024 •

edited

Loading