mirror of
https://github.com/obsproject/obs-studio.git
synced 2024-07-05 11:03:31 +00:00
cececf4e55
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 ofdf446c3f6ewas 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 in7cd7ca80f8, 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
86 lines
2.4 KiB
C++
86 lines
2.4 KiB
C++
#pragma once
|
|
|
|
#include <string>
|
|
|
|
class OBSBasic;
|
|
|
|
struct BasicOutputHandler {
|
|
OBSOutputAutoRelease fileOutput;
|
|
OBSOutputAutoRelease streamOutput;
|
|
OBSOutputAutoRelease replayBuffer;
|
|
OBSOutputAutoRelease virtualCam;
|
|
bool streamingActive = false;
|
|
bool recordingActive = false;
|
|
bool delayActive = false;
|
|
bool replayBufferActive = false;
|
|
bool virtualCamActive = false;
|
|
OBSBasic *main;
|
|
|
|
obs_view_t *virtualCamView = nullptr;
|
|
video_t *virtualCamVideo = nullptr;
|
|
obs_scene_t *vCamSourceScene = nullptr;
|
|
obs_sceneitem_t *vCamSourceSceneItem = nullptr;
|
|
|
|
std::string outputType;
|
|
std::string lastError;
|
|
|
|
std::string lastRecordingPath;
|
|
|
|
OBSSignal startRecording;
|
|
OBSSignal stopRecording;
|
|
OBSSignal startReplayBuffer;
|
|
OBSSignal stopReplayBuffer;
|
|
OBSSignal startStreaming;
|
|
OBSSignal stopStreaming;
|
|
OBSSignal startVirtualCam;
|
|
OBSSignal stopVirtualCam;
|
|
OBSSignal deactivateVirtualCam;
|
|
OBSSignal streamDelayStarting;
|
|
OBSSignal streamStopping;
|
|
OBSSignal recordStopping;
|
|
OBSSignal recordFileChanged;
|
|
OBSSignal replayBufferStopping;
|
|
OBSSignal replayBufferSaved;
|
|
|
|
inline BasicOutputHandler(OBSBasic *main_);
|
|
|
|
virtual ~BasicOutputHandler(){};
|
|
|
|
virtual bool SetupStreaming(obs_service_t *service) = 0;
|
|
virtual bool StartStreaming(obs_service_t *service) = 0;
|
|
virtual bool StartRecording() = 0;
|
|
virtual bool StartReplayBuffer() { return false; }
|
|
virtual bool StartVirtualCam();
|
|
virtual void StopStreaming(bool force = false) = 0;
|
|
virtual void StopRecording(bool force = false) = 0;
|
|
virtual void StopReplayBuffer(bool force = false) { (void)force; }
|
|
virtual void StopVirtualCam();
|
|
virtual bool StreamingActive() const = 0;
|
|
virtual bool RecordingActive() const = 0;
|
|
virtual bool ReplayBufferActive() const { return false; }
|
|
virtual bool VirtualCamActive() const;
|
|
|
|
virtual void Update() = 0;
|
|
virtual void SetupOutputs() = 0;
|
|
|
|
virtual void UpdateVirtualCamOutputSource();
|
|
virtual void DestroyVirtualCamView();
|
|
virtual void DestroyVirtualCameraScene();
|
|
|
|
inline bool Active() const
|
|
{
|
|
return streamingActive || recordingActive || delayActive ||
|
|
replayBufferActive || virtualCamActive;
|
|
}
|
|
|
|
protected:
|
|
void SetupAutoRemux(const char *&container);
|
|
std::string GetRecordingFilename(const char *path,
|
|
const char *container, bool noSpace,
|
|
bool overwrite, const char *format,
|
|
bool ffmpeg);
|
|
};
|
|
|
|
BasicOutputHandler *CreateSimpleOutputHandler(OBSBasic *main);
|
|
BasicOutputHandler *CreateAdvancedOutputHandler(OBSBasic *main);
|