DefaultGlFrameProcessor
@ExperimentalApi
class DefaultGlFrameProcessor : FrameProcessor
A FrameProcessor implementation that executes a chain of GlTextureFrameConsumers.
Summary
Nested types |
|---|
@RequiresApi(value = 26)A |
|
A builder for |
Constants |
|
|---|---|
const ColorInfo! |
An HDR color space with BT.2020 color primaries, and HLG transfer function. |
const ColorInfo! |
An HDR color space with BT.2020 color primaries, and linear transfer function. |
const ColorInfo! |
An SDR color space with BT.709 / sRGB color primaries, and linear transfer function. |
const ColorInfo! |
An SDR color space with BT.709 / sRGB color primaries, and sRGB transfer function. |
const String! |
KEY_COMPOSITION_EFFECTS = "KEY_COMPOSITION_EFFECTS"Metadata key for storing the |
const String! |
KEY_COMPOSITION_SEQUENCE_INDEX = "KEY_COMPOSITION_SEQUENCE_INDEX"Metadata key for storing the integer index to identify the source sequence in a |
const String! |
KEY_COMPOSITOR_SETTINGS = "KEY_COMPOSITOR_SETTINGS"Metadata key for storing the |
const String! |
KEY_FRAME_DISCONTINUITY_NUMBER = "KEY_FRAME_DISCONTINUITY_NUMBER"Metadata key for storing the frame discontinuity number, in |
const String! |
KEY_ITEM_EFFECTS = "KEY_ITEM_EFFECTS"Metadata key for storing the |
Public functions |
|
|---|---|
Unit |
close()Blocks until all resources are released. |
Boolean |
queue(frames: (Mutable)List<AsyncFrame!>!) |
Unit |
Notifies this processor that the current stream has ended. |
Constants
BT2020_HLG
const val BT2020_HLG: ColorInfo!
An HDR color space with BT.2020 color primaries, and HLG transfer function.
When input is PQ or Ultra HDR (JPEG_R), values are first converted to optical linear BT.2020 display light and normalized against the 1,000-nit HLG reference display peak. The resulting display light is converted to scene light via inverse HLG OOTF (system gamma 1.2) and encoded into an HLG electrical signal using the BT.2100 HLG OETF.
HLG signal cannot represent scene light above 1.0 (either from display light above the 1,000-nit reference peak or saturated primaries where inverse OOTF boosts channel values above 1.0), so scene light is scaled down to fit in [0.0, 1.0] after the inverse HLG OOTF and before the OETF; all channels are scaled equally to preserve chromaticity.
The values are always scene-referred.
BT2020_LINEAR
const val BT2020_LINEAR: ColorInfo!
An HDR color space with BT.2020 color primaries, and linear transfer function.
Values are display-referred linear optical light anchored on the ITU-R BT.2408 203-nit diffuse white reference, so 1.0 represents diffuse white, the 1,000-nit HLG reference peak evaluates to ~4.9224, and the 10,000-nit PQ peak evaluates to ~49.2242.
When input is HLG, HLG scene-referred electrical values are converted to display light using the ITU-R BT.2100 HLG EOTF (OOTF_1.2(OETF^-1(E))) and scaled onto the diffuse white anchor. When input is PQ, PQ electrical values are linearized using the SMPTE ST 2084 EOTF and scaled onto the diffuse white anchor. When input is Ultra HDR (JPEG_R), the sRGB base image is linearized to optical BT.709 display light (1.0 = 203-nit diffuse white), boosted by the gainmap up to the 1,000-nit reference peak (~4.9224), and converted to BT.2020.
BT709_LINEAR
const val BT709_LINEAR: ColorInfo!
An SDR color space with BT.709 / sRGB color primaries, and linear transfer function.
BT709_SRGB
const val BT709_SRGB: ColorInfo!
An SDR color space with BT.709 / sRGB color primaries, and sRGB transfer function.
KEY_COMPOSITION_EFFECTS
const val KEY_COMPOSITION_EFFECTS = "KEY_COMPOSITION_EFFECTS": String!
Metadata key for storing the List of video effects to apply on the composited frames, in frame metadata.
The order of effect application is KEY_ITEM_EFFECTS, KEY_COMPOSITOR_SETTINGS and then KEY_COMPOSITION_EFFECTS.
KEY_COMPOSITION_SEQUENCE_INDEX
const val KEY_COMPOSITION_SEQUENCE_INDEX = "KEY_COMPOSITION_SEQUENCE_INDEX": String!
Metadata key for storing the integer index to identify the source sequence in a
Composition from which an input frame comes, in frame metadata.
KEY_COMPOSITOR_SETTINGS
const val KEY_COMPOSITOR_SETTINGS = "KEY_COMPOSITOR_SETTINGS": String!
Metadata key for storing the VideoCompositorSettings, in frame metadata.
When using CompositionPlayer or Transformer, the value is
Composition#videoCompositorSettings.
The order of effect application is KEY_ITEM_EFFECTS, KEY_COMPOSITOR_SETTINGS and then KEY_COMPOSITION_EFFECTS.
KEY_FRAME_DISCONTINUITY_NUMBER
const val KEY_FRAME_DISCONTINUITY_NUMBER = "KEY_FRAME_DISCONTINUITY_NUMBER": String!
Metadata key for storing the frame discontinuity number, in getMetadata and getMetadata.
The number is an integer, incremented every time the player reports a discontinuity (for example, when seeking).
The number is only mandatory for previewing use cases. It is used to trigger flushes in GlShaderProgram implementations during discontinuities.
KEY_ITEM_EFFECTS
const val KEY_ITEM_EFFECTS = "KEY_ITEM_EFFECTS": String!
Metadata key for storing the List of video effects to apply on a single media item, in frame metadata.
The order of effect application is KEY_ITEM_EFFECTS, KEY_COMPOSITOR_SETTINGS and then KEY_COMPOSITION_EFFECTS.
Public functions
queue
fun queue(frames: (Mutable)List<AsyncFrame!>!): Boolean
Attempts to queue a List of frames for processing.
All frames provided in a single invocation of this method represent the exact same point in time.
If this consumer is at capacity, this method returns false and the onWakeup will be invoked when capacity becomes available.
If this method returns true, onFrameProcessed must be called once with every input frame instance queued, once the FrameProcessor has finished processing the frames.
| Parameters | |
|---|---|
frames: (Mutable)List<AsyncFrame!>! |
The frames to queue. |
| Returns | |
|---|---|
Boolean |
|
signalEndOfStream
fun signalEndOfStream(): Unit
Notifies this processor that the current stream has ended.
More frames may be queued after calling this method, if the current stream changes.