OBS/obs-studio
OBS/obs-studio
1
0
Fork 0
mirror of https://github.com/obsproject/obs-studio.git synced 2024-07-02 09:33:33 +00:00
Code Issues Packages Projects Releases Wiki Activity
obs-studio/UI/window-basic-main-outputs.hpp

Ignoring revisions in .git-blame-ignore-revs. Click here to bypass and see the normal blame view.

109 lines
3.1 KiB
C++
Raw Permalink Normal View History

UI: Refactor output handling To accommodate multiple types of outputs, there has to be some level of abstraction. The BasicOutputHandler structure will give us a way that we can switch between different output configurations.
2015-02-06 11:17:33 +00:00
#pragma once
UI: Add eRTMP Multitrack Video Output
2024-04-18 13:41:36 +00:00
#include <memory>
UI: Allow services to use different outputs Allows a service to specify the output it needs in order to function as configured. NOTE: This functionality should be considered temporary as a seamless means of implementing support for different output types within the same service. Ideally, different services should be used for this functionality.
2017-07-13 10:57:42 +00:00
#include <string>
UI: Add eRTMP Multitrack Video Output
2024-04-18 13:41:36 +00:00
#include <QFuture>
#include "qt-helpers.hpp"
#include "multitrack-video-output.hpp"
UI: Refactor output handling To accommodate multiple types of outputs, there has to be some level of abstraction. The BasicOutputHandler structure will give us a way that we can switch between different output configurations.
2015-02-06 11:17:33 +00:00
class OBSBasic;
struct BasicOutputHandler {
UI: Cleanup libobs C++ type use
2021-11-26 09:25:39 +00:00
OBSOutputAutoRelease fileOutput;
OBSOutputAutoRelease streamOutput;
OBSOutputAutoRelease replayBuffer;
OBSOutputAutoRelease virtualCam;
UI: Don't use activeRefs to determine if active Due to certain design changes for delay, it's better to simply determine whether outputs are active via booleans rather than an activeRefs variable, which could get decremented more than once if say, the signal for stopping the stream gets called more than once for whatever reason (which may happen in the case of delay due to the way delay works)
2015-09-06 23:07:45 +00:00
bool streamingActive = false;
bool recordingActive = false;
UI: Implement stream delay When stream delay is active, the "Start/Stop Streaming" button is changed in to a menu button, which allows the user to select either the option to stop the stream (which causes it to count down), or forcibly stop the stream (which immediately stops the stream and cuts off all delayed data). If the user decides they want to start the stream again while in the process of counting down, they can safely do so without having to wait for it to stop, and it will schedule it to start up again with the same delay after the stop. On the status bar, it will now show whether delay is active, and its duration. If the stream is in the process of stopping/starting, it will count down to the stop/start. If the option to preserve stream cutoff point on unexpected disconnections/reconnections is enabled, it will update the current delay duration accordingly.
2015-09-06 23:19:53 +00:00
bool delayActive = false;
UI: Separate replay buffer from recording Replay buffer and recording should be separate in case the user wants to start recording from a specific point rather being forced to reconfigure for regular recording. Creates a new button on the main window below the recording button for turning on/off the replay buffer.
2016-12-09 22:40:04 +00:00
bool replayBufferActive = false;
UI: Add virtual camera to UI Adds a virtual camera button to the main user interface. If virtual camera is not installed, it will not add the button. On Windows, it detects whether the virtual camera filters are properly registered, and will only add the button if the virtual camera filter is confirmed registered. Also adds a virtual camera option to the auto-configuration wizard, which will just simply set the user's resolution/scale to 1920x1080 at 30 FPS.
2020-06-20 14:42:14 +00:00
bool virtualCamActive = false;
UI: Refactor output handling To accommodate multiple types of outputs, there has to be some level of abstraction. The BasicOutputHandler structure will give us a way that we can switch between different output configurations.
2015-02-06 11:17:33 +00:00
OBSBasic *main;
clang-format: Apply formatting Code submissions have continually suffered from formatting inconsistencies that constantly have to be addressed. Using clang-format simplifies this by making code formatting more consistent, and allows automation of the code formatting so that maintainers can focus more on the code itself instead of code formatting.
2019-06-23 05:13:45 +00:00
UI: Add eRTMP Multitrack Video Output
2024-04-18 13:41:36 +00:00
std::unique_ptr<MultitrackVideoOutput> multitrackVideo;
bool multitrackVideoActive = false;
OBSOutputAutoRelease StreamingOutput() const
{
return (multitrackVideo && multitrackVideoActive)
? multitrackVideo->StreamingOutput()
: OBSOutputAutoRelease{
obs_output_get_ref(streamOutput)};
}
UI: Refactor Virtual Camera source selector dialog
2022-08-22 14:04:13 +00:00
obs_view_t *virtualCamView = nullptr;
video_t *virtualCamVideo = nullptr;
obs_scene_t *vCamSourceScene = nullptr;
obs_sceneitem_t *vCamSourceSceneItem = nullptr;
UI: Allow services to use different outputs Allows a service to specify the output it needs in order to function as configured. NOTE: This functionality should be considered temporary as a seamless means of implementing support for different output types within the same service. Ideally, different services should be used for this functionality.
2017-07-13 10:57:42 +00:00
std::string outputType;
UI: Show output's last error in failure dialog Logs the last output error if given.
2018-12-12 23:20:48 +00:00
std::string lastError;
clang-format: Apply formatting Code submissions have continually suffered from formatting inconsistencies that constantly have to be addressed. Using clang-format simplifies this by making code formatting more consistent, and allows automation of the code formatting so that maintainers can focus more on the code itself instead of code formatting.
2019-06-23 05:13:45 +00:00
UI: Fix screenshots preventing auto-remux Due to the fact that a global was used on GenerateSpecifiedFilename to save the remux file name, when a screenshot was made, it would overwrite the filename being remuxed, because screenshots use the same function to generate filenames as well. This solves that problem by removing the global and the changes to GeneratedSpecifiedFilename, and isolating that to the output handler. Coincidentally, this bug probably also happened with replay buffers under certain circumstances. Fixes obsproject/obs-studio#3497 Closes obsproject/obs-studio#3498
2020-09-26 15:19:27 +00:00
std::string lastRecordingPath;
UI: Release recording/streaming signals before outputs
2015-07-04 06:00:21 +00:00
OBSSignal startRecording;
OBSSignal stopRecording;
UI: Separate replay buffer from recording Replay buffer and recording should be separate in case the user wants to start recording from a specific point rather being forced to reconfigure for regular recording. Creates a new button on the main window below the recording button for turning on/off the replay buffer.
2016-12-09 22:40:04 +00:00
OBSSignal startReplayBuffer;
OBSSignal stopReplayBuffer;
UI: Release recording/streaming signals before outputs
2015-07-04 06:00:21 +00:00
OBSSignal startStreaming;
OBSSignal stopStreaming;
UI: Add virtual camera to UI Adds a virtual camera button to the main user interface. If virtual camera is not installed, it will not add the button. On Windows, it detects whether the virtual camera filters are properly registered, and will only add the button if the virtual camera filter is confirmed registered. Also adds a virtual camera option to the auto-configuration wizard, which will just simply set the user's resolution/scale to 1920x1080 at 30 FPS.
2020-06-20 14:42:14 +00:00
OBSSignal startVirtualCam;
OBSSignal stopVirtualCam;
UI: Wait for full vcam deactivation to destroy its view A bug which was technically introduced in df446c3f6e: the author assigned video mixes to the virtual camera and did not realize you have to wait for full capture stop with the "deactivate" signal rather than the "stop" signal. This situation is understandable because these signals are likely confusing and need more documentation. The way an output works when it stops is it has three stages: - "stopping", which is the moment the user themselves stop the output - "stop", when the output's implementation has stopped and returns success or an error code - "deactivate", when the output inself (not the implementation) has fully stopped capturing encoded or raw frame data after the implementation has stopped. This is done in a separate thread, end_data_capture_thread(), for performance and data race reasons, and is when it's "actually fully stopped for real this time" (Lain note: I sincerely apologize for this confusing signal design) The author of df446c3f6e was likely confused as to why they could not destroy the video mix in the "stop" signal without triggering a race condition in end_data_capture_thread(), and instead decided to make a workaround to clear the video mix set to the output before destroying the video mix. Unsetting the video mix I'm guessing *seemed* to fix the problem for them at the time, and destroying the video mix separately after that automatically stops capture, so it *technically* worked because the deactivate thread cannot be called until the implementation's stop signal has executed. However, it was still the incorrect way to handle the problem, because it circumvents the output's mechanism for deactivating the frame data capture by destroying the view instead. The reason this was the incorrect way to handle the problem became exposed in 7cd7ca80f8, when tytan made it so it uses the main video mix under certain circumstances. The main view is special and cannot be destroyed, so the mechanism to stop frame data capture that the virtualcam was using before failed, and raw frame data capture continued perpetually until the end of the program erroneously. This fix solves the bug by using the "deactivate" signal rather than the "stop" signal, thus allowing the output to fully end its data capture and *then* destroy the video mix. Fixes obsproject/obs-studio#9153
2023-07-06 21:56:48 +00:00
OBSSignal deactivateVirtualCam;
UI: Implement stream delay When stream delay is active, the "Start/Stop Streaming" button is changed in to a menu button, which allows the user to select either the option to stop the stream (which causes it to count down), or forcibly stop the stream (which immediately stops the stream and cuts off all delayed data). If the user decides they want to start the stream again while in the process of counting down, they can safely do so without having to wait for it to stop, and it will schedule it to start up again with the same delay after the stop. On the status bar, it will now show whether delay is active, and its duration. If the stream is in the process of stopping/starting, it will count down to the stop/start. If the option to preserve stream cutoff point on unexpected disconnections/reconnections is enabled, it will update the current delay duration accordingly.
2015-09-06 23:19:53 +00:00
OBSSignal streamDelayStarting;
UI: Show "stopping" text on buttons when waiting for stop The new cutoff timing fix means that streaming/recording has to remain active for bit until the stream/recording has reached the expecting stop timestamp. This means that the buttons would continue to say "Stop streaming/recording" while waiting for the output to stop itself at the appropriate timing. So instead of letting it do that and confusing the user, the buttons will now say "stopping" when the button is pressed to indicate to the user that the stream/recording is in the process of stopping.
2016-06-22 08:47:08 +00:00
OBSSignal streamStopping;
OBSSignal recordStopping;
UI: Add automatic file splitting This commit implements a new feature to split recordings in split files in Advanced output mode. These basic settings are implemented. - Enable/disable the feature. Default is disabled. - Select a type of the limit, time or size. - Specifies the limit in seconds or MiB.
2021-10-03 10:06:46 +00:00
OBSSignal recordFileChanged;
UI: Separate replay buffer from recording Replay buffer and recording should be separate in case the user wants to start recording from a specific point rather being forced to reconfigure for regular recording. Creates a new button on the main window below the recording button for turning on/off the replay buffer.
2016-12-09 22:40:04 +00:00
OBSSignal replayBufferStopping;
UI: Fix replay buffer frontend event not triggering The frontend API event OBS_FRONTEND_EVENT_REPLAY_BUFFER_SAVED was not being triggered when hotkeys were used because it was only set to trigger when the replay buffer button was clicked, not when a hotkey was used. This fixes it so that the frontend event sends a signal to the frontend so that hotkeys will actually work.
2020-10-12 23:55:01 +00:00
OBSSignal replayBufferSaved;
UI: Release recording/streaming signals before outputs
2015-07-04 06:00:21 +00:00
UI: Add virtual camera to UI Adds a virtual camera button to the main user interface. If virtual camera is not installed, it will not add the button. On Windows, it detects whether the virtual camera filters are properly registered, and will only add the button if the virtual camera filter is confirmed registered. Also adds a virtual camera option to the auto-configuration wizard, which will just simply set the user's resolution/scale to 1920x1080 at 30 FPS.
2020-06-20 14:42:14 +00:00
inline BasicOutputHandler(OBSBasic *main_);
UI: Refactor output handling To accommodate multiple types of outputs, there has to be some level of abstraction. The BasicOutputHandler structure will give us a way that we can switch between different output configurations.
2015-02-06 11:17:33 +00:00
virtual ~BasicOutputHandler(){};
UI: Add eRTMP Multitrack Video Output
2024-04-18 13:41:36 +00:00
virtual FutureHolder<bool> SetupStreaming(obs_service_t *service) = 0;
UI: Refactor output handling To accommodate multiple types of outputs, there has to be some level of abstraction. The BasicOutputHandler structure will give us a way that we can switch between different output configurations.
2015-02-06 11:17:33 +00:00
virtual bool StartStreaming(obs_service_t *service) = 0;
virtual bool StartRecording() = 0;
UI: Separate replay buffer from recording Replay buffer and recording should be separate in case the user wants to start recording from a specific point rather being forced to reconfigure for regular recording. Creates a new button on the main window below the recording button for turning on/off the replay buffer.
2016-12-09 22:40:04 +00:00
virtual bool StartReplayBuffer() { return false; }
UI: Add virtual camera to UI Adds a virtual camera button to the main user interface. If virtual camera is not installed, it will not add the button. On Windows, it detects whether the virtual camera filters are properly registered, and will only add the button if the virtual camera filter is confirmed registered. Also adds a virtual camera option to the auto-configuration wizard, which will just simply set the user's resolution/scale to 1920x1080 at 30 FPS.
2020-06-20 14:42:14 +00:00
virtual bool StartVirtualCam();
UI: Add ability to forcibly stop streams/recordings If the user hits the "stop stream" button it'll transition in to "stopping stream..." and will continue to output until the stream reaches the timing in which "stop" was pressed. However, if there is significant congestion, stopping the stream can take far longer than the user may like. So there needs to be an option to forcibly stop the stream in that case; pushing the "stop" button a second time should allow the user to tell the stream/recording to stop right away instead of waiting for the precise stop timing.
2016-09-09 14:37:54 +00:00
virtual void StopStreaming(bool force = false) = 0;
virtual void StopRecording(bool force = false) = 0;
UI: Separate replay buffer from recording Replay buffer and recording should be separate in case the user wants to start recording from a specific point rather being forced to reconfigure for regular recording. Creates a new button on the main window below the recording button for turning on/off the replay buffer.
2016-12-09 22:40:04 +00:00
virtual void StopReplayBuffer(bool force = false) { (void)force; }
UI: Add virtual camera to UI Adds a virtual camera button to the main user interface. If virtual camera is not installed, it will not add the button. On Windows, it detects whether the virtual camera filters are properly registered, and will only add the button if the virtual camera filter is confirmed registered. Also adds a virtual camera option to the auto-configuration wizard, which will just simply set the user's resolution/scale to 1920x1080 at 30 FPS.
2020-06-20 14:42:14 +00:00
virtual void StopVirtualCam();
UI: Refactor output handling To accommodate multiple types of outputs, there has to be some level of abstraction. The BasicOutputHandler structure will give us a way that we can switch between different output configurations.
2015-02-06 11:17:33 +00:00
virtual bool StreamingActive() const = 0;
virtual bool RecordingActive() const = 0;
UI: Separate replay buffer from recording Replay buffer and recording should be separate in case the user wants to start recording from a specific point rather being forced to reconfigure for regular recording. Creates a new button on the main window below the recording button for turning on/off the replay buffer.
2016-12-09 22:40:04 +00:00
virtual bool ReplayBufferActive() const { return false; }
UI: Add virtual camera to UI Adds a virtual camera button to the main user interface. If virtual camera is not installed, it will not add the button. On Windows, it detects whether the virtual camera filters are properly registered, and will only add the button if the virtual camera filter is confirmed registered. Also adds a virtual camera option to the auto-configuration wizard, which will just simply set the user's resolution/scale to 1920x1080 at 30 FPS.
2020-06-20 14:42:14 +00:00
virtual bool VirtualCamActive() const;
UI: Refactor output handling To accommodate multiple types of outputs, there has to be some level of abstraction. The BasicOutputHandler structure will give us a way that we can switch between different output configurations.
2015-02-06 11:17:33 +00:00
virtual void Update() = 0;
UI: Make SetupOutputs virtual instead of ignoring vcam In 218b936b1dae, the virtual camera was ignored when checking the active state, which is kind of a lackluster solution. Instead, this makes SetupOutputs() a virtual function, and calls it before starting the virtual camera to be more consistent with the rest of the outputs.
2020-09-03 13:56:03 +00:00
virtual void SetupOutputs() = 0;
UI: Refactor output handling To accommodate multiple types of outputs, there has to be some level of abstraction. The BasicOutputHandler structure will give us a way that we can switch between different output configurations.
2015-02-06 11:17:33 +00:00
UI: Refactor Virtual Camera source selector dialog
2022-08-22 14:04:13 +00:00
virtual void UpdateVirtualCamOutputSource();
virtual void DestroyVirtualCamView();
UI: Reset VCam when clearing scene data
2023-05-13 15:19:00 +00:00
virtual void DestroyVirtualCameraScene();
UI: Refactor Virtual Camera source selector dialog
2022-08-22 14:04:13 +00:00
UI: Make SetupOutputs virtual instead of ignoring vcam In 218b936b1dae, the virtual camera was ignored when checking the active state, which is kind of a lackluster solution. Instead, this makes SetupOutputs() a virtual function, and calls it before starting the virtual camera to be more consistent with the rest of the outputs.
2020-09-03 13:56:03 +00:00
inline bool Active() const
UI: Don't use activeRefs to determine if active Due to certain design changes for delay, it's better to simply determine whether outputs are active via booleans rather than an activeRefs variable, which could get decremented more than once if say, the signal for stopping the stream gets called more than once for whatever reason (which may happen in the case of delay due to the way delay works)
2015-09-06 23:07:45 +00:00
{
UI: Separate replay buffer from recording Replay buffer and recording should be separate in case the user wants to start recording from a specific point rather being forced to reconfigure for regular recording. Creates a new button on the main window below the recording button for turning on/off the replay buffer.
2016-12-09 22:40:04 +00:00
return streamingActive || recordingActive || delayActive ||
UI: Add eRTMP Multitrack Video Output
2024-04-18 13:41:36 +00:00
replayBufferActive || virtualCamActive ||
multitrackVideoActive;
UI: Don't use activeRefs to determine if active Due to certain design changes for delay, it's better to simply determine whether outputs are active via booleans rather than an activeRefs variable, which could get decremented more than once if say, the signal for stopping the stream gets called more than once for whatever reason (which may happen in the case of delay due to the way delay works)
2015-09-06 23:07:45 +00:00
}
UI: Fix screenshots preventing auto-remux Due to the fact that a global was used on GenerateSpecifiedFilename to save the remux file name, when a screenshot was made, it would overwrite the filename being remuxed, because screenshots use the same function to generate filenames as well. This solves that problem by removing the global and the changes to GeneratedSpecifiedFilename, and isolating that to the output handler. Coincidentally, this bug probably also happened with replay buffers under certain circumstances. Fixes obsproject/obs-studio#3497 Closes obsproject/obs-studio#3498
2020-09-26 15:19:27 +00:00
protected:
UI: Rework recording format handling
2023-04-03 13:48:55 +00:00
void SetupAutoRemux(const char *&container);
std::string GetRecordingFilename(const char *path,
const char *container, bool noSpace,
bool overwrite, const char *format,
bool ffmpeg);
UI: Add eRTMP Multitrack Video Output
2024-04-18 13:41:36 +00:00
UI: Use advanced mode audio track in multitrack video output
2024-06-18 13:12:57 +00:00
FutureHolder<std::optional<bool>> SetupMultitrackVideo(
obs_service_t *service, std::string audio_encoder_id,
size_t main_audio_mixer, std::optional<size_t> vod_track_mixer);
UI: Add eRTMP Multitrack Video Output
2024-04-18 13:41:36 +00:00
OBSDataAutoRelease GenerateMultitrackVideoStreamDumpConfig();
UI: Refactor output handling To accommodate multiple types of outputs, there has to be some level of abstraction. The BasicOutputHandler structure will give us a way that we can switch between different output configurations.
2015-02-06 11:17:33 +00:00
};
BasicOutputHandler *CreateSimpleOutputHandler(OBSBasic *main);
UI: Add advanced output settings Adds an 'advanced' mode to the output settings to allow more powerful and complex streaming and recording options: - Optionally use a different encoder for recording than for streaming to allow the recording to use a different encoder or encoder settings if desired (though at the cost if increased CPU usage depending on the encoders being used) - Use encoders other than x264 - Rescale the recording or streaming encoders in case the user wishes to stream and record at different resolutions - Select the specific mixer to use for recording and for streaming, allowing the stream and recording to use separate mixers (to for example allow a user to stream the game/mic audio but only record the game audio) - Use FFmpeg output for the recording button instead of only recording h264/aac to FLV, allowing the user to output to various different types of file formats or remote URLs, as well as allowing the user to select and use different encoders and encoder settings that are available in the FFmpeg library - Optionally allow the use of multiple audio tracks in a single output if the file formats or stream services support it
2015-01-26 21:41:22 +00:00
BasicOutputHandler *CreateAdvancedOutputHandler(OBSBasic *main);
Reference in a new issue Copy permalink