README

   1
   2 Welcome to MPlayer, the Unix movie player. MPlayer can play most standard video
   3 formats out of the box and almost all others with the help of external codecs.
   4 MPlayer currently works best from the command line, but visual feedback for
   5 many functions is available from its onscreen status display (OSD), which is
   6 also used for displaying subtitles. MPlayer also has a GUI with skin support and
   7 several unofficial alternative graphical frontends are available.
   8
   9 MEncoder is a command line video encoder for advanced users that can be built
  10 from the MPlayer source tree. An unofficial graphical frontend exists but is
  11 not included.
  12
  13 This document is for getting you started in a few minutes. It cannot answer all
  14 of your questions. If you have problems, please read the documentation in
  15 DOCS/en/documentation.html, which should help you solve most of your problems.
  16 Also read the man page to learn how to use MPlayer.
  17
  18
  19 Requirements:
  20 - To compile MPlayer with X11 support, you need to have the XFree86 development
  21   packages installed.
  22 - For the GUI you need the libpng and GTK 1.2 development packages.
  23
  24
  25 Before you start...
  26 Unless you know what are you doing, consult DOCS/en/video.html to see which driver
  27 to use with your video card to get the best quality and performance. Most cards
  28 require special drivers not included with XFree86 to drive their 2-D video
  29 acceleration features like YUV and scaling.
  30
  31 A quick and incomplete list of recommendations:
  32 - ATI cards: Get the GATOS drivers for X11/Xv or use VIDIX.
  33 - Matrox G200/G4x0/G550: Compile and use mga_vid for Linux, on BSD use VIDIX.
  34 - 3dfx Voodoo3/Banshee: Get XFree86 4.2.0+ for Xv or use the tdfxfb driver.
  35 - nVidia cards: Get the X11 driver from www.nvidia.com for Xv support.
  36 - NeoMagic cards: Get an Xv capable driver from our homepage as described in
  37   DOCS/en/video.html.
  38
  39 Without accelerated video even an 800MHz P3 may be too slow to play DVDs.
  40
  41
  42 ______________________
  43 STEP0: Getting MPlayer
  44 ~~~~~~~~~~~~~~~~~~~~~~
  45
  46 Official releases, prereleases and CVS snapshots, as well as fonts for the
  47 OSD, codec packages and a number of different skins for the GUI are available
  48 from the download section of our homepage at
  49
  50   http://www.mplayerhq.hu/homepage/dload.html
  51
  52 A set of fonts is necessary for the OSD and subtitles, the GUI needs at least
  53 one skin and codec packages add support for some more video and audio formats.
  54 MPlayer does not come with any of these by default, you have to download and
  55 install them separately. A wide range of codec packages can be downloaded at
  56
  57   http://www.mplayerhq.hu/MPlayer/releases/codecs/
  58
  59 You can also get MPlayer via anonymous CVS. Issue the following commands to get
  60 the latest sources:
  61
  62   cvs -d:pserver:anonymous@mplayerhq.hu:/cvsroot/mplayer login
  63   cvs -z3 -d:pserver:anonymous@mplayerhq.hu:/cvsroot/mplayer co main
  64
  65 When asked for a password, just hit enter. A directory named 'main' will be
  66 created. You can later update your sources by saying
  67
  68   cvs -z3 update -dPA
  69
  70 from within that directory.
  71
  72
  73 ___________________________________
  74 STEP1: Installing FFmpeg libavcodec
  75 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  76
  77 If you are using an official (pre)release, skip this step, since official
  78 releases include libavcodec. CVS sources and thus CVS snapshots do not include
  79 libavcodec. To verify if you do have libavcodec or not, check if a subdirectory
  80 named 'libavcodec' exists in the MPlayer source tree.
  81
  82 The FFmpeg project provides libavcodec, a very portable codec collection (among
  83 the supported formats is MPEG4/DivX) with excellent quality and speed, that is
  84 the preferred MPEG4/DivX codec of MPlayer. You have to get libavcodec directly
  85 from the FFmpeg CVS server.
  86
  87 To get the FFmpeg sources, use the following commands in a suitable directory
  88 outside the MPlayer source directory:
  89
  90 cvs -d:pserver:anonymous@cvs.ffmpeg.sourceforge.net:/cvsroot/ffmpeg login
  91 cvs -z3 -d:pserver:anonymous@cvs.ffmpeg.sourceforge.net:/cvsroot/ffmpeg co ffmpeg/libavcodec
  92
  93 When asked for a password, you can just hit enter. A directory named 'ffmpeg'
  94 with a subdirectory named 'libavcodec' inside will be created. Copy (symbolic
  95 linking does NOT suffice) this subdirectory into the MPlayer source tree.
  96
  97
  98 ______________________________
  99 STEP2: Installing Win32 Codecs
 100 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 101
 102 MPlayer and libavcodec have builtin support for the most common audio and video
 103 formats, but some formats require external codecs. Examples include Real, Indeo
 104 and Sorenson3 (newer Quicktime) formats. Support for Windows Media formats
 105 except WMV9 exists but still has some bugs, your mileage may vary. This step is
 106 not mandatory, but recommended for getting MPlayer to play a broader range of
 107 formats. Please note that most codecs only work on Intel x86 compatible PCs.
 108
 109 Unpack the codecs archives and put the contents in a directory where MPlayer
 110 will find them. The default directory is /usr/lib/win32/ but you can change
 111 that to something else by using the '--with-win32libdir=DIR' option when you
 112 run './configure'.
 113
 114
 115 __________________________
 116 STEP3: Configuring MPlayer
 117 ~~~~~~~~~~~~~~~~~~~~~~~~~~
 118
 119 MPlayer can be adapted to all kinds of needs and hardware environments. Run
 120
 121   ./configure
 122
 123 to configure MPlayer with the default options. The codecs you installed above
 124 should be autodetected. GUI support has to be enabled separately, run
 125
 126   ./configure --enable-gui
 127
 128 if you want to use the GUI.
 129
 130 If something does not work as expected, try
 131
 132   ./configure --help
 133
 134 to see the available options and select what you need.
 135
 136 The configure script prints a summary of enabled and disabled options. If you
 137 have something installed that configure fails to detect, check the file
 138 configure.log for errors and reasons for the failure. Repeat this step until
 139 you are satisfied with the enabled feature set.
 140
 141
 142 ________________________
 143 STEP4: Compiling MPlayer
 144 ~~~~~~~~~~~~~~~~~~~~~~~~
 145
 146 Now you can start the compilation by typing
 147
 148   make
 149
 150 You can install MPlayer with
 151
 152   make install
 153
 154 provided that you have write permission in the installation directory.
 155
 156 If all went well, you can run MPlayer by typing 'mplayer'. A help screen with a
 157 summary of the most common options and keyboard shortcuts should be displayed.
 158
 159 If you get 'unable to load shared library' or similar errors, run
 160 'ldd ./mplayer' to check which libraries fail and go back to STEP 3 to fix it.
 161 Sometimes running 'ldconfig' is enough to fix the problem.
 162
 163 NOTE: If you run Debian you can configure, compile and build a proper Debian
 164 .deb package with only one command:
 165
 166   fakeroot debian/rules binary
 167
 168
 169 ____________________________________________
 170 STEP5: Installing the onscreen display fonts
 171 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 172
 173 Unpack the archive and choose one of the available font sizes. Then copy the
 174 font files of the corresponding size into /usr/local/share/mplayer/font/ or
 175 ~/.mplayer/font/ (or whatever you set with './configure --datadir=DIR').
 176
 177
 178 ____________________________
 179 STEP6: Installing a GUI skin
 180 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 181
 182 Unpack the archive and put the contents in /usr/local/share/mplayer/Skin/ or
 183 ~/.mplayer/Skin/. MPlayer will use the skin in the subdirectory named default
 184 of /usr/local/share/mplayer/Skin/ or ~/.mplayer/Skin/ unless told otherwise via
 185 the '-skin' switch. You should therefore rename your skin subdirectory or make
 186 a suitable symbolic link.
 187
 188
 189 __________________
 190 STEP7: Let's play!
 191 ~~~~~~~~~~~~~~~~~~
 192
 193 That's it for the moment. To start playing movies, open a command line and try
 194
 195   mplayer <moviefile>
 196
 197 or for the GUI
 198
 199   gmplayer <moviefile>
 200
 201 gmplayer is a symbolic link to mplayer created by 'make install'.
 202 Without <moviefile>, MPlayer will come up and you will be able to use the GUI
 203 filepicker.
 204
 205 To play a VCD track or a DVD title, try:
 206
 207   mplayer -vcd 2 -cdrom-device /dev/hdc
 208   mplayer -dvd 1 -alang en -slang hu -dvd-device /dev/hdd
 209
 210 See 'mplayer -help' and 'man mplayer' for further options.
 211
 212 'mplayer -vo help' will show you the available video output drivers. Experiment
 213 with the '-vo' switch to see which one gives you the best performance.
 214 If you get jerky playback or no sound, experiment with the '-ao' switch (see
 215 '-ao help') to choose between different audio drivers. Note that jerky playback
 216 is caused by buggy audio drivers or a slow processor and video card. With a
 217 good audio and video driver combination, one can play DVDs and 720x576 DivX
 218 files smoothly on a Celeron 366. Slower systems may need the '-framedrop'
 219 option.
 220
 221 Questions you may have are probably answered in the rest of the documentation.
 222 The places to start reading are the man page, DOCS/en/documentation.html and
 223 DOCS/en/faq.html. If you find a bug, read DOCS/en/bugreports.html first!