All Superinterfaces:: TextureSequence

public interface GLMediaPlayer
extends TextureSequence

GLMediaPlayer interface specifies a TextureSequence state machine using a multiplexed audio/video stream as it's source.

Audio maybe supported and played back internally or via an AudioSink implementation.

Audio and video streams can be selected or muted via playStream(Uri, int, int, int, int) or playStream(Uri, int, String, int, String, int, int) using the appropriate stream id's.

Camera input can be selected using the CameraInputScheme Uri.

StreamWorker Decoding Thread

Most of the stream processing is performed on the decoding thread, a.k.a. StreamWorker:

Stream initialization triggered by playStream(..) - User gets notified whether the stream has been initialized or not via attributesChanges(..).
Stream decoding - User gets notified of a new frame via newFrameAvailable(...).
Caught exceptions on the decoding thread are delivered as GLMediaPlayer.StreamExceptions.

StreamWorker generates it's own GLContext, shared with the one passed to initGL(GL). The shared GLContext allows the decoding thread to push the video frame data directly into the designated TextureSequence.TextureFrame, later returned via getNextTexture(GL) and used by the user.

StreamWorker Error Handling

Caught exceptions on StreamWorker are delivered as GLMediaPlayer.StreamExceptions, which either degrades the GLMediaPlayer.State to GLMediaPlayer.State.Uninitialized or GLMediaPlayer.State.Paused.

An occurring GLMediaPlayer.StreamException triggers a EVENT_CHANGE_ERR event, which can be listened to via GLMediaEventListener#attributesChanged(GLMediaPlayer, int, long).

An occurred GLMediaPlayer.StreamException can be read via getStreamException().

GLMediaPlayer Lifecycle

Action	`GLMediaPlayer.State` Before	`GLMediaPlayer.State` After	`Event`
`playStream(Uri, int, int, int, int)`	`Uninitialized`	`Initialized`¹, `Uninitialized`	`Init` or ( `Error` + `Uninit` )
`initGL(GL)`	`Initialized`, `Uninitialized`	`Playing`, `Uninitialized`	`Play` or ( `Error` + `Uninit` )
`pause(boolean)`	`Playing`	`Paused`	`Pause`
`resume()`	`Paused`	`Playing`	`Play`
`stop()`	`Playing`, `Paused`	`Uninitialized`	`Pause`
`seek(int)`	`Paused`, `Playing`	`Paused`, `Playing`	none
`getNextTexture(GL)`	any	same	none
`getLastTexture()`	any	same	none
`END_OF_STREAM`	`Playing`	`Paused`	`EOS` + `Pause`
`GLMediaPlayer.StreamException`	any	`Paused`, `Uninitialized`	`Error` + ( `Pause` or `Uninit` )
`destroy(GL)`	any	`Uninitialized`	`Uninit`

Audio and video Stream IDs

value	request	get
`STREAM_ID_NONE`	mute	not available
`STREAM_ID_AUTO`	auto	unspecified
≥0	specific stream	specific stream

Current implementations (check each API doc link for details):

NullGLMediaPlayer
OMXGLMediaPlayer
FFMPEGMediaPlayer
AndroidGLMediaPlayerAPI14

Implementations of this interface must implement:

    public static final boolean isAvailable();

to be properly considered by GLMediaPlayerFactory.create(ClassLoader, String) and GLMediaPlayerFactory.createDefault().

Timestamp Accuracy

Timestamp type and value range has been chosen to suit embedded CPUs and characteristics of audio and video streaming. See TimeFrameI.

Audio and video synchronization

The class follows a passive A/V synchronization pattern. Audio is being untouched, while getNextTexture(GL) delivers a new video frame only, if its timestamp is less than MAX_VIDEO_ASYNC ahead of time. If its timestamp is more than MAX_VIDEO_ASYNC ahead of time, the previous frame is returned. If its timestamp is more than MAX_VIDEO_ASYNC after time, the frame is dropped and the next frame is being fetched.

https://en.wikipedia.org/wiki/Audio_to_video_synchronization

   d_av = v_pts - a_pts;

Recommendation of audio/video pts time lead/lag at production:

Overall: +40ms and -60ms audio ahead video / audio after video
Each stage: +5ms and -15ms. audio ahead video / audio after video

Recommendation of av pts time lead/lag at presentation:

TV: +15ms and -45ms. audio ahead video / audio after video.
Film: +22ms and -22ms. audio ahead video / audio after video.

Test Streams

Nested Class Summary

Big Buck Bunny 24f 16:9
Big Buck Bunny	320p	h264	aac 48000Hz 2 chan	http://download.blender.org/peach/bigbuckbunny_movies/BigBuckBunny_320x180.mp4
Big Buck Bunny	240p	h264	aac 48000Hz 2 chan	http://archive.org/download/BigBuckBunny_328/BigBuckBunny_512kb.mp4
Big Buck Bunny	720p	mpeg4	ac3 48000Hz 5.1 chan	http://download.blender.org/peach/bigbuckbunny_movies/big_buck_bunny_720p_surround.avi
Big Buck Bunny	720p	msmpeg4v2	mp3 48000Hz 2 chan	http://download.blender.org/peach/bigbuckbunny_movies/big_buck_bunny_720p_stereo.avi
Big Buck Bunny	720p	theora	vorbis 48000Hz 2 chan	http://download.blender.org/peach/bigbuckbunny_movies/big_buck_bunny_720p_stereo.ogg
Big Buck Bunny	1080p	mpeg4	ac3 48000Hz 5.1 chan	http://download.blender.org/peach/bigbuckbunny_movies/big_buck_bunny_1080p_surround.avi
WebM/Matroska (vp8/vorbis)
Big Buck Bunny Trailer	640p	vp8	vorbis 44100Hz 1 chan	http://video.webmfiles.org/big-buck-bunny_trailer.webm
Elephants Dream	540p	vp8	vorbis 44100Hz 1 chan	http://video.webmfiles.org/elephants-dream.webm
You Tube http/rtsp
Sintel	http://www.youtube.com/watch?v=eRsGyueVLvQ			rtsp://v3.cache1.c.youtube.com/CiILENy73wIaGQn0LpXnygYbeRMYDSANFEgGUgZ2aWRlb3MM/0/0/0/video.3gp
Audio/Video Sync
Five-minute-sync-test1080p	https://www.youtube.com/watch?v=szoOsG9137U			rtsp://v7.cache8.c.youtube.com/CiILENy73wIaGQm133VvsA46sxMYDSANFEgGUgZ2aWRlb3MM/0/0/0/video.3gp
Audio-Video-Sync-Test-Calibration-23.98fps-24fps	https://www.youtube.com/watch?v=cGgf_dbDMsw
sound_in_sync_test	https://www.youtube.com/watch?v=O-zIZkhXNLE

Nested Classes
Modifier and Type	Interface	Description
`static class`	`GLMediaPlayer.Chapter`	Chapter meta-data of stream, see `getChapters()`.
`static class`	`GLMediaPlayer.EventMask`	Changes attributes event mask
`static interface`	`GLMediaPlayer.GLMediaEventListener`	As the contract of `GLMediaPlayer.GLMediaFrameListener` and `TextureSequence.TexSeqEventListener` requests, implementations of `GLMediaPlayer.GLMediaEventListener` shall: off-load complex or `GLMediaPlayer` commands on another thread, or simply changing a volatile state of their `GLEventListener` implementation.
`static interface`	`GLMediaPlayer.GLMediaFrameListener`
`static class`	`GLMediaPlayer.State`	See Lifecycle.
`static class`	`GLMediaPlayer.StreamException`	A StreamException encapsulates a caught exception in the decoder thread, a.k.a StreamWorker, see See StreamWorker Error Handling.

Nested classes/interfaces inherited from interface com.jogamp.opengl.util.texture.TextureSequence
TextureSequence.TexSeqEventListener<T extends TextureSequence>, TextureSequence.TextureFrame

Field Summary

Fields
Modifier and Type	Field	Description
`static Uri.Encoded`	`CameraInputScheme`	`Uri scheme` name for camera input.
`static String`	`CameraPropHeight`	Camera property "height".
`static String`	`CameraPropRate`	Camera property "rate".
`static String`	`CameraPropSizeS`	Camera property "size", size as string, e.g.
`static String`	`CameraPropWidth`	Camera property "width".
`static boolean`	`DEBUG`
`static boolean`	`DEBUG_AVSYNC`
`static boolean`	`DEBUG_NATIVE`
`static int`	`MAX_VIDEO_ASYNC`	Maximum video frame async of 22 milliseconds.
`static int`	`MIN_VIDEO_ASYNC`
`static int`	`STREAM_ID_AUTO`	Constant -1 for auto or unspecified.
`static int`	`STREAM_ID_NONE`	Constant -2 for mute or not available.
`static int`	`TEXTURE_COUNT_DEFAULT`	Default texture count, value 3.
`static int`	`TEXTURE_COUNT_MIN`	Minimum texture count, value 1.

Fields inherited from interface com.jogamp.opengl.util.texture.TextureSequence
sampler2D, samplerExternalOES

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`void`	`addEventListener(GLMediaPlayer.GLMediaEventListener l)`	Adds a `GLMediaPlayer.GLMediaEventListener` to this player.
`void`	`addFrameListener(GLMediaPlayer.GLMediaFrameListener l)`	Adds a `GLMediaPlayer.GLMediaFrameListener` to this player.
`Object`	`attachObject(String name, Object obj)`	Attaches the user object for the given name.
`GLMediaPlayer.State`	`destroy(GL gl)`	Releases the GL, stream and other resources, including `attached user objects`.
`Object`	`detachObject(String name)`	Detaches the user object for the given name.
`int`	`getAID()`	Return the audio stream id, see audio and video Stream IDs.
`String[]`	`getALangs()`	Return an array of detected audio stream language codes, matching `getAStreams()` array and its indices.
`com.jogamp.math.Vec4f`	`getARatioLetterboxBackColor()`	Returns `TextureSequence.useARatioLetterbox()` background color for added letter-box space, defaults to transparent zero.
`int[]`	`getAStreams()`	Return an array of detected audio stream IDs.
`Object`	`getAttachedObject(String name)`	Returns the attached user object for the given name.
`int`	`getAudioBitrate()`	Warning: Optional information, may not be supported by implementation.
`String`	`getAudioCodec()`	Warning: Optional information, may not be supported by implementation.
`CodecID`	`getAudioCodecID()`	Warning: Optional information, may not be supported by implementation.
`int`	`getAudioFrames()`	Warning: Optional information, may not be supported by implementation.
`int`	`getAudioPTS()`	Returns current audio presentation timestamp (PTS) in milliseconds, try using `getPTS()`.
`AudioSink`	`getAudioSink()`	If implementation uses a `AudioSink`, it's instance will be returned.
`float`	`getAudioVolume()`	Returns the audio volume.
`GLMediaPlayer.Chapter`	`getChapter(int msec)`	Returns `GLMediaPlayer.Chapter` covering given time position in milliseconds or null if none covers given time
`GLMediaPlayer.Chapter[]`	`getChapters()`	Returns `GLMediaPlayer.Chapter` meta-data from stream, available after `GLMediaPlayer.State.Initialized` is reached after issuing `playStream(Uri, int, int, int, int)`.
`int`	`getDecodedFrameCount()`
`int`	`getDuration()`	Return total duration of stream in msec.
`GLMediaPlayer.GLMediaEventListener[]`	`getEventListeners()`	Return all `GLMediaPlayer.GLMediaEventListener` of this player.
`GLMediaPlayer.GLMediaFrameListener[]`	`getFrameListeners()`	Return all `GLMediaPlayer.GLMediaFrameListener` of this player.
`float`	`getFramerate()`	Warning: Optional information, may not be supported by implementation.
`int`	`getHeight()`	Returns the height of the video.
`String`	`getLang(int id)`	Return the matching language code of given stream ID, matching one of the stream IDs in `getVStreams()`, `getAStreams()` or `getSStreams()`.
`TextureSequence.TextureFrame`	`getLastTexture()`	Returns the last updated texture.
`int`	`getNextAID()`	Returns the next audio stream id, rotates.
`int`	`getNextSID()`	Returns the next subtitle stream id, rotates including no-stream
`TextureSequence.TextureFrame`	`getNextTexture(GL gl)`	Returns the next texture to be rendered.
`int`	`getNextVID()`	Returns the next video stream id, rotates.
`String`	`getPerfString()`	Returns a string representation of this player's performance values.
`float`	`getPlaySpeed()`	Returns the playback speed.
`int`	`getPresentedFrameCount()`
`PTS`	`getPTS()`	Returns current System Clock Reference (SCR) presentation timestamp (`PTS`).
`int`	`getSID()`	Return the subtitle stream id, see audio and video Stream IDs.
`String[]`	`getSLangs()`	Return an array of detected subtitle stream language codes, matching `getSStreams()` array and its indices.
`int[]`	`getSStreams()`	Return an array of detected subtitle stream IDs.
`GLMediaPlayer.State`	`getState()`	See Lifecycle.
`long`	`getStreamBitrate()`	Warning: Optional information, may not be supported by implementation.
`GLMediaPlayer.StreamException`	`getStreamException()`	Returns the `GLMediaPlayer.StreamException` caught in the decoder thread, or `null` if none occured.
`String`	`getSubtitleCodec()`	Warning: Optional information, may not be supported by implementation.
`CodecID`	`getSubtitleCodecID()`	Warning: Optional information, may not be supported by implementation.
`SubtitleEventListener`	`getSubtitleEventListener()`	Returns the `setSubtitleEventListener(SubtitleEventListener)` of this player.
`int`	`getTextureCount()`
`String`	`getTitle()`	Returns title meta-data from stream, available after `GLMediaPlayer.State.Initialized` is reached after issuing `playStream(Uri, int, int, int, int)`.
`Uri`	`getUri()`	Return the stream location, as set by `playStream(Uri, int, int, int, int)`.
`int`	`getVID()`	Return the video stream id, see audio and video Stream IDs.
`int`	`getVideoBitrate()`	Warning: Optional information, may not be supported by implementation.
`String`	`getVideoCodec()`	Warning: Optional information, may not be supported by implementation.
`CodecID`	`getVideoCodecID()`	Warning: Optional information, may not be supported by implementation.
`int`	`getVideoFrames()`	Warning: Optional information, may not be supported by implementation.
`int`	`getVideoPTS()`	Returns current video presentation timestamp (PTS) in milliseconds of `getLastTexture()`, try using `getPTS()`.
`String[]`	`getVLangs()`	Return an array of detected video stream language codes, matching `getVStreams()` array and its indices.
`int[]`	`getVStreams()`	Return an array of detected video stream IDs.
`int`	`getWidth()`	Returns the width of the video.
`boolean`	`hasStreamID(int id)`	Return whether the given stream ID is available, i.e.
`void`	`initGL(GL gl)`	Initializes OpenGL related resources.
`boolean`	`isAudioMuted()`	Returns true if audio is muted, i.e.
`boolean`	`isGLOriented()`	Returns `true` if the video frame is oriented in OpenGL's coordinate system, origin at bottom left.
`GLMediaPlayer.State`	`pause(boolean flush)`	Pauses the StreamWorker decoding thread.
`void`	`playStream(Uri streamLoc, int vid, int aid, int sid, int textureCount)`	Issues asynchronous stream initialization.
`void`	`playStream(Uri streamLoc, int vid, String alang, int aid, String slang, int sid, int reqTextureCount)`	Same as `playStream(Uri, int, int, int, int)`, but providing desired audio- and subtile languages to be selected.
`void`	`printNativeInfo(PrintStream out)`	Print native library information of used implementation to given out PrintStream.
`void`	`removeEventListener(GLMediaPlayer.GLMediaEventListener l)`	Removes a `GLMediaPlayer.GLMediaEventListener` to this player.
`void`	`removeFrameListener(GLMediaPlayer.GLMediaFrameListener l)`	Removes a `GLMediaPlayer.GLMediaFrameListener` to this player.
`GLMediaPlayer.State`	`resume()`	Starts or resumes the StreamWorker decoding thread.
`int`	`seek(int msec)`	Seeks to the new absolute position.
`void`	`setARatioAdjustment(boolean v)`	Toggles `TextureSequence.useARatioLetterbox()`.
`void`	`setARatioLetterbox(boolean v, com.jogamp.math.Vec4f backColor)`	Toggles `TextureSequence.useARatioLetterbox()`.
`void`	`setAudioChannelLimit(int cc)`	Limit maximum supported audio channels by user.
`boolean`	`setAudioVolume(float v)`	Sets the audio volume, [0f..1f].
`boolean`	`setPlaySpeed(float rate)`	Sets the playback speed.
`void`	`setSubtitleEventListener(SubtitleEventListener l)`	Sets the `SubtitleEventListener` for this player.
`void`	`setTextureMinMagFilter(int[] minMagFilter)`	Sets the texture min-mag filter, defaults to `GL.GL_NEAREST`.
`void`	`setTextureUnit(int u)`	Sets the texture unit.
`void`	`setTextureWrapST(int[] wrapST)`	Sets the texture min-mag filter, defaults to `GL.GL_CLAMP_TO_EDGE`.
`GLMediaPlayer.State`	`stop()`	Stops streaming and releases the GL, stream and other resources, but keeps `attached user objects`.
`void`	`switchStream(int vid, int aid, int sid)`	Switches current `playStream(Uri, int, int, int, int)` to given stream IDs and continues at same `getVideoPTS()`.
`String`	`toString()`	Returns a string representation of this player, incl.
`boolean`	`useARatioAdjustment()`	Returning `true` indicates texture correction for aspect-ratio in the shader.
`boolean`	`useARatioLetterbox()`	Returns whether `TextureSequence.useARatioAdjustment()` shall add letter-box space to match aspect-ratio, otherwise it will be zoomed in.

Methods inherited from interface com.jogamp.opengl.util.texture.TextureSequence
getRequiredExtensionsShaderStub, getTextureFragmentShaderHashCode, getTextureFragmentShaderHashID, getTextureLookupFragmentShaderImpl, getTextureLookupFunctionName, getTextureMinMagFilter, getTextureSampler2DType, getTextureTarget, getTextureUnit, getTextureWrapST, isTextureAvailable, setTextureLookupFunctionName

- Field Detail
  - DEBUG
```
static final boolean DEBUG
```
  - DEBUG_AVSYNC
```
static final boolean DEBUG_AVSYNC
```
  - DEBUG_NATIVE
```
static final boolean DEBUG_NATIVE
```
  - TEXTURE_COUNT_DEFAULT
```
static final int TEXTURE_COUNT_DEFAULT
```
    Default texture count, value 3.
    
    See Also:
    
    Constant Field Values
  - TEXTURE_COUNT_MIN
```
static final int TEXTURE_COUNT_MIN
```
    Minimum texture count, value 1. Using the minimum texture count disables multi-threaded decoding.
    
    See Also:
    
    Constant Field Values
  - STREAM_ID_NONE
```
static final int STREAM_ID_NONE
```
    Constant -2 for mute or not available. See Audio and video Stream IDs.
    
    See Also:
    
    Constant Field Values
  - STREAM_ID_AUTO
```
static final int STREAM_ID_AUTO
```
    Constant -1 for auto or unspecified. See Audio and video Stream IDs.
    
    See Also:
    
    Constant Field Values
  - CameraInputScheme
```
static final Uri.Encoded CameraInputScheme
```
    Uri scheme name for camera input. E.g. camera:/0 for the 1st camera device.
    The Uri path is being used to identify the camera (<id>), where the root fwd-slash is being cut-off.
    
    The <id> is usually an integer value indexing the camera ranging from [0..max-number].
    
    The <somewhere> is usually empty, since it would imply a networking camera protocol.
    
    The Uri query is used to pass options to the camera using ; as the separator. The latter avoids trouble w/ escaping.
    
    camera:/<id> camera:/<id>?width=640;height=480;rate=15 camera:/<id>?size=640x480;rate=15 camera://<somewhere>/<id> camera://<somewhere>/<id>?width=640;height=480;rate=15 camera://<somewhere>/<id>?size=640x480;rate=15 camera:///<id>?width=640;height=480;rate=15 camera:///<id>?size=640x480;rate=15
    
    Uri: [scheme:][//authority][path][?query][#fragment] w/ authority: [user-info@]host[:port] Note: 'path' starts w/ fwd slash
  - CameraPropSizeS
```
static final String CameraPropSizeS
```
    Camera property "size", size as string, e.g. 1280x720, hd720. May not be supported on all platforms. See CameraInputScheme.
    
    See Also:
    
    Constant Field Values
  - CameraPropWidth
```
static final String CameraPropWidth
```
    Camera property "width". See CameraInputScheme.
    
    See Also:
    
    Constant Field Values
  - CameraPropHeight
```
static final String CameraPropHeight
```
    Camera property "height". See CameraInputScheme.
    
    See Also:
    
    Constant Field Values
  - CameraPropRate
```
static final String CameraPropRate
```
    Camera property "rate". See CameraInputScheme.
    
    See Also:
    
    Constant Field Values
  - MAX_VIDEO_ASYNC
```
static final int MAX_VIDEO_ASYNC
```
    Maximum video frame async of 22 milliseconds.
    
    See Also:
    
    Constant Field Values
  - MIN_VIDEO_ASYNC
```
static final int MIN_VIDEO_ASYNC
```
    See Also:
    
    Constant Field Values
- Method Detail
  - printNativeInfo
```
void printNativeInfo(PrintStream out)
```
    Print native library information of used implementation to given out PrintStream.
  - getTextureCount
```
int getTextureCount()
```
  - setTextureUnit
```
void setTextureUnit(int u)
```
    Sets the texture unit. Defaults to 0.
  - setTextureMinMagFilter
```
void setTextureMinMagFilter(int[] minMagFilter)
```
    Sets the texture min-mag filter, defaults to GL.GL_NEAREST.
  - setTextureWrapST
```
void setTextureWrapST(int[] wrapST)
```
    Sets the texture min-mag filter, defaults to GL.GL_CLAMP_TO_EDGE.
  - useARatioAdjustment
```
boolean useARatioAdjustment()
```
    Returning true indicates texture correction for aspect-ratio in the shader. Graph's Region shader will utilize TextureSequence.setTexCoordBBox(Texture, AABBox, boolean, float[], boolean) for texture-coordinate bounding-box calculation.
    Returning false indicates no correction for aspect-ratio in the shader. Graph's Region shader will utilize TextureSequence.setTexCoordBBoxSimple(Texture, AABBox, float[], boolean) for texture-coordinate bounding-box calculation.
    
    Default value is implementation specific and toggling is optional.
    
    Defaults to true and toggling not supported.
    
    Specified by:
    
    useARatioAdjustment in interface TextureSequence
    
    See Also:
    
    TextureSequence.setTexCoordBBox(Texture, AABBox, boolean, float[], boolean), TextureSequence.setTexCoordBBoxSimple(Texture, AABBox, float[], boolean), TextureSequence.useARatioLetterbox()
  - setARatioAdjustment
```
void setARatioAdjustment(boolean v)
```
    Toggles TextureSequence.useARatioLetterbox().
    Default value is implementation specific and toggling is optional.
    
    Defaults to true and toggling is not supported.
    
    Specified by:
    
    setARatioAdjustment in interface TextureSequence
    
    See Also:
    
    TextureSequence.useARatioLetterbox(), TextureSequence.useARatioAdjustment()
  - useARatioLetterbox
```
boolean useARatioLetterbox()
```
    Returns whether TextureSequence.useARatioAdjustment() shall add letter-box space to match aspect-ratio, otherwise it will be zoomed in.
    Default value is implementation specific and toggling is optional.
    
    Defaults to false and toggling is supported via setARatioLetterbox(boolean, Vec4f)
    
    Specified by:
    
    useARatioLetterbox in interface TextureSequence
    
    See Also:
    
    TextureSequence.useARatioAdjustment(), TextureSequence.setARatioLetterbox(boolean, Vec4f)
  - getARatioLetterboxBackColor
```
com.jogamp.math.Vec4f getARatioLetterboxBackColor()
```
    Returns TextureSequence.useARatioLetterbox() background color for added letter-box space, defaults to transparent zero.
    
    Specified by:
    
    getARatioLetterboxBackColor in interface TextureSequence
  - setARatioLetterbox
```
void setARatioLetterbox(boolean v,
                        com.jogamp.math.Vec4f backColor)
```
    Toggles TextureSequence.useARatioLetterbox().
    Default value is implementation specific and toggling is optional.
    
    Impacts only if TextureSequence.useARatioAdjustment() returns true.
    
    Defaults to false.
    
    Specified by:
    
    setARatioLetterbox in interface TextureSequence
    
    Parameters:
    
    v - new value for TextureSequence.useARatioLetterbox()
    
    backColor - optional background color for added letter-box space, defaults to transparent zero
    
    See Also:
    
    TextureSequence.useARatioLetterbox(), TextureSequence.useARatioAdjustment()
  - setAudioChannelLimit
```
void setAudioChannelLimit(int cc)
```
    Limit maximum supported audio channels by user.
    Must be set before playStream(Uri, int, int, int, int)
    
    May be utilized to enforce 1 channel (mono) downsampling in combination with JOAL/OpenAL to experience spatial 3D position effects.
    
    Parameters:
    
    cc - maximum supported audio channels, will be clipped [1..x], with x being the underlying audio subsystem's maximum
    
    See Also:
    
    playStream(Uri, int, int, int, int)
  - playStream
```
void playStream(Uri streamLoc,
                int vid,
                int aid,
                int sid,
                int textureCount)
         throws IllegalStateException,
                IllegalArgumentException
```
    Issues asynchronous stream initialization.
    Lifecycle: GLMediaPlayer.State.Uninitialized -> GLMediaPlayer.State.Initialized¹ or GLMediaPlayer.State.Uninitialized
    
    GLMediaPlayer.State.Initialized is reached asynchronous, i.e. user gets notified via attributesChanges(..).
    
    A possible caught asynchronous GLMediaPlayer.StreamException while initializing the stream off-thread will be thrown at initGL(GL).
    
    Muted audio can be achieved by passing STREAM_ID_NONE to aid.
    
    Muted video can be achieved by passing STREAM_ID_NONE to vid, in which case textureCount is ignored as well as the passed GL object of the subsequent initGL(GL) call.
    
    Parameters:
    
    streamLoc - the stream location
    
    vid - video stream id, see audio and video Stream IDs
    
    aid - audio stream id, see audio and video Stream IDs
    
    sid - subtitle stream id, see audio and video Stream IDs
    
    textureCount - desired number of buffered textures to be decoded off-thread, will be validated by implementation. The minimum value is TEXTURE_COUNT_MIN (single-threaded) or above to enable multi-threaded stream decoding. Default is TEXTURE_COUNT_DEFAULT. Value is ignored if video is muted.
    
    Throws:
    
    IllegalStateException - if not invoked in GLMediaPlayer.State.Uninitialized
    
    IllegalArgumentException - if arguments are invalid
    
    Since:
    
    2.6.0
    
    See Also:
    
    playStream(Uri, int, String, int, String, int, int)
  - playStream
```
void playStream(Uri streamLoc,
                int vid,
                String alang,
                int aid,
                String slang,
                int sid,
                int reqTextureCount)
         throws IllegalStateException,
                IllegalArgumentException
```
    Same as playStream(Uri, int, int, int, int), but providing desired audio- and subtile languages to be selected.
    
    Parameters:
    
    streamLoc - the stream location
    
    vid - video stream id, see audio and video Stream IDs
    
    alang - desired audio language, pass null to use aid
    
    aid - fallback audio stream id in case alang is null, see audio and video Stream IDs
    
    slang - desired subtitle language, pass null to use sid
    
    sid - fallback subtitle stream id in case alang is null, see audio and video Stream IDs
    
    textureCount - desired number of buffered textures to be decoded off-thread, will be validated by implementation. The minimum value is TEXTURE_COUNT_MIN (single-threaded) or above to enable multi-threaded stream decoding. Default is TEXTURE_COUNT_DEFAULT. Value is ignored if video is muted.
    
    Throws:
    
    IllegalStateException - if not invoked in GLMediaPlayer.State.Uninitialized
    
    IllegalArgumentException - if arguments are invalid
    
    Since:
    
    2.6.0
    
    See Also:
    
    playStream(Uri, int, int, int, int)
  - switchStream
```
void switchStream(int vid,
                  int aid,
                  int sid)
           throws IllegalStateException,
                  IllegalArgumentException
```
    Switches current playStream(Uri, int, int, int, int) to given stream IDs and continues at same getVideoPTS().
    Implementation just issues stop(), seek(int) and playStream(Uri, int, int, int, int).
    
    Parameters:
    
    vid - video stream id, see audio and video Stream IDs
    
    aid - audio stream id, see audio and video Stream IDs
    
    sid - subtitle stream id, see audio and video Stream IDs
    
    Throws:
    
    IllegalStateException
    
    IllegalArgumentException
    
    Since:
    
    2.6.0
  - getStreamException
```
GLMediaPlayer.StreamException getStreamException()
```
    Returns the GLMediaPlayer.StreamException caught in the decoder thread, or null if none occured.
    Method clears the cached GLMediaPlayer.StreamException, hence an immediate subsequent call will return null.
    
    See Also:
    
    GLMediaEventListener#EVENT_CHANGE_ERR, GLMediaPlayer.StreamException
  - initGL
```
void initGL(GL gl)
     throws IllegalStateException,
            GLMediaPlayer.StreamException,
            GLException
```
    Initializes OpenGL related resources.
    Lifecycle: GLMediaPlayer.State.Initialized -> GLMediaPlayer.State.Paused or GLMediaPlayer.State.Initialized
    Argument gl is ignored if video is muted, see playStream(Uri, int, int, int, int).
    
    Parameters:
    
    gl - current GL object. Maybe null, for audio only.
    
    Throws:
    
    IllegalStateException - if not invoked in GLMediaPlayer.State.Initialized.
    
    GLMediaPlayer.StreamException - forwarded from the off-thread stream initialization
    
    GLException - in case of difficulties to initialize the GL resources
  - getAudioSink
```
AudioSink getAudioSink()
```
    If implementation uses a AudioSink, it's instance will be returned.
    The AudioSink instance is available after playStream(Uri, int, int, int, int), if used by implementation.
  - destroy
```
GLMediaPlayer.State destroy(GL gl)
```
    Releases the GL, stream and other resources, including attached user objects.
    Lifecycle: ANY -> GLMediaPlayer.State.Uninitialized
  - stop
```
GLMediaPlayer.State stop()
```
    Stops streaming and releases the GL, stream and other resources, but keeps attached user objects.
    Lifecycle: ANY -> GLMediaPlayer.State.Uninitialized
  - setPlaySpeed
```
boolean setPlaySpeed(float rate)
```
    Sets the playback speed.
    To simplify test, play speed is normalized, i.e.
    
    1.0f: if Math.abs(1.0f - rate) < 0.01f
    Returns:
    
    true if successful, otherwise false, i.e. due to unsupported value range of implementation.
  - getPlaySpeed
```
float getPlaySpeed()
```
    Returns the playback speed.
  - setAudioVolume
```
boolean setAudioVolume(float v)
```
    Sets the audio volume, [0f..1f].
    To simplify test, volume is normalized, i.e.
    
    0.0f: if Math.abs(v) < 0.01f
    
    1.0f: if Math.abs(1.0f - v) < 0.01f
    Returns:
    
    true if successful, otherwise false, i.e. due to unsupported value range of implementation.
  - getAudioVolume
```
float getAudioVolume()
```
    Returns the audio volume.
  - isAudioMuted
```
boolean isAudioMuted()
```
    Returns true if audio is muted, i.e. setAudioVolume(float) to zero.
  - resume
```
GLMediaPlayer.State resume()
```
    Starts or resumes the StreamWorker decoding thread.
    Lifecycle: GLMediaPlayer.State.Paused -> GLMediaPlayer.State.Playing
  - pause
```
GLMediaPlayer.State pause(boolean flush)
```
    Pauses the StreamWorker decoding thread.
    Lifecycle: GLMediaPlayer.State.Playing -> GLMediaPlayer.State.Paused
    
    If a new frame is desired after the next resume() call, e.g. to make a snapshot of a camera input stream, flush shall be set to true.
    
    Parameters:
    
    flush - if true flushes the video and audio buffers, otherwise keep them intact.
  - seek
```
int seek(int msec)
```
    Seeks to the new absolute position. The StreamWorker decoding thread is paused while doing so and the A/V buffers are flushed.
    Allowed in state GLMediaPlayer.State.Playing and GLMediaPlayer.State.Paused, otherwise ignored, see Lifecycle.
    
    Parameters:
    
    msec - absolute desired time position in milliseconds
    
    Returns:
    
    time current position in milliseconds, after seeking to the desired position
  - getState
```
GLMediaPlayer.State getState()
```
    See Lifecycle.
    
    Returns:
    
    the current state, either GLMediaPlayer.State.Uninitialized, GLMediaPlayer.State.Initialized, GLMediaPlayer.State.Playing or GLMediaPlayer.State.Paused
  - getVStreams
```
int[] getVStreams()
```
    Return an array of detected video stream IDs.
  - getVLangs
```
String[] getVLangs()
```
    Return an array of detected video stream language codes, matching getVStreams() array and its indices.
    The language code is supposed to be 3-letters of `ISO 639-2 language codes`.
    
    See Also:
    
    getLang(int)
  - getVID
```
int getVID()
```
    Return the video stream id, see audio and video Stream IDs.
  - getNextVID
```
int getNextVID()
```
    Returns the next video stream id, rotates.
  - getAStreams
```
int[] getAStreams()
```
    Return an array of detected audio stream IDs.
  - getALangs
```
String[] getALangs()
```
    Return an array of detected audio stream language codes, matching getAStreams() array and its indices.
    The language code is supposed to be 3-letters of `ISO 639-2 language codes`.
    
    See Also:
    
    getLang(int)
  - getAID
```
int getAID()
```
    Return the audio stream id, see audio and video Stream IDs.
  - getNextAID
```
int getNextAID()
```
    Returns the next audio stream id, rotates.
  - getSStreams
```
int[] getSStreams()
```
    Return an array of detected subtitle stream IDs.
  - getSLangs
```
String[] getSLangs()
```
    Return an array of detected subtitle stream language codes, matching getSStreams() array and its indices.
    The language code is supposed to be 3-letters of `ISO 639-2 language codes`.
    
    See Also:
    
    getLang(int)
  - getSID
```
int getSID()
```
    Return the subtitle stream id, see audio and video Stream IDs.
  - getNextSID
```
int getNextSID()
```
    Returns the next subtitle stream id, rotates including no-stream
  - hasStreamID
```
boolean hasStreamID(int id)
```
    Return whether the given stream ID is available, i.e. matching one of the stream IDs in getVStreams(), getAStreams() or getSStreams().
  - getLang
```
String getLang(int id)
```
    Return the matching language code of given stream ID, matching one of the stream IDs in getVStreams(), getAStreams() or getSStreams().
    The language code is supposed to be 3-letters of `ISO 639-2 language codes`.
    
    If the stream ID is not available, und is returned
    
    See Also:
    
    getVStreams(), getAStreams(), getSStreams(), getVLangs(), getALangs(), getSLangs()
  - getDecodedFrameCount
```
int getDecodedFrameCount()
```
    Returns:
    
    the current decoded video frame count since resume() and seek(int) as increased by getNextTexture(GL) or the decoding thread.
  - getPresentedFrameCount
```
int getPresentedFrameCount()
```
    Returns:
    
    the current presented video frame count since resume() and seek(int) as increased by getNextTexture(GL) for new frames.
  - getPTS
```
PTS getPTS()
```
    Returns current System Clock Reference (SCR) presentation timestamp (PTS).
    To retrieve the current interpolated PTS against the stored System Clock Reference (SCR), use:
    int pts = mPlayer.getPTS().get(Clock.currentMillis());
  - getVideoPTS
```
int getVideoPTS()
```
    Returns current video presentation timestamp (PTS) in milliseconds of getLastTexture(), try using getPTS().
    The relative millisecond PTS since start of the presentation stored in integer covers a time span of 2'147'483'647 ms (see Integer.MAX_VALUE or 2'147'483 seconds or 24.855 days.
    
    See Also:
    
    getPTS()
  - getAudioPTS
```
int getAudioPTS()
```
    Returns current audio presentation timestamp (PTS) in milliseconds, try using getPTS().
    The relative millisecond PTS since start of the presentation stored in integer covers a time span of 2'147'483'647 ms (see Integer.MAX_VALUE or 2'147'483 seconds or 24.855 days.
    
    See Also:
    
    getPTS()
  - getLastTexture
```
TextureSequence.TextureFrame getLastTexture()
                                     throws IllegalStateException
```
    Returns the last updated texture.
    In case the instance is just initialized, it shall return a TextureFrame object with valid attributes. The texture content may be undefined until the first call of TextureSequence.getNextTexture(GL).
    
    Not blocking.
    Returns the last decoded Video TextureSequence.TextureFrame.
    
    See audio and video synchronization.
    
    Specified by:
    
    getLastTexture in interface TextureSequence
    
    Throws:
    
    IllegalStateException - if not invoked in GLMediaPlayer.State.Paused or GLMediaPlayer.State.Playing
  - getNextTexture
```
TextureSequence.TextureFrame getNextTexture(GL gl)
                                     throws IllegalStateException
```
    Returns the next texture to be rendered.
    Implementation shall return the next frame if available, may block if a next frame may arrive soon. Otherwise implementation shall return the last frame.
    
    Shall return null in case no next or last frame is available.
    
    Returns the next Video TextureSequence.TextureFrame to be rendered in sync with getPTS() and keeps decoding going.
    
    In case the current state is not GLMediaPlayer.State.Playing, getLastTexture() is returned.
    
    See audio and video synchronization.
    
    Specified by:
    
    getNextTexture in interface TextureSequence
    
    Throws:
    
    IllegalStateException - if not invoked in GLMediaPlayer.State.Paused or GLMediaPlayer.State.Playing
    
    See Also:
    
    addEventListener(GLMediaEventListener), GLMediaEventListener#newFrameAvailable(GLMediaPlayer, TextureFrame, long)
  - getUri
```
Uri getUri()
```
    Return the stream location, as set by playStream(Uri, int, int, int, int).
    
    Since:
    
    2.3.0
  - getVideoCodecID
```
CodecID getVideoCodecID()
```
    Warning: Optional information, may not be supported by implementation.
    
    Returns:
    
    the CodecID of the video stream, if available
  - getVideoCodec
```
String getVideoCodec()
```
    Warning: Optional information, may not be supported by implementation.
    
    Returns:
    
    the codec of the video stream, if available
  - getAudioCodecID
```
CodecID getAudioCodecID()
```
    Warning: Optional information, may not be supported by implementation.
    
    Returns:
    
    the CodecID of the audio stream, if available
  - getAudioCodec
```
String getAudioCodec()
```
    Warning: Optional information, may not be supported by implementation.
    
    Returns:
    
    the codec of the audio stream, if available
  - getSubtitleCodecID
```
CodecID getSubtitleCodecID()
```
    Warning: Optional information, may not be supported by implementation.
    
    Returns:
    
    the CodecID of the subtitle stream, if available
  - getSubtitleCodec
```
String getSubtitleCodec()
```
    Warning: Optional information, may not be supported by implementation.
    
    Returns:
    
    the codec of the subtitle stream, if available
  - getVideoFrames
```
int getVideoFrames()
```
    Warning: Optional information, may not be supported by implementation.
    
    Returns:
    
    the total number of video frames
  - getAudioFrames
```
int getAudioFrames()
```
    Warning: Optional information, may not be supported by implementation.
    
    Returns:
    
    the total number of audio frames
  - getDuration
```
int getDuration()
```
    Return total duration of stream in msec.
    The duration stored in integer covers 2'147'483'647 ms (see Integer.MAX_VALUE or 2'147'483 seconds or 24.855 days.
  - getStreamBitrate
```
long getStreamBitrate()
```
    Warning: Optional information, may not be supported by implementation.
    
    Returns:
    
    the overall bitrate of the stream.
  - getVideoBitrate
```
int getVideoBitrate()
```
    Warning: Optional information, may not be supported by implementation.
    
    Returns:
    
    video bitrate
  - getAudioBitrate
```
int getAudioBitrate()
```
    Warning: Optional information, may not be supported by implementation.
    
    Returns:
    
    the audio bitrate
  - getFramerate
```
float getFramerate()
```
    Warning: Optional information, may not be supported by implementation.
    
    Returns:
    
    the framerate of the video
  - isGLOriented
```
boolean isGLOriented()
```
    Returns true if the video frame is oriented in OpenGL's coordinate system, origin at bottom left.
    Otherwise returns false, i.e. video frame is oriented origin at top left.
    
    false is the default assumption for videos, but user shall not rely on.
    
    false GL orientation leads to Texture.getMustFlipVertically() == true, as reflected by all TextureSequence.TextureFrame's Textures retrieved via getLastTexture() or getNextTexture(GL).
  - getWidth
```
int getWidth()
```
    Returns the width of the video.
  - getHeight
```
int getHeight()
```
    Returns the height of the video.
  - getTitle
```
String getTitle()
```
    Returns title meta-data from stream, available after GLMediaPlayer.State.Initialized is reached after issuing playStream(Uri, int, int, int, int).
    In case no title meta-data is being used, the getUri() basename w/o suffix is being returned.
  - getChapters
```
GLMediaPlayer.Chapter[] getChapters()
```
    Returns GLMediaPlayer.Chapter meta-data from stream, available after GLMediaPlayer.State.Initialized is reached after issuing playStream(Uri, int, int, int, int).
  - getChapter
```
GLMediaPlayer.Chapter getChapter(int msec)
```
    Returns GLMediaPlayer.Chapter covering given time position in milliseconds or null if none covers given time
    
    Parameters:
    
    msec - desired chapter covering time position in milliseconds
  - toString
```
String toString()
```
    Returns a string representation of this player, incl. state and audio/video details.
    
    Overrides:
    
    toString in class Object
  - getPerfString
```
String getPerfString()
```
    Returns a string representation of this player's performance values.
  - addEventListener
```
void addEventListener(GLMediaPlayer.GLMediaEventListener l)
```
    Adds a GLMediaPlayer.GLMediaEventListener to this player.
  - removeEventListener
```
void removeEventListener(GLMediaPlayer.GLMediaEventListener l)
```
    Removes a GLMediaPlayer.GLMediaEventListener to this player.
  - getEventListeners
```
GLMediaPlayer.GLMediaEventListener[] getEventListeners()
```
    Return all GLMediaPlayer.GLMediaEventListener of this player.
  - addFrameListener
```
void addFrameListener(GLMediaPlayer.GLMediaFrameListener l)
```
    Adds a GLMediaPlayer.GLMediaFrameListener to this player.
  - removeFrameListener
```
void removeFrameListener(GLMediaPlayer.GLMediaFrameListener l)
```
    Removes a GLMediaPlayer.GLMediaFrameListener to this player.
  - getFrameListeners
```
GLMediaPlayer.GLMediaFrameListener[] getFrameListeners()
```
    Return all GLMediaPlayer.GLMediaFrameListener of this player.
  - setSubtitleEventListener
```
void setSubtitleEventListener(SubtitleEventListener l)
```
    Sets the SubtitleEventListener for this player.
  - getSubtitleEventListener
```
SubtitleEventListener getSubtitleEventListener()
```
    Returns the setSubtitleEventListener(SubtitleEventListener) of this player.
  - getAttachedObject
```
Object getAttachedObject(String name)
```
    Returns the attached user object for the given name.
  - attachObject
```
Object attachObject(String name,
                    Object obj)
```
    Attaches the user object for the given name. Returns the previously set object, may be null.
  - detachObject
```
Object detachObject(String name)
```
    Detaches the user object for the given name. Returns the previously set object, may be null.

Interface GLMediaPlayer

StreamWorker Decoding Thread

GLMediaPlayer Lifecycle

Audio and video Stream IDs

Timestamp Accuracy

Audio and video synchronization

Test Streams

Nested Class Summary

Nested classes/interfaces inherited from interface com.jogamp.opengl.util.texture.TextureSequence

Field Summary

Fields inherited from interface com.jogamp.opengl.util.texture.TextureSequence

Method Summary

Methods inherited from interface com.jogamp.opengl.util.texture.TextureSequence

Field Detail

DEBUG

DEBUG_AVSYNC

DEBUG_NATIVE

TEXTURE_COUNT_DEFAULT

TEXTURE_COUNT_MIN

STREAM_ID_NONE

STREAM_ID_AUTO

CameraInputScheme

CameraPropSizeS

CameraPropWidth

CameraPropHeight

CameraPropRate

MAX_VIDEO_ASYNC

MIN_VIDEO_ASYNC

Method Detail

printNativeInfo

getTextureCount

setTextureUnit

setTextureMinMagFilter

setTextureWrapST

useARatioAdjustment

setARatioAdjustment

useARatioLetterbox

getARatioLetterboxBackColor

setARatioLetterbox

setAudioChannelLimit

playStream

playStream

switchStream

getStreamException

initGL

getAudioSink

destroy

stop

setPlaySpeed

getPlaySpeed

setAudioVolume

getAudioVolume

isAudioMuted

resume

pause

seek

getState

getVStreams

getVLangs

getVID

getNextVID

getAStreams

getALangs

getAID

getNextAID

getSStreams

getSLangs

getSID

getNextSID

hasStreamID

getLang

getDecodedFrameCount

getPresentedFrameCount

getPTS

getVideoPTS

getAudioPTS

getLastTexture

getNextTexture

getUri

getVideoCodecID