home *** CD-ROM | disk | FTP | other *** search
/ mail.altrad.com / 2015.02.mail.altrad.com.tar / mail.altrad.com / TEST / vlc-2-0-5-win32.exe / sdk / include / vlc / plugins / vlc_objects.h < prev    next >
C/C++ Source or Header  |  2012-12-12  |  3KB  |  90 lines
  1. /*****************************************************************************
  2.  * vlc_objects.h: vlc_object_t definition and manipulation methods
  3.  *****************************************************************************
  4.  * Copyright (C) 2002-2008 VLC authors and VideoLAN
  5.  * $Id: 06ac2bbd9e02f5a481ddc868b909c933a046d877 $
  6.  *
  7.  * Authors: Samuel Hocevar <sam@zoy.org>
  8.  *
  9.  * This program is free software; you can redistribute it and/or modify it
  10.  * under the terms of the GNU Lesser General Public License as published by
  11.  * the Free Software Foundation; either version 2.1 of the License, or
  12.  * (at your option) any later version.
  13.  *
  14.  * This program is distributed in the hope that it will be useful,
  15.  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  16.  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  17.  * GNU Lesser General Public License for more details.
  18.  *
  19.  * You should have received a copy of the GNU Lesser General Public License
  20.  * along with this program; if not, write to the Free Software Foundation,
  21.  * Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
  22.  *****************************************************************************/
  23.  
  24. /**
  25.  * \file
  26.  * This file defines the vlc_object_t structure and object types.
  27.  */
  28.  
  29. /**
  30.  * \defgroup vlc_object Objects
  31.  * @{
  32.  */
  33.  
  34. /* Object flags */
  35. #define OBJECT_FLAGS_QUIET       0x0002
  36. #define OBJECT_FLAGS_NOINTERACT  0x0004
  37.  
  38. /*****************************************************************************
  39.  * The vlc_object_t type. Yes, it's that simple :-)
  40.  *****************************************************************************/
  41. /** The main vlc_object_t structure */
  42. struct vlc_object_t
  43. {
  44.     VLC_COMMON_MEMBERS
  45. };
  46.  
  47. /*****************************************************************************
  48.  * Prototypes
  49.  *****************************************************************************/
  50. VLC_API void *vlc_object_create( vlc_object_t *, size_t ) VLC_MALLOC VLC_USED;
  51. VLC_API vlc_object_t *vlc_object_find_name( vlc_object_t *, const char * ) VLC_USED VLC_DEPRECATED;
  52. VLC_API void * vlc_object_hold( vlc_object_t * );
  53. VLC_API void vlc_object_release( vlc_object_t * );
  54. VLC_API vlc_list_t *vlc_list_children( vlc_object_t * ) VLC_USED;
  55. VLC_API void vlc_list_release( vlc_list_t * );
  56. VLC_API char *vlc_object_get_name( const vlc_object_t * ) VLC_USED;
  57. #define vlc_object_get_name(o) vlc_object_get_name(VLC_OBJECT(o))
  58.  
  59. /**}@*/
  60.  
  61. #define vlc_object_create(a,b) vlc_object_create( VLC_OBJECT(a), b )
  62.  
  63. #define vlc_object_find_name(a,b) \
  64.     vlc_object_find_name( VLC_OBJECT(a),b)
  65.  
  66. #define vlc_object_hold(a) \
  67.     vlc_object_hold( VLC_OBJECT(a) )
  68.  
  69. #define vlc_object_release(a) \
  70.     vlc_object_release( VLC_OBJECT(a) )
  71.  
  72. #define vlc_list_children(a) \
  73.     vlc_list_children( VLC_OBJECT(a) )
  74.  
  75. /* Objects and threading */
  76. VLC_API void vlc_object_kill( vlc_object_t * ) VLC_DEPRECATED;
  77. #define vlc_object_kill(a) \
  78.     vlc_object_kill( VLC_OBJECT(a) )
  79.  
  80. VLC_USED VLC_DEPRECATED
  81. static inline bool vlc_object_alive (const vlc_object_t *obj)
  82. {
  83.     barrier ();
  84.     return !obj->b_die;
  85. }
  86.  
  87. #define vlc_object_alive(a) vlc_object_alive( VLC_OBJECT(a) )
  88.  
  89. /** @} */
  90.