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  *
   6  * Authors: Samuel Hocevar <sam@zoy.org>
   7  *
   8  * This program is free software; you can redistribute it and/or modify
   9  * it under the terms of the GNU General Public License as published by
  10  * the Free Software Foundation; either version 2 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 General Public License for more details.
  17  *
  18  * You should have received a copy of the GNU General Public License
  19  * along with this program; if not, write to the Free Software
  20  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
  21  *****************************************************************************/
  22
  23 /**
  24  * \file
  25  * This file contains the functions to handle the vlc_object_t type
  26  *
  27  * Unless otherwise stated, functions in this file are not cancellation point.
  28  * All functions in this file are safe w.r.t. deferred cancellation.
  29  */
  30
  31
  32 /*****************************************************************************
  33  * Preamble
  34  *****************************************************************************/
  35 #ifdef HAVE_CONFIG_H
  36 # include "config.h"
  37 #endif
  38
  39 #include <vlc_common.h>
  40
  41 #include "../libvlc.h"
  42 #include <vlc_aout.h>
  43 #include "audio_output/aout_internal.h"
  44
  45 #include "vlc_interface.h"
  46 #include "vlc_codec.h"
  47
  48 #include "variables.h"
  49 #ifndef WIN32
  50 # include <unistd.h>
  51 #else
  52 # include <io.h>
  53 # include <fcntl.h>
  54 # include <errno.h> /* ENOSYS */
  55 #endif
  56
  57 #include <limits.h>
  58 #include <assert.h>
  59
  60 #if defined (HAVE_SYS_EVENTFD_H)
  61 # include <sys/eventfd.h>
  62 #endif
  63
  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
  76 static vlc_list_t   * NewList       ( int );
  77 static void           ListReplace   ( vlc_list_t *, vlc_object_t *, int );
  78 /*static void           ListAppend    ( vlc_list_t *, vlc_object_t * );*/
  79 static int            CountChildren ( vlc_object_t *, int );
  80 static void           ListChildren  ( vlc_list_t *, vlc_object_t *, int );
  81
  82 static void vlc_object_destroy( vlc_object_t *p_this );
  83 static void vlc_object_detach_unlocked (vlc_object_t *p_this);
  84
  85 /*****************************************************************************
  86  * Local structure lock
  87  *****************************************************************************/
  88 static void libvlc_lock (libvlc_int_t *p_libvlc)
  89 {
  90     vlc_mutex_lock (&(libvlc_priv (p_libvlc)->structure_lock));
  91 }
  92
  93 static void libvlc_unlock (libvlc_int_t *p_libvlc)
  94 {
  95     vlc_mutex_unlock (&(libvlc_priv (p_libvlc)->structure_lock));
  96 }
  97
  98 void *__vlc_custom_create( vlc_object_t *p_this, size_t i_size,
  99                            int i_type, const char *psz_type )
 100 {
 101     vlc_object_t *p_new;
 102     vlc_object_internals_t *p_priv;
 103
 104     /* NOTE:
 105      * VLC objects are laid out as follow:
 106      * - first the LibVLC-private per-object data,
 107      * - then VLC_COMMON members from vlc_object_t,
 108      * - finally, the type-specific data (if any).
 109      *
 110      * This function initializes the LibVLC and common data,
 111      * and zeroes the rest.
 112      */
 113     p_priv = calloc( 1, sizeof( *p_priv ) + i_size );
 114     if( p_priv == NULL )
 115         return NULL;
 116
 117     assert (i_size >= sizeof (vlc_object_t));
 118     p_new = (vlc_object_t *)(p_priv + 1);
 119
 120     p_priv->i_object_type = i_type;
 121     p_new->psz_object_type = psz_type;
 122     p_priv->psz_name = NULL;
 123
 124     p_new->b_die = false;
 125     p_new->b_error = false;
 126     p_new->b_force = false;
 127
 128     p_new->psz_header = NULL;
 129
 130     if (p_this)
 131         p_new->i_flags = p_this->i_flags
 132             & (OBJECT_FLAGS_NODBG|OBJECT_FLAGS_QUIET|OBJECT_FLAGS_NOINTERACT);
 133
 134     p_priv->p_vars = calloc( 16, sizeof( variable_t ) );
 135
 136     if( !p_priv->p_vars )
 137     {
 138         free( p_priv );
 139         return NULL;
 140     }
 141
 142     if( p_this == NULL )
 143     {
 144         libvlc_int_t *self = (libvlc_int_t*)p_new;
 145         p_new->p_libvlc = self;
 146         vlc_mutex_init (&(libvlc_priv (self)->structure_lock));
 147         p_this = p_new;
 148     }
 149     else
 150         p_new->p_libvlc = p_this->p_libvlc;
 151
 152     vlc_spin_init( &p_priv->ref_spin );
 153     p_priv->i_refcount = 1;
 154     p_priv->pf_destructor = NULL;
 155     p_priv->b_thread = false;
 156     p_new->p_parent = NULL;
 157     p_priv->pp_children = NULL;
 158     p_priv->i_children = 0;
 159
 160     /* Initialize mutexes and condvars */
 161     vlc_mutex_init( &p_priv->var_lock );
 162     vlc_cond_init( &p_priv->var_wait );
 163     p_priv->pipes[0] = p_priv->pipes[1] = -1;
 164
 165     if (p_new == VLC_OBJECT(p_new->p_libvlc))
 166     {   /* TODO: should be in src/libvlc.c */
 167         int canc = vlc_savecancel ();
 168         var_Create( p_new, "tree", VLC_VAR_STRING | VLC_VAR_ISCOMMAND );
 169         var_AddCallback( p_new, "tree", DumpCommand, NULL );
 170         var_Create( p_new, "vars", VLC_VAR_STRING | VLC_VAR_ISCOMMAND );
 171         var_AddCallback( p_new, "vars", DumpCommand, NULL );
 172         vlc_restorecancel (canc);
 173     }
 174
 175     return p_new;
 176 }
 177
 178
 179 /**
 180  * Allocates and initializes a vlc object.
 181  *
 182  * @param i_type known object type (all of them are negative integer values),
 183  *               or object byte size (always positive).
 184  *
 185  * @return the new object, or NULL on error.
 186  */
 187 void * __vlc_object_create( vlc_object_t *p_this, int i_type )
 188 {
 189     const char   * psz_type;
 190     size_t         i_size;
 191
 192     switch( i_type )
 193     {
 194         case VLC_OBJECT_DECODER:
 195             i_size = sizeof(decoder_t);
 196             psz_type = "decoder";
 197             break;
 198         case VLC_OBJECT_AOUT:
 199             i_size = sizeof(aout_instance_t);
 200             psz_type = "audio output";
 201             break;
 202         default:
 203             assert( i_type > 0 ); /* unknown type?! */
 204             i_size = i_type;
 205             i_type = VLC_OBJECT_GENERIC;
 206             psz_type = "generic";
 207             break;
 208     }
 209
 210     return vlc_custom_create( p_this, i_size, i_type, psz_type );
 211 }
 212
 213
 214 /**
 215  ****************************************************************************
 216  * Set the destructor of a vlc object
 217  *
 218  * This function sets the destructor of the vlc object. It will be called
 219  * when the object is destroyed when the its refcount reaches 0.
 220  * (It is called by the internal function vlc_object_destroy())
 221  *****************************************************************************/
 222 void __vlc_object_set_destructor( vlc_object_t *p_this,
 223                                   vlc_destructor_t pf_destructor )
 224 {
 225     vlc_object_internals_t *p_priv = vlc_internals(p_this );
 226
 227     vlc_spin_lock( &p_priv->ref_spin );
 228     p_priv->pf_destructor = pf_destructor;
 229     vlc_spin_unlock( &p_priv->ref_spin );
 230 }
 231
 232 static vlc_mutex_t name_lock = VLC_STATIC_MUTEX;
 233
 234 #undef vlc_object_set_name
 235 int vlc_object_set_name(vlc_object_t *obj, const char *name)
 236 {
 237     vlc_object_internals_t *priv = vlc_internals(obj);
 238     char *newname = name ? strdup (name) : NULL;
 239     char *oldname;
 240
 241     vlc_mutex_lock (&name_lock);
 242     oldname = priv->psz_name;
 243     priv->psz_name = newname;
 244     vlc_mutex_unlock (&name_lock);
 245
 246     free (oldname);
 247     return (priv->psz_name || !name) ? VLC_SUCCESS : VLC_ENOMEM;
 248 }
 249
 250 #undef vlc_object_get_name
 251 char *vlc_object_get_name(const vlc_object_t *obj)
 252 {
 253     vlc_object_internals_t *priv = vlc_internals(obj);
 254     char *name;
 255
 256     vlc_mutex_lock (&name_lock);
 257     name = priv->psz_name ? strdup (priv->psz_name) : NULL;
 258     vlc_mutex_unlock (&name_lock);
 259
 260     return name;
 261 }
 262
 263 /**
 264  ****************************************************************************
 265  * Destroy a vlc object (Internal)
 266  *
 267  * This function destroys an object that has been previously allocated with
 268  * vlc_object_create. The object's refcount must be zero and it must not be
 269  * attached to other objects in any way.
 270  *
 271  * This function must be called with cancellation disabled (currently).
 272  *****************************************************************************/
 273 static void vlc_object_destroy( vlc_object_t *p_this )
 274 {
 275     vlc_object_internals_t *p_priv = vlc_internals( p_this );
 276
 277     /* Objects are always detached beforehand */
 278     assert( !p_this->p_parent );
 279
 280     /* Send a kill to the object's thread if applicable */
 281     vlc_object_kill( p_this );
 282
 283     /* Call the custom "subclass" destructor */
 284     if( p_priv->pf_destructor )
 285         p_priv->pf_destructor( p_this );
 286
 287     /* Any thread must have been cleaned up at this point. */
 288     assert( !p_priv->b_thread );
 289
 290     /* Destroy the associated variables, starting from the end so that
 291      * no memmove calls have to be done. */
 292     while( p_priv->i_vars )
 293     {
 294         var_Destroy( p_this, p_priv->p_vars[p_priv->i_vars - 1].psz_name );
 295     }
 296
 297     free( p_priv->p_vars );
 298     vlc_cond_destroy( &p_priv->var_wait );
 299     vlc_mutex_destroy( &p_priv->var_lock );
 300
 301     free( p_this->psz_header );
 302
 303     free( p_priv->psz_name );
 304
 305     vlc_spin_destroy( &p_priv->ref_spin );
 306     if( p_priv->pipes[1] != -1 && p_priv->pipes[1] != p_priv->pipes[0] )
 307         close( p_priv->pipes[1] );
 308     if( p_priv->pipes[0] != -1 )
 309         close( p_priv->pipes[0] );
 310     if( VLC_OBJECT(p_this->p_libvlc) == p_this )
 311         vlc_mutex_destroy (&(libvlc_priv ((libvlc_int_t *)p_this)->structure_lock));
 312
 313     free( p_priv );
 314 }
 315
 316
 317 #ifdef WIN32
 318 # include <winsock2.h>
 319 # include <ws2tcpip.h>
 320
 321 /**
 322  * select()-able pipes emulated using Winsock
 323  */
 324 static int pipe (int fd[2])
 325 {
 326     SOCKADDR_IN addr;
 327     int addrlen = sizeof (addr);
 328
 329     SOCKET l = socket (PF_INET, SOCK_STREAM, IPPROTO_TCP), a,
 330            c = socket (PF_INET, SOCK_STREAM, IPPROTO_TCP);
 331     if ((l == INVALID_SOCKET) || (c == INVALID_SOCKET))
 332         goto error;
 333
 334     memset (&addr, 0, sizeof (addr));
 335     addr.sin_family = AF_INET;
 336     addr.sin_addr.s_addr = htonl (INADDR_LOOPBACK);
 337     if (bind (l, (PSOCKADDR)&addr, sizeof (addr))
 338      || getsockname (l, (PSOCKADDR)&addr, &addrlen)
 339      || listen (l, 1)
 340      || connect (c, (PSOCKADDR)&addr, addrlen))
 341         goto error;
 342
 343     a = accept (l, NULL, NULL);
 344     if (a == INVALID_SOCKET)
 345         goto error;
 346
 347     closesocket (l);
 348     //shutdown (a, 0);
 349     //shutdown (c, 1);
 350     fd[0] = c;
 351     fd[1] = a;
 352     return 0;
 353
 354 error:
 355     if (l != INVALID_SOCKET)
 356         closesocket (l);
 357     if (c != INVALID_SOCKET)
 358         closesocket (c);
 359     return -1;
 360 }
 361
 362 #undef  read
 363 #define read( a, b, c )  recv (a, b, c, 0)
 364 #undef  write
 365 #define write( a, b, c ) send (a, b, c, 0)
 366 #undef  close
 367 #define close( a )       closesocket (a)
 368 #endif /* WIN32 */
 369
 370 static vlc_mutex_t pipe_lock = VLC_STATIC_MUTEX;
 371
 372 /**
 373  * Returns the readable end of a pipe that becomes readable once termination
 374  * of the object is requested (vlc_object_kill()).
 375  * This can be used to wake-up out of a select() or poll() event loop, such
 376  * typically when doing network I/O.
 377  *
 378  * Note that the pipe will remain the same for the lifetime of the object.
 379  * DO NOT read the pipe nor close it yourself. Ever.
 380  *
 381  * @param obj object that would be "killed"
 382  * @return a readable pipe descriptor, or -1 on error.
 383  */
 384 int vlc_object_waitpipe( vlc_object_t *obj )
 385 {
 386     vlc_object_internals_t *internals = vlc_internals( obj );
 387
 388     vlc_mutex_lock (&pipe_lock);
 389     if (internals->pipes[0] == -1)
 390     {
 391         /* This can only ever happen if someone killed us without locking: */
 392         assert (internals->pipes[1] == -1);
 393
 394 #if defined (HAVE_SYS_EVENTFD_H)
 395         internals->pipes[0] = internals->pipes[1] = eventfd (0, 0);
 396         if (internals->pipes[0] == -1)
 397 #endif
 398         {
 399             if (pipe (internals->pipes))
 400                 internals->pipes[0] = internals->pipes[1] = -1;
 401         }
 402
 403         if (internals->pipes[0] != -1 && obj->b_die)
 404         {   /* Race condition: vlc_object_kill() already invoked! */
 405             msg_Dbg (obj, "waitpipe: object already dying");
 406             write (internals->pipes[1], &(uint64_t){ 1 }, sizeof (uint64_t));
 407         }
 408     }
 409     vlc_mutex_unlock (&pipe_lock);
 410     return internals->pipes[0];
 411 }
 412
 413
 414 /**
 415  * Requests termination of an object, cancels the object thread, and make the
 416  * object wait pipe (if it exists) readable. Not a cancellation point.
 417  */
 418 void __vlc_object_kill( vlc_object_t *p_this )
 419 {
 420     vlc_object_internals_t *priv = vlc_internals( p_this );
 421     int fd = -1;
 422
 423     vlc_thread_cancel( p_this );
 424     vlc_mutex_lock( &pipe_lock );
 425     if( !p_this->b_die )
 426     {
 427         fd = priv->pipes[1];
 428         p_this->b_die = true;
 429     }
 430
 431     /* This also serves as a memory barrier toward vlc_object_alive(): */
 432     vlc_mutex_unlock( &pipe_lock );
 433
 434     if (fd != -1)
 435     {
 436         int canc = vlc_savecancel ();
 437
 438         /* write _after_ setting b_die, so vlc_object_alive() returns false */
 439         write (fd, &(uint64_t){ 1 }, sizeof (uint64_t));
 440         msg_Dbg (p_this, "waitpipe: object killed");
 441         vlc_restorecancel (canc);
 442     }
 443 }
 444
 445
 446 /*****************************************************************************
 447  * find a typed object and increment its refcount
 448  *****************************************************************************
 449  * This function recursively looks for a given object type. i_mode can be one
 450  * of FIND_PARENT, FIND_CHILD or FIND_ANYWHERE.
 451  *****************************************************************************/
 452 void * __vlc_object_find( vlc_object_t *p_this, int i_type, int i_mode )
 453 {
 454     vlc_object_t *p_found;
 455
 456     /* If we are of the requested type ourselves, don't look further */
 457     if( !(i_mode & FIND_STRICT)
 458      && vlc_internals (p_this)->i_object_type == i_type )
 459     {
 460         vlc_object_hold( p_this );
 461         return p_this;
 462     }
 463
 464     /* Otherwise, recursively look for the object */
 465     if ((i_mode & 0x000f) == FIND_ANYWHERE)
 466         return vlc_object_find (p_this->p_libvlc, i_type,
 467                                 (i_mode & ~0x000f)|FIND_CHILD);
 468
 469     libvlc_lock (p_this->p_libvlc);
 470     p_found = FindObject( p_this, i_type, i_mode );
 471     libvlc_unlock (p_this->p_libvlc);
 472     return p_found;
 473 }
 474
 475
 476 static int objnamecmp(const vlc_object_t *obj, const char *name)
 477 {
 478     char *objname = vlc_object_get_name(obj);
 479     if (objname == NULL)
 480         return INT_MIN;
 481
 482     int ret = strcmp (objname, name);
 483     free (objname);
 484     return ret;
 485 }
 486
 487 #undef vlc_object_find_name
 488 /**
 489  * Finds a named object and increment its reference count.
 490  * Beware that objects found in this manner can be "owned" by another thread,
 491  * be of _any_ type, and be attached to any module (if any). With such an
 492  * object reference, you can set or get object variables, emit log messages,
 493  * and read write-once object parameters (psz_object_type, etc).
 494  * You CANNOT cast the object to a more specific object type, and you
 495  * definitely cannot invoke object type-specific callbacks with this.
 496  *
 497  * @param p_this object to search from
 498  * @param psz_name name of the object to search for
 499  * @param i_mode search direction: FIND_PARENT, FIND_CHILD or FIND_ANYWHERE.
 500  *
 501  * @return a matching object (must be released by the caller),
 502  * or NULL on error.
 503  */
 504 vlc_object_t *vlc_object_find_name( vlc_object_t *p_this,
 505                                     const char *psz_name, int i_mode )
 506 {
 507     vlc_object_t *p_found;
 508
 509     /* Reading psz_object_name from a separate inhibits thread-safety.
 510      * Use a libvlc address variable instead for that sort of things! */
 511     msg_Warn( p_this, "%s(%s) is not safe!", __func__, psz_name );
 512     /* If have the requested name ourselves, don't look further */
 513     if( !(i_mode & FIND_STRICT) && !objnamecmp(p_this, psz_name) )
 514     {
 515         vlc_object_hold( p_this );
 516         return p_this;
 517     }
 518
 519     libvlc_lock (p_this->p_libvlc);
 520
 521     /* Otherwise, recursively look for the object */
 522     if( (i_mode & 0x000f) == FIND_ANYWHERE )
 523     {
 524         vlc_object_t *p_root = p_this;
 525
 526         /* Find the root */
 527         while( p_root->p_parent != NULL &&
 528                p_root != VLC_OBJECT( p_this->p_libvlc ) )
 529         {
 530             p_root = p_root->p_parent;
 531         }
 532
 533         p_found = FindObjectName( p_root, psz_name,
 534                                  (i_mode & ~0x000f)|FIND_CHILD );
 535         if( p_found == NULL && p_root != VLC_OBJECT( p_this->p_libvlc ) )
 536         {
 537             p_found = FindObjectName( VLC_OBJECT( p_this->p_libvlc ),
 538                                       psz_name, (i_mode & ~0x000f)|FIND_CHILD );
 539         }
 540     }
 541     else
 542     {
 543         p_found = FindObjectName( p_this, psz_name, i_mode );
 544     }
 545
 546     libvlc_unlock (p_this->p_libvlc);
 547     return p_found;
 548 }
 549
 550 /**
 551  * Increment an object reference counter.
 552  */
 553 void * __vlc_object_hold( vlc_object_t *p_this )
 554 {
 555     vlc_object_internals_t *internals = vlc_internals( p_this );
 556
 557     vlc_spin_lock( &internals->ref_spin );
 558     /* Avoid obvious freed object uses */
 559     assert( internals->i_refcount > 0 );
 560     /* Increment the counter */
 561     internals->i_refcount++;
 562     vlc_spin_unlock( &internals->ref_spin );
 563     return p_this;
 564 }
 565
 566 /*****************************************************************************
 567  * Decrement an object refcount
 568  * And destroy the object if its refcount reach zero.
 569  *****************************************************************************/
 570 void __vlc_object_release( vlc_object_t *p_this )
 571 {
 572     vlc_object_internals_t *internals = vlc_internals( p_this );
 573     vlc_object_t *parent = NULL;
 574     bool b_should_destroy;
 575
 576     vlc_spin_lock( &internals->ref_spin );
 577     assert( internals->i_refcount > 0 );
 578
 579     if( internals->i_refcount > 1 )
 580     {
 581         /* Fast path */
 582         /* There are still other references to the object */
 583         internals->i_refcount--;
 584         vlc_spin_unlock( &internals->ref_spin );
 585         return;
 586     }
 587     vlc_spin_unlock( &internals->ref_spin );
 588
 589     /* Slow path */
 590     /* Remember that we cannot hold the spin while waiting on the mutex */
 591     libvlc_lock (p_this->p_libvlc);
 592     /* Take the spin again. Note that another thread may have held the
 593      * object in the (very short) mean time. */
 594     vlc_spin_lock( &internals->ref_spin );
 595     b_should_destroy = --internals->i_refcount == 0;
 596     vlc_spin_unlock( &internals->ref_spin );
 597
 598     if( b_should_destroy )
 599     {
 600         parent = p_this->p_parent;
 601         if (parent)
 602             /* Detach from parent to protect against FIND_CHILDREN */
 603             vlc_object_detach_unlocked (p_this);
 604
 605         /* We have no children */
 606         assert (internals->i_children == 0);
 607     }
 608     libvlc_unlock (p_this->p_libvlc);
 609
 610     if( b_should_destroy )
 611     {
 612         int canc;
 613
 614         canc = vlc_savecancel ();
 615         vlc_object_destroy( p_this );
 616         vlc_restorecancel (canc);
 617         if (parent)
 618             vlc_object_release (parent);
 619     }
 620 }
 621
 622 /**
 623  ****************************************************************************
 624  * attach object to a parent object
 625  *****************************************************************************
 626  * This function sets p_this as a child of p_parent, and p_parent as a parent
 627  * of p_this. This link can be undone using vlc_object_detach.
 628  *****************************************************************************/
 629 void __vlc_object_attach( vlc_object_t *p_this, vlc_object_t *p_parent )
 630 {
 631     if( !p_this ) return;
 632
 633     vlc_object_hold (p_parent);
 634     libvlc_lock (p_this->p_libvlc);
 635
 636     /* Attach the parent to its child */
 637     assert (!p_this->p_parent);
 638     p_this->p_parent = p_parent;
 639
 640     /* Attach the child to its parent */
 641     vlc_object_internals_t *priv = vlc_internals( p_parent );
 642     INSERT_ELEM( priv->pp_children, priv->i_children, priv->i_children,
 643                  p_this );
 644     libvlc_unlock (p_this->p_libvlc);
 645 }
 646
 647
 648 static void vlc_object_detach_unlocked (vlc_object_t *p_this)
 649 {
 650     if (p_this->p_parent == NULL)
 651         return;
 652
 653     vlc_object_internals_t *priv = vlc_internals( p_this->p_parent );
 654
 655     int i_index, i;
 656
 657     /* Remove p_this's parent */
 658     p_this->p_parent = NULL;
 659
 660     /* Remove all of p_parent's children which are p_this */
 661     for( i_index = priv->i_children ; i_index-- ; )
 662     {
 663         if( priv->pp_children[i_index] == p_this )
 664         {
 665             priv->i_children--;
 666             for( i = i_index ; i < priv->i_children ; i++ )
 667                 priv->pp_children[i] = priv->pp_children[i+1];
 668         }
 669     }
 670
 671     if( priv->i_children )
 672     {
 673         vlc_object_t **pp_children = (vlc_object_t **)
 674             realloc( priv->pp_children,
 675                      priv->i_children * sizeof(vlc_object_t *) );
 676         if( pp_children )
 677             priv->pp_children = pp_children;
 678     }
 679     else
 680     {
 681         /* Special case - don't realloc() to zero to avoid leaking */
 682         free( priv->pp_children );
 683         priv->pp_children = NULL;
 684     }
 685 }
 686
 687
 688 /**
 689  ****************************************************************************
 690  * detach object from its parent
 691  *****************************************************************************
 692  * This function removes all links between an object and its parent.
 693  *****************************************************************************/
 694 void __vlc_object_detach( vlc_object_t *p_this )
 695 {
 696     vlc_object_t *p_parent;
 697     if( !p_this ) return;
 698
 699     libvlc_lock (p_this->p_libvlc);
 700     p_parent = p_this->p_parent;
 701     if (p_parent)
 702         vlc_object_detach_unlocked( p_this );
 703     libvlc_unlock (p_this->p_libvlc);
 704
 705     if (p_parent)
 706         vlc_object_release (p_parent);
 707 }
 708
 709
 710 /**
 711  ****************************************************************************
 712  * find a list typed objects and increment their refcount
 713  *****************************************************************************
 714  * This function recursively looks for a given object type. i_mode can be one
 715  * of FIND_PARENT, FIND_CHILD or FIND_ANYWHERE.
 716  *****************************************************************************/
 717 vlc_list_t * vlc_list_find( vlc_object_t *p_this, int i_type, int i_mode )
 718 {
 719     vlc_list_t *p_list;
 720     int i_count = 0;
 721
 722     /* Look for the objects */
 723     switch( i_mode & 0x000f )
 724     {
 725     case FIND_ANYWHERE:
 726         return vlc_list_find (VLC_OBJECT(p_this->p_libvlc), i_type, FIND_CHILD);
 727
 728     case FIND_CHILD:
 729         libvlc_lock (p_this->p_libvlc);
 730         i_count = CountChildren( p_this, i_type );
 731         p_list = NewList( i_count );
 732
 733         /* Check allocation was successful */
 734         if( p_list->i_count != i_count )
 735         {
 736             libvlc_unlock (p_this->p_libvlc);
 737             p_list->i_count = 0;
 738             break;
 739         }
 740
 741         p_list->i_count = 0;
 742         ListChildren( p_list, p_this, i_type );
 743         libvlc_unlock (p_this->p_libvlc);
 744         break;
 745
 746     default:
 747         msg_Err( p_this, "unimplemented!" );
 748         p_list = NewList( 0 );
 749         break;
 750     }
 751
 752     return p_list;
 753 }
 754
 755 /**
 756  * Gets the list of children of an objects, and increment their reference
 757  * count.
 758  * @return a list (possibly empty) or NULL in case of error.
 759  */
 760 vlc_list_t *__vlc_list_children( vlc_object_t *obj )
 761 {
 762     vlc_list_t *l;
 763     vlc_object_internals_t *priv = vlc_internals( obj );
 764
 765     libvlc_lock (obj->p_libvlc);
 766     l = NewList( priv->i_children );
 767     for (int i = 0; i < l->i_count; i++)
 768     {
 769         vlc_object_hold( priv->pp_children[i] );
 770         l->p_values[i].p_object = priv->pp_children[i];
 771     }
 772     libvlc_unlock (obj->p_libvlc);
 773     return l;
 774 }
 775
 776 /*****************************************************************************
 777  * DumpCommand: print the current vlc structure
 778  *****************************************************************************
 779  * This function prints either an ASCII tree showing the connections between
 780  * vlc objects, and additional information such as their refcount, thread ID,
 781  * etc. (command "tree"), or the same data as a simple list (command "list").
 782  *****************************************************************************/
 783 static int DumpCommand( vlc_object_t *p_this, char const *psz_cmd,
 784                         vlc_value_t oldval, vlc_value_t newval, void *p_data )
 785 {
 786     (void)oldval; (void)p_data;
 787     vlc_object_t *p_object = NULL;
 788
 789     if( *newval.psz_string )
 790     {
 791         /* try using the object's name to find it */
 792         p_object = vlc_object_find_name( p_this, newval.psz_string,
 793                                          FIND_ANYWHERE );
 794         if( !p_object )
 795         {
 796             return VLC_ENOOBJ;
 797         }
 798     }
 799
 800     libvlc_lock (p_this->p_libvlc);
 801     if( *psz_cmd == 't' )
 802     {
 803         char psz_foo[2 * MAX_DUMPSTRUCTURE_DEPTH + 1];
 804
 805         if( !p_object )
 806             p_object = VLC_OBJECT(p_this->p_libvlc);
 807
 808         psz_foo[0] = '|';
 809         DumpStructure( p_object, 0, psz_foo );
 810     }
 811     else if( *psz_cmd == 'v' )
 812     {
 813         int i;
 814
 815         if( !p_object )
 816             p_object = p_this->p_libvlc ? VLC_OBJECT(p_this->p_libvlc) : p_this;
 817
 818         PrintObject( p_object, "" );
 819
 820         vlc_mutex_lock( &vlc_internals( p_object )->var_lock );
 821         if( !vlc_internals( p_object )->i_vars )
 822             printf( " `-o No variables\n" );
 823         for( i = 0; i < vlc_internals( p_object )->i_vars; i++ )
 824         {
 825             variable_t *p_var = vlc_internals( p_object )->p_vars + i;
 826             const char *psz_type = "unknown";
 827
 828             switch( p_var->i_type & VLC_VAR_TYPE )
 829             {
 830 #define MYCASE( type, nice )                \
 831                 case VLC_VAR_ ## type:  \
 832                     psz_type = nice;    \
 833                     break;
 834                 MYCASE( VOID, "void" );
 835                 MYCASE( BOOL, "bool" );
 836                 MYCASE( INTEGER, "integer" );
 837                 MYCASE( HOTKEY, "hotkey" );
 838                 MYCASE( STRING, "string" );
 839                 MYCASE( MODULE, "module" );
 840                 MYCASE( FILE, "file" );
 841                 MYCASE( DIRECTORY, "directory" );
 842                 MYCASE( VARIABLE, "variable" );
 843                 MYCASE( FLOAT, "float" );
 844                 MYCASE( TIME, "time" );
 845                 MYCASE( ADDRESS, "address" );
 846                 MYCASE( MUTEX, "mutex" );
 847                 MYCASE( LIST, "list" );
 848 #undef MYCASE
 849             }
 850             printf( " %c-o \"%s\" (%s",
 851                     i + 1 == vlc_internals( p_object )->i_vars ? '`' : '|',
 852                     p_var->psz_name, psz_type );
 853             if( p_var->psz_text )
 854                 printf( ", %s", p_var->psz_text );
 855             printf( ")" );
 856             if( p_var->i_type & VLC_VAR_HASCHOICE )
 857                 printf( ", has choices" );
 858             if( p_var->i_type & VLC_VAR_ISCOMMAND )
 859                 printf( ", command" );
 860             if( p_var->i_entries )
 861                 printf( ", %d callbacks", p_var->i_entries );
 862             switch( p_var->i_type & VLC_VAR_CLASS )
 863             {
 864                 case VLC_VAR_VOID:
 865                 case VLC_VAR_MUTEX:
 866                     break;
 867                 case VLC_VAR_BOOL:
 868                     printf( ": %s", p_var->val.b_bool ? "true" : "false" );
 869                     break;
 870                 case VLC_VAR_INTEGER:
 871                     printf( ": %d", p_var->val.i_int );
 872                     break;
 873                 case VLC_VAR_STRING:
 874                     printf( ": \"%s\"", p_var->val.psz_string );
 875                     break;
 876                 case VLC_VAR_FLOAT:
 877                     printf( ": %f", p_var->val.f_float );
 878                     break;
 879                 case VLC_VAR_TIME:
 880                     printf( ": %"PRIi64, (int64_t)p_var->val.i_time );
 881                     break;
 882                 case VLC_VAR_ADDRESS:
 883                     printf( ": %p", p_var->val.p_address );
 884                     break;
 885                 case VLC_VAR_LIST:
 886                     printf( ": TODO" );
 887                     break;
 888             }
 889             printf( "\n" );
 890         }
 891         vlc_mutex_unlock( &vlc_internals( p_object )->var_lock );
 892     }
 893     libvlc_unlock (p_this->p_libvlc);
 894
 895     if( *newval.psz_string )
 896     {
 897         vlc_object_release( p_object );
 898     }
 899     return VLC_SUCCESS;
 900 }
 901
 902 /*****************************************************************************
 903  * vlc_list_release: free a list previously allocated by vlc_list_find
 904  *****************************************************************************
 905  * This function decreases the refcount of all objects in the list and
 906  * frees the list.
 907  *****************************************************************************/
 908 void vlc_list_release( vlc_list_t *p_list )
 909 {
 910     int i_index;
 911
 912     for( i_index = 0; i_index < p_list->i_count; i_index++ )
 913     {
 914         vlc_object_release( p_list->p_values[i_index].p_object );
 915     }
 916
 917     free( p_list->p_values );
 918     free( p_list );
 919 }
 920
 921 /* Following functions are local */
 922
 923 static vlc_object_t * FindObject( vlc_object_t *p_this, int i_type, int i_mode )
 924 {
 925     int i;
 926     vlc_object_t *p_tmp;
 927
 928     switch( i_mode & 0x000f )
 929     {
 930     case FIND_PARENT:
 931         p_tmp = p_this->p_parent;
 932         if( p_tmp )
 933         {
 934             if( vlc_internals( p_tmp )->i_object_type == i_type )
 935             {
 936                 vlc_object_hold( p_tmp );
 937                 return p_tmp;
 938             }
 939             else
 940             {
 941                 return FindObject( p_tmp, i_type, i_mode );
 942             }
 943         }
 944         break;
 945
 946     case FIND_CHILD:
 947         for( i = vlc_internals( p_this )->i_children; i--; )
 948         {
 949             p_tmp = vlc_internals( p_this )->pp_children[i];
 950             if( vlc_internals( p_tmp )->i_object_type == i_type )
 951             {
 952                 vlc_object_hold( p_tmp );
 953                 return p_tmp;
 954             }
 955             else if( vlc_internals( p_tmp )->i_children )
 956             {
 957                 p_tmp = FindObject( p_tmp, i_type, i_mode );
 958                 if( p_tmp )
 959                 {
 960                     return p_tmp;
 961                 }
 962             }
 963         }
 964         break;
 965
 966     case FIND_ANYWHERE:
 967         /* Handled in vlc_object_find */
 968         break;
 969     }
 970
 971     return NULL;
 972 }
 973
 974 static vlc_object_t * FindObjectName( vlc_object_t *p_this,
 975                                       const char *psz_name,
 976                                       int i_mode )
 977 {
 978     int i;
 979     vlc_object_t *p_tmp;
 980
 981     switch( i_mode & 0x000f )
 982     {
 983     case FIND_PARENT:
 984         p_tmp = p_this->p_parent;
 985         if( p_tmp )
 986         {
 987             if( !objnamecmp(p_tmp, psz_name) )
 988             {
 989                 vlc_object_hold( p_tmp );
 990                 return p_tmp;
 991             }
 992             else
 993             {
 994                 return FindObjectName( p_tmp, psz_name, i_mode );
 995             }
 996         }
 997         break;
 998
 999     case FIND_CHILD:
1000         for( i = vlc_internals( p_this )->i_children; i--; )
1001         {
1002             p_tmp = vlc_internals( p_this )->pp_children[i];
1003             if( !objnamecmp(p_tmp, psz_name ) )
1004             {
1005                 vlc_object_hold( p_tmp );
1006                 return p_tmp;
1007             }
1008             else if( vlc_internals( p_tmp )->i_children )
1009             {
1010                 p_tmp = FindObjectName( p_tmp, psz_name, i_mode );
1011                 if( p_tmp )
1012                 {
1013                     return p_tmp;
1014                 }
1015             }
1016         }
1017         break;
1018
1019     case FIND_ANYWHERE:
1020         /* Handled in vlc_object_find */
1021         break;
1022     }
1023
1024     return NULL;
1025 }
1026
1027
1028 static void PrintObject( vlc_object_t *p_this, const char *psz_prefix )
1029 {
1030     char psz_children[20], psz_refcount[20], psz_thread[30], psz_name[50],
1031          psz_parent[20];
1032
1033     int canc = vlc_savecancel ();
1034     memset( &psz_name, 0, sizeof(psz_name) );
1035     char *name = vlc_object_get_name(p_this);
1036     if( name )
1037     {
1038         snprintf( psz_name, 49, " \"%s\"", name );
1039         free( name );
1040         if( psz_name[48] )
1041             psz_name[48] = '\"';
1042     }
1043
1044     psz_children[0] = '\0';
1045     switch( vlc_internals( p_this )->i_children )
1046     {
1047         case 0:
1048             break;
1049         case 1:
1050             strcpy( psz_children, ", 1 child" );
1051             break;
1052         default:
1053             snprintf( psz_children, 19, ", %i children",
1054                       vlc_internals( p_this )->i_children );
1055             break;
1056     }
1057
1058     psz_refcount[0] = '\0';
1059     if( vlc_internals( p_this )->i_refcount > 0 )
1060         snprintf( psz_refcount, 19, ", refcount %u",
1061                   vlc_internals( p_this )->i_refcount );
1062
1063     psz_thread[0] = '\0';
1064     if( vlc_internals( p_this )->b_thread )
1065         snprintf( psz_thread, 29, " (thread %lu)",
1066                   (unsigned long)vlc_internals( p_this )->thread_id );
1067
1068     psz_parent[0] = '\0';
1069     if( p_this->p_parent )
1070         snprintf( psz_parent, 19, ", parent %p", p_this->p_parent );
1071
1072     printf( " %so %p %s%s%s%s%s%s\n", psz_prefix,
1073             p_this, p_this->psz_object_type,
1074             psz_name, psz_thread, psz_refcount, psz_children,
1075             psz_parent );
1076     vlc_restorecancel (canc);
1077 }
1078
1079 static void DumpStructure( vlc_object_t *p_this, int i_level, char *psz_foo )
1080 {
1081     int i;
1082     char i_back = psz_foo[i_level];
1083     psz_foo[i_level] = '\0';
1084
1085     PrintObject( p_this, psz_foo );
1086
1087     psz_foo[i_level] = i_back;
1088
1089     if( i_level / 2 >= MAX_DUMPSTRUCTURE_DEPTH )
1090     {
1091         msg_Warn( p_this, "structure tree is too deep" );
1092         return;
1093     }
1094
1095     for( i = 0 ; i < vlc_internals( p_this )->i_children ; i++ )
1096     {
1097         if( i_level )
1098         {
1099             psz_foo[i_level-1] = ' ';
1100
1101             if( psz_foo[i_level-2] == '`' )
1102             {
1103                 psz_foo[i_level-2] = ' ';
1104             }
1105         }
1106
1107         if( i == vlc_internals( p_this )->i_children - 1 )
1108         {
1109             psz_foo[i_level] = '`';
1110         }
1111         else
1112         {
1113             psz_foo[i_level] = '|';
1114         }
1115
1116         psz_foo[i_level+1] = '-';
1117         psz_foo[i_level+2] = '\0';
1118
1119         DumpStructure( vlc_internals( p_this )->pp_children[i], i_level + 2,
1120                        psz_foo );
1121     }
1122 }
1123
1124 static vlc_list_t * NewList( int i_count )
1125 {
1126     vlc_list_t * p_list = malloc( sizeof( vlc_list_t ) );
1127     if( p_list == NULL )
1128         return NULL;
1129
1130     p_list->i_count = i_count;
1131
1132     if( i_count == 0 )
1133     {
1134         p_list->p_values = NULL;
1135         return p_list;
1136     }
1137
1138     p_list->p_values = malloc( i_count * sizeof( vlc_value_t ) );
1139     if( p_list->p_values == NULL )
1140     {
1141         p_list->i_count = 0;
1142         return p_list;
1143     }
1144
1145     return p_list;
1146 }
1147
1148 static void ListReplace( vlc_list_t *p_list, vlc_object_t *p_object,
1149                          int i_index )
1150 {
1151     if( p_list == NULL || i_index >= p_list->i_count )
1152     {
1153         return;
1154     }
1155
1156     vlc_object_hold( p_object );
1157
1158     p_list->p_values[i_index].p_object = p_object;
1159
1160     return;
1161 }
1162
1163 /*static void ListAppend( vlc_list_t *p_list, vlc_object_t *p_object )
1164 {
1165     if( p_list == NULL )
1166     {
1167         return;
1168     }
1169
1170     p_list->p_values = realloc_or_free( p_list->p_values,
1171                               (p_list->i_count + 1) * sizeof( vlc_value_t ) );
1172     if( p_list->p_values == NULL )
1173     {
1174         p_list->i_count = 0;
1175         return;
1176     }
1177
1178     vlc_object_hold( p_object );
1179
1180     p_list->p_values[p_list->i_count].p_object = p_object;
1181     p_list->i_count++;
1182
1183     return;
1184 }*/
1185
1186 static int CountChildren( vlc_object_t *p_this, int i_type )
1187 {
1188     vlc_object_t *p_tmp;
1189     int i, i_count = 0;
1190
1191     for( i = 0; i < vlc_internals( p_this )->i_children; i++ )
1192     {
1193         p_tmp = vlc_internals( p_this )->pp_children[i];
1194
1195         if( vlc_internals( p_tmp )->i_object_type == i_type )
1196         {
1197             i_count++;
1198         }
1199         i_count += CountChildren( p_tmp, i_type );
1200     }
1201
1202     return i_count;
1203 }
1204
1205 static void ListChildren( vlc_list_t *p_list, vlc_object_t *p_this, int i_type )
1206 {
1207     vlc_object_t *p_tmp;
1208     int i;
1209
1210     for( i = 0; i < vlc_internals( p_this )->i_children; i++ )
1211     {
1212         p_tmp = vlc_internals( p_this )->pp_children[i];
1213
1214         if( vlc_internals( p_tmp )->i_object_type == i_type )
1215             ListReplace( p_list, p_tmp, p_list->i_count++ );
1216
1217         ListChildren( p_list, p_tmp, i_type );
1218     }
1219 }