Development/Tutorials/Debugging/Phonon - Revision history

Dominik Schmidt: /* Environment Variables */

2013-04-22T15:30:15Z

‎Environment Variables

Apachelogger: add backend_debug used in pgst 4.6 and pvlc 0.6

2012-06-18T02:41:11Z

add backend_debug used in pgst 4.6 and pvlc 0.6

Trever at 17:13, 5 June 2012

2012-06-05T17:13:03Z

Mamarok: /* Environment Variables */ removed xine debug

2012-04-27T19:58:58Z

‎Environment Variables: removed xine debug

Icwiener: Fix syntax highlighting.

2011-06-27T16:26:21Z

Fix syntax highlighting.

Apachelogger: can someone please move the install stuff somewhere else?!?!?!

2011-05-07T10:59:18Z

can someone please move the install stuff somewhere else?!?!?!

Valoriez: /* Environment Variables */ added section on building from source

2011-05-04T08:47:07Z

‎Environment Variables: added section on building from source

Tdfischer: Created page with '= Environment Variables = In general, there is one easy way to give Phonon devs all the information they need to help fix your problem. Set these environment variables:

 $...'

2011-03-19T01:39:21Z

Created page with '= Environment Variables = In general, there is one easy way to give Phonon devs all the information they need to help fix your problem. Set these environment variables: <pre> $...'

New page

= Environment Variables =

In general, there is one easy way to give Phonon devs all the information they need to help fix your problem.

Set these environment variables:
<pre>
$ export PHONON_DEBUG=5
$ export PHONON_PULSEAUDIO_DEBUG=5
$ export PHONON_VLC_DEBUG=5
$ export PHONON_GST_DEBUG=5
$ export PHONON_XINE_DEBUG=5
</pre>

Then run your program. The terminal will fill up with gobs of debugging output.

== Phonon-GStreamer debugging ==

=== Even more verbose output ===

Phonon-gst has some fancier debug options available. In addition to PHONON_GST_DEBUG, there is PHONON_GST_GST_DEBUG. Setting it to 8 or so will cause the gstreamer libraries to produce ''copious'' quantities of debug output. We're talking thousands of lines of what seems to be useless noise. Roughly 1% of it is useful, but the phonon-gst devs can easily decipher it and drill down to the important bits.

=== Pulseaudio ===

Pulseaudio and phonon try their hardest to get along. Sometimes, it doesn't work. Luckily, there is a way to test gstreamer and pulseaudio to see who is at fault.

<pre>
$ gst-launch filesrc location=/usr/share/sounds/KDE-Sys-Log-In.ogg ! decodebin2 ! audioresample ! audioconvert ! pulsesink
$ gst-launch filesrc location=/usr/share/sounds/KDE-Sys-Log-In.ogg ! decodebin2 ! audioresample ! audioconvert ! alsasink
</pre>

If they both work flawlessly, blame Phonon-GStreamer.

If the first works but the second doesn't, you might have an exotic sound setup that involves tweaking the alsasink parameters to reflect what pulseaudio does to alsa.

If the second works but the first doesn't, you can blame pulseaudio.

Another way to confirm this is by setting the PHONON_GST_AUDIOSINK environment variable. Setting it to e.g. "pulsesink" uses the pulseaudio sink.

=== Recreating the phonon-gst pipeline ===

Phonon-GStreamer creates predicable pipelines. In general, they look like this:



<pre>
filesrc -> decodebin2 -> queue -> audioresample -> audioconvert -> pulsesink
\
-> ffmpegcolorspace -> queue -> xvimagesink
</pre>

If the input stream isn't coming from a file, it is likely coming in via KIO which pipes it into an abstractmediastream. If pulseaudio isn't used, then replace pulsesink with something of alsasink, osssink, or somesuch.

Recreating the playback stream of some video file can be done as such:
<pre>
$ gst-launch filesrc location=/path/to/video ! decdebin2 name=dec ! audioresample ! audioconvert ! pulsesink \
dec. ! ffmpegcolorspace ! xvimagesink
</pre>

DVD playback is a bit different:
<pre>
(subpicture stream)
/--->---\
rsndvdbin -> dvdspu -> ffmpegcolorspace -> queue -> xvimagesink
\-> queue -> audioresample -> audioconvert -> pulsesink
</pre>

This is built with the following:
<pre>
$ gst-launch rsndvdbin ! dvdspu ! ffmpegcolorspace ! queue ! xvimagesink \
rsndvdbin0 ! dvdspu0.subpicture \
rsndvdbin0 ! queue ! audioresample ! audioconvert ! pulsesink
</pre>

← Older revision		Revision as of 17:13, 5 June 2012
Line 14:		Line 14:

	== Phonon-GStreamer debugging ==		== Phonon-GStreamer debugging ==
		+
		+	=== Drawing a dot diagram ===
		+
		+	<syntaxhighlight lang="bash">
		+	$ export GST_DEBUG_DUMP_DOT_DIR=/tmp
		+	$ # run your program
		+	$ dot -Tpng -oimage.png < /tmp/one-of-the-dot-files.dot
		+	</syntaxhighlight>

	=== Even more verbose output ===		=== Even more verbose output ===

@@ Line 4: / Line 4: @@
 Set these environment variables:
-<pre>
+<syntaxhighlight lang="bash">
 $ export PHONON_DEBUG=5
 $ export PHONON_PULSEAUDIO_DEBUG=5
@@ Line 10: / Line 10: @@
 $ export PHONON_GST_DEBUG=5
 $ export PHONON_XINE_DEBUG=5
-</pre>
+</syntaxhighlight>
 Then run your program. The terminal will fill up with gobs of debugging output.
@@ Line 24: / Line 24: @@
 Pulseaudio and phonon try their hardest to get along. Sometimes, it doesn't work. Luckily, there is a way to test gstreamer and pulseaudio to see who is at fault.
-<pre>
+<syntaxhighlight lang="bash">
 $ gst-launch filesrc location=/usr/share/sounds/KDE-Sys-Log-In.ogg ! decodebin2 ! audioresample ! audioconvert ! pulsesink
 $ gst-launch filesrc location=/usr/share/sounds/KDE-Sys-Log-In.ogg ! decodebin2 ! audioresample ! audioconvert ! alsasink
-</pre>
+</syntaxhighlight>
 If they both work flawlessly, blame Phonon-GStreamer.
@@ Line 52: / Line 52: @@
 Recreating the playback stream of some video file can be done as such:
-<pre>
+<syntaxhighlight lang="bash">
 $ gst-launch filesrc location=/path/to/video ! decdebin2 name=dec ! audioresample ! audioconvert ! pulsesink \
      dec. ! ffmpegcolorspace ! xvimagesink
-</pre>
+</syntaxhighlight>
 DVD playback is a bit different:
@@ Line 66: / Line 66: @@
 This is built with the following:
-<pre>
+<syntaxhighlight lang="bash">
 $ gst-launch rsndvdbin ! dvdspu ! ffmpegcolorspace ! queue ! xvimagesink \
      rsndvdbin0 ! dvdspu0.subpicture \
      rsndvdbin0 ! queue ! audioresample ! audioconvert ! pulsesink
-</pre>
+</syntaxhighlight>
 = Building Phonon from source =
@@ Line 79: / Line 79: @@
 Deb-based distros, run <pre>sudo apt-get build-dep phonon</pre>to be sure you have all dependencies installed.
-<br>
+<br />
-OpenSuSE:<pre>sudo zypper si -d phonon</pre>
+OpenSuSE:
 == Install git ==
@@ Line 96: / Line 97: @@
 == Define the PATH and local environment ==
-Append the following to $HOME/.bashrc:<pre>
+Append the following to <tt>$HOME/.bashrc</tt>:
-    export PATH=$HOME/kde/bin:$PATH
+<syntaxhighlight lang="bash">
-    export PATH=/usr/lib/ccache:$PATH
+export PATH=$HOME/kde/bin:$PATH
-    export LD_LIBRARY_PATH=$HOME/kde/lib:$LD_LIBRARY_PATH</pre>
+export PATH=/usr/lib/ccache:$PATH
-Reload your edited .bashrc:<pre>
+Reload your edited .bashrc:
-    source $HOME/.bashrc</pre>
+<syntaxhighlight lang="bash">
-NOTE: if you are not using the bash shell, edit your proper shell config file (~/.zshrc or ~/.tcshrc or whatever it may be).
+source $HOME/.bashrc
 == Make KDE aware of Phonon’s location ==
-<pre>
+<syntaxhighlight lang="bash">
 echo 'export KDEDIR=$HOME/kde' >> $HOME/.kde/env/myenv.sh
-echo 'export KDEDIRS=$KDEDIR' >> $HOME/.kde/env/myenv.sh</pre>
+echo 'export KDEDIRS=$KDEDIR' >> $HOME/.kde/env/myenv.sh
-Some distributions call the above folder $HOME/.kde4/ , such as OpenSuSE.
+</syntaxhighlight>
 == Install locally==
-Install in your $HOME dir):<pre>
+Install in your $HOME dir):
 mkdir $HOME/kde && cd kde && mkdir src && cd src
 git clone git://anongit.kde.org/phonon
 cd phonon && mkdir build && cd build
 cmake -DCMAKE_INSTALL_PREFIX=/usr -DCMAKE_BUILD_TYPE=debugfull $HOME/kde/src/phonon
-sudo make install</pre>
+To update your build, it's even easier:
+<syntaxhighlight lang="bash">
-To update your build, it's even easier: <pre>
 cd ~/kde/src/phonon
 git pull
 cd build && sudo make install
-cd build && sudo make install</pre>
+</syntaxhighlight>
 == Build locally from a tarball ==
-This is 4.4.4 for example:<pre>
+This is 4.4.4 for example:
 cd ~/kde/src/
 wget http://download.kde.org/download.php?url=stable/phonon/4.4.4/src/phonon-4.4.4.tar.bz2
 tar xf phonon-4.4.4.tar.bz2
 cd phonon-4.4.4 && mkdir build && cd build
 cmake -DCMAKE_INSTALL_PREFIX=/usr -DCMAKE_BUILD_TYPE=debugfull $HOME/kde/src/phonon-4.4.4
 sudo make install
-sudo make install</pre>
+</syntaxhighlight>

← Older revision		Revision as of 10:59, 7 May 2011
Line 1:		Line 1:
		+	= Environment Variables =
		+
		+	In general, there is one easy way to give Phonon devs all the information they need to help fix your problem.
		+
		+	Set these environment variables:
		+	<pre>
		+	$ export PHONON_DEBUG=5
		+	$ export PHONON_PULSEAUDIO_DEBUG=5
		+	$ export PHONON_VLC_DEBUG=5
		+	$ export PHONON_GST_DEBUG=5
		+	$ export PHONON_XINE_DEBUG=5
		+	</pre>
		+
		+	Then run your program. The terminal will fill up with gobs of debugging output.
		+
		+	== Phonon-GStreamer debugging ==
		+
		+	=== Even more verbose output ===
		+
		+	Phonon-gst has some fancier debug options available. In addition to PHONON_GST_DEBUG, there is PHONON_GST_GST_DEBUG. Setting it to 8 or so will cause the gstreamer libraries to produce ''copious'' quantities of debug output. We're talking thousands of lines of what seems to be useless noise. Roughly 1% of it is useful, but the phonon-gst devs can easily decipher it and drill down to the important bits.
		+
		+	=== Pulseaudio ===
		+
		+	Pulseaudio and phonon try their hardest to get along. Sometimes, it doesn't work. Luckily, there is a way to test gstreamer and pulseaudio to see who is at fault.
		+
		+	<pre>
		+	$ gst-launch filesrc location=/usr/share/sounds/KDE-Sys-Log-In.ogg ! decodebin2 ! audioresample ! audioconvert ! pulsesink
		+	$ gst-launch filesrc location=/usr/share/sounds/KDE-Sys-Log-In.ogg ! decodebin2 ! audioresample ! audioconvert ! alsasink
		+	</pre>
		+
		+	If they both work flawlessly, blame Phonon-GStreamer.
		+
		+	If the first works but the second doesn't, you might have an exotic sound setup that involves tweaking the alsasink parameters to reflect what pulseaudio does to alsa.
		+
		+	If the second works but the first doesn't, you can blame pulseaudio.
		+
		+	Another way to confirm this is by setting the PHONON_GST_AUDIOSINK environment variable. Setting it to e.g. "pulsesink" uses the pulseaudio sink.
		+
		+	=== Recreating the phonon-gst pipeline ===
		+
		+	Phonon-GStreamer creates predicable pipelines. In general, they look like this:
		+
		+	<!-- FIXME: We need a nice diagram -->
		+
		+	<pre>
		+	filesrc -> decodebin2 -> queue -> audioresample -> audioconvert -> pulsesink
		+	\
		+	-> ffmpegcolorspace -> queue -> xvimagesink
		+	</pre>
		+
		+	If the input stream isn't coming from a file, it is likely coming in via KIO which pipes it into an abstractmediastream. If pulseaudio isn't used, then replace pulsesink with something of alsasink, osssink, or somesuch.
		+
		+	Recreating the playback stream of some video file can be done as such:
		+	<pre>
		+	$ gst-launch filesrc location=/path/to/video ! decdebin2 name=dec ! audioresample ! audioconvert ! pulsesink \
		+	dec. ! ffmpegcolorspace ! xvimagesink
		+	</pre>
		+
		+	DVD playback is a bit different:
		+	<pre>
		+	(subpicture stream)
		+	/--->---\
		+	rsndvdbin -> dvdspu -> ffmpegcolorspace -> queue -> xvimagesink
		+	\-> queue -> audioresample -> audioconvert -> pulsesink
		+	</pre>
		+
		+	This is built with the following:
		+	<pre>
		+	$ gst-launch rsndvdbin ! dvdspu ! ffmpegcolorspace ! queue ! xvimagesink \
		+	rsndvdbin0 ! dvdspu0.subpicture \
		+	rsndvdbin0 ! queue ! audioresample ! audioconvert ! pulsesink
		+	</pre>
		+
	= Building Phonon from source =		= Building Phonon from source =

Line 72:		Line 145:

	sudo make install</pre>		sudo make install</pre>
−
−	~~= Environment Variables =~~
−
−	~~In general, there is one easy way to give Phonon devs all the information they need to help fix your problem.~~
−
−	~~Set these environment variables:~~
−	~~<pre>~~
−	~~$ export PHONON_DEBUG=5~~
−	~~$ export PHONON_PULSEAUDIO_DEBUG=5~~
−	~~$ export PHONON_VLC_DEBUG=5~~
−	~~$ export PHONON_GST_DEBUG=5~~
−	~~$ export PHONON_XINE_DEBUG=5~~
−	~~</pre>~~
−
−	~~Then run your program. The terminal will fill up with gobs of debugging output.~~
−
−	~~== Phonon-GStreamer debugging ==~~
−
−	~~=== Even more verbose output ===~~
−
−	Phonon-gst has some fancier debug options available. In addition to PHONON_GST_DEBUG, there is PHONON_GST_GST_DEBUG. Setting it to 8 or so will cause the gstreamer libraries to produce ''copious'' quantities of debug output. We're talking thousands of lines of what seems to be useless noise. Roughly 1% of it is useful, but the phonon-gst devs can easily decipher it and drill down to the important bits.
−
−	~~=== Pulseaudio ===~~
−
−	~~Pulseaudio and phonon try their hardest to get along. Sometimes, it doesn't work. Luckily, there is a way to test gstreamer and pulseaudio to see who is at fault.~~
−
−	~~<pre>~~
−	~~$ gst-launch filesrc location=/usr/share/sounds/KDE-Sys-Log-In.ogg ! decodebin2 ! audioresample ! audioconvert ! pulsesink~~
−	~~$ gst-launch filesrc location=/usr/share/sounds/KDE-Sys-Log-In.ogg ! decodebin2 ! audioresample ! audioconvert ! alsasink~~
−	~~</pre>~~
−
−	~~If they both work flawlessly, blame Phonon-GStreamer.~~
−
−	~~If the first works but the second doesn't, you might have an exotic sound setup that involves tweaking the alsasink parameters to reflect what pulseaudio does to alsa.~~
−
−	~~If the second works but the first doesn't, you can blame pulseaudio.~~
−
−	~~Another way to confirm this is by setting the PHONON_GST_AUDIOSINK environment variable. Setting it to e.g. "pulsesink" uses the pulseaudio sink.~~
−
−	~~=== Recreating the phonon-gst pipeline ===~~
−
−	~~Phonon-GStreamer creates predicable pipelines. In general, they look like this:~~
−
−	~~<!-- FIXME: We need a nice diagram -->~~
−
−	~~<pre>~~
−	~~filesrc -> decodebin2 -> queue -> audioresample -> audioconvert -> pulsesink~~
−	\
−	~~-> ffmpegcolorspace -> queue -> xvimagesink~~
−	~~</pre>~~
−
−	If the input stream isn't coming from a file, it is likely coming in via KIO which pipes it into an abstractmediastream. If pulseaudio isn't used, then replace pulsesink with something of alsasink, osssink, or somesuch.
−
−	~~Recreating the playback stream of some video file can be done as such:~~
−	~~<pre>~~
−	~~$ gst-launch filesrc location=/path/to/video ! decdebin2 name=dec ! audioresample ! audioconvert ! pulsesink \~~
−	~~dec. ! ffmpegcolorspace ! xvimagesink~~
−	~~</pre>~~
−
−	~~DVD playback is a bit different:~~
−	~~<pre>~~
−	~~(subpicture stream)~~
−	~~/--->---\~~
−	~~rsndvdbin -> dvdspu -> ffmpegcolorspace -> queue -> xvimagesink~~
−	~~\-> queue -> audioresample -> audioconvert -> pulsesink~~
−	~~</pre>~~
−
−	~~This is built with the following:~~
−	~~<pre>~~
−	~~$ gst-launch rsndvdbin ! dvdspu ! ffmpegcolorspace ! queue ! xvimagesink \~~
−	~~rsndvdbin0 ! dvdspu0.subpicture \~~
−	~~rsndvdbin0 ! queue ! audioresample ! audioconvert ! pulsesink~~
−	~~</pre>~~

← Older revision		Revision as of 08:47, 4 May 2011
Line 1:		Line 1:
		+	= Building Phonon from source =
		+
		+	If you want to have a newer Phonon build than 4.4.3 which is currently shipped by most distributions in KDE 4.6, you can build from source (git). Phonon is now located on git.kde.org.
		+
		+	== Get Dependencies ==
		+
		+	Deb-based distros, run <pre>sudo apt-get build-dep phonon</pre>to be sure you have all dependencies installed.
		+	<br>
		+	OpenSuSE:<pre>sudo zypper si -d phonon</pre>
		+
		+	== Install git ==
		+
		+	In Kubuntu, Debian, etc.:<pre>sudo apt-get install git-core</pre>
		+	In Archlinux:<pre>sudo pacman -Sy git</pre>
		+	In Gentoo:<pre>sudo emerge -av dev-util/git</pre>
		+	In OpenSuSE:<pre>sudo zypper install git</pre>
		+
		+	== Install ccache to speed up compilation ==
		+
		+	Install the package from your distribution and set the size of the cache to 2 GB with the command<pre>ccache -M 2G</pre>
		+	This will take 2Gb of space in your local directory. Enable the use of ccache by adding it to your local .bashrc, described below.
		+
		+	== Define the PATH and local environment ==
		+
		+	Append the following to $HOME/.bashrc:<pre>
		+	export PATH=$HOME/kde/bin:$PATH
		+	export PATH=/usr/lib/ccache:$PATH
		+	export LD_LIBRARY_PATH=$HOME/kde/lib:$LD_LIBRARY_PATH</pre>
		+
		+	Reload your edited .bashrc:<pre>
		+	source $HOME/.bashrc</pre>
		+	NOTE: if you are not using the bash shell, edit your proper shell config file (~/.zshrc or ~/.tcshrc or whatever it may be).
		+
		+	== Make KDE aware of Phonon’s location ==
		+	<pre>
		+	echo 'export KDEDIR=$HOME/kde' >> $HOME/.kde/env/myenv.sh
		+	echo 'export KDEDIRS=$KDEDIR' >> $HOME/.kde/env/myenv.sh</pre>
		+	Some distributions call the above folder $HOME/.kde4/ , such as OpenSuSE.
		+
		+	== Install locally==
		+
		+	Install in your $HOME dir):<pre>
		+	mkdir $HOME/kde && cd kde && mkdir src && cd src
		+
		+	git clone git://anongit.kde.org/phonon
		+
		+	cd phonon && mkdir build && cd build
		+
		+	cmake -DCMAKE_INSTALL_PREFIX=/usr -DCMAKE_BUILD_TYPE=debugfull $HOME/kde/src/phonon
		+
		+	sudo make install</pre>
		+
		+	To update your build, it's even easier: <pre>
		+	cd ~/kde/src/phonon
		+
		+	git pull
		+
		+	cd build && sudo make install</pre>
		+
		+	== Build locally from a tarball ==
		+
		+	This is 4.4.4 for example:<pre>
		+	cd ~/kde/src/
		+
		+	wget http://download.kde.org/download.php?url=stable/phonon/4.4.4/src/phonon-4.4.4.tar.bz2
		+
		+	tar xf phonon-4.4.4.tar.bz2
		+
		+	cd phonon-4.4.4 && mkdir build && cd build
		+
		+	cmake -DCMAKE_INSTALL_PREFIX=/usr -DCMAKE_BUILD_TYPE=debugfull $HOME/kde/src/phonon-4.4.4
		+
		+	sudo make install</pre>
		+
	= Environment Variables =		= Environment Variables =

@@ Line 7: / Line 7: @@
 $ export PHONON_DEBUG=5
 $ export PHONON_BACKEND_DEBUG=5
 $ export PHONON_PULSEAUDIO_DEBUG=5
 $ export PHONON_VLC_DEBUG=5