aboutsummaryrefslogblamecommitdiff
path: root/README
blob: 4ced1afba69bedd9caf01cf37e32222b52ab39f3 (plain) (tree)
1
2
3
4
5
6
7


                                                                 

                                               

                  









































                                                                    
                            
              


              
           




                         
               
              
                          
                          
                               




                                   
                                 
                                 
                            
                             
                           
                             
                                 
                           
                    
                                 

 
                                                                                                     


          

      
    

             
            
 
                                                                                               
           
                              
 
                  









                                                                                                                



                                                                                           
 
                                                               

          
                    




             
                                    
 

           
 

                                                                    

                                              
                                                                           
                                                                                                       


                                                                
                        
 

                                                                                       
Qmmp - Qt-based multimedia player

This program is an audio-player, written with help of Qt library.
Official home page: http://qmmp.ylsoftware.com/

Supported formats:
- MPEG1 layer 2/3
- Ogg Vorbis
- Native FLAC, Ogg FLAC
- Musepack
- WavePack
- Tracker modules (mod, s3m, it, xm, etc)
- ADTS AAC
- CD Audio
- WMA, Monkey's Audio (and other formats provided by FFmpeg library)
- PCM WAVE (and other formats provided by libsndfile library)

DSP effects:
- BS2B effect
- Sample rate converter
- LADSPA effects

Visual effects:
- ProjectM visualization
- Spectrum analyzer

Output system support:
- OSS
- ALSA (Linux)
- Pulse Audio
- JACK
- WaveOut (Win32)

Other features:
- Xmms and Winamp 2.x skins support
- 10-band equalizer
- MP3, Vorbis, AAC, AAC+ streams support
- mms support (experimental)
- MPRIS
- Removable device detection (via HAL)
- Video playback via Mplayer
- Lyrics (using lyricsplugin.com)
- Cover art support
- CUE sheet support
- Embedded CUE support (for FLAC and WavPack)
- Multiple playlists
- Automatic charset detection for cue files and ShoutCast metadata
- Playlist formats: m3u, pls, xspf
- ReplayGain support
- Last.fm/Libre.fm scrobbler
- CDDB support

Requirements:
- OS GNU Linux
- Qt >= 4.4
- tar, unzip, bzip2, gzip
- libmad
- libvorbis
- libogg
- libalsa >= 1.0.1
- taglib >= 1.6
- curl >= 7.16
- libmms >= 0.4 (Optional)
- flac >= 1.1.3 (Optional)
- libmpcdec >= 1.2.6 (Optional)
- jackit >= 0.102.5 (Optional)
- libsamplerate >= 0.1.2 (Optional)
- libmodplug >= 0.8.4 (Optional)
- libsndfile >= 1.0.17 (Optional)
- wavpack >= 4.41 (Optional)
- pulseaudio >= 0.9.15 (Optional)
- ffmpeg >= 0.4.9-pre1 (Optional)
- libcdio >= 0.80 (Optional)
- libcddb >= 1.3.1 (Optional)
- faad2 >= 2.6.1 (Optional)
- libbs2b >= 3.0.0 (Optional)
- libprojectM >= 1.2.0 (Optional)
- libenca >= 1.9 (Optional)
- mplayer (Optional)
- cmake >= 2.6.0 (for build only)


Attention! Qmmp build needs lrelease installed. The libqt4-devel package often contains this utility.

Configure:
cmake ./

Build:
make

Installation:
make install

If someone plugin (for example, Jack plugin) doesn't build or doesn't needed you can disable it
by running:
cmake ./ -DUSE_JACK:BOOL=FALSE

Available options:
- USE_CURL, USE_MMS (transports);
- USE_MAD, USE_FLAC, USE_VORBIS, USE_MPC, USE_MODPLUG, USE_SNDFILE, USE_WAVPACK, USE_FFMPEG, USE_AAC, USE_CUE,
  USE_MPLAYER, USE_CDA (decoders);
- USE_ALSA, USE_OSS, USE_JACK, USE_PULSE, USE_NULL, USE_WAVEOUT (output plugins);
- USE_SRC, USE_BS2B, USE_LADSPA (effects);
- USE_ANALYZER, USE_PROJECTM (visualization);
- USE_MPRIS, USE_SCROBBLER, USE_STATICON, USE_NOTIFIER, USE_LYRICS, USE_HAL, USE_HOTKEY, USE_FILEOPS, USE_COVER,
  USE_KDENOTIFY (general plugins);
- USE_QMMP_DIALOG (file dialog);
- USE_ENCA (automatic charset detection);

Also you can use ccmake for changing plugins configuration.
By default program will be installed in /usr/local. You can change default path by running:
cmake ./ -DCMAKE_INSTALL_PREFIX=custom_path

In some cases, you can use qmake for building and installation.

Configure:
qmake-qt4 (or qmake)

Build:
make

Installation:
make install INSTALL_ROOT=/usr/local

Executable:
./bin/qmmp

If someone module doesn't build or doesn't needed you can disable it
in qmmp.pri file - just comment corresponding line( symbol '#').
Attention! By default all modules are enabled.

Changing shared library install path (needed by some 64-bit distributions).
By default, all libraries and plugins will be installed to $(INSTALL PREFIX)/lib. You can change "lib" 
to "lib64" by running qmake-qt4 or cmake with special parameter:
qmake-qt4 LIB_DIR=/lib64
or
cmake ./ -DLIB_DIR=lib64

All patches, bug reports, ideas etc. send to forkotov02@hotmail.ru or use issue tracker
http://code.google.com/p/qmmp/issues/list