Multimedia keyboard buttons configuration for Openbox

[melodie]

Hi unist,

If you have more questions about howto tweak the rc.xml file, don't hesitate to ask. And very Happy Year 2012 to you too ! And to all

[unist]

Well, I am trying.

On my system doing set | grep BROWSER shows:

BROWSER=/usr/bin/www-browser

and set | grep MAIL shows:

MAIL=/var/spool/mail/myname
MAILCHECK=60

Searching in xev I found:

keycode 123 XF86AudioRaiseVolume
keycode 122 XF86AudioLowerVolume
keycode 172 XF86AudioPlayVolume
keycode 174 XF86AudioStop
keycode 179 XF86Tools
keycode 163 XF86Mail
keycode 152 XF86Explorer

Those are my 7 hotkeys

For the modification to rc.xml I think these would be the additional lines:

</ keyboard>
<keybind key="XF86AudioRaiseVolume">
<action name="Execute">
<command> UMPlayer </ command>
</action>
</ keybind>
</ keyboard>
<keybind key="XF86AudioLowerVolume">
<action name="Execute">
<command> UMPlayer </ command>
</action>
</ keybind>
</ keyboard>
<keybind key="XF86AudioPlay">
<action name="Execute">
<command> UMPlayer </ command>
</action>
</ keybind>
</ keyboard>
<keybind key="XF86AudioStop">
<action name="Execute">
<command> UMPlayer </ command>
</action>
</ keybind>
</ keyboard>
<keybind key="XF86Tools">
<action name="Execute">
<command> which-program </ command>
</action>
</ keybind>
</ keyboard>
<keybind key="XF86Mail">
<action name="Execute">
<command> Sylpheed </ command>
</action>
</ keybind>
</ keyboard>
<keybind key="XF86Explorer">
<action name="Execute">
<command> Firefox </ command>
</action>
</ keybind>
</ keyboard>

For Tools I don't know which program use.

I don't know either for what I will use the keycodes numbers that I found in xev

Am I in the right track?

[djohnston]

For Tools I don't know which program use.

I don't know either for what I will use the keycodes numbers that I found in xev

Am I in the right track?

Yes, you are on the right track. Not familiar with doing this myself, I would say make a backup copy of your original ~/.config/openbox/rc.xml file first. Then edit the original. After editing, log out and log back in again. See if the keybindings are working. If not, I believe you'll need to use the keycode numbers. For example, change:

<keybind key="XF86AudioRaiseVolume">
<action name="Execute">
<command> UMPlayer </ command>

to:

<keybind key="0x123">
<action name="Execute">
<command> UMPlayer </ command>

Here's some additional information from the Openbox wiki. For Tools, you can call any installed program you want to associate with that keybinding. For example, you might want to call PCLinuxOS Control Center (Configure Your Computer) by entering:

<keybind key="XF86Tools">
<action name="Execute">
<command> pcc </ command>

or:

<keybind key="0x179">
<action name="Execute">
<command> pcc </ command>

[melodie]

For the modification to rc.xml I think these would be the additional lines:

</ keyboard>
<keybind key="XF86AudioRaiseVolume">
<action name="Execute">
<command> UMPlayer </ command>
</action>
</ keybind>
</ keyboard>
<keybind key="XF86AudioLowerVolume">
<action name="Execute">
<command> UMPlayer </ command>
</action>
</ keybind>
</ keyboard>
<keybind key="XF86AudioPlay">
<action name="Execute">
<command> UMPlayer </ command>
</action>
</ keybind>
</ keyboard>
<keybind key="XF86AudioStop">
<action name="Execute">
<command> UMPlayer </ command>
</action>
</ keybind>
</ keyboard>
<keybind key="XF86Tools">
<action name="Execute">
<command> which-program </ command>
</action>
</ keybind>
</ keyboard>
<keybind key="XF86Mail">
<action name="Execute">
<command> Sylpheed </ command>
</action>
</ keybind>
</ keyboard>
<keybind key="XF86Explorer">
<action name="Execute">
<command> Firefox </ command>
</action>
</ keybind>
</ keyboard>

Almost, not exactly.

Don't add the tag </ keyboard> anywhere. Just the block texts such as :
<keybind key="XF86Explorer">
<action name="Execute">
<command> Firefox </ command>
</action>

BEFORE the last end tag </ keyboard> which already exists.

There are already block texts in it to perform diverse operations using the keyboard shortcuts. If you read through you will discover what the default shortcuts do and how you can use them.

So it is a whole chapter related to keyboard : a start tag, <keyboard>and end tag </ keyboard>: no need to add more keyboard tags. Just add your keybind commands at the end of the chapter, before the last keyboard tag which is the end of the chapter.

<!-- Unist's personal keybindings start after here-->
<keybind key="XF86AudioRaiseVolume">
<action name="Execute">
<command> UMPlayer </ command>
</action>
</ keybind>

<keybind key="XF86AudioLowerVolume">
<action name="Execute">
<command> UMPlayer </ command>
</action>
</ keybind>

<keybind key="XF86AudioPlay">
<action name="Execute">
<command> UMPlayer </ command>
</action>
</ keybind>

<keybind key="XF86AudioStop">
<action name="Execute">
<command> UMPlayer </ command>
</action>
</ keybind>

<keybind key="XF86Tools">
<action name="Execute">
<command> which-program </ command>
</action>
</ keybind>

<keybind key="XF86Mail">
<action name="Execute">
<command> Sylpheed </ command>
</action>
</ keybind>

<keybind key="XF86Explorer">
<action name="Execute">
<command> Firefox </ command>
</action>
</ keybind>

Johnston: I think the above commands can be read by Xorg, but not the keycodes... according to what was explained to me. (If I mistake, let me know... I can't take the time to test and I don't have a multimedia keyboard right at hand either).

I had not read you correctly... My bad !

Wish a nice day to all ! Stay well !

PS: I have already pre-configured a keybinding for PCC and for Synaptic, in the files provided in the distro. they are in the chapter starting with the comment "<!-- personalized configurations --> and allow starting Synaptic with key Windows+s and PCC with key Windows+p. If you don't have a W key, then you need to change this setting.

PS2: unist : once the change done and saved, don't forget to reload Openbox either from the menu "Openbox > Reconfigure" or in console : "openbox --reconfigure".

PS3 : keybindings can fight together sometimes, for example I had the Ctrl+s to save a file in a text editor which was used by a keybinding in rc.xml. When this happens, it needs to be reconfigured in rc.xml.

[djohnston]

Don't add the tag </ keyboard> anywhere. Just the block texts such as :
<keybind key="XF86Explorer">
<action name="Execute">
<command> Firefox </ command>
</action>

One slight correction. The command would be firefox, not Firefox.


darrel@AMD64:  53 items 428Kb -> Firefox &
[1] 11523
bash: Firefox: command not found
[1]+  Exit 127                Firefox

Tue Jan  3 02:50:48 PM CST 2012
~
darrel@AMD64:  53 items 428Kb ->

[melodie]

One slight correction. The command would be firefox, not Firefox.

+1. I even copied unist's block text and didn't pay attention.

[unist]

Tonight, after making a backup copy of rc.xml , I 'll apply the changes and post the result.

Update No. 1:
These are the additional lines that I will include in rc.xml:

<keyboard>

<keybind key="XF86AudioRaiseVolume">
<action name="Execute">
<command> UMPlayer </ command>
</action>
</ keybind>

<keybind key="XF86AudioLowerVolume">
<action name="Execute">
<command> UMPlayer </ command>
</action>
</ keybind>

<keybind key="XF86AudioPlay">
<action name="Execute">
<command> UMPlayer </ command>
</action>
</ keybind>

<keybind key="XF86AudioStop">
<action name="Execute">
<command> UMPlayer </ command>
</action>
</ keybind>

<keybind key="XF86Tools">
<action name="Execute">
<command> pcc </ command>
</action>
</ keybind>

<keybind key="XF86Mail">
<action name="Execute">
<command> Sylpheed </ command>
</action>
</ keybind>

<keybind key="XF86Explorer">
<action name="Execute">
<command> firefox </ command>
</action>
</ keybind>

</ keyboard>

Update No. 2:
I located and opened rc.xml and I note that in its 2nd and 3rd lines it is said:

"Do not edit this file, it will be overwritten on install
    Copy the file to $HOME/.config/openbox"

Should I proceed anyway and edit rc.xml or should I copy it in $HOME/.config/openbox and edit the copied file there?
I suppose that the quoted text is a prevision for mistaken entries in the file. If that happens, how to install again in order to resolve the error?

In addition, I want to be sure where in the file insert the new lines:

- Should it be after line No. 600 </ applications> ? or
- Should it be before line No. 732 </ applications> ?

In between there are commented lines

Update No. 3:
I corrected program names and eliminated blank spaces in lines. New proposed block:

<keyboard>

<keybind key="XF86AudioRaiseVolume">
<action name="Execute">
<command>umplayer</command>
</action>
</keybind>

<keybind key="XF86AudioLowerVolume">
<action name="Execute">
<command>umplayer</command>
</action>
</keybind>

<keybind key="XF86AudioPlay">
<action name="Execute">
<command>umplayer</command>
</action>
</keybind>

<keybind key="XF86AudioStop">
<action name="Execute">
<command>umplayer</command>
</action>
</keybind>

<keybind key="XF86Tools">
<action name="Execute">
<command>pcc</command>
</action>
</keybind>

<keybind key="XF86Mail">
<action name="Execute">
<command>sylpheed</command>
</action>
</keybind>

<keybind key="XF86Explorer">
<action name="Execute">
<command>firefox</command>
</action>
</keybind>

</keyboard>

Update No. 4:
Should I leave blank lines in between applications blocks? Or no blank lines at all?

[djohnston]

Update No. 2:
I located and opened rc.xml and I note that in its 2nd and 3rd lines it is said:

"Do not edit this file, it will be overwritten on install
    Copy the file to $HOME/.config/openbox"

Should I proceed anyway and edit rc.xml or should I copy it in $HOME/.config/openbox and edit the copied file there?
I suppose that the quoted text is a prevision for mistaken entries in the file. If that happens, how to install again in order to resolve the error?

I hope you are editing the rc.xml file in your home directory, as previously indicated:

Not familiar with doing this myself, I would say make a backup copy of your original ~/.config/openbox/rc.xml file first. Then edit the original.

To explain the meaning of the ~ symbol, it is an abbreviation for /home/yourusername. So, ~/.config/openbox/rc.xml would equal /home/yourusername/.config/openbox/rc.xml. If you entered:

leafpad ~/.config/openbox/rc.xml

in a terminal, the file /home/yourusername/.config/openbox/rc.xml would open in the leafpad editor. The "overwritten on install" message refers to the file /etc/xdg/openbox/rc.xml. Do not edit that file. It will be overwritten with certain package updates. The rc.xml file in your home directory is probably a copy of the one in the /etc/xdg/openbox directory. When logged in as your user, the rc.xml in your home directory will override the system-wide settings in /etc/xdg/openbox/rc.xml.

I'm not sure that extra blank lines will make any difference in the parsing of the file.

[melodie]

Hi,

This:
"I located and opened rc.xml and I note that in its 2nd and 3rd lines it is said:

"Do not edit this file, it will be overwritten on install
    Copy the file to $HOME/.config/openbox""

has been left as is. You can safely ignore it, if as Djohnston says you are using the one which is located in /home/unist/.config/openbox

The block texts you say are ok, but you do not have to add the <keybaord>tags</keyboard>, because they are already there. Use the ones which exist : just by adding the block texts you need nested just before the ending tag :  </keyboard>

In addition, I want to be sure where in the file insert the new lines:

- Should it be after line No. 600 </ applications> ? or
- Should it be before line No. 732 </ applications> ?

No, you copy them at the end of the section starting with <keyboard> before the end tag </keyboard>.

Update No. 4:
Should I leave blank lines in between applications blocks? Or no blank lines at all?

I suggest you leave them for the comfort of your sight. Openbox does not care, so it's up to you. And to end with, I suggest you use a good text editor, such as Geany (which is included in Openbox), or Gedit if you prefer it, but not something such as Leafpad. Leafpad displays the texts all in black whereas advanced text editors such as Geany, Gedit, Kwrite...  display the content of the files such as xml files or any file containing programs, such as bash, Perl and so on with syntax highlighting, which is much more comfortable for editing.

Regards,
Mélodie

[unist]

I applied everything.
I did "openbox --reconfigure" in console and rebooted.
The result is as follows:

Home button: it opens Firefox Home (PCLOS)
Mail button: it opens Sylpheed email program
Configure button: it opens pcc
Stop button: it raises volume for a music CD currently playing.
Play/Pause button: it play or pause a music CD recording
Lower Volume button: no effect
Raise Volume: no effect

Because of the wrong functioning of some of the media buttons I changed the following:

XF86AudioRaiseVolume for 0x123
XF86AudioLowerVolume for 0x122
XF86AudioPlay for 0x172
XF86AudioStop for 0x174

But it did not corrected the behavior of the media buttons.

I verified in console xev pressing the hotkeys of my keyboard and the functions and codes are the correct ones.

This is a copy of the modified part of rc.xml file:

 <keybind key="0x123">
 <action name="Execute">
 <command>umplayer</command>
 </action>
 </keybind>
 <keybind key="0x122">
 <action name="Execute">
 <command>umplayer</command>
 </action>
 </keybind>
 <keybind key="0x172">
 <action name="Execute">
 <command>umplayer</command>
 </action>
 </keybind>
 <keybind key="0x174">
 <action name="Execute">
 <command>umplayer</command>
 </action>
 </keybind>
 <keybind key="XF86Tools">
 <action name="Execute">
 <command>pcc</command>
 </action>
 </keybind>
 <keybind key="XF86Mail">
 <action name="Execute">
 <command>sylpheed</command>
 </action>
 </keybind>
 <keybind key="XF86Explorer">
 <action name="Execute">
 <command>firefox</command>
 </action>
 </keybind>

[djohnston]

Try

 <keybind key="0x123">
 <action name="Execute">
 <command>amixer set Master 5%+</command>
 </action>
 </keybind>
 <keybind key="0x122">
 <action name="Execute">
 <command>amixer set Master 5%-</command>
 </action>
 </keybind>

See if that works.

EDIT: I don't know umplayer. Can you open a console and enter umplayer --help and post the output?

[melodie]

Hi,
I also suggest trying to deactivate the software volume control in Umplayer. Maybe it could work ?

I installed it to see what it looks like, it has no depends... in the menu "Options > Preferences > General > tab Audio > Volume" untick "Use the oftware volume control". Quit Umplayer, restart it, see what ?

[unist]

I changed the commands as you can see:

<keybind key="0x123">
 <action name="Execute">
 <command>amixer set Master 5%+</command>
 </action>
 </keybind>
 <keybind key="0x122">
 <action name="Execute">
 <command>amixer set Master 5%-</command>
 </action>
 </keybind>
 <keybind key="0x172">
 <action name="Execute">
 <command>umplayer</command>
 </action>
 </keybind>
 <keybind key="0x174">
 <action name="Execute">
 <command>umplayer</command>
 </action>
 </keybind>

I did "openbox --reconfigure" and rebooted, but the result was the same.
Then I unticked "Use the software volume control" in UMPlayer preferences, rebooted, and there was no change.

Is there any consequence for the blank spaces in "amixer set Master 5%+" and "amixer set Master 5%-"?

This is the output of umplayer --help:

[hugo@localhost ~]$ umplayer --help
Debug: main: lock_file: /home/hugo/.config/umplayer/umplayer_init.lock
Debug: global_init
Debug: global_init: config file: '/home/hugo/.config/umplayer/umplayer.ini'
Debug: Preferences::load
Debug: AssStyles::load
Debug: Translator::loadCatalog: can't load qt_en_US from /usr/share/umplayer/translations
Debug: Translator::loadCatalog: can't load qt_en_US from /usr/lib/qt4/translations
Debug: Translator::loadCatalog: successfully loaded umplayer_en_US from /usr/share/umplayer/translations
This is UMPlayer v. 0.97 running on Linux
Debug: This is UMPlayer v. 0.97 running on Linux
Debug: Compiled with Qt v. 4.7.3, using 4.7.3
Debug:  * application path: '/usr/bin'
Debug:  * data path: '/usr/share/umplayer'
Debug:  * translation path: '/usr/share/umplayer/translations'
Debug:  * doc path: '/usr/share/doc/packages/umplayer'
Debug:  * themes path: '/usr/share/umplayer/themes'
Debug:  * shortcuts path: '/usr/share/umplayer/shortcuts'
Debug:  * config path: '/home/hugo/.config/umplayer'
Debug:  * ini path: '/home/hugo/.config/umplayer'
Debug:  * file for subtitles' styles: '/home/hugo/.config/umplayer/styles.ass'
Debug:  * current path: '/home/hugo'
Debug: UMPlayer::processArgs: arguments: 2
Debug: UMPlayer::processArgs: 0 = umplayer
Debug: UMPlayer::processArgs: 1 = --help
Usage: umplayer [-minigui] [-defaultgui] [-mpcgui] [-config-path directory]
[-send-action action_name] [-actions action_list] [-close-at-end]
[-no-close-at-end] [-fullscreen] [-no-fullscreen] [-sub subtitle_file] [-pos x
y] [-size width height] [-add-to-playlist] [-help|--help|-h|-?] [[-playlist]
media] [[-playlist] media]...

          -minigui: opens the mini gui instead of the default one.
           -mpcgui: opens the mpc gui.
       -defaultgui: opens the default gui.
      -config-path: specifies the directory where umplayer will store its
                    configuration files (umplayer.ini, umplayer_files.ini...)
      -send-action: tries to make a connection to another running instance and
                    send to it the specified action. Example: -send-action
                    pause The rest of options (if any) will be ignored and the
                    application will exit. It will return 0 on success or -1 on
                    failure.
          -actions: action_list is a list of actions separated by spaces. The
                    actions will be executed just after loading the file (if
                    any) in the same order you entered. For checkable actions
                    you can pass true or false as parameter. Example: -actions
                    "fullscreen compact true". Quotes are necessary in case you
                    pass more than one action.
     -close-at-end: the main window will be closed when the file/playlist
                    finishes.
  -no-close-at-end: the main window won't be closed when the file/playlist
                    finishes.
       -fullscreen: the video will be played in fullscreen mode.
    -no-fullscreen: the video will be played in window mode.
              -sub: specifies the subtitle file to be loaded for the first
                    video.
              -pos: specifies the coordinates where the main window will be
                    displayed.
             -size: specifies the size of the main window.
             -help: will show this message and then will exit.
  -add-to-playlist: if there's another instance running, the media will be
                    added to that instance's playlist. If there's no other
                    instance, this option will be ignored and the files will be
                    opened in a new instance.
             media: 'media' is any kind of file that UMPlayer can open. It can
                    be a local file, a DVD (e.g. dvd://1), an Internet stream
                    (e.g. mms://....) or a local playlist in format m3u or pls.
                    If the -playlist option is used, that means that UMPlayer
                    will pass the -playlist option to MPlayer, so MPlayer will
                    handle the playlist, not UMPlayer.

Debug: main: remove_lock: /home/hugo/.config/umplayer/umplayer_init.lock

In addition I opened the music CD with VLC and genome-mplayer 1.04, and Raise Volume, Lower Volume and Play/Pause buttons did not respond, but Stop Button increased volume as UMPlayer did. The only difference with UMPlayer was that using it the Play/Pause button responded as expected.

[djohnston]

Is there any consequence for the blank spaces in "amixer set Master 5%+" and "amixer set Master 5%-"?

That's the correct syntax. It raises and lowers the master volume of alsamixer. Try it in a terminal with amixer set Master 5%+ and the other way.

umplayer is a GUI front end for mplayer, just like the mplayer-gui package in Synaptic. I was hoping there would be some control keys like there are for gmplayer (the executable for mplayer-gui). Here's a partial list by issuing gmplayer --help in a terminal.

Basic keys: (complete list in the man page, also check input.conf)
 <-  or  ->       seek backward/forward 10 seconds
 down or up       seek backward/forward  1 minute
 pgdown or pgup   seek backward/forward 10 minutes
 < or >           step backward/forward in playlist
 p or SPACE       pause movie (press any key to continue)
 q or ESC         stop playing and quit program
 + or -           adjust audio delay by +/- 0.1 second
 o                cycle OSD mode:  none / seekbar / seekbar + timer
 * or /           increase or decrease PCM volume
 x or z           adjust subtitle delay by +/- 0.1 second
 r or t           adjust subtitle position up/down, also see -vf expand

[unist]

That's the correct syntax. It raises and lowers the master volume of alsamixer. Try it in a terminal with amixer set Master 5%+ and the other way.

In terminal, with a music CD playing, "amixer set Master 5%+" and "amixer set Master 5%-" raises and lower volume as expected.