FGCom 3.0: Difference between revisions

3,241 bytes removed ,  19 November 2020
m
 
(27 intermediate revisions by 6 users not shown)
Line 5: Line 5:
|developmentstatus  = Active
|developmentstatus  = Active
|license            = GNU GPL v2
|license            = GNU GPL v2
|website            = http://gitorious.org/fg/flightgear
|website            = http://fgcom.flightgear.org
}}
}}


Line 26: Line 26:
* If you are not using FlightGear 3.0 or higher you have to read the [[FGCom_3.0#FGCom_standalone|FGCom standalone section]] and follow "If FlightGear is not installed" instructions.
* If you are not using FlightGear 3.0 or higher you have to read the [[FGCom_3.0#FGCom_standalone|FGCom standalone section]] and follow "If FlightGear is not installed" instructions.


= FGCom 3.0 Builtin =
<br/><br/>
This is concerning the now internal FGCom within FlightGear-3.0 versions, and later versions of FlightGear.


== Installation ==
= FGCom Builtin =
 
=== Installation ===
The good news here is that FlightGear has now an FGCom client built in the software. That means there is no additional installation step. If you have installed FlightGear you can immediately use FGCom.
The good news here is that FlightGear has now an FGCom client built in the software. That means there is no additional installation step. If you have installed FlightGear you can immediately use FGCom.


=== Linux ALSA Sound ===
=== How to start FGCom builtin ? ===
By defaults, most Linux ALSA systems should just work.  This is because by default Linux ALSA utilizes the DMix plugin when there is no $HOME/.asoundrc file.  Linux ALSA also, by default when using DMix unless further customized, resamples all audio to 48000hz.  If this is not the case, or if you speculate customizations have been performed by your Linux distribution, you may need to read further below on how to ensure ALSA's DMix and DSnoop plugins are used with FlightGear & FGCom.  The common side effect of possible customizations, FGCom does not playback (or record) sound.
 
(Reference [[Linux software audio mixing with FlightGear]]) <br />
 
Check your Home-directory (“~/” or $HOME) for a file "'''.alsoftrc'''"
(Remember that the “show hidden files” must be enabled!)
 
Copied over from [[FGCOM Testing]] or FGCOM Testing Wiki page.
 
==== If using Creative Labs' OpenAL library (or older OpenAL version)  ====
Check if you are using the old Creative Labs OpenAL library (or old version) which uses the ".openalrc" configuration file.  If so, you can put something like this within ".openalrc":
 
$HOME/.openalrc
<pre>
(define devices '(alsa))
(define alsa-out-device "plug:dmix")
(device alsa-in-device "plug:dsnoop")
</pre>
 
==== If using OpenAL Soft (or newer OpenAL version) ====
It is more likely users of more recent Linux distributions are using this newer OpenAL Soft package, instead of the previously mentioned older Create Labs' OpenAL.  (Hence, the likely rational for renaming the default configuration file to something other than the more common previous naming format.)
 
Copy either the be /etc/openal/alsoft.conf, /usr/share/doc/openal-1.15.1-r2/alsoftrc.sample.bz2, or create a new $HOME/.alsoftrc file and insert the following:
 
<pre><nowiki>
format = AL_FORMAT_STEREO16
cf_level = 1
drivers = alsa
[alsa]
device = plug:dmix
capture = plug:dsnoop
</nowiki></pre>
 
[NOTE: format is now "sample-type = uint16", and cf_level would appear not needed for typical users, or only desired for headphone users.]
 
The system wide OpenAL-soft configuration file may be /etc/openal/alsoft.conf or similar. It usually contains comments describing all possible configuration options.
<br /><br />
 
==== Linux ALSA Audiophiles avoiding Dmix ====
For audiophiles using Linux ALSA and with their custom $HOME/.asoundrc file preventing DMix usage, make sure you have both specified "device = plug:dmix" as well as "capture = plug:dsnoop".  Per ALSA's page, "dsnoop is the equivalent of the dmix plugin, but for recording sound."  Without specifying using dsnoop for the capture device alongside your $HOME/.asoundrc file preventing DMix usage, you will likely only get silence played back when usage FGCom.  FGCom is not working at this point, as the sound device is likely still locked by your $HOME/.asoundrc file and only recording silence or playing back silence during the echo test!
 
==== Using ALSA Custom "plug:" Filters ====
The OpenAL Soft (or the newer version of OpenAL) $HOME/.alsoftrc file also accepts using other $HOME/.asoundrc "plug:" incanatations, such as sections containing Dmix - alsa.opensrc.org's "pcm.dmixs51" customization for using DMix with 5.1 Surround Sound, and called as:
 
<pre>$ aplay -D "plug:dmixs51" Some_PCM_WAV_File.wav </pre>
 
$HOME/.alsoftrc
<pre>
"device = plug:dmixs51"
</pre>
 
Just remember to also uncomment layout_surround51, and note the likely fact FlightGear is still only using Stereo sound (or two channel audio) and is only set here for an example!
 
= How to start FGCom builtin ? =
# Start FlightGear
# Start FlightGear
# Open the dialog located in "Multiplayer > FGCom Settings"
# Open the dialog located in "Multiplayer > FGCom Settings"
Line 98: Line 45:
FGCom will be automatically enabled for your future sessions until you uncheck the "Enable" checkbox.
FGCom will be automatically enabled for your future sessions until you uncheck the "Enable" checkbox.


= How to test your setup ? =
=== How to test your setup ? ===
In order to check that your microphone and speakers are correctly connected and functional you can test it with the following steps:
In order to check that your microphone and speakers are correctly connected and functional you can test it with the following steps:


== Activate Testing ==
# Start FlightGear (if not yet done of course)
# Start FlightGear (if not yet done of course)
# Open the dialog located in "Multiplayer > FGCom Settings"
# Open the dialog located in "Multiplayer > FGCom Settings"
# Check the "Enabled" checkbox (If not yet already done.)
# Check the "Enabled" checkbox (If not yet already done.)
# Check the "Display messages" checkbox.  (Displays FGCom's messages within the FlightGear's console.)
# Check the "Display messages" checkbox.  (Displays FGCom's messages on screen)
# Check the "Echo test" checkbox.  (Connects to frequency 910.0, for loopback testing of your microphone record/capture device.)
# Check the "Echo test" checkbox <br/><br/>At this moment you should hear your own voice with a delay. If you can't hear your own voice it means your microphone or your speakers are wrongly set.<br/>To further check your "Echo test", see [http://fgcom.flightgear.org/history.php Live FGCom]<br/><br/>
 
At this moment you should hear your own voice with a delay. If you can't hear your own voice it means your microphone or your speakers are wrongly set.
 
To further check your "Echo test" using the builtin host Echo Test (ie. frequency 910.0) loopback and FGCom's server logs, see [http://fgcom.flightgear.org/history.php Live FGCom].  (It maybe useful to give yourself a unique Call Sign, or --callsign=ICanEchoWell via command line options.)
 
== Deactivate Testing ==
# Unckeck the "Echo test" checkbox, and/or other boxes as desired.
# Unckeck the "Echo test" checkbox, and/or other boxes as desired.
# You can also check that your PTT works fine looking at the "PTT test" checkbox when you press your PTT button (default is {{Key press|Space}})
# Close the dialog
# Close the dialog


= How to use FGCom builtin ? =
=== How to use FGCom builtin ? ===
Once you started FGCom from the [[FGCom_3.0#How_to_start_FGCom_builtin_.3F|How to start FGCom builtin]] procedure, you can simply use your radio stack like it done in real life.
Once you started FGCom from the [[FGCom_3.0#How_to_start_FGCom_builtin_.3F|How to start FGCom builtin]] procedure, you can simply use your radio stack like it done in real life.


Line 125: Line 66:
[[File:FGCom dialog.png|thumb|FGCom dialog]]
[[File:FGCom dialog.png|thumb|FGCom dialog]]


[NOTE: It maybe desireable to keep FGCom's Settings "Display messages" activated, to verify these FGCom related keys are working properly!]
NOTE: It maybe desirable to keep FGCom's Settings "Display messages" activated, to verify these FGCom related keys are working properly.


= Dialog details =
=== Dialog details ===
The dialog located in "Multiplayer > FGCom Settings" provide some features described here:
The dialog located in "Multiplayer > FGCom Settings" provide some features described here:


* Enable : you can check/uncheck this for enable/disable FGCom feature
* Enable : you can check/uncheck this for enable/disable FGCom feature
* Display messages : display FGCom transaction message for debug only
* Display messages : display FGCom transaction message for debug only
* Test : check/uncheck this for testing server communication (Echo-Box)
* Echo test : check/uncheck this for testing server communication (Echo-Box)
* PTT test : when you press your PTT this checkbox will be checked
* Speaker volume : set speaker volume for FGCom built-in
* Speaker volume : set speaker volume for FGCom built-in
* Silence threshold : set the limit, in dB, when FGCom consider no voice in your microphone
* Server > List : Select the server to be connected (immediat effect)
* Server > List : Select the server to be connected (immediat effect)
<br/><br/>


= FGCom standalone =
= FGCom standalone =
Line 140: Line 85:
'''If FlightGear is installed:'''
'''If FlightGear is installed:'''


The good news here is that if you have FlightGear installed on your computer you already have FGCom standalone !
The good news here is that if you have FlightGear installed on your computer you already have FGCom standalone!




Line 147: Line 92:
If you haven't installed FlightGear on the computer where you want to use FGCom standalone you can simply download FGCom standalone with the following steps:
If you haven't installed FlightGear on the computer where you want to use FGCom standalone you can simply download FGCom standalone with the following steps:


# Download FGCom standalone: [http://fgcom.flightgear.org/download/fgcom-3.0.0_win32.zip Windows] | [http://fgcom.flightgear.org/download/fgcom-3.0.0_linux32.zip Linux 32 bits] | [http://fgcom.flightgear.org/download/fgcom-3.0.0_linux64.zip Linux 64 bits] | [http://fgcom.flightgear.org/download/fgcom-3.0.0_mac.zip Mac] (take care to select the correct version for your computer !)
# Download FGCom standalone: [http://build.flightgear.org:8080/job/FGCom-Win/lastStableBuild/artifact/*zip*/archive.zip Windows] | [http://build.flightgear.org:8080/job/FGCom/lastStableBuild/artifact/*zip*/archive.zip Linux] | [http://build.flightgear.org:8080/job/FGCom-Mac/lastStableBuild/artifact/*zip*/archive.zip Mac] (take care to select the correct version for your computer!)
# Unzip the downloaded file
# Unzip the downloaded file
# That's all ! Of course you can place the "FGCom" folder where you want on your computer
# That's all! Of course you can place the "FGCom" folder where you want on your computer


On Linux, you have to [http://www.pilotlogic.com/sitejoom/index.php/95-wiki/codetyphon-studio/installation/linux-install/206-linux-give-executable-permission#h1-method-1 setup the permission as "executable"] for the files "run_fgcom.sh" and "test_fgcom.sh"
On Linux, you have to [http://www.pilotlogic.com/sitejoom/index.php/95-wiki/codetyphon-studio/installation/linux-install/206-linux-give-executable-permission#h1-method-1 setup the permission as "executable"] for the files "run_fgcom.sh" and "test_fgcom.sh"
Line 175: Line 120:


Now a terminal has been opened and you should be able to see the following lines:
Now a terminal has been opened and you should be able to see the following lines:
  Successfully parsed commandline options
  FGCom 3.3.0 compiled Dec 30 2014, at 17:19:39
Loaded file [../share/flightgear/special_frequencies.txt].
  For help usage, use --help
  Reading airports [../share/flightgear/positions.txt]
  Starting FGCom session as guest:xxxxxxxxx@fgcom.flightgear.org
  loaded 46927 entries
Loading aiports informations...
Initializing IAX client as guest:xxxxxxxxxxx@fgcom.flightgear.org
 
In order to stop FGCom standalone you have to press {{Key press|Control}} + {{Key press|c}}
 


=== How to test your setup ? ===
=== How to test your setup ? ===
Line 203: Line 150:


Now you should be able to hear your own voice with a delay and see the following lines:
Now you should be able to hear your own voice with a delay and see the following lines:
  Successfully parsed commandline options
  FGCom 3.3.0 compiled Dec 30 2014, at 17:19:39
Loaded file [../share/flightgear/special_frequencies.txt].
  For help usage, use --help
  Reading airports [../share/flightgear/positions.txt]
  Starting FGCom session as guest:xxxxxxxxx@fgcom.flightgear.org
  loaded 46927 entries
  Message: Call 0 accepted
Initializing IAX client as guest:xxxxxxxxxxx@fgcom.flightgear.org
  Message: Echo Box - For testing FGCOM
  Originating an audio only call
  Message: Call 0 answered
Call 0 accepted
  Echo Box - For testing FGCOM
  Call 0 answered


In order to stop FGCom standalone you have to press {{Key press|Control}} + {{Key press|c}}
In order to stop FGCom standalone you have to press {{Key press|Control}} + {{Key press|c}}
Line 233: Line 177:
=== Options details ===
=== Options details ===


Starting FGCom standalone with "-h" argument will show you all available options.  
Starting FGCom standalone with "--help" argument will show you all the available options.


'''IMPORTANT:''' Keep in mind that FGCom standalone works fine for a standard operating system without options at all ! Use them only if you know exactly what they do.
'''IMPORTANT:''' Keep in mind that FGCom standalone works fine for a standard operating system without options at all ! Use them only if you know exactly what they do.


= FAQ =
= FAQ =
== How to add the --generic option for FGCom standalone ? ==
''' How to add the --generic option for FGCom standalone ? '''


Since FlightGear 3.0 you can select "FGCom standalone" in the [[FlightGear_Launch_Control#Network|FlightGear Launcher > Advanced > Network]] section else:
Since FlightGear 3.0 you can select "FGCom standalone" in the [[FlightGear_Launch_Control#Network|FlightGear Launcher > Advanced > Network]] section else:
Line 252: Line 196:
* Generic  : fgcom
* Generic  : fgcom


== I want to use FGCom builtin but I haven't any item "Multiplayer > FGCom Settings" in FlightGear ==
''' I want to use FGCom builtin but I haven't any item "Multiplayer > FGCom Settings" in FlightGear '''


Because you are not using FlightGear 3.0 or higher. FGCom builtin is only available for FlightGear 3.0 or higher. You have to use FGCom standalone until you upgrade your FlightGear installation.
Because you are not using FlightGear 3.0 or higher. FGCom builtin is only available for FlightGear 3.0 or higher. You have to use FGCom standalone until you upgrade your FlightGear installation.


== I want to use FGCom standalone but I haven't any FGCom item in "Start menu > FlightGear > Tools" ==
''' I want to use FGCom standalone but I haven't any FGCom item in "Start menu > FlightGear > Tools" '''


Because you are not using FlightGear 3.0 or higher. FGCom standalone is automatically installed only for FlightGear 3.0 or higher.  
Because you are not using FlightGear 3.0 or higher. FGCom standalone is automatically installed only for FlightGear 3.0 or higher.  
Line 262: Line 206:
You have to follow "If FlightGear is not installed" instructions until you upgrade your FlightGear installation.
You have to follow "If FlightGear is not installed" instructions until you upgrade your FlightGear installation.


== I'm using FGCom standalone, other pilots can hear me but I can't hear other pilots ==
''' I'm using FGCom standalone, other pilots can hear me but I can't hear other pilots '''


Be sure the slider "ATC" from the File > Sound configuration dialog is at full right.
Be sure the slider "ATC" from the File > Sound configuration dialog is at full right.


''' I'm using Linux and I can't get FGCom working '''
Please read this page which has a lot of information about audio configuration for Linux user, even some specific reference to FGCom: [[Linux software audio mixing with FlightGear]]
== Related content ==
=== Wiki articles ===
* [[FGCom-mumble]] - a Mumble based implementation
=== Source code ===
* {{flightgear source|path=src/Network/fgcom.hxx}}
* {{flightgear source|path=src/Network/fgcom.cxx}}


[[fr:FGCom 3.0]]
[[fr:FGCom 3.0]]
[[es:FGCom 3.0]]
[[Category:FGCom]]
[[Category:FGCom]]
[[Category:Menubar]]
601

edits