1 This piece of software is based on the software and descriptions mentioned below -
4 (re)Written by: Igor / Atmo (aka André Weber) - WeberAndre@gmx.de
8 if you need to contact one of us - come to www.vdr-portal.de
10 http://www.vdr-portal.de/board/thread.php?threadid=59294 -- Description and Development of the Windows Software
11 http://www.vdr-portal.de/board/thread.php?threadid=48574 -- Description and Development of the Hardware part
13 =====================================================
14 Info for Users on Vista or Windows 7 with active UAC!
15 =====================================================
16 for the first launch do it as Administrator with the following command line
18 AtmoWinA.exe /register
20 to create the required registry entries for the COM Objects, without
21 these registry entries - the DirectShow Filter and also the VLC Plugin
23 If anything went fine you should see the message "COM Server registered Ok!".
25 See the file COPYING.txt for license information.
31 In order to use this Programm with the VLC-Media-Player properly copy the "AtmoCtrlLib.dll" into the same Location where the vlc.exe is. E.G.: "D:\Programme\VLC".
33 NEWER Versions of VideoLAN 1.1.x and higher, don't need a own copy of the "AtmoCtrlLib.dll" in the vlc.exe folder,
34 if the complete filename of the AtmoWin*.exe is given. (Atmo Filter will try to load the DLL from there)
36 Then open VLC and navigate to "Extras" / "Settings" or Press "Ctrl" + "p".
37 Check that the radiobutton in the lower part of the dialogbox called "Show settings" -> "all" is checked.
38 Now open the Register "Video" and click on "Filter". There you have to select the checkbox "AtmoLight-Filter".
39 Afterwards you expand the Tree "Filter" in the Listbox on the left side. By selecting the entry "AtmoLight" you gain more settings.
40 The most important are right these one at the beginning:
44 "Use build in AtmoLight driver":
45 Using this Property means VLC will control the Hardware with its built in driver.
46 (no need for the extra AtmoWin software driver)
50 You have the following choices for "Devicetype" instead of the old settings
51 "AtmoWin Software" - is only available on Windows and works like the old way useing the external AtmoWin*.exe Software package, with the AtmoCtrlLib.dll.
52 "Classic AtmoLight" - is the same as the former "use build in AtmoLight driver"
53 "Quattro AtmoLight" - allows to use up to four serial connected class AtmoLight devices, as one logical device
54 "DMX" - allows to control a simple serial DMX devices for AtmoLight effects
55 "MoMoLight" - is a another kind of hardware supporting 2 oder 3 channels.
56 (see bottom of this file - for more infos about the devices.)
60 "Serial Device / Port":
61 The COM-Port you are using for the hardware. E.G.: COM6 (This setting must be done if you are using the Property
62 "use build in AtmoLight driver" )
66 "Serial Device / Port":
67 The COM-Port you are using for the hardware. E.G.: COM6 (This setting must be done if you are using a device
68 other than "AtmoWin Software")
69 in the case of the device "Quattro AtmoLight" you may specify up to four ports/devices seperated by
70 , or ; for example if you are useing two physical devices write
71 COM6;COM7 or on linux /dev/ttyUSB1;/dev/ttyUSB2
75 "Filename of AtmoWinA.exe":
76 The Path and the Name of the executable. E.G.:
77 'D:\atmoWin_0.45\AtmoWinA.exe' (Using this setting expects that you have copied "AtmoCtrlLib.dll" to the Path where VLC.exe is like described before)
81 "Filename of AtmoWinA.exe":
82 The Path and the Name of the executable. E.G.:
83 'D:\atmoWin_0.45\AtmoWinA.exe'
84 in the same path where the .exe resides the "AtmoCtrlLib.dll" should be there. or you may need to place
85 a copy of this ".dll" into the vlc.exe folder - like in VideoLAN 1.0.x
87 Afterwards you should apply those settings by pressing the button "Save".
92 VideoLAN 1.1.x - new options and settings
93 =========================================
94 Zone Layout for the build-in Atmo
95 =================================
96 This is the most important change I think - because the number of analyzed zones isn't
97 longer fixed to 4 or 5 - it allows to define the physical layout of your lights arround
99 "Number of zones on top" -- how many light sources are place on top of the screen
100 (number of columns in which the screen should be tiled)
102 "Number of zones on bottom" -- how many light sources are place on bottom of the screen
103 (number of columns in which the screen should be tiled)
105 "Zones on left / right side" -- how many light sources are place on right/left of the screen
106 (number of rows in which the screen should be tiled)
107 its assumed that the number on right and left is equal.
109 "[] Calculate a average zone" -- define a color pair depending on the complete screen content
111 This settings tiles the screen into a number of zones - which get analyzed by atmoLight to
112 determine a most used color for these areas - each zone has a number starting from zero.
113 The zones are usualy numbered in clock-wise order starting at the top/left of the screen.
115 Example 1: classic Atmo with 4 channels
116 ---------------------------------------
117 "Number of zones on top" = 1
118 "Number of zones on bottom" = 1
119 "Zones on left / right side" = 1
120 "[] Calculate a average zone" = false/0 not checked.
122 will produce this zone layout
125 ---------------------
133 ---------------- ----
138 Example 2: classic Atmo with 4 channels
139 ---------------------------------------
140 "Number of zones on top" = 2
141 "Number of zones on bottom" = 0
142 "Zones on left / right side" = 1
143 "[] Calculate a average zone" = false/0 not checked.
145 ----------- -----------
146 | Zone 0 | | Zone 1 |
147 ---------------------------------
157 Example 3: classic Atmo with 4 channels
158 ---------------------------------------
159 "Number of zones on top" = 1
160 "Number of zones on bottom" = 0
161 "Zones on left / right side" = 1
162 "[X] Calculate a average zone" = true/1 checked.
166 ---------------------
175 Zone 3 - usualy calcuates the most used color of the full screen / picture / frame
176 not only at the border of the picture.
178 "The average zone" is allways the last in the sequence of numbers.
182 the weightning gradients for these zones are auto calculated
183 from 100% .. 0% starting from the edge.
185 thats also the cause why the parameters Channel assignment changed,
186 the classic comboboxes are still there for devices with 4 channels ot less,
187 but for newer devices the "Channel / Zone assignment" should be used which
188 is defined by a , or ; separated list of "AtmoLight channel numbers" if you
189 want to hide a calcuated zone from output - you can assign channel -1 to
191 for classic AtmoLight with "Example 1" you may write this:
193 AtmoLight Channel 0: gets no zone assigned (-1)
194 AtmoLight Channel 1: gets zone 3 (left)
195 AtmoLight Channel 2: gets zone 2 (bottom)
196 AtmoLight Channel 3: gets zone 1 (right)
197 AtmoLight Channel 4: gets zone 0 (top)
200 Also the settings for Gradient images change for the new devices, its no longer
201 sufficient to speficy only 5 image name - because the number of zones is no longer
203 So its prefered to set a path ("Gradient Bitmap searchpath"), where files
204 like "zone_0.bmp" "zone_1.bmp" etc. exists. (with the same rules as defined for
205 the old zone bitmaps.)
206 --> I think in most cases its no longer required to use this option,
207 to change the zone layout - for most cases its sufficient to change
208 "Zone Layout for the build-in Atmo" to get the same effect?
210 Live Set of parameters for Buildin AtmoLight
211 ============================================
212 durring playback with the buildin driver you can now change some settings
213 of the filter without stopping / starting your movie - just open the
214 "extras" --> "Effects and Filters" --> [Video effects] --> [AtmoLight]
215 - move the sliders or change the calcuation mode, or enable/disable
216 the debug grid - just in time.
221 [] Mark analyzed pixels - puts a grid of the used pixels on each frame
222 to see from which locations/positions the colors are extracted.
226 like the group says only for the DMX device
227 "Count of AtmoLight Channels" - defines how many RGB Channels should be simulated
228 with this DMX device (each RGB channel needs three DMX channels!)
230 "DMX adress for each channel" - defines the DMX Startadress for each AtmoLight
231 channel as "," or ";" separated list. (starting with 0 up to 252) it is assumed
232 that the f.e. of the DMX-AtmoLight channel starts at DMX-Channel 5 - that
233 DMX-Channel 5: is red
234 DMX-Channel 6: is green
235 DMX-Channel 7: is blue!
239 "Count of channels" - defines the devicetype and serial protocol
240 3: - means 3 channels hardware
241 4: - means 4 channels hardware
242 (its required to set the correct number of channels to get this device working,
243 because the serial protocol isn't the same!)
247 VideoLan Options and Devices - the buildin version of AtmoLight supports a subset of the
248 devices that AtmoWin supports.
250 - AtmoWin Software - means do not use the VLC buildin video processing - just forward
251 the basic preprocessed data to the launched AtmoWinA.exe controlling your hardware.
253 - Classic AtmoLight - means the classic hardware from www.vdr-portal.de - with up to 5 channels.
255 - Quattro AtmoLight - is nothing else as that you have connected up to 4 "classic AtmoLight" devices
256 to your computer creating a up 16 channel Atmo Light - each devices needs its own serial port.
257 you have to write the ports seperated by , or ; to [Serial Port/device] f.e. COM3,COM4,COM5 or on
258 Linux /dev/ttyUSB01,/dev/ttyUSB02,/dev/ttyUSB03
260 - DMX - stands for a simple DMX controller which can control up to 255 DMX devices (lights)
261 - f.e. you may have a look here:
262 * http://www.dzionsko.de/elektronic/index.htm
263 * http://www.ulrichradig.de/ (search for dmx on his page)
265 - MoMoLight - is a serial device, with 3 or 4 channels - doing nearly the same like
266 Classic AtmoLight - just another protocol to control the hardware.
267 http://lx.divxstation.com/article.asp?aId=151
268 http://www.the-boss.dk/pages/momolight.htm
270 - Fnordlicht - is a serial device with up to four channels
271 http://github.com/fd0/fnordlicht/raw/master/doc/PROTOCOL
272 http://github.com/fd0/fnordlicht/
277 Original Readme - of the Linux Version - from where some code was used
278 to do the color calculations ...
280 ######################################################################
281 Original Readme and Authors of the Linux VDR Plugin!
282 ######################################################################
284 Written by: Eike Edener <vdr@edener.de>
285 Project's homepage: www.edener.de
286 Latest version available at: www.edener.de
287 See the file COPYING for license information.
288 ----------------------------------------------------------------------
290 for detailed informations visit the VDR-Wiki:
291 http://www.vdr-wiki.de/wiki/index.php/Atmo-plugin
294 http://www.vdr-portal.de/board/thread.php?threadid=48574
299 ----------------------------------------------------------------------