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.
   6
   7 MEncoder is a command line video encoder for advanced users that can be built
   8 from the MPlayer source tree. Unofficial graphical frontends exist but are
   9 not included.
  10
  11 This document is for getting you started in a few minutes. It cannot answer all
  12 of your questions. If you have problems, please read the documentation in
  13 DOCS/HTML/en/index.html, which should help you solve most of your problems.
  14 Also read the man page to learn how to use MPlayer.
  15
  16
  17 Requirements:
  18 - POSIX system: You need a POSIX-compatible shell and POSIX-compatible system
  19   tools like grep, sed, awk, etc. in your path.
  20 - You need a working development environment that can compile programs.
  21   On popular Linux distributions, this means having the glibc development
  22   package(s) installed.
  23 - To compile MPlayer with X11 support, you need to have the X Window System
  24   development packages (like for XFree86 or X.Org) installed.
  25
  26
  27 Before you start...
  28 Make sure that your version of X has Xvideo support, without it even very
  29 fast machines may not be able to properly play high resolution videos in
  30 fullscreen mode. Consult DOCS/HTML/en/video.html for details. There you may
  31 also find out about special card-specific video output drivers that can yield
  32 optimal performance.
  33
  34
  35 ______________________
  36 STEP0: Getting MPlayer
  37 ~~~~~~~~~~~~~~~~~~~~~~
  38
  39 Official releases and Subversion snapshots, as well as binary codec packages
  40 available from the download section of our homepage at
  41
  42   http://www.mplayerhq.hu/dload.html
  43
  44 MPlayer has builtin support for the most common audio and video formats. For a
  45 few formats no native decoder exists and external binary codecs are required
  46 to handle them. Examples are newer RealVideo variants and a variety of rare
  47 formats. However, binary codecs are NOT required in this day and age, they are
  48 strictly optional.
  49
  50 Please note that binary codecs only work on the processor architecture they
  51 were compiled for. Choose the correct package for your processor. No other
  52 package is necessary.
  53
  54 Codec packages add support for some more video and audio formats. MPlayer does
  55 not come with any of these by default, you have to download and install them
  56 separately.
  57
  58 You can also get MPlayer via Subversion. Issue the following commands to get
  59 the latest sources:
  60
  61   svn checkout svn://svn.mplayerhq.hu/mplayer/trunk mplayer
  62
  63 A directory named 'mplayer' will be created. It will include all necessary
  64 FFmpeg libraries, you don't need to get them separately as was the case in
  65 the past. You can later update your sources by saying
  66
  67   svn update
  68
  69 from within that directory.
  70
  71
  72 _______________________________
  73 STEP1: Installing Binary Codecs
  74 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  75
  76 Unpack the codecs archives and put the contents in a directory where MPlayer
  77 will find them. The default directory is /usr/local/lib/codecs/ (it used to be
  78 /usr/local/lib/win32 in the past, this also works) but you can change that to
  79 something else by passing the '--codecsdir' option to './configure'.
  80
  81
  82 __________________________
  83 STEP2: Configuring MPlayer
  84 ~~~~~~~~~~~~~~~~~~~~~~~~~~
  85
  86 MPlayer can be adapted to all kinds of needs and hardware environments. Run
  87
  88   ./configure
  89
  90 to configure MPlayer with the default options. If something does not work as
  91 expected, try
  92
  93   ./configure --help
  94
  95 to see the available options and select what you need.
  96
  97 The configure script prints a summary of enabled and disabled options. If you
  98 have something installed that configure fails to detect, check the file
  99 config.log for errors and reasons for the failure. Repeat this step until
 100 you are satisfied with the enabled feature set.
 101
 102
 103 ________________________
 104 STEP3: Compiling MPlayer
 105 ~~~~~~~~~~~~~~~~~~~~~~~~
 106
 107 Now you can start the compilation by typing
 108
 109   make
 110
 111 You can install MPlayer with
 112
 113   make install
 114
 115 provided that you have write permission in the installation directory.
 116
 117 If all went well, you can run MPlayer by typing 'mplayer'. A help screen with a
 118 summary of the most common options and keyboard shortcuts should be displayed.
 119
 120 If you get 'unable to load shared library' or similar errors, run
 121 'ldd ./mplayer' to check which libraries fail and go back to STEP 3 to fix it.
 122 Sometimes running 'ldconfig' is enough to fix the problem.
 123
 124 NOTE: If you run Debian you can configure, compile and build a proper Debian
 125 .deb package with only one command:
 126
 127   fakeroot debian/rules binary
 128
 129 If you want to pass custom options to configure, you can set up the
 130 DEB_BUILD_OPTIONS environment variable. For instance, if you want OSD menu
 131 support you would use:
 132
 133   DEB_BUILD_OPTIONS="--enable-menu" fakeroot debian/rules binary
 134
 135 You can also pass some variables to the Makefile. For example, if you want
 136 to compile with gcc 3.4 even if it's not the default compiler:
 137
 138   CC=gcc-3.4 DEB_BUILD_OPTIONS="--enable-menu" fakeroot debian/rules binary
 139
 140 To clean up the source tree run the following command:
 141
 142   fakeroot debian/rules clean
 143
 144 ______________________________________
 145 STEP4: Choose an onscreen display font
 146 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 147
 148 You can use any TrueType font installed on your system. Just pass '-font
 149 /path/to/font.ttf' on the command line or add 'font=/path/to/font.ttf' to
 150 your configuration file. The manual page has more details. Alternatively
 151 you can create a symbolic link from either ~/.mplayer/subfont.ttf or
 152 /usr/local/share/mplayer/subfont.ttf to your TrueType font.
 153
 154
 155 __________________
 156 STEP5: Let's play!
 157 ~~~~~~~~~~~~~~~~~~
 158
 159 That's it for the moment. To start playing movies, open a command line and try
 160
 161   mplayer <moviefile>
 162
 163 To play a VCD track or a DVD title, try:
 164
 165   mplayer vcd://2 -cdrom-device /dev/hdc
 166   mplayer dvd://1 -alang en -slang hu -dvd-device /dev/hdd
 167
 168 See 'mplayer -help' and 'man mplayer' for further options.
 169
 170 'mplayer -vo help' will show you the available video output drivers. Experiment
 171 with the '-vo' switch to see which one gives you the best performance.
 172 If you get jerky playback or no sound, experiment with the '-ao' switch (see
 173 '-ao help') to choose between different audio drivers. Note that jerky playback
 174 is caused by buggy audio drivers or a slow processor and video card. With a
 175 good audio and video driver combination, one can play DVDs and 720x576 MPEG-4
 176 files smoothly on a Celeron 366. Slower systems may need the '-framedrop'
 177 option.
 178
 179 Questions you may have are probably answered in the rest of the documentation.
 180 The places to start reading are the man page, DOCS/HTML/en/index.html and
 181 DOCS/HTML/en/faq.html. If you find a bug, please report it, but first read
 182 DOCS/HTML/en/bugreports.html.