CORBA module update:

- the VLC-specific code has been isolated in mediacontrol-core.c so that
  corba.c only has to glue CORBA calls to C calls.
- the IDL has been modified:
  - snapshot support
  - text display support
  - access to stream information
  - access to volume information

modules/control/corba/MediaControl.idl

-/* Cf
-   http://www.cs.rpi.edu/~musser/dsc/idl/idl-overview.html
-   pour une intro à la syntaxe */
-
+/*
+  Module inspired by the MediaControl IDL
+ */
 module VLC {
-   enum PositionOrigin {
-   	AbsolutePosition, RelativePosition, ModuloPosition
-   };
-   
-   enum PositionKey {
-   	ByteCount, SampleCount, MediaTime
-   };
-   
-   struct Position {
-   	PositionOrigin origin;
-   	PositionKey key;
-   	long value;
-   };
-   
-   exception PositionKeyNotSupported { PositionKey key;};
-   exception InvalidPosition { PositionKey key;};
 
-  typedef sequence<string> PlaylistSeq; 
+  const float VERSION = 0.1;
+
+  enum PositionOrigin {
+    AbsolutePosition, RelativePosition, ModuloPosition
+  };
+  
+  enum PositionKey {
+    ByteCount, SampleCount, MediaTime
+  };
+  
+  struct Position {
+    PositionOrigin origin;
+    PositionKey key;
+    long long value;
+  };
+  
+  exception PositionKeyNotSupported { string message; };
+  exception PositionOriginNotSupported { string message; };
+  exception InvalidPosition         { string message; };
+  exception PlaylistException       { string message; };
+  exception InternalException       { string message; };
 
+  typedef sequence<string> PlaylistSeq; 
+  typedef sequence<octet> ByteSeq;
+  
+  struct RGBPicture {
+    short width;
+    short height;
+    long type;
+    ByteSeq data;
+    long long date;
+  };
+  
+  typedef sequence<RGBPicture> RGBPictureSeq;
+  
+  /* Cf stream_control.h */
+  enum PlayerStatus { PlayingStatus, PauseStatus, ForwardStatus, BackwardStatus, InitStatus, EndStatus, UndefinedStatus };
+  
+  struct StreamInformation {
+    PlayerStatus streamstatus;
+    string url;        /* The URL of the current media stream */
+    long long position;     /* actual location in the stream (in ms) */
+    long long length;         /* total length of the stream (in ms) */
+  };
+  
    // MediaControl interface is similar to
    // ControlledStream interface in MSS.
    // It can be inherited by flow endpoints or
    // FlowConnection interfaces.
   interface MediaControl
   {
-    
-    exception PositionKeyNotSupported { PositionKey key;};
-    
-    Position get_media_position(
-				in PositionOrigin an_origin,
+    Position get_media_position(in PositionOrigin an_origin,
 				in PositionKey a_key)
-      raises (PositionKeyNotSupported);
+      raises (InternalException, PositionKeyNotSupported);
     
     void set_media_position(in Position a_position)
-      raises (PositionKeyNotSupported, InvalidPosition);
+      raises (InternalException, PositionKeyNotSupported, InvalidPosition);
      
     void start(in Position a_position)
-      raises(InvalidPosition);
+      raises (InternalException, InvalidPosition, PlaylistException);
     void pause(in Position a_position)
-      raises(InvalidPosition);
+      raises (InternalException, InvalidPosition);
     void resume(in Position a_position)
-      raises(InvalidPosition);
+      raises (InternalException, InvalidPosition);
     void stop(in Position a_position)
-      raises(InvalidPosition);
-    void exit (); // Exits the player (not in the original spec)
-    void add_to_playlist (in string a_file);
+      raises (InternalException, InvalidPosition);
+
+    oneway void exit (); // Exits the player (not in the original spec)
+
+    void playlist_add_item (in string a_file)
+      raises (PlaylistException);
+    void playlist_clear ()
+      raises (PlaylistException);
     // Returns the list of files in playlist
-    PlaylistSeq get_playlist ();
+    PlaylistSeq playlist_get_list ()
+      raises (PlaylistException);
+
+    // Returns a snapshot of the currently displayed picture
+    RGBPicture snapshot (in Position a_position)
+      raises (InternalException);
+
+    RGBPictureSeq all_snapshots ()
+      raises (InternalException);
+
+    // Displays the message string, between "begin" and "end" positions
+    void display_text (in string message, in Position begin, in Position end)
+      raises (InternalException);
+
+    StreamInformation get_stream_information ()
+      raises (InternalException);
+    
+    unsigned short sound_get_volume()
+      raises (InternalException);
+
+    void sound_set_volume(in unsigned short volume)
+      raises (InternalException);
+
   };
 };

modules/control/corba/Modules.am

 ## corba module declaration
 
-SOURCES_corba = corba.c
+SOURCES_corba = corba.c mediacontrol-core.c mediacontrol-plugin.c
+
+EXTRA_DIST = MediaControl.so
 
 nodist_SOURCES_corba = \
-	mediacontrol-common.c \
-	mediacontrol-skels.c \
-	mediacontrol.h \
+	MediaControl-common.c \
+	MediaControl-skels.c \
+	MediaControl.h \
 	$(NULL)
 
 ORBITIDL = orbit-idl-2
 
-mediacontrol-common.c mediacontrol-skels.c mediacontrol-stubs.c mediacontrol.h:
-	$(ORBITIDL) --skeleton-impl mediacontrol.idl
+GENERATEDFILES=MediaControl-common.c MediaControl-skels.c MediaControl.h  MediaControl-imodule.c
+
+corba.c: MediaControl.h MediaControl-common.c
+
+$(GENERATEDFILES): MediaControl.idl
+	$(ORBITIDL) --skeleton-impl MediaControl.idl
 
-mediacontrol-imodule.c:
-	$(ORBITIDL) --imodule mediacontrol.idl
+MediaControl-imodule.c:
+	$(ORBITIDL) --imodule MediaControl.idl
 
-mediacontrol.so: mediacontrol-imodule.c
-	gcc -fPIC -o mediacontrol-imodule.o -c mediacontrol-imodule.c `pkg-config --cflags ORBit-2.0`
-	gcc -shared -o $@ mediacontrol-imodule.o `pkg-config --libs ORBit-2.0`
+MediaControl.so: MediaControl-imodule.c
+	$(CC) -fPIC -o MediaControl-imodule.o -c MediaControl-imodule.c `pkg-config --cflags ORBit-2.0`
+	$(CC) -shared -o $@ MediaControl-imodule.o `pkg-config --libs ORBit-2.0`
 
 clean:
-	rm -f mediacontrol-stubs.c mediacontrol-imodule.c mediacontrol-skelimpl.c
+	$(RM) -f $(GENERATEDFILES)
 

modules/control/corba/README

-$Id: README,v 1.2 2004/01/25 16:17:03 anil Exp $
-* Module (server) side
+* Corba module (server) side
+
 ** Dependencies
 
-To compile the CORBA module, you need the orbit2 developpement files
-(for Debian, install the package liborbi2-dev)
+To compile the CORBA plugin, you need the orbit2 developpement files
+(for Debian, install the package liborbit2-dev)
 
 ** How to run it ?
 
@@ -13,24 +13,27 @@ vlc --intf corba
 
 The CORBA module is initialized and saves its IOR into the file
 /tmp/vlc-ior.ref
+(it will soon move to $HOME/.vlc-ior.ref)
+
+** Code architecture
+
+The binding between VLC and the MediaControl API (at C-level) is done
+through the mediacontrol-core.c file. This file implements an
+object-oriented layer API accessible in C. 
 
+The corba.c itself only translates calls from CORBA to this C API,
+which makes the code clearer overall. Moreover, the same
+mediacontrol-core.c file is used by the vlc-python module to implement the
+same API.
 
 * Client side
 
-A sample client application is provided, using python-orbit
+A sample client code can be found at http://liris.cnrs.fr/advene/
 
 **  Dependencies
 
 The python client uses the pyorbit library developped by James
-Henstridge <james at daa dot com dot au> (source:
-http://ftp.gnome.org/pub/GNOME/sources/pyorbit/1.99/pyorbit-1.99.3.tar.gz).
-
-To interoperate with gtk, the original pyorbit-1.99.3 needs a patch to
-implement the bindings to OR_work_pending and ORB_perform_work (see
-pyorbit-1.99.3.patch)
-
-The gtk simpleplayer example uses the python-glade module by James
-Henstridge.
+Henstridge <james@daa.com.au> 
 
 ** Typelib information
 
@@ -40,12 +43,6 @@ use the structures defined in the IDL (Position, Origin, ...), you
 need to use the IDL information, and compile a dynamic lib
 (MediaControl.so) from the IDL.
 
-To build the library, you can use the Makefile :
-
-make corba-generate-typelib
-
-which will generate MediaControl.so
-
 * Interesting pointers 
 
 - GLib reference manual
@@ -54,11 +51,3 @@ http://developer.gnome.org/doc/API/glib/
 - IDL quickref :
 http://www.cs.rpi.edu/~musser/dsc/idl/idl-overview.html
 
-- Python-Bonobo
-http://www.pycage.de/howto_bonobo.html
-
-* How to add the module to the original sources (vlc-0.5.x) :
-- copy the directory modules/control/corba
-- add configuration lines relative to corba in configure.ac.in
-- add a reference to  control/corba/Modules.am in
-  modules/Makefile.am

modules/control/corba/mediacontrol-core.h

+#ifndef __mediacontrol_core_h
+
+#define __mediacontrol_core_h
+
+#ifndef __VLC__
+#define __VLC__
+#endif
+#include <vlc/vlc.h>
+
+/************************************************************************
+ * Position Object Manipulation
+ *************************************************************************/
+typedef enum  {
+  mediacontrol_AbsolutePosition,
+  mediacontrol_RelativePosition,
+  mediacontrol_ModuloPosition
+} mediacontrol_PositionOrigin;
+
+typedef enum {
+  mediacontrol_ByteCount,
+  mediacontrol_SampleCount,
+  mediacontrol_MediaTime
+} mediacontrol_PositionKey;
+
+typedef struct {
+  mediacontrol_PositionOrigin origin;
+  mediacontrol_PositionKey key;
+  long value;
+} mediacontrol_Position;
+
+typedef struct {
+  int  width;
+  int  height;
+  long type;
+  long long date;
+  int  size;
+  char* data;
+} mediacontrol_RGBPicture;
+
+typedef struct {
+  int size;
+  char** data;
+} mediacontrol_PlaylistSeq;
+
+typedef struct {
+  int code;
+  char* message;
+} mediacontrol_Exception;
+
+/* Exception codes */
+#define mediacontrol_PositionKeyNotSupported    1
+#define mediacontrol_PositionOriginNotSupported 2
+#define mediacontrol_InvalidPosition            3
+#define mediacontrol_PlaylistException          4
+#define mediacontrol_InternalException          5
+
+typedef struct {
+  vlc_object_t  *p_vlc;
+  playlist_t    *p_playlist;
+  intf_thread_t *p_intf;
+  int           vlc_object_id;
+} mediacontrol_Instance;
+
+/* Cf stream_control.h */
+enum mediacontrol_PlayerStatusList
+  { 
+    mediacontrol_PlayingStatus, mediacontrol_PauseStatus, 
+    mediacontrol_ForwardStatus, mediacontrol_BackwardStatus, 
+    mediacontrol_InitStatus,    mediacontrol_EndStatus, 
+    mediacontrol_UndefinedStatus 
+  };
+typedef enum mediacontrol_PlayerStatusList mediacontrol_PlayerStatus;
+
+typedef struct {
+    mediacontrol_PlayerStatus streamstatus;
+    char* url;         /* The URL of the current media stream */
+    long long position;     /* actual location in the stream (in ms) */
+    long long length;         /* total length of the stream (in ms) */
+  } mediacontrol_StreamInformation;
+
+/* Helper functions */
+long long mediacontrol_unit_convert (input_thread_t *p_input,
+				     mediacontrol_PositionKey from,
+				     mediacontrol_PositionKey to,
+				     long long value);
+long long
+mediacontrol_position2microsecond (input_thread_t* p_input, const mediacontrol_Position * pos);
+
+mediacontrol_RGBPicture* mediacontrol_RGBPicture__alloc (int datasize);
+void mediacontrol_RGBPicture__free (mediacontrol_RGBPicture* pic);
+mediacontrol_PlaylistSeq* mediacontrol_PlaylistSeq__alloc (int size);
+void mediacontrol_PlaylistSeq__free (mediacontrol_PlaylistSeq* ps);
+
+mediacontrol_Exception* mediacontrol_exception_init(mediacontrol_Exception *exception);
+void mediacontrol_exception_free(mediacontrol_Exception *exception);
+
+mediacontrol_Instance* mediacontrol_new(char** args, mediacontrol_Exception *exception);
+mediacontrol_Instance* mediacontrol_new_from_object(vlc_object_t* p_object,
+						    mediacontrol_Exception *exception);
+mediacontrol_Position* mediacontrol_get_media_position(mediacontrol_Instance *self,
+						       mediacontrol_PositionOrigin an_origin,
+						       mediacontrol_PositionKey a_key,
+						       mediacontrol_Exception *exception);
+void mediacontrol_set_media_position(mediacontrol_Instance *self,
+				     const mediacontrol_Position* a_position, 
+				     mediacontrol_Exception *exception);
+void mediacontrol_start(mediacontrol_Instance *self,
+			const mediacontrol_Position* a_position, 
+			mediacontrol_Exception *exception);
+void mediacontrol_pause(mediacontrol_Instance *self,
+			const mediacontrol_Position* a_position, 
+			mediacontrol_Exception *exception);
+void mediacontrol_resume(mediacontrol_Instance *self,
+			 const mediacontrol_Position* a_position,
+			 mediacontrol_Exception *exception);
+void mediacontrol_stop(mediacontrol_Instance *self,
+		       const mediacontrol_Position* a_position,
+		       mediacontrol_Exception *exception);
+void mediacontrol_exit(mediacontrol_Instance *self);
+
+void mediacontrol_playlist_add_item (mediacontrol_Instance *self,
+				     const char* psz_file,
+				     mediacontrol_Exception *exception);
+void mediacontrol_playlist_clear (mediacontrol_Instance *self,
+				  mediacontrol_Exception *exception);
+mediacontrol_PlaylistSeq* mediacontrol_playlist_get_list (mediacontrol_Instance *self,
+							  mediacontrol_Exception *exception);
+
+mediacontrol_RGBPicture* mediacontrol_snapshot (mediacontrol_Instance *self,
+						const mediacontrol_Position* a_position,
+						mediacontrol_Exception *exception);
+/* Return a NULL terminated list */
+mediacontrol_RGBPicture** mediacontrol_all_snapshots (mediacontrol_Instance *self,
+						      mediacontrol_Exception *exception);
+
+// Displays the message string, between "begin" and "end" positions
+void mediacontrol_display_text (mediacontrol_Instance *self,
+				const char* message, 
+				const mediacontrol_Position* begin, 
+				const mediacontrol_Position* end,
+				mediacontrol_Exception *exception);
+
+mediacontrol_StreamInformation* 
+mediacontrol_get_stream_information(mediacontrol_Instance* self,
+				    mediacontrol_PositionKey a_key,
+				    mediacontrol_Exception *exception);
+
+unsigned short mediacontrol_sound_get_volume(mediacontrol_Instance* self,
+					     mediacontrol_Exception *exception);
+void mediacontrol_sound_set_volume(mediacontrol_Instance* self,
+				   const unsigned short volume,
+				   mediacontrol_Exception *exception);
+
+#endif
+

modules/control/corba/mediacontrol-init.c

+#include "mediacontrol-core.h"
+
+mediacontrol_Instance* mediacontrol_new(char** args, mediacontrol_Exception *exception)
+{
+  mediacontrol_Instance* retval;
+  vlc_object_t *p_vlc;
+  int p_vlc_id;
+  char **ppsz_argv;
+  int i_count = 0;
+  int i_index;
+  char **p_tmp;
+
+  if (args)
+    {
+      for (p_tmp = args ; *p_tmp != NULL; p_tmp++)
+	i_count++;
+    }
+
+  ppsz_argv = malloc(i_count + 2);
+  ppsz_argv[0] = strdup("vlc");
+  for (i_index = 0; i_index < i_count; i_index++)
+    ppsz_argv[i_index+1] = strdup(args[i_index]);
+  ppsz_argv[i_count + 1] = NULL;
+  
+  p_vlc_id = VLC_Create();
+  
+  p_vlc = (vlc_object_t*)vlc_current_object (p_vlc_id);
+  
+  if (! p_vlc)
+    {
+      exception->code = mediacontrol_InternalException;
+      exception->message = strdup("Unable to initialize VLC");
+      return NULL;
+    }
+  retval = (mediacontrol_Instance*)malloc(sizeof(mediacontrol_Instance));
+
+  VLC_Init(p_vlc_id, i_count + 1, ppsz_argv);
+
+  retval->p_vlc = p_vlc;
+  retval->vlc_object_id = p_vlc_id;
+
+  /* We can keep references on these, which should not change. Is it true ? */
+  retval->p_playlist = vlc_object_find(p_vlc, VLC_OBJECT_PLAYLIST, FIND_ANYWHERE);
+  retval->p_intf = vlc_object_find(p_vlc, VLC_OBJECT_INTF, FIND_ANYWHERE);
+
+  if (! retval->p_playlist || ! retval->p_intf)
+    {
+      exception->code=mediacontrol_InternalException;
+      exception->message=strdup("No available interface");
+      return NULL;
+    }
+  return retval;  
+};
+
+void
+mediacontrol_exit(mediacontrol_Instance *self)
+{
+  vlc_object_release((vlc_object_t*)self->p_playlist);
+  vlc_object_release((vlc_object_t*)self->p_intf);
+  VLC_Stop(self->vlc_object_id);
+  VLC_Destroy(self->vlc_object_id);
+}

modules/control/corba/mediacontrol-plugin.c

+#include "mediacontrol-core.h"
+#include <vlc/intf.h>
+
+mediacontrol_Instance* mediacontrol_new(char** args, mediacontrol_Exception *exception)
+{
+  exception->code = mediacontrol_InternalException;
+  exception->message = strdup("The mediacontrol extension was compiled for plugin use only.");
+  return NULL;
+};
+
+void
+mediacontrol_exit(mediacontrol_Instance *self)
+{
+  vlc_object_release(self->p_playlist);
+  
+  vlc_mutex_lock( &self->p_intf->change_lock );
+  self->p_intf->b_die = 1;
+  vlc_mutex_unlock( &self->p_intf->change_lock );
+
+  vlc_object_release(self->p_intf);
+  vlc_object_release(self->p_vlc);
+}