]> git.mxchange.org Git - flightgear.git/blob - src/Network/native_ctrls.cxx
MSVC fix from Frederic Bouvier
[flightgear.git] / src / Network / native_ctrls.cxx
1 // native_ctrls.cxx -- FGFS "Native" controls I/O class
2 //
3 // Written by Curtis Olson, started July 2001.
4 //
5 // Copyright (C) 2001  Curtis L. Olson - curt@flightgear.org
6 //
7 // This program is free software; you can redistribute it and/or
8 // modify it under the terms of the GNU General Public License as
9 // published by the Free Software Foundation; either version 2 of the
10 // License, or (at your option) any later version.
11 //
12 // This program is distributed in the hope that it will be useful, but
13 // WITHOUT ANY WARRANTY; without even the implied warranty of
14 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
15 // General Public License for more details.
16 //
17 // You should have received a copy of the GNU General Public License
18 // along with this program; if not, write to the Free Software
19 // Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
20 //
21 // $Id$
22
23
24 #ifdef HAVE_CONFIG_H
25 #  include <config.h>
26 #endif
27
28 #include <simgear/debug/logstream.hxx>
29 #include <simgear/io/iochannel.hxx>
30 #include <simgear/io/lowlevel.hxx> // endian tests
31
32 #include <FDM/flight.hxx>
33 #include <Main/fg_props.hxx>
34 #include <Scenery/scenery.hxx>  // ground elevation
35
36 #include "native_ctrls.hxx"
37
38 // FreeBSD works better with this included last ... (?)
39 #if defined(WIN32) && !defined(__CYGWIN__)
40 #  include <windows.h>
41 #else
42 #  include <netinet/in.h>       // htonl() ntohl()
43 #endif
44
45
46 FGNativeCtrls::FGNativeCtrls() {
47 }
48
49 FGNativeCtrls::~FGNativeCtrls() {
50 }
51
52
53 // open hailing frequencies
54 bool FGNativeCtrls::open() {
55     if ( is_enabled() ) {
56         SG_LOG( SG_IO, SG_ALERT, "This shouldn't happen, but the channel " 
57                 << "is already in use, ignoring" );
58         return false;
59     }
60
61     SGIOChannel *io = get_io_channel();
62
63     if ( ! io->open( get_direction() ) ) {
64         SG_LOG( SG_IO, SG_ALERT, "Error opening channel communication layer." );
65         return false;
66     }
67
68     set_enabled( true );
69
70     return true;
71 }
72
73
74 // The function htond is defined this way due to the way some
75 // processors and OSes treat floating point values.  Some will raise
76 // an exception whenever a "bad" floating point value is loaded into a
77 // floating point register.  Solaris is notorious for this, but then
78 // so is LynxOS on the PowerPC.  By translating the data in place,
79 // there is no need to load a FP register with the "corruped" floating
80 // point value.  By doing the BIG_ENDIAN test, I can optimize the
81 // routine for big-endian processors so it can be as efficient as
82 // possible
83 static void htond (double &x)   
84 {
85     if ( sgIsLittleEndian() ) {
86         int    *Double_Overlay;
87         int     Holding_Buffer;
88     
89         Double_Overlay = (int *) &x;
90         Holding_Buffer = Double_Overlay [0];
91     
92         Double_Overlay [0] = htonl (Double_Overlay [1]);
93         Double_Overlay [1] = htonl (Holding_Buffer);
94     } else {
95         return;
96     }
97 }
98
99
100 // Populate the FGNetCtrls structure from the property tree.
101 void FGProps2NetCtrls( FGNetCtrls *net, bool net_byte_order ) {
102     int i;
103
104     SGPropertyNode * node = fgGetNode("/controls", true);
105
106     // fill in values
107     net->version = FG_NET_CTRLS_VERSION;
108     net->aileron = node->getDoubleValue( "aileron" );
109     net->elevator = node->getDoubleValue( "elevator" );
110     net->elevator_trim = node->getDoubleValue( "elevator-trim" );
111     net->rudder = node->getDoubleValue( "rudder" );
112     net->flaps = node->getDoubleValue( "flaps" );
113     net->flaps_power
114             = node->getDoubleValue( "/systems/electrical/outputs/flaps",
115                                     1.0 ) >= 1.0;
116     net->num_engines = FGNetCtrls::FG_MAX_ENGINES;
117     for ( i = 0; i < FGNetCtrls::FG_MAX_ENGINES; ++i ) {
118         net->throttle[i] = node->getDoubleValue( "throttle", 0.0 );
119         net->mixture[i] = node->getDoubleValue( "mixture", 0.0 );
120         net->fuel_pump_power[i]
121             = node->getDoubleValue( "/systems/electrical/outputs/fuel-pump",
122                                     1.0 ) >= 1.0;
123         net->prop_advance[i] = node->getDoubleValue( "propeller-pitch", 0.0 );
124         net->magnetos[i] = node->getIntValue( "magnetos", 0 );
125         if ( i == 0 ) {
126           // cout << "Magnetos -> " << node->getIntValue( "magnetos", 0 );
127         }
128         net->starter_power[i]
129             = node->getDoubleValue( "/systems/electrical/outputs/starter",
130                                     1.0 ) >= 1.0;
131         if ( i == 0 ) {
132           // cout << " Starter -> " << node->getIntValue( "stater", false )
133           //      << endl;
134         }
135     }
136     net->num_tanks = FGNetCtrls::FG_MAX_TANKS;
137     for ( i = 0; i < FGNetCtrls::FG_MAX_TANKS; ++i ) {
138         if ( node->getChild("fuel-selector", i) != 0 ) {
139             net->fuel_selector[i]
140                 = node->getChild("fuel-selector", i)->getDoubleValue();
141         } else {
142             net->fuel_selector[i] = false;
143         }
144     }
145     net->num_wheels = FGNetCtrls::FG_MAX_WHEELS;
146     for ( i = 0; i < FGNetCtrls::FG_MAX_WHEELS; ++i ) {
147         if ( node->getChild("brakes", i) != 0 ) {
148             if ( node->getChild("parking-brake")->getDoubleValue() > 0.0 ) {
149                 net->brake[i] = 1.0;
150            } else {
151                 net->brake[i]
152                     = node->getChild("brakes", i)->getDoubleValue();
153             }
154         } else {
155             net->brake[i] = 0.0;
156         }
157     }
158
159     node = fgGetNode("/controls/switches", true);
160     net->master_bat = node->getChild("master-bat")->getBoolValue();
161     net->master_alt = node->getChild("master-alt")->getBoolValue();
162     net->master_avionics = node->getChild("master-avionics")->getBoolValue();
163
164     net->wind_speed_kt = fgGetDouble("/environment/wind-speed-kt");
165     net->wind_dir_deg = fgGetDouble("/environment/wind-from-heading-deg");
166
167     // cur_fdm_state->get_ground_elev_ft() is what we want ... this
168     // reports the altitude of the aircraft.
169     // "/environment/ground-elevation-m" reports the ground elevation
170     // of the current view point which could change substantially if
171     // the user is switching views.
172     net->hground = cur_fdm_state->get_ground_elev_ft() * SG_FEET_TO_METER;
173     net->magvar = fgGetDouble("/environment/magnetic-variation-deg");
174     net->speedup = fgGetInt("/sim/speed-up");
175     net->freeze = 0;
176     if ( fgGetBool("/sim/freeze/master") ) {
177         net->freeze |= 0x01;
178     }
179     if ( fgGetBool("/sim/freeze/position") ) {
180         net->freeze |= 0x02;
181     }
182     if ( fgGetBool("/sim/freeze/fuel") ) {
183         net->freeze |= 0x04;
184     }
185
186     if ( net_byte_order ) {
187         // convert to network byte order
188         net->version = htonl(net->version);
189         htond(net->aileron);
190         htond(net->elevator);
191         htond(net->elevator_trim);
192         htond(net->rudder);
193         htond(net->flaps);
194         net->flaps_power = htonl(net->flaps_power);
195         for ( i = 0; i < FGNetCtrls::FG_MAX_ENGINES; ++i ) {
196             htond(net->throttle[i]);
197             htond(net->mixture[i]);
198             net->fuel_pump_power[i] = htonl(net->fuel_pump_power[i]);
199             htond(net->prop_advance[i]);
200             net->magnetos[i] = htonl(net->magnetos[i]);
201             net->starter_power[i] = htonl(net->starter_power[i]);
202         }
203         net->num_engines = htonl(net->num_engines);
204         for ( i = 0; i < FGNetCtrls::FG_MAX_TANKS; ++i ) {
205             net->fuel_selector[i] = htonl(net->fuel_selector[i]);
206         }
207         net->num_tanks = htonl(net->num_tanks);
208         for ( i = 0; i < FGNetCtrls::FG_MAX_WHEELS; ++i ) {
209             htond(net->brake[i]);
210         }
211         net->num_wheels = htonl(net->num_wheels);
212         net->gear_handle = htonl(net->gear_handle);
213         net->master_bat = htonl(net->master_bat);
214         net->master_alt = htonl(net->master_alt);
215         net->master_avionics = htonl(net->master_avionics);
216         htond(net->wind_speed_kt);
217         htond(net->wind_dir_deg);
218         htond(net->hground);
219         htond(net->magvar);
220         net->speedup = htonl(net->speedup);
221         net->freeze = htonl(net->freeze);
222     }
223 }
224
225
226 // Update the property tree from the FGNetCtrls structure.
227 void FGNetCtrls2Props( FGNetCtrls *net, bool net_byte_order ) {
228     int i;
229
230     SGPropertyNode * node = fgGetNode("/controls", true);
231
232     if ( net_byte_order ) {
233         // convert from network byte order
234         net->version = htonl(net->version);
235         htond(net->aileron);
236         htond(net->elevator);
237         htond(net->elevator_trim);
238         htond(net->rudder);
239         htond(net->flaps);
240         net->flaps_power = htonl(net->flaps_power);
241         net->num_engines = htonl(net->num_engines);
242         for ( i = 0; i < net->num_engines; ++i ) {
243             net->magnetos[i] = htonl(net->magnetos[i]);
244             net->starter_power[i] = htonl(net->starter_power[i]);
245             htond(net->throttle[i]);
246             htond(net->mixture[i]);
247             net->fuel_pump_power[i] = htonl(net->fuel_pump_power[i]);
248             htond(net->prop_advance[i]);
249         }
250         net->num_tanks = htonl(net->num_tanks);
251         for ( i = 0; i < net->num_tanks; ++i ) {
252             net->fuel_selector[i] = htonl(net->fuel_selector[i]);
253         }
254         net->num_wheels = htonl(net->num_wheels);
255         for ( i = 0; i < net->num_wheels; ++i ) {
256             htond(net->brake[i]);
257         }
258         net->gear_handle = htonl(net->gear_handle);
259         net->master_bat = htonl(net->master_bat);
260         net->master_alt = htonl(net->master_alt);
261         net->master_avionics = htonl(net->master_avionics);
262         htond(net->wind_speed_kt);
263         htond(net->wind_dir_deg);
264         htond(net->hground);
265         htond(net->magvar);
266         net->speedup = htonl(net->speedup);
267         net->freeze = htonl(net->freeze);
268     }
269
270     if ( net->version != FG_NET_CTRLS_VERSION ) {
271         SG_LOG( SG_IO, SG_ALERT,
272                 "Version mismatch with raw controls packet format." );
273         SG_LOG( SG_IO, SG_ALERT,
274                 "FlightGear needs version = " << FG_NET_CTRLS_VERSION
275                 << " but is receiving version = "  << net->version );
276     }
277
278     node->setDoubleValue( "aileron", net->aileron );
279     node->setDoubleValue( "elevator", net->elevator );
280     node->setDoubleValue( "elevator-trim", net->elevator_trim );
281     node->setDoubleValue( "rudder", net->rudder );
282     node->setDoubleValue( "flaps", net->flaps );
283
284     fgSetBool( "/systems/electrical/outputs/flaps", net->flaps_power );
285
286     for ( i = 0; i < FGNetCtrls::FG_MAX_ENGINES; ++i ) {
287         node->getChild( "throttle", i )->setDoubleValue( net->throttle[i] );
288         node->getChild( "mixture", i )->setDoubleValue( net->mixture[i] );
289         node->getChild( "propeller-pitch", i )
290             ->setDoubleValue( net->prop_advance[i] );
291         node->getChild( "magnetos", i )->setDoubleValue( net->magnetos[i] );
292     }
293
294     fgSetBool( "/systems/electrical/outputs/fuel-pump",
295                net->fuel_pump_power[0] );
296     fgSetBool( "/systems/electrical/outputs/starter",
297                net->starter_power[0] );
298
299     for ( i = 0; i < FGNetCtrls::FG_MAX_TANKS; ++i ) {
300         node->getChild( "fuel-selector", i )
301             ->setBoolValue( net->fuel_selector[i] );
302     }
303     for ( i = 0; i < FGNetCtrls::FG_MAX_WHEELS; ++i ) {
304         node->getChild( "brakes", i )->setDoubleValue( net->brake[i] );
305     }
306
307     node->setBoolValue( "gear-down", net->gear_handle );
308
309     node = fgGetNode( "/controls/switches", true );
310     node->setBoolValue( "master-bat", net->master_bat );
311     node->setBoolValue( "master-alt", net->master_alt );
312     node->setBoolValue( "master-avionics", net->master_avionics );
313     
314     node = fgGetNode( "/environment", true );
315     node->setBoolValue( "wind-speed-kt", net->wind_speed_kt );
316     node->setBoolValue( "wind-from-heading-deg", net->wind_dir_deg );
317     node->setBoolValue( "magnetic-variation-deg", net->magvar );
318
319     // ground elevation ???
320
321     fgSetInt( "/sim/speed-up", net->speedup );
322
323     node = fgGetNode( "/sim/freeze", true );
324     node->setBoolValue( "master", net->freeze & 0x01 );
325     node->setBoolValue( "position", net->freeze & 0x02 );
326     node->setBoolValue( "fuel", net->freeze & 0x04 );
327 }
328
329
330 // process work for this port
331 bool FGNativeCtrls::process() {
332     SGIOChannel *io = get_io_channel();
333     int length = sizeof(FGNetCtrls);
334
335     if ( get_direction() == SG_IO_OUT ) {
336         // cout << "size of cur_fdm_state = " << length << endl;
337
338         FGProps2NetCtrls( &net_ctrls );
339
340         if ( ! io->write( (char *)(& net_ctrls), length ) ) {
341             SG_LOG( SG_IO, SG_ALERT, "Error writing data." );
342             return false;
343         }
344     } else if ( get_direction() == SG_IO_IN ) {
345         if ( io->get_type() == sgFileType ) {
346             if ( io->read( (char *)(& net_ctrls), length ) == length ) {
347                 SG_LOG( SG_IO, SG_DEBUG, "Success reading data." );
348                 FGNetCtrls2Props( &net_ctrls );
349             }
350         } else {
351             while ( io->read( (char *)(& net_ctrls), length ) == length ) {
352                 SG_LOG( SG_IO, SG_DEBUG, "Success reading data." );
353                 FGNetCtrls2Props( &net_ctrls );
354             }
355         }
356     }
357
358     return true;
359 }
360
361
362 // close the channel
363 bool FGNativeCtrls::close() {
364     SGIOChannel *io = get_io_channel();
365
366     set_enabled( false );
367
368     if ( ! io->close() ) {
369         return false;
370     }
371
372     return true;
373 }