ViewVC logotype

Contents of /web/trunk/www.linuxsampler.org/windows.html

Parent Directory Parent Directory | Revision Log Revision Log

Revision 1593 - (show annotations) (download) (as text)
Thu Dec 13 01:46:02 2007 UTC (12 years, 9 months ago) by schoenebeck
File MIME type: text/html
File size: 14686 byte(s)
* yeah it neded it: cleanup of Windows HOWTO

1 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
2 <html>
3 <head>
4 <meta content="text/html; charset=ISO-8859-1"
5 http-equiv="content-type">
6 <title>LinuxSampler For Windows</title>
7 <link rel="shortcut icon" href="http://download.linuxsampler.org/favicon.ico" type="image/x-icon">
8 <link rel="stylesheet" type="text/css" href="libgig/css/content.css" title="content" media="all">
9 </head>
10 <body>
11 <h2><center>LinuxSampler for Windows &nbsp; <img src="gfx/logos/windows.png"> &nbsp; HOWTO by Benno Senoner&nbsp;</center></h2>
12 <br>
13 <center>December&nbsp;13th,&nbsp;2007</center><br>
14 <div style="background-color: #F4F4FF; margin: 1em 3em 1em 3em; padding: 1em 1em 1em 2.2em;">
15 <a href="#intro">1.&nbsp; Introduction</a><br>
16 <a href="#requirements">2.&nbsp; Requirements</a><br>
17 3.&nbsp; Installation ...<br>
18 <a href="#install_w_inet">&nbsp;&nbsp;&nbsp;&nbsp;3.a&nbsp; with Internet Connection</a><br>
19 <a href="#install_wo_inet">&nbsp;&nbsp;&nbsp;&nbsp;3.b&nbsp; without Internet</a><br>
20 <a href="#using">4.&nbsp; Using the Applications</a><br>
21 <a href="#setup_midi">&nbsp;&nbsp;&nbsp;&nbsp;4.1&nbsp; Setting up MIDI Input</a><br>
22 <a href="#setup_audio">&nbsp;&nbsp;&nbsp;&nbsp;4.2&nbsp; Setting up Audio Output</a><br>
23 <a href="#load_samples">&nbsp;&nbsp;&nbsp;&nbsp;4.3&nbsp; Loading Samples</a><br>
24 <a href="#save_session">&nbsp;&nbsp;&nbsp;&nbsp;4.4&nbsp; Saving a Sampler Session</a><br>
25 <a href="#houston">5.&nbsp; Installation Troubleshooting</a><br>
26 <a href="#docs">6.&nbsp; Detailed Documentation</a><br>
27 <a href="#bugs">7.&nbsp; Bugs, Problems and Feature Requests</a><br>
28 <a href="#contact">8.&nbsp; Contact</a><br>
29 </div>
31 <a name="intro"></a>
32 <h3>1.&nbsp; Introduction</h3>
33 The LinuxSampler development team is happy to announce that
34 LinuxSampler, the most advanced free, open source sampler finally runs on
35 MS Windows too. More information will be added here soon, so check back frequently.<br>
36 <br>
37 For now the sampler supports the Windows Multimedia Extensions System (MME)
38 for MIDI input and ASIO for audio out. This means it currently runs only
39 as a standalone application. A VST interface will follow soon, along with
40 a network module to run multiple sampler slaves distributed on Windows or
41 Linux machines (Linux provides better performance) all controlled from a
42 Windows box i.e. running the VST sequencer.<br>
43 <br>
44 LinuxSampler is implemented as a client/server application. This means
45 the sampling engine (the server / backend) runs
46 independently from the GUI (the client / frontend). Sampling engine and
47 client can be run on the same box or on different machines too, connected
48 over the network.<br>
49 <br>
50 The MS Windows version provides all the features of the Linux version
51 (except of the instruments DB feature yet) since it is built from the
52 same source code base. This means when new features will come out the
53 Windows version will usually provide the same feature set as the Linux
54 version. This was made possible by the very modular design of both
55 low level, operating system functions and flexible audio / MIDI driver
56 system.<br>
57 <br>
58 The Windows version comes as a self extracting .exe file which will
59 install all the necessary modules to run both the server ( linuxsampler.exe )
60 and the GUI client. It installs 2 GUI clients:
61 <ul>
62 <li>One is <b>QSampler</b>, a light-weight frontend based on the
63 cross-platform Qt4 GUI toolkit with native OS GUI widgets</li>
64 <li>Another is <b>JSampler "Fantasia"</b>, a Java based GUI client called,
65 providing a modern skin-based user interface</li>
66 </ul>
67 At the moment JSampler is more advanced than QSampler as it implements all
68 the functionality present in the LinuxSampler engine. Due to the Java
69 virtual machine however it occupies a bit more RAM than the
70 QSsampler GUI (around 30MB or so) and takes a bit longer for startup,
71 but on a 1GB+ RAM box the difference should be negligible.
73 <a name="requirements"></a>
74 <h3>2.&nbsp; Requirements</h3>
75 <ul>
76 <li>Windows 2000, ME, XP or Vista</li>
77 <li><a href="http://www.gtk.org/">GTK+</a> (<a href="http://downloads.sourceforge.net/gladewin32/gtk-2.10.11-win32-1.exe?modtime=1175123376&big_mirror=0">version 2.10.11</a>)</li>
78 <li><a href="http://www.gtkmm.org/">gtkmm</a> (<a href="http://ftp.gnome.org/pub/gnome/binaries/win32/gtkmm/2.10/gtkmm-win32-runtime-2.10.11-1.exe">version 2.10.11</a>)</li>
79 <li><a href="http://en.wikipedia.org/wiki/Java_(Sun)">Java Runtime Environment</a> (<a href="http://www.java.com/getjava/">version 6</a>)</a></li>
80 <li>sound card with <a href="http://en.wikipedia.org/wiki/Audio_Stream_Input/Output">ASIO</a> driver</li>
81 </ul>
82 <a name="asio_tip"></a>
83 <b>Tip:</b> For consumer audio cards which do not come with their own ASIO
84 drivers you can install <a href="http://www.asio4all.com/">ASIO4ALL</a> to be
85 able to use LinuxSampler with your soundcard.
86 We recommend to use version 2.7, perhaps on Vista 2.8beta1 works better but
87 we did not perform tests on Vista so we cannot tell it. Please let us know
88 about your results so we can share them here!
90 <a name="install_w_inet"></a>
91 <h3>3.a&nbsp; Installation with Internet Connection</h3>
92 Simply download the latest version of the LinuxSampler Windows installer
93 from the <a href="http://www.linuxsampler.org/downloads.html">LinuxSampler
94 Download Page</a>, execute the installer and follow the instructions. It will
95 automatically detect if the required software components are already installed.
96 If not, it will download them from the internet and install them on your
97 computer.
99 <a name="install_wo_inet"></a>
100 <h3>3.b&nbsp; Installation without Internet</h3>
101 First download the required components with a machine which has connection to
102 the internet:
103 <ul>
104 <li><a href="http://downloads.sourceforge.net/gladewin32/gtk-2.10.11-win32-1.exe?modtime=1175123376&big_mirror=0">gtk+ 2.10.11</a></li>
105 <li><a href="http://ftp.gnome.org/pub/gnome/binaries/win32/gtkmm/2.10/gtkmm-win32-runtime-2.10.11-1.exe">gtkmm 2.10.11</a></li>
106 <li><a href="http://www.java.com/getjava/">Java Runtime Environment 6</a></li>
107 <li>and of course the latest <a href="http://www.linuxsampler.org/downloads.html">
108 LinuxSampler Windows installer</a></li>
109 </ul>
110 Transfer the downloaded files to the computer where you want to install
111 LinuxSampler and install them in the following order:
112 <ol>
113 <li>gtk-2.10.11-win32-1.exe</li>
114 <li>gtkmm-win32-runtime-2.10.11-1.exe</li>
115 <li>jre-6u2-windows-i586-p.exe</li>
116 <li>linuxsampler_20071207_setup.exe</li>
117 </ol>
118 The order is important, since the components depend on each other and would
119 otherwise try to download the missing component from the internet.
121 <a name="using"></a>
122 <h3>4.&nbsp; Using the Applications</h3>
123 Now that we installed everything, let's get wet and start the applications:
124 <ol>
125 <li>First start the LinuxSampler backend: Click on <i>"Start" ->
126 "LinuxSampler" -> "LinuxSampler 0.5.1 (backend)"</i>. A black console
127 window should immediately popup. It does what you think it does:
128 nothing ... yet ... because this is "just" the raw sampler, without a
129 user interface.</li>
130 <li>Now start a "frontend" application to actually control the previously
131 started sampler. For beginners and / or unpatient people, we recommend
132 you to use JSampler: Click on <i>"Start" -> "LinuxSampler" ->
133 "JSampler 'Fantasia' 0.8a (frontend)"</i>. This usually takes about
134 20 seconds or so until the application finally appears on the
135 screens.</li>
136 </ol>
137 </div>
139 <a name="setup_midi"></a>
140 <h3>4.1&nbsp; Setting up MIDI Input</h3>
141 Once the GUI opens, click on the left round button in the MIDI devices
142 tab.
143 At this point a window will open where you can create a new MIDI device.
144 Press Create. The window will close and the MIDI device will be created.
145 (MIDI Device 0 MME).
146 Now click on the right arrow which points downwards.
147 You can see that a MIDI device with a single Port (Port 0) was created.
148 Under Windows MME LinuxSampler always creates MIDI devices which are
149 connected to a single MME port.
150 To select the MIDI input port you must click on the field located on
151 the left of PORT.
152 A combobox pops-up where you can select the Windows MIDI port.<br>
153 <br>
154 You can create an arbitrary number of MIDI input devices by repeating
155 the procedure above.
156 Each MIDI input device is connected to a single Windows MME MIDI port.
157 This means LinuxSampler has no limitation in terms of number of MIDI
158 ports.
159 Each MIDI device can be routed to arbitrary sampler channels.
161 <a name="setup_audio"></a>
162 <h3>4.2&nbsp; Setting up Audio Output</h3>
163 LinuxSampler currently only supports the ASIO driver model for audio output
164 on Windows. ASIO drivers ensure reliable low-latency operation and are
165 virtually available for any soundcard (see <a href="#asio_tip">
166 ASIO requirements tip</a>).<br>
167 <br>
168 Click on the left round button in the Audio Devices tab.
169 At this point a window will open where you can create a new MIDI device.
170 When creating the Audio device you can set several parameters:
171 <ul>
172 <li><b>CARD</b> : The name of the soundcard, in case you have multiple cards
173 installed. It will show the default value (first card found).</li>
174 <li><b>CHANNELS</b> : Number of audio output channels, can range from 1 to
175 maximum number of channels your soundcard supports. We recommend to
176 leave the default value which is the maximum number of channels your
177 soundcard supports.</li>
178 <li><b>FRAGMENTSIZE</b> : ASIO buffer size in samples. The card's default
179 value is shown. If you experience clicks and pops during audio
180 playback then initialize the audio output device with bigger values.
181 (better if it's always a power of 2:&nbsp; e.g. 256, 512, 1024)</li>
182 <li><b>SAMPLERATE</b> : Sets the samplerate. The default value is shown.<br>
183 </ul>
184 Now Press "Create". The window will close and the Audio device will be
185 created: "AUDIO DEVICE 0 (ASIO)" appears.
187 <a name="load_samples"></a>
188 <h3>4.3&nbsp; Loading Samples</h3>
189 In the middle of the screen below the volume slider, you see the sampler
190 channel strip pane. press on the round button located on the left.
191 This will create a new sampler channel. Click on "Load Instrument".
192 This opens a dialog which allows you to select an instrument to be
193 loaded in the sampler channel
195 (for information on how to use "orchestras" <a
196 href="http://www.linuxsampler.org/jsampler/manual/html/jsampler.html#USING_ORCHESTRAS">click
197 here</a>, but note: orchestras, a.k.a "instruments database" is not yet supported in this
198 first Windows version of LinuxSampler, but will certainly be on the next Windows release).
200 On the row&nbsp; "Select instrument from file" click on the orange icon
201 located on the right side. This opens a file dialog which allows you to
202 select a sample to be loaded
203 (currently only the GIG format is supported).
204 Select the sample to be loaded and then click on "Open".
205 At this point the fields Instrument file shows the filename.
206 You can click on the Instrument index and select the specific
207 instrument contained in the instrument file. Now press "OK".<br>
208 <br>
209 While it loads you see: "Loading" .. "90%" .. "100%" <br>
210 <br>
211 Once loaded, you see the Instrument's name: i.e.&nbsp;"FreePiano"<br>
212 <br>
213 On the left side of the sampler channel click on the arrow below
214 "Options".
215 This pane permits to set MIDI input device, port and channel and oudio
216 output channel.
217 Notice that under Windows MME the Port value is always 0.
218 So the only values you can change is "MIDI device" (normally 0 if you
219 created only a single
220 MIDI input device) and the MIDI channel (from 1 to 16).
222 <a name="save_session"></a>
223 <h3>4.4&nbsp; Saving a Sampler Session</h3>
224 Click on the 3rd icon from the left on the row where you see the round
225 icon with the LinuxSampler "S"-shape logo.
226 Now select the directory where you want to save the file to (extension
227 .lscp = <i>Linux Sampler Control Protocol</i>).
228 Enter the name and press save (add .lscp at end of file otherwise you
229 will not see it in the file-open dialog later, when you want to load it again).<br>
230 <br>
231 Next time you can load a sampler session by clicking on the second icon
232 from the left, then select a .lscp file in the file dialog and press "Open".
233 This will automatically set up the MIDI devices and audio devices,
234 create the sampler channels and load all the samples that were previously
235 loaded by you in the saved sampler session.
237 <a name="houston"></a>
238 <h3>5.&nbsp; Installation Troubleshooting</h3>
239 It could happen that due to previous installations of Gtk+ and gtkmm DLLs
240 even after deinstallation leave some stale keys in the windows registry which
241 could fool the installer into
242 believing that the needed DLLs are already installed therefore skipping
243 its installation which will
244 cause the sampler not being able to start due to the missing DLLs.
245 We recommend in this case to install gtk+ and gtkmm manually as described
246 above in "<a href="#install_wo_inet">Installation without Internet</a>".
247 Just install those mentioned Gtk+ and gtkmm versions and then LinuxSampler
248 should work correctly.
250 <a name="docs"></a>
251 <h3>6.&nbsp; Detailed Documentation</h3>
252 You find more detailed documentation about our software, i.e. about JSampler
253 or gigedit on our official <a href="http://linuxsampler.org/documentation.html">
254 LinuxSampler documentation site</a>.
256 <a name="bugs"></a>
257 <h3>7.&nbsp; Bugs, Problems and Feature Requests</h3>
258 Since the Windows port of LinuxSampler is very young, there could be several
259 bugs which we hope to root out soon.
260 Please report them using our bug tracking system:<br>
261 <br>
262 &nbsp;&nbsp;&nbsp;&nbsp;<a href="http://bugs.linuxsampler.org/">http://bugs.linuxsampler.org/</a><br>
263 <br>
264 Some bugs and problems I discovered so far:
265 <ul>
266 <li>when adding a channel there noises could occur while playing on other
267 channels</li>
268 <li>if you overload the sampler (CPU overload or disk overload) it
269 produces noises</li>
270 <li>when editing an instrument using gigedit, after saving it, it could
271 happen that LinuxSampler does not accept commands from the GUI anymore.
272 if this happens close the GUI and the LinuxSampler console window and
273 restart both.</li>
274 </ul>
276 <a name="contact"></a>
277 <h3>8.&nbsp; Contact</h3>
278 If you have questions or want to help us to improve the sampler,
279 subscribe to the <a href="http://www.linuxsampler.org/developers.html">
280 LinuxSampler Developer's mailing list</a>. Alternatively, since I did most
281 of of the Windows porting, you can write me (Benno) directly about Windows
282 related issues. You can find my email address here:<br>
283 <br>
284 &nbsp;&nbsp;&nbsp;&nbsp;<a href="http://www.linuxsampler.org/developers.html">http://www.linuxsampler.org/developers.html</a>
285 <br><br>
286 That's it, enjoy!<br>
287 <br>
289 </body>
290 </html>

  ViewVC Help
Powered by ViewVC