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