]> git.sesse.net Git - vlc/blobdiff - include/vlc_objects.h
* modules/gui/wxwindows/*: don't forget to delete the timer.
[vlc] / include / vlc_objects.h
index d2d18d4ff9d0d81096ea8d060a8071fcfa55afa7..5ced55bffae2b37dc7f5d7976a0afd4dc0c73d2a 100644 (file)
@@ -2,7 +2,7 @@
  * vlc_objects.h: vlc_object_t definition.
  *****************************************************************************
  * Copyright (C) 2002 VideoLAN
- * $Id: vlc_objects.h,v 1.8 2002/08/14 08:17:24 sam Exp $
+ * $Id: vlc_objects.h,v 1.20 2003/10/14 22:41:41 gbazin Exp $
  *
  * Authors: Samuel Hocevar <sam@zoy.org>
  *
  * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111, USA.
  *****************************************************************************/
 
+/**
+ * \file
+ * This file defines the vlc_object_t structure and object types
+ */
+
+/** 
+ * \defgroup vlc_object Objects
+ * @{
+ */
+
 /* Object types */
 #define VLC_OBJECT_ROOT       (-1)
-#define VLC_OBJECT_MODULE     (-2)
-#define VLC_OBJECT_INTF       (-3)
-#define VLC_OBJECT_PLAYLIST   (-4)
-#define VLC_OBJECT_ITEM       (-5)
-#define VLC_OBJECT_INPUT      (-6)
-#define VLC_OBJECT_DECODER    (-7)
-#define VLC_OBJECT_VOUT       (-8)
-#define VLC_OBJECT_AOUT       (-9)
-#define VLC_OBJECT_SOUT       (-10)
+#define VLC_OBJECT_VLC        (-2)
+#define VLC_OBJECT_MODULE     (-3)
+#define VLC_OBJECT_INTF       (-4)
+#define VLC_OBJECT_PLAYLIST   (-5)
+#define VLC_OBJECT_ITEM       (-6)
+#define VLC_OBJECT_INPUT      (-7)
+#define VLC_OBJECT_DECODER    (-8)
+/* tmp for backward compat */
+#define VLC_OBJECT_DECODER_FIFO (-999)
+#define VLC_OBJECT_VOUT       (-9)
+#define VLC_OBJECT_AOUT      (-10)
+#define VLC_OBJECT_SOUT      (-11)
+#define VLC_OBJECT_HTTPD     (-12)
+#define VLC_OBJECT_PACKETIZER (-13)
+#define VLC_OBJECT_ENCODER   (-14)
+#define VLC_OBJECT_DIALOGS   (-15)
+
 #define VLC_OBJECT_GENERIC  (-666)
 
 /* Object search mode */
 
 #define FIND_STRICT         0x0010
 
-/* Object cast */
-
+/*****************************************************************************
+ * The vlc_object_t type. Yes, it's that simple :-)
+ *****************************************************************************/
+/** The main vlc_object_t structure */
+struct vlc_object_t
+{
+    VLC_COMMON_MEMBERS
+};
 
 /*****************************************************************************
  * Prototypes
  *****************************************************************************/
 VLC_EXPORT( void *, __vlc_object_create, ( vlc_object_t *, int ) );
 VLC_EXPORT( void, __vlc_object_destroy, ( vlc_object_t * ) );
+VLC_EXPORT( void, __vlc_object_attach, ( vlc_object_t *, vlc_object_t * ) );
+VLC_EXPORT( void, __vlc_object_detach, ( vlc_object_t * ) );
+VLC_EXPORT( void *, __vlc_object_get, ( vlc_object_t *, int ) );
 VLC_EXPORT( void *, __vlc_object_find, ( vlc_object_t *, int, int ) );
 VLC_EXPORT( void, __vlc_object_yield, ( vlc_object_t * ) );
 VLC_EXPORT( void, __vlc_object_release, ( vlc_object_t * ) );
-VLC_EXPORT( void, __vlc_object_detach, ( vlc_object_t * ) );
-VLC_EXPORT( void, __vlc_object_attach, ( vlc_object_t *, vlc_object_t * ) );
-#if 0
-//VLC_EXPORT( void, __vlc_object_setchild, ( vlc_object_t *, vlc_object_t * ) );
-#endif
+VLC_EXPORT( vlc_list_t *, __vlc_list_find, ( vlc_object_t *, int, int ) );
+VLC_EXPORT( void, vlc_list_release, ( vlc_list_t * ) );
 
-VLC_EXPORT( void, __vlc_liststructure, ( vlc_object_t * ) );
-VLC_EXPORT( void, __vlc_dumpstructure, ( vlc_object_t * ) );
+/*}@*/
 
 #define vlc_object_create(a,b) \
     __vlc_object_create( VLC_OBJECT(a), b )
@@ -68,6 +91,15 @@ VLC_EXPORT( void, __vlc_dumpstructure, ( vlc_object_t * ) );
     __vlc_object_destroy( VLC_OBJECT(a) ); \
     (a) = NULL; } while(0)
 
+#define vlc_object_detach(a) \
+    __vlc_object_detach( VLC_OBJECT(a) )
+
+#define vlc_object_attach(a,b) \
+    __vlc_object_attach( VLC_OBJECT(a), VLC_OBJECT(b) )
+
+#define vlc_object_get(a,b) \
+    __vlc_object_get( VLC_OBJECT(a),b)
+
 #define vlc_object_find(a,b,c) \
     __vlc_object_find( VLC_OBJECT(a),b,c)
 
@@ -77,20 +109,6 @@ VLC_EXPORT( void, __vlc_dumpstructure, ( vlc_object_t * ) );
 #define vlc_object_release(a) \
     __vlc_object_release( VLC_OBJECT(a) )
 
-#define vlc_object_detach(a) \
-    __vlc_object_detach( VLC_OBJECT(a) )
-
-#define vlc_object_attach(a,b) \
-    __vlc_object_attach( VLC_OBJECT(a), VLC_OBJECT(b) )
-
-#if 0
-#define vlc_object_setchild(a,b) \
-    __vlc_object_setchild( VLC_OBJECT(a), VLC_OBJECT(b) )
-#endif
-
-#define vlc_liststructure(a) \
-    __vlc_liststructure( VLC_OBJECT(a) )
-
-#define vlc_dumpstructure(a) \
-    __vlc_dumpstructure( VLC_OBJECT(a) )
+#define vlc_list_find(a,b,c) \
+    __vlc_list_find( VLC_OBJECT(a),b,c)