PlaybackManager.cpp 28 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727
  1. /*
  2. * Copyright (c) 2022, Gregory Bertilson <zaggy1024@gmail.com>
  3. *
  4. * SPDX-License-Identifier: BSD-2-Clause
  5. */
  6. #include <AK/Format.h>
  7. #include <LibCore/Timer.h>
  8. #include <LibVideo/Containers/Matroska/MatroskaDemuxer.h>
  9. #include <LibVideo/VP9/Decoder.h>
  10. #include "PlaybackManager.h"
  11. namespace Video {
  12. #define TRY_OR_FATAL_ERROR(expression) \
  13. ({ \
  14. auto&& _fatal_expression = (expression); \
  15. if (_fatal_expression.is_error()) { \
  16. dispatch_fatal_error(_fatal_expression.release_error()); \
  17. return; \
  18. } \
  19. static_assert(!::AK::Detail::IsLvalueReference<decltype(_fatal_expression.release_value())>, \
  20. "Do not return a reference from a fallible expression"); \
  21. _fatal_expression.release_value(); \
  22. })
  23. DecoderErrorOr<NonnullOwnPtr<PlaybackManager>> PlaybackManager::from_file(StringView filename)
  24. {
  25. auto demuxer = TRY(Matroska::MatroskaDemuxer::from_file(filename));
  26. return create(move(demuxer));
  27. }
  28. DecoderErrorOr<NonnullOwnPtr<PlaybackManager>> PlaybackManager::from_mapped_file(NonnullOwnPtr<Core::MappedFile> mapped_file)
  29. {
  30. auto demuxer = TRY(Matroska::MatroskaDemuxer::from_mapped_file(move(mapped_file)));
  31. return create(move(demuxer));
  32. }
  33. DecoderErrorOr<NonnullOwnPtr<PlaybackManager>> PlaybackManager::from_data(ReadonlyBytes data)
  34. {
  35. auto demuxer = TRY(Matroska::MatroskaDemuxer::from_data(data));
  36. return create(move(demuxer));
  37. }
  38. DecoderErrorOr<NonnullOwnPtr<PlaybackManager>> PlaybackManager::create(NonnullOwnPtr<Demuxer> demuxer)
  39. {
  40. auto video_tracks = TRY(demuxer->get_tracks_for_type(TrackType::Video));
  41. if (video_tracks.is_empty())
  42. return DecoderError::with_description(DecoderErrorCategory::Invalid, "No video track is present"sv);
  43. auto track = video_tracks[0];
  44. dbgln_if(PLAYBACK_MANAGER_DEBUG, "Selecting video track number {}", track.identifier());
  45. auto codec_id = TRY(demuxer->get_codec_id_for_track(track));
  46. OwnPtr<VideoDecoder> decoder;
  47. switch (codec_id) {
  48. case CodecID::VP9:
  49. decoder = DECODER_TRY_ALLOC(try_make<VP9::Decoder>());
  50. break;
  51. default:
  52. return DecoderError::format(DecoderErrorCategory::Invalid, "Unsupported codec: {}", codec_id);
  53. }
  54. auto decoder_non_null = decoder.release_nonnull();
  55. auto frame_queue = DECODER_TRY_ALLOC(VideoFrameQueue::create());
  56. auto playback_manager = DECODER_TRY_ALLOC(try_make<PlaybackManager>(demuxer, track, move(decoder_non_null), move(frame_queue)));
  57. playback_manager->m_state_update_timer = DECODER_TRY_ALLOC(Core::Timer::create_single_shot(0, [&self = *playback_manager] { self.timer_callback(); }));
  58. playback_manager->m_decode_thread = DECODER_TRY_ALLOC(Threading::Thread::try_create([&self = *playback_manager] {
  59. while (!self.m_stop_decoding.load())
  60. self.decode_and_queue_one_sample();
  61. dbgln_if(PLAYBACK_MANAGER_DEBUG, "Media Decoder thread ended.");
  62. return 0;
  63. },
  64. "Media Decoder"sv));
  65. playback_manager->m_playback_handler = make<SeekingStateHandler>(*playback_manager, false, Duration::zero(), SeekMode::Fast);
  66. DECODER_TRY_ALLOC(playback_manager->m_playback_handler->on_enter());
  67. playback_manager->m_decode_thread->start();
  68. return playback_manager;
  69. }
  70. PlaybackManager::PlaybackManager(NonnullOwnPtr<Demuxer>& demuxer, Track video_track, NonnullOwnPtr<VideoDecoder>&& decoder, VideoFrameQueue&& frame_queue)
  71. : m_demuxer(move(demuxer))
  72. , m_selected_video_track(video_track)
  73. , m_frame_queue(move(frame_queue))
  74. , m_decoder(move(decoder))
  75. , m_decode_wait_condition(m_decode_wait_mutex)
  76. {
  77. }
  78. PlaybackManager::~PlaybackManager()
  79. {
  80. m_stop_decoding.exchange(true);
  81. m_decode_wait_condition.broadcast();
  82. dbgln_if(PLAYBACK_MANAGER_DEBUG, "Waiting for decode thread to end...");
  83. (void)m_decode_thread->join();
  84. dbgln_if(PLAYBACK_MANAGER_DEBUG, "Successfully destroyed PlaybackManager.");
  85. }
  86. void PlaybackManager::resume_playback()
  87. {
  88. dbgln_if(PLAYBACK_MANAGER_DEBUG, "Resuming playback.");
  89. TRY_OR_FATAL_ERROR(m_playback_handler->play());
  90. }
  91. void PlaybackManager::pause_playback()
  92. {
  93. dbgln_if(PLAYBACK_MANAGER_DEBUG, "Pausing playback.");
  94. if (!m_playback_handler->is_playing())
  95. warnln("Cannot pause.");
  96. TRY_OR_FATAL_ERROR(m_playback_handler->pause());
  97. }
  98. Duration PlaybackManager::current_playback_time()
  99. {
  100. return m_playback_handler->current_time();
  101. }
  102. Duration PlaybackManager::duration()
  103. {
  104. auto duration_result = ({
  105. auto demuxer_locker = Threading::MutexLocker(m_demuxer_mutex);
  106. m_demuxer->duration();
  107. });
  108. if (duration_result.is_error()) {
  109. dispatch_decoder_error(duration_result.release_error());
  110. // FIXME: We should determine the last sample that the demuxer knows is available and
  111. // use that as the current duration. The duration may change if the demuxer doesn't
  112. // know there is a fixed duration.
  113. return Duration::zero();
  114. }
  115. return duration_result.release_value();
  116. }
  117. void PlaybackManager::dispatch_fatal_error(Error error)
  118. {
  119. dbgln_if(PLAYBACK_MANAGER_DEBUG, "Encountered fatal error: {}", error.string_literal());
  120. // FIXME: For threading, this will have to use a pre-allocated event to send to the main loop
  121. // to be able to gracefully handle OOM.
  122. if (on_fatal_playback_error)
  123. on_fatal_playback_error(move(error));
  124. }
  125. void PlaybackManager::dispatch_decoder_error(DecoderError error)
  126. {
  127. switch (error.category()) {
  128. case DecoderErrorCategory::EndOfStream:
  129. dbgln_if(PLAYBACK_MANAGER_DEBUG, "{}", error.string_literal());
  130. TRY_OR_FATAL_ERROR(m_playback_handler->stop());
  131. break;
  132. default:
  133. dbgln("Playback error encountered: {}", error.string_literal());
  134. TRY_OR_FATAL_ERROR(m_playback_handler->stop());
  135. if (on_decoder_error)
  136. on_decoder_error(move(error));
  137. break;
  138. }
  139. }
  140. void PlaybackManager::dispatch_new_frame(RefPtr<Gfx::Bitmap> frame)
  141. {
  142. if (on_video_frame)
  143. on_video_frame(move(frame));
  144. }
  145. bool PlaybackManager::dispatch_frame_queue_item(FrameQueueItem&& item)
  146. {
  147. if (item.is_error()) {
  148. dispatch_decoder_error(item.release_error());
  149. return true;
  150. }
  151. dbgln_if(PLAYBACK_MANAGER_DEBUG, "Sent frame for presentation with timestamp {}ms, late by {}ms", item.timestamp().to_milliseconds(), (current_playback_time() - item.timestamp()).to_milliseconds());
  152. dispatch_new_frame(item.bitmap());
  153. return false;
  154. }
  155. void PlaybackManager::dispatch_state_change()
  156. {
  157. if (on_playback_state_change)
  158. on_playback_state_change();
  159. }
  160. void PlaybackManager::timer_callback()
  161. {
  162. TRY_OR_FATAL_ERROR(m_playback_handler->do_timed_state_update());
  163. }
  164. void PlaybackManager::seek_to_timestamp(Duration target_timestamp, SeekMode seek_mode)
  165. {
  166. TRY_OR_FATAL_ERROR(m_playback_handler->seek(target_timestamp, seek_mode));
  167. }
  168. DecoderErrorOr<Optional<Duration>> PlaybackManager::seek_demuxer_to_most_recent_keyframe(Duration timestamp, Optional<Duration> earliest_available_sample)
  169. {
  170. return m_demuxer->seek_to_most_recent_keyframe(m_selected_video_track, timestamp, move(earliest_available_sample));
  171. }
  172. Optional<FrameQueueItem> PlaybackManager::dequeue_one_frame()
  173. {
  174. auto result = m_frame_queue.dequeue();
  175. m_decode_wait_condition.broadcast();
  176. if (result.is_error()) {
  177. if (result.error() != VideoFrameQueue::QueueStatus::Empty)
  178. dispatch_fatal_error(Error::from_string_literal("Dequeue failed with an unexpected error"));
  179. return {};
  180. }
  181. return result.release_value();
  182. }
  183. void PlaybackManager::set_state_update_timer(int delay_ms)
  184. {
  185. m_state_update_timer->start(delay_ms);
  186. }
  187. void PlaybackManager::restart_playback()
  188. {
  189. seek_to_timestamp(Duration::zero());
  190. }
  191. void PlaybackManager::decode_and_queue_one_sample()
  192. {
  193. #if PLAYBACK_MANAGER_DEBUG
  194. auto start_time = MonotonicTime::now();
  195. #endif
  196. FrameQueueItem item_to_enqueue;
  197. while (item_to_enqueue.is_empty()) {
  198. // Get a sample to decode.
  199. auto sample_result = [&]() {
  200. // FIXME: Implement and use a class to enforce that this field is accessed through a mutex (like Kernel::MutexProtected).
  201. Threading::MutexLocker demuxer_locker(m_demuxer_mutex);
  202. return m_demuxer->get_next_video_sample_for_track(m_selected_video_track);
  203. }();
  204. if (sample_result.is_error()) {
  205. item_to_enqueue = FrameQueueItem::error_marker(sample_result.release_error(), FrameQueueItem::no_timestamp);
  206. break;
  207. }
  208. auto sample = sample_result.release_value();
  209. // Submit the sample to the decoder.
  210. auto decode_result = m_decoder->receive_sample(sample->data());
  211. if (decode_result.is_error()) {
  212. item_to_enqueue = FrameQueueItem::error_marker(decode_result.release_error(), sample->timestamp());
  213. break;
  214. }
  215. // Retrieve the last available frame to present.
  216. OwnPtr<VideoFrame> decoded_frame = nullptr;
  217. while (true) {
  218. auto frame_result = m_decoder->get_decoded_frame();
  219. if (frame_result.is_error()) {
  220. if (frame_result.error().category() == DecoderErrorCategory::NeedsMoreInput) {
  221. break;
  222. }
  223. item_to_enqueue = FrameQueueItem::error_marker(frame_result.release_error(), sample->timestamp());
  224. break;
  225. }
  226. decoded_frame = frame_result.release_value();
  227. }
  228. // Convert the frame for display.
  229. if (decoded_frame != nullptr) {
  230. auto& cicp = decoded_frame->cicp();
  231. cicp.adopt_specified_values(sample->container_cicp());
  232. cicp.default_code_points_if_unspecified({ ColorPrimaries::BT709, TransferCharacteristics::BT709, MatrixCoefficients::BT709, VideoFullRangeFlag::Studio });
  233. // BT.601, BT.709 and BT.2020 have a similar transfer function to sRGB, so other applications
  234. // (Chromium, VLC) forgo transfer characteristics conversion. We will emulate that behavior by
  235. // handling those as sRGB instead, which causes no transfer function change in the output,
  236. // unless display color management is later implemented.
  237. switch (cicp.transfer_characteristics()) {
  238. case TransferCharacteristics::BT601:
  239. case TransferCharacteristics::BT709:
  240. case TransferCharacteristics::BT2020BitDepth10:
  241. case TransferCharacteristics::BT2020BitDepth12:
  242. cicp.set_transfer_characteristics(TransferCharacteristics::SRGB);
  243. break;
  244. default:
  245. break;
  246. }
  247. auto bitmap_result = decoded_frame->to_bitmap();
  248. if (bitmap_result.is_error())
  249. item_to_enqueue = FrameQueueItem::error_marker(bitmap_result.release_error(), sample->timestamp());
  250. else
  251. item_to_enqueue = FrameQueueItem::frame(bitmap_result.release_value(), sample->timestamp());
  252. break;
  253. }
  254. }
  255. VERIFY(!item_to_enqueue.is_empty());
  256. #if PLAYBACK_MANAGER_DEBUG
  257. dbgln("Media Decoder: Sample at {}ms took {}ms to decode, queue contains ~{} items", item_to_enqueue.timestamp().to_milliseconds(), (MonotonicTime::now() - start_time).to_milliseconds(), m_frame_queue.weak_used());
  258. #endif
  259. auto wait = [&] {
  260. auto wait_locker = Threading::MutexLocker(m_decode_wait_mutex);
  261. m_decode_wait_condition.wait();
  262. };
  263. bool had_error = item_to_enqueue.is_error();
  264. while (true) {
  265. if (m_frame_queue.can_enqueue()) {
  266. MUST(m_frame_queue.enqueue(move(item_to_enqueue)));
  267. break;
  268. }
  269. if (m_stop_decoding.load()) {
  270. dbgln_if(PLAYBACK_MANAGER_DEBUG, "Media Decoder: Received signal to stop, exiting decode function...");
  271. return;
  272. }
  273. m_buffer_is_full.exchange(true);
  274. dbgln_if(PLAYBACK_MANAGER_DEBUG, "Media Decoder: Waiting for a frame to be dequeued...");
  275. wait();
  276. }
  277. if (had_error) {
  278. dbgln_if(PLAYBACK_MANAGER_DEBUG, "Media Decoder: Encountered {}, waiting...", item_to_enqueue.error().category() == DecoderErrorCategory::EndOfStream ? "end of stream"sv : "error"sv);
  279. m_buffer_is_full.exchange(true);
  280. wait();
  281. }
  282. m_buffer_is_full.exchange(false);
  283. }
  284. Duration PlaybackManager::PlaybackStateHandler::current_time() const
  285. {
  286. return m_manager.m_last_present_in_media_time;
  287. }
  288. ErrorOr<void> PlaybackManager::PlaybackStateHandler::seek(Duration target_timestamp, SeekMode seek_mode)
  289. {
  290. return replace_handler_and_delete_this<SeekingStateHandler>(is_playing(), target_timestamp, seek_mode);
  291. }
  292. ErrorOr<void> PlaybackManager::PlaybackStateHandler::stop()
  293. {
  294. return replace_handler_and_delete_this<StoppedStateHandler>();
  295. }
  296. template<class T, class... Args>
  297. ErrorOr<void> PlaybackManager::PlaybackStateHandler::replace_handler_and_delete_this(Args... args)
  298. {
  299. OwnPtr<PlaybackStateHandler> temp_handler = TRY(try_make<T>(m_manager, args...));
  300. m_manager.m_playback_handler.swap(temp_handler);
  301. #if PLAYBACK_MANAGER_DEBUG
  302. m_has_exited = true;
  303. dbgln("Changing state from {} to {}", temp_handler->name(), m_manager.m_playback_handler->name());
  304. #endif
  305. TRY(m_manager.m_playback_handler->on_enter());
  306. m_manager.dispatch_state_change();
  307. return {};
  308. }
  309. PlaybackManager& PlaybackManager::PlaybackStateHandler::manager() const
  310. {
  311. #if PLAYBACK_MANAGER_DEBUG
  312. VERIFY(!m_has_exited);
  313. #endif
  314. return m_manager;
  315. }
  316. class PlaybackManager::ResumingStateHandler : public PlaybackManager::PlaybackStateHandler {
  317. public:
  318. ResumingStateHandler(PlaybackManager& manager, bool playing)
  319. : PlaybackStateHandler(manager)
  320. , m_playing(playing)
  321. {
  322. }
  323. ~ResumingStateHandler() override = default;
  324. protected:
  325. ErrorOr<void> assume_next_state()
  326. {
  327. if (!m_playing)
  328. return replace_handler_and_delete_this<PausedStateHandler>();
  329. return replace_handler_and_delete_this<PlayingStateHandler>();
  330. }
  331. ErrorOr<void> play() override
  332. {
  333. m_playing = true;
  334. manager().dispatch_state_change();
  335. return {};
  336. }
  337. bool is_playing() const override { return m_playing; }
  338. ErrorOr<void> pause() override
  339. {
  340. m_playing = false;
  341. manager().dispatch_state_change();
  342. return {};
  343. }
  344. bool m_playing { false };
  345. };
  346. class PlaybackManager::PlayingStateHandler : public PlaybackManager::PlaybackStateHandler {
  347. public:
  348. PlayingStateHandler(PlaybackManager& manager)
  349. : PlaybackStateHandler(manager)
  350. {
  351. }
  352. ~PlayingStateHandler() override = default;
  353. private:
  354. ErrorOr<void> on_enter() override
  355. {
  356. m_last_present_in_real_time = MonotonicTime::now();
  357. return do_timed_state_update();
  358. }
  359. StringView name() override { return "Playing"sv; }
  360. bool is_playing() const override { return true; }
  361. PlaybackState get_state() const override { return PlaybackState::Playing; }
  362. ErrorOr<void> pause() override
  363. {
  364. manager().m_last_present_in_media_time = current_time();
  365. return replace_handler_and_delete_this<PausedStateHandler>();
  366. }
  367. ErrorOr<void> buffer() override
  368. {
  369. manager().m_last_present_in_media_time = current_time();
  370. return replace_handler_and_delete_this<BufferingStateHandler>(true);
  371. }
  372. Duration current_time() const override
  373. {
  374. return manager().m_last_present_in_media_time + (MonotonicTime::now() - m_last_present_in_real_time);
  375. }
  376. ErrorOr<void> do_timed_state_update() override
  377. {
  378. auto set_presentation_timer = [&]() {
  379. auto frame_time_ms = (manager().m_next_frame->timestamp() - current_time()).to_milliseconds();
  380. VERIFY(frame_time_ms <= NumericLimits<int>::max());
  381. dbgln_if(PLAYBACK_MANAGER_DEBUG, "Time until next frame is {}ms", frame_time_ms);
  382. manager().set_state_update_timer(max(static_cast<int>(frame_time_ms), 0));
  383. };
  384. if (manager().m_next_frame.has_value() && current_time() < manager().m_next_frame->timestamp()) {
  385. dbgln_if(PLAYBACK_MANAGER_DEBUG, "Current time {}ms is too early to present the next frame at {}ms, delaying", current_time().to_milliseconds(), manager().m_next_frame->timestamp().to_milliseconds());
  386. set_presentation_timer();
  387. return {};
  388. }
  389. Optional<FrameQueueItem> future_frame_item;
  390. bool should_present_frame = false;
  391. // Skip frames until we find a frame past the current playback time, and keep the one that precedes it to display.
  392. while (true) {
  393. future_frame_item = manager().dequeue_one_frame();
  394. if (!future_frame_item.has_value())
  395. break;
  396. if (future_frame_item->timestamp() >= current_time() || future_frame_item->timestamp() == FrameQueueItem::no_timestamp) {
  397. dbgln_if(PLAYBACK_MANAGER_DEBUG, "Should present frame, future {} is error or after {}ms", future_frame_item->debug_string(), current_time().to_milliseconds());
  398. should_present_frame = true;
  399. break;
  400. }
  401. if (manager().m_next_frame.has_value()) {
  402. dbgln_if(PLAYBACK_MANAGER_DEBUG, "At {}ms: Dropped {} in favor of {}", current_time().to_milliseconds(), manager().m_next_frame->debug_string(), future_frame_item->debug_string());
  403. manager().m_skipped_frames++;
  404. }
  405. manager().m_next_frame.emplace(future_frame_item.release_value());
  406. }
  407. // If we don't have both of these items, we can't present, since we need to set a timer for
  408. // the next frame. Check if we need to buffer based on the current state.
  409. if (!manager().m_next_frame.has_value() || !future_frame_item.has_value()) {
  410. #if PLAYBACK_MANAGER_DEBUG
  411. StringBuilder debug_string_builder;
  412. debug_string_builder.append("We don't have "sv);
  413. if (!manager().m_next_frame.has_value()) {
  414. debug_string_builder.append("a frame to present"sv);
  415. if (!future_frame_item.has_value())
  416. debug_string_builder.append(" or a future frame"sv);
  417. } else {
  418. debug_string_builder.append("a future frame"sv);
  419. }
  420. debug_string_builder.append(", checking for error and buffering"sv);
  421. dbgln_if(PLAYBACK_MANAGER_DEBUG, debug_string_builder.to_byte_string());
  422. #endif
  423. if (future_frame_item.has_value()) {
  424. if (future_frame_item->is_error()) {
  425. manager().dispatch_decoder_error(future_frame_item.release_value().release_error());
  426. return {};
  427. }
  428. manager().m_next_frame.emplace(future_frame_item.release_value());
  429. }
  430. TRY(buffer());
  431. return {};
  432. }
  433. // If we have a frame, send it for presentation.
  434. if (should_present_frame) {
  435. auto now = MonotonicTime::now();
  436. manager().m_last_present_in_media_time += now - m_last_present_in_real_time;
  437. m_last_present_in_real_time = now;
  438. if (manager().dispatch_frame_queue_item(manager().m_next_frame.release_value()))
  439. return {};
  440. }
  441. // Now that we've presented the current frame, we can throw whatever error is next in queue.
  442. // This way, we always display a frame before the stream ends, and should also show any frames
  443. // we already had when a real error occurs.
  444. if (future_frame_item->is_error()) {
  445. manager().dispatch_decoder_error(future_frame_item.release_value().release_error());
  446. return {};
  447. }
  448. // The future frame item becomes the next one to present.
  449. manager().m_next_frame.emplace(future_frame_item.release_value());
  450. set_presentation_timer();
  451. return {};
  452. }
  453. MonotonicTime m_last_present_in_real_time = MonotonicTime::now_coarse();
  454. };
  455. class PlaybackManager::PausedStateHandler : public PlaybackManager::PlaybackStateHandler {
  456. public:
  457. PausedStateHandler(PlaybackManager& manager)
  458. : PlaybackStateHandler(manager)
  459. {
  460. }
  461. ~PausedStateHandler() override = default;
  462. private:
  463. StringView name() override { return "Paused"sv; }
  464. ErrorOr<void> play() override
  465. {
  466. return replace_handler_and_delete_this<PlayingStateHandler>();
  467. }
  468. bool is_playing() const override { return false; }
  469. PlaybackState get_state() const override { return PlaybackState::Paused; }
  470. };
  471. // FIXME: This is a placeholder variable that could be scaled based on how long each frame decode takes to
  472. // avoid triggering the timer to check the queue constantly. However, doing so may reduce the speed
  473. // of seeking due to the decode thread having to wait for a signal to continue decoding.
  474. constexpr int buffering_or_seeking_decode_wait_time = 1;
  475. class PlaybackManager::BufferingStateHandler : public PlaybackManager::ResumingStateHandler {
  476. using PlaybackManager::ResumingStateHandler::ResumingStateHandler;
  477. ErrorOr<void> on_enter() override
  478. {
  479. manager().set_state_update_timer(buffering_or_seeking_decode_wait_time);
  480. return {};
  481. }
  482. StringView name() override { return "Buffering"sv; }
  483. ErrorOr<void> do_timed_state_update() override
  484. {
  485. auto buffer_is_full = manager().m_buffer_is_full.load();
  486. dbgln_if(PLAYBACK_MANAGER_DEBUG, "Buffering timer callback has been called. Buffer is {}.", buffer_is_full ? "full, exiting"sv : "not full, waiting"sv);
  487. if (buffer_is_full)
  488. return assume_next_state();
  489. manager().set_state_update_timer(buffering_or_seeking_decode_wait_time);
  490. return {};
  491. }
  492. PlaybackState get_state() const override { return PlaybackState::Buffering; }
  493. };
  494. class PlaybackManager::SeekingStateHandler : public PlaybackManager::ResumingStateHandler {
  495. public:
  496. SeekingStateHandler(PlaybackManager& manager, bool playing, Duration target_timestamp, SeekMode seek_mode)
  497. : ResumingStateHandler(manager, playing)
  498. , m_target_timestamp(target_timestamp)
  499. , m_seek_mode(seek_mode)
  500. {
  501. }
  502. ~SeekingStateHandler() override = default;
  503. private:
  504. ErrorOr<void> on_enter() override
  505. {
  506. auto earliest_available_sample = manager().m_last_present_in_media_time;
  507. if (manager().m_next_frame.has_value() && manager().m_next_frame->timestamp() != FrameQueueItem::no_timestamp) {
  508. earliest_available_sample = min(earliest_available_sample, manager().m_next_frame->timestamp());
  509. }
  510. {
  511. Threading::MutexLocker demuxer_locker(manager().m_demuxer_mutex);
  512. auto demuxer_seek_result = manager().seek_demuxer_to_most_recent_keyframe(m_target_timestamp, earliest_available_sample);
  513. if (demuxer_seek_result.is_error()) {
  514. manager().dispatch_decoder_error(demuxer_seek_result.release_error());
  515. return {};
  516. }
  517. auto keyframe_timestamp = demuxer_seek_result.release_value();
  518. #if PLAYBACK_MANAGER_DEBUG
  519. auto seek_mode_name = m_seek_mode == SeekMode::Accurate ? "Accurate"sv : "Fast"sv;
  520. if (keyframe_timestamp.has_value())
  521. dbgln("{} seeking to timestamp target {}ms, selected keyframe at {}ms", seek_mode_name, m_target_timestamp.to_milliseconds(), keyframe_timestamp->to_milliseconds());
  522. else
  523. dbgln("{} seeking to timestamp target {}ms, demuxer kept its iterator position after {}ms", seek_mode_name, m_target_timestamp.to_milliseconds(), earliest_available_sample.to_milliseconds());
  524. #endif
  525. if (m_seek_mode == SeekMode::Fast)
  526. m_target_timestamp = keyframe_timestamp.value_or(manager().m_last_present_in_media_time);
  527. if (keyframe_timestamp.has_value()) {
  528. dbgln_if(PLAYBACK_MANAGER_DEBUG, "Keyframe is nearer to the target than the current frames, emptying queue");
  529. while (manager().dequeue_one_frame().has_value()) { }
  530. manager().m_next_frame.clear();
  531. manager().m_last_present_in_media_time = keyframe_timestamp.value();
  532. } else if (m_target_timestamp >= manager().m_last_present_in_media_time && manager().m_next_frame.has_value() && manager().m_next_frame.value().timestamp() > m_target_timestamp) {
  533. dbgln_if(PLAYBACK_MANAGER_DEBUG, "Target timestamp is between the last presented frame and the next frame, exiting seek at {}ms", m_target_timestamp.to_milliseconds());
  534. manager().m_last_present_in_media_time = m_target_timestamp;
  535. return assume_next_state();
  536. }
  537. }
  538. return skip_samples_until_timestamp();
  539. }
  540. ErrorOr<void> skip_samples_until_timestamp()
  541. {
  542. while (true) {
  543. auto optional_item = manager().dequeue_one_frame();
  544. if (!optional_item.has_value())
  545. break;
  546. auto item = optional_item.release_value();
  547. dbgln_if(PLAYBACK_MANAGER_DEBUG, "Dequeuing frame at {}ms and comparing to seek target {}ms", item.timestamp().to_milliseconds(), m_target_timestamp.to_milliseconds());
  548. if (manager().m_next_frame.has_value() && (item.timestamp() > m_target_timestamp || item.timestamp() == FrameQueueItem::no_timestamp)) {
  549. // If the frame we're presenting is later than the target timestamp, skip the timestamp forward to it.
  550. if (manager().m_next_frame->timestamp() > m_target_timestamp) {
  551. manager().m_last_present_in_media_time = manager().m_next_frame->timestamp();
  552. } else {
  553. manager().m_last_present_in_media_time = m_target_timestamp;
  554. }
  555. if (manager().dispatch_frame_queue_item(manager().m_next_frame.release_value()))
  556. return {};
  557. manager().m_next_frame.emplace(item);
  558. dbgln_if(PLAYBACK_MANAGER_DEBUG, "Exiting seek to {} state at {}ms", m_playing ? "Playing" : "Paused", manager().m_last_present_in_media_time.to_milliseconds());
  559. return assume_next_state();
  560. }
  561. manager().m_next_frame.emplace(item);
  562. }
  563. dbgln_if(PLAYBACK_MANAGER_DEBUG, "Frame queue is empty while seeking, waiting for buffer to fill.");
  564. manager().set_state_update_timer(buffering_or_seeking_decode_wait_time);
  565. return {};
  566. }
  567. StringView name() override { return "Seeking"sv; }
  568. ErrorOr<void> seek(Duration target_timestamp, SeekMode seek_mode) override
  569. {
  570. m_target_timestamp = target_timestamp;
  571. m_seek_mode = seek_mode;
  572. return on_enter();
  573. }
  574. Duration current_time() const override
  575. {
  576. return m_target_timestamp;
  577. }
  578. // We won't need this override when threaded, the queue can pause us in on_enter().
  579. ErrorOr<void> do_timed_state_update() override
  580. {
  581. dbgln_if(PLAYBACK_MANAGER_DEBUG, "Seeking wait finished, attempting to dequeue until timestamp.");
  582. return skip_samples_until_timestamp();
  583. }
  584. PlaybackState get_state() const override { return PlaybackState::Seeking; }
  585. Duration m_target_timestamp { Duration::zero() };
  586. SeekMode m_seek_mode { SeekMode::Accurate };
  587. };
  588. class PlaybackManager::StoppedStateHandler : public PlaybackManager::PlaybackStateHandler {
  589. public:
  590. StoppedStateHandler(PlaybackManager& manager)
  591. : PlaybackStateHandler(manager)
  592. {
  593. }
  594. ~StoppedStateHandler() override = default;
  595. private:
  596. ErrorOr<void> on_enter() override
  597. {
  598. return {};
  599. }
  600. StringView name() override { return "Stopped"sv; }
  601. ErrorOr<void> play() override
  602. {
  603. // When Stopped, the decoder thread will be waiting for a signal to start its loop going again.
  604. manager().m_decode_wait_condition.broadcast();
  605. return replace_handler_and_delete_this<SeekingStateHandler>(true, Duration::zero(), SeekMode::Fast);
  606. }
  607. bool is_playing() const override { return false; }
  608. PlaybackState get_state() const override { return PlaybackState::Stopped; }
  609. };
  610. }