Changes which allow images to be resized by Mir and saved in the filesystem if an...
[mir.git] / source / mir / media / image / ImageProcessor.java
1 /*
2  * Copyright (C) 2005 The Mir-coders group
3  *
4  * This file is part of Mir.
5  *
6  * Mir is free software; you can redistribute it and/or modify
7  * it under the terms of the GNU General Public License as published by
8  * the Free Software Foundation; either version 2 of the License, or
9  * (at your option) any later version.
10  *
11  * Mir is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14  * GNU General Public License for more details.
15  *
16  * You should have received a copy of the GNU General Public License
17  * along with Mir; if not, write to the Free Software
18  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
19  *
20  * In addition, as a special exception, The Mir-coders gives permission to link
21  * the code of this program with  any library licensed under the Apache Software License.
22  * You must obey the GNU General Public License in all respects for all of the code used
23  * other than the above mentioned libraries.  If you modify this file, you may extend this
24  * exception to your version of the file, but you are not obligated to do so.
25  * If you do not wish to do so, delete this exception statement from your version.
26  */
27 package mir.media.image;
28
29 import mir.media.MediaExc;
30
31 import java.io.File;
32 import java.io.OutputStream;
33
34 public interface ImageProcessor {
35   public void descaleImage(int aMaxSize) throws MediaExc;
36
37   public void descaleImage(int aMaxSize, float aMinDescale) throws MediaExc;
38
39   public void descaleImage(int aMaxSize, int aMinResize) throws MediaExc;
40
41   public void descaleImage(int aMaxSize, float aMinDescale, int aMinResize) throws MediaExc;
42
43   /**
44    * Resizes an image to fit inside <code>aMaxWidth</code> and <code>aMaxHeight</code>, provided
45    *    this requires at least <code>aMinResize</code> pixels will be removed from either the width or
46    *    the height
47    */
48   public void descaleImage(int aMaxWidth, int aMaxHeight, float aMinDescale, int aMinResize) throws MediaExc;
49
50   public void scaleImage(float aScalingFactor) throws MediaExc;
51
52   public int getWidth();
53   public int getHeight();
54   public int getSourceFileSize();
55   public int getScaledFileSize();
56   public int getScaledWidth();
57   public int getScaledHeight();
58   public void writeScaledData(OutputStream aStream, String anImageType) 
59     throws MediaExc;
60   public byte[] getScaledData(String anImageType) throws MediaExc;
61   public void writeScaledData(File aFile, String anImageType) throws MediaExc;
62
63   /**
64    * call this when you're over using this object (removes temp files)
65    */
66   public void cleanup();
67 }
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87