Skip to content

Commit

Permalink
Auto merge of #18504 - servo:media, r=emilio
Browse files Browse the repository at this point in the history 
Some minor HTMLMediaElement improvements

<!-- Reviewable:start -->
This change is [<img src="https://reviewable.io/review_button.svg" height="34" align="absmiddle" alt="Reviewable"/>](https://reviewable.io/reviews/servo/servo/18504)
<!-- Reviewable:end -->
  • Loading branch information
bors-servo committed Sep 15, 2017
2 parents 4268037 + 518e34e commit 1b9a5ea
Showing 1 changed file with 83 additions and 62 deletions.
145 changes: 83 additions & 62 deletions components/script/dom/htmlmediaelement.rs
View file
Expand Up @@ -8,7 +8,7 @@ use dom::attr::Attr;
use dom::bindings::cell::DOMRefCell;
use dom::bindings::codegen::Bindings::AttrBinding::AttrMethods;
use dom::bindings::codegen::Bindings::HTMLMediaElementBinding::CanPlayTypeResult;
use dom::bindings::codegen::Bindings::HTMLMediaElementBinding::HTMLMediaElementConstants::*;
use dom::bindings::codegen::Bindings::HTMLMediaElementBinding::HTMLMediaElementConstants;
use dom::bindings::codegen::Bindings::HTMLMediaElementBinding::HTMLMediaElementMethods;
use dom::bindings::codegen::Bindings::MediaErrorBinding::MediaErrorConstants::*;
use dom::bindings::codegen::Bindings::MediaErrorBinding::MediaErrorMethods;
Expand Down Expand Up @@ -45,23 +45,23 @@ use time::{self, Timespec, Duration};
#[dom_struct]
pub struct HTMLMediaElement {
htmlelement: HTMLElement,
/// https://html.spec.whatwg.org/multipage/#dom-media-networkstate-2
/// https://html.spec.whatwg.org/multipage/#dom-media-networkstate
// FIXME(nox): Use an enum.
network_state: Cell<u16>,
/// https://html.spec.whatwg.org/multipage/#dom-media-readystate-2
network_state: Cell<NetworkState>,
/// https://html.spec.whatwg.org/multipage/#dom-media-readystate
// FIXME(nox): Use an enum.
ready_state: Cell<u16>,
/// https://html.spec.whatwg.org/multipage/#dom-media-currentsrc-2
ready_state: Cell<ReadyState>,
/// https://html.spec.whatwg.org/multipage/#dom-media-currentsrc
current_src: DOMRefCell<String>,
// FIXME(nox): Document this one, I have no idea what it is used for.
generation_id: Cell<u32>,
/// https://html.spec.whatwg.org/multipage/#fire-loadeddata
///
/// Reset to false every time the load algorithm is invoked.
fired_loadeddata_event: Cell<bool>,
/// https://html.spec.whatwg.org/multipage/#dom-media-error-2
/// https://html.spec.whatwg.org/multipage/#dom-media-error
error: MutNullableJS<MediaError>,
/// https://html.spec.whatwg.org/multipage/#dom-media-paused-2
/// https://html.spec.whatwg.org/multipage/#dom-media-paused
paused: Cell<bool>,
/// https://html.spec.whatwg.org/multipage/#attr-media-autoplay
autoplaying: Cell<bool>,
Expand All @@ -70,6 +70,27 @@ pub struct HTMLMediaElement {
video: DOMRefCell<Option<VideoMedia>>,
}

/// https://html.spec.whatwg.org/multipage/#dom-media-networkstate
#[derive(Clone, Copy, HeapSizeOf, JSTraceable, PartialEq)]
#[repr(u8)]
enum NetworkState {
Empty = HTMLMediaElementConstants::NETWORK_EMPTY as u8,
Idle = HTMLMediaElementConstants::NETWORK_IDLE as u8,
Loading = HTMLMediaElementConstants::NETWORK_LOADING as u8,
NoSource = HTMLMediaElementConstants::NETWORK_NO_SOURCE as u8,
}

/// https://html.spec.whatwg.org/multipage/#dom-media-readystate
#[derive(Clone, Copy, HeapSizeOf, JSTraceable, PartialEq, PartialOrd)]
#[repr(u8)]
enum ReadyState {
HaveNothing = HTMLMediaElementConstants::HAVE_NOTHING as u8,
HaveMetadata = HTMLMediaElementConstants::HAVE_METADATA as u8,
HaveCurrentData = HTMLMediaElementConstants::HAVE_CURRENT_DATA as u8,
HaveFutureData = HTMLMediaElementConstants::HAVE_FUTURE_DATA as u8,
HaveEnoughData = HTMLMediaElementConstants::HAVE_ENOUGH_DATA as u8,
}

#[derive(HeapSizeOf, JSTraceable)]
pub struct VideoMedia {
format: String,
Expand All @@ -89,8 +110,8 @@ impl HTMLMediaElement {
) -> Self {
Self {
htmlelement: HTMLElement::new_inherited(tag_name, prefix, document),
network_state: Cell::new(NETWORK_EMPTY),
ready_state: Cell::new(HAVE_NOTHING),
network_state: Cell::new(NetworkState::Empty),
ready_state: Cell::new(ReadyState::HaveNothing),
current_src: DOMRefCell::new("".to_owned()),
generation_id: Cell::new(0),
fired_loadeddata_event: Cell::new(false),
Expand Down Expand Up @@ -173,11 +194,11 @@ impl HTMLMediaElement {
}

// https://html.spec.whatwg.org/multipage/#ready-states
fn change_ready_state(&self, ready_state: u16) {
fn change_ready_state(&self, ready_state: ReadyState) {
let old_ready_state = self.ready_state.get();
self.ready_state.set(ready_state);

if self.network_state.get() == NETWORK_EMPTY {
if self.network_state.get() == NetworkState::Empty {
return;
}

Expand All @@ -186,21 +207,21 @@ impl HTMLMediaElement {

// Step 1
match (old_ready_state, ready_state) {
// previous ready state was HAVE_NOTHING, and the new ready state is
// HAVE_METADATA
(HAVE_NOTHING, HAVE_METADATA) => {
// Previous ready state was ReadyState::HaveNothing,
// and the new ready state is ReadyState::HaveMetadata.
(ReadyState::HaveNothing, ReadyState::HaveMetadata) => {
task_source.queue_simple_event(
self.upcast(),
atom!("loadedmetadata"),
&window,
);
}

// previous ready state was HAVE_METADATA and the new ready state is
// HAVE_CURRENT_DATA or greater
(HAVE_METADATA, HAVE_CURRENT_DATA) |
(HAVE_METADATA, HAVE_FUTURE_DATA) |
(HAVE_METADATA, HAVE_ENOUGH_DATA) => {
// Previous ready state was ReadyState::HaveMetadata, and the new
// ready state is ReadyState::HaveCurrentData or greater.
(ReadyState::HaveMetadata, ReadyState::HaveCurrentData) |
(ReadyState::HaveMetadata, ReadyState::HaveFutureData) |
(ReadyState::HaveMetadata, ReadyState::HaveEnoughData) => {
if !self.fired_loadeddata_event.get() {
self.fired_loadeddata_event.set(true);
task_source.queue_simple_event(
Expand All @@ -211,29 +232,29 @@ impl HTMLMediaElement {
}
}

// previous ready state was HAVE_FUTURE_DATA or more, and the new ready
// state is HAVE_CURRENT_DATA or less
(HAVE_FUTURE_DATA, HAVE_CURRENT_DATA) |
(HAVE_ENOUGH_DATA, HAVE_CURRENT_DATA) |
(HAVE_FUTURE_DATA, HAVE_METADATA) |
(HAVE_ENOUGH_DATA, HAVE_METADATA) |
(HAVE_FUTURE_DATA, HAVE_NOTHING) |
(HAVE_ENOUGH_DATA, HAVE_NOTHING) => {
// previous ready state was ReadyState::HaveFutureData or more,
// and the new ready state is ReadyState::HaveCurrentData or less.
(ReadyState::HaveFutureData, ReadyState::HaveCurrentData) |
(ReadyState::HaveEnoughData, ReadyState::HaveCurrentData) |
(ReadyState::HaveFutureData, ReadyState::HaveMetadata) |
(ReadyState::HaveEnoughData, ReadyState::HaveMetadata) |
(ReadyState::HaveFutureData, ReadyState::HaveNothing) |
(ReadyState::HaveEnoughData, ReadyState::HaveNothing) => {
// TODO: timeupdate event logic + waiting
}

_ => (),
}

// Step 1
// If the new ready state is HAVE_FUTURE_DATA or HAVE_ENOUGH_DATA,
// Step 1.
// If the new ready state is ReadyState::HaveFutureData or ReadyState::HaveEnoughData,
// then the relevant steps below must then be run also.
match (old_ready_state, ready_state) {
// previous ready state was HAVE_CURRENT_DATA or less, and the new ready
// state is HAVE_FUTURE_DATA
(HAVE_CURRENT_DATA, HAVE_FUTURE_DATA) |
(HAVE_METADATA, HAVE_FUTURE_DATA) |
(HAVE_NOTHING, HAVE_FUTURE_DATA) => {
// Previous ready state was ReadyState::HaveCurrentData or less,
// and the new ready state is ReadyState::HaveFutureData.
(ReadyState::HaveCurrentData, ReadyState::HaveFutureData) |
(ReadyState::HaveMetadata, ReadyState::HaveFutureData) |
(ReadyState::HaveNothing, ReadyState::HaveFutureData) => {
task_source.queue_simple_event(
self.upcast(),
atom!("canplay"),
Expand All @@ -245,9 +266,9 @@ impl HTMLMediaElement {
}
}

// new ready state is HAVE_ENOUGH_DATA
(_, HAVE_ENOUGH_DATA) => {
if old_ready_state <= HAVE_CURRENT_DATA {
// New ready state is ReadyState::HaveEnoughData.
(_, ReadyState::HaveEnoughData) => {
if old_ready_state <= ReadyState::HaveCurrentData {
task_source.queue_simple_event(
self.upcast(),
atom!("canplay"),
Expand Down Expand Up @@ -294,7 +315,7 @@ impl HTMLMediaElement {
// https://html.spec.whatwg.org/multipage/#concept-media-load-algorithm
fn invoke_resource_selection_algorithm(&self) {
// Step 1
self.network_state.set(NETWORK_NO_SOURCE);
self.network_state.set(NetworkState::NoSource);

// TODO step 2 (show poster)
// TODO step 3 (delay load event)
Expand Down Expand Up @@ -323,12 +344,12 @@ impl HTMLMediaElement {
// TODO <source> child
ResourceSelectionMode::Children(panic!())
} else {
self.network_state.set(NETWORK_EMPTY);
self.network_state.set(NetworkState::Empty);
return;
};

// Step 7
self.network_state.set(NETWORK_LOADING);
self.network_state.set(NetworkState::Loading);

// Step 8
let window = window_from_node(self);
Expand Down Expand Up @@ -384,7 +405,7 @@ impl HTMLMediaElement {
// 4.1
if self.Preload() == "none" && !self.autoplaying.get() {
// 4.1.1
self.network_state.set(NETWORK_IDLE);
self.network_state.set(NetworkState::Idle);

// 4.1.2
let window = window_from_node(self);
Expand Down Expand Up @@ -460,7 +481,7 @@ impl HTMLMediaElement {
// TODO step 2 (forget resource tracks)

// Step 3
self.network_state.set(NETWORK_NO_SOURCE);
self.network_state.set(NetworkState::NoSource);

// TODO step 4 (show poster)

Expand All @@ -487,8 +508,8 @@ impl HTMLMediaElement {
let task_source = window.dom_manipulation_task_source();

// Step 3
let network_state = self.NetworkState();
if network_state == NETWORK_LOADING || network_state == NETWORK_IDLE {
let network_state = self.network_state.get();
if network_state == NetworkState::Loading || network_state == NetworkState::Idle {
task_source.queue_simple_event(
self.upcast(),
atom!("abort"),
Expand All @@ -497,7 +518,7 @@ impl HTMLMediaElement {
}

// Step 4
if network_state != NETWORK_EMPTY {
if network_state != NetworkState::Empty {
// 4.1
task_source.queue_simple_event(self.upcast(), atom!("emptied"), &window);

Expand All @@ -507,8 +528,8 @@ impl HTMLMediaElement {
// TODO 4.4 (forget resource tracks)

// 4.5
if self.ready_state.get() != HAVE_NOTHING {
self.change_ready_state(HAVE_NOTHING);
if self.ready_state.get() != ReadyState::HaveNothing {
self.change_ready_state(ReadyState::HaveNothing);
}

// 4.6
Expand Down Expand Up @@ -536,12 +557,12 @@ impl HTMLMediaElement {
impl HTMLMediaElementMethods for HTMLMediaElement {
// https://html.spec.whatwg.org/multipage/#dom-media-networkstate
fn NetworkState(&self) -> u16 {
self.network_state.get()
self.network_state.get() as u16
}

// https://html.spec.whatwg.org/multipage/#dom-media-readystate
fn ReadyState(&self) -> u16 {
self.ready_state.get()
self.ready_state.get() as u16
}

// https://html.spec.whatwg.org/multipage/#dom-media-autoplay
Expand Down Expand Up @@ -594,7 +615,7 @@ impl HTMLMediaElementMethods for HTMLMediaElement {
// TODO step 3

// Step 4
if self.network_state.get() == NETWORK_EMPTY {
if self.network_state.get() == NetworkState::Empty {
self.invoke_resource_selection_algorithm();
}

Expand All @@ -618,9 +639,9 @@ impl HTMLMediaElementMethods for HTMLMediaElement {
task_source.queue_simple_event(self.upcast(), atom!("play"), &window);

// 7.4
if state == HAVE_NOTHING ||
state == HAVE_METADATA ||
state == HAVE_CURRENT_DATA {
if state == ReadyState::HaveNothing ||
state == ReadyState::HaveMetadata ||
state == ReadyState::HaveCurrentData {
task_source.queue_simple_event(
self.upcast(),
atom!("waiting"),
Expand All @@ -631,7 +652,7 @@ impl HTMLMediaElementMethods for HTMLMediaElement {
}
}
// Step 8
else if state == HAVE_FUTURE_DATA || state == HAVE_ENOUGH_DATA {
else if state == ReadyState::HaveFutureData || state == ReadyState::HaveEnoughData {
// TODO resolve pending play promises
}

Expand All @@ -646,7 +667,7 @@ impl HTMLMediaElementMethods for HTMLMediaElement {
// https://html.spec.whatwg.org/multipage/#dom-media-pause
fn Pause(&self) {
// Step 1
if self.network_state.get() == NETWORK_EMPTY {
if self.network_state.get() == NetworkState::Empty {
self.invoke_resource_selection_algorithm();
}

Expand Down Expand Up @@ -808,7 +829,7 @@ impl FetchResponseListener for HTMLMediaElementContext {
if !self.have_metadata {
self.check_metadata(&elem);
} else {
elem.change_ready_state(HAVE_CURRENT_DATA);
elem.change_ready_state(ReadyState::HaveCurrentData);
}

// https://html.spec.whatwg.org/multipage/#concept-media-load-resource step 4,
Expand All @@ -835,22 +856,22 @@ impl FetchResponseListener for HTMLMediaElementContext {
}
// => "Once the entire media resource has been fetched..."
else if status.is_ok() {
elem.change_ready_state(HAVE_ENOUGH_DATA);
elem.change_ready_state(ReadyState::HaveEnoughData);

elem.upcast::<EventTarget>().fire_event(atom!("progress"));

elem.network_state.set(NETWORK_IDLE);
elem.network_state.set(NetworkState::Idle);

elem.upcast::<EventTarget>().fire_event(atom!("suspend"));
}
// => "If the connection is interrupted after some media data has been received..."
else if elem.ready_state.get() != HAVE_NOTHING {
else if elem.ready_state.get() != ReadyState::HaveNothing {
// Step 2
elem.error.set(Some(&*MediaError::new(&*window_from_node(&*elem),
MEDIA_ERR_NETWORK)));

// Step 3
elem.network_state.set(NETWORK_IDLE);
elem.network_state.set(NetworkState::Idle);

// TODO: Step 4 - update delay load flag

Expand Down Expand Up @@ -901,7 +922,7 @@ impl HTMLMediaElementContext {
audio: meta.audio.audio,
});
// Step 6
elem.change_ready_state(HAVE_METADATA);
elem.change_ready_state(ReadyState::HaveMetadata);
self.have_metadata = true;
}
_ => {}
Expand Down

0 comments on commit 1b9a5ea

Please sign in to comment.