git.sesse.net Git - vlc/blob - src/misc/objects.c

   1 /*****************************************************************************
   2  * objects.c: vlc_object_t handling
   3  *****************************************************************************
   4  * Copyright (C) 2004-2008 the VideoLAN team
   5  * $Id$
   6  *
   7  * Authors: Samuel Hocevar <sam@zoy.org>
   8  *
   9  * This program is free software; you can redistribute it and/or modify
  10  * it under the terms of the GNU General Public License as published by
  11  * the Free Software Foundation; either version 2 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 General Public License for more details.
  18  *
  19  * You should have received a copy of the GNU General Public License
  20  * along with this program; if not, write to the Free Software
  21  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
  22  *****************************************************************************/
  23
  24 /**
  25  * \file
  26  * This file contains the functions to handle the vlc_object_t type
  27  */
  28
  29
  30 /*****************************************************************************
  31  * Preamble
  32  *****************************************************************************/
  33 #ifdef HAVE_CONFIG_H
  34 # include "config.h"
  35 #endif
  36
  37 #include <vlc/vlc.h>
  38
  39 #include "../libvlc.h"
  40 #include <vlc_vout.h>
  41 #include <vlc_aout.h>
  42 #include "audio_output/aout_internal.h"
  43
  44 #include <vlc_access.h>
  45 #include <vlc_demux.h>
  46 #include <vlc_stream.h>
  47
  48 #include <vlc_sout.h>
  49 #include "stream_output/stream_output.h"
  50
  51 #include "vlc_interface.h"
  52 #include "vlc_codec.h"
  53 #include "vlc_filter.h"
  54
  55 #include "variables.h"
  56 #ifndef WIN32
  57 # include <unistd.h>
  58 #else
  59 # include <io.h>
  60 # include <fcntl.h>
  61 # include <errno.h> /* ENOSYS */
  62 #endif
  63 #include <assert.h>
  64
  65 /*****************************************************************************
  66  * Local prototypes
  67  *****************************************************************************/
  68 static int  DumpCommand( vlc_object_t *, char const *,
  69                          vlc_value_t, vlc_value_t, void * );
  70
  71 static vlc_object_t * FindObject    ( vlc_object_t *, int, int );
  72 static vlc_object_t * FindObjectName( vlc_object_t *, const char *, int );
  73 static void           PrintObject   ( vlc_object_t *, const char * );
  74 static void           DumpStructure ( vlc_object_t *, int, char * );
  75 static int            FindIndex     ( vlc_object_t *, vlc_object_t **, int );
  76
  77 static vlc_list_t   * NewList       ( int );
  78 static void           ListReplace   ( vlc_list_t *, vlc_object_t *, int );
  79 /*static void           ListAppend    ( vlc_list_t *, vlc_object_t * );*/
  80 static int            CountChildren ( vlc_object_t *, int );
  81 static void           ListChildren  ( vlc_list_t *, vlc_object_t *, int );
  82
  83 static void vlc_object_destroy( vlc_object_t *p_this );
  84 static void vlc_object_detach_unlocked (vlc_object_t *p_this);
  85
  86 /*****************************************************************************
  87  * Local structure lock
  88  *****************************************************************************/
  89 static vlc_mutex_t    structure_lock;
  90
  91 void *vlc_custom_create( vlc_object_t *p_this, size_t i_size,
  92                          int i_type, const char *psz_type )
  93 {
  94     vlc_object_t *p_new;
  95     vlc_object_internals_t *p_priv;
  96
  97     /* NOTE:
  98      * VLC objects are laid out as follow:
  99      * - first the LibVLC-private per-object data,
 100      * - then VLC_COMMON members from vlc_object_t,
 101      * - finally, the type-specific data (if any).
 102      *
 103      * This function initializes the LibVLC and common data,
 104      * and zeroes the rest.
 105      */
 106     p_priv = calloc( 1, sizeof( *p_priv ) + i_size );
 107     if( p_priv == NULL )
 108         return NULL;
 109
 110     assert (i_size >= sizeof (vlc_object_t));
 111     p_new = (vlc_object_t *)(p_priv + 1);
 112
 113     p_new->i_object_type = i_type;
 114     p_new->psz_object_type = psz_type;
 115     p_new->psz_object_name = NULL;
 116
 117     p_new->b_die = false;
 118     p_new->b_error = false;
 119     p_new->b_dead = false;
 120     p_new->b_force = false;
 121
 122     p_new->psz_header = NULL;
 123
 124     if (p_this)
 125         p_new->i_flags = p_this->i_flags
 126             & (OBJECT_FLAGS_NODBG|OBJECT_FLAGS_QUIET|OBJECT_FLAGS_NOINTERACT);
 127
 128     p_priv->p_vars = calloc( sizeof( variable_t ), 16 );
 129
 130     if( !p_priv->p_vars )
 131     {
 132         free( p_priv );
 133         return NULL;
 134     }
 135
 136     libvlc_global_data_t *p_libvlc_global;
 137     if( p_this == NULL )
 138     {
 139         /* Only the global root object is created out of the blue */
 140         p_libvlc_global = (libvlc_global_data_t *)p_new;
 141         p_new->p_libvlc = NULL;
 142
 143         p_libvlc_global->i_counter = 0;
 144         p_libvlc_global->i_objects = 0;
 145         p_libvlc_global->pp_objects = NULL;
 146         vlc_mutex_init( &structure_lock );
 147     }
 148     else
 149     {
 150         p_libvlc_global = vlc_global();
 151         if( i_type == VLC_OBJECT_LIBVLC )
 152             p_new->p_libvlc = (libvlc_int_t*)p_new;
 153         else
 154             p_new->p_libvlc = p_this->p_libvlc;
 155     }
 156
 157     vlc_spin_init( &p_priv->ref_spin );
 158     p_priv->i_refcount = 1;
 159     p_priv->pf_destructor = NULL;
 160     p_priv->b_thread = false;
 161     p_new->p_parent = NULL;
 162     p_priv->pp_children = NULL;
 163     p_priv->i_children = 0;
 164
 165     p_new->p_private = NULL;
 166
 167     /* Initialize mutexes and condvars */
 168     vlc_mutex_init( &p_new->object_lock );
 169     vlc_cond_init( p_new, &p_new->object_wait );
 170     vlc_mutex_init( &p_priv->var_lock );
 171     vlc_spin_init( &p_priv->spin );
 172     p_priv->pipes[0] = p_priv->pipes[1] = -1;
 173
 174     vlc_mutex_lock( &structure_lock );
 175     p_new->i_object_id = p_libvlc_global->i_counter++;
 176     /* Wooohaa! If *this* fails, we're in serious trouble! Anyway it's
 177      * useless to try and recover anything if pp_objects gets smashed. */
 178     TAB_APPEND( p_libvlc_global->i_objects, p_libvlc_global->pp_objects,
 179                 p_new );
 180     vlc_mutex_unlock( &structure_lock );
 181
 182     if( i_type == VLC_OBJECT_LIBVLC )
 183     {
 184         var_Create( p_new, "list", VLC_VAR_STRING | VLC_VAR_ISCOMMAND );
 185         var_AddCallback( p_new, "list", DumpCommand, NULL );
 186         var_Create( p_new, "tree", VLC_VAR_STRING | VLC_VAR_ISCOMMAND );
 187         var_AddCallback( p_new, "tree", DumpCommand, NULL );
 188         var_Create( p_new, "vars", VLC_VAR_STRING | VLC_VAR_ISCOMMAND );
 189         var_AddCallback( p_new, "vars", DumpCommand, NULL );
 190     }
 191
 192     return p_new;
 193 }
 194
 195
 196 /**
 197  * Allocates and initializes a vlc object.
 198  *
 199  * @param i_type known object type (all of them are negative integer values),
 200  *               or object byte size (always positive).
 201  *
 202  * @return the new object, or NULL on error.
 203  */
 204 void * __vlc_object_create( vlc_object_t *p_this, int i_type )
 205 {
 206     const char   * psz_type;
 207     size_t         i_size;
 208
 209     switch( i_type )
 210     {
 211         case VLC_OBJECT_LIBVLC:
 212             i_size = sizeof(libvlc_int_t);
 213             psz_type = "libvlc";
 214             break;
 215         case VLC_OBJECT_INTF:
 216             i_size = sizeof(intf_thread_t);
 217             psz_type = "interface";
 218             break;
 219         case VLC_OBJECT_DIALOGS:
 220             i_size = sizeof(intf_thread_t);
 221             psz_type = "dialogs";
 222             break;
 223         case VLC_OBJECT_DEMUX:
 224             i_size = sizeof(demux_t);
 225             psz_type = "demux";
 226             break;
 227         case VLC_OBJECT_ACCESS:
 228             i_size = sizeof(access_t);
 229             psz_type = "access";
 230             break;
 231         case VLC_OBJECT_DECODER:
 232             i_size = sizeof(decoder_t);
 233             psz_type = "decoder";
 234             break;
 235         case VLC_OBJECT_PACKETIZER:
 236             i_size = sizeof(decoder_t);
 237             psz_type = "packetizer";
 238             break;
 239         case VLC_OBJECT_ENCODER:
 240             i_size = sizeof(encoder_t);
 241             psz_type = "encoder";
 242             break;
 243         case VLC_OBJECT_FILTER:
 244             i_size = sizeof(filter_t);
 245             psz_type = "filter";
 246             break;
 247         case VLC_OBJECT_VOUT:
 248             i_size = sizeof(vout_thread_t);
 249             psz_type = "video output";
 250             break;
 251         case VLC_OBJECT_AOUT:
 252             i_size = sizeof(aout_instance_t);
 253             psz_type = "audio output";
 254             break;
 255         case VLC_OBJECT_SOUT:
 256             i_size = sizeof(sout_instance_t);
 257             psz_type = "stream output";
 258             break;
 259         case VLC_OBJECT_OPENGL:
 260             i_size = sizeof( vout_thread_t );
 261             psz_type = "opengl";
 262             break;
 263         case VLC_OBJECT_ANNOUNCE:
 264             i_size = sizeof( announce_handler_t );
 265             psz_type = "announce";
 266             break;
 267         case VLC_OBJECT_INTERACTION:
 268             i_size = sizeof( interaction_t );
 269             psz_type = "interaction";
 270             break;
 271         default:
 272             i_size = i_type > (int)sizeof(vlc_object_t)
 273                          ? i_type : (int)sizeof(vlc_object_t);
 274             i_type = VLC_OBJECT_GENERIC;
 275             psz_type = "generic";
 276             break;
 277     }
 278
 279     return vlc_custom_create( p_this, i_size, i_type, psz_type );
 280 }
 281
 282
 283 /**
 284  ****************************************************************************
 285  * Set the destructor of a vlc object
 286  *
 287  * This function sets the destructor of the vlc object. It will be called
 288  * when the object is destroyed when the its refcount reaches 0.
 289  * (It is called by the internal function vlc_object_destroy())
 290  *****************************************************************************/
 291 void __vlc_object_set_destructor( vlc_object_t *p_this,
 292                                   vlc_destructor_t pf_destructor )
 293 {
 294     vlc_object_internals_t *p_priv = vlc_internals(p_this );
 295     p_priv->pf_destructor = pf_destructor;
 296 }
 297
 298 /**
 299  ****************************************************************************
 300  * Destroy a vlc object (Internal)
 301  *
 302  * This function destroys an object that has been previously allocated with
 303  * vlc_object_create. The object's refcount must be zero and it must not be
 304  * attached to other objects in any way.
 305  *****************************************************************************/
 306 static void vlc_object_destroy( vlc_object_t *p_this )
 307 {
 308     vlc_object_internals_t *p_priv = vlc_internals( p_this );
 309
 310     /* Objects are always detached beforehand */
 311     assert( !p_this->p_parent );
 312
 313     /* Send a kill to the object's thread if applicable */
 314     vlc_object_kill( p_this );
 315
 316     /* If we are running on a thread, wait until it ends */
 317     if( p_priv->b_thread )
 318         vlc_thread_join( p_this );
 319
 320     /* Call the custom "subclass" destructor */
 321     if( p_priv->pf_destructor )
 322         p_priv->pf_destructor( p_this );
 323
 324     /* Destroy the associated variables, starting from the end so that
 325      * no memmove calls have to be done. */
 326     while( p_priv->i_vars )
 327     {
 328         var_Destroy( p_this, p_priv->p_vars[p_priv->i_vars - 1].psz_name );
 329     }
 330
 331     free( p_priv->p_vars );
 332     vlc_mutex_destroy( &p_priv->var_lock );
 333
 334     free( p_this->psz_header );
 335
 336     if( p_this->p_libvlc == NULL )
 337     {
 338         libvlc_global_data_t *p_global = (libvlc_global_data_t *)p_this;
 339
 340 #ifndef NDEBUG
 341         assert( p_global == vlc_global() );
 342         /* Test for leaks */
 343         if( p_global->i_objects > 0 )
 344         {
 345             int i;
 346             for( i = 0; i < p_global->i_objects; i++ )
 347             {
 348                 /* We are leaking this object */
 349                 fprintf( stderr,
 350                          "ERROR: leaking object (id:%i, type:%s, name:%s)\n",
 351                          p_global->pp_objects[i]->i_object_id,
 352                          p_global->pp_objects[i]->psz_object_type,
 353                          p_global->pp_objects[i]->psz_object_name );
 354
 355                 /* Dump libvlc object to ease debugging */
 356                 vlc_object_dump( p_global->pp_objects[i] );
 357
 358                 fflush(stderr);
 359             }
 360
 361             /* Dump libvlc object to ease debugging */
 362             vlc_object_dump( p_this );
 363
 364             /* Strongly abort, cause we want these to be fixed */
 365             abort();
 366         }
 367 #endif
 368
 369         /* We are the global object ... no need to lock. */
 370         free( p_global->pp_objects );
 371         p_global->pp_objects = NULL;
 372
 373         vlc_mutex_destroy( &structure_lock );
 374     }
 375
 376     FREENULL( p_this->psz_object_name );
 377
 378 #if defined(WIN32) || defined(UNDER_CE)
 379     /* if object has an associated thread, close it now */
 380     if( p_priv->thread_id )
 381        CloseHandle(p_priv->thread_id);
 382 #endif
 383
 384     vlc_spin_destroy( &p_priv->ref_spin );
 385     vlc_mutex_destroy( &p_this->object_lock );
 386     vlc_cond_destroy( &p_this->object_wait );
 387     vlc_spin_destroy( &p_priv->spin );
 388     if( p_priv->pipes[1] != -1 )
 389         close( p_priv->pipes[1] );
 390     if( p_priv->pipes[0] != -1 )
 391         close( p_priv->pipes[0] );
 392
 393     free( p_priv );
 394 }
 395
 396
 397 /** Inter-object signaling */
 398
 399 void __vlc_object_lock( vlc_object_t *obj )
 400 {
 401     vlc_mutex_lock( &obj->object_lock );
 402 }
 403
 404 void __vlc_object_unlock( vlc_object_t *obj )
 405 {
 406     vlc_assert_locked( &obj->object_lock );
 407     vlc_mutex_unlock( &obj->object_lock );
 408 }
 409
 410 #ifdef WIN32
 411 # include <winsock2.h>
 412 # include <ws2tcpip.h>
 413
 414 /**
 415  * select()-able pipes emulated using Winsock
 416  */
 417 static int pipe (int fd[2])
 418 {
 419     SOCKADDR_IN addr;
 420     int addrlen = sizeof (addr);
 421
 422     SOCKET l = socket (PF_INET, SOCK_STREAM, IPPROTO_TCP), a,
 423            c = socket (PF_INET, SOCK_STREAM, IPPROTO_TCP);
 424     if ((l == INVALID_SOCKET) || (c == INVALID_SOCKET))
 425         goto error;
 426
 427     memset (&addr, 0, sizeof (addr));
 428     addr.sin_family = AF_INET;
 429     addr.sin_addr.s_addr = htonl (INADDR_LOOPBACK);
 430     if (bind (l, (PSOCKADDR)&addr, sizeof (addr))
 431      || getsockname (l, (PSOCKADDR)&addr, &addrlen)
 432      || listen (l, 1)
 433      || connect (c, (PSOCKADDR)&addr, addrlen))
 434         goto error;
 435
 436     a = accept (l, NULL, NULL);
 437     if (a == INVALID_SOCKET)
 438         goto error;
 439
 440     closesocket (l);
 441     //shutdown (a, 0);
 442     //shutdown (c, 1);
 443     fd[0] = c;
 444     fd[1] = a;
 445     return 0;
 446
 447 error:
 448     if (l != INVALID_SOCKET)
 449         closesocket (l);
 450     if (c != INVALID_SOCKET)
 451         closesocket (c);
 452     return -1;
 453 }
 454
 455 #undef  read
 456 #define read( a, b, c )  recv (a, b, c, 0)
 457 #undef  write
 458 #define write( a, b, c ) send (a, b, c, 0)
 459 #undef  close
 460 #define close( a )       closesocket (a)
 461 #endif /* WIN32 */
 462
 463 /**
 464  * Returns the readable end of a pipe that becomes readable once termination
 465  * of the object is requested (vlc_object_kill()).
 466  * This can be used to wake-up out of a select() or poll() event loop, such
 467  * typically when doing network I/O.
 468  *
 469  * Note that the pipe will remain the same for the lifetime of the object.
 470  * DO NOT read the pipe nor close it yourself. Ever.
 471  *
 472  * @param obj object that would be "killed"
 473  * @return a readable pipe descriptor, or -1 on error.
 474  */
 475 int __vlc_object_waitpipe( vlc_object_t *obj )
 476 {
 477     int pfd[2] = { -1, -1 };
 478     vlc_object_internals_t *internals = vlc_internals( obj );
 479     bool killed = false;
 480
 481     vlc_spin_lock (&internals->spin);
 482     if (internals->pipes[0] == -1)
 483     {
 484         /* This can only ever happen if someone killed us without locking: */
 485         assert (internals->pipes[1] == -1);
 486         vlc_spin_unlock (&internals->spin);
 487
 488         if (pipe (pfd))
 489             return -1;
 490
 491         vlc_spin_lock (&internals->spin);
 492         if (internals->pipes[0] == -1)
 493         {
 494             internals->pipes[0] = pfd[0];
 495             internals->pipes[1] = pfd[1];
 496             pfd[0] = pfd[1] = -1;
 497         }
 498         killed = obj->b_die;
 499     }
 500     vlc_spin_unlock (&internals->spin);
 501
 502     if (killed)
 503     {
 504         /* Race condition: vlc_object_kill() already invoked! */
 505         int fd;
 506
 507         vlc_spin_lock (&internals->spin);
 508         fd = internals->pipes[1];
 509         internals->pipes[1] = -1;
 510         vlc_spin_unlock (&internals->spin);
 511
 512         msg_Dbg (obj, "waitpipe: object already dying");
 513         if (fd != -1)
 514             close (fd);
 515     }
 516
 517     /* Race condition: two threads call pipe() - unlikely */
 518     if (pfd[0] != -1)
 519         close (pfd[0]);
 520     if (pfd[1] != -1)
 521         close (pfd[1]);
 522
 523     return internals->pipes[0];
 524 }
 525
 526
 527 /**
 528  * Waits for the object to be signaled (using vlc_object_signal()).
 529  * If the object already has a signal pending, this function will return
 530  * immediately. It is asserted that the caller holds the object lock.
 531  *
 532  * @return true if the object is dying and should terminate.
 533  */
 534 bool __vlc_object_wait( vlc_object_t *obj )
 535 {
 536     vlc_assert_locked( &obj->object_lock );
 537     vlc_cond_wait( &obj->object_wait, &obj->object_lock );
 538     return obj->b_die;
 539 }
 540
 541
 542 /**
 543  * Waits for the object to be signaled (using vlc_object_signal()), or for
 544  * a timer to expire.
 545  * If the object already has a signal pending, this function will return
 546  * immediately. It is asserted that the caller holds the object lock.
 547  *
 548  * @return negative if the object is dying and should terminate,
 549  * positive if the the object has been signaled but is not dying,
 550  * 0 if timeout has been reached.
 551  */
 552 int __vlc_object_timedwait( vlc_object_t *obj, mtime_t deadline )
 553 {
 554     int v;
 555
 556     vlc_assert_locked( &obj->object_lock );
 557     v = vlc_cond_timedwait( &obj->object_wait, &obj->object_lock, deadline );
 558     if( v == 0 ) /* signaled */
 559         return obj->b_die ? -1 : 1;
 560     return 0;
 561 }
 562
 563
 564 /**
 565  * Checks whether an object has been "killed".
 566  * The object lock must be held.
 567  *
 568  * Typical code for an object thread could be:
 569  *
 570    vlc_object_lock (self);
 571    ...initialization...
 572    while (vlc_object_alive (self))
 573    {
 574        ...preprocessing...
 575
 576        if (vlc_object_wait (self))
 577            continue;
 578
 579        ...postprocessing...
 580    }
 581    ...deinitialization...
 582    vlc_object_unlock (self);
 583  *
 584  *
 585  * @return true iff the object has not been killed yet
 586  */
 587 bool __vlc_object_alive( vlc_object_t *obj )
 588 {
 589     vlc_assert_locked( &obj->object_lock );
 590     return !obj->b_die;
 591 }
 592
 593
 594 /**
 595  * Signals an object for which the lock is held.
 596  */
 597 void __vlc_object_signal_unlocked( vlc_object_t *obj )
 598 {
 599     vlc_assert_locked (&obj->object_lock);
 600     vlc_cond_signal( &obj->object_wait );
 601 }
 602
 603
 604 /**
 605  * Requests termination of an object.
 606  * If the object is LibVLC, also request to terminate all its children.
 607  */
 608 void __vlc_object_kill( vlc_object_t *p_this )
 609 {
 610     vlc_object_internals_t *internals = vlc_internals( p_this );
 611     int fd;
 612
 613     vlc_mutex_lock( &p_this->object_lock );
 614     p_this->b_die = true;
 615
 616     vlc_spin_lock (&internals->spin);
 617     fd = internals->pipes[1];
 618     internals->pipes[1] = -1;
 619     vlc_spin_unlock (&internals->spin);
 620
 621     if( fd != -1 )
 622     {
 623         msg_Dbg (p_this, "waitpipe: object killed");
 624         close (fd);
 625     }
 626
 627     if( p_this->i_object_type == VLC_OBJECT_LIBVLC )
 628         for( int i = 0; i < internals->i_children ; i++ )
 629             vlc_object_kill( internals->pp_children[i] );
 630
 631     vlc_object_signal_unlocked( p_this );
 632     vlc_mutex_unlock( &p_this->object_lock );
 633 }
 634
 635
 636 /**
 637  * Find an object given its ID.
 638  *
 639  * This function looks for the object whose i_object_id field is i_id.
 640  * This function is slow, and often used to hide bugs. Do not use it.
 641  * If you need to retain reference to an object, yield the object pointer with
 642  * vlc_object_yield(), use the pointer as your reference, and call
 643  * vlc_object_release() when you're done.
 644  */
 645 void * vlc_object_get( int i_id )
 646 {
 647     int i_max, i_middle;
 648     vlc_object_t **pp_objects;
 649     libvlc_global_data_t *p_libvlc_global = vlc_global();
 650     vlc_object_t *obj = NULL;
 651
 652     vlc_mutex_lock( &structure_lock );
 653
 654     pp_objects = p_libvlc_global->pp_objects;
 655
 656     /* Perform our dichotomy */
 657     for( i_max = p_libvlc_global->i_objects - 1 ; ; )
 658     {
 659         i_middle = i_max / 2;
 660
 661         if( pp_objects[i_middle]->i_object_id > i_id )
 662         {
 663             i_max = i_middle;
 664         }
 665         else if( pp_objects[i_middle]->i_object_id < i_id )
 666         {
 667             if( i_middle )
 668             {
 669                 pp_objects += i_middle;
 670                 i_max -= i_middle;
 671             }
 672             else
 673             {
 674                 /* This happens when there are only two remaining objects */
 675                 if( pp_objects[i_middle+1]->i_object_id == i_id )
 676                 {
 677                     vlc_object_yield( pp_objects[i_middle+1] );
 678                     obj = pp_objects[i_middle+1];
 679                 }
 680                 break;
 681             }
 682         }
 683         else
 684         {
 685             vlc_object_yield( pp_objects[i_middle] );
 686             obj = pp_objects[i_middle];
 687             break;
 688         }
 689     }
 690
 691     vlc_mutex_unlock( &structure_lock );
 692     return obj;
 693 }
 694
 695 /**
 696  ****************************************************************************
 697  * find a typed object and increment its refcount
 698  *****************************************************************************
 699  * This function recursively looks for a given object type. i_mode can be one
 700  * of FIND_PARENT, FIND_CHILD or FIND_ANYWHERE.
 701  *****************************************************************************/
 702 void * __vlc_object_find( vlc_object_t *p_this, int i_type, int i_mode )
 703 {
 704     vlc_object_t *p_found;
 705
 706     /* If we are of the requested type ourselves, don't look further */
 707     if( !(i_mode & FIND_STRICT) && p_this->i_object_type == i_type )
 708     {
 709         vlc_object_yield( p_this );
 710         return p_this;
 711     }
 712
 713     vlc_mutex_lock( &structure_lock );
 714
 715     /* Otherwise, recursively look for the object */
 716     if( (i_mode & 0x000f) == FIND_ANYWHERE )
 717     {
 718         vlc_object_t *p_root = p_this;
 719
 720         /* Find the root */
 721         while( p_root->p_parent != NULL &&
 722                p_root != VLC_OBJECT( p_this->p_libvlc ) )
 723         {
 724             p_root = p_root->p_parent;
 725         }
 726
 727         p_found = FindObject( p_root, i_type, (i_mode & ~0x000f)|FIND_CHILD );
 728         if( p_found == NULL && p_root != VLC_OBJECT( p_this->p_libvlc ) )
 729         {
 730             p_found = FindObject( VLC_OBJECT( p_this->p_libvlc ),
 731                                   i_type, (i_mode & ~0x000f)|FIND_CHILD );
 732         }
 733     }
 734     else
 735     {
 736         p_found = FindObject( p_this, i_type, i_mode );
 737     }
 738
 739     vlc_mutex_unlock( &structure_lock );
 740
 741     return p_found;
 742 }
 743
 744 /**
 745  ****************************************************************************
 746  * find a named object and increment its refcount
 747  *****************************************************************************
 748  * This function recursively looks for a given object name. i_mode can be one
 749  * of FIND_PARENT, FIND_CHILD or FIND_ANYWHERE.
 750  *****************************************************************************/
 751 void * __vlc_object_find_name( vlc_object_t *p_this, const char *psz_name,
 752                                int i_mode )
 753 {
 754     vlc_object_t *p_found;
 755
 756     /* If have the requested name ourselves, don't look further */
 757     if( !(i_mode & FIND_STRICT)
 758         && p_this->psz_object_name
 759         && !strcmp( p_this->psz_object_name, psz_name ) )
 760     {
 761         vlc_object_yield( p_this );
 762         return p_this;
 763     }
 764
 765     vlc_mutex_lock( &structure_lock );
 766
 767     /* Otherwise, recursively look for the object */
 768     if( (i_mode & 0x000f) == FIND_ANYWHERE )
 769     {
 770         vlc_object_t *p_root = p_this;
 771
 772         /* Find the root */
 773         while( p_root->p_parent != NULL &&
 774                p_root != VLC_OBJECT( p_this->p_libvlc ) )
 775         {
 776             p_root = p_root->p_parent;
 777         }
 778
 779         p_found = FindObjectName( p_root, psz_name,
 780                                  (i_mode & ~0x000f)|FIND_CHILD );
 781         if( p_found == NULL && p_root != VLC_OBJECT( p_this->p_libvlc ) )
 782         {
 783             p_found = FindObjectName( VLC_OBJECT( p_this->p_libvlc ),
 784                                       psz_name, (i_mode & ~0x000f)|FIND_CHILD );
 785         }
 786     }
 787     else
 788     {
 789         p_found = FindObjectName( p_this, psz_name, i_mode );
 790     }
 791
 792     vlc_mutex_unlock( &structure_lock );
 793
 794     return p_found;
 795 }
 796
 797 /**
 798  * Increment an object reference counter.
 799  */
 800 void __vlc_object_yield( vlc_object_t *p_this )
 801 {
 802     vlc_object_internals_t *internals = vlc_internals( p_this );
 803
 804     vlc_spin_lock( &internals->ref_spin );
 805     /* Avoid obvious freed object uses */
 806     assert( internals->i_refcount > 0 );
 807     /* Increment the counter */
 808     internals->i_refcount++;
 809     vlc_spin_unlock( &internals->ref_spin );
 810 }
 811
 812 /*****************************************************************************
 813  * decrement an object refcount
 814  * And destroy the object if its refcount reach zero.
 815  *****************************************************************************/
 816 void __vlc_object_release( vlc_object_t *p_this )
 817 {
 818     vlc_object_internals_t *internals = vlc_internals( p_this );
 819     bool b_should_destroy;
 820
 821     vlc_spin_lock( &internals->ref_spin );
 822     assert( internals->i_refcount > 0 );
 823
 824     if( internals->i_refcount > 1 )
 825     {
 826         /* Fast path */
 827         /* There are still other references to the object */
 828         internals->i_refcount--;
 829         vlc_spin_unlock( &internals->ref_spin );
 830         return;
 831     }
 832     vlc_spin_unlock( &internals->ref_spin );
 833
 834     /* Slow path */
 835     /* Remember that we cannot hold the spin while waiting on the mutex */
 836     vlc_mutex_lock( &structure_lock );
 837     /* Take the spin again. Note that another thread may have yielded the
 838      * object in the (very short) mean time. */
 839     vlc_spin_lock( &internals->ref_spin );
 840     b_should_destroy = --internals->i_refcount == 0;
 841     vlc_spin_unlock( &internals->ref_spin );
 842
 843     if( b_should_destroy )
 844     {
 845         /* Remove the object from the table
 846          * so that it cannot be encountered by vlc_object_get() */
 847         libvlc_global_data_t *p_libvlc_global = vlc_global();
 848         int i_index;
 849
 850         i_index = FindIndex( p_this, p_libvlc_global->pp_objects,
 851                              p_libvlc_global->i_objects );
 852         REMOVE_ELEM( p_libvlc_global->pp_objects,
 853                      p_libvlc_global->i_objects, i_index );
 854
 855         /* Detach from parent to protect against FIND_CHILDREN */
 856         vlc_object_detach_unlocked (p_this);
 857         /* Detach from children to protect against FIND_PARENT */
 858         for (int i = 0; i < internals->i_children; i++)
 859             internals->pp_children[i]->p_parent = NULL;
 860     }
 861
 862     vlc_mutex_unlock( &structure_lock );
 863
 864     if( b_should_destroy )
 865     {
 866         free( internals->pp_children );
 867         internals->pp_children = NULL;
 868         internals->i_children = 0;
 869         vlc_object_destroy( p_this );
 870     }
 871 }
 872
 873 /**
 874  ****************************************************************************
 875  * attach object to a parent object
 876  *****************************************************************************
 877  * This function sets p_this as a child of p_parent, and p_parent as a parent
 878  * of p_this. This link can be undone using vlc_object_detach.
 879  *****************************************************************************/
 880 void __vlc_object_attach( vlc_object_t *p_this, vlc_object_t *p_parent )
 881 {
 882     if( !p_this ) return;
 883
 884     vlc_mutex_lock( &structure_lock );
 885
 886     /* Attach the parent to its child */
 887     assert (!p_this->p_parent);
 888     p_this->p_parent = p_parent;
 889
 890     /* Attach the child to its parent */
 891     vlc_object_internals_t *priv = vlc_internals( p_parent );
 892     INSERT_ELEM( priv->pp_children, priv->i_children, priv->i_children,
 893                  p_this );
 894
 895     vlc_mutex_unlock( &structure_lock );
 896 }
 897
 898
 899 static void vlc_object_detach_unlocked (vlc_object_t *p_this)
 900 {
 901     vlc_assert_locked (&structure_lock);
 902
 903     if (p_this->p_parent == NULL)
 904         return;
 905
 906     vlc_object_internals_t *priv = vlc_internals( p_this->p_parent );
 907
 908     int i_index, i;
 909
 910     /* Remove p_this's parent */
 911     p_this->p_parent = NULL;
 912
 913     /* Remove all of p_parent's children which are p_this */
 914     for( i_index = priv->i_children ; i_index-- ; )
 915     {
 916         if( priv->pp_children[i_index] == p_this )
 917         {
 918             priv->i_children--;
 919             for( i = i_index ; i < priv->i_children ; i++ )
 920                 priv->pp_children[i] = priv->pp_children[i+1];
 921         }
 922     }
 923
 924     if( priv->i_children )
 925     {
 926         priv->pp_children = (vlc_object_t **)realloc( priv->pp_children,
 927                                priv->i_children * sizeof(vlc_object_t *) );
 928     }
 929     else
 930     {
 931         /* Special case - don't realloc() to zero to avoid leaking */
 932         free( priv->pp_children );
 933         priv->pp_children = NULL;
 934     }
 935 }
 936
 937
 938 /**
 939  ****************************************************************************
 940  * detach object from its parent
 941  *****************************************************************************
 942  * This function removes all links between an object and its parent.
 943  *****************************************************************************/
 944 void __vlc_object_detach( vlc_object_t *p_this )
 945 {
 946     if( !p_this ) return;
 947
 948     vlc_mutex_lock( &structure_lock );
 949     if( !p_this->p_parent )
 950         msg_Err( p_this, "object is not attached" );
 951     else
 952         vlc_object_detach_unlocked( p_this );
 953     vlc_mutex_unlock( &structure_lock );
 954 }
 955
 956
 957 /**
 958  ****************************************************************************
 959  * find a list typed objects and increment their refcount
 960  *****************************************************************************
 961  * This function recursively looks for a given object type. i_mode can be one
 962  * of FIND_PARENT, FIND_CHILD or FIND_ANYWHERE.
 963  *****************************************************************************/
 964 vlc_list_t * __vlc_list_find( vlc_object_t *p_this, int i_type, int i_mode )
 965 {
 966     vlc_list_t *p_list;
 967     int i_count = 0;
 968
 969     /* Look for the objects */
 970     switch( i_mode & 0x000f )
 971     {
 972     case FIND_ANYWHERE:
 973         return vlc_list_find (vlc_global (), i_type, FIND_CHILD);
 974
 975     case FIND_CHILD:
 976         vlc_mutex_lock( &structure_lock );
 977         i_count = CountChildren( p_this, i_type );
 978         p_list = NewList( i_count );
 979
 980         /* Check allocation was successful */
 981         if( p_list->i_count != i_count )
 982         {
 983             msg_Err( p_this, "list allocation failed!" );
 984             p_list->i_count = 0;
 985             break;
 986         }
 987
 988         p_list->i_count = 0;
 989         ListChildren( p_list, p_this, i_type );
 990         vlc_mutex_unlock( &structure_lock );
 991         break;
 992
 993     default:
 994         msg_Err( p_this, "unimplemented!" );
 995         p_list = NewList( 0 );
 996         break;
 997     }
 998
 999     return p_list;
1000 }
1001
1002 /**
1003  * Gets the list of children of an objects, and increment their reference
1004  * count.
1005  * @return a list (possibly empty) or NULL in case of error.
1006  */
1007 vlc_list_t *__vlc_list_children( vlc_object_t *obj )
1008 {
1009     vlc_list_t *l;
1010     vlc_object_internals_t *priv = vlc_internals( obj );
1011
1012     vlc_mutex_lock( &structure_lock );
1013     l = NewList( priv->i_children );
1014     for (int i = 0; i < l->i_count; i++)
1015     {
1016         vlc_object_yield( priv->pp_children[i] );
1017         l->p_values[i].p_object = priv->pp_children[i];
1018     }
1019     vlc_mutex_unlock( &structure_lock );
1020     return l;
1021 }
1022
1023 /*****************************************************************************
1024  * DumpCommand: print the current vlc structure
1025  *****************************************************************************
1026  * This function prints either an ASCII tree showing the connections between
1027  * vlc objects, and additional information such as their refcount, thread ID,
1028  * etc. (command "tree"), or the same data as a simple list (command "list").
1029  *****************************************************************************/
1030 static int DumpCommand( vlc_object_t *p_this, char const *psz_cmd,
1031                         vlc_value_t oldval, vlc_value_t newval, void *p_data )
1032 {
1033     libvlc_global_data_t *p_libvlc_global = vlc_global();
1034
1035     (void)oldval; (void)p_data;
1036     if( *psz_cmd == 'l' )
1037     {
1038         vlc_mutex_lock( &structure_lock );
1039
1040         vlc_object_t **pp_current, **pp_end;
1041
1042         pp_current = p_libvlc_global->pp_objects;
1043         pp_end = pp_current + p_libvlc_global->i_objects;
1044
1045         for( ; pp_current < pp_end ; pp_current++ )
1046             PrintObject( *pp_current, "" );
1047
1048         vlc_mutex_unlock( &structure_lock );
1049     }
1050     else
1051     {
1052         vlc_object_t *p_object = NULL;
1053
1054         if( *newval.psz_string )
1055         {
1056             char *end;
1057             int i_id = strtol( newval.psz_string, &end, 0 );
1058             if( end != newval.psz_string )
1059                 p_object = vlc_object_get( i_id );
1060             else
1061             {
1062                 /* try using the object's name to find it */
1063                 vlc_object_t *p_libvlc = vlc_object_get( 1 );
1064                 if( p_libvlc )
1065                 {
1066                     /* Look in p_libvlc's children tree */
1067                     p_object = vlc_object_find_name( p_libvlc,
1068                                                      newval.psz_string,
1069                                                      FIND_CHILD );
1070                     vlc_object_release( p_libvlc );
1071                 }
1072                 if( !p_object )
1073                 {
1074                     /* If it's not in libvlc, look in libvlc_global (== p_this) */
1075                     p_object = vlc_object_find_name( p_this,
1076                                                      newval.psz_string,
1077                                                      FIND_CHILD );
1078                 }
1079             }
1080
1081             if( !p_object )
1082             {
1083                 return VLC_ENOOBJ;
1084             }
1085         }
1086
1087         vlc_mutex_lock( &structure_lock );
1088
1089         if( *psz_cmd == 't' )
1090         {
1091             char psz_foo[2 * MAX_DUMPSTRUCTURE_DEPTH + 1];
1092
1093             if( !p_object )
1094                 p_object = p_this->p_libvlc ? VLC_OBJECT(p_this->p_libvlc) : p_this;
1095
1096             psz_foo[0] = '|';
1097             DumpStructure( p_object, 0, psz_foo );
1098         }
1099         else if( *psz_cmd == 'v' )
1100         {
1101             int i;
1102
1103             if( !p_object )
1104                 p_object = p_this->p_libvlc ? VLC_OBJECT(p_this->p_libvlc) : p_this;
1105
1106             PrintObject( p_object, "" );
1107
1108             if( !vlc_internals( p_object )->i_vars )
1109                 printf( " `-o No variables\n" );
1110             for( i = 0; i < vlc_internals( p_object )->i_vars; i++ )
1111             {
1112                 variable_t *p_var = vlc_internals( p_object )->p_vars + i;
1113
1114                 const char *psz_type = "unknown";
1115                 switch( p_var->i_type & VLC_VAR_TYPE )
1116                 {
1117 #define MYCASE( type, nice )                \
1118                     case VLC_VAR_ ## type:  \
1119                         psz_type = nice;    \
1120                         break;
1121                     MYCASE( VOID, "void" );
1122                     MYCASE( BOOL, "bool" );
1123                     MYCASE( INTEGER, "integer" );
1124                     MYCASE( HOTKEY, "hotkey" );
1125                     MYCASE( STRING, "string" );
1126                     MYCASE( MODULE, "module" );
1127                     MYCASE( FILE, "file" );
1128                     MYCASE( DIRECTORY, "directory" );
1129                     MYCASE( VARIABLE, "variable" );
1130                     MYCASE( FLOAT, "float" );
1131                     MYCASE( TIME, "time" );
1132                     MYCASE( ADDRESS, "address" );
1133                     MYCASE( MUTEX, "mutex" );
1134                     MYCASE( LIST, "list" );
1135 #undef MYCASE
1136                 }
1137                 printf( " %c-o \"%s\" (%s",
1138                         i + 1 == vlc_internals( p_object )->i_vars ? '`' : '|',
1139                         p_var->psz_name, psz_type );
1140                 if( p_var->psz_text )
1141                     printf( ", %s", p_var->psz_text );
1142                 printf( ")" );
1143                 if( p_var->i_type & VLC_VAR_ISCOMMAND )
1144                     printf( ", command" );
1145                 if( p_var->i_entries )
1146                     printf( ", %d callbacks", p_var->i_entries );
1147                 switch( p_var->i_type & 0x00f0 )
1148                 {
1149                     case VLC_VAR_VOID:
1150                     case VLC_VAR_MUTEX:
1151                         break;
1152                     case VLC_VAR_BOOL:
1153                         printf( ": %s", p_var->val.b_bool ? "true" : "false" );
1154                         break;
1155                     case VLC_VAR_INTEGER:
1156                         printf( ": %d", p_var->val.i_int );
1157                         break;
1158                     case VLC_VAR_STRING:
1159                         printf( ": \"%s\"", p_var->val.psz_string );
1160                         break;
1161                     case VLC_VAR_FLOAT:
1162                         printf( ": %f", p_var->val.f_float );
1163                         break;
1164                     case VLC_VAR_TIME:
1165                         printf( ": %"PRIi64, (int64_t)p_var->val.i_time );
1166                         break;
1167                     case VLC_VAR_ADDRESS:
1168                         printf( ": %p", p_var->val.p_address );
1169                         break;
1170                     case VLC_VAR_LIST:
1171                         printf( ": TODO" );
1172                         break;
1173                 }
1174                 printf( "\n" );
1175             }
1176         }
1177
1178         vlc_mutex_unlock( &structure_lock );
1179
1180         if( *newval.psz_string )
1181         {
1182             vlc_object_release( p_object );
1183         }
1184     }
1185
1186     return VLC_SUCCESS;
1187 }
1188
1189 /*****************************************************************************
1190  * vlc_list_release: free a list previously allocated by vlc_list_find
1191  *****************************************************************************
1192  * This function decreases the refcount of all objects in the list and
1193  * frees the list.
1194  *****************************************************************************/
1195 void vlc_list_release( vlc_list_t *p_list )
1196 {
1197     int i_index;
1198
1199     for( i_index = 0; i_index < p_list->i_count; i_index++ )
1200     {
1201         vlc_object_release( p_list->p_values[i_index].p_object );
1202     }
1203
1204     free( p_list->p_values );
1205     free( p_list );
1206 }
1207
1208 /*****************************************************************************
1209  * dump an object. (Debug function)
1210  *****************************************************************************/
1211 void __vlc_object_dump( vlc_object_t *p_this )
1212 {
1213     vlc_mutex_lock( &structure_lock );
1214     char psz_foo[2 * MAX_DUMPSTRUCTURE_DEPTH + 1];
1215     psz_foo[0] = '|';
1216     DumpStructure( p_this, 0, psz_foo );
1217     vlc_mutex_unlock( &structure_lock );
1218 }
1219
1220 /* Following functions are local */
1221
1222 /*****************************************************************************
1223  * FindIndex: find the index of an object in an array of objects
1224  *****************************************************************************
1225  * This function assumes that p_this can be found in pp_objects. It will not
1226  * crash if p_this cannot be found, but will return a wrong value. It is your
1227  * duty to check the return value if you are not certain that the object could
1228  * be found for sure.
1229  *****************************************************************************/
1230 static int FindIndex( vlc_object_t *p_this,
1231                       vlc_object_t **pp_objects, int i_count )
1232 {
1233     int i_middle = i_count / 2;
1234
1235     if( i_count == 0 )
1236     {
1237         return 0;
1238     }
1239
1240     if( pp_objects[i_middle] == p_this )
1241     {
1242         return i_middle;
1243     }
1244
1245     if( i_count == 1 )
1246     {
1247         return 0;
1248     }
1249
1250     /* We take advantage of the sorted array */
1251     if( pp_objects[i_middle]->i_object_id < p_this->i_object_id )
1252     {
1253         return i_middle + FindIndex( p_this, pp_objects + i_middle,
1254                                              i_count - i_middle );
1255     }
1256     else
1257     {
1258         return FindIndex( p_this, pp_objects, i_middle );
1259     }
1260 }
1261
1262 static vlc_object_t * FindObject( vlc_object_t *p_this, int i_type, int i_mode )
1263 {
1264     int i;
1265     vlc_object_t *p_tmp;
1266
1267     switch( i_mode & 0x000f )
1268     {
1269     case FIND_PARENT:
1270         p_tmp = p_this->p_parent;
1271         if( p_tmp )
1272         {
1273             if( p_tmp->i_object_type == i_type )
1274             {
1275                 vlc_object_yield( p_tmp );
1276                 return p_tmp;
1277             }
1278             else
1279             {
1280                 return FindObject( p_tmp, i_type, i_mode );
1281             }
1282         }
1283         break;
1284
1285     case FIND_CHILD:
1286         for( i = vlc_internals( p_this )->i_children; i--; )
1287         {
1288             p_tmp = vlc_internals( p_this )->pp_children[i];
1289             if( p_tmp->i_object_type == i_type )
1290             {
1291                 vlc_object_yield( p_tmp );
1292                 return p_tmp;
1293             }
1294             else if( vlc_internals( p_tmp )->i_children )
1295             {
1296                 p_tmp = FindObject( p_tmp, i_type, i_mode );
1297                 if( p_tmp )
1298                 {
1299                     return p_tmp;
1300                 }
1301             }
1302         }
1303         break;
1304
1305     case FIND_ANYWHERE:
1306         /* Handled in vlc_object_find */
1307         break;
1308     }
1309
1310     return NULL;
1311 }
1312
1313 static vlc_object_t * FindObjectName( vlc_object_t *p_this,
1314                                       const char *psz_name,
1315                                       int i_mode )
1316 {
1317     int i;
1318     vlc_object_t *p_tmp;
1319
1320     switch( i_mode & 0x000f )
1321     {
1322     case FIND_PARENT:
1323         p_tmp = p_this->p_parent;
1324         if( p_tmp )
1325         {
1326             if( p_tmp->psz_object_name
1327                 && !strcmp( p_tmp->psz_object_name, psz_name ) )
1328             {
1329                 vlc_object_yield( p_tmp );
1330                 return p_tmp;
1331             }
1332             else
1333             {
1334                 return FindObjectName( p_tmp, psz_name, i_mode );
1335             }
1336         }
1337         break;
1338
1339     case FIND_CHILD:
1340         for( i = vlc_internals( p_this )->i_children; i--; )
1341         {
1342             p_tmp = vlc_internals( p_this )->pp_children[i];
1343             if( p_tmp->psz_object_name
1344                 && !strcmp( p_tmp->psz_object_name, psz_name ) )
1345             {
1346                 vlc_object_yield( p_tmp );
1347                 return p_tmp;
1348             }
1349             else if( vlc_internals( p_tmp )->i_children )
1350             {
1351                 p_tmp = FindObjectName( p_tmp, psz_name, i_mode );
1352                 if( p_tmp )
1353                 {
1354                     return p_tmp;
1355                 }
1356             }
1357         }
1358         break;
1359
1360     case FIND_ANYWHERE:
1361         /* Handled in vlc_object_find */
1362         break;
1363     }
1364
1365     return NULL;
1366 }
1367
1368
1369 static void PrintObject( vlc_object_t *p_this, const char *psz_prefix )
1370 {
1371     char psz_children[20], psz_refcount[20], psz_thread[30], psz_name[50],
1372          psz_parent[20];
1373
1374     memset( &psz_name, 0, sizeof(psz_name) );
1375     if( p_this->psz_object_name )
1376     {
1377         snprintf( psz_name, 49, " \"%s\"", p_this->psz_object_name );
1378         if( psz_name[48] )
1379             psz_name[48] = '\"';
1380     }
1381
1382     psz_children[0] = '\0';
1383     switch( vlc_internals( p_this )->i_children )
1384     {
1385         case 0:
1386             break;
1387         case 1:
1388             strcpy( psz_children, ", 1 child" );
1389             break;
1390         default:
1391             snprintf( psz_children, 19, ", %i children",
1392                       vlc_internals( p_this )->i_children );
1393             break;
1394     }
1395
1396     psz_refcount[0] = '\0';
1397     if( vlc_internals( p_this )->i_refcount > 0 )
1398         snprintf( psz_refcount, 19, ", refcount %u",
1399                   vlc_internals( p_this )->i_refcount );
1400
1401     psz_thread[0] = '\0';
1402     if( vlc_internals( p_this )->b_thread )
1403         snprintf( psz_thread, 29, " (thread %lu)",
1404                   (unsigned long)vlc_internals( p_this )->thread_id );
1405
1406     psz_parent[0] = '\0';
1407     if( p_this->p_parent )
1408         snprintf( psz_parent, 19, ", parent %i", p_this->p_parent->i_object_id );
1409
1410     printf( " %so %.8i %s%s%s%s%s%s\n", psz_prefix,
1411             p_this->i_object_id, p_this->psz_object_type,
1412             psz_name, psz_thread, psz_refcount, psz_children,
1413             psz_parent );
1414 }
1415
1416 static void DumpStructure( vlc_object_t *p_this, int i_level, char *psz_foo )
1417 {
1418     int i;
1419     char i_back = psz_foo[i_level];
1420     psz_foo[i_level] = '\0';
1421
1422     PrintObject( p_this, psz_foo );
1423
1424     psz_foo[i_level] = i_back;
1425
1426     if( i_level / 2 >= MAX_DUMPSTRUCTURE_DEPTH )
1427     {
1428         msg_Warn( p_this, "structure tree is too deep" );
1429         return;
1430     }
1431
1432     for( i = 0 ; i < vlc_internals( p_this )->i_children ; i++ )
1433     {
1434         if( i_level )
1435         {
1436             psz_foo[i_level-1] = ' ';
1437
1438             if( psz_foo[i_level-2] == '`' )
1439             {
1440                 psz_foo[i_level-2] = ' ';
1441             }
1442         }
1443
1444         if( i == vlc_internals( p_this )->i_children - 1 )
1445         {
1446             psz_foo[i_level] = '`';
1447         }
1448         else
1449         {
1450             psz_foo[i_level] = '|';
1451         }
1452
1453         psz_foo[i_level+1] = '-';
1454         psz_foo[i_level+2] = '\0';
1455
1456         DumpStructure( vlc_internals( p_this )->pp_children[i], i_level + 2,
1457                        psz_foo );
1458     }
1459 }
1460
1461 static vlc_list_t * NewList( int i_count )
1462 {
1463     vlc_list_t * p_list = (vlc_list_t *)malloc( sizeof( vlc_list_t ) );
1464     if( p_list == NULL )
1465     {
1466         return NULL;
1467     }
1468
1469     p_list->i_count = i_count;
1470
1471     if( i_count == 0 )
1472     {
1473         p_list->p_values = NULL;
1474         return p_list;
1475     }
1476
1477     p_list->p_values = malloc( i_count * sizeof( vlc_value_t ) );
1478     if( p_list->p_values == NULL )
1479     {
1480         p_list->i_count = 0;
1481         return p_list;
1482     }
1483
1484     return p_list;
1485 }
1486
1487 static void ListReplace( vlc_list_t *p_list, vlc_object_t *p_object,
1488                          int i_index )
1489 {
1490     if( p_list == NULL || i_index >= p_list->i_count )
1491     {
1492         return;
1493     }
1494
1495     vlc_object_yield( p_object );
1496
1497     p_list->p_values[i_index].p_object = p_object;
1498
1499     return;
1500 }
1501
1502 /*static void ListAppend( vlc_list_t *p_list, vlc_object_t *p_object )
1503 {
1504     if( p_list == NULL )
1505     {
1506         return;
1507     }
1508
1509     p_list->p_values = realloc( p_list->p_values, (p_list->i_count + 1)
1510                                 * sizeof( vlc_value_t ) );
1511     if( p_list->p_values == NULL )
1512     {
1513         p_list->i_count = 0;
1514         return;
1515     }
1516
1517     vlc_object_yield( p_object );
1518
1519     p_list->p_values[p_list->i_count].p_object = p_object;
1520     p_list->i_count++;
1521
1522     return;
1523 }*/
1524
1525 static int CountChildren( vlc_object_t *p_this, int i_type )
1526 {
1527     vlc_object_t *p_tmp;
1528     int i, i_count = 0;
1529
1530     for( i = 0; i < vlc_internals( p_this )->i_children; i++ )
1531     {
1532         p_tmp = vlc_internals( p_this )->pp_children[i];
1533
1534         if( p_tmp->i_object_type == i_type )
1535         {
1536             i_count++;
1537         }
1538         i_count += CountChildren( p_tmp, i_type );
1539     }
1540
1541     return i_count;
1542 }
1543
1544 static void ListChildren( vlc_list_t *p_list, vlc_object_t *p_this, int i_type )
1545 {
1546     vlc_object_t *p_tmp;
1547     int i;
1548
1549     for( i = 0; i < vlc_internals( p_this )->i_children; i++ )
1550     {
1551         p_tmp = vlc_internals( p_this )->pp_children[i];
1552
1553         if( p_tmp->i_object_type == i_type )
1554             ListReplace( p_list, p_tmp, p_list->i_count++ );
1555
1556         ListChildren( p_list, p_tmp, i_type );
1557     }
1558 }