Command line video player
Go to file
albeu 17ac1fe1ce Fix the step_property coammand to correctly handle the step size with
all numerical types.


git-svn-id: svn://svn.mplayerhq.hu/mplayer/trunk@23429 b3059339-0415-0410-9bf9-f77b7e298cf2
2007-05-31 09:13:21 +00:00
DOCS sync.d up to r23425!!! ehi, it's updated :))) 2007-05-31 00:19:40 +00:00
TOOLS test for tab characters 2007-05-07 17:34:31 +00:00
debian
drivers cosmetics: Shorten overly long lines. 2007-03-24 13:12:55 +00:00
dvdread Remove CFLAGS that are already set by configure. 2007-03-16 22:01:41 +00:00
etc Drop the metadata stuff and replace it with generic property string expansion. 2007-05-30 07:07:32 +00:00
gui Remove two useless fastmemcpy.h includes in gui code. 2007-05-27 20:40:04 +00:00
help little fix 2007-05-31 00:21:25 +00:00
input buggy joystick initialization, works much better without this 2007-05-19 16:59:24 +00:00
liba52 Move test program removal on distclean to mpcommon.mak. 2007-03-24 15:03:57 +00:00
libaf Add general variables for either static or shared FFmpeg libraries. 2007-04-26 11:22:22 +00:00
libao2 Remove some unused variables, patch by timwoj ieee org. 2007-05-28 08:42:35 +00:00
libass Fix #if condition. 2007-05-20 17:56:39 +00:00
libdvdcss Move setting Cygwin specific CFLAGS to configure. 2007-03-19 00:03:00 +00:00
libfaad2 Simplify CFLAGS handling. 2007-03-13 22:17:48 +00:00
libmenu Drop the metadata stuff and replace it with generic property string expansion. 2007-05-30 07:07:32 +00:00
libmpcodecs Remove some unused variables, patch by timwoj ieee org. 2007-05-28 08:42:35 +00:00
libmpdemux Use play duration instead of send duration to calculate the length 2007-05-30 08:36:38 +00:00
libmpeg2 add MPlayer's local changes introduced in r23258 2007-05-07 23:26:40 +00:00
libswscale rename attribute_unused to av_unused as it is declared in common.h 2007-05-30 09:33:09 +00:00
libvo Add LGPL license header. 2007-05-28 17:13:52 +00:00
loader typo fixes ported from VLC 2007-04-01 14:42:13 +00:00
mp3lib Record what was produced by make_decode_table_MMX() and used that data to 2007-05-25 02:52:35 +00:00
osdep "()" to "(void)" function param list fixes 2007-04-01 21:59:54 +00:00
stream Remove some unused variables, patch by timwoj ieee org. 2007-05-28 08:42:35 +00:00
tremor Put special CFLAGS for low accuracy tremor in the Makefile, similar to the 2007-03-16 21:54:48 +00:00
vidix Remove awk test. awk is a basic Unix tool, any implementation is sufficient. 2007-05-17 21:48:56 +00:00
AUTHORS Adding myself to the authors page. 2007-05-31 04:15:29 +00:00
Changelog update changelog and bump codecs.conf release number 2007-05-11 12:58:06 +00:00
Copyright Remove obsolete TV output tools. 2007-03-31 14:21:06 +00:00
LICENSE
Makefile Compile internal FFmpeg libraries only when configure enabled the static 2007-05-11 23:15:11 +00:00
README The GUI no longer depends on libpng. 2007-05-03 14:36:46 +00:00
access_mpcontext.h Fix GUI compilation 2007-02-21 19:14:49 +00:00
asxparser.c
asxparser.h
cfg-common.h add new -subfont option, that allows having a different font for OSD (controls and menu) and subtitles 2007-05-20 16:10:45 +00:00
cfg-mencoder.h Make liblzo conditional to the appropriate #defines. 2007-02-18 19:28:47 +00:00
cfg-mplayer-def.h
cfg-mplayer.h new -menu-chroot option that prevent OSD file selection menu to go to an unwanted location (yeah, chroot ;-)) 2007-05-29 18:49:38 +00:00
codec-cfg.c Fix comment about test application compilation. 2007-03-12 08:52:45 +00:00
codec-cfg.h qdrw changed output format in ffmpeg r8630, sync codecs.conf and require 2007-04-07 16:14:51 +00:00
command.c Fix the step_property coammand to correctly handle the step size with 2007-05-31 09:13:21 +00:00
command.h Make command.h usable without the MPContext typedef. 2007-05-30 07:05:34 +00:00
common.mak
configure Add "uclinux" as an accepted system type in the linux() test. 2007-05-21 06:54:06 +00:00
cpudetect.c
cpudetect.h
cpuinfo.c 10l: cosmetic: more trailing whitespaces removed 2007-05-21 07:47:53 +00:00
cputable.h
edl.c
edl.h
find_sub.c
fmt-conversion.h
get_path.c
m_config.c
m_config.h
m_option.c remove C99-ism (mixed declaration and code), 2007-02-28 09:18:42 +00:00
m_option.h Move parsing of the -ss option to the option code. 2007-02-24 07:11:57 +00:00
m_property.c Fix fallback on the default GET_TYPE for unvailable/disabled 2007-05-30 06:39:21 +00:00
m_property.h Make all the info available via the metadata API available via properties. 2007-05-29 22:14:41 +00:00
m_struct.c
m_struct.h
mangle.h
mencoder.c add new -subfont option, that allows having a different font for OSD (controls and menu) and subtitles 2007-05-20 16:10:45 +00:00
metadata.h
mixer.c
mixer.h
mp_core.h Move the sh_audio->delay field to mpctx->delay. 2007-03-11 06:16:14 +00:00
mp_fifo.c Code cleanup: don't include a .c file in mplayer.c and fix a few 2007-03-29 17:16:11 +00:00
mp_fifo.h Missing svn add from r22841. 2007-03-29 17:21:17 +00:00
mp_msg-mencoder.c
mp_msg.c Gui --> gui 2007-04-23 07:42:42 +00:00
mp_msg.h cosmetics: Fix some common typos, appropiate --> appropRiate, 2007-02-24 10:27:14 +00:00
mpbswap.h
mpcommon.c
mpcommon.h
mpcommon.mak cosmetics: Remove CONFIG_ prefix from FFmpeg library Makefile variables. 2007-04-25 08:35:35 +00:00
mplayer.c add new -subfont option, that allows having a different font for OSD (controls and menu) and subtitles 2007-05-20 16:10:45 +00:00
mplayer.h add new -subfont option, that allows having a different font for OSD (controls and menu) and subtitles 2007-05-20 16:10:45 +00:00
parser-cfg.c
parser-cfg.h
parser-mecmd.c
parser-mecmd.h
parser-mpcmd.c
parser-mpcmd.h
playtree.c
playtree.h cosmetics: typo fixes, usefuLL --> useful and aswell --> as well 2007-02-22 00:18:10 +00:00
playtreeparser.c Support multiple tags in a single line and tags on the same line as the 2007-03-18 21:39:52 +00:00
playtreeparser.h
spudec.c Replace MIN with FFMIN 2007-03-01 12:54:38 +00:00
spudec.h
sub_cc.c
sub_cc.h
subopt-helper.c cosmetics: Fix some common typos, sepErate --> sepArate, deciSSion --> deciSion. 2007-02-21 10:05:46 +00:00
subopt-helper.h
subreader.c 10l: comparison of char* ptrs with string literals 2007-02-19 10:48:50 +00:00
subreader.h Fixes: 2007-03-25 19:25:11 +00:00
unrarlib.c
unrarlib.h
version.sh
vobsub.c Use libavutil's av_clip* instead of unreadable MIN/MAX chaos. 2007-03-01 12:54:08 +00:00
vobsub.h
xvid_vbr.c "inline" is used elsewhere and more portable than "__inline" 2007-05-16 21:50:59 +00:00
xvid_vbr.h
xvmc_render.h sync to lavcodecs version 2007-03-26 15:23:15 +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.