A user account is required in order to edit this wiki, but we've had to disable public user registrations due to spam.

To request an account, ask an autoconfirmed user on IRC (such as one of these permanent autoconfirmed members).

Difference between revisions of "Video Overlay"

From WHATWG Wiki
Jump to: navigation, search
(work in progress...)
(work in progress....)
Line 25: Line 25:
 
In order to overlay scripted controls on top of <video>, a wrapping <div> and some CSS is needed:
 
In order to overlay scripted controls on top of <video>, a wrapping <div> and some CSS is needed:
 
  <div style="position:relative;width:400px;height:300px">
 
  <div style="position:relative;width:400px;height:300px">
  <video src="video.ogv" style="width:100%;height:100%"></video>
+
  <video src="video.ogv" style="width:100%;height:100%"></video>
  <div class="controls" style="position:absolute;bottom:0;left:0;right:0">
+
  <div class="controls" style="position:absolute;bottom:0;left:0;right:0">
  <!-- actual controls here -->
+
    <!-- actual controls here -->
  </div>
+
  </div>
 
  </div>
 
  </div>
 
This isn't terrible, but requires the size of the video to be known or be fixed to a certain size as above.
 
This isn't terrible, but requires the size of the video to be known or be fixed to a certain size as above.
  
 
=== Benefits ===
 
=== Benefits ===
 
+
<overlay> provides a single container for styling for all kinds of overlay content. The alternative would be to have one markup for in-band and external captions/subtitles (e.g. <itext>) and another solution for scripted captions/subtitles/controls/annotations, even though the problem solved is mostly exactly the same.
''Explanation of how and why new markup would be useful.''
 
  
 
=== Requests for this Feature ===
 
=== Requests for this Feature ===
Line 44: Line 43:
  
 
=== My Solution ===
 
=== My Solution ===
:''Brief description of the solution and of how it address the problem at hand.''
+
The <overlay> element is used as a child of <video>. It can optionally refer to an external source, which should be in a format supported by the UA. Example:
 +
<video src="video.ogv">
 +
  <overlay src="captions.srt">
 +
</video>
 +
Possibly, one could allow <overlay> to have <source> element children, similar to <video>. The purpose would be group resources which are mutually exclusive, e.g. subtitles in different languages:
 +
<video src="video.ogv">
 +
  <overlay>
 +
    <source src="captions-english.srt" lang="en"></source>
 +
    <source src="captions-simplified-chinese.srt" lang="zh-Hans"></source>
 +
  </overlay>
 +
</video>
 +
If necessary, one could also <source> to provide the same resource in multiple formats for fallback purposes:
 +
<video src="video.ogv">
 +
  <overlay>
 +
    <source src="captions.srt" type="text/x-srt"></source>
 +
    <source src="captions.xml" type="application/ttaf+xml"></source>
 +
  </overlay>
 +
</video>
 +
 
 +
When <overlay> does not point to an external resource, its content should instead be displayed. By updating the content with scripts, the possibilities are many:
 +
<video src="video.ogv">
 +
  <overlay><!-- content goes here --></overlay>
 +
</video>
 +
<script>
 +
  var v = document.querySelector("video");
 +
  var ol = v.querySelector("overlay");
 +
  v.ontimeupdate = function() {
 +
    ol.textContent = someInterestingText();
 +
  }
 +
</script>
  
 
==== Processing Model ====
 
==== Processing Model ====

Revision as of 12:30, 28 November 2009

<overlay> is a proposal to display and style subtitles/captions for <video> in a uniform way, regardless of whether they are in-band or from an external resource. It also doubles as a container to overlay arbitrary (HTML) content on a <video>, enabling advanced scripted overlays such as karaoke animations or visual annotations.

Use Case Description

There are several distinct use cases addressed by this proposal:

  • Linking < with external captions/subtitles for native fetching/decoding/display by the UA.
  • Styling captions/subtitles with CSS, regardless of their source.
  • Allowing scripts to operate on captions/subtitles in a uniform manner, regardless of their source.

Possible sources of captions/subtitles include in-band (e.g. embedded in an MPEG-4 or Ogg stream), external (e.g. SRT or DXFP) or scripted (e.g. extracted from an on-page transcript) captions/subtitles.

Current Limitations

HTML5 currently lacks convenient markup and/or interfaces to handle at least these things:

  • Syncing and styling external subtitles/captions with <video>
  • Styling in-band subtitles/captions from media resources
  • Rendering scripted controls on top of <video> and positioning them to bottom.
  • Callbacks at specific times for scripted subtitles/captions (previously possible with "cue ranges")
  • Allowing any overlay (controls/captions/etc) to be retained in fullscreen mode.

Current Usage and Workarounds

Currently no browser supports rendering in-band subtitles, so there are no workarounds for styling them. Fullscreen support is still immature, but there is no possible workaround for having scripted captions or controls to appear in fullscreen display.

Scripted Captions

In Silvia's <itext> demo external SRT subtitles are fetched with XHR, parsed with JavaScript and finally synced in the timeupdate event. Using the timeupdate event is sub-optimal because it isn't guaranteed to fire any more often than every 250 ms, which isn't enough for fast-paced dialog.

Scripted Controls

In order to overlay scripted controls on top of <video>, a wrapping <div> and some CSS is needed:

<div style="position:relative;width:400px;height:300px">
  <video src="video.ogv" style="width:100%;height:100%"></video>
  <div class="controls" style="position:absolute;bottom:0;left:0;right:0">
    <!-- actual controls here -->
  </div>
</div>

This isn't terrible, but requires the size of the video to be known or be fixed to a certain size as above.

Benefits

<overlay> provides a single container for styling for all kinds of overlay content. The alternative would be to have one markup for in-band and external captions/subtitles (e.g. <itext>) and another solution for scripted captions/subtitles/controls/annotations, even though the problem solved is mostly exactly the same.

Requests for this Feature

  • <overlay> Suggested by Philip Jägenstedt (Opera)

TODO: Find the many mails related to some of the features addressed by <overlay>

Proposed Solutions

My Solution

The <overlay> element is used as a child of <video>. It can optionally refer to an external source, which should be in a format supported by the UA. Example:

<video src="video.ogv">
  <overlay src="captions.srt">
</video>

Possibly, one could allow <overlay> to have <source> element children, similar to <video>. The purpose would be group resources which are mutually exclusive, e.g. subtitles in different languages:

<video src="video.ogv">
  <overlay>
    <source src="captions-english.srt" lang="en"></source>
    <source src="captions-simplified-chinese.srt" lang="zh-Hans"></source>
  </overlay>
</video>

If necessary, one could also <source> to provide the same resource in multiple formats for fallback purposes:

<video src="video.ogv">
  <overlay>
    <source src="captions.srt" type="text/x-srt"></source>
    <source src="captions.xml" type="application/ttaf+xml"></source>
  </overlay>
</video>

When <overlay> does not point to an external resource, its content should instead be displayed. By updating the content with scripts, the possibilities are many:

<video src="video.ogv">
  <overlay><!-- content goes here --></overlay>
</video>
<script>
  var v = document.querySelector("video");
  var ol = v.querySelector("overlay");
  v.ontimeupdate = function() {
    ol.textContent = someInterestingText();
  }
</script>

Processing Model

Explanation of the changes introduced by this solution. It explains how the document is processed, and how errors are handled. This should be very clear, including things such as event timing if the solution involves events, how to create graphs representing the data in the case of semantic proposals, etc.

Limitations

Cases not covered by this solution in relation to the problem description; other problems with this solution, if any.

Implementation

Description of how and why browser vendors would take advantage of this feature.

Adoption

Reasons why page authors would use this solution.

References

Silvia Pfeiffer's blog posts:

Silvia Pfeiffer's <itext> proposals:

Mailing lists: