Xine.Foreign

A simple binding to xine-lib. Low-level bindings. Made for xine-lib version 1.1.18.1

Version information

xine_get_version_string :: String

Get xine-lib version string.

Header declaration:

const char *xine_get_version_string (void)

xine_get_version :: (Int, Int, Int)

Get version as a triple: major, minor, sub

Header declaration:

void xine_get_version (int *major, int *minor, int *sub)

xine_check_version :: Int -> Int -> Int -> Bool

Compare given version to xine-lib version (major, minor, sub).

Header declaration:

int xine_check_version (int major, int minor, int sub)

returns 1 if compatible, 0 otherwise.

Global engine handling

data Engine

An opaque type, never dereferenced on the Haskell side XXX: document me

data AudioPort

An opaque type, never dereferenced on the Haskell side XXX: document me

data VideoPort

An opaque type, never dereferenced on the Haskell side XXX: document me

data VisualType

Valid visual types

Constructors

None

X11

X11_2

AA

FB

GTK

DFB

PM

DirectX

CACA

MacOSX

XCB

Raw

Instances

Enum VisualType

Eq VisualType

xine_new :: IO Engine

Pre-init the xine engine.

Header declaration:

xine_t *xine_new (void)

xine_init :: Engine -> IO ()

Post-init the xine engine.

Header declaration:

void xine_init (xine_t *self)

xine_open_audio_driver :: Engine -> Maybe String -> IO (Maybe AudioPort)

Initialise audio driver.

Header declaration:

xine_audio_port_t *xine_open_audio_driver (xine_t *self, const char *id, void *data)

id: identifier of the driver, may be NULL for auto-detection

data: special data struct for ui/driver communication

May return NULL if the driver failed to load.

xine_open_video_driver :: Engine -> Maybe String -> VisualType -> IO (Maybe VideoPort)

Initialise video driver.

Header declaration:

xine_video_port_t *xine_open_video_driver (xine_t *self, const char *id, int visual, void *data)

id: identifier of the driver, may be NULL for auto-detection

data: special data struct for ui/driver communication

visual : video driver flavor selector

May return NULL if the driver failed to load.

xine_close_audio_driver :: Engine -> AudioPort -> IO ()

Close audio port.

Header declaration:

void xine_close_audio_driver (xine_t *self, xine_audio_port_t *driver)

xine_close_video_driver :: Engine -> VideoPort -> IO ()

Close video port.

Header declaration:

void xine_close_video_driver (xine_t *self, xine_video_port_t *driver)

xine_exit :: Engine -> IO ()

Free all resources, close all plugins, close engine.

Header declaration:

void xine_exit (xine_t *self)

Stream handling

data Stream

An opaque type, never dereferenced on the Haskell side

data StreamParam

Stream parameter enumeration.

Constructors

Speed

AvOffset

AudioChannelLogical

SpuChannel

AudioVolume

AudioMute

AudioComprLevel

AudioReportLevel

Verbosity

SpuOffset

IgnoreVideo

IgnoreAudio

BroadcasterPort

MetronomPrebuffer

Eq30Hz

Eq60Hz

Eq125Hz

Eq500Hz

Eq1000Hz

Eq2000Hz

Eq4000Hz

Eq8000Hz

Eq16000Hz

AudioCloseDevice

AmpMute

FineSpeed

EarlyFinishedEvent

GaplessSwitch

DelayFinishedEvent

Deinterlace

AspectRatio

Hue

Saturation

Contrast

Brightness

ZoomX

ZoomY

PanScan

TvMode

WindowWidth

WindowHeight

CropLeft

CropRight

CropTop

CropBottom

Instances

Enum StreamParam

data Speed

Values for XINE_PARAM_SPEED parameter.

Constructors

Pause

Slow4

Slow2

Normal

Fast2

Fast4

Instances

Enum Speed

Eq Speed

data NormalSpeed

Value for XINE_PARAM_FINE_SPEED

Constructors

NormalSpeed

Instances

Enum NormalSpeed

data Zoom

Values for XINE_PARAM_VO_ZOOM_

Constructors

ZoomStep

ZoomMax

ZoomMin

Instances

Enum Zoom

data AspectRatio

Values for XINE_PARAM_VO_ASPECT_RATIO

Constructors

AspectAuto

AspectSquare

Aspect43

AspectAnamorphic

AspectDvb

AspectNumRatios

Instances

Enum AspectRatio

data DemuxStrategy

Stream format detection strategies

Constructors

DemuxDefault

DemuxRevert

DemuxContent

DemuxExtension

Instances

Enum DemuxStrategy

data Verbosity

Verbosity setting

Constructors

VerbosityNone

VerbosityLog

VerbosityDebug

Instances

Enum Verbosity

type MRL = String

Media Resource Locator. Describes the media to read from. Valid MRLs may be plain file names or one of the following:

• Filesystem:

file:<path>

fifo:<path>

stdin:/

• CD and DVD:

dvd:/[device_name][/title[.part]]

dvd:/DVD_image_file[/title[.part]]

dvd:/DVD_directory[/title[.part]]

vcd://[CD_image_or_device_name][@[letter]number]

vcdo://track_number

cdda:/[device][/track_number]

• Video devices:

v4l://[tuner_device/frequency

v4l2://tuner_device

dvb://channel_number

dvb://channel_name

dvbc://channel_name:tuning_parameters

dvbs://channel_name:tuning_parameters

dvbt://channel_name:tuning_parameters

dvba://channel_name:tuning_parameters

pvr:/tmp_files_path!saved_files_path!max_page_age

• Network:

http://host

tcp://host[:port]

udp://host[:port[?iface=interface]]

rtp://host[:port[?iface=interface]]

smb://

mms://host

pnm://host

rtsp://host

data EngineParam

Engine parameter enumeration.

Constructors

EngineVerbosity

Instances

Enum EngineParam

data Affection

The affection determines which actions on the master stream are also to be applied to the slave stream. See xine_stream_master_slave.

Constructors

AffectionPlay

AffectionStop

AffectionSpeed

Instances

Enum Affection

data TrickMode

Constructors

TrickOff

TrickSeekToPosition

TrickSeekToTime

TrickFastForward

TrickRewind

Instances

Enum TrickMode

xine_stream_new :: Engine -> AudioPort -> VideoPort -> IO (Maybe Stream)

Create a new stream for media playback.

Header declaration:

xine_stream_t *xine_stream_new (xine_t *self, xine_audio_port *ao, xine_video_port_t *vo)

Returns xine_stream_t* if OK, NULL on error (use xine_get_error for details).

xine_stream_master_slave :: Stream -> Stream -> [Affection] -> IO Int

Make one stream the slave of another. Certain operations on the master stream are also applied to the slave stream.

Header declaration:

int xine_stream_master_slave (xine_stream_t *master, xine_stream_t *slave, int affection)

returns 1 on success, 0 on failure.

xine_open :: Stream -> MRL -> IO Int

Open a stream.

Header declaration:

int xine_open (xine_stream_t *stream, const char *mrl)

Returns 1 if OK, 0 on error (use xine_get_error for details).

xine_play :: Stream -> Int -> Int -> IO Int

Play a stream from a given position.

Header declaration:

int xine_play (xine_stream_t *stream, int start_pos, int start_time)

Returns 1 if OK, 0 on error (use xine_get_error for details).

xine_dispose :: Stream -> IO ()

Stop playback, dispose all stream-related resources. The stream is no longer valid after this.

Header declaration:

void xine_dispose (xine_stream_t *stream)

xine_eject :: Stream -> IO Int

Ask current input plugin to eject media.

Header declaration:

int xine_eject (xine_stream_t *stream)

xine_trick_mode :: Stream -> TrickMode -> Int -> IO Int

Set xine to a trick mode for fast forward, backwards playback, low latency seeking.

Header declaration:

int xine_trick_mode (xine_stream_t *stream, int mode, int value)

Returns 1 if OK, 0 on error (use xine_get_error for details).

xine_stop :: Stream -> IO ()

Stop stream playback. The stream stays valid for new xine_open or xine_play.

Header declaration:

void xine_stop (xine_stream *stream)

xine_close :: Stream -> IO ()

Free all stream-related resources. The stream stays valid for new xine_open.

Header declaration:

void xine_close (xine_stream_t *stream)

xine_engine_set_param :: Engine -> EngineParam -> Int -> IO ()

Set engine parameter.

Header declaration:

void xine_engine_set_param (xine_t *self, int param, int value)

xine_engine_get_param :: Engine -> EngineParam -> IO Int

Get engine parameter.

Header declaration:

int xine_engine_get_param(xine_t *self, int param)

xine_set_param :: Enum a => Stream -> StreamParam -> a -> IO ()

Set stream parameter.

Header declaration:

void xine_set_param (xine_stream_t *stream, int param, int value)

xine_get_param :: Enum a => Stream -> StreamParam -> IO a

Get stream parameter.

Header declaration:

int xine_get_param (xine_stream_t *stream, int param)

Information retrieval

data EngineStatus

Engine status codes.

Constructors

Idle

Stopped

Playing

Quitting

Instances

Enum EngineStatus

Eq EngineStatus

Show EngineStatus

data XineError

xine error codes.

Constructors

NoError

NoInputPlugin

NoDemuxPlugin

MalformedMrl

InputFailed

Instances

Enum XineError

Eq XineError

Show XineError

xine_get_error :: Stream -> IO XineError

Return last error.

Header declaration:

int xine_get_error (xine_stream_t *stream)

xine_get_status :: Stream -> IO EngineStatus

Get current xine engine status.

int xine_get_status (xine_stream_t *stream)

xine_get_audio_lang :: Stream -> Int -> IO (Int, String)

Find the audio language of the given channel (use -1 for current channel).

Header declaration:

int xine_get_audio_lang (xine_stream_t *stream, int channel, char *lang)

lang must point to a buffer of at least XINE_LANG_MAX bytes.

Returns 1 on success, 0 on failure.

xine_get_spu_lang :: Stream -> Int -> IO (Int, String)

Find the spu language of the given channel (use -1 for current channel).

Header declaration:

int xine_get_spu_lang (xine_stream_t *stream, int channel, char *lang)

lang must point to a buffer of at least XINE_LANG_MAX bytes.

Returns 1 on success, 0 on failure.

xine_get_pos_length :: Stream -> IO (Int, Int, Int, Int)

Get position/length information.

Header declaration:

int xine_get_pos_length (xine_stream_t *stream, int *pos_stream, int *pos_time, int *length_time)

Returns 1 on success, 0 on failure.

data InfoType

The different kinds of stream information

Constructors

InfoBitrate

InfoSeekable

InfoVideoWidth

InfoVideoHeight

InfoVideoRatio

InfoVideoChannels

InfoVideoStreams

InfoVideoBitrate

InfoVideoFourCC

InfoVideoHandled

InfoFrameDuration

InfoAudioChannels

InfoAudioBits

InfoAudioSamplerate

InfoAudioBitrate

InfoAudioFourCC

InfoAudioHandled

InfoHasChapters

InfoHasVideo

InfoHasAudio

InfoIgnoreVideo

InfoIgnoreAudio

InfoIgnoreSpu

InfoVideoHasStill

InfoMaxAudioChannel

InfoMaxSpuChannel

InfoAudioMode

InfoSkippedFrames

InfoDiscardedFrames

InfoVideoAFD

InfoDvdTitleNumber

InfoDvdTitleCount

InfoDvdChapterNumber

InfoDvdChapterCount

InfoDvdAngleNumber

InfoDvdAngleCount

Instances

Enum InfoType

data MetaType

The different kinds of metadata

Constructors

MetaTitle

MetaComment

MetaArtist

MetaGenre

MetaAlbum

MetaYear

MetaVideoCodec

MetaAudioCodec

MetaSystemLayer

MetaInputPlugin

MetaDiscId

MetaTrackNumber

MetaComposer

MetaPublisher

MetaLicense

MetaArranger

MetaLyricist

MetaConductor

MetaPerformer

MetaEnsemble

MetaOpus

MetaPart

MetaPartNumber

MetaLocation

Instances

Enum MetaType

xine_get_stream_info :: Stream -> InfoType -> IO Int

Get information about the stream.

Header declaration:

int32_t xine_get_stream_info (xine_stream_t *stream, int info)

xine_get_meta_info :: Stream -> MetaType -> IO String

Get meta information about the stream.

Header declaration:

const char *xine_get_meta_info (xine_stream_t *stream, int info)