io.humble.video.DemuxerFormat 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.*;
/**
 * An object that describes Containers that HumbleVideo can read MediaPacket objects

 * from.
 */
public class DemuxerFormat extends ContainerFormat {
  // 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 DemuxerFormat(long cPtr, boolean cMemoryOwn) {
    super(VideoJNI.DemuxerFormat_SWIGUpcast(cPtr), cMemoryOwn);
    swigCPtr = cPtr;
  }
  
  /**
   * Internal Only.
   */
  protected DemuxerFormat(long cPtr, boolean cMemoryOwn,
      java.util.concurrent.atomic.AtomicLong ref)
  {
    super(VideoJNI.DemuxerFormat_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(DemuxerFormat 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 DemuxerFormat object that is actually referring to the
   * exact same underlying native object.
   *
   * @return the new Java object.
   */
  @Override
  public DemuxerFormat copyReference() {
    if (swigCPtr == 0)
      return null;
    else
      return new DemuxerFormat(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 DemuxerFormat)
      equal = (((DemuxerFormat)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
  
  @Override
  public String toString()
  {
    StringBuilder result = new StringBuilder();
    
    result.append(this.getClass().getName()+"@"+hashCode()+"[");
    result.append("name:" + getName() + ";");
    result.append("description:"+getLongName() + ";");
    result.append("]");
    return result.toString();
  }

  /**
   * Return a collection of all input formats installed on this system.
   * @return the list.
   */
  public static java.util.Collection
  getFormats()
  {
    java.util.Collection retval =
      new java.util.HashSet();
    int count = getNumFormats();
    for(int i = 0; i< count;++i)
    {
      DemuxerFormat fmt = getFormat(i);
      if (fmt != null)
        retval.add(fmt);
    }
    return retval;
  }


/**
 * Name for format.
 */
  public String getName() {
    return VideoJNI.DemuxerFormat_getName(swigCPtr, this);
  }

/**
 * Descriptive name for the format, meant to be more human-readable

 * than name.
 */
  public String getLongName() {
    return VideoJNI.DemuxerFormat_getLongName(swigCPtr, this);
  }

/**
 * A comma-separated list of supported filename extensions 
 */
  public String getExtensions() {
    return VideoJNI.DemuxerFormat_getExtensions(swigCPtr, this);
  }

/**
 * Flags that tell you what capabilities this format supports.

 * 

 * @return a bitmask of Flags
 */
  public int getFlags() {
    return VideoJNI.DemuxerFormat_getFlags(swigCPtr, this);
  }

/**
 * Get total number of different codecs this container can output.
 */
  protected int getNumSupportedCodecs() {
    return VideoJNI.DemuxerFormat_getNumSupportedCodecs(swigCPtr, this);
  }

/**
 * Get the CodecId for the n'th codec supported by this container.

 * 

 * @param n The n'th codec supported by this codec. Lower n are higher priority.

 *   n must be < #getNumSupportedCodecs()

 * @return the CodecId at the n'th slot, or CodecId.ID_NONE if none.
 */
  protected Codec.ID getSupportedCodecId(int n) {
    return Codec.ID.swigToEnum(VideoJNI.DemuxerFormat_getSupportedCodecId(swigCPtr, this, n));
  }

/**
 * Get the 32-bit Codec Tag for the n'th codec supported by this container.

 * 

 * @param n The n'th codec supported by this codec. Lower n are higher priority.

 *   n must be < #getNumSupportedCodecs()

 * @return the codec tag at the n'th slot, or 0 if none.
 */
  protected long getSupportedCodecTag(int n) {
    return VideoJNI.DemuxerFormat_getSupportedCodecTag(swigCPtr, this, n);
  }

/**
 * Find DemuxerFormat based on the short name of the input format.

 * @return An DemuxerFormat or null if none found.
 */
  public static DemuxerFormat findFormat(String shortName) {
    long cPtr = VideoJNI.DemuxerFormat_findFormat(shortName);
    return (cPtr == 0) ? null : new DemuxerFormat(cPtr, false);
  }

/**
 * Get the number of DemuxerFormats this install can demultiplex (read)

 * from.

 * 

 * @return the number of formats
 */
  protected static int getNumFormats() {
    return VideoJNI.DemuxerFormat_getNumFormats();
  }

/**
 * Return an object for the DemuxerFormats at the given index.

 * 

 * @param index an index for the format list we maintain

 * 

 * @return a format object for that input or null if

 *   unknown, index < 0 or index >= #getNumInstalledInputFormats()
 */
  protected static DemuxerFormat getFormat(int index) {
    long cPtr = VideoJNI.DemuxerFormat_getFormat(index);
    return (cPtr == 0) ? null : new DemuxerFormat(cPtr, false);
  }

}