Flutter Engine Uber Docs
Docs for the entire Flutter Engine repo.
 
Loading...
Searching...
No Matches
flutter::MultiFrameCodec Class Reference

#include <multi_frame_codec.h>

Inheritance diagram for flutter::MultiFrameCodec:
flutter::Codec flutter::RefCountedDartWrappable< Codec > fml::RefCountedThreadSafe< T > tonic::DartWrappable fml::internal::RefCountedThreadSafeBase

Public Member Functions

 MultiFrameCodec (std::shared_ptr< ImageGenerator > generator)
 
 ~MultiFrameCodec () override
 
int frameCount () const override
 
int repetitionCount () const override
 
Dart_Handle getNextFrame (Dart_Handle args) override
 
- Public Member Functions inherited from flutter::Codec
void dispose ()
 
- Public Member Functions inherited from flutter::RefCountedDartWrappable< Codec >
virtual void RetainDartWrappableReference () const override
 
virtual void ReleaseDartWrappableReference () const override
 
- Public Member Functions inherited from fml::RefCountedThreadSafe< T >
void Release () const
 
- Public Member Functions inherited from fml::internal::RefCountedThreadSafeBase
void AddRef () const
 
bool HasOneRef () const
 
void AssertHasOneRef () const
 
- Public Member Functions inherited from tonic::DartWrappable
 DartWrappable ()
 
virtual const DartWrapperInfoGetDartWrapperInfo () const =0
 
Dart_Handle CreateDartWrapper (DartState *dart_state)
 
void AssociateWithDartWrapper (Dart_Handle wrappable)
 
void ClearDartWrapper ()
 
Dart_WeakPersistentHandle dart_wrapper () const
 

Additional Inherited Members

- Public Types inherited from tonic::DartWrappable
enum  DartNativeFields {
  kPeerIndex ,
  kNumberOfNativeFields
}
 
- Protected Member Functions inherited from fml::RefCountedThreadSafe< T >
 RefCountedThreadSafe ()
 
 ~RefCountedThreadSafe ()
 
- Protected Member Functions inherited from fml::internal::RefCountedThreadSafeBase
 RefCountedThreadSafeBase ()
 
 ~RefCountedThreadSafeBase ()
 
bool Release () const
 
void Adopt ()
 
- Protected Member Functions inherited from tonic::DartWrappable
virtual ~DartWrappable ()
 
- Static Protected Member Functions inherited from tonic::DartWrappable
static Dart_PersistentHandle GetTypeForWrapper (tonic::DartState *dart_state, const tonic::DartWrapperInfo &wrapper_info)
 

Detailed Description

Definition at line 16 of file multi_frame_codec.h.

Constructor & Destructor Documentation

◆ MultiFrameCodec()

flutter::MultiFrameCodec::MultiFrameCodec ( std::shared_ptr< ImageGenerator generator)
explicit

Definition at line 26 of file multi_frame_codec.cc.

27 : state_(new State(std::move(generator))) {}

◆ ~MultiFrameCodec()

flutter::MultiFrameCodec::~MultiFrameCodec ( )
overridedefault

Member Function Documentation

◆ frameCount()

int flutter::MultiFrameCodec::frameCount ( ) const
overridevirtual

Implements flutter::Codec.

Definition at line 319 of file multi_frame_codec.cc.

319 {
320 return state_->frameCount_;
321}

◆ getNextFrame()

Dart_Handle flutter::MultiFrameCodec::getNextFrame ( Dart_Handle  args)
overridevirtual

Implements flutter::Codec.

Definition at line 269 of file multi_frame_codec.cc.

269 {
270 static size_t trace_counter = 1;
271 const size_t trace_id = trace_counter++;
272
273 if (!Dart_IsClosure(callback_handle)) {
274 return tonic::ToDart("Callback must be a function");
275 }
276
277 auto* dart_state = UIDartState::Current();
278
279 const auto& task_runners = dart_state->GetTaskRunners();
280
281 if (state_->frameCount_ == 0) {
282 std::string decode_error("Could not provide any frame.");
283 FML_LOG(ERROR) << decode_error;
284 task_runners.GetUITaskRunner()->PostTask(fml::MakeCopyable(
285 [trace_id, decode_error = std::move(decode_error),
286 callback = std::make_unique<tonic::DartPersistentValue>(
287 tonic::DartState::Current(), callback_handle)]() mutable {
288 InvokeNextFrameCallback(nullptr, 0, decode_error, std::move(callback),
289 trace_id);
290 }));
291 return Dart_Null();
292 }
293
294 task_runners.GetIOTaskRunner()->PostTask(fml::MakeCopyable(
295 [callback = std::make_unique<tonic::DartPersistentValue>(
296 tonic::DartState::Current(), callback_handle),
297 weak_state = std::weak_ptr<MultiFrameCodec::State>(state_), trace_id,
298 ui_task_runner = task_runners.GetUITaskRunner(),
299 io_manager = dart_state->GetIOManager()]() mutable {
300 auto state = weak_state.lock();
301 if (!state) {
302 ui_task_runner->PostTask(fml::MakeCopyable(
303 [callback = std::move(callback)]() { callback->Clear(); }));
304 return;
305 }
306 state->GetNextFrameAndInvokeCallback(
307 std::move(callback), ui_task_runner,
308 io_manager->GetResourceContext(), io_manager->GetSkiaUnrefQueue(),
309 io_manager->GetIsGpuDisabledSyncSwitch(), trace_id,
310 io_manager->GetImpellerContext());
311 }));
312
313 return Dart_Null();
314 // The static leak checker gets confused by the control flow, unique
315 // pointers and closures in this function.
316 // NOLINTNEXTLINE(clang-analyzer-cplusplus.NewDeleteLeaks)
317}
static UIDartState * Current()
static DartState * Current()
Definition dart_state.cc:56
FlutterDesktopBinaryReply callback
#define FML_LOG(severity)
Definition logging.h:101
static void InvokeNextFrameCallback(const fml::RefPtr< CanvasImage > &image, int duration, const std::string &decode_error, std::unique_ptr< tonic::DartPersistentValue > callback, size_t trace_id)
internal::CopyableLambda< T > MakeCopyable(T lambda)
Dart_Handle ToDart(const T &object)

References callback, flutter::UIDartState::Current(), tonic::DartState::Current(), FML_LOG, flutter::InvokeNextFrameCallback(), fml::MakeCopyable(), and tonic::ToDart().

◆ repetitionCount()

int flutter::MultiFrameCodec::repetitionCount ( ) const
overridevirtual

Implements flutter::Codec.

Definition at line 323 of file multi_frame_codec.cc.

323 {
324 return state_->repetitionCount_;
325}

The documentation for this class was generated from the following files: