org/jsampler/HF.java

/*
 *   JSampler - a java front-end for LinuxSampler
 *
 *   Copyright (C) 2005-2008 Grigor Iliev <grigor@grigoriliev.com>
 *
 *   This file is part of JSampler.
 *
 *   JSampler is free software; you can redistribute it and/or modify
 *   it under the terms of the GNU General Public License version 2
 *   as published by the Free Software Foundation.
 *
 *   JSampler 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 General Public License for more details.
 *
 *   You should have received a copy of the GNU General Public License
 *   along with JSampler; if not, write to the Free Software
 *   Foundation, Inc., 59 Temple Place, Suite 330, Boston,
 *   MA  02111-1307  USA
 */

package org.jsampler;

import java.awt.Component;
import java.awt.Dialog;
import java.awt.Font;
import java.awt.Frame;

import java.io.File;
import java.io.FileInputStream;
import java.io.FileOutputStream;

import java.util.logging.Level;

import javax.swing.JOptionPane;
import javax.swing.UIManager;
import javax.swing.plaf.FontUIResource;

import org.linuxsampler.lscp.LSException;
import org.linuxsampler.lscp.LscpException;

import static org.jsampler.JSI18n.i18n;


/**
 * This class contains some helper function.
 * @author Grigor Iliev
 */
public class HF {
// GUI HELPER FUNCIONS
        
        /**
         * Returns more meaningful, non-<code>null</code> message.
         * @return More meaningful, non-<code>null</code> message.
         */
        public static String
        getErrorMessage(Exception e) {
                String msg = e.getMessage();
                
                if(e instanceof LSException) {
                        LSException x = (LSException)e;
                } else if(e instanceof LscpException) {
                        
                } else { msg = (msg != null ? msg : i18n.getError("unknownError")); }
                
                return msg;
        }
        
        /**
         * Shows a dialog with the specified error message.
         * @param msg The error message to be shown.
         */
        public static void
        showErrorMessage(String msg) { showErrorMessage(msg, CC.getMainFrame()); }
        
        /**
         * Shows a dialog with the specified error message.
         * @param parentComponent determines the Frame in which the dialog is displayed
         * @param msg The error message to be shown.
         */
        public static void
        showErrorMessage(String msg, Component parentComponent) {
                JOptionPane.showMessageDialog (
                        parentComponent, msg,
                        i18n.getError("error"),
                        JOptionPane.ERROR_MESSAGE
                );
        }
        
        /**
         * Shows a dialog with error message obtained by {@link #getErrorMessage} method.
         * @param e The <code>Exception</code> from which the error message is obtained.
         */
        public static void
        showErrorMessage(Exception e) { showErrorMessage(e, CC.getMainFrame()); }
        
        /**
         * Shows a dialog with error message obtained by {@link #getErrorMessage} method.
         * @param e The <code>Exception</code> from which the error message is obtained.
         * @param prefix The prefix to be added to the error message.
         */
        public static void
        showErrorMessage(Exception e, String prefix) {
                showErrorMessage(e, CC.getMainFrame(), prefix);
        }
        
        /**
         * Shows a dialog with error message obtained by {@link #getErrorMessage} method.
         * @param e The <code>Exception</code> from which the error message is obtained.
         * @param frame The parent <code>Frame</code> for the dialog.
         */
        public static void
        showErrorMessage(Exception e, Frame frame) {
                showErrorMessage(e, frame, "");
        }
        
        /**
         * Shows a dialog with error message obtained by {@link #getErrorMessage} method.
         * @param e The <code>Exception</code> from which the error message is obtained.
         * @param frame The parent <code>Frame</code> for the dialog.
         * @param prefix The prefix to be added to the error message.
         */
        public static void
        showErrorMessage(Exception e, Frame frame, String prefix) {
                String msg = prefix + getErrorMessage(e);
                
                CC.getLogger().log(Level.INFO, msg, e);
                        
                JOptionPane.showMessageDialog (
                        frame, msg,
                        i18n.getError("error"),
                        JOptionPane.ERROR_MESSAGE
                );
        }
        
        /**
         * Shows a dialog with error message obtained by {@link #getErrorMessage} method.
         * @param e The <code>Exception</code> from which the error message is obtained.
         * @param dlg The parent <code>Dialog</code> from which the dialog is displayed.
         */
        public static void
        showErrorMessage(Exception e, Dialog dlg) {
                String msg = getErrorMessage(e);
                
                CC.getLogger().log(Level.INFO, msg, e);
                
                JOptionPane.showMessageDialog (
                        dlg, msg,
                        i18n.getError("error"),
                        JOptionPane.ERROR_MESSAGE
                );
        }
        
        /**
         * Brings up a question dialog with Yes, No options, empty title and the specified message.
         * @param parent The parent <code>Component</code> for the dialog.
         * @param message The message to display.
         * @return <code>true</code> if the user chooses "yes", <code>false</code> otherwise.
         */
        public static boolean
        showYesNoDialog(Component parent, String message) {
                return showYesNoDialog(parent, message, "");
        }
        
        /**
         * Brings up a question dialog with Yes, No options, empty title and the specified message.
         * @param parent The parent <code>Component</code> for the dialog.
         * @param message The message to display.
         * @param title The dialog's title.
         * @return <code>true</code> if the user chooses "yes", <code>false</code> otherwise.
         */
        public static boolean
        showYesNoDialog(Component parent, String message, String title) {
                Object[] options = { i18n.getButtonLabel("yes"), i18n.getButtonLabel("no") };
                int n = JOptionPane.showOptionDialog (
                        parent,
                        message, title,
                        JOptionPane.YES_NO_OPTION,
                        JOptionPane.QUESTION_MESSAGE,
                        null,
                        options, options[0]
                );
                
                return n == 0;
        }
        
        /**
         * Sets the default font to be used in the GUI.
         * @param fontName The name of the font to be used as default.
         */
        public static void
        setUIDefaultFont(String fontName) {
                if(fontName == null) return;
                
                java.util.Enumeration keys = UIManager.getDefaults().keys();
                while(keys.hasMoreElements()) {
                        Object key = keys.nextElement();
                        Object value = UIManager.get(key);
                        if(value instanceof FontUIResource) {
                                Font f = (FontUIResource)value;
                                FontUIResource fr =
                                        new FontUIResource(fontName, f.getStyle(), f.getSize());
                                UIManager.put(key, fr);
                        }
                }
        }
///////
        
        /**
         * Deletes the specified file, if exists and
         * is located in the JSampler's home directory.
         * @param file The file to delete.
         */
        public static void
        deleteFile(String file) {
                String s = CC.getJSamplerHome();
                if(s == null) return;
                
                try {
                        File f = new File(s + File.separator + file);
                        if(f.isFile()) f.delete();
                } catch(Exception x) {
                        CC.getLogger().log(Level.INFO, getErrorMessage(x), x);
                }
        }
        
        /**
         * Create a backup copy of the specified file, located in the JSampler's home directory.
         * @param file The name of the file to backup.
         * @param bkpFile The backup name of the file.
         * @return <code>true</code> if the file is backuped successfully.
         */
        public static boolean
        createBackup(String file, String bkpFile) {
                if(file == null || bkpFile == null) return false;
                if(file.length() == 0 || bkpFile.length() == 0) return false;
                
                String s = CC.getJSamplerHome();
                if(s == null) return false;
                
                File f = new File(s + File.separator + file);
                if(!f.isFile()) return false;
                
                try {
                        FileInputStream fis = new FileInputStream(s + File.separator + file);
                        
                        FileOutputStream fos;
                        fos = new FileOutputStream(s + File.separator + bkpFile, false);
                        
                        int i = fis.read();
                        while(i != -1) {
                                fos.write(i);
                                i = fis.read();
                        }
                } catch(Exception x) {
                        CC.getLogger().log(Level.INFO, getErrorMessage(x), x);
                        return false;
                }
                
                return true;
        }
        
        /**
         * Converts the volume value specified in percents to decibels.
         */
        public static double
        percentsToDecibels(int vol) {
                if(vol == 0) return Double.NEGATIVE_INFINITY;
                double i = vol;
                i /= 100;
                i = 20 * Math.log10(i);
                return i;
        }
        
        
        /**
         * Converts the volume value specified in decibels to percents.
         */
        public static int
        decibelsToPercents(double vol) {
                if(vol == Double.NEGATIVE_INFINITY) return 0;
                double i = Math.pow(10, vol/20);
                i *= 100;
                return (int)i;
        }
        
        /**
         * Converts the volume value specified in decibels to volume factor.
         */
        public static float
        decibelsToFactor(double vol) {
                if(vol == Double.NEGATIVE_INFINITY) return 0;
                double i = Math.pow(10, vol/20);
                return (float)i;
        }
        
        /**
         * Converts the volume value specified in percents to volume factor.
         */
        public static float
        percentsToFactor(int vol) {
                float f = vol;
                f /= 100;
                return f;
        }
}
1	iliev	787	/*
2			* JSampler - a java front-end for LinuxSampler
3			*
4	iliev	1752	* Copyright (C) 2005-2008 Grigor Iliev <grigor@grigoriliev.com>
5	iliev	787	*
6			* This file is part of JSampler.
7			*
8			* JSampler is free software; you can redistribute it and/or modify
9			* it under the terms of the GNU General Public License version 2
10			* as published by the Free Software Foundation.
11			*
12			* JSampler is distributed in the hope that it will be useful,
13			* but WITHOUT ANY WARRANTY; without even the implied warranty of
14			* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15			* GNU General Public License for more details.
16			*
17			* You should have received a copy of the GNU General Public License
18			* along with JSampler; if not, write to the Free Software
19			* Foundation, Inc., 59 Temple Place, Suite 330, Boston,
20			* MA 02111-1307 USA
21			*/
22
23			package org.jsampler;
24
25			import java.awt.Component;
26			import java.awt.Dialog;
27			import java.awt.Font;
28			import java.awt.Frame;
29
30	iliev	1143	import java.io.File;
31			import java.io.FileInputStream;
32			import java.io.FileOutputStream;
33
34	iliev	787	import java.util.logging.Level;
35
36			import javax.swing.JOptionPane;
37			import javax.swing.UIManager;
38			import javax.swing.plaf.FontUIResource;
39
40			import org.linuxsampler.lscp.LSException;
41			import org.linuxsampler.lscp.LscpException;
42
43			import static org.jsampler.JSI18n.i18n;
44
45
46			/**
47	iliev	911	* This class contains some helper function.
48	iliev	787	* @author Grigor Iliev
49			*/
50			public class HF {
51			// GUI HELPER FUNCIONS
52	iliev	911
53			/**
54			* Returns more meaningful, non-<code>null</code> message.
55			* @return More meaningful, non-<code>null</code> message.
56			*/
57	iliev	787	public static String
58			getErrorMessage(Exception e) {
59			String msg = e.getMessage();
60
61			if(e instanceof LSException) {
62			LSException x = (LSException)e;
63			} else if(e instanceof LscpException) {
64
65			} else { msg = (msg != null ? msg : i18n.getError("unknownError")); }
66
67			return msg;
68			}
69
70	iliev	911	/**
71			* Shows a dialog with the specified error message.
72			* @param msg The error message to be shown.
73			*/
74	iliev	787	public static void
75			showErrorMessage(String msg) { showErrorMessage(msg, CC.getMainFrame()); }
76
77	iliev	911	/**
78			* Shows a dialog with the specified error message.
79	iliev	1752	* @param parentComponent determines the Frame in which the dialog is displayed
80	iliev	911	* @param msg The error message to be shown.
81			*/
82	iliev	787	public static void
83	iliev	1752	showErrorMessage(String msg, Component parentComponent) {
84	iliev	787	JOptionPane.showMessageDialog (
85	iliev	1752	parentComponent, msg,
86	iliev	787	i18n.getError("error"),
87			JOptionPane.ERROR_MESSAGE
88			);
89			}
90
91	iliev	911	/**
92			* Shows a dialog with error message obtained by {@link #getErrorMessage} method.
93			* @param e The <code>Exception</code> from which the error message is obtained.
94			*/
95	iliev	787	public static void
96			showErrorMessage(Exception e) { showErrorMessage(e, CC.getMainFrame()); }
97
98	iliev	911	/**
99			* Shows a dialog with error message obtained by {@link #getErrorMessage} method.
100			* @param e The <code>Exception</code> from which the error message is obtained.
101			* @param prefix The prefix to be added to the error message.
102			*/
103	iliev	787	public static void
104	iliev	911	showErrorMessage(Exception e, String prefix) {
105			showErrorMessage(e, CC.getMainFrame(), prefix);
106			}
107
108			/**
109			* Shows a dialog with error message obtained by {@link #getErrorMessage} method.
110			* @param e The <code>Exception</code> from which the error message is obtained.
111			* @param frame The parent <code>Frame</code> for the dialog.
112			*/
113			public static void
114	iliev	787	showErrorMessage(Exception e, Frame frame) {
115	iliev	911	showErrorMessage(e, frame, "");
116			}
117
118			/**
119			* Shows a dialog with error message obtained by {@link #getErrorMessage} method.
120			* @param e The <code>Exception</code> from which the error message is obtained.
121			* @param frame The parent <code>Frame</code> for the dialog.
122			* @param prefix The prefix to be added to the error message.
123			*/
124			public static void
125			showErrorMessage(Exception e, Frame frame, String prefix) {
126			String msg = prefix + getErrorMessage(e);
127	iliev	787
128			CC.getLogger().log(Level.INFO, msg, e);
129
130			JOptionPane.showMessageDialog (
131			frame, msg,
132			i18n.getError("error"),
133			JOptionPane.ERROR_MESSAGE
134			);
135			}
136
137	iliev	911	/**
138			* Shows a dialog with error message obtained by {@link #getErrorMessage} method.
139			* @param e The <code>Exception</code> from which the error message is obtained.
140			* @param dlg The parent <code>Dialog</code> from which the dialog is displayed.
141			*/
142	iliev	787	public static void
143			showErrorMessage(Exception e, Dialog dlg) {
144			String msg = getErrorMessage(e);
145
146			CC.getLogger().log(Level.INFO, msg, e);
147	iliev	1204
148	iliev	787	JOptionPane.showMessageDialog (
149			dlg, msg,
150			i18n.getError("error"),
151			JOptionPane.ERROR_MESSAGE
152			);
153			}
154
155			/**
156			* Brings up a question dialog with Yes, No options, empty title and the specified message.
157	iliev	911	* @param parent The parent <code>Component</code> for the dialog.
158			* @param message The message to display.
159	iliev	1204	* @return <code>true</code> if the user chooses "yes", <code>false</code> otherwise.
160	iliev	787	*/
161			public static boolean
162			showYesNoDialog(Component parent, String message) {
163			return showYesNoDialog(parent, message, "");
164			}
165
166	iliev	911	/**
167			* Brings up a question dialog with Yes, No options, empty title and the specified message.
168			* @param parent The parent <code>Component</code> for the dialog.
169			* @param message The message to display.
170			* @param title The dialog's title.
171	iliev	1204	* @return <code>true</code> if the user chooses "yes", <code>false</code> otherwise.
172	iliev	911	*/
173	iliev	787	public static boolean
174			showYesNoDialog(Component parent, String message, String title) {
175			Object[] options = { i18n.getButtonLabel("yes"), i18n.getButtonLabel("no") };
176			int n = JOptionPane.showOptionDialog (
177			parent,
178			message, title,
179			JOptionPane.YES_NO_OPTION,
180			JOptionPane.QUESTION_MESSAGE,
181			null,
182			options, options[0]
183			);
184
185			return n == 0;
186			}
187
188	iliev	911	/**
189			* Sets the default font to be used in the GUI.
190			* @param fontName The name of the font to be used as default.
191			*/
192	iliev	787	public static void
193			setUIDefaultFont(String fontName) {
194			if(fontName == null) return;
195
196			java.util.Enumeration keys = UIManager.getDefaults().keys();
197			while(keys.hasMoreElements()) {
198			Object key = keys.nextElement();
199			Object value = UIManager.get(key);
200			if(value instanceof FontUIResource) {
201			Font f = (FontUIResource)value;
202			FontUIResource fr =
203			new FontUIResource(fontName, f.getStyle(), f.getSize());
204			UIManager.put(key, fr);
205			}
206			}
207			}
208			///////
209	iliev	1143
210			/**
211			* Deletes the specified file, if exists and
212			* is located in the JSampler's home directory.
213			* @param file The file to delete.
214			*/
215			public static void
216			deleteFile(String file) {
217			String s = CC.getJSamplerHome();
218			if(s == null) return;
219
220			try {
221			File f = new File(s + File.separator + file);
222			if(f.isFile()) f.delete();
223			} catch(Exception x) {
224			CC.getLogger().log(Level.INFO, getErrorMessage(x), x);
225			}
226			}
227
228			/**
229			* Create a backup copy of the specified file, located in the JSampler's home directory.
230			* @param file The name of the file to backup.
231			* @param bkpFile The backup name of the file.
232			* @return <code>true</code> if the file is backuped successfully.
233			*/
234			public static boolean
235			createBackup(String file, String bkpFile) {
236			if(file == null \|\| bkpFile == null) return false;
237			if(file.length() == 0 \|\| bkpFile.length() == 0) return false;
238
239			String s = CC.getJSamplerHome();
240			if(s == null) return false;
241
242			File f = new File(s + File.separator + file);
243			if(!f.isFile()) return false;
244
245			try {
246			FileInputStream fis = new FileInputStream(s + File.separator + file);
247
248			FileOutputStream fos;
249			fos = new FileOutputStream(s + File.separator + bkpFile, false);
250
251			int i = fis.read();
252			while(i != -1) {
253			fos.write(i);
254			i = fis.read();
255			}
256			} catch(Exception x) {
257			CC.getLogger().log(Level.INFO, getErrorMessage(x), x);
258			return false;
259			}
260
261			return true;
262			}
263
264	iliev	1540	/**
265			* Converts the volume value specified in percents to decibels.
266			*/
267			public static double
268			percentsToDecibels(int vol) {
269			if(vol == 0) return Double.NEGATIVE_INFINITY;
270			double i = vol;
271			i /= 100;
272			i = 20 * Math.log10(i);
273			return i;
274			}
275	iliev	1143
276	iliev	1540
277
278			/**
279			* Converts the volume value specified in decibels to percents.
280			*/
281			public static int
282			decibelsToPercents(double vol) {
283			if(vol == Double.NEGATIVE_INFINITY) return 0;
284			double i = Math.pow(10, vol/20);
285			i *= 100;
286			return (int)i;
287			}
288
289			/**
290			* Converts the volume value specified in decibels to volume factor.
291			*/
292			public static float
293			decibelsToFactor(double vol) {
294			if(vol == Double.NEGATIVE_INFINITY) return 0;
295			double i = Math.pow(10, vol/20);
296			return (float)i;
297			}
298
299			/**
300			* Converts the volume value specified in percents to volume factor.
301			*/
302			public static float
303			percentsToFactor(int vol) {
304			float f = vol;
305			f /= 100;
306			return f;
307			}
308	iliev	787	}