mplayer.core
index

# -*- coding: utf-8 -*-
#
# Copyright (C) 2007-2011  Darwin M. Bautista <djclue917 AT gmail>
#
# This file is part of PyMPlayer.
#
# PyMPlayer is free software: you can redistribute it and/or modify
# it under the terms of the GNU Lesser General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# PyMPlayer is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
# GNU Lesser General Public License for more details.
#
# You should have received a copy of the GNU Lesser General Public License
# along with PyMPlayer.  If not, see <http://www.gnu.org/licenses/>.

 
Modules
       
shlex
subprocess

 
Classes
       
__builtin__.object
CommandPrefix
Player
Step

 
class CommandPrefix(__builtin__.object)
    MPlayer command prefixes
 
  Data descriptors defined here:
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)

Data and other attributes defined here:
PAUSING = 'pausing'
PAUSING_KEEP = 'pausing_keep'
PAUSING_KEEP_FORCE = 'pausing_keep_force'
PAUSING_TOGGLE = 'pausing_toggle'

 
class Player(__builtin__.object)
    An out-of-process wrapper for MPlayer. It provides the basic
interface for sending commands and receiving responses to and from
MPlayer. Take note that MPlayer is always started in 'slave',
'idle', and 'quiet' modes.
 
@class attr path: path to the MPlayer executable
@class attr command_prefix: prefix for MPlayer commands (see CommandPrefix)
@property args: MPlayer arguments
@property stdout: process' stdout (read-only)
@property stderr: process' stderr (read-only)
 
  Methods defined here:
__del__(self)
__init__(self, args=(), stdout=-1, stderr=None, autospawn=True)
__repr__(self)
af_add(self, string0, prefix=None)
af_clr(self, prefix=None)
af_cmdline(self, string0, string1, prefix=None)
af_del(self, string0, prefix=None)
af_switch(self, string0, prefix=None)
alt_src_step(self, integer0, prefix=None)
change_rectangle(self, integer0, integer1, prefix=None)
dvb_set_channel(self, integer0, integer1, prefix=None)
dvdnav(self, string0, prefix=None)
edl_loadfile(self, string0, prefix=None)
edl_mark(self, prefix=None)
exit(self, prefix=None)
file_filter(self, integer0, prefix=None)
forced_subs_only(self, integer0='', prefix=None)
frame_step(self, prefix=None)
get_meta_album(self, prefix=None)
get_meta_artist(self, prefix=None)
get_meta_comment(self, prefix=None)
get_meta_genre(self, prefix=None)
get_meta_title(self, prefix=None)
get_meta_track(self, prefix=None)
get_meta_year(self, prefix=None)
help(self, prefix=None)
hide(self, integer0='', prefix=None)
is_alive(self)
Check if MPlayer process is alive.
 
Returns True if alive, else, returns False.
key_down_event(self, integer0, prefix=None)
loadfile(self, string0, integer1='', prefix=None)
loadlist(self, string0, integer1='', prefix=None)
menu(self, string0, prefix=None)
osd_show_progression(self, prefix=None)
osd_show_property_text(self, string0, integer1='', integer2='', prefix=None)
osd_show_text(self, string0, integer1='', integer2='', prefix=None)
overlay_add(self, string0, integer1, integer2, integer3, integer4, prefix=None)
overlay_remove(self, integer0, prefix=None)
pause(self, prefix=None)
pt_step(self, integer0, integer1='', prefix=None)
pt_up_step(self, integer0, integer1='', prefix=None)
quit(self, retcode=0)
Terminate the underlying MPlayer process.
 
Returns the exit status of MPlayer or None if not running.
run(self, string0, prefix=None)
screenshot(self, integer0='', prefix=None)
seek(self, float0, integer1='', prefix=None)
seek_chapter(self, integer0, integer1='', prefix=None)
set_menu(self, string0, string1='', prefix=None)
set_mouse_pos(self, integer0, integer1, prefix=None)
spawn(self)
Spawn the underlying MPlayer process.
 
Returns None if MPlayer is already running.
speed_incr(self, float0, prefix=None)
speed_mult(self, float0, prefix=None)
speed_set(self, float0, prefix=None)
stop(self, prefix=None)
sub_load(self, string0, prefix=None)
sub_log(self, prefix=None)
sub_remove(self, integer0='', prefix=None)
sub_select(self, integer0='', prefix=None)
sub_step(self, integer0, integer1='', prefix=None)
switch_angle(self, integer0='', prefix=None)
switch_ratio(self, float0='', prefix=None)
switch_title(self, integer0='', prefix=None)
switch_vsync(self, integer0='', prefix=None)
teletext_add_dec(self, string0, prefix=None)
teletext_go_link(self, integer0, prefix=None)
tv_last_channel(self, prefix=None)
tv_set_channel(self, string0, prefix=None)
tv_set_freq(self, float0, prefix=None)
tv_set_norm(self, string0, prefix=None)
tv_start_scan(self, prefix=None)
tv_step_chanlist(self, prefix=None)
tv_step_channel(self, integer0, prefix=None)
tv_step_freq(self, float0, prefix=None)
tv_step_norm(self, prefix=None)
use_master(self, prefix=None)
vobsub_lang(self, integer0='', prefix=None)

Class methods defined here:
introspect(cls) from __builtin__.type
Introspect the MPlayer executable
 
Generate available methods and properties.
See http://www.mplayerhq.hu/DOCS/tech/slave.txt

Data descriptors defined here:
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)
angle
Type: int
Min: -2
Max: 10
args
list of MPlayer arguments
aspect
Type: float
* Read-only
ass_use_margins
Type: bool
audio_bitrate
Type: int
* Read-only
audio_codec
Type: str
* Read-only
audio_delay
Type: float
Min: -100
Max: 100
audio_format
Type: int
* Read-only
balance
Type: float
Min: -1
Max: 1
border
Type: bool
brightness
Type: int
Min: -100
Max: 100
capturing
Type: bool
channels
Type: int
* Read-only
chapter
Type: int
Min: 0
chapters
Type: int
* Read-only
contrast
Type: int
Min: -100
Max: 100
deinterlace
Type: bool
demuxer
Type: str
* Read-only
filename
Type: str
* Read-only
filepath
Type: str
* Read-only
fps
Type: float
* Read-only
framedropping
Type: int
Min: 0
Max: 2
fullscreen
Type: bool
gamma
Type: int
Min: -100
Max: 100
height
Type: int
* Read-only
hue
Type: int
Min: -100
Max: 100
length
Type: float
* Read-only
loop
Type: int
Min: -1
metadata
Type: dict
* Read-only
mute
Type: bool
ontop
Type: bool
osdlevel
Type: int
Min: 0
Max: 3
panscan
Type: float
Min: 0
Max: 1
paused
Type: bool
* Read-only
percent_pos
Type: int
Min: 0
Max: 100
rootwin
Type: bool
samplerate
Type: int
* Read-only
saturation
Type: int
Min: -100
Max: 100
speed
Type: float
Min: 0
Max: 100
stderr
stderr of the MPlayer process
stdout
stdout of the MPlayer process
stream_end
Type: int
* Read-only
stream_length
Type: int
* Read-only
stream_pos
Type: int
Min: 0
stream_start
Type: int
* Read-only
stream_time_pos
Type: float
Min: 0
sub
Type: int
Min: -1
sub_alignment
Type: int
Min: 0
Max: 2
sub_delay
Type: float
sub_demux
Type: int
Min: -1
sub_file
Type: int
Min: -1
sub_forced_only
Type: bool
sub_pos
Type: int
Min: 0
Max: 100
sub_scale
Type: float
Min: 0
Max: 100
sub_source
Type: int
Min: -1
Max: 2
sub_visibility
Type: bool
sub_vob
Type: int
Min: -1
switch_audio
Type: int
Min: -2
Max: 65535
switch_program
Type: int
Min: -1
Max: 65535
switch_video
Type: int
Min: -2
Max: 65535
teletext_format
Type: int
Min: 0
Max: 3
teletext_half_page
Type: int
Min: 0
Max: 2
teletext_mode
Type: bool
teletext_page
Type: int
Min: 100
Max: 899
teletext_subpage
Type: int
Min: 0
Max: 64
time_pos
Type: float
Min: 0
tv_brightness
Type: int
Min: -100
Max: 100
tv_contrast
Type: int
Min: -100
Max: 100
tv_hue
Type: int
Min: -100
Max: 100
tv_saturation
Type: int
Min: -100
Max: 100
video_bitrate
Type: int
* Read-only
video_codec
Type: str
* Read-only
video_format
Type: int
* Read-only
volume
Type: float
Min: 0
Max: 100
vsync
Type: bool
width
Type: int
* Read-only

Data and other attributes defined here:
command_prefix = 'pausing_keep_force'
path = 'mplayer'

 
class Step(__builtin__.object)
    A vector which contains information about the step magnitude and direction.
This is meant to be used with property access to implement
the 'step_property' command like so:
 
    p.fullscreen = Step()
    p.time_pos = Step(50, -1)
 
  Methods defined here:
__init__(self, value=0, direction=0)

Data descriptors defined here:
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)

 
Data
        __all__ = ['Player', 'CommandPrefix', 'Step']