Skip to content

Commit

Permalink
Migrate spec to Media WG (#150)
Browse files Browse the repository at this point in the history
This update adjusts the metadata of the spec as it gets adopted by the Media
Working Group, and makes the following changes:

- Update CONTRIBUTING.md to match that used in W3C
- Update LICENSE.md to drop the CLA part
- Update links in README.md and to mention Media WG
- Update w3c.json
- Update status, group, and links that currently target the WICG repo in the
spec itself

Also note the switch to `Level: None` in the metadata of the spec as I suspect
that the group will publish the API without any level, at least initially.

This update also drops the hyphen in `web-codecs` as discussed in:
#149 (comment)

The default boilerplate for the Status of This Document section of the Media WG
asserts that the specs are intended to be published as W3C Recommendations. The
text needs to be adjusted for drafts that are intended to be published as W3C
Working Group Notes.

There is no specific way to flag the targeted spec status in Bikeshed. The idea
is thus to add a `Text macro: NOTE yes` macro definition in the spec metadata
and conditionals in the boilerplate files to issue the right text.

The updates to the boilerplate files are at:
speced/bikeshed#1999

Privacy and Security Consideration sections have also been added to registry
notes that targets the relevants sections in the main WebCodecs spec.
  • Loading branch information
tidoust authored Mar 30, 2021
1 parent 7f12b42 commit 4b76877
Show file tree
Hide file tree
Showing 8 changed files with 87 additions and 75 deletions.
32 changes: 17 additions & 15 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,23 +1,25 @@
# Web Platform Incubator Community Group
# Contributing

This repository is being used for work in the W3C Web Platform Incubator Community Group, governed by the [W3C Community License
Agreement (CLA)](http://www.w3.org/community/about/agreements/cla/). To make substantive contributions,
you must join the CG.
Contributions to this repository are intended to become part of Recommendation-track documents
governed by the [W3C Patent Policy](http://www.w3.org/Consortium/Patent-Policy-20040205/) and
[Software and Document License](http://www.w3.org/Consortium/Legal/copyright-software). To contribute, you must
either participate in the relevant W3C Working Group or make a non-member patent licensing
commitment.

If you are not the sole contributor to a contribution (pull request), please identify all
contributors in the pull request comment.
contributors in the pull request's body or in subsequent comments.

To add a contributor (other than yourself, that's automatic), mark them one per line as follows:
To add a contributor (other than yourself, that's automatic), mark them one per line as follows:

```
+@github_username
```
```
+@github_username
```

If you added a contributor by mistake, you can remove them in a comment with:
If you added a contributor by mistake, you can remove them in a comment with:

```
-@github_username
```
```
-@github_username
```

If you are making a pull request on behalf of someone else but you had no part in designing the
feature, you can remove yourself with the above syntax.
If you are making a pull request on behalf of someone else but you had no part in designing the
feature, you can remove yourself with the above syntax.
12 changes: 2 additions & 10 deletions LICENSE.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,2 @@
All Reports in this Repository are licensed by Contributors
under the
[W3C Software and Document License](http://www.w3.org/Consortium/Legal/2015/copyright-software-and-document).

Contributions to Specifications are made under the
[W3C CLA](https://www.w3.org/community/about/agreements/cla/).

Contributions to Test Suites are made under the
[W3C 3-clause BSD License](https://www.w3.org/Consortium/Legal/2008/03-bsd-license.html)

All documents in this Repository are licensed by contributors under the [W3C
Software and Document License](http://www.w3.org/Consortium/Legal/copyright-software).
7 changes: 3 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,3 @@
https://wicg.github.io/web-codecs/

# Try it out in Chrome 86

Please see [this doc for current limitations](https://docs.google.com/document/d/1H1UHn3DIw-LOfBUdNUFR6l2-zSipXuHCVmhrwF3rR6w/edit).
Expand All @@ -13,7 +11,8 @@ https://developers.chrome.com/origintrials/#/register_trial/-7811493553674125311

# WebCodecs

API that allows web applications to encode and decode audio and video
The [WebCodecs API](https://w3c.github.io/webcodecs/) allows web applications
to encode and decode audio and video.

Many Web APIs use media codecs internally to support APIs for particular uses:
- HTMLMediaElement and Media Source Extensions
Expand All @@ -33,5 +32,5 @@ It's great for:
- Cloud gaming
- Media file editing and transcoding

See the [explainer](https://github.com/pthatcherg/web-codecs/blob/master/explainer.md) for more info.
See the [explainer](https://github.com/w3c/webcodecs/blob/main/explainer.md) for more info.

35 changes: 22 additions & 13 deletions avc_codec_registration.src.html
Original file line number Diff line number Diff line change
@@ -1,15 +1,17 @@
<pre class='metadata'>
Title: AVC (H.264) WebCodecs Registration
Repository: wicg/web-codecs
Status: CG-DRAFT
Repository: w3c/webcodecs
Status: ED
Shortname: webcodecs-avc-codec-registration
Level: none
Group: wicg
ED: none
Group: mediawg
ED: https://w3c.github.io/webcodecs/avc_codec_registration.html
Editor: Chris Cunningham, w3cid 114832, Google Inc. https://google.com/
Editor: Paul Adenot, w3cid 62410, Mozilla https://www.mozilla.org/
Editor: Bernard Aboba, w3cid 65611, Microsoft Corporation https://www.microsoft.com/

Boilerplate: omit conformance
Text macro: NOTE yes

Abstract: This registration is entered into the [[webcodecs-codec-registry]].
It describes, for AVC (H.264), the (1) fully qualified codec strings, (2)
Expand All @@ -25,13 +27,13 @@
This registration is non-normative.

Markup Shorthands:css no, markdown yes, dfn yes
!Participate: <a href="https://github.com/wicg/web-codecs">Git Repository.</a>
!Participate: <a href="https://github.com/wicg/web-codecs/issues/new">File an issue.</a>
!Version History: <a href="https://github.com/wicg/web-codecs/commits">https://github.com/wicg/web-codecs/commits</a>
!Participate: <a href="https://github.com/w3c/webcodecs">Git Repository.</a>
!Participate: <a href="https://github.com/w3c/webcodecs/issues/new">File an issue.</a>
!Version History: <a href="https://github.com/w3c/webcodecs/commits">https://github.com/w3c/webcodecs/commits</a>
</pre>

<pre class='anchors'>
spec: webcodecs; urlPrefix: https://wicg.github.io/web-codecs/#
spec: WEBCODECS; urlPrefix: https://w3c.github.io/webcodecs/#
type: attribute
text: VideoDecoderConfig.description; url: dom-videodecoderconfig-description
type: interface
Expand All @@ -45,14 +47,14 @@
<pre class='biblio'>
{
"WEBCODECS": {
"href": "https://wicg.github.io/web-codecs/",
"href": "https://w3c.github.io/webcodecs/",
"title": "WebCodecs",
"publisher": "WICG"
"publisher": "W3C"
},
"WEBCODECS-CODEC-REGISTRY": {
"href": "https://wicg.github.io/web-codecs/codec_registry.html",
"href": "https://w3c.github.io/webcodecs/codec_registry.html",
"title": "WebCodecs Codec Registry",
"publisher": "WICG"
"publisher": "W3C"
},
"ITU-T-REC-H.264": {
"href": "https://www.itu.int/rec/T-REC-H.264",
Expand Down Expand Up @@ -170,4 +172,11 @@
NOTE: This format is described in greater detail by [[iso14496-15]],
section 5.3.3.1. This format is commonly used in .MP4 files, where the
player generally has random access to the media data.
</dl>
</dl>

Privacy and Security Considerations {#privacy-and-security-considerations}
==========================================================================

Please refer to the [[WEBCODECS#privacy-considerations|Privacy Considerations]]
and [[WEBCODECS#security-considerations|Security Considerations]] sections in
[[WEBCODECS]].
38 changes: 23 additions & 15 deletions codec_registry.src.html
Original file line number Diff line number Diff line change
@@ -1,22 +1,23 @@
<pre class='metadata'>
Title: WebCodecs Codec Registry
Repository: wicg/web-codecs
Status: CG-DRAFT
Repository: w3c/webcodecs
Status: ED
Shortname: webcodecs-codec-registry
Level: none
Group: wicg
ED: none
Group: mediawg
ED: https://w3c.github.io/webcodecs/codec_registry.html
Editor: Chris Cunningham, w3cid 114832, Google Inc. https://google.com/
Editor: Paul Adenot, w3cid 62410, Mozilla https://www.mozilla.org/
Editor: Bernard Aboba, w3cid 65611, Microsoft Corporation https://www.microsoft.com/

Boilerplate: omit conformance
Text macro: NOTE yes

Abstract: This registry is intended to enhance interoperability among
implementations and users of [[webcodecs]]. In particular, this
implementations and users of [[WEBCODECS]]. In particular, this
registry provides the means to identify and avoid collisions among codec
strings and provides a mechanism to define codec-specific members of
[[webcodecs]] codec configuration dictionaries.
[[WEBCODECS]] codec configuration dictionaries.

This registry is not intended to include any information on whether a codec
format is encumbered by intellectual property claims. Implementers and
Expand All @@ -28,13 +29,13 @@
This registry is non-normative.

Markup Shorthands:css no, markdown yes, dfn yes
!Participate: <a href="https://github.com/wicg/web-codecs">Git Repository.</a>
!Participate: <a href="https://github.com/wicg/web-codecs/issues/new">File an issue.</a>
!Version History: <a href="https://github.com/wicg/web-codecs/commits">https://github.com/wicg/web-codecs/commits</a>
!Participate: <a href="https://github.com/w3c/webcodecs">Git Repository.</a>
!Participate: <a href="https://github.com/w3c/webcodecs/issues/new">File an issue.</a>
!Version History: <a href="https://github.com/w3c/webcodecs/commits">https://github.com/w3c/webcodecs/commits</a>
</pre>

<pre class='anchors'>
spec: web-codecs; urlPrefix: https://wicg.github.io/web-codecs/#
spec: WEBCODECS; urlPrefix: https://w3c.github.io/webcodecs/#
type: attribute
text: AudioDecoderConfig.description; url: dom-audiodecoderconfig-description
text: VideoDecoderConfig.description; url: dom-videodecoderconfig-description
Expand All @@ -45,14 +46,14 @@
<pre class='biblio'>
{
"WEBCODECS": {
"href": "https://wicg.github.io/web-codecs/",
"href": "https://w3c.github.io/webcodecs/",
"title": "WebCodecs",
"publisher": "WICG"
"publisher": "W3C"
},
"WEBCODECS-AVC-REGISTRATION": {
"href": "https://wicg.github.io/web-codecs/avc_codec_registration.html",
"href": "https://w3c.github.io/webcodecs/avc_codec_registration.html",
"title": "AVC (H.264) WebCodecs Registration",
"publisher": "WICG"
"publisher": "W3C"
}
}
</pre>
Expand Down Expand Up @@ -84,7 +85,7 @@
registration must link to a public specification describing how to populate
these fields.
4. Candidate entries must be announced by filing an issue in the
[WebCodecs GitHub issue tracker](https://github.com/wicg/web-codecs/issues/)
[WebCodecs GitHub issue tracker](https://github.com/w3c/webcodecs/issues/)
so they can be discussed and evaluated for compliance before being added to
the registry.

Expand Down Expand Up @@ -170,3 +171,10 @@
<td>TODO (string)</td>
</tr>
</table>

Privacy and Security Considerations {#privacy-and-security-considerations}
==========================================================================

Please refer to the [[WEBCODECS#privacy-considerations|Privacy Considerations]]
and [[WEBCODECS#security-considerations|Security Considerations]] sections in
[[WEBCODECS]].
2 changes: 1 addition & 1 deletion explainer.md
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,7 @@ Core interfaces include

- **AudioFrame** contains decoded audio data. It will provide an [AudioBuffer](https://webaudio.github.io/web-audio-api/#audiobuffer) for rendering via [AudioWorklet](https://webaudio.github.io/web-audio-api/#audioworklet).

- **VideoFrame** contains decoded video data. It will provide an [ImageBitmap](https://html.spec.whatwg.org/multipage/imagebitmap-and-animations.html#imagebitmap) for manipulating in WebGL, including rendering to Canvas. It should eventually also [provide access to YUV data](https://github.com/WICG/web-codecs/issues/30), but the design is still TBD.
- **VideoFrame** contains decoded video data. It will provide an [ImageBitmap](https://html.spec.whatwg.org/multipage/imagebitmap-and-animations.html#imagebitmap) for manipulating in WebGL, including rendering to Canvas. It should eventually also [provide access to YUV data](https://github.com/w3c/webcodecs/issues/30), but the design is still TBD.

- An **AudioEncoder** encodes AudioFrames to produce EncodedAudioChunks.

Expand Down
24 changes: 12 additions & 12 deletions index.src.html
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
<pre class='metadata'>
Title: WebCodecs
Repository: wicg/web-codecs
Status: CG-DRAFT
ED: https://wicg.github.io/web-codecs/
Repository: w3c/webcodecs
Status: ED
ED: https://w3c.github.io/webcodecs/
Shortname: webcodecs
Level: 1
Group: wicg
Level: None
Group: mediawg
Editor: Chris Cunningham, w3cid 114832, Google Inc. https://google.com/
Editor: Paul Adenot, w3cid 62410, Mozilla https://www.mozilla.org/
Editor: Bernard Aboba, w3cid 65611, Microsoft Corporation https://www.microsoft.com/
Expand All @@ -20,9 +20,9 @@
codecs or none at all.

Markup Shorthands:css no, markdown yes, dfn yes
!Participate: <a href="https://github.com/wicg/web-codecs">Git Repository.</a>
!Participate: <a href="https://github.com/wicg/web-codecs/issues/new">File an issue.</a>
!Version History: <a href="https://github.com/wicg/web-codecs/commits">https://github.com/wicg/web-codecs/commits</a>
!Participate: <a href="https://github.com/w3c/webcodecs">Git Repository.</a>
!Participate: <a href="https://github.com/w3c/webcodecs/issues/new">File an issue.</a>
!Version History: <a href="https://github.com/w3c/webcodecs/commits">https://github.com/w3c/webcodecs/commits</a>
</pre>

<pre class='anchors'>
Expand Down Expand Up @@ -73,9 +73,9 @@
<pre class='biblio'>
{
"WEBCODECS-CODEC-REGISTRY": {
"href": "https://wicg.github.io/web-codecs/codec_registry.html",
"href": "https://w3c.github.io/webcodecs/codec_registry.html",
"title": "WebCodecs Codec Registry",
"publisher": "WICG"
"publisher": "W3C"
}
}
</pre>
Expand Down Expand Up @@ -1119,7 +1119,7 @@
encode |output|. But, as written, it may occur that |output| was
encoded using a previous {{VideoEncoderConfig}} that has since
been replaced by a later call to {{VideoEncoder/configure()}}.
See [#138](https://github.com/WICG/web-codecs/issues/138).
See [#138](https://github.com/w3c/webcodecs/issues/138).

2. Let |output_config| be a {{VideoDecoderConfig}} that describes
|output|. Initialize |output_config| as follows:
Expand Down Expand Up @@ -2360,7 +2360,7 @@
immutable.

ISSUE: EncodedVideoChunk and EncodedAudioChunk currently expose a mutable
data. See <a href="https://github.com/WICG/web-codecs/issues/80">#80</a>.
data. See <a href="https://github.com/w3c/webcodecs/issues/80">#80</a>.

Privacy Considerations{#privacy-considerations}
===============================================
Expand Down
12 changes: 7 additions & 5 deletions w3c.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
{
"group": [80485]
, "contacts": ["yoavweiss"]
, "repo-type": "cg-report"
}
{
"group": 115198,
"contacts": [
"tidoust"
],
"repo-type": "rec-track"
}

0 comments on commit 4b76877

Please sign in to comment.