servo/components/devtools/actors/framerate.rs

/* This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at https://mozilla.org/MPL/2.0/. */

use std::mem;

use atomic_refcell::AtomicRefCell;
use base::generic_channel::GenericSender;
use base::id::PipelineId;
use devtools_traits::DevtoolScriptControlMsg;
use malloc_size_of_derive::MallocSizeOf;

use crate::actor::{Actor, ActorRegistry};
use crate::actors::timeline::HighResolutionStamp;

#[derive(MallocSizeOf)]
pub(crate) struct FramerateActor {
    name: String,
    pipeline_id: PipelineId,
    script_sender: GenericSender<DevtoolScriptControlMsg>,
    is_recording: bool,
    ticks: AtomicRefCell<Vec<HighResolutionStamp>>,
}

impl Actor for FramerateActor {
    fn name(&self) -> String {
        self.name.clone()
    }
}

impl FramerateActor {
    /// Return name of actor
    pub fn create(
        registry: &ActorRegistry,
        pipeline_id: PipelineId,
        script_sender: GenericSender<DevtoolScriptControlMsg>,
    ) -> String {
        let actor_name = registry.new_name::<Self>();
        let mut actor = FramerateActor {
            name: actor_name.clone(),
            pipeline_id,
            script_sender,
            is_recording: false,
            ticks: Default::default(),
        };

        actor.start_recording();
        registry.register(actor);
        actor_name
    }

    pub fn add_tick(&self, tick: f64) {
        self.ticks
            .borrow_mut()
            .push(HighResolutionStamp::wrap(tick));

        if self.is_recording {
            let msg = DevtoolScriptControlMsg::RequestAnimationFrame(self.pipeline_id, self.name());
            self.script_sender.send(msg).unwrap();
        }
    }

    pub fn take_pending_ticks(&self) -> Vec<HighResolutionStamp> {
        mem::take(&mut self.ticks.borrow_mut())
    }

    fn start_recording(&mut self) {
        if self.is_recording {
            return;
        }

        self.is_recording = true;

        let msg = DevtoolScriptControlMsg::RequestAnimationFrame(self.pipeline_id, self.name());
        self.script_sender.send(msg).unwrap();
    }

    fn stop_recording(&mut self) {
        if !self.is_recording {
            return;
        }
        self.is_recording = false;
    }
}

impl Drop for FramerateActor {
    fn drop(&mut self) {
        self.stop_recording();
    }
}