SilenceTransform.java

package apes.plugins;

import java.awt.Point;
import java.util.HashMap;
import java.util.Map;

import apes.interfaces.TransformPlugin;
import apes.models.InternalFormat;


/**
 * A simple silence effect.
 */
public class SilenceTransform implements TransformPlugin
{
  /**
   * Returns the name
   * 
   * @return Name
   */
  public String getName()
  {
    return "Silence";
  }

  /**
   * Returns mapping with descriptions.
   * 
   * @return Description map.
   */
  public Map<String, String> getDescriptions()
  {
    Map<String, String> map = new HashMap<String, String>();

    map.put("en", "A silence effect that mutes the marked area.");
    map.put("sv", "En tystnadseffekt som tar bort allt ljud.");

    return map;
  }

  /**
   * Apples effect on internal format.
   * 
   * @param internalFormat The internal format.
   * @param selection The selected region.
   */
  public void apply(InternalFormat internalFormat, Point selection)
  {
    internalFormat.scaleSamples(selection.x, selection.y, 0);
    internalFormat.updated();
  }
}