Mumble is an open-source, low-latency, high quality voice chat software.
Go to file
Charles Ricketts 5b104e09c0 PulseAudio: Add options to disable attenuating applications on other audio outputs and to disable attenuation of loopback modules.
Before this commit, Mumble indiscriminately attenuates applications.
A simple example: it would attenuate applications that were set to output
to HDMI -- something that wasn't always desirable. My HDMI wouldn't need
to be attenuated because I am able to physically distinguish between sound
coming from either my HDMI or my laptop and "tune in" accordingly.

A more advanced use case is my PulseAudio streaming setup. I create two
additional sinks: "stream" and "stream_spkr." The "stream" sink is used
when I want to send audio from an application to my stream but not to
my speakers/headset (i.e., background music or something). In this case,
before this commit Mumble would attenuate my program playing the
background music. If I am running Mumble off-stream (which I often am),
this leads the background music volume fluctuating for seemingly no reason.

The second sink, "stream_spkr" routes both to "stream" and my
speakers/headset via two module-loopbacks. In this way, anything I attach
to stream_spkr can be heard both by my viewers and myself.

The option to include attenuation on loopback modules is for advanced
configurations. Loopback modules are used to route audio, usually between
a sink monitor and a sink. Sometimes it might be beneficial to attenuate a
loopback module that goes into Mumble's sink. Sometimes, however it's
inconvenient such as in the case where a user moves an application to
another sink that uses a loopback to Mumble's sink in order to specifically
have Mumble ignore attenuation on that application. But, if the loopback
that carries the non-Mumble sink's audio back to Mumble's sink is attenuated
then there would still be indirect attenuation of that application. In my
configuration, an example is the loopback from stream_spkr.monitor to the
physical speakers.

Only PulseAusio is supported in this patch, but this functionality could
potentially be extended to other audio systems.
2015-05-10 00:45:35 +02:00
.tx Add transifex client configuration for project. 2014-04-27 03:20:48 +02:00
3rdparty Switch from old speex to new speex and speexdsp 2015-05-06 20:22:11 +02:00
3rdPartyLicenses Add MinHook-based overlay for Windows x64. 2015-01-03 19:44:02 +01:00
g15helper g15helper: force 32-bit x86 compilation. 2015-04-22 22:00:29 +02:00
icons Extended icon theming options. 2014-10-27 21:18:23 +01:00
installer Add Finnish to languages in Product.wxs 2015-04-29 17:45:02 +02:00
macx macx/osax: bump OS X overlay version to 19. 2015-02-08 16:56:06 +01:00
man Update man pages author to "the Mumble team" and bump dates. 2014-10-23 23:46:46 +02:00
overlay Use the index variable instead of hardcoding 0 in overlay_exe's GetCommandLineArgs(). 2015-04-22 21:46:55 +02:00
overlay_gl Unify overlay code for Unix and OS X. 2015-02-07 23:24:47 +01:00
overlay_winx64 Build two separate Windows overlays - one for x86 and one for x86_64. 2015-04-22 21:03:39 +02:00
plugins plugins: limit win32-specific plugins to win32. 2014-12-30 22:57:56 +01:00
samples Add sound for recording state change notifications 2010-08-25 23:24:37 +02:00
scripts Add missing LSB Description to the init script. 2015-04-27 22:58:12 +02:00
src PulseAudio: Add options to disable attenuating applications on other audio outputs and to disable attenuation of loopback modules. 2015-05-10 00:45:35 +02:00
toolchain/win32-msvc2013 Add toolchain files. To be used by 32-bit on 64-bit overlay (and vice versa). 2015-04-22 21:03:36 +02:00
.gitignore Build two separate Windows overlays - one for x86 and one for x86_64. 2015-04-22 21:03:39 +02:00
.gitmodules Switch from old speex to new speex and speexdsp 2015-05-06 20:22:11 +02:00
CHANGES Update changelog. 2014-12-28 23:49:46 +01:00
compiler.pri Add force-x86-toolchain and force-x86_64-toolchain to compiler.pri. 2015-04-22 21:03:37 +02:00
Doxyfile Remove 'doc' directory in favour of https://github.com/mumble-voip/mumble-protocol 2015-03-17 20:19:15 +01:00
INSTALL Update INSTALL 2012-09-01 14:58:47 +02:00
LICENSE Update LICENSE file 2014-09-21 01:41:44 +02:00
main.pro Remove tabs from the project file 2015-05-09 10:51:37 +02:00
qt.pri Do not use the qtaccessiblewidgets plugin on Qt 5.4 and greater. 2014-12-24 13:41:49 +01:00
README Fixed typo in the main README 2014-11-04 18:58:41 +01:00
README.Linux fix minor spelling mistake 2015-05-06 00:53:13 +02:00
README.static.linux Add more newbie friendly READMEs to the static servers. 2012-09-20 23:04:10 +02:00
README.static.osx README.static.osx: remove Linux references. 2014-01-25 10:50:59 +01:00
symbols.pri Handle symbol-generation for plugin_bundles on Mac OS X. 2010-02-24 17:26:01 +01:00
winpaths_default.pri mumble, murmur: final adjustments for the win32-static buildenv. 2013-08-25 13:22:38 +02:00
winpaths_static.pri winpaths_static.pri: remove executable bit. 2014-01-12 22:04:35 +01:00

         M U M B L E

 A voicechat utility for gamers

      http://mumble.info/

      #mumble on freenode

Mumble is a voicechat program for gamers written on top of Qt and Speex.

There are two modules in Mumble; the client (mumble) and the server
(murmur). The client works on Win32/64, Linux and Mac OS X, while the
server should work on anything Qt can be installed on.

Note that when we say Win32, we mean Windows XP or newer.

Running Mumble
==============

On Windows, after installation, you should have a new Mumble folder in your
Start Menu, from which you can start Mumble.

On Mac OS X, to install Mumble, drag the application from the downloaded
disk image into your /Applications folder.

Once Mumble is launched, you need a server to connect to. Either create your
own or join a friend's.

Running Murmur on Unix-like systems
===================================

Murmur should be run from the command line, so start a shell (command prompt)
and go to wherever you installed Mumble. Run murmur as

murmurd [-supw <password>] [-ini <inifile>] [-fg] [v]

-supw   Set new password for the user SuperUser, which is hardcoded to
        bypass ACLs. Keep this password safe. Until you set a password,
        the SuperUser is disabled. If you use this option, murmur will
        set the password in the database and then exit.

-ini    Use a inifile other than murmur.ini, use this to run several instances
        of murmur from the same directory. Make sure each instance is using
        a separate database.

-fg     Run in the foreground, logging to standard output.

-v      More verbose logging.

Running Murmur on Mac OS X
==========================

On Mac OS X, Murmur is available inside your Mumble application bundle. If you
copied the Mumble program into your Applications directory, you should be able
to run it by executing:

 /Applications/Mumble.app/Contents/MacOS/murmurd -v -fg

in a Terminal. For more information, please see the 'Running Murmur on Unix-
like sytems' above.

To easily override the default Murmur configuration, a murmur.ini file can be placed in
your user's 'Library/Preferences/Mumble/' directory.

Example configuration files and other scripts can be found inside the Murmur
directory of the Mumble installation disk image.

Running Murmur on Win32
=======================

Doubleclick the Murmur icon to start murmur. There will be a small icon on your
taskbar from which you can view the log.

To set the superuser password, run murmur with the parameters '-supw <password>'.

Bandwidth usage
===============

Mumble will use 10-40 kbit/s outgoing, and the same incoming for each user.
So if there are 10 other users on the server with you, your incoming
bandwidth requirement will be 100-400 kbit/s if they all talk at the same time.