Neo Freerunner audio subsystem

From Openmoko

Revision as of 22:44, 16 March 2010 by Pini (Talk | contribs)

Jump to: navigation, search

The Neo Freerunner (GTA02) inherited the audio subsystem from its older brother the Neo 1973 (GTA01). However, there are a few small differences. This page tries to show and explain the differences and points you to the Neo 1973 page whenever it touches the common points (but there may be overlaps for the sake of usability). As wiki pages are, errors and omissions are likely, and your help is welcomed.

Contents

Differences from Neo 1973

  • There is only 1 (mono) built-in loud speaker (connected to LOUT1) instead of 2 (stereo).
  • The Wolfson Codec driver presents 94 separate controls {switches, multiplexers, and volumes} to the alsa system (in both Neos). Unfortunately they are not mapped exactly the same for the GTA01 as for the GTA02.

Possible sound connections through the Wolfson Codec

  • "Yes" = Confirmed, alsa state file exists.
  • "No" = Not possible / not desirable.
  • "Should" = Should be possible, not confirmed yet.
  • "?" = Have no idea.
- CPU GSM Bluetooth
GSM Yes
Bluetooth  ? Yes
Wired Speaker Yes Yes  ?
Wired Mic Yes Yes  ?
Body Earpiece Should Yes  ?
Body Speaker Yes Should  ?
Body Mic Should Yes  ?

Alsamixer channel controls

The ALSA state files are installed by default, and belong to package "openmoko-alsa-scenarios". To see where the files reside, do "opkg files openmoko-alsa-scenarios". Currently (SHR), they are in "/etc/freesmartphone/alsa/default/gsmhandset"; in other systems, they might be found in "/usr/share/openmoko/scenarios/". Recommended statefile for phone usage is http://docs.openmoko.org/trac/attachment/ticket/2121/gsmhandset.state.new

  1. State: GSM <-> Built-in Handset (file gsmhandset.state)
    1. Mic volume:
      • Control 48: "Mic2 Capture Volume" (alsamixer name: "Mic2". Suggested value: max)
      • Control 12: "Mono Sidetone Playback Volume" (alsamixer name: "Mono sidetone" Suggested value: 5..7(max))
      • Control 5: "Mono Playback Volume" (alsamixer name: "Mono" Value: as needed)
      • Control 63: 'Mic Sidetone Mux' MANDATORY VALUE "Mic 2"!!!
    2. Earpiece volume:
      • Control 6: "Bypass Playback Volume"
      • Control 4: "Speaker Playback Volume"

According to the conclusion of a thread from Dec 09, you might want to set Control 12 to value 5 if people you call complain about background noise, static, etc with the above settings.

For mic settings please refer also to http://wiki.openmoko.org/wiki/Neo_1973_and_Neo_FreeRunner_gsm_modem#AT.25Nxxxx

user should set volume according to own preferences:

for mic the (full, true) procedure is as follows:
reduce #5 by some 15..30 steps
do testcall:
you get very low volume at far end. but tone should be clear, no clipping (sharp agressive noise)
if there is clipping: reduce #48 by one step (i.e. to "2")
then adjust #5 to your preferences and taste
(do `alsactrl store -f gsmhandset.state` to save the changes if you used a mixer to adjust the levels)

for earpiece(-speaker):

level up modem to full volume (AT+CLVL cmd used by framework), 
level up #6 to full volume, 
adjust by #4
if you get clipping when #4 is at moderate level (same as above): reduce #6 (or even AT+CLVL) until clipping vanishes
(very unlikely to occur for earpiece playback)


  1. State: GSM <-> Built-in Handsfree (file gsmspeakerout.state)
    1. Mic volume:
      • Control ?:
    2. Speaker volume:
      • Control ?:
  2. State: GSM <-> Wired Headset (file gsmheadset.state)
    1. Mic volume:
      • Control 49: "Mic1 Capture Volume"
      • Control 12: "Mono Sidetone Playback Volume"
      • Control 5: "Mono Playback Volume"
    2. Speaker volume:
      • Control 6: "Bypass Playback Volume"
      • Control 3: "Headphone Playback Volume"
  3. State: GSM <-> Bluetooth Headset (file ???)
    1. Alternative working state files: [1]
    2. Mic volume:
      • Control 13: "Mono Voice Playback Volume"
      • Control 5: "Mono Playback Volume"
  4. State: CPU <-> Built-in Handset (file voip-handset.state)
    1. Mic volume:
      • Control ?:
    2. Speaker volume:
      • Control ?:
  5. State: CPU <-> Wired Headset (file headset.state)
    1. Stereo sound:
      • Control ?:
    2. Headset output:
      • Control 94: "Amp Spk Switch" <- false
  6. State: CPU <-> Buildin Speaker (file stereoout.state)
    1. Mono sound:
      • Control ?:
    2. Headset output:
      • Control 94: "Amp Spk Switch" <- true
  7. State: CPU -> GSM (file gsmhandset.state)
    1. Mono sound:
      • Control 74: Mono Mixer Left Playback Switch to true
      • Control 75: Mono Mixer Right Playback Switch to true
      • Control 1: PCM Volume suggested value 135
  • These files I still don't know what they are for:

--Femto 12:39, 24 September 2008 (UTC) I've updated above values. Must be checked.

-- I created another state file (voip-handsfree.state) for CPU Handsfree, mixed and matched voip-handset and stereoout. You can find it here. Feel free to make a change to it if there are errors. I don't see any, though.

Volume Control

Angus Ainslie has written a simple python volume control (which is getting more and more sophisticated) using some of these settings.

Installing the GUI mixer

wget http://handheldshell.com/pymixer.py
wget http://handheldshell.com/volume.desktop
cp pymixer.py /usr/bin
chmod u+x /usr/bin/pymixer.py
cp volume.desktop /usr/share/applications
opkg install python-pygtk
opkg install http://handheldshell.com/python-pyalsaaudio_0.3-ml0_armv4t.ipk

If the python script aborts unexpectedly then look here for a fix

You could also try fso-simplemixer.py, a simplified mixer based on the one above.

Empirical Data for Mic Settings

"Experiment 1" in the table means:

  1. Set your controls as follows:
    control.12 (Mono Sidetone Playback Volume): 5
    control.48 (Mic2 Capture): 3
    control.63 (Mic Sidetone Mux): Mic 2
  2. Call another phone from your Neo FreeRunner, mute it's microphone and listen to your voice coming from Neo FreeRunner's microphone. Connect to FreeRunner, run alsamixer and experiment then with control.5 (Mono Playback Volume) by lowering it so that buzzing noise is gone or at an acceptable level. After the noise is reduced, observe the actual volume/clarity of your voice when you speak.
  3. Write result in the table:
    "Positive" if you don't normally use such settings, but you achieved at least similar level of quality while using these settings, quality meaning lack of noise and clarity/volume of voice.
    "Already in use", if you already normally use settings that have control.12/48/63 like above. Write in notes if you experimented with other settings but found out these were superior, or similar.
    "Negative" if you don't normally use such settings, you experimented, but you failed to achieve similar level of quality with the settings above and experimenting with control.5. Please write in the notes how it failed - most typically did you not hear anymore your voice as well after reducing control.5 enough to get rid of the noise, or how did the experiment turn out negative?
    "Not done", if you didn't complete this experiment.
User FR Revision + buzzfix? Microphone Settings in Use Result of Experiment 1 Notes
User:TimoJyrinki A7 control.5: 97
control.12: 5
control.48: 3
control.63: Mic 2
Already in use Able to reach acceptable level of quality with other settings as well, but somewhat less volume can be had with control.63 set to Right PGA before noise starts to be heard (when increasing control.5 and/or control.12 to compensate).
User:TimoJyrinki A5 + buzzfix control.5: 105
control.12: 7
control.48: 3
control.63: Mic 2
Not done  Only checked from a backup, not sure anymore how the audio quality was like. Buzzfix now failing on the device so cannot test. I have used these kind of settings and also earlier control.63 set to Right PGA while increasing control.5.
User:Pini A5 + buzzfix control.5: 127
control.12:: 1
control.48: 1
control.63: Mic 2
In use -
User:YourName A1 + buzzfix control.5: NN
control.12:: N
control.48: N
control.63: NNNN
Not done -
Personal tools

The Neo Freerunner (GTA02) inherited the audio subsystem from its older brother the Neo 1973 (GTA01). However, there are a few small differences. This page tries to show and explain the differences and points you to the Neo 1973 page whenever it touches the common points (but there may be overlaps for the sake of usability). As wiki pages are, errors and omissions are likely, and your help is welcomed.

Differences from Neo 1973

  • There is only 1 (mono) built-in loud speaker (connected to LOUT1) instead of 2 (stereo).
  • The Wolfson Codec driver presents 94 separate controls {switches, multiplexers, and volumes} to the alsa system (in both Neos). Unfortunately they are not mapped exactly the same for the GTA01 as for the GTA02.

Possible sound connections through the Wolfson Codec

  • "Yes" = Confirmed, alsa state file exists.
  • "No" = Not possible / not desirable.
  • "Should" = Should be possible, not confirmed yet.
  • "?" = Have no idea.
- CPU GSM Bluetooth
GSM Yes
Bluetooth  ? Yes
Wired Speaker Yes Yes  ?
Wired Mic Yes Yes  ?
Body Earpiece Should Yes  ?
Body Speaker Yes Should  ?
Body Mic Should Yes  ?

Alsamixer channel controls

The ALSA state files are installed by default, and belong to package "openmoko-alsa-scenarios". To see where the files reside, do "opkg files openmoko-alsa-scenarios". Currently (SHR), they are in "/etc/freesmartphone/alsa/default/gsmhandset"; in other systems, they might be found in "/usr/share/openmoko/scenarios/". Recommended statefile for phone usage is http://docs.openmoko.org/trac/attachment/ticket/2121/gsmhandset.state.new

  1. State: GSM <-> Built-in Handset (file gsmhandset.state)
    1. Mic volume:
      • Control 48: "Mic2 Capture Volume" (alsamixer name: "Mic2". Suggested value: max)
      • Control 12: "Mono Sidetone Playback Volume" (alsamixer name: "Mono sidetone" Suggested value: 5..7(max))
      • Control 5: "Mono Playback Volume" (alsamixer name: "Mono" Value: as needed)
      • Control 63: 'Mic Sidetone Mux' MANDATORY VALUE "Mic 2"!!!
    2. Earpiece volume:
      • Control 6: "Bypass Playback Volume"
      • Control 4: "Speaker Playback Volume"

According to the conclusion of a thread from Dec 09, you might want to set Control 12 to value 5 if people you call complain about background noise, static, etc with the above settings.

For mic settings please refer also to http://wiki.openmoko.org/wiki/Neo_1973_and_Neo_FreeRunner_gsm_modem#AT.25Nxxxx

user should set volume according to own preferences:

for mic the (full, true) procedure is as follows:
reduce #5 by some 15..30 steps
do testcall:
you get very low volume at far end. but tone should be clear, no clipping (sharp agressive noise)
if there is clipping: reduce #48 by one step (i.e. to "2")
then adjust #5 to your preferences and taste
(do `alsactrl store -f gsmhandset.state` to save the changes if you used a mixer to adjust the levels)

for earpiece(-speaker):

level up modem to full volume (AT+CLVL cmd used by framework), 
level up #6 to full volume, 
adjust by #4
if you get clipping when #4 is at moderate level (same as above): reduce #6 (or even AT+CLVL) until clipping vanishes
(very unlikely to occur for earpiece playback)


  1. State: GSM <-> Built-in Handsfree (file gsmspeakerout.state)
    1. Mic volume:
      • Control ?:
    2. Speaker volume:
      • Control ?:
  2. State: GSM <-> Wired Headset (file gsmheadset.state)
    1. Mic volume:
      • Control 49: "Mic1 Capture Volume"
      • Control 12: "Mono Sidetone Playback Volume"
      • Control 5: "Mono Playback Volume"
    2. Speaker volume:
      • Control 6: "Bypass Playback Volume"
      • Control 3: "Headphone Playback Volume"
  3. State: GSM <-> Bluetooth Headset (file ???)
    1. Alternative working state files: [1]
    2. Mic volume:
      • Control 13: "Mono Voice Playback Volume"
      • Control 5: "Mono Playback Volume"
  4. State: CPU <-> Built-in Handset (file voip-handset.state)
    1. Mic volume:
      • Control ?:
    2. Speaker volume:
      • Control ?:
  5. State: CPU <-> Wired Headset (file headset.state)
    1. Stereo sound:
      • Control ?:
    2. Headset output:
      • Control 94: "Amp Spk Switch" <- false
  6. State: CPU <-> Buildin Speaker (file stereoout.state)
    1. Mono sound:
      • Control ?:
    2. Headset output:
      • Control 94: "Amp Spk Switch" <- true
  7. State: CPU -> GSM (file gsmhandset.state)
    1. Mono sound:
      • Control 74: Mono Mixer Left Playback Switch to true
      • Control 75: Mono Mixer Right Playback Switch to true
      • Control 1: PCM Volume suggested value 135
  • These files I still don't know what they are for:

--Femto 12:39, 24 September 2008 (UTC) I've updated above values. Must be checked.

-- I created another state file (voip-handsfree.state) for CPU Handsfree, mixed and matched voip-handset and stereoout. You can find it here. Feel free to make a change to it if there are errors. I don't see any, though.

Volume Control

Angus Ainslie has written a simple python volume control (which is getting more and more sophisticated) using some of these settings.

Installing the GUI mixer

wget http://handheldshell.com/pymixer.py
wget http://handheldshell.com/volume.desktop
cp pymixer.py /usr/bin
chmod u+x /usr/bin/pymixer.py
cp volume.desktop /usr/share/applications
opkg install python-pygtk
opkg install http://handheldshell.com/python-pyalsaaudio_0.3-ml0_armv4t.ipk

If the python script aborts unexpectedly then look here for a fix

You could also try fso-simplemixer.py, a simplified mixer based on the one above.

Empirical Data for Mic Settings

"Experiment 1" in the table means:

  1. Set your controls as follows:
    control.12 (Mono Sidetone Playback Volume): 5
    control.48 (Mic2 Capture): 3
    control.63 (Mic Sidetone Mux): Mic 2
  2. Call another phone from your Neo FreeRunner, mute it's microphone and listen to your voice coming from Neo FreeRunner's microphone. Connect to FreeRunner, run alsamixer and experiment then with control.5 (Mono Playback Volume) by lowering it so that buzzing noise is gone or at an acceptable level. After the noise is reduced, observe the actual volume/clarity of your voice when you speak.
  3. Write result in the table:
    "Positive" if you don't normally use such settings, but you achieved at least similar level of quality while using these settings, quality meaning lack of noise and clarity/volume of voice.
    "Already in use", if you already normally use settings that have control.12/48/63 like above. Write in notes if you experimented with other settings but found out these were superior, or similar.
    "Negative" if you don't normally use such settings, you experimented, but you failed to achieve similar level of quality with the settings above and experimenting with control.5. Please write in the notes how it failed - most typically did you not hear anymore your voice as well after reducing control.5 enough to get rid of the noise, or how did the experiment turn out negative?
    "Not done", if you didn't complete this experiment.
User FR Revision + buzzfix? Microphone Settings in Use Result of Experiment 1 Notes
User:TimoJyrinki A7 control.5: 97
control.12: 5
control.48: 3
control.63: Mic 2
Already in use Able to reach acceptable level of quality with other settings as well, but somewhat less volume can be had with control.63 set to Right PGA before noise starts to be heard (when increasing control.5 and/or control.12 to compensate).
User:TimoJyrinki A5 + buzzfix control.5: 105
control.12: 7
control.48: 3
control.63: Mic 2
Not done  Only checked from a backup, not sure anymore how the audio quality was like. Buzzfix now failing on the device so cannot test. I have used these kind of settings and also earlier control.63 set to Right PGA while increasing control.5.
User:Pini A5 + buzzfix control.5: 127
control.12:: 1
control.48: 1
control.63: Mic 2
In use -
User:YourName A1 + buzzfix control.5: NN
control.12:: N
control.48: N
control.63: NNNN
Not done -