src/misc/variables.h

   1 /*****************************************************************************
   2  * variables.h: object variables typedefs
   3  *****************************************************************************
   4  * Copyright (C) 1999-2012 VLC authors and VideoLAN
   5  *
   6  * Authors: Samuel Hocevar <sam@zoy.org>
   7  *
   8  * This program is free software; you can redistribute it and/or modify it
   9  * under the terms of the GNU Lesser General Public License as published by
  10  * the Free Software Foundation; either version 2.1 of the License, or
  11  * (at your option) any later version.
  12  *
  13  * This program is distributed in the hope that it will be useful,
  14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  16  * GNU Lesser General Public License for more details.
  17  *
  18  * You should have received a copy of the GNU Lesser General Public License
  19  * along with this program; if not, write to the Free Software Foundation,
  20  * Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
  21  *****************************************************************************/
  22
  23 #ifndef LIBVLC_VARIABLES_H
  24 # define LIBVLC_VARIABLES_H 1
  25
  26 # include <vlc_atomic.h>
  27
  28 /**
  29  * Private LibVLC data for each object.
  30  */
  31 typedef struct vlc_object_internals vlc_object_internals_t;
  32
  33 struct vlc_object_internals
  34 {
  35     char           *psz_name; /* given name */
  36
  37     /* Object variables */
  38     void           *var_root;
  39     vlc_mutex_t     var_lock;
  40     vlc_cond_t      var_wait;
  41
  42     /* Objects management */
  43     atomic_uint     refs;
  44     vlc_destructor_t pf_destructor;
  45
  46     /* Objects tree structure */
  47     vlc_object_internals_t *next;  /* next sibling */
  48     vlc_object_internals_t *prev;  /* previous sibling */
  49     vlc_object_internals_t *first; /* first child */
  50     vlc_mutex_t tree_lock;
  51 };
  52
  53 # define vlc_internals( obj ) (((vlc_object_internals_t*)(VLC_OBJECT(obj)))-1)
  54 # define vlc_externals( priv ) ((vlc_object_t *)((priv) + 1))
  55
  56 void DumpVariables(vlc_object_t *obj);
  57
  58 extern void var_DestroyAll( vlc_object_t * );
  59
  60 #endif