From 403f01979cef7e03b8322ddb870e3959c8de0f77 Mon Sep 17 00:00:00 2001 From: Guenter Bartsch Date: Wed, 4 Sep 2002 23:31:05 +0000 Subject: merging in the new_api branch ... unfortunately video_out / vo_scale is broken now ... matthias/miguel: please fix it :-) CVS patchset: 2606 CVS date: 2002/09/04 23:31:05 --- doc/Makefile.am | 17 +- doc/README.plugins | 192 ++++ doc/xine-lib-API.cfg | 28 - doc/xine-lib-API/.cvsignore | 2 - doc/xine-lib-API/Makefile.am | 13 - doc/xine-lib-API/html/.cvsignore | 2 - doc/xine-lib-API/html/Makefile.am | 53 - doc/xine-lib-API/html/annotated.html | 29 - doc/xine-lib-API/html/doxygen.css | 20 - doc/xine-lib-API/html/doxygen.gif | Bin 2378 -> 0 bytes doc/xine-lib-API/html/files.html | 19 - doc/xine-lib-API/html/functions.html | 41 - doc/xine-lib-API/html/globals.html | 148 --- doc/xine-lib-API/html/group__audio__cap.html | 372 ------- doc/xine-lib-API/html/group__audio__group.html | 22 - doc/xine-lib-API/html/group__audio__prop.html | 244 ----- doc/xine-lib-API/html/group__autoplay__group.html | 149 --- doc/xine-lib-API/html/group__browse__group.html | 285 ------ doc/xine-lib-API/html/group__build__info.html | 96 -- doc/xine-lib-API/html/group__config__group.html | 36 - doc/xine-lib-API/html/group__demux__strategy.html | 132 --- doc/xine-lib-API/html/group__event__group.html | 286 ------ .../html/group__loadplugins__group.html | 287 ------ doc/xine-lib-API/html/group__mrl__types.html | 483 --------- doc/xine-lib-API/html/group__status__group.html | 102 -- doc/xine-lib-API/html/group__ui__callbacks.html | 111 --- doc/xine-lib-API/html/group__version__group.html | 96 -- doc/xine-lib-API/html/group__video__cap.html | 146 --- doc/xine-lib-API/html/group__video__group.html | 37 - doc/xine-lib-API/html/group__video__prop.html | 264 ----- doc/xine-lib-API/html/group__video__ratio.html | 186 ---- doc/xine-lib-API/html/group__visual__types.html | 129 --- doc/xine-lib-API/html/group__xine__api.html | 358 ------- doc/xine-lib-API/html/group__xine__init.html | 251 ----- doc/xine-lib-API/html/group__xine__management.html | 1043 -------------------- doc/xine-lib-API/html/group__xine__version.html | 269 ----- doc/xine-lib-API/html/index.html | 19 - doc/xine-lib-API/html/modules.html | 54 - doc/xine-lib-API/html/structao__driver__t.html | 26 - doc/xine-lib-API/html/structao__functions__t.html | 26 - doc/xine-lib-API/html/structcfg__data__t.html | 26 - doc/xine-lib-API/html/structconfig__values__s.html | 219 ---- doc/xine-lib-API/html/structconfig__values__t.html | 33 - doc/xine-lib-API/html/structmrl__t.html | 165 ---- doc/xine-lib-API/html/structvo__driver__s.html | 308 ------ doc/xine-lib-API/html/structvo__driver__t.html | 33 - doc/xine-lib-API/html/structvo__frame__t.html | 28 - doc/xine-lib-API/html/structvo__overlay__t.html | 28 - doc/xine-lib-API/html/structxine__t.html | 28 - doc/xine-lib-API/html/xine_8h-source.html | 435 -------- doc/xine-lib-API/html/xine_8h.html | 391 -------- doc/xine-lib-API/html/xine_logo.png | Bin 41894 -> 0 bytes 52 files changed, 194 insertions(+), 7573 deletions(-) create mode 100644 doc/README.plugins delete mode 100644 doc/xine-lib-API.cfg delete mode 100644 doc/xine-lib-API/.cvsignore delete mode 100644 doc/xine-lib-API/Makefile.am delete mode 100644 doc/xine-lib-API/html/.cvsignore delete mode 100644 doc/xine-lib-API/html/Makefile.am delete mode 100644 doc/xine-lib-API/html/annotated.html delete mode 100644 doc/xine-lib-API/html/doxygen.css delete mode 100644 doc/xine-lib-API/html/doxygen.gif delete mode 100644 doc/xine-lib-API/html/files.html delete mode 100644 doc/xine-lib-API/html/functions.html delete mode 100644 doc/xine-lib-API/html/globals.html delete mode 100644 doc/xine-lib-API/html/group__audio__cap.html delete mode 100644 doc/xine-lib-API/html/group__audio__group.html delete mode 100644 doc/xine-lib-API/html/group__audio__prop.html delete mode 100644 doc/xine-lib-API/html/group__autoplay__group.html delete mode 100644 doc/xine-lib-API/html/group__browse__group.html delete mode 100644 doc/xine-lib-API/html/group__build__info.html delete mode 100644 doc/xine-lib-API/html/group__config__group.html delete mode 100644 doc/xine-lib-API/html/group__demux__strategy.html delete mode 100644 doc/xine-lib-API/html/group__event__group.html delete mode 100644 doc/xine-lib-API/html/group__loadplugins__group.html delete mode 100644 doc/xine-lib-API/html/group__mrl__types.html delete mode 100644 doc/xine-lib-API/html/group__status__group.html delete mode 100644 doc/xine-lib-API/html/group__ui__callbacks.html delete mode 100644 doc/xine-lib-API/html/group__version__group.html delete mode 100644 doc/xine-lib-API/html/group__video__cap.html delete mode 100644 doc/xine-lib-API/html/group__video__group.html delete mode 100644 doc/xine-lib-API/html/group__video__prop.html delete mode 100644 doc/xine-lib-API/html/group__video__ratio.html delete mode 100644 doc/xine-lib-API/html/group__visual__types.html delete mode 100644 doc/xine-lib-API/html/group__xine__api.html delete mode 100644 doc/xine-lib-API/html/group__xine__init.html delete mode 100644 doc/xine-lib-API/html/group__xine__management.html delete mode 100644 doc/xine-lib-API/html/group__xine__version.html delete mode 100644 doc/xine-lib-API/html/index.html delete mode 100644 doc/xine-lib-API/html/modules.html delete mode 100644 doc/xine-lib-API/html/structao__driver__t.html delete mode 100644 doc/xine-lib-API/html/structao__functions__t.html delete mode 100644 doc/xine-lib-API/html/structcfg__data__t.html delete mode 100644 doc/xine-lib-API/html/structconfig__values__s.html delete mode 100644 doc/xine-lib-API/html/structconfig__values__t.html delete mode 100644 doc/xine-lib-API/html/structmrl__t.html delete mode 100644 doc/xine-lib-API/html/structvo__driver__s.html delete mode 100644 doc/xine-lib-API/html/structvo__driver__t.html delete mode 100644 doc/xine-lib-API/html/structvo__frame__t.html delete mode 100644 doc/xine-lib-API/html/structvo__overlay__t.html delete mode 100644 doc/xine-lib-API/html/structxine__t.html delete mode 100644 doc/xine-lib-API/html/xine_8h-source.html delete mode 100644 doc/xine-lib-API/html/xine_8h.html delete mode 100644 doc/xine-lib-API/html/xine_logo.png (limited to 'doc') diff --git a/doc/Makefile.am b/doc/Makefile.am index 3a06d71c8..c4136e52f 100644 --- a/doc/Makefile.am +++ b/doc/Makefile.am @@ -1,24 +1,11 @@ -SUBDIRS = man xine-lib-API hackersguide +SUBDIRS = man hackersguide -EXTRA_DIST = $(docs_DOCS) README dataflow.dia xine-lib-API.cfg +EXTRA_DIST = $(docs_DOCS) README dataflow.dia docdir = $(prefix)/share/doc/xine docs_DOCS = -docs: - @if test x"$$DOXYGEN" != "xno"; then \ - echo -n " + Creating docs: "; \ - if test ! -d xine-lib-API/html; \ - then mkdir -p xine-lib-API/html; \ - fi; \ - cp ../misc/xine_logo.png ./xine-lib-API/html; \ - echo -e "\n\n\$$projectname\n\"xine\n\n\n" > ./xine-lib-API/xine_header.html; \ - $(DOXYGEN) xine-lib-API.cfg; \ - echo "done.";\ - fi - - install-data-local: @documentations='$(docs_DOCS)'; \ for doc in $$documentations; do \ diff --git a/doc/README.plugins b/doc/README.plugins new file mode 100644 index 000000000..72109e0fd --- /dev/null +++ b/doc/README.plugins @@ -0,0 +1,192 @@ +The (new) xine plugin system +============================ + +The plugin system enables some of xine's most valuable features: + +- drop-in extensiability + (we have always had this...) +- support parallel installation of multiple (incompatible) libxine versions +- support for multiple plugin directories + (/usr/lib/xine/plugins + $HOME/.xine/plugins + /usr/local/... + ...) +- support for recursive plugin directories + (plugins are found even in subdirectories of the plugin directories) +- version management + On start, xine finds all plugins in its plugin (sub)directories and + chooses an appropriate version (usually the newest) for each plugin +- simplification + plugins don't have to follow any special naming convention any more, + and any plugin may contain an arbitrary subset of input, demuxer, + decoder or output plugins. + +User view +--------- + + +Developer view - How it works +----------------------------- + +Essentally, plugins are just shared objects, ie dynamic libraries. In +contrast to normal dynamic libraries, they are stored outside of the +system's library PATHs and libxine does its own bookkeeping, which +enables most advanced features mentioned above. + +The plugin mechanism is mainly defined by 3 components, namely plugin +location (file system layout), plugin content (what's inside the .so?) +and the loading mechanism. Each of those has a dedicated section here: + +Plugin location and filesystem layout +------------------------------------- + +The primary goal for this new plugin mechanism was the need to support +simultaneous installation of several (most likely incompatible) +libxine versions without them overwriting each other's +plugins. Therefore, we have this simple layout: + +Plugins are installed below XINE_PLUGINDIR (/usr/local/lib/xine/plugins +by default). +Note that plugins are _never_ directly installed into XINE_PLUGINDIR. +Instead, a separate subdirectory is created for any "plugin +provider". A plugin provider is equivalent with the exact version of +one source package. Typical examples include "xine-lib-0.9.11" or +"xine-dvdnav-1.0". Every source package is free to install an +arbitrary number of plugins in its own, private directory. If a +package installs several plugins, they may optionally be organized +further into subdirectories. + +So you will finally end up with something like this: + +/usr/local/ lib/xine/plugins + xine-lib-0.9.11 + demux_mpeg_block.so + decode_mpeg.so + video_out_xv.so + ... + xine-dvdnav-0.9.11 + input_dvdnav.so + xine-lib-1.2 + input + file.so + stdin_fifo.so + vcd.so + demuxers + fli.so + avi.so + ... + decoders + ffmpeg.so + mpeg.so (may contain mpeg 1/2 audio and video decoders) + pcm.so + ... + output + video_xv.so + audio_oss.so + ... + xine-lib-3.0 + avi.so (avi demuxer) + mpeg.so (contains mpeg demuxers and audio/video decoders) + video_out_xv.so (Xv video out) + ... + +As you can see, every package is free to organize plugins at will +below its own plugin provider directory. + +Additionally, administrators may choose to put plugins directly into +XINE_PLUGINDIR, or in a "local" subdirectory. +Users may wish to put additional plugins in ~/.xine/plugins/. +Again, there may be subdirectories to help organize the plugins. + + +Plugin Content: What's inside the .so? +-------------------------------------- + +Each plugin library (.so file) contains an arbitrary number of (virtual) +plugins. Typically, it will contain exactly one plugin. However, it +may be useful to put a set of related plugins in one library, so they +can share common code. + +First of all, what is a virtual plugin? +A virtual plugin is essentially a structure that is defined by the +xine engine. This structure typically contains lots of function +pointers to the actual API functions. +For each plugin API, there are several API versions, and each API +version may specify a new, incompatible structure. Therefore, it is +essential that only those plugins are loaded that support current +libxine's API, so the .so file needs a "plugin directory" that +provides libxine with the version information, even before it tries to +load any of the plugins. + +This plugin directory is helt in an array named "xine_plugin_info", +which is defined like this: + +plugin.h: +--------- +#define PLUGIN_NONE 0 +#define PLUGIN_INPUT 1 +#define PLUGIN_DEMUX 2 +#define PLUGIN_AUDIO_CODEC 3 +... + +struct plugin_info_s { + uint8_t plugin_type; /* one of the PLUGIN_* constants above */ + uint8_t plugin_API; /* API version supported by this plugin */ + const char *plugin_id; /* a name that identifies this plugin */ + uint32_t plugin_version; /* version number, increased every release */ + plugin_t *(*init)(void); /* used to get/initialize an instance */ +}; +typedef struct plugin_info_s plugin_info_t; + +a fictitious file input plugin that supports input plugin API 12 and +13, found in xine-lib 2.13.7 would then define this plugin directory: + +input_file.c: +------------ +#include +... +plugin_t *(*init_api12)(void) { + input_plugin_t *this; + + this = malloc(sizeof(input_plugin_t)); + ... + return (plugin_t *) this; +} +/* same thing, with different initialization for API 13 */ + +const plugin_info_t xine_plugin_info[] = { + { PLUGIN_INPUT, 12, "file", 21307, init_api12 }, + { PLUGIN_INPUT, 13, "file", 21307, init_api13 }, + { PLUGIN_NONE, 0, "", 0, NULL } +} + +Notes: +----- +This input plugin supports two APIs, other plugins might provide a +mixture of demuxer and decoder plugins that belong together somehow +(ie. share common code). + +The init function itself doesn't have to check API versions any more. + +The xine_plugin_info list must be terminated by a dummy entry for a +"PLUGIN_NONE" plugin. + +The plugin version number is generated from xine-lib's version number +like this: MAJOR * 10000 + MINOR * 100 + SUBMINOR. (2.13.7 => 21307) +This is not required, but it's an easy way to ensure that the version +increases for every release. + +The structure of xine_plugin_info may _never_ be changed. If it ever +needs to be changed, it must be renamed to avoid erraneous loading of +incompatible plugin directories. + + +Plugin Loader Mechanism +----------------------- + +The plugin loader needs two passes over the plugins: + +1) all configured plugin directories are recursively scanned, + collecting all compatible versions of all the available plugins + +2) for each virtual plugin (identified by plugin_id), the newest + version found above is selected and loaded. + + diff --git a/doc/xine-lib-API.cfg b/doc/xine-lib-API.cfg deleted file mode 100644 index 3a6d93659..000000000 --- a/doc/xine-lib-API.cfg +++ /dev/null @@ -1,28 +0,0 @@ -PROJECT_NAME = "XINE, A Free Video Player Project - API reference" -HTML_OUTPUT = xine-lib-API/html -GENERATE_LATEX = NO -GENERATE_MAN = YES -MAN_OUTPUT = man/en -GENERATE_RTF = NO - -HTML_HEADER = xine-lib-API/xine_header.html - -WARNINGS = YES - -CASE_SENSE_NAMES = NO -RECURSIVE = YES -FILE_PATTERNS = *.c *.h -QUIET = YES - -INPUT = ../include/xine.h - -EXTRACT_ALL = NO -EXTRACT_STATIC = NO -SHOW_INCLUDE_FILES = NO -JAVADOC_AUTOBRIEF = NO -INHERIT_DOCS = YES -ENABLED_SECTIONS = "" -PREDEFINED = "DOC_HIDDEN" - -OPTIMIZE_OUTPUT_FOR_C = YES -DISABLE_INDEX = NO diff --git a/doc/xine-lib-API/.cvsignore b/doc/xine-lib-API/.cvsignore deleted file mode 100644 index 282522db0..000000000 --- a/doc/xine-lib-API/.cvsignore +++ /dev/null @@ -1,2 +0,0 @@ -Makefile -Makefile.in diff --git a/doc/xine-lib-API/Makefile.am b/doc/xine-lib-API/Makefile.am deleted file mode 100644 index d9c437c2d..000000000 --- a/doc/xine-lib-API/Makefile.am +++ /dev/null @@ -1,13 +0,0 @@ - -SUBDIRS = html - -debug: -install-debug: - -mostlyclean-generic: - -rm -f *~ \#* .*~ .\#* - -maintainer-clean-generic: - -@echo "This command is intended for maintainers to use;" - -@echo "it deletes files that may require special tools to rebuild." - -rm -f Makefile.in xine_header.html diff --git a/doc/xine-lib-API/html/.cvsignore b/doc/xine-lib-API/html/.cvsignore deleted file mode 100644 index 282522db0..000000000 --- a/doc/xine-lib-API/html/.cvsignore +++ /dev/null @@ -1,2 +0,0 @@ -Makefile -Makefile.in diff --git a/doc/xine-lib-API/html/Makefile.am b/doc/xine-lib-API/html/Makefile.am deleted file mode 100644 index 928d0859f..000000000 --- a/doc/xine-lib-API/html/Makefile.am +++ /dev/null @@ -1,53 +0,0 @@ -docs_DOCS = \ - group__demux__strategy.html modules.html group__event__group.html \ - structao__driver__t.html group__loadplugins__group.html structao__functions__t.html \ - group__mrl__types.html structcfg__data__t.html \ - annotated.html group__status__group.html structconfig__values__s.html \ - doxygen.css group__ui__callbacks.html structconfig__values__t.html \ - doxygen.gif group__version__group.html structmrl__t.html \ - files.html group__video__cap.html structvo__driver__s.html \ - functions.html group__video__group.html structvo__driver__t.html \ - globals.html group__video__prop.html structvo__frame__t.html \ - group__audio__cap.html group__video__ratio.html structvo__overlay__t.html \ - group__audio__group.html group__visual__types.html structxine__t.html \ - group__audio__prop.html group__xine__api.html xine_8h-source.html \ - group__autoplay__group.html group__xine__init.html xine_8h.html \ - group__browse__group.html group__xine__management.html xine_logo.png \ - group__build__info.html group__xine__version.html \ - group__config__group.html index.html - -EXTRA_DIST = $(docs_DOCS) - -docdir = $(prefix)/share/doc/xine/xine-lib-API/html - -install-data-local: - @documentations='$(docs_DOCS)'; \ - for doc in $$documentations; do \ - destdir=$(DESTDIR)$(docdir); \ - name=`echo $$doc` \ - dir=$$destdir; \ - $(mkinstalldirs) $$dir; \ - $(INSTALL_DATA) $$doc $$dir/$$name; \ - echo "installing $$doc as $$dir/$$name"; \ - done - -uninstall-local: - @documentations='$(docs_DOCS)'; \ - for doc in $$documentations; do \ - destdir=$(DESTDIR)$(docdir); \ - name=`echo $$doc` \ - dir=$$destdir; \ - rm -f $$dir/$$name; \ - echo "removing $$dir/$$name" ; \ - done - -debug: -install-debug: - -mostlyclean-generic: - -rm -f *~ \#* .*~ .\#* - -maintainer-clean-generic: - -@echo "This command is intended for maintainers to use;" - -@echo "it deletes files that may require special tools to rebuild." - -rm -f Makefile.in diff --git a/doc/xine-lib-API/html/annotated.html b/doc/xine-lib-API/html/annotated.html deleted file mode 100644 index f45765ef2..000000000 --- a/doc/xine-lib-API/html/annotated.html +++ /dev/null @@ -1,29 +0,0 @@ - - -XINE, A Free Video Player Project - API reference -xine logo - - - - -
-Main Page   Modules   Data Structures   File List   Data Fields   Globals  
-

XINE, A Free Video Player Project - API reference Data Structures

Here are the data structures with brief descriptions: -
Generated at Mon Oct 15 01:18:06 2001 for XINE, A Free Video Player Project - API reference by - -doxygen1.2.8 written by Dimitri van Heesch, - © 1997-2001
- - diff --git a/doc/xine-lib-API/html/doxygen.css b/doc/xine-lib-API/html/doxygen.css deleted file mode 100644 index 7f8e5b883..000000000 --- a/doc/xine-lib-API/html/doxygen.css +++ /dev/null @@ -1,20 +0,0 @@ -H1 { text-align: center; } -A.qindex {} -A.qindexRef {} -A.el { text-decoration: none; font-weight: bold } -A.elRef { font-weight: bold } -A.code { text-decoration: none; font-weight: normal; color: #4444ee } -A.codeRef { font-weight: normal; color: #4444ee } -DL.el { margin-left: -1cm } -DIV.fragment { width: 100%; border: none; background-color: #eeeeee } -DIV.ah { background-color: black; margin-bottom: 3; margin-top: 3 } -TD.md { background-color: #f2f2ff } -DIV.groupHeader { margin-left: 16; margin-top: 12; margin-bottom: 6; font-weight: bold } -DIV.groupText { margin-left: 16; font-style: italic; font-size: smaller } -FONT.keyword { color: #008000 } -FONT.keywordtype { color: #604020 } -FONT.keywordflow { color: #e08000 } -FONT.comment { color: #800000 } -FONT.preprocessor { color: #806020 } -FONT.stringliteral { color: #002080 } -FONT.charliteral { color: #008080 } diff --git a/doc/xine-lib-API/html/doxygen.gif b/doc/xine-lib-API/html/doxygen.gif deleted file mode 100644 index 192c83ce0..000000000 Binary files a/doc/xine-lib-API/html/doxygen.gif and /dev/null differ diff --git a/doc/xine-lib-API/html/files.html b/doc/xine-lib-API/html/files.html deleted file mode 100644 index df18e202a..000000000 --- a/doc/xine-lib-API/html/files.html +++ /dev/null @@ -1,19 +0,0 @@ - - -XINE, A Free Video Player Project - API reference -xine logo - - - - -
-Main Page   Modules   Data Structures   File List   Data Fields   Globals  
-

XINE, A Free Video Player Project - API reference File List

Here is a list of all documented files with brief descriptions: -
Generated at Mon Oct 15 01:18:06 2001 for XINE, A Free Video Player Project - API reference by - -doxygen1.2.8 written by Dimitri van Heesch, - © 1997-2001
- - diff --git a/doc/xine-lib-API/html/functions.html b/doc/xine-lib-API/html/functions.html deleted file mode 100644 index 6e7f72c99..000000000 --- a/doc/xine-lib-API/html/functions.html +++ /dev/null @@ -1,41 +0,0 @@ - - -XINE, A Free Video Player Project - API reference -xine logo - - - - -
-Main Page   Modules   Data Structures   File List   Data Fields   Globals  
-

XINE, A Free Video Player Project - API reference Data Fields

Here is a list of all documented struct and union fields with links to the structures/unions they belong to: -
Generated at Mon Oct 15 01:18:06 2001 for XINE, A Free Video Player Project - API reference by - -doxygen1.2.8 written by Dimitri van Heesch, - © 1997-2001
- - diff --git a/doc/xine-lib-API/html/globals.html b/doc/xine-lib-API/html/globals.html deleted file mode 100644 index 687455f0f..000000000 --- a/doc/xine-lib-API/html/globals.html +++ /dev/null @@ -1,148 +0,0 @@ - - -XINE, A Free Video Player Project - API reference -xine logo - - - - -
-Main Page   Modules   Data Structures   File List   Data Fields   Globals  
-

XINE, A Free Video Player Project - API reference Globals

Here is a list of all documented functions, variables, defines, enums, and typedefs with links to the documentation: -
Generated at Mon Oct 15 01:18:07 2001 for XINE, A Free Video Player Project - API reference by - -doxygen1.2.8 written by Dimitri van Heesch, - © 1997-2001
- - diff --git a/doc/xine-lib-API/html/group__audio__cap.html b/doc/xine-lib-API/html/group__audio__cap.html deleted file mode 100644 index 11eb86726..000000000 --- a/doc/xine-lib-API/html/group__audio__cap.html +++ /dev/null @@ -1,372 +0,0 @@ - - -XINE, A Free Video Player Project - API reference -xine logo - - - - -
-Main Page   Modules   Data Structures   File List   Data Fields   Globals  
-

audio driver capabilities

- - - - - - - - - - - - - - - -

Defines

-#define AO_CAP_NOCAP   0x00000000
-#define AO_CAP_MODE_A52   0x00000001
-#define AO_CAP_MODE_AC5   0x00000002
-#define AO_CAP_MODE_MONO   0x00000004
-#define AO_CAP_MODE_STEREO   0x00000008
-#define AO_CAP_MODE_4CHANNEL   0x00000010
-#define AO_CAP_MODE_5CHANNEL   0x00000020
-#define AO_CAP_MODE_5_1CHANNEL   0x00000040
-#define AO_CAP_MIXER_VOL   0x00000080
-#define AO_CAP_PCM_VOL   0x00000100
-#define AO_CAP_MUTE_VOL   0x00000200

Functions

-int xine_get_audio_capabilities (xine_t *self)
 Get audio driver capabilities.

-

Define Documentation

-

- - - - -
- - -
-#define AO_CAP_MIXER_VOL   0x00000080 -
-
- - - - - -
-   - - -

-Driver supports mixer control.

-See also:
-xine_get_audio_capabilities()
-

- - - - -
- - -
-#define AO_CAP_MODE_4CHANNEL   0x00000010 -
-
- - - - - -
-   - - -

-Driver supports 4 channels. 1 sample == 8 bytes (L,R,LR,RR)

-See also:
-xine_get_audio_capabilities()
-

- - - - -
- - -
-#define AO_CAP_MODE_5CHANNEL   0x00000020 -
-
- - - - - -
-   - - -

-Driver supports 5 channels. 1 sample == 10 bytes (L,R,LR,RR,C)

-See also:
-xine_get_audio_capabilities()
-

- - - - -
- - -
-#define AO_CAP_MODE_5_1CHANNEL   0x00000040 -
-
- - - - - -
-   - - -

-Driver supports 5.1 channels. 1 sample == 12 bytes (L,R,LR,RR,C,LFE)

-See also:
-xine_get_audio_capabilities()
-

- - - - -
- - -
-#define AO_CAP_MODE_A52   0x00000001 -
-
- - - - - -
-   - - -

-Driver supports A/52 output.

-See also:
-xine_get_audio_capabilities()
-

- - - - -
- - -
-#define AO_CAP_MODE_AC5   0x00000002 -
-
- - - - - -
-   - - -

-Driver supports AC5 output.

-See also:
-xine_get_audio_capabilities()
-

- - - - -
- - -
-#define AO_CAP_MODE_MONO   0x00000004 -
-
- - - - - -
-   - - -

-Driver supports mono output. 1 sample == 2 bytes (C)

-See also:
-xine_get_audio_capabilities()
-

- - - - -
- - -
-#define AO_CAP_MODE_STEREO   0x00000008 -
-
- - - - - -
-   - - -

-Driver supports stereo output. 1 sample == 4 bytes (L,R)

-See also:
-xine_get_audio_capabilities()
-

- - - - -
- - -
-#define AO_CAP_MUTE_VOL   0x00000200 -
-
- - - - - -
-   - - -

-Driver can mute volume.

-See also:
-xine_get_audio_capabilities()
-

- - - - -
- - -
-#define AO_CAP_NOCAP   0x00000000 -
-
- - - - - -
-   - - -

-Driver has no capabilities.

-See also:
-xine_get_audio_capabilities()
-

- - - - -
- - -
-#define AO_CAP_PCM_VOL   0x00000100 -
-
- - - - - -
-   - - -

-Driver supports pcm control.

-See also:
-xine_get_audio_capabilities()
-

Function Documentation

-

- - - - -
- - - - - - -
-int xine_get_audio_capabilities ( - -xine_t * self ) -
-
- - - - - -
-   - - -

-Get audio driver capabilities. -

-

-Parameters:
- - -
self -  -Current xine engine configuration ( see xine_init() )
-
-Returns:
-Audio capabilities. -

-

Get audio driver capabilities, returned value can be AND/ORed with AO_CAP_* constant to get relevant informations.
-Parameters:
- - -
self -  -
-
-

Generated at Mon Oct 15 01:18:07 2001 for XINE, A Free Video Player Project - API reference by - -doxygen1.2.8 written by Dimitri van Heesch, - © 1997-2001
- - diff --git a/doc/xine-lib-API/html/group__audio__group.html b/doc/xine-lib-API/html/group__audio__group.html deleted file mode 100644 index 7b152a642..000000000 --- a/doc/xine-lib-API/html/group__audio__group.html +++ /dev/null @@ -1,22 +0,0 @@ - - -XINE, A Free Video Player Project - API reference -xine logo - - - - -
-Main Page   Modules   Data Structures   File List   Data Fields   Globals  
-

Audio.

- - - -

Modules

Constants for the get/set properties functions.
audio driver capabilities
-
Generated at Mon Oct 15 01:18:07 2001 for XINE, A Free Video Player Project - API reference by - -doxygen1.2.8 written by Dimitri van Heesch, - © 1997-2001
- - diff --git a/doc/xine-lib-API/html/group__audio__prop.html b/doc/xine-lib-API/html/group__audio__prop.html deleted file mode 100644 index 779e0f501..000000000 --- a/doc/xine-lib-API/html/group__audio__prop.html +++ /dev/null @@ -1,244 +0,0 @@ - - -XINE, A Free Video Player Project - API reference -xine logo - - - - -
-Main Page   Modules   Data Structures   File List   Data Fields   Globals  
-

Constants for the get/set properties functions.

- - - - - - - - - -

Defines

-#define AO_PROP_MIXER_VOL   0
-#define AO_PROP_PCM_VOL   1
-#define AO_PROP_MUTE_VOL   2

Functions

-int xine_get_audio_property (xine_t *self, int property)
 Get audio driver property.

-int xine_set_audio_property (xine_t *self, int property, int value)
 Set audio driver property value.

-

Define Documentation

-

- - - - -
- - -
-#define AO_PROP_MIXER_VOL   0 -
-
- - - - - -
-   - - -

-Mixer volume property.

-See also:
-xine_get_audio_property(), xine_set_audio_property()
-

- - - - -
- - -
-#define AO_PROP_MUTE_VOL   2 -
-
- - - - - -
-   - - -

-Pcm volume property.

-See also:
-xine_get_audio_property(), xine_set_audio_property()
-

- - - - -
- - -
-#define AO_PROP_PCM_VOL   1 -
-
- - - - - -
-   - - -

-Pcm volume property.

-See also:
-xine_get_audio_property(), xine_set_audio_property()
-

Function Documentation

-

- - - - -
- - - - - - - - - - -
-int xine_get_audio_property ( - -xine_t * self, -
-int property ) -
-
- - - - - -
-   - - -

-Get audio driver property. -

-

-Parameters:
- - - -
self -  -Current xine engine configuration ( see xine_init() )
property -  -( see AO_PROP_* )
-
-Returns:
-value of property. -

-

Get audio property ( AO_PROP_* ) value .
-Parameters:
- - - -
self -  -
property -  -
-
-

- - - - -
- - - - - - - - - - - - - - -
-int xine_set_audio_property ( - -xine_t * self, -
-int property, -
-int value ) -
-
- - - - - -
-   - - -

-Set audio driver property value. -

-

-Parameters:
- - - - -
self -  -Current xine engine configuration ( see xine_init() )
property -  -( see AO_PROP_* )
value -  -of property
-
-Returns:
-value on success, otherwise ~value. -

-

Set audio property value ( AO_PROP_* ). It will return value if operation is successfuly completed, and ~value on failure.
-Parameters:
- - - - -
self -  -
property -  -
value -  -
-
-

Generated at Mon Oct 15 01:18:07 2001 for XINE, A Free Video Player Project - API reference by - -doxygen1.2.8 written by Dimitri van Heesch, - © 1997-2001
- - diff --git a/doc/xine-lib-API/html/group__autoplay__group.html b/doc/xine-lib-API/html/group__autoplay__group.html deleted file mode 100644 index 413c60e5e..000000000 --- a/doc/xine-lib-API/html/group__autoplay__group.html +++ /dev/null @@ -1,149 +0,0 @@ - - -XINE, A Free Video Player Project - API reference -xine logo - - - - -
-Main Page   Modules   Data Structures   File List   Data Fields   Globals  
-

Autoplay support

- - - - - -

Functions

-char** xine_get_autoplay_input_plugin_ids (xine_t *self)
 Request playlist from plugin.

-char** xine_get_autoplay_mrls (xine_t *self, char *plugin_id, int *num_mrls)
 Request MRL list from plugin.

-

Function Documentation

-

- - - - -
- - - - - - -
-char ** xine_get_autoplay_input_plugin_ids ( - -xine_t * self ) -
-
- - - - - -
-   - - -

-Request playlist from plugin. -

-

-Parameters:
- - -
self -  -Current xine engine configuration ( see xine_init() )
-
-Returns:
-Playlist. -

-

Some input plugins can generate autoplay lists returns a list of ids of these plugins.
-Parameters:
- - -
self -  -
-
-

- - - - -
- - - - - - - - - - - - - - -
-char ** xine_get_autoplay_mrls ( - -xine_t * self, -
-char * plugin_id, -
-int * num_mrls ) -
-
- - - - - -
-   - - -

-Request MRL list from plugin. -

-

-Parameters:
- - - - -
self -  -Current xine engine configuration ( see xine_init() )
plugin_id -  -Plugin name ( see xine_get_autoplay_input_plugin_ids() )
num_mrls -  -Entries in return array.
-
-Returns:
-MRL list. -

-

Get autoplay MRL list for input plugin named <plugin_id>.
-Parameters:
- - - - -
self -  -
plugin_id -  -
num_mrls -  -
-
-

Generated at Mon Oct 15 01:18:07 2001 for XINE, A Free Video Player Project - API reference by - -doxygen1.2.8 written by Dimitri van Heesch, - © 1997-2001
- - diff --git a/doc/xine-lib-API/html/group__browse__group.html b/doc/xine-lib-API/html/group__browse__group.html deleted file mode 100644 index 79c00257c..000000000 --- a/doc/xine-lib-API/html/group__browse__group.html +++ /dev/null @@ -1,285 +0,0 @@ - - -XINE, A Free Video Player Project - API reference -xine logo - - - - -
-Main Page   Modules   Data Structures   File List   Data Fields   Globals  
-

Browsing support

- - - - - - - - - - - - - - -

Modules

Types of available mrls

Data Structures

struct  mrl_t
struct  mrl_t

Defines

-#define MRL_ZERO(m)
-#define MRL_DUPLICATE(s, d)
-#define MRLS_DUPLICATE(s, d)

Functions

-char** xine_get_browsable_input_plugin_ids (xine_t *self)
 Request list of browsable featured plugins.

-mrl_t** xine_get_browse_mrls (xine_t *self, char *plugin_id, char *start_mrl, int *num_mrls)
 Request available MRLs from plugins.

-

Define Documentation

-

- - - - -
- - - -
-#define MRLS_DUPLICATE( - -s, d ) -
-
- - - - - -
-   - - -

-Value:

  {                                                \
-  int i = 0;                                                                  \
-                                                                              \
-  assert((s) != NULL);                                                        \
-  assert((d) != NULL);                                                        \
-                                                                              \
-  while((s) != NULL) {                                                        \
-    d[i] = (mrl_t *) malloc(sizeof(mrl_t));                                   \
-    MRL_DUPLICATE(s[i], d[i]);                                                \
-    i++;                                                                      \
-  }                                                                           \
-}
Duplicate two arrays of mrls (s = source, d = destination).
-See also:
-mrl_t, xine_get_browse_mrls()
-

- - - - -
- - - -
-#define MRL_DUPLICATE( - -s, d ) -
-
- - - - - -
-   - - -

-Duplicate two mrls entries (s = source, d = destination).

-See also:
-mrl_t, xine_get_browse_mrls()
-

- - - - -
- - - -
-#define MRL_ZERO( - -m ) -
-
- - - - - -
-   - - -

-Value:

  {                                                         \
-  if((m)) {                                                                   \
-    if((m)->origin)                                                           \
-      free((m)->origin);                                                      \
-    if((m)->mrl)                                                              \
-      free((m)->mrl);                                                         \
-    if((m)->link)                                                             \
-      free((m)->link);                                                        \
-    (m)->origin = NULL;                                                       \
-    (m)->mrl    = NULL;                                                       \
-    (m)->link   = NULL;                                                       \
-    (m)->type   = 0;                                                          \
-    (m)->size   = (off_t) 0;                                                  \
-  }                                                                           \
-}
Freeing/zeroing all of entries of given mrl.
-See also:
-mrl_t, xine_get_browse_mrls()
-

Function Documentation

-

- - - - -
- - - - - - -
-char ** xine_get_browsable_input_plugin_ids ( - -xine_t * self ) -
-
- - - - - -
-   - - -

-Request list of browsable featured plugins. -

-

-Parameters:
- - -
self -  -Current xine engine configuration ( see xine_init() )
-
-Returns:
-List of plugins -

-

Some input plugins are browseable, get the list of ids of these plugins.
-Parameters:
- - -
self -  -
-
-

- - - - -
- - - - - - - - - - - - - - - - - - -
-mrl_t ** xine_get_browse_mrls ( - -xine_t * self, -
-char * plugin_id, -
-char * start_mrl, -
-int * num_mrls ) -
-
- - - - - -
-   - - -

-Request available MRLs from plugins. -

-

-Parameters:
- - - - - -
self -  -Current xine engine configuration ( see xine_init() )
plugin_id -  -Plugin name ( see xine_get_browsable_input_plugin_ids() )
start_mrl -  -MRL
num_mrl -  -how many mrls was found
-
-Returns:
-start_mrl on success, NULL on failure. -

-

Asks input plugin named <plugin_id> to return a list of available MRLs in domain/directory <start_mrl>. -

-<start_mrl> may be NULL indicating the toplevel domain/dir returns <start_mrl> if <start_mrl> is a valid MRL, not a directory returns NULL if <start_mrl> is an invalid MRL, not even a directory.

-Parameters:
- - - - - -
self -  -
plugin_id -  -
start_mrl -  -
num_mrls -  -
-
-

Generated at Mon Oct 15 01:18:07 2001 for XINE, A Free Video Player Project - API reference by - -doxygen1.2.8 written by Dimitri van Heesch, - © 1997-2001
- - diff --git a/doc/xine-lib-API/html/group__build__info.html b/doc/xine-lib-API/html/group__build__info.html deleted file mode 100644 index dd4afd4b7..000000000 --- a/doc/xine-lib-API/html/group__build__info.html +++ /dev/null @@ -1,96 +0,0 @@ - - -XINE, A Free Video Player Project - API reference -xine logo - - - - -
-Main Page   Modules   Data Structures   File List   Data Fields   Globals  
-

Build informations

- - - - -

Defines

-#define XINE_BUILD_CC   "gcc version 2.95.3 20010315 (release)"
-#define XINE_BUILD_OS   "Linux 2.4.9 i686"
-#define XINE_BUILD_DATE   "Mon 15 Oct 2001 00:22:19"
-

Define Documentation

-

- - - - -
- - -
-#define XINE_BUILD_CC   "gcc version 2.95.3 20010315 (release)" -
-
- - - - - -
-   - - -

-Compiler used to build xine-lib

-

- - - - -
- - -
-#define XINE_BUILD_DATE   "Mon 15 Oct 2001 00:22:19" -
-
- - - - - -
-   - - -

-Build time

-

- - - - -
- - -
-#define XINE_BUILD_OS   "Linux 2.4.9 i686" -
-
- - - - - -
-   - - -

-OS used to build xine-lib

-

Generated at Mon Oct 15 01:18:07 2001 for XINE, A Free Video Player Project - API reference by - -doxygen1.2.8 written by Dimitri van Heesch, - © 1997-2001
- - diff --git a/doc/xine-lib-API/html/group__config__group.html b/doc/xine-lib-API/html/group__config__group.html deleted file mode 100644 index 31387a6a2..000000000 --- a/doc/xine-lib-API/html/group__config__group.html +++ /dev/null @@ -1,36 +0,0 @@ - - -XINE, A Free Video Player Project - API reference -xine logo - - - - -
-Main Page   Modules   Data Structures   File List   Data Fields   Globals  
-

Configuration structure type.

- - - - - - - - - - - - - -

Data Structures

struct  ao_driver_t
struct  cfg_data_t
struct  config_values_s
struct  config_values_s
struct  config_values_t
 Data type of structure config_values_s. More...

struct  xine_t

Typedefs

-typedef void xine_t
-typedef void ao_driver_t
-typedef void cfg_data_t
-typedef struct config_values_s config_values_t
-
Generated at Mon Oct 15 01:18:07 2001 for XINE, A Free Video Player Project - API reference by - -doxygen1.2.8 written by Dimitri van Heesch, - © 1997-2001
- - diff --git a/doc/xine-lib-API/html/group__demux__strategy.html b/doc/xine-lib-API/html/group__demux__strategy.html deleted file mode 100644 index cf8eef242..000000000 --- a/doc/xine-lib-API/html/group__demux__strategy.html +++ /dev/null @@ -1,132 +0,0 @@ - - -XINE, A Free Video Player Project - API reference -xine logo - - - - -
-Main Page   Modules   Data Structures   File List   Data Fields   Globals  
-

Possible demuxer guessing strategy.

- - - - - -

Defines

-#define DEMUX_DEFAULT_STRATEGY   0
-#define DEMUX_REVERT_STRATEGY   1
-#define DEMUX_CONTENT_STRATEGY   2
-#define DEMUX_EXTENSION_STRATEGY   3
-

Detailed Description

-"demux_strategy" should be set to one of these value in configuration file ( see Configuration structure type.) before xine_init() call.
-See also:
-config_values_t

Define Documentation

-

- - - - -
- - -
-#define DEMUX_CONTENT_STRATEGY   2 -
-
- - - - - -
-   - - -

-Recognize by content only.

-See also:
-config_values_t
-

- - - - -
- - -
-#define DEMUX_DEFAULT_STRATEGY   0 -
-
- - - - - -
-   - - -

-Recognize by content then by extension.

-See also:
-config_values_t
-

- - - - -
- - -
-#define DEMUX_EXTENSION_STRATEGY   3 -
-
- - - - - -
-   - - -

-Recognize by extension only.

-See also:
-config_values_t
-

- - - - -
- - -
-#define DEMUX_REVERT_STRATEGY   1 -
-
- - - - - -
-   - - -

-Recognize by extension then by content.

-See also:
-config_values_t
-

Generated at Mon Oct 15 01:18:07 2001 for XINE, A Free Video Player Project - API reference by - -doxygen1.2.8 written by Dimitri van Heesch, - © 1997-2001
- - diff --git a/doc/xine-lib-API/html/group__event__group.html b/doc/xine-lib-API/html/group__event__group.html deleted file mode 100644 index 8dbed980d..000000000 --- a/doc/xine-lib-API/html/group__event__group.html +++ /dev/null @@ -1,286 +0,0 @@ - - -XINE, A Free Video Player Project - API reference -xine logo - - - - -
-Main Page   Modules   Data Structures   File List   Data Fields   Globals  
-

Sending events

- - - - - - - - - - -

Typedefs

-typedef void event_t
-typedef void (* event_listener_t )(xine_t *xine, event_t *event, void *data)

Functions

-int xine_register_event_listener (xine_t *self, event_listener_t listener)
 registers an event listener callback.

-int xine_remove_event_listener (xine_t *self, event_listener_t listener)
 Attempts to remove a registered event listener.

-void xine_send_event (xine_t *self, event_t *event, void *data)
 sends an event to all listeners.

-

Detailed Description

-Event dispatcher mechanism

Typedef Documentation

-

- - - - -
- - - - - -
-typedef void(* event_listener_t)(xine_t *xine, event_t *event, void *data) -
-
- - - - - -
-   - - -

-Event listener callback.

-See also:
-xine_register_event_listener, xine_remove_event_listener
-

- - - - -
- - - - - -
-typedef void event_t -
-
- - - - - -
-   - - -

-Opaque data type.

-See also:
-event_listener_t, xine_send_event
-

Function Documentation

-

- - - - -
- - - - - - - - - - -
-int xine_register_event_listener ( - -xine_t * self, -
-event_listener_t listener ) -
-
- - - - - -
-   - - -

-registers an event listener callback. -

-

-Parameters:
- - - -
self -  -Current xine engine configuration ( see xine_init() )
listener -  -callback function.
-
-Returns:
-0 if the listener was registerd, non-zero if it could not.
-See also:
-event_listener_t
-Parameters:
- - - -
self -  -
listener -  -
-
-

- - - - -
- - - - - - - - - - -
-int xine_remove_event_listener ( - -xine_t * self, -
-event_listener_t listener ) -
-
- - - - - -
-   - - -

-Attempts to remove a registered event listener. -

-

-Parameters:
- - - -
self -  -Current xine engine configuration ( see xine_init() )
listener -  -callback function.
-
-Returns:
-0 if the listener was removes, non-zero if it wasn't (e.g. not found).
-See also:
-event_listener_t
-Parameters:
- - - -
self -  -
listener -  -
-
-

- - - - -
- - - - - - - - - - - - - - -
-void xine_send_event ( - -xine_t * self, -
-event_t * event, -
-void * data ) -
-
- - - - - -
-   - - -

-sends an event to all listeners. -

-

-Parameters:
- - - - -
self -  -Current xine engine configuration ( see xine_init() )
event -  -FILLME
data -  -FILLME.
-
-See also:
-event_t
-Parameters:
- - - - -
self -  -
event -  -
data -  -
-
-

Generated at Mon Oct 15 01:18:07 2001 for XINE, A Free Video Player Project - API reference by - -doxygen1.2.8 written by Dimitri van Heesch, - © 1997-2001
- - diff --git a/doc/xine-lib-API/html/group__loadplugins__group.html b/doc/xine-lib-API/html/group__loadplugins__group.html deleted file mode 100644 index 361195cf6..000000000 --- a/doc/xine-lib-API/html/group__loadplugins__group.html +++ /dev/null @@ -1,287 +0,0 @@ - - -XINE, A Free Video Player Project - API reference -xine logo - - - - -
-Main Page   Modules   Data Structures   File List   Data Fields   Globals  
-

Loading plugins

- - - - - - - - - - - - - -

Modules

Valid visual types

Defines

-#define XINE_PLUGINDIR   "/usr/local/lib/xine/plugins"

Functions

-char** xine_list_video_output_plugins (int visual_type)
 list available video output plugins.

-vo_driver_t* xine_load_video_output_plugin (config_values_t *config, char *id, int visual_type, void *visual)
 load a specific video output plugin.

-char** xine_list_audio_output_plugins (void)
 generate a list of all available audio output plugins.

-ao_driver_t* xine_load_audio_output_plugin (config_values_t *config, char *id)
 load a specific audio output plugin.

-

Detailed Description

-output plugin load support functions

Define Documentation

-

- - - - -
- - -
-#define XINE_PLUGINDIR   "/usr/local/lib/xine/plugins" -
-
- - - - - -
-   - - -

-Plugin files location.

-

Function Documentation

-

- - - - -
- - - - - - -
-char ** xine_list_audio_output_plugins ( - -void ) -
-
- - - - - -
-   - - -

-generate a list of all available audio output plugins. -

-

-Returns:
-a list of available audio output plugins the list returned is sorted by plugin priority
-

- - - - -
- - - - - - -
-char ** xine_list_video_output_plugins ( - -int visual_type ) -
-
- - - - - -
-   - - -

-list available video output plugins. -

-

-Parameters:
- - -
visual_type -  -see Valid visual types
-
-Returns:
-a list of available video output plugins for the specified visual type - the list is sorted by plugin priority
-See also:
-Valid visual types
-Parameters:
- - -
visual_type -  -
-
-

- - - - -
- - - - - - - - - - -
-ao_driver_t * xine_load_audio_output_plugin ( - -config_values_t * config, -
-char * id ) -
-
- - - - - -
-   - - -

-load a specific audio output plugin. -

-

-Parameters:
- - - -
config -  -current configuration ( see config_file_init() )
id -  -driver name.
-
-See also:
-ao_driver_t
-Parameters:
- - - -
config -  -
id -  -
-
-

- - - - -
- - - - - - - - - - - - - - - - - - -
-vo_driver_t * xine_load_video_output_plugin ( - -config_values_t * config, -
-char * id, -
-int visual_type, -
-void * visual ) -
-
- - - - - -
-   - - -

-load a specific video output plugin. -

-

-Parameters:
- - - - - -
config -  -current configuration ( see config_file_init() )
id -  -driver name.
visual_type -  -see Valid visual types
visual -  -visual type dependant data pointer.
-
-See also:
-vo_driver_t, Valid visual types
-Parameters:
- - - - - -
config -  -
id -  -
visual_type -  -
visual -  -
-
-

Generated at Mon Oct 15 01:18:07 2001 for XINE, A Free Video Player Project - API reference by - -doxygen1.2.8 written by Dimitri van Heesch, - © 1997-2001
- - diff --git a/doc/xine-lib-API/html/group__mrl__types.html b/doc/xine-lib-API/html/group__mrl__types.html deleted file mode 100644 index 1abe9e5af..000000000 --- a/doc/xine-lib-API/html/group__mrl__types.html +++ /dev/null @@ -1,483 +0,0 @@ - - -XINE, A Free Video Player Project - API reference -xine logo - - - - -
-Main Page   Modules   Data Structures   File List   Data Fields   Globals  
-

Types of available mrls

- - - - - - - - - - - - - - - - - - -

Defines

-#define mrl_unknown   (0 << 0)
-#define mrl_dvd   (1 << 0)
-#define mrl_vcd   (1 << 1)
-#define mrl_net   (1 << 2)
-#define mrl_rtp   (1 << 3)
-#define mrl_stdin   (1 << 4)
-#define mrl_file   (1 << 5)
-#define mrl_file_fifo   (1 << 6)
-#define mrl_file_chardev   (1 << 7)
-#define mrl_file_directory   (1 << 8)
-#define mrl_file_blockdev   (1 << 9)
-#define mrl_file_normal   (1 << 10)
-#define mrl_file_symlink   (1 << 11)
-#define mrl_file_sock   (1 << 12)
-#define mrl_file_exec   (1 << 13)
-#define mrl_file_backup   (1 << 14)
-#define mrl_file_hidden   (1 << 15)
-

Detailed Description

-These types are bit field, can be used ORed/ANDed.
-See also:
-mrl_t

Define Documentation

-

- - - - -
- - -
-#define mrl_dvd   (1 << 0) -
-
- - - - - -
-   - - -

-DVD mrl type.

-See also:
-mrl_t
-

- - - - -
- - -
-#define mrl_file   (1 << 5) -
-
- - - - - -
-   - - -

-File mrl type.

-See also:
-mrl_t
-

- - - - -
- - -
-#define mrl_file_backup   (1 << 14) -
-
- - - - - -
-   - - -

-Backup file mrl type.

-See also:
-mrl_t
-

- - - - -
- - -
-#define mrl_file_blockdev   (1 << 9) -
-
- - - - - -
-   - - -

-Block device file mrl type.

-See also:
-mrl_t
-

- - - - -
- - -
-#define mrl_file_chardev   (1 << 7) -
-
- - - - - -
-   - - -

-Char device file mrl type.

-See also:
-mrl_t
-

- - - - -
- - -
-#define mrl_file_directory   (1 << 8) -
-
- - - - - -
-   - - -

-Directory file mrl type.

-See also:
-mrl_t
-

- - - - -
- - -
-#define mrl_file_exec   (1 << 13) -
-
- - - - - -
-   - - -

-Executable file mrl type.

-See also:
-mrl_t
-

- - - - -
- - -
-#define mrl_file_fifo   (1 << 6) -
-
- - - - - -
-   - - -

-Fifo file mrl type.

-See also:
-mrl_t
-

- - - - -
- - -
-#define mrl_file_hidden   (1 << 15) -
-
- - - - - -
-   - - -

-Hidden file mrl type.

-See also:
-mrl_t
-

- - - - -
- - -
-#define mrl_file_normal   (1 << 10) -
-
- - - - - -
-   - - -

-Normal file mrl type.

-See also:
-mrl_t
-

- - - - -
- - -
-#define mrl_file_sock   (1 << 12) -
-
- - - - - -
-   - - -

-Socket file mrl type.

-See also:
-mrl_t
-

- - - - -
- - -
-#define mrl_file_symlink   (1 << 11) -
-
- - - - - -
-   - - -

-Soft link file mrl type.

-See also:
-mrl_t
-

- - - - -
- - -
-#define mrl_net   (1 << 2) -
-
- - - - - -
-   - - -

-Network mrl type.

-See also:
-mrl_t
-

- - - - -
- - -
-#define mrl_rtp   (1 << 3) -
-
- - - - - -
-   - - -

-Multicast mrl type.

-See also:
-mrl_t
-

- - - - -
- - -
-#define mrl_stdin   (1 << 4) -
-
- - - - - -
-   - - -

-Standart input mrl type.

-See also:
-mrl_t
-

- - - - -
- - -
-#define mrl_unknown   (0 << 0) -
-
- - - - - -
-   - - -

-Unknow mrl type.

-See also:
-mrl_t
-

- - - - -
- - -
-#define mrl_vcd   (1 << 1) -
-
- - - - - -
-   - - -

-VCD mrl type.

-See also:
-mrl_t
-

Generated at Mon Oct 15 01:18:07 2001 for XINE, A Free Video Player Project - API reference by - -doxygen1.2.8 written by Dimitri van Heesch, - © 1997-2001
- - diff --git a/doc/xine-lib-API/html/group__status__group.html b/doc/xine-lib-API/html/group__status__group.html deleted file mode 100644 index 90cd1ac46..000000000 --- a/doc/xine-lib-API/html/group__status__group.html +++ /dev/null @@ -1,102 +0,0 @@ - - -XINE, A Free Video Player Project - API reference -xine logo - - - - -
-Main Page   Modules   Data Structures   File List   Data Fields   Globals  
-

Player status constants

- - - - -

Defines

-#define XINE_STOP   0
-#define XINE_PLAY   1
-#define XINE_QUIT   2
-

Define Documentation

-

- - - - -
- - -
-#define XINE_PLAY   1 -
-
- - - - - -
-   - - -

-Play status.

-See also:
-xine_get_status()
-

- - - - -
- - -
-#define XINE_QUIT   2 -
-
- - - - - -
-   - - -

-Quit status.

-See also:
-xine_get_status()
-

- - - - -
- - -
-#define XINE_STOP   0 -
-
- - - - - -
-   - - -

-Stop status.

-See also:
-xine_get_status()
-

Generated at Mon Oct 15 01:18:07 2001 for XINE, A Free Video Player Project - API reference by - -doxygen1.2.8 written by Dimitri van Heesch, - © 1997-2001
- - diff --git a/doc/xine-lib-API/html/group__ui__callbacks.html b/doc/xine-lib-API/html/group__ui__callbacks.html deleted file mode 100644 index 31d23bafe..000000000 --- a/doc/xine-lib-API/html/group__ui__callbacks.html +++ /dev/null @@ -1,111 +0,0 @@ - - -XINE, A Free Video Player Project - API reference -xine logo - - - - -
-Main Page   Modules   Data Structures   File List   Data Fields   Globals  
-

UI communication callbacks.

- - - - -

Typedefs

-typedef void (* gui_stream_end_cb_t )(int nStatus)
-typedef char* (* gui_get_next_mrl_cb_t )(void)
-typedef void (* gui_branched_cb_t )(void)
-

Typedef Documentation

-

- - - - -
- - - - - -
-typedef void(* gui_branched_cb_t)(void) -
-
- - - - - -
-   - - -

-Called when xine branched successfully to the next mrl.

-See also:
-xine_init()
-

- - - - -
- - - - - -
-typedef char *(* gui_get_next_mrl_cb_t)(void) -
-
- - - - - -
-   - - -

-Called when xine tries to branch seamlessly to the next mrl.

-See also:
-xine_init()
-

- - - - -
- - - - - -
-typedef void(* gui_stream_end_cb_t)(int nStatus) -
-
- - - - - -
-   - - -

-Notify UI when the stream is finished.

-See also:
-xine_init()
-

Generated at Mon Oct 15 01:18:07 2001 for XINE, A Free Video Player Project - API reference by - -doxygen1.2.8 written by Dimitri van Heesch, - © 1997-2001
- - diff --git a/doc/xine-lib-API/html/group__version__group.html b/doc/xine-lib-API/html/group__version__group.html deleted file mode 100644 index c93ea69e8..000000000 --- a/doc/xine-lib-API/html/group__version__group.html +++ /dev/null @@ -1,96 +0,0 @@ - - -XINE, A Free Video Player Project - API reference -xine logo - - - - -
-Main Page   Modules   Data Structures   File List   Data Fields   Globals  
-

Version constants

- - - - -

Defines

-#define XINE_MAJOR_VERSION   0
-#define XINE_MINOR_VERSION   9
-#define XINE_SUB_VERSION   2
-

Define Documentation

-

- - - - -
- - -
-#define XINE_MAJOR_VERSION   0 -
-
- - - - - -
-   - - -

-Major version constant.

-

- - - - -
- - -
-#define XINE_MINOR_VERSION   9 -
-
- - - - - -
-   - - -

-Minor version constant.

-

- - - - -
- - -
-#define XINE_SUB_VERSION   2 -
-
- - - - - -
-   - - -

-Sub version constant.

-

Generated at Mon Oct 15 01:18:07 2001 for XINE, A Free Video Player Project - API reference by - -doxygen1.2.8 written by Dimitri van Heesch, - © 1997-2001
- - diff --git a/doc/xine-lib-API/html/group__video__cap.html b/doc/xine-lib-API/html/group__video__cap.html deleted file mode 100644 index 945cffbb9..000000000 --- a/doc/xine-lib-API/html/group__video__cap.html +++ /dev/null @@ -1,146 +0,0 @@ - - -XINE, A Free Video Player Project - API reference -xine logo - - - - -
-Main Page   Modules   Data Structures   File List   Data Fields   Globals  
-

video driver capabilities

- - - - - - -

Defines

-#define VO_CAP_HUE   0x00000010
-#define VO_CAP_SATURATION   0x00000020
-#define VO_CAP_BRIGHTNESS   0x00000040
-#define VO_CAP_CONTRAST   0x00000080
-#define VO_CAP_COLORKEY   0x00000100
-

Define Documentation

-

- - - - -
- - -
-#define VO_CAP_BRIGHTNESS   0x00000040 -
-
- - - - - -
-   - - -

-Driver can set BRIGHTNESS value.

-

- - - - -
- - -
-#define VO_CAP_COLORKEY   0x00000100 -
-
- - - - - -
-   - - -

-Driver can set COLORKEY value.

-

- - - - -
- - -
-#define VO_CAP_CONTRAST   0x00000080 -
-
- - - - - -
-   - - -

-Driver can set CONTRAST value.

-

- - - - -
- - -
-#define VO_CAP_HUE   0x00000010 -
-
- - - - - -
-   - - -

-Driver can set HUE value.

-

- - - - -
- - -
-#define VO_CAP_SATURATION   0x00000020 -
-
- - - - - -
-   - - -

-Driver can set SATURATION value.

-

Generated at Mon Oct 15 01:18:07 2001 for XINE, A Free Video Player Project - API reference by - -doxygen1.2.8 written by Dimitri van Heesch, - © 1997-2001
- - diff --git a/doc/xine-lib-API/html/group__video__group.html b/doc/xine-lib-API/html/group__video__group.html deleted file mode 100644 index fb0955ab5..000000000 --- a/doc/xine-lib-API/html/group__video__group.html +++ /dev/null @@ -1,37 +0,0 @@ - - -XINE, A Free Video Player Project - API reference -xine logo - - - - -
-Main Page   Modules   Data Structures   File List   Data Fields   Globals  
-

Video.

- - - - - - - - - - - - - - - -

Modules

Possible ratios for the VO_PROP_ASPECT_RATIO call
Constants for the get/set properties functions.
video driver capabilities

Data Structures

struct  vo_driver_s
struct  vo_driver_s
struct  vo_driver_t
 Data type of structure vo_driver_s. More...

struct  vo_frame_t
struct  vo_overlay_t

Typedefs

-typedef void vo_frame_t
-typedef void vo_overlay_t
-typedef struct vo_driver_s vo_driver_t
-
Generated at Mon Oct 15 01:18:07 2001 for XINE, A Free Video Player Project - API reference by - -doxygen1.2.8 written by Dimitri van Heesch, - © 1997-2001
- - diff --git a/doc/xine-lib-API/html/group__video__prop.html b/doc/xine-lib-API/html/group__video__prop.html deleted file mode 100644 index 86ca3d2d2..000000000 --- a/doc/xine-lib-API/html/group__video__prop.html +++ /dev/null @@ -1,264 +0,0 @@ - - -XINE, A Free Video Player Project - API reference -xine logo - - - - -
-Main Page   Modules   Data Structures   File List   Data Fields   Globals  
-

Constants for the get/set properties functions.

- - - - - - - - - - -

Defines

-#define VO_PROP_INTERLACED   0
-#define VO_PROP_ASPECT_RATIO   1
-#define VO_PROP_HUE   2
-#define VO_PROP_SATURATION   3
-#define VO_PROP_CONTRAST   4
-#define VO_PROP_BRIGHTNESS   5
-#define VO_PROP_COLORKEY   6
-#define VO_PROP_SOFT_DEINTERLACE   7
-#define VO_NUM_PROPERTIES   8
-

Define Documentation

-

- - - - -
- - -
-#define VO_NUM_PROPERTIES   8 -
-
- - - - - -
-   - - -

-Number of available properties property.

-See also:
-vo_driver_t
-

- - - - -
- - -
-#define VO_PROP_ASPECT_RATIO   1 -
-
- - - - - -
-   - - -

-Aspect ratio property.

-See also:
-vo_driver_t, Possible ratios for the VO_PROP_ASPECT_RATIO call
-

- - - - -
- - -
-#define VO_PROP_BRIGHTNESS   5 -
-
- - - - - -
-   - - -

-Brightness property.

-See also:
-vo_driver_t
-

- - - - -
- - -
-#define VO_PROP_COLORKEY   6 -
-
- - - - - -
-   - - -

-Colorkey property.

-See also:
-vo_driver_t
-

- - - - -
- - -
-#define VO_PROP_CONTRAST   4 -
-
- - - - - -
-   - - -

-Contrast property.

-See also:
-vo_driver_t
-

- - - - -
- - -
-#define VO_PROP_HUE   2 -
-
- - - - - -
-   - - -

-Hue property.

-See also:
-vo_driver_t
-

- - - - -
- - -
-#define VO_PROP_INTERLACED   0 -
-
- - - - - -
-   - - -

-Interleave property.

-See also:
-vo_driver_t
-

- - - - -
- - -
-#define VO_PROP_SATURATION   3 -
-
- - - - - -
-   - - -

-Saturation property.

-See also:
-vo_driver_t
-

- - - - -
- - -
-#define VO_PROP_SOFT_DEINTERLACE   7 -
-
- - - - - -
-   - - -

-Software deinterlacing (BOB) property.

-See also:
-vo_driver_t
-

Generated at Mon Oct 15 01:18:07 2001 for XINE, A Free Video Player Project - API reference by - -doxygen1.2.8 written by Dimitri van Heesch, - © 1997-2001
- - diff --git a/doc/xine-lib-API/html/group__video__ratio.html b/doc/xine-lib-API/html/group__video__ratio.html deleted file mode 100644 index 70301cebd..000000000 --- a/doc/xine-lib-API/html/group__video__ratio.html +++ /dev/null @@ -1,186 +0,0 @@ - - -XINE, A Free Video Player Project - API reference -xine logo - - - - -
-Main Page   Modules   Data Structures   File List   Data Fields   Globals  
-

Possible ratios for the VO_PROP_ASPECT_RATIO call

- - - - - - - -

Defines

-#define ASPECT_AUTO   0
-#define ASPECT_ANAMORPHIC   1
-#define ASPECT_FULL   2
-#define ASPECT_DVB   3
-#define ASPECT_SQUARE   4
-#define NUM_ASPECT_RATIOS   5
-

Detailed Description

-
-See also:
-VO_PROP_ASPECT_RATIO, vo_driver_t

Define Documentation

-

- - - - -
- - -
-#define ASPECT_ANAMORPHIC   1 -
-
- - - - - -
-   - - -

-Set aspect ration to 16:9.

-See also:
-VO_PROP_ASPECT_RATIO
-

- - - - -
- - -
-#define ASPECT_AUTO   0 -
-
- - - - - -
-   - - -

-Let video driver guessing aspect ratio.

-See also:
-VO_PROP_ASPECT_RATIO
-

- - - - -
- - -
-#define ASPECT_DVB   3 -
-
- - - - - -
-   - - -

-Set aspect ration to 1:2.

-See also:
-VO_PROP_ASPECT_RATIO
-

- - - - -
- - -
-#define ASPECT_FULL   2 -
-
- - - - - -
-   - - -

-Set aspect ration to 4:3.

-See also:
-VO_PROP_ASPECT_RATIO
-

- - - - -
- - -
-#define ASPECT_SQUARE   4 -
-
- - - - - -
-   - - -

-Set aspect ration to square pels.

-See also:
-VO_PROP_ASPECT_RATIO
-

- - - - -
- - -
-#define NUM_ASPECT_RATIOS   5 -
-
- - - - - -
-   - - -

-Number of aspect ratios supported for VO_PROP_ASPECT_RATIO property.

-See also:
-VO_PROP_ASPECT_RATIO
-

Generated at Mon Oct 15 01:18:07 2001 for XINE, A Free Video Player Project - API reference by - -doxygen1.2.8 written by Dimitri van Heesch, - © 1997-2001
- - diff --git a/doc/xine-lib-API/html/group__visual__types.html b/doc/xine-lib-API/html/group__visual__types.html deleted file mode 100644 index 05e471a74..000000000 --- a/doc/xine-lib-API/html/group__visual__types.html +++ /dev/null @@ -1,129 +0,0 @@ - - -XINE, A Free Video Player Project - API reference -xine logo - - - - -
-Main Page   Modules   Data Structures   File List   Data Fields   Globals  
-

Valid visual types

- - - - - -

Defines

-#define VISUAL_TYPE_X11   1
-#define VISUAL_TYPE_AA   2
-#define VISUAL_TYPE_FB   3
-#define VISUAL_TYPE_GTK   4
-

Define Documentation

-

- - - - -
- - -
-#define VISUAL_TYPE_AA   2 -
-
- - - - - -
-   - - -

-Asci Art visual type.

-See also:
-xine_list_video_output_plugins, xine_load_video_output_plugin
-

- - - - -
- - -
-#define VISUAL_TYPE_FB   3 -
-
- - - - - -
-   - - -

-Framebuffer visual type

-See also:
-xine_list_video_output_plugins, xine_load_video_output_plugin
-

- - - - -
- - -
-#define VISUAL_TYPE_GTK   4 -
-
- - - - - -
-   - - -

-GTK visual type

-See also:
-xine_list_video_output_plugins, xine_load_video_output_plugin
-

- - - - -
- - -
-#define VISUAL_TYPE_X11   1 -
-
- - - - - -
-   - - -

-X11 visual type.

-See also:
-xine_list_video_output_plugins, xine_load_video_output_plugin
-

Generated at Mon Oct 15 01:18:07 2001 for XINE, A Free Video Player Project - API reference by - -doxygen1.2.8 written by Dimitri van Heesch, - © 1997-2001
- - diff --git a/doc/xine-lib-API/html/group__xine__api.html b/doc/xine-lib-API/html/group__xine__api.html deleted file mode 100644 index 8292217dc..000000000 --- a/doc/xine-lib-API/html/group__xine__api.html +++ /dev/null @@ -1,358 +0,0 @@ - - -XINE, A Free Video Player Project - API reference -xine logo - - - - -
-Main Page   Modules   Data Structures   File List   Data Fields   Globals  
-

API functions

- - - - - - - - - - - - - - - - - - - - - - - -

Modules

Sending events
Loading plugins
Autoplay support
Browsing support
Audio.
Engine management
Init functions
Video.
Version functions
Version constants
Player status constants

Defines

-#define XINE_IMGFMT_YV12   0x32315659
-#define XINE_IMGFMT_YUY2   (('2'<<24)|('Y'<<16)|('U'<<8)|'Y')
-#define XINE_ASPECT_RATIO_SQUARE   1
-#define XINE_ASPECT_RATIO_4_3   2
-#define XINE_ASPECT_RATIO_ANAMORPHIC   3
-#define XINE_ASPECT_RATIO_211_1   4
-#define XINE_ASPECT_RATIO_DONT_TOUCH   42

Functions

-int xine_get_current_frame (xine_t *self, int *width, int *height, int *ratio_code, int *format, uint8_t **y, uint8_t **u, uint8_t **v)
 Snapshot function.

-

Define Documentation

-

- - - - -
- - -
-#define XINE_ASPECT_RATIO_211_1   4 -
-
- - - - - -
-   - - -

-aspect ratio.

-See also:
-xine_get_current_frame
-

- - - - -
- - -
-#define XINE_ASPECT_RATIO_4_3   2 -
-
- - - - - -
-   - - -

-aspect ratio.

-See also:
-xine_get_current_frame
-

- - - - -
- - -
-#define XINE_ASPECT_RATIO_ANAMORPHIC   3 -
-
- - - - - -
-   - - -

-aspect ratio.

-See also:
-xine_get_current_frame
-

- - - - -
- - -
-#define XINE_ASPECT_RATIO_DONT_TOUCH   42 -
-
- - - - - -
-   - - -

-aspect ratio.

-See also:
-xine_get_current_frame
-

- - - - -
- - -
-#define XINE_ASPECT_RATIO_SQUARE   1 -
-
- - - - - -
-   - - -

-aspect ratio.

-See also:
-xine_get_current_frame
-

- - - - -
- - -
-#define XINE_IMGFMT_YUY2   (('2'<<24)|('Y'<<16)|('U'<<8)|'Y') -
-
- - - - - -
-   - - -

-image format.

-See also:
-xine_get_current_frame
-

- - - - -
- - -
-#define XINE_IMGFMT_YV12   0x32315659 -
-
- - - - - -
-   - - -

-image format.

-See also:
-xine_get_current_frame
-

Function Documentation

-

- - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-int xine_get_current_frame ( - -xine_t * self, -
-int * width, -
-int * height, -
-int * ratio_code, -
-int * format, -
-uint8_t ** y, -
-uint8_t ** u, -
-uint8_t ** v ) -
-
- - - - - -
-   - - -

-Snapshot function. -

-

-Parameters:
- - - - - - - - - -
self -  -Current xine engine configuration ( see xine_init() )
width -  -Width of image (be aware that u,v may be subsampled)
height -  -Height of image (be aware that u,v may be subsampled)
ratio_code -  -Aspect ratio of the frame
format -  -Subsampling format YUV 4:2:0 or 4:2:2
y -  -Lumiance information
u -  -Subsample color information
v -  -Subsample color information
-
-Returns:
-1 on success, 0 failure.
-Parameters:
- - - - - - - - - -
self -  -
width -  -
height -  -
ratio_code -  -
format -  -
y -  -
u -  -
v -  -
-
-

Generated at Mon Oct 15 01:18:07 2001 for XINE, A Free Video Player Project - API reference by - -doxygen1.2.8 written by Dimitri van Heesch, - © 1997-2001
- - diff --git a/doc/xine-lib-API/html/group__xine__init.html b/doc/xine-lib-API/html/group__xine__init.html deleted file mode 100644 index 5379c0411..000000000 --- a/doc/xine-lib-API/html/group__xine__init.html +++ /dev/null @@ -1,251 +0,0 @@ - - -XINE, A Free Video Player Project - API reference -xine logo - - - - -
-Main Page   Modules   Data Structures   File List   Data Fields   Globals  
-

Init functions

- - - - - - - - - - - -

Modules

Possible demuxer guessing strategy.
UI communication callbacks.
Configuration structure type.

Functions

-config_values_t* config_file_init (char *filename)
 Configuration file initialisation.

-xine_t* xine_init (vo_driver_t *vo, ao_driver_t *ao, config_values_t *config, gui_stream_end_cb_t stream_end_cb, gui_get_next_mrl_cb_t get_next_mrl_cb, gui_branched_cb_t branched_cb)
 Initialisation of xine.

-void xine_exit (xine_t *self)
 De-initialisation of xine.

-

Function Documentation

-

- - - - -
- - - - - - -
-config_values_t * config_file_init ( - -char * filename ) -
-
- - - - - -
-   - - -

-Configuration file initialisation. -

-

-Parameters:
- - -
filename -  -Pathname of configuration file.
-
-Returns:
-Current config
-See also:
-config_values_t
-Warning:
-This function should be called at least one time before xine_init() call. -

-

Read config file and init a config object of config_values_t type (if it exists)
-Parameters:
- - -
filename -  -
-
-

- - - - -
- - - - - - -
-void xine_exit ( - -xine_t * self ) -
-
- - - - - -
-   - - -

-De-initialisation of xine. -

-

-Parameters:
- - -
self -  -Current xine engine configuration.
-
-Returns:
-Nothing
-See also:
-xine_init() -

-

De-init xine engine.
-Parameters:
- - -
self -  -
-
-

- - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - -
-xine_t * xine_init ( - -vo_driver_t * vo, -
-ao_driver_t * ao, -
-config_values_t * config, -
-gui_stream_end_cb_t stream_end_cb, -
-gui_get_next_mrl_cb_t get_next_mrl_cb, -
-gui_branched_cb_t branched_cb ) -
-
- - - - - -
-   - - -

-Initialisation of xine. -

-

-Parameters:
- - - - - - - -
vo -  -video driver ( see xine_load_video_output_plugin() )
ao -  -audio driver ( see xine_load_audio_output_plugin() )
config -  -current configuration ( see config_file_init() )
stream_end -  -cb called on stream end
get_next_mrl_cb -  -called to find out next mrl for seamless branching
branched_cb -  -called if seamless branch was taken
-
-Returns:
-Current xine engine configuration
-See also:
-vo_driver_t, ao_driver_t, config_values_t, gui_stream_end_cb_t, gui_get_next_mrl_cb_t, gui_branched_cb_t
-Warning:
-This function should be called before any other xine_*() function. -

-

Init of xine. It should called once at startup. all callbacks may be NULL if ui is not interested in them for whatever reason ao may be NULL for no audio playback
-Parameters:
- - - - - - - -
vo -  -
ao -  -
config -  -
stream_end_cb -  -
get_next_mrl_cb -  -
branched_cb -  -
-
-

Generated at Mon Oct 15 01:18:07 2001 for XINE, A Free Video Player Project - API reference by - -doxygen1.2.8 written by Dimitri van Heesch, - © 1997-2001
- - diff --git a/doc/xine-lib-API/html/group__xine__management.html b/doc/xine-lib-API/html/group__xine__management.html deleted file mode 100644 index b1ac64a7d..000000000 --- a/doc/xine-lib-API/html/group__xine__management.html +++ /dev/null @@ -1,1043 +0,0 @@ - - -XINE, A Free Video Player Project - API reference -xine logo - - - - -
-Main Page   Modules   Data Structures   File List   Data Fields   Globals  
-

Engine management

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Defines

-#define SPEED_PAUSE   0
-#define SPEED_SLOW_4   1
-#define SPEED_SLOW_2   2
-#define SPEED_NORMAL   4
-#define SPEED_FAST_2   8
-#define SPEED_FAST_4   16

Functions

-void xine_play (xine_t *self, char *MRL, int start_pos, int start_time)
 Start to play a stream.

-void xine_set_speed (xine_t *self, int speed)
 Set playback speed.

-int xine_get_speed (xine_t *self)
 Get the playback speed.

-void xine_set_av_offset (xine_t *self, int offset_pts)
 Set audio/video sync.

-int xine_get_av_offset (xine_t *self)
 Get audio/video sync.

-void xine_stop (xine_t *self)
 Stop playing.

-int xine_eject (xine_t *self)
 Eject media.

-int xine_get_status (xine_t *self)
 Get current xine status.

-int xine_get_current_position (xine_t *self)
 Get current position.

-int xine_get_current_time (xine_t *self)
 get current pos in seconds.

-int xine_get_stream_length (xine_t *self)
 estimate length of input stream in seconds.

-int xine_get_audio_channel (xine_t *self)
 Get current audio channel.

-void xine_select_audio_channel (xine_t *self, int channel)
 Set audio channel.

-int xine_get_spu_channel (xine_t *self)
 Get current sub-title channel.

-void xine_select_spu_channel (xine_t *self, int channel)
 Set sub-title channel.

-

Define Documentation

-

- - - - -
- - -
-#define SPEED_FAST_2   8 -
-
- - - - - -
-   - - -

-Playback at 200% speed.

-See also:
-xine_set_speed(), xine_get_speed()
-

- - - - -
- - -
-#define SPEED_FAST_4   16 -
-
- - - - - -
-   - - -

-Playback at 400% speed.

-See also:
-xine_set_speed(), xine_get_speed()
-

- - - - -
- - -
-#define SPEED_NORMAL   4 -
-
- - - - - -
-   - - -

-Playback at 100% speed.

-See also:
-xine_set_speed(), xine_get_speed()
-

- - - - -
- - -
-#define SPEED_PAUSE   0 -
-
- - - - - -
-   - - -

-Playback pause.

-See also:
-xine_set_speed(), xine_get_speed()
-

- - - - -
- - -
-#define SPEED_SLOW_2   2 -
-
- - - - - -
-   - - -

-Playback at 50% speed.

-See also:
-xine_set_speed(), xine_get_speed()
-

- - - - -
- - -
-#define SPEED_SLOW_4   1 -
-
- - - - - -
-   - - -

-Playback at 25% speed.

-See also:
-xine_set_speed(), xine_get_speed()
-

Function Documentation

-

- - - - -
- - - - - - -
-int xine_eject ( - -xine_t * self ) -
-
- - - - - -
-   - - -

-Eject media. -

-

-Parameters:
- - -
self -  -Current xine engine configuration ( see xine_init() )
-
-Returns:
-1 on success, 0 on failure. -

-

Tell current input plugin to eject media.
-Parameters:
- - -
self -  -
-
-

- - - - -
- - - - - - -
-int xine_get_audio_channel ( - -xine_t * self ) -
-
- - - - - -
-   - - -

-Get current audio channel. -

-

-Parameters:
- - -
self -  -Current xine engine configuration ( see xine_init() )
-
-Returns:
-Current audio chennel -

-

Get current audio channel.
-Parameters:
- - -
self -  -
-
-

- - - - -
- - - - - - -
-int xine_get_av_offset ( - -xine_t * self ) -
-
- - - - - -
-   - - -

-Get audio/video sync. -

-

-Parameters:
- - -
self -  -Current xine engine configuration ( see xine_init() )
-
-Returns:
-Current audio/video offset. -

-

Return the current audio/video sync offset ( see xine_set_av_offset() ).
-Parameters:
- - -
self -  -
-
-

- - - - -
- - - - - - -
-int xine_get_current_position ( - -xine_t * self ) -
-
- - - - - -
-   - - -

-Get current position. -

-

-Parameters:
- - -
self -  -Current xine engine configuration ( see xine_init() )
-
-Returns:
-Current position ( 0..65535 ) -

-

Get current position in stream.
-Parameters:
- - -
self -  -
-
-

- - - - -
- - - - - - -
-int xine_get_current_time ( - -xine_t * self ) -
-
- - - - - -
-   - - -

-get current pos in seconds. -

-

-Parameters:
- - -
self -  -Current xine engine configuration ( see xine_init() )
-
-Returns:
-current position measured in seconds from the beginning of the stream -

-

get current position measured in seconds from the beginning of the stream
-Parameters:
- - -
self -  -
-
-

- - - - -
- - - - - - -
-int xine_get_speed ( - -xine_t * self ) -
-
- - - - - -
-   - - -

-Get the playback speed. -

-

-Parameters:
- - -
self -  -Current xine engine configuration ( see xine_init() )
-
-Returns:
-speed value ( see SPEED_PAUSE, SPEED_SLOW_4, SPEED_SLOW_2, SPEED_NORMAL, SPEED_FAST_2, SPEED_FAST_4 ) -

-

Get the current speed playback. Possible values are SPEED_PAUSE, SPEED_SLOW_4, SPEED_SLOW_2, SPEED_NORMAL, SPEED_FAST_2, SPEED_FAST_4.
-Parameters:
- - -
self -  -
-
-

- - - - -
- - - - - - -
-int xine_get_spu_channel ( - -xine_t * self ) -
-
- - - - - -
-   - - -

-Get current sub-title channel. -

-

-Parameters:
- - -
self -  -Current xine engine configuration ( see xine_init() )
-
-Returns:
-Current sub-title channel -

-

Get current sub-title channel.
-Parameters:
- - -
self -  -
-
-

- - - - -
- - - - - - -
-int xine_get_status ( - -xine_t * self ) -
-
- - - - - -
-   - - -

-Get current xine status. -

-

-Parameters:
- - -
self -  -Current xine engine configuration ( see xine_init() )
-
-Returns:
-Current status ( see Player status constants ) -

-

Return the current state of xine engine.
-Parameters:
- - -
self -  -
-
-

- - - - -
- - - - - - -
-int xine_get_stream_length ( - -xine_t * self ) -
-
- - - - - -
-   - - -

-estimate length of input stream in seconds. -

-

-Parameters:
- - -
self -  -Current xine engine configuration ( see xine_init() )
-
-Returns:
-length of input stream in seconds or 0 if stream is not seekable -

-

estimate length of input stream in seconds
-Parameters:
- - -
self -  -
-
-

- - - - -
- - - - - - - - - - - - - - - - - - -
-void xine_play ( - -xine_t * self, -
-char * MRL, -
-int start_pos, -
-int start_time ) -
-
- - - - - -
-   - - -

-Start to play a stream. -

-

-Parameters:
- - - - - -
self -  -Current xine engine configuration ( see xine_init() )
MRL -  -Media Resource Location to open
start_pos -  -position in input source (0..65535)
start_time -  -position measured in seconds from stream start
-
-Returns:
-Nothing -

-

Open a stream and play it. If both start position parameters are !=0 start_pos will be used for non-seekable streams both values will be ignored
-Parameters:
- - - - - -
self -  -
MRL -  -
start_pos -  -
start_time -  -
-
-

- - - - -
- - - - - - - - - - -
-void xine_select_audio_channel ( - -xine_t * self, -
-int channel ) -
-
- - - - - -
-   - - -

-Set audio channel. -

-

-Parameters:
- - -
self -  -Current xine engine configuration ( see xine_init() )
-
-Returns:
-Nothing -

-

Set desired audio channel.
-Parameters:
- - - -
self -  -
channel -  -
-
-

- - - - -
- - - - - - - - - - -
-void xine_select_spu_channel ( - -xine_t * self, -
-int channel ) -
-
- - - - - -
-   - - -

-Set sub-title channel. -

-

-Parameters:
- - -
self -  -Current xine engine configuration ( see xine_init() )
-
-Returns:
-Nothing -

-

Set desired sub-title channel.
-Parameters:
- - - -
self -  -
channel -  -
-
-

- - - - -
- - - - - - - - - - -
-void xine_set_av_offset ( - -xine_t * self, -
-int offset_pts ) -
-
- - - - - -
-   - - -

-Set audio/video sync. -

-

-Parameters:
- - - -
self -  -Current xine engine configuration ( see xine_init() )
offset_pts -  -New pts.
-
-Returns:
-Nothing -

-

Set audio/video sync offset, according to offset_pts value ( see xine_get_av_offset() ).
-Parameters:
- - - -
self -  -
offset_pts -  -
-
-

- - - - -
- - - - - - - - - - -
-void xine_set_speed ( - -xine_t * self, -
-int speed ) -
-
- - - - - -
-   - - -

-Set playback speed. -

-

-Parameters:
- - - -
self -  -Current xine engine configuration ( see xine_init() )
speed -  -Desired playback speed ( see SPEED_PAUSE, SPEED_SLOW_4, SPEED_SLOW_2, SPEED_NORMAL, SPEED_FAST_2, SPEED_FAST_4 )
-
-Returns:
-Nothing -

-

Set the playback speed to desired speed, according of SPEED_x constant.
-Parameters:
- - - -
self -  -
speed -  -
-
-

- - - - -
- - - - - - -
-void xine_stop ( - -xine_t * self ) -
-
- - - - - -
-   - - -

-Stop playing. -

-

-Parameters:
- - -
self -  -Current xine engine configuration ( see xine_init() )
-
-Returns:
-Nothing -

-

Stop the playback.
-Parameters:
- - -
self -  -
-
-

Generated at Mon Oct 15 01:18:07 2001 for XINE, A Free Video Player Project - API reference by - -doxygen1.2.8 written by Dimitri van Heesch, - © 1997-2001
- - diff --git a/doc/xine-lib-API/html/group__xine__version.html b/doc/xine-lib-API/html/group__xine__version.html deleted file mode 100644 index a8d3b60d5..000000000 --- a/doc/xine-lib-API/html/group__xine__version.html +++ /dev/null @@ -1,269 +0,0 @@ - - -XINE, A Free Video Player Project - API reference -xine logo - - - - -
-Main Page   Modules   Data Structures   File List   Data Fields   Globals  
-

Version functions

- - - - - - - - - - - -

Functions

-char* xine_get_str_version (void)
 return string version, like "0.5.0".

-int xine_get_major_version (void)
 return version information.

-int xine_get_minor_version (void)
 return version information.

-int xine_get_sub_version (void)
 return version information.

-int xine_check_version (int major, int minor, int sub)
 check minimal version.

-

Function Documentation

-

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

-check minimal version. -

-

-Parameters:
- - - - -
major -  -major version wanted.
minorr -  -minor version wanted.
sub -  -sub version wanted.
-
-Returns:
-1 if installed version is >= to desired, otherwise 0 -

-

Compare version numbers with xine installed version.
-Parameters:
- - - - -
major -  -
minor -  -
sub -  -
-
-

- - - - -
- - - - - - -
-int xine_get_major_version ( - -void ) -
-
- - - - - -
-   - - -

-return version information. -

-

-Parameters:
- - -
None. -  -
-
-Returns:
-major version.
-

- - - - -
- - - - - - -
-int xine_get_minor_version ( - -void ) -
-
- - - - - -
-   - - -

-return version information. -

-

-Parameters:
- - -
None. -  -
-
-Returns:
-minor version.
-

- - - - -
- - - - - - -
-char * xine_get_str_version ( - -void ) -
-
- - - - - -
-   - - -

-return string version, like "0.5.0". -

-

-Parameters:
- - -
None. -  -
-
-Returns:
-string version
-

- - - - -
- - - - - - -
-int xine_get_sub_version ( - -void ) -
-
- - - - - -
-   - - -

-return version information. -

-

-Parameters:
- - -
None. -  -
-
-Returns:
-sub version.
-

Generated at Mon Oct 15 01:18:07 2001 for XINE, A Free Video Player Project - API reference by - -doxygen1.2.8 written by Dimitri van Heesch, - © 1997-2001
- - diff --git a/doc/xine-lib-API/html/index.html b/doc/xine-lib-API/html/index.html deleted file mode 100644 index 9bc4b4976..000000000 --- a/doc/xine-lib-API/html/index.html +++ /dev/null @@ -1,19 +0,0 @@ - - -XINE, A Free Video Player Project - API reference -xine logo - - - - -
-Main Page   Modules   Data Structures   File List   Data Fields   Globals  
-

XINE, A Free Video Player Project - API reference Documentation

-

-

Generated at Mon Oct 15 01:18:06 2001 for XINE, A Free Video Player Project - API reference by - -doxygen1.2.8 written by Dimitri van Heesch, - © 1997-2001
- - diff --git a/doc/xine-lib-API/html/modules.html b/doc/xine-lib-API/html/modules.html deleted file mode 100644 index 85e8d8559..000000000 --- a/doc/xine-lib-API/html/modules.html +++ /dev/null @@ -1,54 +0,0 @@ - - -XINE, A Free Video Player Project - API reference -xine logo - - - - -
-Main Page   Modules   Data Structures   File List   Data Fields   Globals  
-

XINE, A Free Video Player Project - API reference Modules

Here is a list of all modules: -
Generated at Mon Oct 15 01:18:07 2001 for XINE, A Free Video Player Project - API reference by - -doxygen1.2.8 written by Dimitri van Heesch, - © 1997-2001
- - diff --git a/doc/xine-lib-API/html/structao__driver__t.html b/doc/xine-lib-API/html/structao__driver__t.html deleted file mode 100644 index f80b2d588..000000000 --- a/doc/xine-lib-API/html/structao__driver__t.html +++ /dev/null @@ -1,26 +0,0 @@ - - -XINE, A Free Video Player Project - API reference -xine logo - - - - -
-Main Page   Modules   Data Structures   File List   Data Fields   Globals  
-

ao_driver_t Struct Reference

#include <xine.h> -

- -
-

Detailed Description

-Opaque data type. -

-

The documentation for this struct was generated from the following file: -
Generated at Mon Oct 15 01:18:06 2001 for XINE, A Free Video Player Project - API reference by - -doxygen1.2.8 written by Dimitri van Heesch, - © 1997-2001
- - diff --git a/doc/xine-lib-API/html/structao__functions__t.html b/doc/xine-lib-API/html/structao__functions__t.html deleted file mode 100644 index 3d96d2ecd..000000000 --- a/doc/xine-lib-API/html/structao__functions__t.html +++ /dev/null @@ -1,26 +0,0 @@ - - -XINE, A Free Video Player Project - API reference -xine logo - - - - -
-Main Page   Modules   Data Structures   File List   Data Fields   Globals  
-

ao_functions_t Struct Reference

#include <xine.h> -

- -
-

Detailed Description

-Opaque data type. -

-

The documentation for this struct was generated from the following file: -
Generated at Thu Jul 26 11:29:45 2001 for XINE, A Free Video Player Project - API reference by - -doxygen1.2.8 written by Dimitri van Heesch, - © 1997-2001
- - diff --git a/doc/xine-lib-API/html/structcfg__data__t.html b/doc/xine-lib-API/html/structcfg__data__t.html deleted file mode 100644 index d13a052cb..000000000 --- a/doc/xine-lib-API/html/structcfg__data__t.html +++ /dev/null @@ -1,26 +0,0 @@ - - -XINE, A Free Video Player Project - API reference -xine logo - - - - -
-Main Page   Modules   Data Structures   File List   Data Fields   Globals  
-

cfg_data_t Struct Reference

#include <xine.h> -

- -
-

Detailed Description

-Opaque data type. -

-

The documentation for this struct was generated from the following file: -
Generated at Mon Oct 15 01:18:06 2001 for XINE, A Free Video Player Project - API reference by - -doxygen1.2.8 written by Dimitri van Heesch, - © 1997-2001
- - diff --git a/doc/xine-lib-API/html/structconfig__values__s.html b/doc/xine-lib-API/html/structconfig__values__s.html deleted file mode 100644 index d452e6f91..000000000 --- a/doc/xine-lib-API/html/structconfig__values__s.html +++ /dev/null @@ -1,219 +0,0 @@ - - -XINE, A Free Video Player Project - API reference -xine logo - - - - -
-Main Page   Modules   Data Structures   File List   Data Fields   Globals  
-

config_values_s Struct Reference

#include <xine.h> -

- - - - - - - - - -

Data Fields

char* (* lookup_str )(config_values_t *self, char *key, char *str_default)
int (* lookup_int )(config_values_t *self, char *key, int n_default)
void (* set_str )(config_values_t *self, char *key, char *value)
void (* set_int )(config_values_t *self, char *key, int value)
void (* save )(config_values_t *self)
void (* read )(config_values_t *self, char *filename)
cfg_data_t* data
-

Detailed Description

-Configuration file manipulation.
-See also:
-config_file_init()
-

-

Field Documentation

-

- - - - -
- - - - - -
-cfg_data_t * config_values_s::data -
-
- - - - - -
-   - - -

-Contains private data of this configuration file.

-

- - - - -
- - - - - -
-int(* config_values_s::lookup_int)(config_values_t *self, char *key, int n_default) -
-
- - - - - -
-   - - -

-Lookup integer values in configuration file.

-

- - - - -
- - - - - -
-char *(* config_values_s::lookup_str)(config_values_t *self, char *key, char *str_default) -
-
- - - - - -
-   - - -

-Lookup string values in configuration file.

-

- - - - -
- - - - - -
-void(* config_values_s::read)(config_values_t *self, char *filename) -
-
- - - - - -
-   - - -

-Read configuration file from disk, overriding values in memory. If you also want to clear values that are not in the file, use config_file_init() instead!

-

- - - - -
- - - - - -
-void(* config_values_s::save)(config_values_t *self) -
-
- - - - - -
-   - - -

-Write configuration file to disk.

-

- - - - -
- - - - - -
-void(* config_values_s::set_int)(config_values_t *self, char *key, int value) -
-
- - - - - -
-   - - -

-Set integer values in configuration file.

-

- - - - -
- - - - - -
-void(* config_values_s::set_str)(config_values_t *self, char *key, char *value) -
-
- - - - - -
-   - - -

-Set string values in configuration file.

-

The documentation for this struct was generated from the following file: -
Generated at Mon Oct 15 01:18:07 2001 for XINE, A Free Video Player Project - API reference by - -doxygen1.2.8 written by Dimitri van Heesch, - © 1997-2001
- - diff --git a/doc/xine-lib-API/html/structconfig__values__t.html b/doc/xine-lib-API/html/structconfig__values__t.html deleted file mode 100644 index 3953e2293..000000000 --- a/doc/xine-lib-API/html/structconfig__values__t.html +++ /dev/null @@ -1,33 +0,0 @@ - - -XINE, A Free Video Player Project - API reference -xine logo - - - - -
-Main Page   Modules   Data Structures   File List   Data Fields   Globals  
-

config_values_t Struct Reference

Data type of structure config_values_s. -More... -

-#include <xine.h> -

- -
-

Detailed Description

-Data type of structure config_values_s. -

-

-See also:
-config_values_s.
-

-

The documentation for this struct was generated from the following file: -
Generated at Mon Oct 15 01:18:07 2001 for XINE, A Free Video Player Project - API reference by - -doxygen1.2.8 written by Dimitri van Heesch, - © 1997-2001
- - diff --git a/doc/xine-lib-API/html/structmrl__t.html b/doc/xine-lib-API/html/structmrl__t.html deleted file mode 100644 index 860b11907..000000000 --- a/doc/xine-lib-API/html/structmrl__t.html +++ /dev/null @@ -1,165 +0,0 @@ - - -XINE, A Free Video Player Project - API reference -xine logo - - - - -
-Main Page   Modules   Data Structures   File List   Data Fields   Globals  
-

mrl_t Struct Reference

#include <xine.h> -

- - - - - - - -

Data Fields

char* origin
char* mrl
char* link
uint32_t type
off_t size
-

Detailed Description

-mrl type.
-See also:
-xine_get_browse_mrls(), MRL_ZERO, MRL_DUPLICATE, MRLS_DUPLICATE, Types of available mrls
-

-

Field Documentation

-

- - - - -
- - - - - -
-char * mrl_t::link -
-
- - - - - -
-   - - -

-name of link, if exist, otherwise NULL

-

- - - - -
- - - - - -
-char * mrl_t::mrl -
-
- - - - - -
-   - - -

-<type>://<location>

-

- - - - -
- - - - - -
-char * mrl_t::origin -
-
- - - - - -
-   - - -

-Origin of grabbed mrls (eg: path for file plugin

-

- - - - -
- - - - - -
-off_t mrl_t::size -
-
- - - - - -
-   - - -

-size of this source, may be 0

-

- - - - -
- - - - - -
-uint32_t mrl_t::type -
-
- - - - - -
-   - - -

-match to mrl_type enum

-

The documentation for this struct was generated from the following file: -
Generated at Mon Oct 15 01:18:07 2001 for XINE, A Free Video Player Project - API reference by - -doxygen1.2.8 written by Dimitri van Heesch, - © 1997-2001
- - diff --git a/doc/xine-lib-API/html/structvo__driver__s.html b/doc/xine-lib-API/html/structvo__driver__s.html deleted file mode 100644 index 4cc7c34f0..000000000 --- a/doc/xine-lib-API/html/structvo__driver__s.html +++ /dev/null @@ -1,308 +0,0 @@ - - -XINE, A Free Video Player Project - API reference -xine logo - - - - -
-Main Page   Modules   Data Structures   File List   Data Fields   Globals  
-

vo_driver_s Struct Reference

#include <xine.h> -

- - - - - - - - - - - - -

Data Fields

uint32_t (* get_capabilities )(vo_driver_t *self)
vo_frame_t* (* alloc_frame )(vo_driver_t *self)
void (* update_frame_format )(vo_driver_t *self, vo_frame_t *img, uint32_t width, uint32_t height, int ratio_code, int format)
void (* display_frame )(vo_driver_t *self, vo_frame_t *vo_img)
void (* overlay_blend )(vo_driver_t *self, vo_frame_t *vo_img, vo_overlay_t *overlay)
int (* get_property )(vo_driver_t *self, int property)
int (* set_property )(vo_driver_t *self, int property, int value)
void (* get_property_min_max )(vo_driver_t *self, int property, int *min, int *max)
int (* gui_data_exchange )(vo_driver_t *self, int data_type, void *data)
void (* exit )(vo_driver_t *self)
-

Detailed Description

-Video driver fonctions. -

-

Field Documentation

-

- - - - -
- - - - - -
-vo_frame_t *(* vo_driver_s::alloc_frame)(vo_driver_t *self) -
-
- - - - - -
-   - - -

-Allocate an vo_frame_t struct, the driver must supply the copy, field and dispose functions

-

- - - - -
- - - - - -
-void(* vo_driver_s::display_frame)(vo_driver_t *self, vo_frame_t *vo_img) -
-
- - - - - -
-   - - -

-Display a given frame

-

- - - - -
- - - - - -
-void(* vo_driver_s::exit)(vo_driver_t *self) -
-
- - - - - -
-   - - -

-Leaving video driver.

-

- - - - -
- - - - - -
-uint32_t(* vo_driver_s::get_capabilities)(vo_driver_t *self) -
-
- - - - - -
-   - - -

-Get capabilities of video driver.

-See also:
-video driver capabilities
-

- - - - -
- - - - - -
-int(* vo_driver_s::get_property)(vo_driver_t *self, int property) -
-
- - - - - -
-   - - -

-Get value if property.

-See also:
-Constants for the get/set properties functions.
-

- - - - -
- - - - - -
-void(* vo_driver_s::get_property_min_max)(vo_driver_t *self, int property, int *min, int *max) -
-
- - - - - -
-   - - -

-Get min/max values of property.

-See also:
-Constants for the get/set properties functions.
-

- - - - -
- - - - - -
-int(* vo_driver_s::gui_data_exchange)(vo_driver_t *self, int data_type, void *data) -
-
- - - - - -
-   - - -

-General purpose communication channel between gui and driver -

-this should be used to propagate events, display data, window sizes etc. to the driver

-

- - - - -
- - - - - -
-void(* vo_driver_s::overlay_blend)(vo_driver_t *self, vo_frame_t *vo_img, vo_overlay_t *overlay) -
-
- - - - - -
-   - - -

-Overlay functions

-

- - - - -
- - - - - -
-int(* vo_driver_s::set_property)(vo_driver_t *self, int property, int value) -
-
- - - - - -
-   - - -

-Set value of property.

-See also:
-Constants for the get/set properties functions.
-

- - - - -
- - - - - -
-void(* vo_driver_s::update_frame_format)(vo_driver_t *self, vo_frame_t *img, uint32_t width, uint32_t height, int ratio_code, int format) -
-
- - - - - -
-   - - -

-Check if the given image fullfills the format specified (re-)allocate memory if necessary

-

The documentation for this struct was generated from the following file: -
Generated at Mon Oct 15 01:18:07 2001 for XINE, A Free Video Player Project - API reference by - -doxygen1.2.8 written by Dimitri van Heesch, - © 1997-2001
- - diff --git a/doc/xine-lib-API/html/structvo__driver__t.html b/doc/xine-lib-API/html/structvo__driver__t.html deleted file mode 100644 index 537811fd0..000000000 --- a/doc/xine-lib-API/html/structvo__driver__t.html +++ /dev/null @@ -1,33 +0,0 @@ - - -XINE, A Free Video Player Project - API reference -xine logo - - - - -
-Main Page   Modules   Data Structures   File List   Data Fields   Globals  
-

vo_driver_t Struct Reference

Data type of structure vo_driver_s. -More... -

-#include <xine.h> -

- -
-

Detailed Description

-Data type of structure vo_driver_s. -

-

-See also:
-structure vo_driver_s.
-

-

The documentation for this struct was generated from the following file: -
Generated at Mon Oct 15 01:18:07 2001 for XINE, A Free Video Player Project - API reference by - -doxygen1.2.8 written by Dimitri van Heesch, - © 1997-2001
- - diff --git a/doc/xine-lib-API/html/structvo__frame__t.html b/doc/xine-lib-API/html/structvo__frame__t.html deleted file mode 100644 index ff3462247..000000000 --- a/doc/xine-lib-API/html/structvo__frame__t.html +++ /dev/null @@ -1,28 +0,0 @@ - - -XINE, A Free Video Player Project - API reference -xine logo - - - - -
-Main Page   Modules   Data Structures   File List   Data Fields   Globals  
-

vo_frame_t Struct Reference

#include <xine.h> -

- -
-

Detailed Description

-Opaque data type.
-See also:
-vo_driver_t
-

-

The documentation for this struct was generated from the following file: -
Generated at Mon Oct 15 01:18:07 2001 for XINE, A Free Video Player Project - API reference by - -doxygen1.2.8 written by Dimitri van Heesch, - © 1997-2001
- - diff --git a/doc/xine-lib-API/html/structvo__overlay__t.html b/doc/xine-lib-API/html/structvo__overlay__t.html deleted file mode 100644 index 5689d914d..000000000 --- a/doc/xine-lib-API/html/structvo__overlay__t.html +++ /dev/null @@ -1,28 +0,0 @@ - - -XINE, A Free Video Player Project - API reference -xine logo - - - - -
-Main Page   Modules   Data Structures   File List   Data Fields   Globals  
-

vo_overlay_t Struct Reference

#include <xine.h> -

- -
-

Detailed Description

-Opaque data type.
-See also:
-vo_driver_t
-

-

The documentation for this struct was generated from the following file: -
Generated at Mon Oct 15 01:18:07 2001 for XINE, A Free Video Player Project - API reference by - -doxygen1.2.8 written by Dimitri van Heesch, - © 1997-2001
- - diff --git a/doc/xine-lib-API/html/structxine__t.html b/doc/xine-lib-API/html/structxine__t.html deleted file mode 100644 index ed1a905e1..000000000 --- a/doc/xine-lib-API/html/structxine__t.html +++ /dev/null @@ -1,28 +0,0 @@ - - -XINE, A Free Video Player Project - API reference -xine logo - - - - -
-Main Page   Modules   Data Structures   File List   Data Fields   Globals  
-

xine_t Struct Reference

#include <xine.h> -

- -
-

Detailed Description

-Opaque data type.
-See also:
-xine_load_audio_output_plugin
-

-

The documentation for this struct was generated from the following file: -
Generated at Mon Oct 15 01:18:07 2001 for XINE, A Free Video Player Project - API reference by - -doxygen1.2.8 written by Dimitri van Heesch, - © 1997-2001
- - diff --git a/doc/xine-lib-API/html/xine_8h-source.html b/doc/xine-lib-API/html/xine_8h-source.html deleted file mode 100644 index fa93d4f49..000000000 --- a/doc/xine-lib-API/html/xine_8h-source.html +++ /dev/null @@ -1,435 +0,0 @@ - - -XINE, A Free Video Player Project - API reference -xine logo - - - - -
-Main Page   Modules   Data Structures   File List   Data Fields   Globals  
-

xine.h

Go to the documentation of this file.
00001 /* !! DO NO EDIT THIS FILE, it is automatically generated */
-00031 /*
-00032  * $Id: xine_8h-source.html,v 1.4 2001/10/14 23:19:59 f1rmb Exp $
-00033  *
-00034  */
-00035 
-00036 #ifndef HAVE_XINE_H
-00037 #define HAVE_XINE_H
-00038 
-00039 #ifdef __cplusplus
-00040 extern "C" {
-00041 #endif
-00042 
-00043 #include <inttypes.h>
-00044 #include <unistd.h>
-00045 #include <sys/types.h>
-00046 
-00047 #ifndef XINE_COMPILE
-00048 #include <xine/video_out.h>
-00049 #endif
-00050 
-00051 #ifndef DOC_HIDDEN
-00052 #include <xine/events.h>
-00053 #endif
-00054 
-00059 #define XINE_SKINDIR    "/usr/local/share/xine/skins"
-00060 
-00070 #define XINE_BUILD_CC      "gcc version 2.95.3 20010315 (release)"
-00071 
-00074 #define XINE_BUILD_OS      "Linux 2.4.9 i686"
-00075 
-00078 #define XINE_BUILD_DATE    "Mon 15 Oct 2001 00:22:19"
-00079 
-00097 #define XINE_STOP      0
-00098 
-00103 #define XINE_PLAY      1
-00104 
-00109 #define XINE_QUIT      2
-00110 
-00122 #define XINE_MAJOR_VERSION 0
-00123 
-00127 #define XINE_MINOR_VERSION 9
-00128 
-00132 #define XINE_SUB_VERSION   2
-00133 
-00148 char *xine_get_str_version(void);
-00149 
-00157 int xine_get_major_version(void);
-00158 
-00166 int xine_get_minor_version(void);
-00167 
-00175 int xine_get_sub_version(void);
-00176 
-00187 int xine_check_version(int major, int minor, int sub);
-00188 
-00205 #define VO_CAP_HUE          0x00000010
-00206 
-00210 #define VO_CAP_SATURATION   0x00000020
-00211 
-00215 #define VO_CAP_BRIGHTNESS   0x00000040
-00216 
-00220 #define VO_CAP_CONTRAST     0x00000080
-00221 
-00225 #define VO_CAP_COLORKEY     0x00000100
-00226 
-00239 #define VO_PROP_INTERLACED        0
-00240 
-00245 #define VO_PROP_ASPECT_RATIO      1
-00246 
-00251 #define VO_PROP_HUE               2
-00252 
-00257 #define VO_PROP_SATURATION        3
-00258 
-00263 #define VO_PROP_CONTRAST          4
-00264 
-00269 #define VO_PROP_BRIGHTNESS        5
-00270 
-00275 #define VO_PROP_COLORKEY          6
-00276 
-00281 #define VO_PROP_SOFT_DEINTERLACE  7
-00282 
-00287 #define VO_NUM_PROPERTIES         8
-00288 
-00302 #define ASPECT_AUTO        0
-00303 
-00308 #define ASPECT_ANAMORPHIC  1
-00309 
-00314 #define ASPECT_FULL        2
-00315 
-00320 #define ASPECT_DVB         3
-00321 
-00326 #define ASPECT_SQUARE      4
-00327 
-00332 #define NUM_ASPECT_RATIOS  5
-00333 
-00336 #ifdef DOC_HIDDEN
-00337 
-00342 typedef void vo_frame_t;
-00348 typedef void vo_overlay_t;
-00349 
-00355 typedef struct vo_driver_s vo_driver_t;
-00356 
-00361 struct vo_driver_s {
-00366   uint32_t (*get_capabilities) (vo_driver_t *self);
-00371   vo_frame_t* (*alloc_frame) (vo_driver_t *self);
-00376   void (*update_frame_format) (vo_driver_t *self, vo_frame_t *img,
-00377                                uint32_t width, uint32_t height, 
-00378                                int ratio_code, int format);
-00382   void (*display_frame) (vo_driver_t *self, vo_frame_t *vo_img);
-00386   void (*overlay_blend) (vo_driver_t *self, vo_frame_t *vo_img, vo_overlay_t *overlay);
-00394   int (*get_property) (vo_driver_t *self, int property);
-00399   int (*set_property) (vo_driver_t *self, 
-00400                        int property, int value);
-00405   void (*get_property_min_max) (vo_driver_t *self,
-00406                                 int property, int *min, int *max);
-00413   int (*gui_data_exchange) (vo_driver_t *self, int data_type,
-00414                             void *data);
-00418   void (*exit) (vo_driver_t *self);
-00419 
-00420 };
-00421 #endif
-00422 
-00439 typedef void xine_t;
-00444 typedef void ao_driver_t;
-00450 #ifdef DOC_HIDDEN
-00451 typedef void cfg_data_t;
-00457 typedef struct config_values_s config_values_t;
-00463 struct config_values_s {
-00467   char* (*lookup_str) (config_values_t *self,
-00468                        char *key, char *str_default);
-00472   int (*lookup_int) (config_values_t *self,
-00473                      char *key, int n_default);
-00477   void (*set_str) (config_values_t *self,
-00478                    char *key, char *value) ;
-00482   void (*set_int) (config_values_t *self,
-00483                    char *key, int value) ;
-00487   void (*save) (config_values_t *self);
-00493   void (*read) (config_values_t *self, char *filename);
-00497   cfg_data_t *data;
-00498 };
-00499 #endif
-00500 
-00513 config_values_t *config_file_init (char *filename);
-00514 
-00525 typedef void (*gui_stream_end_cb_t) (int nStatus);
-00530 typedef char* (*gui_get_next_mrl_cb_t) (void);
-00535 typedef void (*gui_branched_cb_t) (void);
-00536 
-00551 #define DEMUX_DEFAULT_STRATEGY    0
-00552 
-00557 #define DEMUX_REVERT_STRATEGY     1
-00558 
-00563 #define DEMUX_CONTENT_STRATEGY    2
-00564 
-00569 #define DEMUX_EXTENSION_STRATEGY  3
-00570 
-00591 xine_t *xine_init (vo_driver_t *vo, 
-00592                    ao_driver_t *ao,
-00593                    config_values_t *config,
-00594                    gui_stream_end_cb_t stream_end_cb,
-00595                    gui_get_next_mrl_cb_t get_next_mrl_cb,
-00596                    gui_branched_cb_t branched_cb);
-00597 
-00607 void xine_exit (xine_t *self);
-00608 
-00629 void xine_play (xine_t *self, char *MRL, int start_pos, int start_time);
-00630 
-00641 void xine_set_speed (xine_t *self, int speed);
-00642 
-00651 int xine_get_speed (xine_t *self);
-00652 
-00658 #define SPEED_PAUSE   0
-00659 
-00664 #define SPEED_SLOW_4  1
-00665 
-00670 #define SPEED_SLOW_2  2
-00671 
-00676 #define SPEED_NORMAL  4
-00677 
-00682 #define SPEED_FAST_2  8
-00683 
-00688 #define SPEED_FAST_4 16
-00689 
-00699 void xine_set_av_offset (xine_t *self, int offset_pts);
-00700 
-00709 int xine_get_av_offset (xine_t *self);
-00710 
-00719 void xine_stop (xine_t *self);
-00720 
-00729 int xine_eject(xine_t *self);
-00730 
-00739 int xine_get_status (xine_t *self);
-00740 
-00749 int xine_get_current_position (xine_t *self);
-00750 
-00759 int xine_get_current_time (xine_t *self);
-00760 
-00769 int xine_get_stream_length (xine_t *self);
-00770 
-00779 int xine_get_audio_channel (xine_t *self);
-00780 
-00789 void xine_select_audio_channel (xine_t *self, int channel);
-00790 
-00799 int xine_get_spu_channel (xine_t *self);
-00800 
-00809 void xine_select_spu_channel (xine_t *self, int channel);
-00810 
-00828 #define AO_CAP_NOCAP            0x00000000
-00829 
-00834 #define AO_CAP_MODE_A52         0x00000001
-00835 
-00840 #define AO_CAP_MODE_AC5         0x00000002
-00841 
-00847 #define AO_CAP_MODE_MONO        0x00000004
-00848 
-00854 #define AO_CAP_MODE_STEREO      0x00000008
-00855 
-00861 #define AO_CAP_MODE_4CHANNEL    0x00000010
-00862 
-00868 #define AO_CAP_MODE_5CHANNEL    0x00000020
-00869 
-00875 #define AO_CAP_MODE_5_1CHANNEL  0x00000040
-00876 
-00881 #define AO_CAP_MIXER_VOL        0x00000080
-00882 
-00887 #define AO_CAP_PCM_VOL          0x00000100
-00888 
-00893 #define AO_CAP_MUTE_VOL         0x00000200
-00894 
-00904 int xine_get_audio_capabilities(xine_t *self);
-00905 
-00918 #define AO_PROP_MIXER_VOL       0
-00919 
-00924 #define AO_PROP_PCM_VOL         1
-00925 
-00930 #define AO_PROP_MUTE_VOL        2
-00931 
-00941 int xine_get_audio_property(xine_t *self, int property);
-00953 int xine_set_audio_property(xine_t *self, int property, int value);
-00954 
-00973 char **xine_get_browsable_input_plugin_ids (xine_t *self) ;
-00974 
-00987 #define mrl_unknown        (0 << 0)
-00988 
-00993 #define mrl_dvd            (1 << 0)
-00994 
-00999 #define mrl_vcd            (1 << 1)
-01000 
-01005 #define mrl_net            (1 << 2)
-01006 
-01011 #define mrl_rtp            (1 << 3)
-01012 
-01017 #define mrl_stdin          (1 << 4)
-01018 
-01023 #define mrl_file           (1 << 5)
-01024 
-01029 #define mrl_file_fifo      (1 << 6)
-01030 
-01035 #define mrl_file_chardev   (1 << 7)
-01036 
-01041 #define mrl_file_directory (1 << 8)
-01042 
-01047 #define mrl_file_blockdev  (1 << 9)
-01048 
-01053 #define mrl_file_normal    (1 << 10)
-01054 
-01059 #define mrl_file_symlink   (1 << 11)
-01060 
-01065 #define mrl_file_sock      (1 << 12)
-01066 
-01071 #define mrl_file_exec      (1 << 13)
-01072 
-01077 #define mrl_file_backup    (1 << 14)
-01078 
-01083 #define mrl_file_hidden    (1 << 15)
-01084 
-01092 #define MRL_ZERO(m) {                                                         \
-01093   if((m)) {                                                                   \
-01094     if((m)->origin)                                                           \
-01095       free((m)->origin);                                                      \
-01096     if((m)->mrl)                                                              \
-01097       free((m)->mrl);                                                         \
-01098     if((m)->link)                                                             \
-01099       free((m)->link);                                                        \
-01100     (m)->origin = NULL;                                                       \
-01101     (m)->mrl    = NULL;                                                       \
-01102     (m)->link   = NULL;                                                       \
-01103     (m)->type   = 0;                                                          \
-01104     (m)->size   = (off_t) 0;                                                  \
-01105   }                                                                           \
-01106 }
-01107 
-01113 #define MRL_DUPLICATE(s, d) {                                                 \
-01114   assert((s) != NULL);                                                        \
-01115   assert((d) != NULL);                                                        \
-01116                                                                               \
-01117   if((s)->origin) {                                                           \
-01118     if((d)->origin) {                                                         \
-01119       (d)->origin = (char *) realloc((d)->origin, strlen((s)->origin) + 1);   \
-01120       sprintf((d)->origin, "%s", (s)->origin);                                \
-01121     }                                                                         \
-01122     else                                                                      \
-01123       (d)->origin = strdup((s)->origin);                                      \
-01124   }                                                                           \
-01125   else                                                                        \
-01126     (d)->origin = NULL;                                                       \
-01127                                                                               \
-01128   if((s)->mrl) {                                                              \
-01129     if((d)->mrl) {                                                            \
-01130       (d)->mrl = (char *) realloc((d)->mrl, strlen((s)->mrl) + 1);            \
-01131       sprintf((d)->mrl, "%s", (s)->mrl);                                      \
-01132     }                                                                         \
-01133     else                                                                      \
-01134       (d)->mrl = strdup((s)->mrl);                                            \
-01135   }                                                                           \
-01136   else                                                                        \
-01137     (d)->mrl = NULL;                                                          \
-01138                                                                               \
-01139   if((s)->link) {                                                             \
-01140     if((d)->link) {                                                           \
-01141       (d)->link = (char *) realloc((d)->link, strlen((s)->link) + 1);         \
-01142       sprintf((d)->link, "%s", (s)->link);                                    \
-01143     }                                                                         \
-01144     else                                                                      \
-01145       (d)->link = strdup((s)->link);                                          \
-01146   }                                                                           \
-01147   else                                                                        \
-01148     (d)->link = NULL;                                                         \
-01149                                                                               \
-01150   (d)->type = (s)->type;                                                      \
-01151   (d)->size = (s)->size;                                                      \
-01152 }
-01153 
-01159 #define MRLS_DUPLICATE(s, d) {                                                \
-01160   int i = 0;                                                                  \
-01161                                                                               \
-01162   assert((s) != NULL);                                                        \
-01163   assert((d) != NULL);                                                        \
-01164                                                                               \
-01165   while((s) != NULL) {                                                        \
-01166     d[i] = (mrl_t *) malloc(sizeof(mrl_t));                                   \
-01167     MRL_DUPLICATE(s[i], d[i]);                                                \
-01168     i++;                                                                      \
-01169   }                                                                           \
-01170 }
-01171 
-01177 typedef struct {
-01179   char         *origin;
-01181   char         *mrl;
-01183   char         *link;
-01185   uint32_t      type;
-01187   off_t         size;
-01188 } mrl_t;
-01189 
-01206 mrl_t **xine_get_browse_mrls (xine_t *self, char *plugin_id, char *start_mrl, int *num_mrls);
-01207 
-01223 char **xine_get_autoplay_input_plugin_ids (xine_t *self) ;
-01224 
-01235 char **xine_get_autoplay_mrls (xine_t *self, char *plugin_id, int *num_mrls);
-01236 
-01250 #define XINE_PLUGINDIR  "/usr/local/lib/xine/plugins"
-01251 
-01262 #define VISUAL_TYPE_X11   1
-01263 
-01268 #define VISUAL_TYPE_AA    2
-01269 
-01274 #define VISUAL_TYPE_FB    3
-01275 
-01280 #define VISUAL_TYPE_GTK   4
-01281 
-01291 char **xine_list_video_output_plugins (int visual_type);
-01292 
-01302 vo_driver_t *xine_load_video_output_plugin(config_values_t *config,
-01303                                            char *id, int visual_type, void *visual);
-01304 
-01310 char **xine_list_audio_output_plugins (void);
-01311 
-01319 ao_driver_t *xine_load_audio_output_plugin(config_values_t *config, char *id);
-01320 
-01329 #ifdef DOC_HIDDEN
-01330 
-01334 typedef void event_t;
-01335 #endif
-01336 
-01341 typedef void (*event_listener_t) (xine_t *xine, event_t *event, void *data);
-01342 
-01351 int xine_register_event_listener(xine_t *self, event_listener_t listener);
-01352 
-01361 int xine_remove_event_listener(xine_t *self, event_listener_t listener);
-01362 
-01371 void xine_send_event(xine_t *self, event_t *event, void *data);
-01372 
-01391 int xine_get_current_frame (xine_t *self, int *width, int *height,
-01392                             int *ratio_code, int *format,
-01393                             uint8_t **y, uint8_t **u,
-01394                             uint8_t **v);
-01395 
-01396 
-01397 
-01403 #define XINE_IMGFMT_YV12 0x32315659
-01404 
-01409 #define XINE_IMGFMT_YUY2 (('2'<<24)|('Y'<<16)|('U'<<8)|'Y')
-01410 
-01416 #define XINE_ASPECT_RATIO_SQUARE      1
-01417 
-01422 #define XINE_ASPECT_RATIO_4_3         2
-01423 
-01428 #define XINE_ASPECT_RATIO_ANAMORPHIC  3
-01429 
-01434 #define XINE_ASPECT_RATIO_211_1       4
-01435 
-01440 #define XINE_ASPECT_RATIO_DONT_TOUCH 42
-01441 
-01444 #ifdef __cplusplus
-01445 }
-01446 #endif
-01447 
-01448 #endif
-
Generated at Mon Oct 15 01:18:06 2001 for XINE, A Free Video Player Project - API reference by - -doxygen1.2.8 written by Dimitri van Heesch, - © 1997-2001
- - diff --git a/doc/xine-lib-API/html/xine_8h.html b/doc/xine-lib-API/html/xine_8h.html deleted file mode 100644 index 473340600..000000000 --- a/doc/xine-lib-API/html/xine_8h.html +++ /dev/null @@ -1,391 +0,0 @@ - - -XINE, A Free Video Player Project - API reference -xine logo - - - - -
-Main Page   Modules   Data Structures   File List   Data Fields   Globals  
-

xine.h File Reference

-

-Go to the source code of this file. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Data Structures

struct  config_values_s
struct  mrl_t
struct  vo_driver_s

Defines

#define XINE_SKINDIR   "/usr/local/share/xine/skins"
-#define XINE_BUILD_CC   "gcc version 2.95.3 20010315 (release)"
-#define XINE_BUILD_OS   "Linux 2.4.9 i686"
-#define XINE_BUILD_DATE   "Mon 15 Oct 2001 00:22:19"
-#define XINE_STOP   0
-#define XINE_PLAY   1
-#define XINE_QUIT   2
-#define XINE_MAJOR_VERSION   0
-#define XINE_MINOR_VERSION   9
-#define XINE_SUB_VERSION   2
-#define VO_CAP_HUE   0x00000010
-#define VO_CAP_SATURATION   0x00000020
-#define VO_CAP_BRIGHTNESS   0x00000040
-#define VO_CAP_CONTRAST   0x00000080
-#define VO_CAP_COLORKEY   0x00000100
-#define VO_PROP_INTERLACED   0
-#define VO_PROP_ASPECT_RATIO   1
-#define VO_PROP_HUE   2
-#define VO_PROP_SATURATION   3
-#define VO_PROP_CONTRAST   4
-#define VO_PROP_BRIGHTNESS   5
-#define VO_PROP_COLORKEY   6
-#define VO_PROP_SOFT_DEINTERLACE   7
-#define VO_NUM_PROPERTIES   8
-#define ASPECT_AUTO   0
-#define ASPECT_ANAMORPHIC   1
-#define ASPECT_FULL   2
-#define ASPECT_DVB   3
-#define ASPECT_SQUARE   4
-#define NUM_ASPECT_RATIOS   5
-#define DEMUX_DEFAULT_STRATEGY   0
-#define DEMUX_REVERT_STRATEGY   1
-#define DEMUX_CONTENT_STRATEGY   2
-#define DEMUX_EXTENSION_STRATEGY   3
-#define SPEED_PAUSE   0
-#define SPEED_SLOW_4   1
-#define SPEED_SLOW_2   2
-#define SPEED_NORMAL   4
-#define SPEED_FAST_2   8
-#define SPEED_FAST_4   16
-#define AO_CAP_NOCAP   0x00000000
-#define AO_CAP_MODE_A52   0x00000001
-#define AO_CAP_MODE_AC5   0x00000002
-#define AO_CAP_MODE_MONO   0x00000004
-#define AO_CAP_MODE_STEREO   0x00000008
-#define AO_CAP_MODE_4CHANNEL   0x00000010
-#define AO_CAP_MODE_5CHANNEL   0x00000020
-#define AO_CAP_MODE_5_1CHANNEL   0x00000040
-#define AO_CAP_MIXER_VOL   0x00000080
-#define AO_CAP_PCM_VOL   0x00000100
-#define AO_CAP_MUTE_VOL   0x00000200
-#define AO_PROP_MIXER_VOL   0
-#define AO_PROP_PCM_VOL   1
-#define AO_PROP_MUTE_VOL   2
-#define mrl_unknown   (0 << 0)
-#define mrl_dvd   (1 << 0)
-#define mrl_vcd   (1 << 1)
-#define mrl_net   (1 << 2)
-#define mrl_rtp   (1 << 3)
-#define mrl_stdin   (1 << 4)
-#define mrl_file   (1 << 5)
-#define mrl_file_fifo   (1 << 6)
-#define mrl_file_chardev   (1 << 7)
-#define mrl_file_directory   (1 << 8)
-#define mrl_file_blockdev   (1 << 9)
-#define mrl_file_normal   (1 << 10)
-#define mrl_file_symlink   (1 << 11)
-#define mrl_file_sock   (1 << 12)
-#define mrl_file_exec   (1 << 13)
-#define mrl_file_backup   (1 << 14)
-#define mrl_file_hidden   (1 << 15)
-#define MRL_ZERO(m)
-#define MRL_DUPLICATE(s, d)
-#define MRLS_DUPLICATE(s, d)
-#define XINE_PLUGINDIR   "/usr/local/lib/xine/plugins"
-#define VISUAL_TYPE_X11   1
-#define VISUAL_TYPE_AA   2
-#define VISUAL_TYPE_FB   3
-#define VISUAL_TYPE_GTK   4
-#define XINE_IMGFMT_YV12   0x32315659
-#define XINE_IMGFMT_YUY2   (('2'<<24)|('Y'<<16)|('U'<<8)|'Y')
-#define XINE_ASPECT_RATIO_SQUARE   1
-#define XINE_ASPECT_RATIO_4_3   2
-#define XINE_ASPECT_RATIO_ANAMORPHIC   3
-#define XINE_ASPECT_RATIO_211_1   4
-#define XINE_ASPECT_RATIO_DONT_TOUCH   42

Typedefs

-typedef void vo_frame_t
-typedef void vo_overlay_t
-typedef struct vo_driver_s vo_driver_t
-typedef void xine_t
-typedef void ao_driver_t
-typedef void cfg_data_t
-typedef struct config_values_s config_values_t
-typedef void (* gui_stream_end_cb_t )(int nStatus)
-typedef char* (* gui_get_next_mrl_cb_t )(void)
-typedef void (* gui_branched_cb_t )(void)
-typedef void event_t
-typedef void (* event_listener_t )(xine_t *xine, event_t *event, void *data)

Functions

-char* xine_get_str_version (void)
 return string version, like "0.5.0".

-int xine_get_major_version (void)
 return version information.

-int xine_get_minor_version (void)
 return version information.

-int xine_get_sub_version (void)
 return version information.

-int xine_check_version (int major, int minor, int sub)
 check minimal version.

-config_values_t* config_file_init (char *filename)
 Configuration file initialisation.

-xine_t* xine_init (vo_driver_t *vo, ao_driver_t *ao, config_values_t *config, gui_stream_end_cb_t stream_end_cb, gui_get_next_mrl_cb_t get_next_mrl_cb, gui_branched_cb_t branched_cb)
 Initialisation of xine.

-void xine_exit (xine_t *self)
 De-initialisation of xine.

-void xine_play (xine_t *self, char *MRL, int start_pos, int start_time)
 Start to play a stream.

-void xine_set_speed (xine_t *self, int speed)
 Set playback speed.

-int xine_get_speed (xine_t *self)
 Get the playback speed.

-void xine_set_av_offset (xine_t *self, int offset_pts)
 Set audio/video sync.

-int xine_get_av_offset (xine_t *self)
 Get audio/video sync.

-void xine_stop (xine_t *self)
 Stop playing.

-int xine_eject (xine_t *self)
 Eject media.

-int xine_get_status (xine_t *self)
 Get current xine status.

-int xine_get_current_position (xine_t *self)
 Get current position.

-int xine_get_current_time (xine_t *self)
 get current pos in seconds.

-int xine_get_stream_length (xine_t *self)
 estimate length of input stream in seconds.

-int xine_get_audio_channel (xine_t *self)
 Get current audio channel.

-void xine_select_audio_channel (xine_t *self, int channel)
 Set audio channel.

-int xine_get_spu_channel (xine_t *self)
 Get current sub-title channel.

-void xine_select_spu_channel (xine_t *self, int channel)
 Set sub-title channel.

-int xine_get_audio_capabilities (xine_t *self)
 Get audio driver capabilities.

-int xine_get_audio_property (xine_t *self, int property)
 Get audio driver property.

-int xine_set_audio_property (xine_t *self, int property, int value)
 Set audio driver property value.

-char** xine_get_browsable_input_plugin_ids (xine_t *self)
 Request list of browsable featured plugins.

-mrl_t** xine_get_browse_mrls (xine_t *self, char *plugin_id, char *start_mrl, int *num_mrls)
 Request available MRLs from plugins.

-char** xine_get_autoplay_input_plugin_ids (xine_t *self)
 Request playlist from plugin.

-char** xine_get_autoplay_mrls (xine_t *self, char *plugin_id, int *num_mrls)
 Request MRL list from plugin.

-char** xine_list_video_output_plugins (int visual_type)
 list available video output plugins.

-vo_driver_t* xine_load_video_output_plugin (config_values_t *config, char *id, int visual_type, void *visual)
 load a specific video output plugin.

-char** xine_list_audio_output_plugins (void)
 generate a list of all available audio output plugins.

-ao_driver_t* xine_load_audio_output_plugin (config_values_t *config, char *id)
 load a specific audio output plugin.

-int xine_register_event_listener (xine_t *self, event_listener_t listener)
 registers an event listener callback.

-int xine_remove_event_listener (xine_t *self, event_listener_t listener)
 Attempts to remove a registered event listener.

-void xine_send_event (xine_t *self, event_t *event, void *data)
 sends an event to all listeners.

-int xine_get_current_frame (xine_t *self, int *width, int *height, int *ratio_code, int *format, uint8_t **y, uint8_t **u, uint8_t **v)
 Snapshot function.

-

Detailed Description

- -

-

-Author:
-Guenter Bartsch <guenter@users.sourceforge.net> , Siegfried Langauf <siggi@users.sourceforge.net> , Daniel Caujolle-Bert <f1rmb@users.sourceforge.net>
-Date:
-16/09/2001 -

-

API of XINE library. 
-   Copyright (C) 2000-2001 the xine project
- 
-   This file is part of xine, a unix video player.
- 
-   xine is free software; you can redistribute it and/or modify
-   it under the terms of the GNU General Public License as published by
-   the Free Software Foundation; either version 2 of the License, or
-   (at your option) any later version.
- 
-   xine 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 General Public License for more details.
- 
-   You should have received a copy of the GNU General Public License
-   along with this program; if not, write to the Free Software
-   Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA
- 
-
-

-

Define Documentation

-

- - - - -
- - -
-#define XINE_SKINDIR   "/usr/local/share/xine/skins" -
-
- - - - - -
-   - - -

-Skin file location

-

Generated at Mon Oct 15 01:18:06 2001 for XINE, A Free Video Player Project - API reference by - -doxygen1.2.8 written by Dimitri van Heesch, - © 1997-2001
- - diff --git a/doc/xine-lib-API/html/xine_logo.png b/doc/xine-lib-API/html/xine_logo.png deleted file mode 100644 index 3aad01fc9..000000000 Binary files a/doc/xine-lib-API/html/xine_logo.png and /dev/null differ -- cgit v1.2.3