/*****************************************************************************
- * vlc_objects.h: vlc_object_t definition.
+ * vlc_objects.h: vlc_object_t definition and manipulation methods
*****************************************************************************
- * Copyright (C) 2002 VideoLAN
- * $Id: vlc_objects.h,v 1.8 2002/08/14 08:17:24 sam Exp $
+ * Copyright (C) 2002-2006 the VideoLAN team
+ * $Id$
*
* Authors: Samuel Hocevar <sam@zoy.org>
*
* 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.
- *
+ *
* This program 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
*
* 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, USA.
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
*****************************************************************************/
+#if !defined( __LIBVLC__ )
+ #error You are not libvlc or one of its plugins. You cannot include this file
+#endif
+
+/**
+ * \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_GENERIC (-666)
+#define VLC_OBJECT_GLOBAL (-1)
+#define VLC_OBJECT_LIBVLC (-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)
+#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_VLM (-16)
+#define VLC_OBJECT_ANNOUNCE (-17)
+#define VLC_OBJECT_DEMUX (-18)
+#define VLC_OBJECT_ACCESS (-19)
+#define VLC_OBJECT_STREAM (-20)
+#define VLC_OBJECT_OPENGL (-21)
+#define VLC_OBJECT_FILTER (-22)
+#define VLC_OBJECT_VOD (-23)
+#define VLC_OBJECT_SPU (-24)
+#define VLC_OBJECT_TLS (-25)
+#define VLC_OBJECT_SD (-26)
+#define VLC_OBJECT_XML (-27)
+#define VLC_OBJECT_OSDMENU (-28)
+#define VLC_OBJECT_STATS (-29)
+#define VLC_OBJECT_HTTPD_HOST (-30)
+#define VLC_OBJECT_META_ENGINE (-31)
+
+#define VLC_OBJECT_GENERIC (-666)
/* Object search mode */
#define FIND_PARENT 0x0001
#define FIND_STRICT 0x0010
-/* Object cast */
+/* Object flags */
+#define OBJECT_FLAGS_NODBG 0x0001
+#define OBJECT_FLAGS_QUIET 0x0002
+#define OBJECT_FLAGS_NOINTERACT 0x0004
+/*****************************************************************************
+ * 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_kill, ( vlc_object_t * ) );
+VLC_EXPORT( vlc_bool_t, __vlc_object_dying_unlocked, ( vlc_object_t * ) );
+VLC_EXPORT( vlc_bool_t, __vlc_object_dying, ( 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_find_name, ( vlc_object_t *, const char *, 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( libvlc_int_t *, vlc_current_object, ( int ) );
-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 )
__vlc_object_destroy( VLC_OBJECT(a) ); \
(a) = NULL; } while(0)
-#define vlc_object_find(a,b,c) \
- __vlc_object_find( VLC_OBJECT(a),b,c)
-
-#define vlc_object_yield(a) \
- __vlc_object_yield( VLC_OBJECT(a) )
-
-#define vlc_object_release(a) \
- __vlc_object_release( VLC_OBJECT(a) )
+#define vlc_object_kill(a) \
+ __vlc_object_kill( 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_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)
-#define vlc_liststructure(a) \
- __vlc_liststructure( VLC_OBJECT(a) )
+#define vlc_object_find_name(a,b,c) \
+ __vlc_object_find_name( VLC_OBJECT(a),b,c)
-#define vlc_dumpstructure(a) \
- __vlc_dumpstructure( VLC_OBJECT(a) )
+#define vlc_object_yield(a) \
+ __vlc_object_yield( VLC_OBJECT(a) )
+
+#define vlc_object_release(a) \
+ __vlc_object_release( VLC_OBJECT(a) )
+#define vlc_list_find(a,b,c) \
+ __vlc_list_find( VLC_OBJECT(a),b,c)
projects / vlc / blobdiff