io.humble.video.Decoder Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of humble-video-noarch Show documentation
This is the main Humble Video Java library. It contains no native code, but all Java runtime code. It must be paired up with the correct humble-video-arch-*.jar library for your OS. For most users, depending on humble-video-all will work better.
The newest version!
/* ----------------------------------------------------------------------------
 * This file was automatically generated by SWIG (http://www.swig.org).
 * Version 2.0.6
 *
 * Do not make changes to this file unless you know what you are doing--modify
 * the SWIG interface file instead.
 * ----------------------------------------------------------------------------- */

package io.humble.video;
import io.humble.ferry.*;
/**
 * Decodes MediaPacket objects into MediaAudio, MediaPicture or MediaSubtitle objects.
 */
public class Decoder extends Coder {
  // JNIHelper.swg: Start generated code
  // >>>>>>>>>>>>>>>>>>>>>>>>>>>
  /**
   * This method is only here to use some references and remove
   * a Eclipse compiler warning.
   */
  @SuppressWarnings("unused")
  private void noop()
  {
    Buffer.make(null, 1);
  }
   
  private volatile long swigCPtr;

  /**
   * Internal Only.
   */
  protected Decoder(long cPtr, boolean cMemoryOwn) {
    super(VideoJNI.Decoder_SWIGUpcast(cPtr), cMemoryOwn);
    swigCPtr = cPtr;
  }
  
  /**
   * Internal Only.
   */
  protected Decoder(long cPtr, boolean cMemoryOwn,
      java.util.concurrent.atomic.AtomicLong ref)
  {
    super(VideoJNI.Decoder_SWIGUpcast(cPtr),
     cMemoryOwn, ref);
    swigCPtr = cPtr;
  }
    
  /**
   * Internal Only.  Not part of public API.
   *
   * Get the raw value of the native object that obj is proxying for.
   *   
   * @param obj The java proxy object for a native object.
   * @return The raw pointer obj is proxying for.
   */
  protected static long getCPtr(Decoder obj) {
    if (obj == null) return 0;
    return obj.getMyCPtr();
  }

  /**
   * Internal Only.  Not part of public API.
   *
   * Get the raw value of the native object that we're proxying for.
   *   
   * @return The raw pointer we're proxying for.
   */  
  protected long getMyCPtr() {
    if (swigCPtr == 0) throw new IllegalStateException("underlying native object already deleted");
    return swigCPtr;
  }
  
  /**
   * Create a new Decoder object that is actually referring to the
   * exact same underlying native object.
   *
   * @return the new Java object.
   */
  @Override
  public Decoder copyReference() {
    if (swigCPtr == 0)
      return null;
    else
      return new Decoder(swigCPtr, swigCMemOwn, getJavaRefCount());
  }

  /**
   * Compares two values, returning true if the underlying objects in native code are the same object.
   *
   * That means you can have two different Java objects, but when you do a comparison, you'll find out
   * they are the EXACT same object.
   *
   * @return True if the underlying native object is the same.  False otherwise.
   */
  public boolean equals(Object obj) {
    boolean equal = false;
    if (obj instanceof Decoder)
      equal = (((Decoder)obj).swigCPtr == this.swigCPtr);
    return equal;
  }
  
  /**
   * Get a hashable value for this object.
   *
   * @return the hashable value.
   */
  public int hashCode() {
     return (int)swigCPtr;
  }
  
  // <<<<<<<<<<<<<<<<<<<<<<<<<<<
  // JNIHelper.swg: End generated code
  

/**
 * Create a Decoder that will use the given Codec.

 * 

 * @return a Decoder

 * @throws InvalidArgument if codec is null or codec cannot decode.
 */
  public static Decoder make(Codec codec) {
    long cPtr = VideoJNI.Decoder_make__SWIG_0(Codec.getCPtr(codec), codec);
    return (cPtr == 0) ? null : new Decoder(cPtr, false);
  }

/**
 * Creates a Decoder from a given Coder (either an encoder or a decoder).

 * @return a Decoder

 * @throws InvalidArgument if src is null
 */
  public static Decoder make(Coder src) {
    long cPtr = VideoJNI.Decoder_make__SWIG_1(Coder.getCPtr(src), src);
    return (cPtr == 0) ? null : new Decoder(cPtr, false);
  }

/**
 * Flush this Decoder, getting rid of any cached packets (call after seek).

 * Next packet given to decode should be a key packet.
 */
  public void flush() {
    VideoJNI.Decoder_flush(swigCPtr, this);
  }

/**
 * Decode this packet into output.  It will

 * try to fill up the audio samples object, starting

 * from the byteOffset inside this packet.

 * 

 * The caller is responsible for allocating the

 * MediaAudio object.  This function will overwrite

 * any data in the samples object.

 * 


 * @param output The MediaAudio we decode to. Caller must check if it is complete on return.

 * @param packet    The packet we're attempting to decode from.

 * @param byteOffset Where in the packet payload to start decoding

 * 

 * @return number of bytes actually processed from the packet, or negative for error
 */
  public int decodeAudio(MediaAudio output, MediaPacket packet, int byteOffset) {
    return VideoJNI.Decoder_decodeAudio(swigCPtr, this, MediaAudio.getCPtr(output), output, MediaPacket.getCPtr(packet), packet, byteOffset);
  }

/**
 * Decode this packet into output.

 * 

 * The caller is responsible for allocating the

 * MediaPicture object.  This function will potentially

 * overwrite any data in the frame object, but

 * you should pass the same MediaPicture into this function

 * repeatedly until Media.isComplete() is true.

 * 

 * Note on memory for MediaPicture: For a multitude of reasons,

 * if you created MediaPicture from a buffer, decodeVideo will discard

 * it and replace it with a buffer that is aligned correctly for different

 * CPUs and different codecs. If you must have a copy of the image data

 * in memory managed by you, then pass in a MediaPicture allocated without

 * a buffer to DecodeVideo, and then copy that into your own media picture.

 * 


 * 

 * @param output The MediaPicture we decode. Caller must check if it is complete on return.

 * @param packet  The packet we're attempting to decode from.

 * @param byteOffset Where in the packet payload to start decoding

 * 

 * @return number of bytes actually processed from the packet, or negative for error
 */
  public int decodeVideo(MediaPicture output, MediaPacket packet, int byteOffset) {
    return VideoJNI.Decoder_decodeVideo(swigCPtr, this, MediaPicture.getCPtr(output), output, MediaPacket.getCPtr(packet), packet, byteOffset);
  }

/**
 * Decode this packet into output.  It will

 * try to fill up the media object, starting

 * from the byteOffset inside this packet.

 * 

 * The caller is responsible for allocating the

 * correct underlying Media object.  This function will overwrite

 * any data in the samples object.

 * 


 * @param output The Media we decode to. Caller must check if it is complete on return.

 * @param packet    The packet we're attempting to decode from.

 * @param byteOffset Where in the packet payload to start decoding

 * 

 * @return number of bytes actually processed from the packet, or negative for error

 * 

 * @throws InvalidArgument if the media type is not compatible with this decoder.

 * @see decodeVideo

 * @see decodeAudio
 */
  public int decode(MediaSampled output, MediaPacket packet, int byteOffset) {
    return VideoJNI.Decoder_decode(swigCPtr, this, MediaSampled.getCPtr(output), output, MediaPacket.getCPtr(packet), packet, byteOffset);
  }

}