omxplayer(1) -- Raspberry Pi command line OMX player

OMXPlayer is a commandline OMX player for the Raspberry Pi. It was developed as a testbed for the XBMC Raspberry PI implementation and is quite handy to use standalone.

DOWNLOADING

git clone https://github.com/popcornmix/omxplayer.git

HELP AND DOCS

omxplayer's built-in help and the man page are all generated from this README.md file during make. You may need to change the Makefile if you modify the structure of README.md!

COMPILING

Run this script which will install build dependency packages, including g++ 4.7, and update firmware

./prepare-native-raspbian.sh

Build with

make ffmpeg
make

Install with

sudo make install

CROSS COMPILING

You need the content of your sdcard somewhere mounted or copied. There might be development headers to install on the running Pi system for the crosscompiling.

Edit Makefile.include and change the settings according your locations.

make ffmpeg
make
make dist

Installing OMXPlayer

You may want to specify a valid font path inside the omxplayer shell script. Copy over omxplayer-dist/* to the Pi /.

SYNOPSIS

Usage: omxplayer [OPTIONS] [FILE]

-h  --help                  Print this help
-v  --version               Print version info
-k  --keys                  Print key bindings
-n  --aidx  index           Audio stream index    : e.g. 1
-o  --adev  device          Audio out device      : e.g. hdmi/local/both
-i  --info                  Dump stream format and exit
-I  --with-info             dump stream format before playback
-s  --stats                 Pts and buffer stats
-p  --passthrough           Audio passthrough
-d  --deinterlace           Force deinterlacing
    --nodeinterlace         Force no deinterlacing
    --nativedeinterlace     let display handle interlace
    --anaglyph type         convert 3d to anaglyph
-w  --hw                    Hw audio decoding
-3  --3d mode               Switch tv into 3d mode (e.g. SBS/TB)
-M  --allow-mvc             Allow decoding of both views of MVC stereo stream
-y  --hdmiclocksync         Display refresh rate to match video (default)
-z  --nohdmiclocksync       Do not adjust display refresh rate to match video
-t  --sid index             Show subtitle with index
-r  --refresh               Adjust framerate/resolution to video
-g  --genlog                Generate log file
-l  --pos n                 Start position (hh:mm:ss)
-b  --blank                 Set background to black
    --loop                  Loop file. Ignored if file not seekable
    --no-boost-on-downmix   Don't boost volume when downmixing
    --vol n                 set initial volume in millibels (default 0)
    --amp n                 set initial amplification in millibels (default 0)
    --no-osd                Do not display status information on screen
    --no-keys               Disable keyboard input (prevents hangs for certain TTYs)
    --subtitles path        External subtitles in UTF-8 srt format
    --font path             Default: /usr/share/fonts/truetype/freefont/FreeSans.ttf
    --italic-font path      Default: /usr/share/fonts/truetype/freefont/FreeSansOblique.ttf
    --font-size size        Font size in 1/1000 screen height (default: 55)
    --align left/center     Subtitle alignment (default: left)
    --no-ghost-box          No semitransparent boxes behind subtitles
    --lines n               Number of lines in the subtitle buffer (default: 3)
    --win 'x1 y1 x2 y2'     Set position of video window
    --win x1,y1,x2,y2       Set position of video window
    --audio_fifo  n         Size of audio output fifo in seconds
    --video_fifo  n         Size of video output fifo in MB
    --audio_queue n         Size of audio input queue in MB
    --video_queue n         Size of video input queue in MB
    --threshold   n         Amount of buffered data required to finish buffering [s]
    --timeout     n         Timeout for stalled file/network operations (default 10s)
    --orientation n         Set orientation of video (0, 90, 180 or 270)
    --fps n                 Set fps of video where timestamps are not present
    --live                  Set for live tv or vod type stream
    --layout                Set output speaker layout (e.g. 5.1)
    --dbus_name name        default: org.mpris.MediaPlayer2.omxplayer
    --key-config <file>     Uses key bindings in <file> instead of the default
    --alpha                 Set video transparency (0..255)
    --layer n               Set video render layer number (higher numbers are on top)
    --display n             Set display to output to
    --cookie 'cookie'       Send specified cookie as part of HTTP requests
    --user-agent 'ua'       Send specified User-Agent as part of HTTP requests

For example:

./omxplayer -p -o hdmi test.mkv

KEY BINDINGS

Key bindings to control omxplayer while playing:

1           decrease speed
2           increase speed
<           rewind
>           fast forward
z           show info
j           previous audio stream
k           next audio stream
i           previous chapter
o           next chapter
n           previous subtitle stream
m           next subtitle stream
s           toggle subtitles
w           show subtitles
x           hide subtitles
d           decrease subtitle delay (- 250 ms)
f           increase subtitle delay (+ 250 ms)
q           exit omxplayer
p / space   pause/resume
-           decrease volume
+ / =       increase volume
left arrow  seek -30 seconds
right arrow seek +30 seconds
down arrow  seek -600 seconds
up arrow    seek +600 seconds

KEY CONFIG SYNTAX

A key config file is a series of rules of the form [action]:[key]. Multiple keys can be bound to the same action, and comments are supported by adding a # in front of the line. The list of valid [action]s roughly corresponds to the list of default key bindings above and are:

DECREASE_SPEED
INCREASE_SPEED
REWIND
FAST_FORWARD
SHOW_INFO
PREVIOUS_AUDIO
NEXT_AUDIO
PREVIOUS_CHAPTER
NEXT_CHAPTER
PREVIOUS_SUBTITLE
NEXT_SUBTITLE
TOGGLE_SUBTITLE
DECREASE_SUBTITLE_DELAY
INCREASE_SUBTITLE_DELAY
EXIT
PAUSE
DECREASE_VOLUME
INCREASE_VOLUME
SEEK_BACK_SMALL
SEEK_FORWARD_SMALL
SEEK_BACK_LARGE
SEEK_FORWARD_LARGE
STEP

Valid [key]s include all alpha-numeric characters and most symbols, as well as:

left
right
up
down
esc
hex [keycode]

For example:

EXIT:esc
PAUSE:p
#Note that this next line has a space after the :
PAUSE: 
REWIND:left
SEEK_FORWARD_SMALL:hex 0x4f43
EXIT:q

DBUS CONTROL

omxplayer can be controlled via DBUS. There are three interfaces, all of which present a different set of commands. For examples on working with DBUS take a look at the supplied dbuscontrol.sh file.

Root Interface

The root interface is accessible under the name org.mpris.MediaPlayer2.

Quit

Stops the currently playing video. This will cause the currently running omxplayer process to terminate.

Params	Type
Return	`null`

Properties Interface

The properties interface is accessible under the name org.freedesktop.DBus.Properties.

CanQuit

Whether or not the player can quit.

Params	Type
Return	`boolean`

Fullscreen

Whether or not the player can is fullscreen.

Params	Type
Return	`boolean`

CanSetFullscreen

Whether or not the player can set fullscreen.

Params	Type
Return	`boolean`

CanRaise

Whether the display window can be brought to the top of all the window.

Params	Type
Return	`boolean`

HasTrackList

Whether or not the player has a track list.

Params	Type
Return	`boolean`

Identity

Name of the player.

Params	Type
Return	`string`

SupportedUriSchemes

Playable URI formats.

Params	Type
Return	`string[]`

SupportedMimeTypes

Supported mime types. Note: currently not implemented.

Params	Type
Return	`string[]`

CanGoNext

Whether or not the play can skip to the next track.

Params	Type
Return	`boolean`

CanGoPrevious

Whether or not the player can skip to the previous track.

Params	Type
Return	`boolean`

CanSeek

Whether or not the player can seek.

Params	Type
Return	`boolean`

CanControl

Whether or not the player can be controlled.

Params	Type
Return	`boolean`

CanPlay

Whether or not the player can play.

Return type: boolean.

CanPause

Whether or not the player can pause.

Params	Type
Return	`boolean`

PlaybackStatus

The current state of the player, either "Paused" or "Playing".

Params	Type
Return	`string`

Volume

When called with an argument it will set the volume and return the current volume. When called without an argument it will simply return the current volume. As defined by the MPRIS specifications, this value should be greater than or equal to 0. 1 is the normal volume. Everything below is quieter than normal, everything above is louder.

Millibels can be converted to/from acceptable values using the following:

volume = pow(10, mB / 2000.0);
mB     = 2000.0 * log10(volume)

Params	Type	Description
1 (optional)	`double`	Volume to set
Return	`double`	Current volume

Mute

Mute the audio stream. If the volume is already muted, this does nothing.

Params	Type
Return	`null`

Unmute

Unmute the audio stream. If the stream is already unmuted, this does nothing.

Params	Type
Return	`null`

Position

Returns the current position of the playing media.

Params	Type	Description
Return	`int64`	Current position in microseconds

Duration

Returns the total length of the playing media.

Params	Type	Description
Return	`int64`	Total length in microseconds

MinimumRate

Returns the minimum playback rate of the video.

Params	Type
Return	`double`

MaximumRate

Returns the maximum playback rate of the video.

Params	Type
Return	`double`

Player Interface

Pause

Toggles the play state. If the video is playing, it will be paused, if it is paused it will start playing.

Params	Type
Return	`null`

PlayPause

Same as the Pause method.

Stop

Stops the video.

Params	Type
Return	`null`

Seek

Perform a relative seek, i.e. seek plus or minus a certain number of microseconds from the current position in the video.

Params	Type	Description
1	`int64`	Microseconds to seek
Return	`null` or `int64`	If the supplied offset is invalid, `null` is returned, otherwise the offset (in microseconds) is returned

SetPosition

Seeks to a specific location in the file. This is an absolute seek.

Params	Type	Description
1	`string`	Path (not currently used)
2	`int64`	Position to seek to, in microseconds
Return	`null` or `int64`	If the supplied position is invalid, `null` is returned, otherwise the position (in microseconds) is returned

ListSubtitles

Returns a array of all known subtitles. The length of the array is the number of subtitles. Each item in the araay is a string in the following format:

<index>:<language>:<name>:<codec>:<active>

Any of the fields may be blank, except for index. language is the language code, such as eng, chi, swe, etc. name is a description of the subtitle, such as foreign parts or SDH. codec is the name of the codec used by the subtitle, sudh as subrip. active is either the string active or an empty string.

Params	Type
Return	`string[]`

ListAudio

Returns and array of all known audio streams. The length of the array is the number of streams. Each item in the array is a string in the following format:

<index>:<language>:<name>:<codec>:<active>

See ListSubtitles for a description of what each of these fields means. An example of a possible string is:

0:eng:DD 5.1:ac3:active

Params	Type
Return	`string[]`

ListVideo

Returns and array of all known video streams. The length of the array is the number of streams. Each item in the array is a string in the following format:

<index>:<language>:<name>:<codec>:<active>