From kde-commits Mon May 21 15:24:46 2018 From: Yuri Chornoivan Date: Mon, 21 May 2018 15:24:46 +0000 To: kde-commits Subject: [amarok] doc: Sync the docs with UserBase Message-Id: X-MARC-Message: https://marc.info/?l=kde-commits&m=152691630414147 Git commit f4af2bc5bb501b36fed8c35004c833e5352180bf by Yuri Chornoivan. Committed on 21/05/2018 at 15:24. Pushed by yurchor into branch 'master'. Sync the docs with UserBase M +33 -43 doc/index.docbook https://commits.kde.org/amarok/f4af2bc5bb501b36fed8c35004c833e5352180bf diff --git a/doc/index.docbook b/doc/index.docbook index 7849b168e3..819eef62f3 100644 --- a/doc/index.docbook +++ b/doc/index.docbook @@ -16,7 +16,7 @@ &FDLNotice; -2018-03-21 +2018-05-21 2.9.0 &amarok; is a free, versatile and powerful music player for &Linux;.= The latest 2.x release series, often referred to as Amarok 2, is cross-platform (can be used on many platforms, including &Linux;= , &MacOS; and &Microsoft; &Windows;) and implements a completely reworked c= ode base that will enable it to incorporate exciting new features as the re= lease matures. The current stable release is version 2.4. @@ -33,7 +33,7 @@ sound - + = Amarok: Rediscover yo= ur music! = @@ -5824,12 +5824,12 @@ mysql -u amarokuser -p amarok < amarok.mysql Summary of Requirements</titl= e> = <itemizedlist> -<listitem><para>The <guilabel>Moodbar</guilabel> binary, in your PATH (it = should be listed upon running <userinput>which moodbar</userinput> from a c= onsole) — Remember to configure the <guilabel>Moodbar</guilabel> pack= age with <userinput>./configure --prefix=3D`pkg-config --variable=3Dprefix = gstreamer-0.10`</userinput></para></listitem> -<listitem><para>The GStreamer 0.10 library and <link linkend=3D"supported-= filetypes">plugins</link> for the formats you want <guilabel>Moodbar</guila= bel> to be able to analyse. A GStreamer 1.0 based fork is also available, s= ee <link linkend=3D"source-downloads">below</link>.</para></listitem> +<listitem><para>The <guilabel>Moodbar</guilabel> binary, in your PATH (it = should be listed upon running <userinput>which moodbar</userinput> from a c= onsole) — Remember to configure the <guilabel>Moodbar</guilabel> pack= age with proper path, ⪚ build and install with commands <userinput>./aut= ogen.sh --prefix=3D`pkg-config --variable=3Dprefix gstreamer-1.0` &&= ; make && sudo make install</userinput></para></listitem> +<listitem><para>The GStreamer 1.0 library and <link linkend=3D"supported-f= iletypes">plugins</link> for the formats you want <guilabel>Moodbar</guilab= el> to be able to analyse. (An earlier GStreamer 0.10 based version is also= still available for some distributions)</para></listitem> <listitem><para>The <emphasis>Fastest Fourier Transform In The West</empha= sis> (<ulink url=3D"http://www.fftw.org">fftw.org</ulink>) FFTW library ve= rsion 3.0 or above (at least single-precision floating point version - libf= ftw3f) — If your platform does not provide this for you or you need t= o compile your own version, remember to configure the FFTW package with <u= serinput>./configure --enable-single</userinput></para></listitem> <listitem><para>A version of &amarok; with a <guilabel>Use moods</guilabel= > option in the <guilabel>General</guilabel> section of the configuration s= creen. This means 1.4.4 or higher in the 1.4 series or 2.2.2 or higher in t= he 2.x series.</para></listitem> </itemizedlist> -<para><note><para>Systems with package managers should automatically insta= ll the GStreamer plugins and FFTW along with the Moodbar package; this info= rmation is provided mostly for people who want or need to compile from sour= ce or manually install packages.</para></note> +<para><note><para>Systems with package managers should automatically insta= ll the GStreamer plugins and FFTW along with the Moodbar package if availab= le; this information is provided mostly for people who want or need to comp= ile from source or manually install packages, or where the distribution spe= cific instructions are outdated and no updated moodbar package is yet avail= able.</para></note> </para> </sect2> <sect2 id=3D"usage"><title>Usage = @@ -5840,18 +5840,20 @@ mysql -u amarokuser -p amarok < amarok.mysql Installation = Source Downloads = -Latest release: moodbar-0.1.2.tar.gz — this is the Moodbar source packa= ge, which contains the Moodbar program (which generate= s .mood files from music files), and a GStreamer plugin that does the work.= The Moodbar package needs GStreamer 0.10.* installed, plus the 0.10.* ver= sion of various plugins. Be su= re to install the Moodbar package into the same prefix= as GStreamer — follow the instructions in the INSTALL file. - -As the Moodbar version above uses nowadays obsolete GStreamer 0.10 a= nd the original source code link is dead, sources have been uploaded to GitHub and a forked = version supporting GStreamer 1.0 has been developed. +Latest release: moodbar-0.1.4.tar.gz — this is the Moodba= r source package, which contains the Moodbar program (= which generates .mood files from music files), and a GStreamer plugin that = does the work. The Moodbar package needs GStreamer 1.0.* installed, plus t= he 1.0.* version of various plugins. Be sure to install the Moodbar package into the same prefi= x as GStreamer — follow the instructions in =C2=A0the summary of requirements chapter. The 0.1.4 is a a fork of original 0.1.2 sources, updated to use GStream= er 1.0. The old 0.1.2 sources are not reliably available online any more, b= ut packages might be still available for some distributions. If you find any bugs, please submit a bug report at bugs.kde.org. Debian packages = +This section contains old instructions for the GStreamer= 0.10 based moodbar version 0.1.2, they might be outdated. + A package for Moodbar is now available in Debian unstable. Simply ru= n apt-get install moodbar . You will likely also wan= t to install gstreamer0.10-plugins-ugly, gstreamer0.10-plugins-good, and gs= treamer0.10-plugins-bad for format support. Kubuntu and Ubuntu packag= es = +This section contains old instructions for the GStreamer= 0.10 based moodbar version 0.1.2, they might be outdated. + A package for Moodbar is available in the official package repositor= y; just ensure the universe section is activated (which should be default a= nyway). Just install the package moodbar with your preferred package manage= r (Kpackagekit, Aptitude, Adept, Synaptic). You will likely also w= ant to install gstreamer0.10-plugins-ugly, gstreamer0.10-plugins-good, and = gstreamer0.10-plugins-bad for format support. Or, to install, paste this into Firefox or &kon= queror; and hit &Enter;. @@ -5860,55 +5862,43 @@ mysql -u amarokuser -p amarok < amarok.mysql Gentoo ebuilds = +This section contains old instructions for the GStreamer= 0.10 based moodbar version 0.1.2, they might be outdated. + Moodbar is available in Portage, simply emerge moodbar Unofficial ebuilds are no longer required. RPM builds = +This section contains old instructions for the GStreamer= 0.10 based moodbar version 0.1.2, they might be outdated + If you are a rpm-based distro user, you can build a .rpm using rpmbu= ild with latest gstreamer-plugins-moodbar.spec. The binary = package will be soon available for PLD-= linux distro. Fedora = +This section contains old instructions for the GStreamer= 0.10 based moodbar version 0.1.2, they might be outdated. + In Fedora 7 and higher (up to 16 as of this writing) Moodbar is avai= lable in the default repositories. Simply install it with your PackageKit G= UI or with the following yum command: yum install moodbar openSUSE packages = -openSUSE 11.0 and later, automatically install the following package= s: +GStreamer 1.0 based version 0.1.4 is available in KDE:Extra reposito= ry for openSUSE Leap 42.3 and later. An earlier GStreamer 0.10 based versio= n 0.1.2 is also still available in the main repository for some openSUSE ve= rsions. - -gstreamer-0_10-fluendo-mp3 -gstreamer-0_10-plugins-base - -Also, if your songs contain ID3 tags, you must install +For details on how to add repositories, see the openSUSE wiki. - -gstreamer-0_10-plugins-good - -Moodbar Installation = -1-Click Install for openSUSE 11. - just choose your version and inst= allation procedure will do the rest: +1-Click Install for openSUSE - just choose your version and installa= tion procedure will do the rest: -openSUSE 11.2 -openSUSE 11.1 +openSUSE Tumbleweed +openSUSE Leap 15.0 +openSUSE Leap 42.3 -To install, add the correct repository for your version of openSUSE = to YaST then make sure the following packages are inst= alled: - - -gstreamer-0_10-plugins-good -gstreamer-0_10-plugins-ugly -gstreamer-0_10-plugins-moodbar -mad - -For details on how to add repositories, see the openSUSE wiki. - -If you are using the Smart software management = tool, add the channel by entering the following at the command line, rememb= er to change the URL to match your version of openSUSE: smart channel --add http://software.opensuse.org/download/home:/d7/openSUS= E_10.2/home:d7.repo Then enter smart updat= e home:d7 You can now install the required packages by smart install gstreamer10-plugins-moodbar Dependencies are r= esolved automatically. - - Mandriva packages = +This section contains old instructions for the GStreamer= 0.10 based moodbar version 0.1.2, they might be outdated. + First of all, you need to add PLF repositories, so visit easyurpmi.zarb.org and add them to y= our repositories list. Then simply install the following packages: @@ -5921,12 +5911,16 @@ mysql -u amarokuser -p amarok < amarok.mysql Arch &Linux; = +This section contains old instructions for the GStreamer= 0.10 based moodbar version 0.1.2, they might be outdated. + There is a PKGBUILD for Moodbar in the Arch User Repository (AUR) available here. For more information about the AUR and working with PKGBUILDs, see t= he A= UR User Guidelines. FreeBSD = +This section contains old instructions for the GStreamer= 0.10 based moodbar version 0.1.2, they might be outdated. + There is a port: audio/gstreamer-plugins-moodbar here. To install the port: cd /usr/ports/audio/gstreamer-plugin= s-moodbar/ && make install clean @@ -5998,22 +5992,18 @@ mysql -u amarokuser -p amarok < amarok.mysql fi done = -The links are not available anymore. I don't know i= f it should be updated or deleted - -There is another script at Github, which shows previews of the generated = mood files on the command line while they are being generated. Read more ab= out it at the author's blog. - Troubleshooting = -If the Moodbar executable gives you a= bus error, that almost always means it can't decode (= or can't find) your file. Take a look at the supported file types below for ideas on which GStreamer plu= gins to install. You can also try the command below to test whether GStrea= mer can decode your file:gst-launch filesrc location=3D[file] ! = decodebin ! fakesink +If the Moodbar executable gives you a= bus error, that almost always means it can't decode (= or can't find) your file. Take a look at the supported file types below for ideas on which GStreamer plu= gins to install. You can also try the command below to test whether GStrea= mer can decode your file:gst-launch-1.0 filesrc location=3D[file= ] ! decodebin ! fakesink If you are using the ffmpeg plugin to decode mp3s, you may= also receive mysterious bus errors. The solution is to stop using the ffmp= eg plugin, as it is extremely buggy — use mad instead. If the Moodbar executable tells you t= hat it can't find an element — &ie;, it gives an error message like <= screen>Could not create element of type fftwspectrum, please install it.— that usually means that you either don't have the required pl= ugins installed (see the plugin list = here), or that you didn't install the Moodbar package in the same pr= efix as GStreamer. If libmoodbar.so and libgstdecodebin.so are not in the s= ame directory, then Moodbar is not installed in the same prefix as GStreame= r. Please read the INSTALL file for instructions on how to configure the m= oodbar package correctly. Alternatively, if you know what you're = doing, it may be easier for you to take a look at the = GST_PLUGIN_PATH environment variable. -If you're wondering why the Moodbar i= sn't working, either not working at all or not working for a particular fil= e, run the command below, where [file] is a music file:moodbar -= o test.mood [file] -If you have multiple versions of GStreamer installed, make= sure all of the required plugins are installed for version 0.10.= * -- different versions cannot use each oth= er's plugins. +If you're wondering why the Moodbar i= sn't working, either not working at all or not working for a particular fil= e, run the command below, where [file] is a music file:moodbar -= o test.mood [file] To generate a test image preview, one can u= se the command=CB=90gst-launch-1.0 filesrc location=3D[file] ! d= ecodebin ! audioconvert ! fftwspectrum ! moodbar height=3D50 max-width=3D30= 0 ! pngenc ! filesink location=3Dmood.png +If you have multiple versions of GStreamer installed, make= sure all of the required plugins are installed for version 1.0.*= -- different versions cannot use each othe= r's plugins. Supported Filetypes = -You will need various Gstreamer plugins to enable Moodbar<= /guilabel> to analyze your files. Here is a list of the plugins you will ne= ed; make sure to install the 0.10.* version of each pl= ugin: +You will need various Gstreamer plugins to enable Moodbar<= /guilabel> to analyze your files. Here is a list of the plugins you will ne= ed; make sure to install the 1.0.* version of each plu= gin: @@ -6031,7 +6021,7 @@ mysql -u amarokuser -p amarok < amarok.mysql All - gstreamer-0.10.*, gst-plugins-base, gst-plugins-good + gstreamer-1.0.*, gst-plugins-base, gst-plugins-good