Aegisub/src/threaded_frame_source.h

143 lines
5.4 KiB
C
Raw Normal View History

// Copyright (c) 2013, Thomas Goyne <plorkyeran@aegisub.org>
//
// Permission to use, copy, modify, and distribute this software for any
// purpose with or without fee is hereby granted, provided that the above
// copyright notice and this permission notice appear in all copies.
//
// THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
// WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
// MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
// ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
// WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
// ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
// OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
//
// Aegisub Project http://www.aegisub.org/
/// @file threaded_frame_source.h
/// @see threaded_frame_source.cpp
/// @ingroup video
///
#include <libaegisub/exception.h>
#include <libaegisub/fs_fwd.h>
#include <atomic>
#include <deque>
2012-09-25 01:35:27 +02:00
#include <memory>
#include <set>
#include <wx/event.h>
class AssEntry;
class AssFile;
class SubtitlesProvider;
class VideoProvider;
class VideoProviderError;
struct VideoFrame;
namespace agi { namespace dispatch { class Queue; } }
/// @class ThreadedFrameSource
/// @brief An asynchronous video decoding and subtitle rendering wrapper
class ThreadedFrameSource {
/// Asynchronous work queue
std::unique_ptr<agi::dispatch::Queue> worker;
/// Subtitles provider
std::unique_ptr<SubtitlesProvider> subs_provider;
/// Video provider
std::unique_ptr<VideoProvider> video_provider;
/// Event handler to send FrameReady events to
wxEvtHandler *parent;
2013-12-12 01:29:48 +01:00
int frame_number = -1; ///< Last frame number requested
double time = -1.; ///< Time of the frame to pass to the subtitle renderer
/// Copy of the subtitles file to avoid having to touch the project context
std::unique_ptr<AssFile> subs;
/// If >= 0, the subtitles provider current has just the lines visible on
/// that frame loaded. If -1, the entire file is loaded. If -2, the
/// currently loaded file is out of date.
2013-12-12 01:29:48 +01:00
int single_frame = -1;
std::shared_ptr<VideoFrame> ProcFrame(int frame, double time, bool raw = false);
/// Produce a frame if req_version is still the current version
void ProcAsync(uint_fast32_t req_version);
/// Monotonic counter used to drop frames when changes arrive faster than
/// they can be rendered
2013-12-12 01:29:48 +01:00
std::atomic<uint_fast32_t> version{ 0 };
public:
/// @brief Load the passed subtitle file
/// @param subs File to load
///
/// This function blocks until is it is safe for the calling thread to
/// modify subs
void LoadSubtitles(const AssFile *subs) throw();
/// @brief Update a previously loaded subtitle file
/// @param subs Subtitle file which was last passed to LoadSubtitles
/// @param changes Set of lines which have changed
///
/// This function only supports changes to existing lines, and not
/// insertions or deletions.
void UpdateSubtitles(const AssFile *subs, std::set<const AssEntry *> const& changes) throw();
/// @brief Queue a request for a frame
/// @brief frame Frame number
/// @brief time Exact start time of the frame in seconds
///
/// This merely queues up a request and deletes any pending requests; there
/// is no guarantee that the requested frame will ever actually be produced
void RequestFrame(int frame, double time) throw();
/// @brief Synchronously get a frame
/// @brief frame Frame number
/// @brief time Exact start time of the frame in seconds
/// @brief raw Get raw frame without subtitles
std::shared_ptr<VideoFrame> GetFrame(int frame, double time, bool raw = false);
/// Get a reference to the video provider this is using
VideoProvider *GetVideoProvider() const { return video_provider.get(); }
/// @brief Constructor
/// @param videoFileName File to open
/// @param parent Event handler to send FrameReady events to
ThreadedFrameSource(agi::fs::path const& filename, std::string const& colormatrix, wxEvtHandler *parent);
~ThreadedFrameSource();
};
/// Event which signals that a requested frame is ready
struct FrameReadyEvent : public wxEvent {
/// Frame which is ready
std::shared_ptr<VideoFrame> frame;
/// Time which was used for subtitle rendering
double time;
2013-11-21 18:13:36 +01:00
wxEvent *Clone() const override { return new FrameReadyEvent(*this); };
FrameReadyEvent(std::shared_ptr<VideoFrame> frame, double time)
2013-11-21 18:13:36 +01:00
: frame(std::move(frame)), time(time) { }
};
// These exceptions are wxEvents so that they can be passed directly back to
// the parent thread as events
struct VideoProviderErrorEvent : public wxEvent, public agi::Exception {
2013-11-21 18:13:36 +01:00
const char * GetName() const override { return "video/error"; }
wxEvent *Clone() const override { return new VideoProviderErrorEvent(*this); };
agi::Exception *Copy() const override { return new VideoProviderErrorEvent(*this); };
VideoProviderErrorEvent(VideoProviderError const& err);
};
struct SubtitlesProviderErrorEvent : public wxEvent, public agi::Exception {
2013-11-21 18:13:36 +01:00
const char * GetName() const override { return "subtitles/error"; }
wxEvent *Clone() const override { return new SubtitlesProviderErrorEvent(*this); };
agi::Exception *Copy() const override { return new SubtitlesProviderErrorEvent(*this); };
SubtitlesProviderErrorEvent(std::string const& msg);
};
wxDECLARE_EVENT(EVT_FRAME_READY, FrameReadyEvent);
wxDECLARE_EVENT(EVT_VIDEO_ERROR, VideoProviderErrorEvent);
wxDECLARE_EVENT(EVT_SUBTITLES_ERROR, SubtitlesProviderErrorEvent);