1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
|
// Copyright 2019 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
// https://github.com/WICG/web-codecs
// A VideoDecoder processes a queue of configure, decode, and flush requests.
// Requests are taken from the queue sequentially but may be processed
// concurrently.
[
Exposed=(Window,DedicatedWorker),
SecureContext,
ActiveScriptWrappable
] interface VideoDecoder : EventTarget {
// |init| includes an |output| callback for emitting VideoFrames and an
// |error| callback for emitting decode errors.
//
// When in an closed state, all methods will fail.
//
// TODO(sandersd): Consider adding a state or last error attribute.
[CallWith=ScriptState, RaisesException, MeasureAs=WebCodecsVideoDecoder] constructor(VideoDecoderInit init);
// The number of pending decode requests. This does not include requests that
// have been sent to the underlying codec.
//
// Applications can minimize underflow by enqueueing decode requests until
// |decodeQueueSize| is greater than a constant.
//
// TODO(sandersd): Consider adding a predicted output count or other
// backpressure mechanism that considers the state of the underlying codec.
// TODO(sandersd): Consider emitting an event when this number decreases.
readonly attribute unsigned long decodeQueueSize;
// Fires to signal a decrease in decodeQueueSize. Will fire at most once for a
// given turn of the event loop.
attribute EventHandler ondequeue;
// Which state the decoder is in, indicating which methods can be called.
readonly attribute CodecState state;
// Set the stream configuration for future decode() requests.
//
// The next decode request must be for a keyframe.
//
// TODO(sandersd): Move the keyframe rule into the bytestream registry.
[RaisesException] void configure(VideoDecoderConfig config);
// Request decoding of an input chunk.
//
// You must call configure() before calling decode() for the first time.
[RaisesException] void decode(EncodedVideoChunk chunk);
// Request output from all previous decode requests.
//
// Resolved after all output for earlier decode requests has been emitted.
//
// The next decode request must be for a keyframe.
//
// TODO(sandersd): Consider relaxing the keyframe requirement.
// TODO(sandersd): Indicate whether the flush() completed successfully or due
// to a reset.
[RaisesException] Promise<undefined> flush();
// Discard all pending decode requests.
//
// The next decode request must be for a keyframe.
//
// Note: It may be possible to call reset() after a flush() promise has been
// resolved but before it is fulfilled. In that case the flush() promise will
// be fulfilled successfully even though reset() was called.
[RaisesException] void reset();
// Immediately shut down the decoder and free its resources. All pending
// decode requests are aborted.
//
// Not recoverable: make a new VideoDecoder if needed.
[RaisesException] void close();
// Call prior to configure() to determine whether config will be supported.
[CallWith=ScriptState, RaisesException]
static Promise<VideoDecoderSupport> isConfigSupported(VideoDecoderConfig config);
};
|
