/**
* @file libvlc.cs
- * @brief libvlc-control CIL bindings
+ * @brief Unmanaged LibVLC APIs
+ * @ingroup Internals
*
- * $Id$
+ * @defgroup Internals LibVLC internals
+ * This covers internal marshalling functions to use the native LibVLC.
+ * Only VLC developpers should need to read this section.
*/
/**********************************************************************
- * Copyright (C) 2007 Rémi Denis-Courmont. *
+ * Copyright (C) 2007-2009 Rémi Denis-Courmont. *
* This program is free software; you can redistribute and/or modify *
* it under the terms of the GNU General Public License as published *
* by the Free Software Foundation; version 2 of the license, or (at *
**********************************************************************/
using System;
-using System.Collections.Generic;
using System.Runtime.InteropServices;
namespace VideoLAN.LibVLC
{
/**
- * The VLC class is used to create LibVLC Instance objects.
- * The VLC class has only one static method and cannot be instanciated.
- *
- * @code
- * string[] argv = new string[]{ "-vvv", "-I", "dummy" };
- *
- * Instance vlc = VLC.CreateInstance (argv);
- * @endcode
+ * @brief Native: unmanaged LibVLC APIs
+ * @ingroup Internals
*/
- public sealed class VLC
+ internal static class LibVLC
{
- /**
- * Loads native LibVLC and creates a LibVLC instance.
- *
- * @param args VLC command line parameters for the LibVLC Instance.
- *
- * @return a new LibVLC Instance
- */
- public static Instance CreateInstance (string[] args)
- {
- U8String[] argv = new U8String[args.Length];
- for (int i = 0; i < args.Length; i++)
- argv[i] = new U8String (args[i]);
-
- NativeException ex = new NativeException ();
-
- InstanceHandle h = InstanceHandle.Create (argv.Length, argv, ex);
- ex.Raise ();
-
- return new Instance (h);
- }
- };
+ /* Where is the run-time?
+ * On ELF platforms, "libvlc.so.2" should be used instead. */
+ const string lib = "libvlc.dll";
- /**
- * Safe handle for unmanaged LibVLC instance pointer.
- */
- public sealed class InstanceHandle : NonNullHandle
- {
- private InstanceHandle ()
- {
- }
+ /* exception.c */
+ [DllImport (lib, EntryPoint="libvlc_exception_init")]
+ public static extern void ExceptionInit (NativeException e);
+
+ [DllImport (lib, EntryPoint="libvlc_exception_clear")]
+ public static extern void ExceptionClear (NativeException e);
+
+ /* core.c */
+ [DllImport (lib, EntryPoint="libvlc_get_version")]
+ public static extern IntPtr GetVersion ();
+
+ [DllImport (lib, EntryPoint="libvlc_get_compiler")]
+ public static extern IntPtr GetCompiler ();
+
+ [DllImport (lib, EntryPoint="libvlc_get_changeset")]
+ public static extern IntPtr GetChangeset ();
+
+ [DllImport (LibVLC.lib, EntryPoint="libvlc_free")]
+ public static extern void Free (IntPtr ptr);
- [DllImport ("libvlc-control.dll", EntryPoint="libvlc_new")]
- internal static extern
+ [DllImport (lib, EntryPoint="libvlc_new")]
+ public static extern
InstanceHandle Create (int argc, U8String[] argv, NativeException ex);
- [DllImport ("libvlc-control.dll", EntryPoint="libvlc_release")]
- static extern void Destroy (IntPtr ptr, NativeException ex);
-
- /**
- * System.Runtime.InteropServices.SafeHandle::ReleaseHandle.
- */
- protected override bool ReleaseHandle ()
- {
- Destroy (handle, null);
- return true;
- }
- };
+ /*[DllImport (lib, EntryPoint="libvlc_retain")]
+ public static extern
+ void Retain (InstanceHandle h, NativeException ex);*/
- /**
- * LibVLC Instance provides basic media player features from VLC,
- * such as play/pause/stop and flat playlist management.
- */
- public class Instance : BaseObject<InstanceHandle>
- {
- Dictionary<int, PlaylistItem> items;
-
- internal Instance (InstanceHandle self) : base (self)
- {
- items = new Dictionary<int, PlaylistItem> ();
- }
-
- /**
- * Creates a MediaDescriptor.
- * @param mrl Media Resource Locator (file path or URL)
- * @return create MediaDescriptor object.
- */
- public MediaDescriptor CreateDescriptor (string mrl)
- {
- U8String umrl = new U8String (mrl);
- DescriptorHandle dh = DescriptorHandle.Create (self, umrl, ex);
- ex.Raise ();
-
- return new MediaDescriptor (dh);
- }
-
- [DllImport ("libvlc-control.dll", EntryPoint="libvlc_playlist_loop")]
- static extern void PlaylistLoop (InstanceHandle self, bool b,
- NativeException ex);
- /** Sets the playlist loop flag. */
- public bool Loop
- {
- set
- {
- PlaylistLoop (self, value, ex);
- ex.Raise ();
- }
- }
-
- [DllImport ("libvlc-control.dll", EntryPoint="libvlc_playlist_play")]
- static extern void PlaylistPlay (InstanceHandle self, int id, int optc,
- U8String[] optv, NativeException ex);
- /** Plays the next playlist item (if not already playing). */
- public void Play ()
- {
- PlaylistPlay (self, -1, 0, new U8String[0], ex);
- ex.Raise ();
- }
-
- [DllImport ("libvlc-control.dll", EntryPoint="libvlc_playlist_pause")]
- static extern void PlaylistPause (InstanceHandle self,
- NativeException ex);
- /** Toggles pause (starts playing if stopped, pauses if playing). */
- public void TogglePause ()
- {
- PlaylistPause (self, ex);
- ex.Raise ();
- }
-
- [DllImport ("libvlc-control.dll",
- EntryPoint="libvlc_playlist_isplaying")]
- static extern int PlaylistIsPlaying (InstanceHandle self,
- NativeException ex);
- /** Whether the playlist is running, or paused/stopped. */
- public bool IsPlaying
- {
- get
- {
- int ret = PlaylistIsPlaying (self, ex);
- ex.Raise ();
- return ret != 0;
- }
- }
-
- [DllImport ("libvlc-control.dll", EntryPoint="libvlc_playlist_stop")]
- static extern void PlaylistStop (InstanceHandle self,
- NativeException ex);
- /** Stops playing. */
- public void Stop ()
- {
- PlaylistStop (self, ex);
- ex.Raise ();
- }
-
- [DllImport ("libvlc-control.dll", EntryPoint="libvlc_playlist_next")]
- static extern void PlaylistNext (InstanceHandle self,
- NativeException ex);
- /** Switches to next playlist item, and starts playing it. */
- public void Next ()
- {
- PlaylistNext (self, ex);
- ex.Raise ();
- }
-
- [DllImport ("libvlc-control.dll", EntryPoint="libvlc_playlist_prev")]
- static extern void PlaylistPrev (InstanceHandle self,
- NativeException ex);
- /** Switches to previous playlist item, and starts playing it. */
- public void Prev ()
- {
- PlaylistPrev (self, ex);
- ex.Raise ();
- }
-
- [DllImport ("libvlc-control.dll", EntryPoint="libvlc_playlist_clear")]
- static extern void PlaylistClear (InstanceHandle self,
- NativeException ex);
- /** Clears the whole playlist. */
- public void Clear ()
- {
- PlaylistClear (self, ex);
- ex.Raise ();
-
- foreach (PlaylistItem item in items.Values)
- item.Close ();
- items.Clear ();
- }
-
- [DllImport ("libvlc-control.dll",
- EntryPoint="libvlc_playlist_add_extended")]
- static extern int PlaylistAdd (InstanceHandle self, U8String uri,
- U8String name, int optc,
- U8String[] optv, NativeException e);
- /**
- * Appends an item to the playlist, with options.
- * @param mrl Media Resource Locator (file name or URL)
- * @param name playlist item user-visible name
- * @param opts item options (see LibVLC documentation for details)
- * @return created playlist item.
- */
- public PlaylistItem Add (string mrl, string name, string[] opts)
- {
- U8String umrl = new U8String (mrl);
- U8String uname = new U8String (name);
- U8String[] optv = new U8String[opts.Length];
- for (int i = 0; i < opts.Length; i++)
- optv[i] = new U8String (opts[i]);
-
- int id = PlaylistAdd (self, umrl, uname, optv.Length, optv, ex);
- ex.Raise ();
-
- PlaylistItem item = new PlaylistItem (id);
- items.Add (id, item);
- return item;
- }
- /**
- * Appends an item with options.
- * @param mrl Media Resource Locator (file name or URL)
- * @param opts item options (see LibVLC documentation for details)
- * @return created playlist item.
- */
- public PlaylistItem Add (string mrl, string[] opts)
- {
- return Add (mrl, null, opts);
- }
- /**
- * Appends an item to the playlist.
- * @param mrl Media Resource Locator (file name or URL)
- * @param name playlist item user-visible name
- * @return created playlist item.
- */
- public PlaylistItem Add (string mrl, string name)
- {
- return Add (mrl, name, new string[0]);
- }
- /**
- * Appends an item to the playlist.
- * @param mrl Media Resource Locator (file name or URL)
- * @return created playlist item.
- */
- public PlaylistItem Add (string mrl)
- {
- return Add (mrl, null, new string[0]);
- }
-
- [DllImport ("libvlc-control.dll",
- EntryPoint="libvlc_playlist_delete_item")]
- static extern int PlaylistDelete (InstanceHandle self, int id,
- NativeException e);
- /**
- * Removes an item from the playlist.
- * @param item playlist item (as obtained from Add())
- */
- public void Delete (PlaylistItem item)
- {
- int id = item.Id;
- PlaylistDelete (self, id, ex);
- ex.Raise ();
-
- item.Close ();
- items.Remove (id);
- }
- };
+ [DllImport (lib, EntryPoint="libvlc_release")]
+ public static extern
+ void Release (IntPtr h, NativeException ex);
- /**
- * A playlist item.
- */
- public class PlaylistItem
- {
- int id;
- bool deleted;
-
- internal PlaylistItem (int id)
- {
- this.id = id;
- this.deleted = false;
- }
-
- internal void Close ()
- {
- deleted = true;
- }
-
- internal int Id
- {
- get
- {
- if (deleted)
- throw new ObjectDisposedException ("Playlist item deleted");
- return id;
- }
- }
- };
+ [DllImport (lib, EntryPoint="libvlc_add_intf")]
+ public static extern
+ void AddIntf (InstanceHandle h, U8String name, NativeException ex);
- /** Safe handle for unmanaged LibVLC media descriptor */
- public sealed class DescriptorHandle : NonNullHandle
- {
- private DescriptorHandle ()
- {
- }
+ [DllImport (lib, EntryPoint="libvlc_wait")]
+ public static extern
+ void Wait (InstanceHandle h);
+
+ [DllImport (lib, EntryPoint="libvlc_get_vlc_instance")]
+ public static extern
+ IntPtr GetVLCInstance (InstanceHandle h);
- [DllImport ("libvlc-control.dll",
- EntryPoint="libvlc_media_new")]
+ /* media.c */
+ [DllImport (lib, EntryPoint="libvlc_media_new")]
public static extern
- DescriptorHandle Create (InstanceHandle inst, U8String mrl,
+ MediaHandle MediaCreate (InstanceHandle inst, U8String mrl,
NativeException ex);
- [DllImport ("libvlc-control.dll",
- EntryPoint="libvlc_media_release")]
- public static extern void Release (IntPtr ptr);
+ [DllImport (lib, EntryPoint="libvlc_media_new_as_node")]
+ public static extern
+ MediaHandle MediaCreateAsNode (InstanceHandle inst, U8String name,
+ NativeException ex);
- protected override bool ReleaseHandle ()
- {
- Release (handle);
- return true;
- }
- };
+ [DllImport (lib, EntryPoint="libvlc_media_add_option")]
+ public static extern
+ void MediaAddOption (MediaHandle media, U8String options,
+ NativeException ex);
- /**
- * Media descriptor. Not implemented yet.
- */
- public class MediaDescriptor : BaseObject<DescriptorHandle>
- {
- internal MediaDescriptor (DescriptorHandle self) : base (self)
- {
- }
+ [DllImport (lib,
+ EntryPoint="libvlc_media_add_option_untrusted")]
+ public static extern
+ void MediaAddUntrustedOption (MediaHandle media, U8String options,
+ NativeException ex);
+
+ [DllImport (lib, EntryPoint="libvlc_media_release")]
+ public static extern
+ void MediaRelease (IntPtr ptr);
+
+ [DllImport (lib, EntryPoint="libvlc_media_get_mrl")]
+ public static extern
+ StringHandle MediaGetMRL (MediaHandle media, NativeException ex);
+
+ [DllImport (lib, EntryPoint="libvlc_media_duplicate")]
+ public static extern
+ MediaHandle MediaDuplicate (MediaHandle media);
+
+ [DllImport (lib, EntryPoint="libvlc_media_get_meta")]
+ public static extern
+ StringHandle MediaGetMeta (MediaHandle media, MetaType type,
+ NativeException ex);
+
+ [DllImport (lib, EntryPoint="libvlc_media_get_state")]
+ public static extern
+ State MediaGetState (MediaHandle media, NativeException ex);
+
+ /*[DllImport (lib, EntryPoint="libvlc_media_subitems")]
+ public static extern
+ MediaListHandle MediaSubItems (MediaHandle media, NativeException ex);*/
+
+ [DllImport (lib, EntryPoint="libvlc_media_event_manager")]
+ public static extern
+ EventManagerHandle MediaEventManager (MediaHandle media,
+ NativeException ex);
+
+ [DllImport (lib, EntryPoint="libvlc_media_get_duration")]
+ public static extern
+ long MediaGetDuration (MediaHandle media, NativeException ex);
+
+ [DllImport (lib, EntryPoint="libvlc_media_is_preparsed")]
+ public static extern
+ int MediaIsPreparsed (MediaHandle media, NativeException ex);
+
+ /*[DllImport (lib, EntryPoint="libvlc_media_set_user_data")]
+ public static extern
+ void MediaIsPreparsed (MediaHandle media, IntPtr data,
+ NativeException ex);*/
+
+ /*[DllImport (lib, EntryPoint="libvlc_media_get_user_data")]
+ public static extern
+ IntPtr MediaIsPreparsed (MediaHandle media, NativeException ex);*/
+
+ /* media_player.c */
+ [DllImport (lib, EntryPoint="libvlc_media_player_new")]
+ public static extern
+ PlayerHandle PlayerCreate (InstanceHandle inst, NativeException ex);
+
+ [DllImport (lib,
+ EntryPoint="libvlc_media_player_new_from_media")]
+ public static extern
+ PlayerHandle PlayerCreateFromMedia (MediaHandle media,
+ NativeException ex);
+
+ [DllImport (lib, EntryPoint="libvlc_media_player_release")]
+ public static extern
+ void PlayerRelease (IntPtr ptr);
+
+ /* PlayerRetain */
+
+ [DllImport (lib,
+ EntryPoint="libvlc_media_player_set_media")]
+ public static extern
+ void PlayerSetMedia (PlayerHandle player, MediaHandle media,
+ NativeException ex);
+
+ /*[DllImport (lib,
+ EntryPoint="libvlc_media_player_get_media")]
+ public static extern
+ MediaHandle PlayerGetMedia (PlayerHandle player,
+ NativeException ex);*/
+
+ [DllImport (lib,
+ EntryPoint="libvlc_media_player_event_manager")]
+ public static extern
+ EventManagerHandle PlayerEventManager (PlayerHandle media,
+ NativeException ex);
+
+ [DllImport (lib,
+ EntryPoint="libvlc_media_player_is_playing")]
+ public static extern
+ int PlayerIsPlaying (PlayerHandle player, NativeException ex);
+
+ [DllImport (lib,
+ EntryPoint="libvlc_media_player_play")]
+ public static extern
+ void PlayerPlay (PlayerHandle player, NativeException ex);
+
+ [DllImport (lib,
+ EntryPoint="libvlc_media_player_pause")]
+ public static extern
+ void PlayerPause (PlayerHandle player, NativeException ex);
+
+ [DllImport (lib,
+ EntryPoint="libvlc_media_player_stop")]
+ public static extern
+ void PlayerStop (PlayerHandle player, NativeException ex);
+
+ [DllImport (lib,
+ EntryPoint="libvlc_media_player_set_xwindow")]
+ public static extern
+ void PlayerSetXWindow (PlayerHandle player, int xid,
+ NativeException ex);
+
+ [DllImport (lib,
+ EntryPoint="libvlc_media_player_get_xwindow")]
+ public static extern
+ int PlayerGetXWindow (PlayerHandle player);
+
+ [DllImport (lib,
+ EntryPoint="libvlc_media_player_set_hwnd")]
+ public static extern
+ void PlayerSetHWND (PlayerHandle player, SafeHandle hwnd,
+ NativeException ex);
+
+ [DllImport (lib,
+ EntryPoint="libvlc_media_player_get_hwnd")]
+ public static extern
+ SafeHandle PlayerGetHWND (PlayerHandle player);
+
+ [DllImport (lib,
+ EntryPoint="libvlc_media_player_get_length")]
+ public static extern
+ long PlayerGetLength (PlayerHandle player, NativeException ex);
+
+ [DllImport (lib, EntryPoint="libvlc_media_player_get_time")]
+ public static extern
+ long PlayerGetTime (PlayerHandle player, NativeException ex);
+
+ [DllImport (lib, EntryPoint="libvlc_media_player_set_time")]
+ public static extern
+ void PlayerSetTime (PlayerHandle player, long time,
+ NativeException ex);
+
+ [DllImport (lib,
+ EntryPoint="libvlc_media_player_get_position")]
+ public static extern
+ float PlayerGetPosition (PlayerHandle player, NativeException ex);
+
+ [DllImport (lib,
+ EntryPoint="libvlc_media_player_set_position")]
+ public static extern
+ void PlayerSetPosition (PlayerHandle player, float position,
+ NativeException ex);
+
+ [DllImport (lib,
+ EntryPoint="libvlc_media_player_get_chapter")]
+ public static extern
+ int PlayerGetChapter (PlayerHandle player, NativeException ex);
+
+ [DllImport (lib,
+ EntryPoint="libvlc_media_player_set_chapter")]
+ public static extern
+ void PlayerSetChapter (PlayerHandle player, int chapter,
+ NativeException ex);
+
+ [DllImport (lib,
+ EntryPoint="libvlc_media_player_get_chapter_count")]
+ public static extern
+ int PlayerGetChapterCount (PlayerHandle player, NativeException ex);
+
+ /* PlayerWillPlay */
+
+ [DllImport (lib,
+ EntryPoint="libvlc_media_player_get_chapter_count_for_title")]
+ public static extern
+ int PlayerGetChapterCountForTitle (PlayerHandle player, int title,
+ NativeException ex);
+
+ [DllImport (lib,
+ EntryPoint="libvlc_media_player_get_title")]
+ public static extern
+ int PlayerGetTitle (PlayerHandle player, NativeException ex);
+
+ [DllImport (lib,
+ EntryPoint="libvlc_media_player_set_title")]
+ public static extern
+ void PlayerSetTitle (PlayerHandle player, int chapter,
+ NativeException ex);
+
+ [DllImport (lib,
+ EntryPoint="libvlc_media_player_get_title_count")]
+ public static extern
+ int PlayerGetTitleCount (PlayerHandle player, NativeException ex);
+
+ [DllImport (lib,
+ EntryPoint="libvlc_media_player_next_chapter")]
+ public static extern
+ void PlayerNextChapter (PlayerHandle player, NativeException ex);
+
+ [DllImport (lib,
+ EntryPoint="libvlc_media_player_previous_chapter")]
+ public static extern
+ void PlayerPreviousChapter (PlayerHandle player, NativeException ex);
+
+ [DllImport (lib,
+ EntryPoint="libvlc_media_player_get_rate")]
+ public static extern
+ float PlayerGetRate (PlayerHandle player, NativeException ex);
+
+ [DllImport (lib,
+ EntryPoint="libvlc_media_player_set_rate")]
+ public static extern
+ void PlayerSetRate (PlayerHandle player, float rate,
+ NativeException ex);
+
+ [DllImport (lib,
+ EntryPoint="libvlc_media_player_get_state")]
+ public static extern
+ State PlayerGetState (PlayerHandle player, NativeException ex);
+
+ [DllImport (lib,
+ EntryPoint="libvlc_media_player_get_fps")]
+ public static extern
+ float PlayerGetFPS (PlayerHandle player, NativeException ex);
+
+ [DllImport (lib,
+ EntryPoint="libvlc_media_player_has_vout")]
+ public static extern
+ int PlayerHasVout (PlayerHandle player, NativeException ex);
+
+ [DllImport (lib,
+ EntryPoint="libvlc_media_player_is_seekable")]
+ public static extern
+ int PlayerIsSeekable (PlayerHandle player, NativeException ex);
+
+ [DllImport (lib,
+ EntryPoint="libvlc_media_player_can_pause")]
+ public static extern
+ int PlayerCanPause (PlayerHandle player, NativeException ex);
+
+
+ /* TODO: video, audio */
+
+ /* event.c */
+ [DllImport (lib, EntryPoint="libvlc_event_attach")]
+ public static extern
+ void EventAttach (EventManagerHandle manager, EventType type,
+ IntPtr callback, IntPtr user_data,
+ NativeException ex);
+
+ [DllImport (lib, EntryPoint="libvlc_event_detach")]
+ public static extern
+ void EventDetach (EventManagerHandle manager, EventType type,
+ IntPtr callback, IntPtr user_data,
+ NativeException ex);
+
+ /* libvlc_event_type_name */
};
};
projects / vlc / blobdiff