/* 
 * Copyright (C) 2007 Wayne Meissner
 * Copyright (C) 1999,2000 Erik Walthinsen <omega@cse.ogi.edu>
 *                    2000 Wim Taymans <wtay@chello.be>
 * 
 * This file is part of gstreamer-java.
 *
 * This code is free software: you can redistribute it and/or modify it under 
 * the terms of the GNU Lesser General Public License version 3 only, as
 * published by the Free Software Foundation.
 *
 * This code is distributed in the hope that it will be useful, but WITHOUT 
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or 
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU Lesser General Public License 
 * version 3 for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * version 3 along with this work.  If not, see <http://www.gnu.org/licenses/>.
 */

package org.gstreamer;

import org.gstreamer.lowlevel.GstNative;
import org.gstreamer.lowlevel.GstPluginFeatureAPI;

/**
 * Base class for contents of a {@link Plugin}
 *
 * This is a base class for anything that can be added to a Plugin.
 * @see Plugin
 */
public class PluginFeature extends GstObject {
    public static final String GTYPE_NAME = "GstPluginFeature";

    private static final GstPluginFeatureAPI gst = GstNative.load(GstPluginFeatureAPI.class);
    
    public enum Rank {
        GST_RANK_NONE(0),
        GST_RANK_MARGINAL(64),
        GST_RANK_SECONDARY(128),
        GST_RANK_PRIMARY(256);

        private int value;

        private Rank(int value) {
            this.value = value;
        }

        public int getValue() {
            return value;
        }
    }

    /** Creates a new instance of PluginFeature */
    public PluginFeature(Initializer init) { 
        super(init); 
    }
    
    @Override
    public String toString() {
        return getName();
    }
    
    /**
     *  Gets the name of a plugin feature.
     *
     * @return The name.
     */
    @Override
    public String getName() {
        return gst.gst_plugin_feature_get_name(this);
    }
    
    /**
     * Sets the name of a plugin feature. The name uniquely identifies a feature
     * within all features of the same type. Renaming a plugin feature is not
     * allowed.
     * @param name The name to set.
     */
    @Override
    public boolean setName(String name) {
        gst.gst_plugin_feature_set_name(this, name);
        return true;
    }
    
    /**
     * Set the rank for the plugin feature.
     * Specifies a rank for a plugin feature, so that autoplugging uses
     * the most appropriate feature.
     * @param rank The rank value - higher number means more priority rank
     */
    public void setRank(int rank) {
        gst.gst_plugin_feature_set_rank(this, rank);
    }
    public void setRank(Rank rank) {
    	setRank(rank.getValue());
    }
    
    /**
     * Gets the rank of a plugin feature.
     *
     * @return The rank of the feature.
     */
    public int getRank() {
        return gst.gst_plugin_feature_get_rank(this);
    }
    
    /**
     * Checks whether the given plugin feature is at least the required version.
     *
     * @param major Minimum required major version
     * @param minor Minimum required minor version
     * @param micro Minimum required micro version
     * @return true if the plugin feature has at least the required version, otherwise false.
     */
    public boolean checkVersion(int major, int minor, int micro) {
        return gst.gst_plugin_feature_check_version(this, minor, minor, micro);
    }
}