CARVIEW |
FLAC WebCodecs Registration
More details about this document
- This version:
- https://www.w3.org/TR/2023/DNOTE-webcodecs-flac-codec-registration-20230511/
- Latest published version:
- https://www.w3.org/TR/webcodecs-flac-codec-registration/
- Editor's Draft:
- https://w3c.github.io/webcodecs/flac_codec_registration.html
- Previous Versions:
- https://www.w3.org/TR/2023/DNOTE-webcodecs-flac-codec-registration-20230427/
- History:
- https://www.w3.org/standards/history/webcodecs-flac-codec-registration
- Feedback:
- GitHub
- Editors:
- Paul Adenot (Mozilla)
- Bernard Aboba (Microsoft Corporation)
- Former Editor:
- Chris Cunningham (Google Inc.)
- Participate:
- Git Repository.
- File an issue.
- Version History:
- https://github.com/w3c/webcodecs/commits
Copyright © 2023 World Wide Web Consortium. W3C® liability, trademark and permissive document license rules apply.
Abstract
This registration is entered into the [webcodecs-codec-registry].
It describes, for FLAC, the (1) fully qualified codec strings,
(2) the codec-specific EncodedAudioChunk
[[internal data]]
bytes, (3) the AudioDecoderConfig.description
bytes,
(4) the values of EncodedAudioChunk
[[type]]
,
and (5) the codec-specific extensions to AudioEncoderConfig
.
The registration is not intended to include any information on whether a codec format is encumbered by intellectual property claims. Implementers and authors are advised to seek appropriate legal counsel in this matter if they intend to implement or use a specific codec format. Implementers of WebCodecs are not required to support the FLAC codec.
This registration is non-normative.
Status of this document
This section describes the status of this document at the time of its publication. A list of current W3C publications and the latest revision of this technical report can be found in the W3C technical reports index at https://www.w3.org/TR/.
Feedback and comments on this specification are welcome. GitHub Issues are preferred for discussion on this specification. Alternatively, you can send comments to the Media Working Group’s mailing-list, public-media-wg@w3.org (archives). This draft highlights some of the pending issues that are still to be discussed in the working group. No decision has been taken on the outcome of these issues including whether they are valid.
This document was published by the Media Working Group as a Group Draft Note using the Note track.
Group Draft Notes are not endorsed by W3C nor its Members.
This is a draft document and may be updated, replaced or obsoleted by other documents at any time. It is inappropriate to cite this document as other than work in progress.
The W3C Patent Policy does not carry any licensing requirements or commitments on this document.
This document is governed by the 2 November 2021 W3C Process Document.
1. Fully qualified codec strings
The codec string is "flac"
.
2. EncodedAudioChunk data
EncodedAudioChunk
[[internal data]]
is expected to be
a "FRAME" as described in [FLAC].
3. AudioDecoderConfig description
description
is required, and has to be the following:
-
The bytes
0x66 0x4C 0x61 0x43
("fLaC
" in ASCII) -
A
metadata block
(called the STREAMINFO block) as described in section 7 of [FLAC] -
Optionaly other metadata blocks, that are not used by the specification
The sampleRate
and numberOfChannels
members are overridden by what the decoder finds in the description
.
NOTE: This corresponds to the beginning of a FLAC bitstream, before the audio frames.
4. EncodedAudioChunk type
The [[type]]
for an EncodedAudioChunk
containing
FLAC is always "key
".
NOTE: Once the initialization has succeeded, any FLAC packet can be decoded at any time without error, but this might not result in the expected audio output.
5. AudioEncoderConfig extensions
partial dictionary AudioEncoderConfig {FlacEncoderConfig flac ; };
flac
, of type FlacEncoderConfig- Contains codec specific configuration options for the FLAC codec.
5.1. FlacEncoderConfig
dictionary { [
FlacEncoderConfig EnforceRange ]unsigned long blockSize = 0; [EnforceRange ]unsigned long compressLevel = 5; };
To check if an FlacEncoderConfig
is valid, run these steps:
-
If
blockSize
is not a valid block size, which is described section 5.1 of [FLAC], returnfalse
. -
If
compressLevel
is specified and not within the range of0
(fastest, least compression) and8
(slowest, most compression) inclusively, returnfalse
. -
Return
true
.
blockSize
, of type unsigned long, defaulting to0
-
Configures the number of samples to use per frame, of output
EncodedAudioChunk
s.NOTE: Use 0 to let the encoder estimate a blocksize by default.
compressLevel
, of type unsigned long, defaulting to5
- Configures the compression level to use while encoding.
6. Privacy Considerations
Please refer to the section Privacy Considerations in [WEBCODECS].
7. Security Considerations
Please refer to the section Security Considerations in [WEBCODECS].
Conformance
Document conventions
Conformance requirements are expressed with a combination of descriptive assertions and RFC 2119 terminology. The key words “MUST”, “MUST NOT”, “REQUIRED”, “SHALL”, “SHALL NOT”, “SHOULD”, “SHOULD NOT”, “RECOMMENDED”, “MAY”, and “OPTIONAL” in the normative parts of this document are to be interpreted as described in RFC 2119. However, for readability, these words do not appear in all uppercase letters in this specification.
All of the text of this specification is normative except sections explicitly marked as non-normative, examples, and notes. [RFC2119]
Examples in this specification are introduced with the words “for example”
or are set apart from the normative text
with class="example"
,
like this:
Informative notes begin with the word “Note”
and are set apart from the normative text
with class="note"
,
like this:
Note, this is an informative note.
Index
Terms defined by this specification
- blockSize, in § 5.1
- compressLevel, in § 5.1
- flac, in § 5
- FlacEncoderConfig, in § 5.1
Terms defined by reference
-
[WEBCODECS] defines the following terms:
- "key"
- AudioEncoderConfig
- EncodedAudioChunk
- [[internal data]]
- [[type]]
- description
- numberOfChannels
- sampleRate
-
[WEBIDL] defines the following terms:
- EnforceRange
- unsigned long
References
Normative References
- [RFC2119]
- S. Bradner. Key words for use in RFCs to Indicate Requirement Levels. March 1997. Best Current Practice. URL: https://datatracker.ietf.org/doc/html/rfc2119
- [WEBCODECS]
- Paul Adenot; Bernard Aboba. WebCodecs. 27 April 2023. WD. URL: https://www.w3.org/TR/webcodecs/
- [WEBIDL]
- Edgar Chen; Timothy Gu. Web IDL Standard. Living Standard. URL: https://webidl.spec.whatwg.org/
Informative References
- [FLAC]
- Free Lossless Audio Codec. URL: https://datatracker.ietf.org/doc/draft-ietf-cellar-flac
- [WEBCODECS-CODEC-REGISTRY]
- Chris Cunningham; Paul Adenot; Bernard Aboba. WebCodecs Codec Registry. 10 October 2022. NOTE. URL: https://www.w3.org/TR/webcodecs-codec-registry/
IDL Index
partial dictionary AudioEncoderConfig {FlacEncoderConfig flac ; };dictionary { [
FlacEncoderConfig EnforceRange ]unsigned long blockSize = 0; [EnforceRange ]unsigned long compressLevel = 5; };