/*
 * Copyright (c) 2005 Sun Microsystems, Inc. All Rights Reserved.
 * 
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are
 * met:
 * 
 * - Redistribution of source code must retain the above copyright
 *   notice, this list of conditions and the following disclaimer.
 * 
 * - Redistribution in binary form must reproduce the above copyright
 *   notice, this list of conditions and the following disclaimer in the
 *   documentation and/or other materials provided with the distribution.
 * 
 * Neither the name of Sun Microsystems, Inc. or the names of
 * contributors may be used to endorse or promote products derived from
 * this software without specific prior written permission.
 * 
 * This software is provided "AS IS," without a warranty of any kind. ALL
 * EXPRESS OR IMPLIED CONDITIONS, REPRESENTATIONS AND WARRANTIES,
 * INCLUDING ANY IMPLIED WARRANTY OF MERCHANTABILITY, FITNESS FOR A
 * PARTICULAR PURPOSE OR NON-INFRINGEMENT, ARE HEREBY EXCLUDED. SUN
 * MICROSYSTEMS, INC. ("SUN") AND ITS LICENSORS SHALL NOT BE LIABLE FOR
 * ANY DAMAGES SUFFERED BY LICENSEE AS A RESULT OF USING, MODIFYING OR
 * DISTRIBUTING THIS SOFTWARE OR ITS DERIVATIVES. IN NO EVENT WILL SUN OR
 * ITS LICENSORS BE LIABLE FOR ANY LOST REVENUE, PROFIT OR DATA, OR FOR
 * DIRECT, INDIRECT, SPECIAL, CONSEQUENTIAL, INCIDENTAL OR PUNITIVE
 * DAMAGES, HOWEVER CAUSED AND REGARDLESS OF THE THEORY OF LIABILITY,
 * ARISING OUT OF THE USE OF OR INABILITY TO USE THIS SOFTWARE, EVEN IF
 * SUN HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.
 * 
 * You acknowledge that this software is not designed or intended for use
 * in the design, construction, operation or maintenance of any nuclear
 * facility.
 * 
 * Sun gratefully acknowledges that this software was originally authored
 * and developed by Kenneth Bradley Russell and Christopher John Kline.
 */

package com.jogamp.opengl.util.awt;

import java.awt.*;
import java.awt.image.*;

/** Utilities for dealing with images. */

public class ImageUtil {
  private ImageUtil() {}

  /** Flips the supplied BufferedImage vertically. This is often a
      necessary conversion step to display a Java2D image correctly
      with OpenGL and vice versa. */
  public static void flipImageVertically(BufferedImage image) {
    WritableRaster raster = image.getRaster();
    Object scanline1 = null;
    Object scanline2 = null;
      
    for (int i = 0; i < image.getHeight() / 2; i++) {
      scanline1 = raster.getDataElements(0, i, image.getWidth(), 1, scanline1);
      scanline2 = raster.getDataElements(0, image.getHeight() - i - 1, image.getWidth(), 1, scanline2);
      raster.setDataElements(0, i, image.getWidth(), 1, scanline2);
      raster.setDataElements(0, image.getHeight() - i - 1, image.getWidth(), 1, scanline1);
    }
  }

  /**
   * Creates a <code>BufferedImage</code> with a pixel format compatible with the graphics
   * environment. The returned image can thus benefit from hardware accelerated operations
   * in Java2D API.
   *
   * @param width The width of the image to be created
   * @param height The height of the image to be created
   *
   * @return A instance of <code>BufferedImage</code> with a type compatible with the graphics card.
   */
  public static BufferedImage createCompatibleImage(int width, int height) {
    GraphicsConfiguration configuration =
      GraphicsEnvironment.getLocalGraphicsEnvironment().
      getDefaultScreenDevice().getDefaultConfiguration();
    return configuration.createCompatibleImage(width, height);
  }

  /**
   * Creates a thumbnail from an image. A thumbnail is a scaled down version of the original picture.
   * This method will retain the width to height ratio of the original picture and return a new
   * instance of <code>BufferedImage</code>. The original picture is not modified.
   *
   * @param image The original image to sample down
   * @param thumbWidth The width of the thumbnail to be created
   *
   * @throws IllegalArgumentException If thumbWidth is greater than image.getWidth()
   *
   * @return A thumbnail with the requested width or the original picture if thumbWidth = image.getWidth()
   */
  public static BufferedImage createThumbnail(BufferedImage image, int thumbWidth) {
    // Thanks to Romain Guy for this utility
    if (thumbWidth > image.getWidth()) {
      throw new IllegalArgumentException("Thumbnail width must be greater than image width");
    }
   
    if (thumbWidth == image.getWidth()) {
      return image;
    }
 
    float ratio = (float) image.getWidth() / (float) image.getHeight();
    int width = image.getWidth();
    BufferedImage thumb = image;
   
    do {
      width /= 2;
      if (width < thumbWidth) {
        width = thumbWidth;
      }
     
      BufferedImage temp = createCompatibleImage(width, (int) (width / ratio));
      Graphics2D g2 = temp.createGraphics();
      g2.setRenderingHint(RenderingHints.KEY_INTERPOLATION,
                          RenderingHints.VALUE_INTERPOLATION_BILINEAR);
      g2.drawImage(thumb, 0, 0, temp.getWidth(), temp.getHeight(), null);
      g2.dispose();
      thumb = temp;
    } while (width != thumbWidth);
   
    return thumb;
  }

}
