com.fluendo.plugin
Class KateDec

java.lang.Object
  extended by com.fluendo.jst.Object
      extended by com.fluendo.jst.Element
          extended by com.fluendo.plugin.KateDec
All Implemented Interfaces:
OggPayload

public class KateDec
extends Element
implements OggPayload

Katedec is a decoder element for the Kate stream format. See http://wiki.xiph.org/index.php/OggKate for more information. Kate streams may be multiplexed in Ogg. The Katedec element accepts Kate packets (presumably demultiplexed by an Ogg demuxer element) on its sink, and generates Kate events on its source. Kate events are Kate specific structures, which may then be interpreted by a renderer.


Field Summary
 
Fields inherited from class com.fluendo.jst.Element
ASYNC, ELEMENT_FLAG_LAST, FAILURE, FLAG_IS_SINK, NO_PREROLL, NONE, PAUSE, PAUSE_PLAY, PAUSE_STOP, PLAY, PLAY_PAUSE, stateReturnNames, STOP, STOP_PAUSE, SUCCESS
 
Fields inherited from class com.fluendo.jst.Object
OBJECT_FLAG_LAST
 
Constructor Summary
KateDec()
           
 
Method Summary
 java.lang.String getFactoryName()
           
 long getFirstTs(java.util.Vector packets)
          Get the first timestamp of the list of packets
 java.lang.String getMime()
          Get mime type
 java.lang.String getMime(com.jcraft.jogg.Packet op)
          Get mime type from the given packet
 java.lang.Object getProperty(java.lang.String name)
           
 long granuleToDuration(long gp)
          Converts a granule position to its duration equivalent
 long granuleToTime(long gp)
          Converts a granule position to its time equivalent
 boolean isDiscontinuous()
          A discontinuous codec will not cause the pipeline to wait for data if starving
 boolean isHeader(com.jcraft.jogg.Packet op)
          Check if the packet contains a header packet
 boolean isKeyFrame(com.jcraft.jogg.Packet op)
          Check if the packet contains a keyframe
 boolean isType(com.jcraft.jogg.Packet op)
          Check if the packet contains the signature of the payload.
 int takeHeader(com.jcraft.jogg.Packet op)
          Initialize the payload with a header packet.
 int typeFind(byte[] data, int offset, int length)
           
 
Methods inherited from class com.fluendo.jst.Element
abortState, addPad, addPadListener, continueState, enumPads, getBus, getClock, getPad, getState, getStateName, getStateNext, getStateReturnName, getTransition, getTransitionCurrent, getTransitionNext, lostState, noMorePads, postMessage, query, removePad, removePadListener, requestSinkPad, sendEvent, setBus, setClock, setState, toString
 
Methods inherited from class com.fluendo.jst.Object
getName, getParent, isFlagSet, setFlag, setName, setParent, setProperty, unParent, unsetFlag
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

KateDec

public KateDec()
Method Detail

isType

public boolean isType(com.jcraft.jogg.Packet op)
Description copied from interface: OggPayload
Check if the packet contains the signature of the payload.

Specified by:
isType in interface OggPayload

isKeyFrame

public boolean isKeyFrame(com.jcraft.jogg.Packet op)
Description copied from interface: OggPayload
Check if the packet contains a keyframe

Specified by:
isKeyFrame in interface OggPayload

isDiscontinuous

public boolean isDiscontinuous()
A discontinuous codec will not cause the pipeline to wait for data if starving

Specified by:
isDiscontinuous in interface OggPayload

takeHeader

public int takeHeader(com.jcraft.jogg.Packet op)
Description copied from interface: OggPayload
Initialize the payload with a header packet. Returns < 0 for error, 0 if OK, 1 if OK and ready for decoding data.

Specified by:
takeHeader in interface OggPayload

isHeader

public boolean isHeader(com.jcraft.jogg.Packet op)
Description copied from interface: OggPayload
Check if the packet contains a header packet

Specified by:
isHeader in interface OggPayload

getFirstTs

public long getFirstTs(java.util.Vector packets)
Description copied from interface: OggPayload
Get the first timestamp of the list of packets

Specified by:
getFirstTs in interface OggPayload

granuleToTime

public long granuleToTime(long gp)
Converts a granule position to its time equivalent

Specified by:
granuleToTime in interface OggPayload

granuleToDuration

public long granuleToDuration(long gp)
Converts a granule position to its duration equivalent


getProperty

public java.lang.Object getProperty(java.lang.String name)
Overrides:
getProperty in class Object

getFactoryName

public java.lang.String getFactoryName()
Specified by:
getFactoryName in class Element

getMime

public java.lang.String getMime()
Description copied from interface: OggPayload
Get mime type

Specified by:
getMime in interface OggPayload
Overrides:
getMime in class Element

getMime

public java.lang.String getMime(com.jcraft.jogg.Packet op)
Description copied from interface: OggPayload
Get mime type from the given packet

Specified by:
getMime in interface OggPayload

typeFind

public int typeFind(byte[] data,
                    int offset,
                    int length)
Overrides:
typeFind in class Element