Command line video player
Go to file
reimar 4153f4e21c Avoid including avcodec.h in demuxer.h (and thus many other files) just to get
FF_INPUT_BUFFER_PADDING_SIZE.
Instead use MP_INPUT_BUFFER_PADDING_SIZE and add a preprocessor check that it
is big enough.


git-svn-id: svn://svn.mplayerhq.hu/mplayer/trunk@27314 b3059339-0415-0410-9bf9-f77b7e298cf2
2008-07-17 17:14:12 +00:00
DOCS Add IDs to some XML elements to avoid warnings. 2008-07-15 22:22:25 +00:00
TOOLS Run bash-specific shell scripts with bash, not sh. 2008-07-07 09:32:21 +00:00
debian
drivers Rename some definitions to avoid clashing with system headers, fixes: 2008-06-23 08:47:50 +00:00
dvdread Use consistent #include paths without "../". 2008-04-28 14:50:24 +00:00
etc Add support for FFmpeg DK3 ADPCM codec and prefer it over MPlayer's 2008-07-13 17:12:41 +00:00
gui Force gcc to emit function body under -gnu99 2008-07-17 10:07:21 +00:00
help r27123: Add verbose messages about trying and searching for audio output drivers. 2008-06-30 12:39:51 +00:00
input Change DVDNAV command key names. 2008-06-19 18:51:42 +00:00
liba52 Check for HAVE_ALTIVEC_VECTOR_BRACES instead of __APPLE_CC__. 2008-05-30 12:05:24 +00:00
libaf Make af_hrtf tables static const 2008-07-15 19:08:09 +00:00
libao2 Our ALSA code needs alloca, so check for it in configure and include alloca.h 2008-07-17 17:11:30 +00:00
libass Fix \fn without an argument consuming the next '\'. 2008-07-09 15:05:56 +00:00
libdvdcss Remove unused file, it has never been compiled. 2008-05-11 14:25:47 +00:00
libfaad2 Merge libfaad2/Makefile into top-level Makefile. 2008-04-24 23:11:16 +00:00
libmenu fixes two bugs: 2008-06-20 20:36:05 +00:00
libmpcodecs Try to keep decoded audio buffer aligned. 2008-07-14 16:38:58 +00:00
libmpdemux Avoid including avcodec.h in demuxer.h (and thus many other files) just to get 2008-07-17 17:14:12 +00:00
libmpeg2 Check for ALTIVEC_H instead of __APPLE_CC__ to decide which AltiVec vector 2008-05-30 12:09:06 +00:00
libswscale Cosmetics: reindent. 2008-07-13 22:27:50 +00:00
libvo One more hack for PBOs on ATI cards. 2008-07-06 07:59:19 +00:00
loader Rename loader/driver.[ch] to loader/drv.[ch], otherwise loader/driver.h can 2008-06-08 10:43:30 +00:00
mp3lib Check for HAVE_ALTIVEC_VECTOR_BRACES instead of __APPLE_CC__. 2008-05-30 12:05:24 +00:00
osdep cosmetics: Remove useless parentheses from return statements. 2008-05-16 09:42:28 +00:00
rpm Give all shell scripts a .sh suffix for consistency. 2008-07-07 09:30:22 +00:00
stream Our ALSA code needs alloca, so check for it in configure and include alloca.h 2008-07-17 17:11:30 +00:00
tremor Instead of removing code from this imported library, place it under #if 0. 2008-05-27 13:09:40 +00:00
vidix Remove -std=gnu99/gnu89/default dialect linux define, as it violates the 2008-07-15 00:21:32 +00:00
AUTHORS Change spelling of XviD to Xvid as has already been done in the (rest of the) 2008-05-31 16:38:02 +00:00
Changelog some updates 2008-06-24 22:36:56 +00:00
Copyright Update homepage and license info for NuppelVideo. 2008-07-06 15:13:04 +00:00
LICENSE
Makefile Rewrite translation handling in the build system. 2008-07-17 12:36:54 +00:00
README
access_mpcontext.h Add MPLAYER_ prefix to multiple inclusion guards. 2008-02-22 09:09:46 +00:00
asxparser.c
asxparser.h Add MPLAYER_ prefix to multiple inclusion guards. 2008-02-22 09:09:46 +00:00
av_opts.c Use standard license header. 2008-05-11 13:42:43 +00:00
av_opts.h Use standard license header. 2008-05-11 13:42:43 +00:00
cfg-common-opts.h Add options to disable some or all config files. 2008-04-14 11:21:29 +00:00
cfg-common.h Add missing #includes to fix 'make checkheaders'. 2008-06-17 08:44:03 +00:00
cfg-mencoder.h Split cfg-common.h into two separate header files. It was being included twice 2008-04-11 09:48:36 +00:00
cfg-mplayer-def.h
cfg-mplayer.h remove extra dash in nocorrect-pts option 2008-05-21 15:11:49 +00:00
codec-cfg.c Fix codec-cfg-test compilation. 2008-05-27 09:03:18 +00:00
codec-cfg.h Add MPLAYER_ prefix to multiple inclusion guards. 2008-02-22 09:09:46 +00:00
command.c Keep old dvdnav sub-command options for a while in order 2008-06-20 18:54:38 +00:00
command.h command.h: Remove unnecessary includes 2008-03-31 04:10:54 +00:00
common.mak Sync with latest FFmpeg changes. 2008-05-09 12:38:33 +00:00
configure Our ALSA code needs alloca, so check for it in configure and include alloca.h 2008-07-17 17:11:30 +00:00
cpudetect.c cosmetics: Remove useless parentheses from return statements. 2008-05-16 09:42:28 +00:00
cpudetect.h Add MPLAYER_ prefix to multiple inclusion guards. 2008-02-22 09:09:46 +00:00
cpuinfo.c
cputable.h Add MPLAYER_ prefix to multiple inclusion guards. 2008-02-22 09:09:46 +00:00
edl.c
edl.h Add MPLAYER_ prefix to multiple inclusion guards. 2008-02-22 09:09:46 +00:00
find_sub.c
fmt-conversion.h Add necessary #includes to pass 'make checkheaders'. 2008-03-04 23:35:24 +00:00
get_path.c On OS/2, fall back on the directory where MPlayer is installed if both 2008-02-24 12:41:51 +00:00
get_path.h Use standard license headers with standard formatting. 2008-05-14 18:02:27 +00:00
m_config.c Replace the trivial command line preparser with a more robust version 2008-04-13 19:18:51 +00:00
m_config.h Add MPLAYER_ prefix to multiple inclusion guards. 2008-02-22 09:09:46 +00:00
m_option.c
m_option.h Replace the trivial command line preparser with a more robust version 2008-04-13 19:18:51 +00:00
m_property.c
m_property.h Add necessary #includes to pass 'make checkheaders'. 2008-03-04 23:35:24 +00:00
m_struct.c
m_struct.h Add MPLAYER_ prefix to multiple inclusion guards. 2008-02-22 09:09:46 +00:00
mangle.h Add MPLAYER_ prefix to multiple inclusion guards. 2008-02-22 09:09:46 +00:00
mencoder.c Fix mencoder built from dvdnav enabled. 2008-06-09 18:43:18 +00:00
metadata.h Use standard license headers with standard formatting. 2008-05-14 18:02:27 +00:00
mixer.c
mixer.h
mp_core.h Add a slave command to stop stream playback. 2008-05-27 18:39:57 +00:00
mp_fifo.c
mp_fifo.h Add MPLAYER_ prefix to multiple inclusion guards. 2008-02-22 09:09:46 +00:00
mp_msg-mencoder.c
mp_msg.c Enable runtime control for colorful and/or module name output 2008-04-12 12:51:07 +00:00
mp_msg.h Remove va_start/vsnprintf workaround for OS/2. 2008-03-01 09:50:06 +00:00
mp_osd.h Add MPLAYER_ prefix to multiple inclusion guards. 2008-02-22 09:09:46 +00:00
mpbswap.h #include config.h before all other headers. 2008-03-14 16:46:13 +00:00
mpcommon.c noconfig fix, disable_gui_conf was not defined when compiling mencoder. 2008-04-15 13:20:15 +00:00
mpcommon.h Add options to disable some or all config files. 2008-04-14 11:21:29 +00:00
mplayer.c Try harder to honour CTRL+C etc. during dumpstream 2008-06-16 18:42:58 +00:00
mplayer.h Add MPLAYER_ prefix to multiple inclusion guards. 2008-02-22 09:09:46 +00:00
parser-cfg.c Replace the trivial command line preparser with a more robust version 2008-04-13 19:18:51 +00:00
parser-cfg.h Replace the trivial command line preparser with a more robust version 2008-04-13 19:18:51 +00:00
parser-mecmd.c
parser-mecmd.h Add necessary #includes to pass 'make checkheaders'. 2008-03-04 23:35:24 +00:00
parser-mpcmd.c Include some .h files in corresponding .c files 2008-03-28 01:07:59 +00:00
parser-mpcmd.h Add necessary #includes to pass 'make checkheaders'. 2008-03-04 23:35:24 +00:00
playtree.c revert non-acked r27106 2008-06-21 09:15:25 +00:00
playtree.h Add MPLAYER_ prefix to multiple inclusion guards. 2008-02-22 09:09:46 +00:00
playtreeparser.c
playtreeparser.h Add necessary #includes to pass 'make checkheaders'. 2008-03-04 23:35:24 +00:00
spudec.c cosmetics: Remove useless parentheses from return statements. 2008-05-16 09:42:28 +00:00
spudec.h
sub_cc.c
sub_cc.h Add MPLAYER_ prefix to multiple inclusion guards. 2008-02-22 09:09:46 +00:00
subdir.mak Sync with latest FFmpeg changes. 2008-04-13 10:54:33 +00:00
subopt-helper.c
subopt-helper.h Add MPLAYER_ prefix to multiple inclusion guards. 2008-02-22 09:09:46 +00:00
subreader.c Clear iconv conversion state after each subtitle line. 2008-05-29 18:35:17 +00:00
subreader.h
unrar_exec.c Use standard license headers with standard formatting. 2008-05-14 18:02:27 +00:00
unrar_exec.h Use standard license headers with standard formatting. 2008-05-14 18:02:27 +00:00
version.sh
vobsub.c Add detection code for abnormal pts jump when seeking previous. 2008-05-14 03:43:45 +00:00
vobsub.h
xvid_vbr.c
xvid_vbr.h Add MPLAYER_ prefix to multiple inclusion guards. 2008-02-22 09:09:46 +00:00
xvmc_render.h Add MPLAYER_ prefix to multiple inclusion guards. 2008-02-22 09:09:46 +00:00

README

Welcome to MPlayer, The Movie Player. MPlayer can play most standard video
formats out of the box and almost all others with the help of external codecs.
MPlayer currently works best from the command line, but visual feedback for
many functions is available from its onscreen status display (OSD), which is
also used for displaying subtitles. MPlayer also has a GUI with skin support and
several unofficial alternative graphical frontends are available.

MEncoder is a command line video encoder for advanced users that can be built
from the MPlayer source tree. Unofficial graphical frontends exist but are
not included.

This document is for getting you started in a few minutes. It cannot answer all
of your questions. If you have problems, please read the documentation in
DOCS/HTML/en/index.html, which should help you solve most of your problems.
Also read the man page to learn how to use MPlayer.


Requirements:
- You need a working development environment that can compile programs.
  On popular Linux distributions, this means having the glibc development
  package(s) installed.
- To compile MPlayer with X11 support, you need to have the X Window System
  development packages (like for XFree86 or X.Org) installed.
- For the GUI you need the GTK development packages.


Before you start...
Make sure that your version of X has Xvideo support, without it even very
fast machines may not be able to properly play high resolution videos in
fullscreen mode. Consult DOCS/HTML/en/video.html for details. There you may
also find out about special card-specific video output drivers that can yield
optimal performance.


______________________
STEP0: Getting MPlayer
~~~~~~~~~~~~~~~~~~~~~~

Official releases and Subversion snapshots, as well as binary codec packages
and a number of different skins for the GUI are available from the download
section of our homepage at

  http://www.mplayerhq.hu/dload.html

The GUI needs at least one skin and codec packages add support for some more
video and audio formats. MPlayer does not come with any of these by default,
you have to download and install them separately.

You can also get MPlayer via Subversion. Issue the following commands to get
the latest sources:

  svn checkout svn://svn.mplayerhq.hu/mplayer/trunk mplayer

A directory named 'mplayer' will be created. It will include all necessary
FFmpeg libraries, you don't need to get them separately as was the case in
the past. You can later update your sources by saying

  svn update

from within that directory.


_______________________________
STEP1: Installing Binary Codecs
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

MPlayer has builtin support for the most common audio and video formats. For a
few formats no native decoder exists and external binary codecs are required
to handle them, for example newer RealVideo variants and a variety of uncommon
formats. This step is not mandatory, but recommended for getting MPlayer to
play a broader range of formats. Please note that binary codecs only work on
the processor architecture they were compiled for.

Unpack the codecs archives and put the contents in a directory where MPlayer
will find them. The default directory is /usr/local/lib/codecs/ (it used to be
/usr/local/lib/win32 in the past, this also works) but you can change that to
something else by passing the '--codecsdir' option to './configure'.


__________________________
STEP2: Configuring MPlayer
~~~~~~~~~~~~~~~~~~~~~~~~~~

MPlayer can be adapted to all kinds of needs and hardware environments. Run

  ./configure

to configure MPlayer with the default options. GUI support has to be enabled
separately, run

  ./configure --enable-gui

if you want to use the GUI.

If something does not work as expected, try

  ./configure --help

to see the available options and select what you need.

The configure script prints a summary of enabled and disabled options. If you
have something installed that configure fails to detect, check the file
configure.log for errors and reasons for the failure. Repeat this step until
you are satisfied with the enabled feature set.


________________________
STEP3: Compiling MPlayer
~~~~~~~~~~~~~~~~~~~~~~~~

Now you can start the compilation by typing

  make

You can install MPlayer with

  make install

provided that you have write permission in the installation directory.

If all went well, you can run MPlayer by typing 'mplayer'. A help screen with a
summary of the most common options and keyboard shortcuts should be displayed.

If you get 'unable to load shared library' or similar errors, run
'ldd ./mplayer' to check which libraries fail and go back to STEP 3 to fix it.
Sometimes running 'ldconfig' is enough to fix the problem.

NOTE: If you run Debian you can configure, compile and build a proper Debian
.deb package with only one command:

  fakeroot debian/rules binary

If you want to pass custom options to configure, you can set up the
DEB_BUILD_OPTIONS environment variable. For instance, if you want GUI
and OSD menu support you would use:

  DEB_BUILD_OPTIONS="--enable-gui --enable-menu" fakeroot debian/rules binary

You can also pass some variables to the Makefile. For example, if you want
to compile with gcc 3.4 even if it's not the default compiler:

  CC=gcc-3.4 DEB_BUILD_OPTIONS="--enable-gui" fakeroot debian/rules binary

To clean up the source tree run the following command:

  fakeroot debian/rules clean

______________________________________
STEP4: Choose an onscreen display font
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

You can use any TrueType font installed on your system. Just pass '-font
/path/to/font.ttf' on the command line or add 'font=/path/to/font.ttf' to
your configuration file. The manual page has more details. Alternatively
you can create a symbolic link from either ~/.mplayer/subfont.ttf or
/usr/local/share/mplayer/subfont.ttf to your TrueType font.


____________________________
STEP5: Installing a GUI skin
~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Unpack the archive and put the contents in /usr/local/share/mplayer/skins/ or
~/.mplayer/skins/. MPlayer will use the skin in the subdirectory named default
of /usr/local/share/mplayer/skins/ or ~/.mplayer/skins/ unless told otherwise
via the '-skin' switch. You should therefore rename your skin subdirectory or
make a suitable symbolic link.


__________________
STEP6: Let's play!
~~~~~~~~~~~~~~~~~~

That's it for the moment. To start playing movies, open a command line and try

  mplayer <moviefile>

or for the GUI

  gmplayer <moviefile>

gmplayer is a symbolic link to mplayer created by 'make install'.
Without <moviefile>, gmplayer will start with the GUI filepicker.

To play a VCD track or a DVD title, try:

  mplayer vcd://2 -cdrom-device /dev/hdc
  mplayer dvd://1 -alang en -slang hu -dvd-device /dev/hdd

See 'mplayer -help' and 'man mplayer' for further options.

'mplayer -vo help' will show you the available video output drivers. Experiment
with the '-vo' switch to see which one gives you the best performance.
If you get jerky playback or no sound, experiment with the '-ao' switch (see
'-ao help') to choose between different audio drivers. Note that jerky playback
is caused by buggy audio drivers or a slow processor and video card. With a
good audio and video driver combination, one can play DVDs and 720x576 MPEG-4
files smoothly on a Celeron 366. Slower systems may need the '-framedrop'
option.

Questions you may have are probably answered in the rest of the documentation.
The places to start reading are the man page, DOCS/HTML/en/index.html and
DOCS/HTML/en/faq.html. If you find a bug, please report it, but first read
DOCS/HTML/en/bugreports.html.