GlShaderProgram
@UnstableApi
interface GlShaderProgram
BaseGlShaderProgram |
A base implementation of |
DebugViewShaderProgram |
|
PassthroughShaderProgram |
A |
SeparableConvolutionShaderProgram |
A |
TimestampAdjustmentShaderProgram |
Changes the frame timestamps using the |
Processes frames from one OpenGL 2D texture to another.
The GlShaderProgram consumes input frames it accepts via queueInputFrame and surrenders each texture back to the caller via its listener once the texture's contents have been processed.
The GlShaderProgram produces output frames asynchronously and notifies its owner when they are available via its listener. The GlShaderProgram instance's owner must surrender the texture back to the GlShaderProgram via releaseOutputFrame when it has finished processing it.
GlShaderProgram implementations can choose to produce output frames before receiving input frames or process several input frames before producing an output frame. However,
GlShaderProgram implementations cannot assume that they will receive more than one input frame at a time, so they must process each input frame they accept even if they cannot produce output yet.
The methods in this interface must be called on the thread that owns the parent OpenGL context. If the implementation uses another OpenGL context, e.g., on another thread, it must configure it to share data with the context of thread the interface methods are called on.
Summary
Nested types |
|---|
interface GlShaderProgram.ErrorListenerListener for video frame processing errors. |
interface GlShaderProgram.InputListenerListener for input-related video frame processing events. |
interface GlShaderProgram.OutputListenerListener for output-related video frame processing events. |
Public functions |
|
|---|---|
Unit |
flush()Flushes the |
Unit |
queueInputFrame(Processes an input frame if possible. |
Unit |
release()Releases all resources. |
Unit |
releaseOutputFrame(outputTexture: GlTextureInfo!)Notifies the |
Unit |
setErrorListener(Sets the |
Unit |
setInputListener(inputListener: GlShaderProgram.InputListener!)Sets the |
Unit |
setOutputListener(outputListener: GlShaderProgram.OutputListener!)Sets the |
Unit |
Notifies the |
Public functions
flush
fun flush(): Unit
Flushes the GlShaderProgram.
The GlShaderProgram should reclaim the ownership of its allocated textures, notify its InputListener about the flush event, and report its availability if necessary.
The implementation must not output frames until after this method returns.
queueInputFrame
fun queueInputFrame(
glObjectsProvider: GlObjectsProvider!,
inputTexture: GlTextureInfo!,
presentationTimeUs: Long
): Unit
Processes an input frame if possible.
The GlShaderProgram owns the accepted frame until it calls onInputFrameProcessed. The caller should not overwrite or release the texture before the GlShaderProgram has finished processing it.
This method must only be called when the GlShaderProgram can accept an input frame.
| Parameters | |
|---|---|
glObjectsProvider: GlObjectsProvider! |
The |
inputTexture: GlTextureInfo! |
A |
presentationTimeUs: Long |
The presentation timestamp of the input frame, in microseconds. |
release
fun release(): Unit
Releases all resources.
| Throws | |
|---|---|
androidx.media3.common.VideoFrameProcessingException |
If an error occurs while releasing resources. |
releaseOutputFrame
fun releaseOutputFrame(outputTexture: GlTextureInfo!): Unit
Notifies the GlShaderProgram that the frame on the given output texture is no longer used and can be overwritten.
setErrorListener
fun setErrorListener(
executor: Executor!,
errorListener: GlShaderProgram.ErrorListener!
): Unit
Sets the ErrorListener.
The ErrorListener is invoked on the provided Executor.
setInputListener
fun setInputListener(inputListener: GlShaderProgram.InputListener!): Unit
Sets the InputListener.
The InputListener should be invoked on the thread that owns the parent OpenGL context. For example, DefaultVideoFrameProcessor invokes the InputListener methods on its internal thread.
setOutputListener
fun setOutputListener(outputListener: GlShaderProgram.OutputListener!): Unit
Sets the OutputListener.
The OutputListener should be invoked on the thread that owns the parent OpenGL context. For example, DefaultVideoFrameProcessor invokes the OutputListener methods on its internal thread.
signalEndOfCurrentInputStream
fun signalEndOfCurrentInputStream(): Unit
Notifies the GlShaderProgram that no further input frames belonging to the current input stream will be queued.
Input frames that are queued after this method is called belong to a different input stream.