README

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