1 /*****************************************************************************
2 * objects.c: vlc_object_t handling
3 *****************************************************************************
4 * Copyright (C) 2004-2008 the VideoLAN team
7 * Authors: Samuel Hocevar <sam@zoy.org>
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.
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.
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 *****************************************************************************/
26 * This file contains the functions to handle the vlc_object_t type
30 /*****************************************************************************
32 *****************************************************************************/
39 #include "../libvlc.h"
42 #include "audio_output/aout_internal.h"
44 #include <vlc_access.h>
45 #include <vlc_demux.h>
46 #include <vlc_stream.h>
49 #include "stream_output/stream_output.h"
51 #include "vlc_interface.h"
52 #include "vlc_codec.h"
53 #include "vlc_filter.h"
55 #include "variables.h"
61 # include <errno.h> /* ENOSYS */
65 /*****************************************************************************
67 *****************************************************************************/
69 const vlc_destructor_t kVLCDestructor = NULL;
71 /*****************************************************************************
73 *****************************************************************************/
74 static int DumpCommand( vlc_object_t *, char const *,
75 vlc_value_t, vlc_value_t, void * );
77 static vlc_object_t * FindObject ( vlc_object_t *, int, int );
78 static vlc_object_t * FindObjectName( vlc_object_t *, const char *, int );
79 static void DetachObject ( vlc_object_t * );
80 static void PrintObject ( vlc_object_t *, const char * );
81 static void DumpStructure ( vlc_object_t *, int, char * );
82 static int FindIndex ( vlc_object_t *, vlc_object_t **, int );
83 static void SetAttachment ( vlc_object_t *, vlc_bool_t );
85 static vlc_list_t * NewList ( int );
86 static void ListReplace ( vlc_list_t *, vlc_object_t *, int );
87 /*static void ListAppend ( vlc_list_t *, vlc_object_t * );*/
88 static int CountChildren ( vlc_object_t *, int );
89 static void ListChildren ( vlc_list_t *, vlc_object_t *, int );
91 static void vlc_object_destroy( vlc_object_t *p_this );
92 static void vlc_object_yield_locked( vlc_object_t *p_this );
94 /*****************************************************************************
95 * Local structure lock
96 *****************************************************************************/
97 static vlc_mutex_t structure_lock;
99 void *vlc_custom_create( vlc_object_t *p_this, size_t i_size,
100 int i_type, const char *psz_type )
103 vlc_object_internals_t *p_priv;
106 * VLC objects are laid out as follow:
107 * - first the LibVLC-private per-object data,
108 * - then VLC_COMMON members from vlc_object_t,
109 * - finally, the type-specific data (if any).
111 * This function initializes the LibVLC and common data,
112 * and zeroes the rest.
114 p_priv = calloc( 1, sizeof( *p_priv ) + i_size );
118 if( i_type == VLC_OBJECT_GLOBAL )
122 assert (i_size >= sizeof (vlc_object_t));
123 p_new = (vlc_object_t *)(p_priv + 1);
126 p_new->p_internals = p_priv;
127 p_new->i_object_type = i_type;
128 p_new->psz_object_type = psz_type;
130 p_new->psz_object_name = NULL;
132 p_new->b_die = VLC_FALSE;
133 p_new->b_error = VLC_FALSE;
134 p_new->b_dead = VLC_FALSE;
135 p_priv->b_attached = VLC_FALSE;
136 p_new->b_force = VLC_FALSE;
138 p_new->psz_header = NULL;
140 p_new->i_flags |= p_this->i_flags
141 & (OBJECT_FLAGS_NODBG|OBJECT_FLAGS_QUIET|OBJECT_FLAGS_NOINTERACT);
143 p_priv->p_vars = calloc( sizeof( variable_t ), 16 );
145 if( !p_priv->p_vars )
151 if( i_type == VLC_OBJECT_GLOBAL )
153 /* If i_type is global, then p_new is actually p_libvlc_global */
154 libvlc_global_data_t *p_libvlc_global = (libvlc_global_data_t *)p_new;
155 p_new->p_libvlc = NULL;
157 p_libvlc_global->i_counter = 0;
158 p_new->i_object_id = 0;
160 p_libvlc_global->i_objects = 1;
161 p_libvlc_global->pp_objects = malloc( sizeof(vlc_object_t *) );
162 p_libvlc_global->pp_objects[0] = p_new;
163 p_priv->b_attached = VLC_TRUE;
164 vlc_mutex_init( p_new, &structure_lock );
168 libvlc_global_data_t *p_libvlc_global = vlc_global();
169 if( i_type == VLC_OBJECT_LIBVLC )
171 p_new->p_libvlc = (libvlc_int_t*)p_new;
172 p_priv->b_attached = VLC_TRUE;
176 p_new->p_libvlc = p_this->p_libvlc;
179 vlc_mutex_lock( &structure_lock );
181 p_libvlc_global->i_counter++;
182 p_new->i_object_id = p_libvlc_global->i_counter;
184 /* Wooohaa! If *this* fails, we're in serious trouble! Anyway it's
185 * useless to try and recover anything if pp_objects gets smashed. */
186 TAB_APPEND( p_libvlc_global->i_objects, p_libvlc_global->pp_objects,
189 vlc_mutex_unlock( &structure_lock );
192 p_priv->i_refcount = 1;
193 p_priv->pf_destructor = kVLCDestructor;
194 p_priv->b_thread = VLC_FALSE;
195 p_new->p_parent = NULL;
196 p_new->pp_children = NULL;
197 p_new->i_children = 0;
199 p_new->p_private = NULL;
201 /* Initialize mutexes and condvars */
202 vlc_mutex_init( p_new, &p_new->object_lock );
203 vlc_cond_init( p_new, &p_new->object_wait );
204 vlc_mutex_init( p_new, &p_priv->var_lock );
205 vlc_spin_init( &p_priv->spin );
206 p_priv->pipes[0] = p_priv->pipes[1] = -1;
208 if( i_type == VLC_OBJECT_LIBVLC )
210 var_Create( p_new, "list", VLC_VAR_STRING | VLC_VAR_ISCOMMAND );
211 var_AddCallback( p_new, "list", DumpCommand, NULL );
212 var_Create( p_new, "tree", VLC_VAR_STRING | VLC_VAR_ISCOMMAND );
213 var_AddCallback( p_new, "tree", DumpCommand, NULL );
214 var_Create( p_new, "vars", VLC_VAR_STRING | VLC_VAR_ISCOMMAND );
215 var_AddCallback( p_new, "vars", DumpCommand, NULL );
223 * Allocates and initializes a vlc object.
225 * @param i_type known object type (all of them are negative integer values),
226 * or object byte size (always positive).
228 * @return the new object, or NULL on error.
230 void * __vlc_object_create( vlc_object_t *p_this, int i_type )
232 const char * psz_type;
237 case VLC_OBJECT_LIBVLC:
238 i_size = sizeof(libvlc_int_t);
241 case VLC_OBJECT_INTF:
242 i_size = sizeof(intf_thread_t);
243 psz_type = "interface";
245 case VLC_OBJECT_DIALOGS:
246 i_size = sizeof(intf_thread_t);
247 psz_type = "dialogs";
249 case VLC_OBJECT_DEMUX:
250 i_size = sizeof(demux_t);
253 case VLC_OBJECT_ACCESS:
254 i_size = sizeof(access_t);
257 case VLC_OBJECT_DECODER:
258 i_size = sizeof(decoder_t);
259 psz_type = "decoder";
261 case VLC_OBJECT_PACKETIZER:
262 i_size = sizeof(decoder_t);
263 psz_type = "packetizer";
265 case VLC_OBJECT_ENCODER:
266 i_size = sizeof(encoder_t);
267 psz_type = "encoder";
269 case VLC_OBJECT_FILTER:
270 i_size = sizeof(filter_t);
273 case VLC_OBJECT_VOUT:
274 i_size = sizeof(vout_thread_t);
275 psz_type = "video output";
277 case VLC_OBJECT_AOUT:
278 i_size = sizeof(aout_instance_t);
279 psz_type = "audio output";
281 case VLC_OBJECT_SOUT:
282 i_size = sizeof(sout_instance_t);
283 psz_type = "stream output";
285 case VLC_OBJECT_OPENGL:
286 i_size = sizeof( vout_thread_t );
289 case VLC_OBJECT_ANNOUNCE:
290 i_size = sizeof( announce_handler_t );
291 psz_type = "announce";
293 case VLC_OBJECT_INTERACTION:
294 i_size = sizeof( interaction_t );
295 psz_type = "interaction";
298 i_size = i_type > (int)sizeof(vlc_object_t)
299 ? i_type : (int)sizeof(vlc_object_t);
300 i_type = VLC_OBJECT_GENERIC;
301 psz_type = "generic";
305 return vlc_custom_create( p_this, i_size, i_type, psz_type );
310 ****************************************************************************
311 * Set the destructor of a vlc object
313 * This function sets the destructor of the vlc object. It will be called
314 * when the object is destroyed when the its refcount reaches 0.
315 * (It is called by the internal function vlc_object_destroy())
316 *****************************************************************************/
317 void __vlc_object_set_destructor( vlc_object_t *p_this,
318 vlc_destructor_t pf_destructor )
320 vlc_object_internals_t *p_priv = vlc_internals(p_this );
322 vlc_mutex_lock( &structure_lock );
323 p_priv->pf_destructor = pf_destructor;
324 vlc_mutex_unlock( &structure_lock );
328 ****************************************************************************
329 * Destroy a vlc object (Internal)
331 * This function destroys an object that has been previously allocated with
332 * vlc_object_create. The object's refcount must be zero and it must not be
333 * attached to other objects in any way.
334 *****************************************************************************/
335 static void vlc_object_destroy( vlc_object_t *p_this )
337 vlc_object_internals_t *p_priv = vlc_internals( p_this );
339 /* Automatically detach the object from its parents */
340 if( p_this->p_parent ) vlc_object_detach( p_this );
343 /* Send a kill to the object's thread if applicable */
344 vlc_object_kill( p_this );
346 /* If we are running on a thread, wait until it ends */
347 if( p_priv->b_thread )
348 vlc_thread_join( p_this );
350 /* Call the custom "subclass" destructor */
351 if( p_priv->pf_destructor )
352 p_priv->pf_destructor( p_this );
355 if( p_this->i_children )
360 "ERROR: cannot delete object (%i, %s) with %d children\n",
361 p_this->i_object_id, p_this->psz_object_name,
362 p_this->i_children );
364 for( i = 0; i < p_this->i_children; i++ )
367 "ERROR: Remaining children object "
368 "(id:%i, type:%s, name:%s)\n",
369 p_this->pp_children[i]->i_object_id,
370 p_this->pp_children[i]->psz_object_type,
371 p_this->pp_children[i]->psz_object_name );
377 /* Destroy the associated variables, starting from the end so that
378 * no memmove calls have to be done. */
379 while( p_priv->i_vars )
381 var_Destroy( p_this, p_priv->p_vars[p_priv->i_vars - 1].psz_name );
384 free( p_priv->p_vars );
385 vlc_mutex_destroy( &p_priv->var_lock );
387 free( p_this->psz_header );
389 if( p_this->i_object_type == VLC_OBJECT_GLOBAL )
391 libvlc_global_data_t *p_global = (libvlc_global_data_t *)p_this;
394 if( p_global->i_objects > 0 )
397 for( i = 0; i < p_global->i_objects; i++ )
399 /* We are leaking this object */
401 "ERROR: leaking object (id:%i, type:%s, name:%s)\n",
402 p_global->pp_objects[i]->i_object_id,
403 p_global->pp_objects[i]->psz_object_type,
404 p_global->pp_objects[i]->psz_object_name );
407 /* Strongly abort, cause we want these to be fixed */
411 /* We are the global object ... no need to lock. */
412 free( p_global->pp_objects );
413 p_global->pp_objects = NULL;
415 vlc_mutex_destroy( &structure_lock );
418 #if defined(WIN32) || defined(UNDER_CE)
419 /* if object has an associated thread, close it now */
420 if( p_priv->thread_id.hThread )
421 CloseHandle(p_priv->thread_id.hThread);
424 vlc_mutex_destroy( &p_this->object_lock );
425 vlc_cond_destroy( &p_this->object_wait );
426 vlc_spin_destroy( &p_priv->spin );
427 if( p_priv->pipes[1] != -1 )
428 close( p_priv->pipes[1] );
429 if( p_priv->pipes[0] != -1 )
430 close( p_priv->pipes[0] );
436 /** Inter-object signaling */
438 void __vlc_object_lock( vlc_object_t *obj )
440 vlc_mutex_lock( &obj->object_lock );
443 void __vlc_object_unlock( vlc_object_t *obj )
445 vlc_assert_locked( &obj->object_lock );
446 vlc_mutex_unlock( &obj->object_lock );
450 # include <winsock2.h>
451 # include <ws2tcpip.h>
454 * select()-able pipes emulated using Winsock
456 static int pipe (int fd[2])
459 int addrlen = sizeof (addr);
461 SOCKET l = socket (PF_INET, SOCK_STREAM, IPPROTO_TCP), a,
462 c = socket (PF_INET, SOCK_STREAM, IPPROTO_TCP);
463 if ((l == INVALID_SOCKET) || (c == INVALID_SOCKET))
466 memset (&addr, 0, sizeof (addr));
467 addr.sin_family = AF_INET;
468 addr.sin_addr.s_addr = htonl (INADDR_LOOPBACK);
469 if (bind (l, (PSOCKADDR)&addr, sizeof (addr))
470 || getsockname (l, (PSOCKADDR)&addr, &addrlen)
472 || connect (c, (PSOCKADDR)&addr, addrlen))
475 a = accept (l, NULL, NULL);
476 if (a == INVALID_SOCKET)
487 if (l != INVALID_SOCKET)
489 if (c != INVALID_SOCKET)
495 #define read( a, b, c ) recv (a, b, c, 0)
497 #define write( a, b, c ) send (a, b, c, 0)
499 #define close( a ) closesocket (a)
503 * Returns the readable end of a pipe that becomes readable once termination
504 * of the object is requested (vlc_object_kill()).
505 * This can be used to wake-up out of a select() or poll() event loop, such
506 * typically when doing network I/O.
508 * Note that the pipe will remain the same for the lifetime of the object.
509 * DO NOT read the pipe nor close it yourself. Ever.
511 * @param obj object that would be "killed"
512 * @return a readable pipe descriptor, or -1 on error.
514 int __vlc_object_waitpipe( vlc_object_t *obj )
516 int pfd[2] = { -1, -1 };
517 struct vlc_object_internals_t *internals = obj->p_internals;
518 vlc_bool_t killed = VLC_FALSE;
520 vlc_spin_lock (&internals->spin);
521 if (internals->pipes[0] == -1)
523 /* This can only ever happen if someone killed us without locking: */
524 assert (internals->pipes[1] == -1);
525 vlc_spin_unlock (&internals->spin);
530 vlc_spin_lock (&internals->spin);
531 if (internals->pipes[0] == -1)
533 internals->pipes[0] = pfd[0];
534 internals->pipes[1] = pfd[1];
535 pfd[0] = pfd[1] = -1;
539 vlc_spin_unlock (&internals->spin);
543 /* Race condition: vlc_object_kill() already invoked! */
546 vlc_spin_lock (&internals->spin);
547 fd = internals->pipes[1];
548 internals->pipes[1] = -1;
549 vlc_spin_unlock (&internals->spin);
551 msg_Dbg (obj, "waitpipe: object already dying");
556 /* Race condition: two threads call pipe() - unlikely */
562 return internals->pipes[0];
567 * Waits for the object to be signaled (using vlc_object_signal()).
568 * If the object already has a signal pending, this function will return
569 * immediately. It is asserted that the caller holds the object lock.
571 * @return true if the object is dying and should terminate.
573 vlc_bool_t __vlc_object_wait( vlc_object_t *obj )
575 vlc_assert_locked( &obj->object_lock );
576 vlc_cond_wait( &obj->object_wait, &obj->object_lock );
582 * Waits for the object to be signaled (using vlc_object_signal()), or for
584 * If the object already has a signal pending, this function will return
585 * immediately. It is asserted that the caller holds the object lock.
587 * @return negative if the object is dying and should terminate,
588 * positive if the the object has been signaled but is not dying,
589 * 0 if timeout has been reached.
591 int __vlc_object_timedwait( vlc_object_t *obj, mtime_t deadline )
595 vlc_assert_locked( &obj->object_lock );
596 v = vlc_cond_timedwait( &obj->object_wait, &obj->object_lock, deadline );
597 if( v == 0 ) /* signaled */
598 return obj->b_die ? -1 : 1;
604 * Checks whether an object has been "killed".
605 * The object lock must be held.
607 * Typical code for an object thread could be:
609 vlc_object_lock (self);
611 while (vlc_object_alive (self))
615 if (vlc_object_wait (self))
620 ...deinitialization...
621 vlc_object_unlock (self);
624 * @return true iff the object has not been killed yet
626 vlc_bool_t __vlc_object_alive( vlc_object_t *obj )
628 vlc_assert_locked( &obj->object_lock );
634 * Signals an object for which the lock is held.
636 void __vlc_object_signal_unlocked( vlc_object_t *obj )
638 vlc_assert_locked (&obj->object_lock);
639 vlc_cond_signal( &obj->object_wait );
644 * Requests termination of an object.
645 * If the object is LibVLC, also request to terminate all its children.
647 void __vlc_object_kill( vlc_object_t *p_this )
649 struct vlc_object_internals_t *internals = p_this->p_internals;
652 vlc_mutex_lock( &p_this->object_lock );
653 p_this->b_die = VLC_TRUE;
655 vlc_spin_lock (&internals->spin);
656 fd = internals->pipes[1];
657 internals->pipes[1] = -1;
658 vlc_spin_unlock (&internals->spin);
662 msg_Dbg (p_this, "waitpipe: object killed");
666 if( p_this->i_object_type == VLC_OBJECT_LIBVLC )
667 for( int i = 0; i < p_this->i_children ; i++ )
668 vlc_object_kill( p_this->pp_children[i] );
670 vlc_object_signal_unlocked( p_this );
671 vlc_mutex_unlock( &p_this->object_lock );
676 * find an object given its ID
678 * This function looks for the object whose i_object_id field is i_id. We
679 * use a dichotomy so that lookups are in log2(n).
680 *****************************************************************************/
681 void * vlc_object_get( int i_id )
684 vlc_object_t **pp_objects;
685 libvlc_global_data_t *p_libvlc_global = vlc_global();
687 vlc_mutex_lock( &structure_lock );
689 pp_objects = p_libvlc_global->pp_objects;
691 /* Perform our dichotomy */
692 for( i_max = p_libvlc_global->i_objects - 1 ; ; )
694 i_middle = i_max / 2;
696 if( pp_objects[i_middle]->i_object_id > i_id )
700 else if( pp_objects[i_middle]->i_object_id < i_id )
704 pp_objects += i_middle;
709 /* This happens when there are only two remaining objects */
710 if( pp_objects[i_middle+1]->i_object_id == i_id
711 && pp_objects[i_middle+1]->p_internals->i_refcount > 0 )
713 vlc_object_yield_locked( pp_objects[i_middle+1] );
714 vlc_mutex_unlock( &structure_lock );
715 return pp_objects[i_middle+1];
720 else if( pp_objects[i_middle]->p_internals->i_refcount > 0 )
722 vlc_object_yield_locked( pp_objects[i_middle] );
723 vlc_mutex_unlock( &structure_lock );
724 return pp_objects[i_middle];
729 /* this means that i_max == i_middle, and since we have already
730 * tested pp_objects[i_middle]), p_found is properly set. */
735 vlc_mutex_unlock( &structure_lock );
740 ****************************************************************************
741 * find a typed object and increment its refcount
742 *****************************************************************************
743 * This function recursively looks for a given object type. i_mode can be one
744 * of FIND_PARENT, FIND_CHILD or FIND_ANYWHERE.
745 *****************************************************************************/
746 void * __vlc_object_find( vlc_object_t *p_this, int i_type, int i_mode )
748 vlc_object_t *p_found;
750 vlc_mutex_lock( &structure_lock );
752 /* If we are of the requested type ourselves, don't look further */
753 if( !(i_mode & FIND_STRICT) && p_this->i_object_type == i_type
754 && p_this->p_internals->i_refcount > 0 )
756 vlc_object_yield_locked( p_this );
757 vlc_mutex_unlock( &structure_lock );
761 /* Otherwise, recursively look for the object */
762 if( (i_mode & 0x000f) == FIND_ANYWHERE )
764 vlc_object_t *p_root = p_this;
767 while( p_root->p_parent != NULL &&
768 p_root != VLC_OBJECT( p_this->p_libvlc ) )
770 p_root = p_root->p_parent;
773 p_found = FindObject( p_root, i_type, (i_mode & ~0x000f)|FIND_CHILD );
774 if( p_found == NULL && p_root != VLC_OBJECT( p_this->p_libvlc ) )
776 p_found = FindObject( VLC_OBJECT( p_this->p_libvlc ),
777 i_type, (i_mode & ~0x000f)|FIND_CHILD );
782 p_found = FindObject( p_this, i_type, i_mode );
785 vlc_mutex_unlock( &structure_lock );
791 ****************************************************************************
792 * find a named object and increment its refcount
793 *****************************************************************************
794 * This function recursively looks for a given object name. i_mode can be one
795 * of FIND_PARENT, FIND_CHILD or FIND_ANYWHERE.
796 *****************************************************************************/
797 void * __vlc_object_find_name( vlc_object_t *p_this, const char *psz_name,
800 vlc_object_t *p_found;
802 vlc_mutex_lock( &structure_lock );
804 /* Avoid obvious freed object uses */
805 assert( p_this->p_internals->i_refcount > 0 );
807 /* If have the requested name ourselves, don't look further */
808 if( !(i_mode & FIND_STRICT)
809 && p_this->psz_object_name
810 && !strcmp( p_this->psz_object_name, psz_name )
811 && p_this->p_internals->i_refcount > 0 )
813 vlc_object_yield_locked( p_this );
814 vlc_mutex_unlock( &structure_lock );
818 /* Otherwise, recursively look for the object */
819 if( (i_mode & 0x000f) == FIND_ANYWHERE )
821 vlc_object_t *p_root = p_this;
824 while( p_root->p_parent != NULL &&
825 p_root != VLC_OBJECT( p_this->p_libvlc ) )
827 p_root = p_root->p_parent;
830 p_found = FindObjectName( p_root, psz_name,
831 (i_mode & ~0x000f)|FIND_CHILD );
832 if( p_found == NULL && p_root != VLC_OBJECT( p_this->p_libvlc ) )
834 p_found = FindObjectName( VLC_OBJECT( p_this->p_libvlc ),
835 psz_name, (i_mode & ~0x000f)|FIND_CHILD );
840 p_found = FindObjectName( p_this, psz_name, i_mode );
843 vlc_mutex_unlock( &structure_lock );
849 ****************************************************************************
850 * increment an object refcount
851 *****************************************************************************/
853 /* When the structure_lock is locked */
854 static void vlc_object_yield_locked( vlc_object_t *p_this )
856 vlc_assert_locked (&structure_lock);
858 /* Avoid obvious freed object uses */
859 assert( p_this->p_internals->i_refcount > 0 );
861 /* Increment the counter */
862 p_this->p_internals->i_refcount++;
865 /* Public function */
866 void __vlc_object_yield( vlc_object_t *p_this )
868 vlc_mutex_lock( &structure_lock );
869 vlc_object_yield_locked( p_this );
870 vlc_mutex_unlock( &structure_lock );
874 /*****************************************************************************
875 * decrement an object refcount
876 * And destroy the object if its refcount reach zero.
877 *****************************************************************************/
878 void __vlc_object_release( vlc_object_t *p_this )
880 vlc_bool_t b_should_destroy;
882 vlc_mutex_lock( &structure_lock );
884 assert( p_this->p_internals->i_refcount > 0 );
885 p_this->p_internals->i_refcount--;
886 b_should_destroy = (p_this->p_internals->i_refcount == 0);
888 if( b_should_destroy )
890 /* Make sure this object can't be obtained via vlc_find_object now that
892 libvlc_global_data_t *p_libvlc_global = vlc_global();
895 /* Wooohaa! If *this* fails, we're in serious trouble! Anyway it's
896 * useless to try and recover anything if pp_objects gets smashed. */
897 i_index = FindIndex( p_this, p_libvlc_global->pp_objects,
898 p_libvlc_global->i_objects );
899 REMOVE_ELEM( p_libvlc_global->pp_objects,
900 p_libvlc_global->i_objects, i_index );
903 vlc_mutex_unlock( &structure_lock );
905 if( b_should_destroy )
906 vlc_object_destroy( p_this );
910 ****************************************************************************
911 * attach object to a parent object
912 *****************************************************************************
913 * This function sets p_this as a child of p_parent, and p_parent as a parent
914 * of p_this. This link can be undone using vlc_object_detach.
915 *****************************************************************************/
916 void __vlc_object_attach( vlc_object_t *p_this, vlc_object_t *p_parent )
918 if( !p_this ) return;
920 vlc_mutex_lock( &structure_lock );
922 /* Avoid obvious freed object uses */
923 assert( p_this->p_internals->i_refcount > 0 );
925 /* Attach the parent to its child */
926 p_this->p_parent = p_parent;
928 /* Attach the child to its parent */
929 INSERT_ELEM( p_parent->pp_children, p_parent->i_children,
930 p_parent->i_children, p_this );
932 /* Climb up the tree to see whether we are connected with the root */
933 if( p_parent->p_internals->b_attached )
935 SetAttachment( p_this, VLC_TRUE );
938 vlc_mutex_unlock( &structure_lock );
942 ****************************************************************************
943 * detach object from its parent
944 *****************************************************************************
945 * This function removes all links between an object and its parent.
946 *****************************************************************************/
947 void __vlc_object_detach( vlc_object_t *p_this )
949 if( !p_this ) return;
951 vlc_mutex_lock( &structure_lock );
953 if( !p_this->p_parent )
955 msg_Err( p_this, "object is not attached" );
956 vlc_mutex_unlock( &structure_lock );
960 /* Climb up the tree to see whether we are connected with the root */
961 if( p_this->p_parent->p_internals->b_attached )
963 SetAttachment( p_this, VLC_FALSE );
966 DetachObject( p_this );
967 vlc_mutex_unlock( &structure_lock );
972 ****************************************************************************
973 * find a list typed objects and increment their refcount
974 *****************************************************************************
975 * This function recursively looks for a given object type. i_mode can be one
976 * of FIND_PARENT, FIND_CHILD or FIND_ANYWHERE.
977 *****************************************************************************/
978 vlc_list_t * __vlc_list_find( vlc_object_t *p_this, int i_type, int i_mode )
981 vlc_object_t **pp_current, **pp_end;
982 int i_count = 0, i_index = 0;
983 libvlc_global_data_t *p_libvlc_global = vlc_global();
985 vlc_mutex_lock( &structure_lock );
987 /* Look for the objects */
988 switch( i_mode & 0x000f )
991 pp_current = p_libvlc_global->pp_objects;
992 pp_end = pp_current + p_libvlc_global->i_objects;
994 for( ; pp_current < pp_end ; pp_current++ )
996 if( (*pp_current)->p_internals->b_attached
997 && (*pp_current)->i_object_type == i_type )
1003 p_list = NewList( i_count );
1004 pp_current = p_libvlc_global->pp_objects;
1006 for( ; pp_current < pp_end ; pp_current++ )
1008 if( (*pp_current)->p_internals->b_attached
1009 && (*pp_current)->i_object_type == i_type )
1011 ListReplace( p_list, *pp_current, i_index );
1012 if( i_index < i_count ) i_index++;
1018 i_count = CountChildren( p_this, i_type );
1019 p_list = NewList( i_count );
1021 /* Check allocation was successful */
1022 if( p_list->i_count != i_count )
1024 msg_Err( p_this, "list allocation failed!" );
1025 p_list->i_count = 0;
1029 p_list->i_count = 0;
1030 ListChildren( p_list, p_this, i_type );
1034 msg_Err( p_this, "unimplemented!" );
1035 p_list = NewList( 0 );
1039 vlc_mutex_unlock( &structure_lock );
1044 /*****************************************************************************
1045 * DumpCommand: print the current vlc structure
1046 *****************************************************************************
1047 * This function prints either an ASCII tree showing the connections between
1048 * vlc objects, and additional information such as their refcount, thread ID,
1049 * etc. (command "tree"), or the same data as a simple list (command "list").
1050 *****************************************************************************/
1051 static int DumpCommand( vlc_object_t *p_this, char const *psz_cmd,
1052 vlc_value_t oldval, vlc_value_t newval, void *p_data )
1054 libvlc_global_data_t *p_libvlc_global = vlc_global();
1056 (void)oldval; (void)p_data;
1057 if( *psz_cmd == 'l' )
1059 vlc_mutex_lock( &structure_lock );
1061 vlc_object_t **pp_current, **pp_end;
1063 pp_current = p_libvlc_global->pp_objects;
1064 pp_end = pp_current + p_libvlc_global->i_objects;
1066 for( ; pp_current < pp_end ; pp_current++ )
1068 if( (*pp_current)->p_internals->b_attached )
1070 PrintObject( *pp_current, "" );
1074 printf( " o %.8i %s (not attached)\n",
1075 (*pp_current)->i_object_id,
1076 (*pp_current)->psz_object_type );
1080 vlc_mutex_unlock( &structure_lock );
1084 vlc_object_t *p_object = NULL;
1086 if( *newval.psz_string )
1089 int i_id = strtol( newval.psz_string, &end, 0 );
1090 if( end != newval.psz_string )
1091 p_object = vlc_object_get( i_id );
1094 /* try using the object's name to find it */
1095 vlc_object_t *p_libvlc = vlc_object_get( 1 );
1098 /* Look in p_libvlc's children tree */
1099 p_object = vlc_object_find_name( p_libvlc,
1102 vlc_object_release( p_libvlc );
1106 /* If it's not in libvlc, look in libvlc_global (== p_this) */
1107 p_object = vlc_object_find_name( p_this,
1119 vlc_mutex_lock( &structure_lock );
1121 if( *psz_cmd == 't' )
1123 char psz_foo[2 * MAX_DUMPSTRUCTURE_DEPTH + 1];
1126 p_object = p_this->p_libvlc ? VLC_OBJECT(p_this->p_libvlc) : p_this;
1129 DumpStructure( p_object, 0, psz_foo );
1131 else if( *psz_cmd == 'v' )
1136 p_object = p_this->p_libvlc ? VLC_OBJECT(p_this->p_libvlc) : p_this;
1138 PrintObject( p_object, "" );
1140 if( !p_object->p_internals->i_vars )
1141 printf( " `-o No variables\n" );
1142 for( i = 0; i < p_object->p_internals->i_vars; i++ )
1144 variable_t *p_var = p_object->p_internals->p_vars + i;
1146 const char *psz_type = "unknown";
1147 switch( p_var->i_type & VLC_VAR_TYPE )
1149 #define MYCASE( type, nice ) \
1150 case VLC_VAR_ ## type: \
1153 MYCASE( VOID, "void" );
1154 MYCASE( BOOL, "bool" );
1155 MYCASE( INTEGER, "integer" );
1156 MYCASE( HOTKEY, "hotkey" );
1157 MYCASE( STRING, "string" );
1158 MYCASE( MODULE, "module" );
1159 MYCASE( FILE, "file" );
1160 MYCASE( DIRECTORY, "directory" );
1161 MYCASE( VARIABLE, "variable" );
1162 MYCASE( FLOAT, "float" );
1163 MYCASE( TIME, "time" );
1164 MYCASE( ADDRESS, "address" );
1165 MYCASE( MUTEX, "mutex" );
1166 MYCASE( LIST, "list" );
1169 printf( " %c-o \"%s\" (%s",
1170 i + 1 == p_object->p_internals->i_vars ? '`' : '|',
1171 p_var->psz_name, psz_type );
1172 if( p_var->psz_text )
1173 printf( ", %s", p_var->psz_text );
1175 if( p_var->i_type & VLC_VAR_ISCOMMAND )
1176 printf( ", command" );
1177 if( p_var->i_entries )
1178 printf( ", %d callbacks", p_var->i_entries );
1179 switch( p_var->i_type & 0x00f0 )
1185 printf( ": %s", p_var->val.b_bool ? "true" : "false" );
1187 case VLC_VAR_INTEGER:
1188 printf( ": %d", p_var->val.i_int );
1190 case VLC_VAR_STRING:
1191 printf( ": \"%s\"", p_var->val.psz_string );
1194 printf( ": %f", p_var->val.f_float );
1197 printf( ": " I64Fi, (int64_t)p_var->val.i_time );
1199 case VLC_VAR_ADDRESS:
1200 printf( ": %p", p_var->val.p_address );
1210 vlc_mutex_unlock( &structure_lock );
1212 if( *newval.psz_string )
1214 vlc_object_release( p_object );
1221 /*****************************************************************************
1222 * vlc_list_release: free a list previously allocated by vlc_list_find
1223 *****************************************************************************
1224 * This function decreases the refcount of all objects in the list and
1226 *****************************************************************************/
1227 void vlc_list_release( vlc_list_t *p_list )
1231 for( i_index = 0; i_index < p_list->i_count; i_index++ )
1233 vlc_object_release( p_list->p_values[i_index].p_object );
1236 free( p_list->p_values );
1240 /*****************************************************************************
1241 * dump an object. (Debug function)
1242 *****************************************************************************/
1243 void __vlc_object_dump( vlc_object_t *p_this )
1245 vlc_mutex_lock( &structure_lock );
1246 char psz_foo[2 * MAX_DUMPSTRUCTURE_DEPTH + 1];
1248 DumpStructure( p_this, 0, psz_foo );
1249 vlc_mutex_unlock( &structure_lock );
1252 /* Following functions are local */
1254 /*****************************************************************************
1255 * FindIndex: find the index of an object in an array of objects
1256 *****************************************************************************
1257 * This function assumes that p_this can be found in pp_objects. It will not
1258 * crash if p_this cannot be found, but will return a wrong value. It is your
1259 * duty to check the return value if you are not certain that the object could
1260 * be found for sure.
1261 *****************************************************************************/
1262 static int FindIndex( vlc_object_t *p_this,
1263 vlc_object_t **pp_objects, int i_count )
1265 int i_middle = i_count / 2;
1272 if( pp_objects[i_middle] == p_this )
1282 /* We take advantage of the sorted array */
1283 if( pp_objects[i_middle]->i_object_id < p_this->i_object_id )
1285 return i_middle + FindIndex( p_this, pp_objects + i_middle,
1286 i_count - i_middle );
1290 return FindIndex( p_this, pp_objects, i_middle );
1294 static vlc_object_t * FindObject( vlc_object_t *p_this, int i_type, int i_mode )
1297 vlc_object_t *p_tmp;
1299 switch( i_mode & 0x000f )
1302 p_tmp = p_this->p_parent;
1305 if( p_tmp->i_object_type == i_type
1306 && p_tmp->p_internals->i_refcount > 0 )
1308 vlc_object_yield_locked( p_tmp );
1313 return FindObject( p_tmp, i_type, i_mode );
1319 for( i = p_this->i_children; i--; )
1321 p_tmp = p_this->pp_children[i];
1322 if( p_tmp->i_object_type == i_type
1323 && p_tmp->p_internals->i_refcount > 0 )
1325 vlc_object_yield_locked( p_tmp );
1328 else if( p_tmp->i_children )
1330 p_tmp = FindObject( p_tmp, i_type, i_mode );
1340 /* Handled in vlc_object_find */
1347 static vlc_object_t * FindObjectName( vlc_object_t *p_this,
1348 const char *psz_name,
1352 vlc_object_t *p_tmp;
1354 switch( i_mode & 0x000f )
1357 p_tmp = p_this->p_parent;
1360 if( p_tmp->psz_object_name
1361 && !strcmp( p_tmp->psz_object_name, psz_name )
1362 && p_tmp->p_internals->i_refcount > 0 )
1364 vlc_object_yield_locked( p_tmp );
1369 return FindObjectName( p_tmp, psz_name, i_mode );
1375 for( i = p_this->i_children; i--; )
1377 p_tmp = p_this->pp_children[i];
1378 if( p_tmp->psz_object_name
1379 && !strcmp( p_tmp->psz_object_name, psz_name )
1380 && p_tmp->p_internals->i_refcount > 0 )
1382 vlc_object_yield_locked( p_tmp );
1385 else if( p_tmp->i_children )
1387 p_tmp = FindObjectName( p_tmp, psz_name, i_mode );
1397 /* Handled in vlc_object_find */
1404 static void DetachObject( vlc_object_t *p_this )
1406 vlc_object_t *p_parent = p_this->p_parent;
1409 /* Remove p_this's parent */
1410 p_this->p_parent = NULL;
1412 /* Remove all of p_parent's children which are p_this */
1413 for( i_index = p_parent->i_children ; i_index-- ; )
1415 if( p_parent->pp_children[i_index] == p_this )
1417 p_parent->i_children--;
1418 for( i = i_index ; i < p_parent->i_children ; i++ )
1420 p_parent->pp_children[i] = p_parent->pp_children[i+1];
1425 if( p_parent->i_children )
1427 p_parent->pp_children = (vlc_object_t **)realloc( p_parent->pp_children,
1428 p_parent->i_children * sizeof(vlc_object_t *) );
1432 free( p_parent->pp_children );
1433 p_parent->pp_children = NULL;
1437 /*****************************************************************************
1438 * SetAttachment: recursively set the b_attached flag of a subtree.
1439 *****************************************************************************
1440 * This function is used by the attach and detach functions to propagate
1441 * the b_attached flag in a subtree.
1442 *****************************************************************************/
1443 static void SetAttachment( vlc_object_t *p_this, vlc_bool_t b_attached )
1447 for( i_index = p_this->i_children ; i_index-- ; )
1449 SetAttachment( p_this->pp_children[i_index], b_attached );
1452 p_this->p_internals->b_attached = b_attached;
1455 static void PrintObject( vlc_object_t *p_this, const char *psz_prefix )
1457 char psz_children[20], psz_refcount[20], psz_thread[30], psz_name[50],
1461 if( p_this->psz_object_name )
1463 snprintf( psz_name, 49, " \"%s\"", p_this->psz_object_name );
1465 psz_name[48] = '\"';
1468 psz_children[0] = '\0';
1469 switch( p_this->i_children )
1474 strcpy( psz_children, ", 1 child" );
1477 snprintf( psz_children, 19, ", %i children", p_this->i_children );
1481 psz_refcount[0] = '\0';
1482 if( p_this->p_internals->i_refcount > 0 )
1483 snprintf( psz_refcount, 19, ", refcount %u",
1484 p_this->p_internals->i_refcount );
1486 psz_thread[0] = '\0';
1487 if( p_this->p_internals->b_thread )
1488 snprintf( psz_thread, 29, " (thread %u)",
1489 #if defined(WIN32) || defined(UNDER_CE)
1490 (unsigned)p_this->p_internals->thread_id.id );
1492 (unsigned)p_this->p_internals->thread_id );
1495 psz_parent[0] = '\0';
1496 if( p_this->p_parent )
1497 snprintf( psz_parent, 19, ", parent %i", p_this->p_parent->i_object_id );
1499 printf( " %so %.8i %s%s%s%s%s%s\n", psz_prefix,
1500 p_this->i_object_id, p_this->psz_object_type,
1501 psz_name, psz_thread, psz_refcount, psz_children,
1505 static void DumpStructure( vlc_object_t *p_this, int i_level, char *psz_foo )
1508 char i_back = psz_foo[i_level];
1509 psz_foo[i_level] = '\0';
1511 PrintObject( p_this, psz_foo );
1513 psz_foo[i_level] = i_back;
1515 if( i_level / 2 >= MAX_DUMPSTRUCTURE_DEPTH )
1517 msg_Warn( p_this, "structure tree is too deep" );
1521 for( i = 0 ; i < p_this->i_children ; i++ )
1525 psz_foo[i_level-1] = ' ';
1527 if( psz_foo[i_level-2] == '`' )
1529 psz_foo[i_level-2] = ' ';
1533 if( i == p_this->i_children - 1 )
1535 psz_foo[i_level] = '`';
1539 psz_foo[i_level] = '|';
1542 psz_foo[i_level+1] = '-';
1543 psz_foo[i_level+2] = '\0';
1545 DumpStructure( p_this->pp_children[i], i_level + 2, psz_foo );
1549 static vlc_list_t * NewList( int i_count )
1551 vlc_list_t * p_list = (vlc_list_t *)malloc( sizeof( vlc_list_t ) );
1552 if( p_list == NULL )
1557 p_list->i_count = i_count;
1561 p_list->p_values = NULL;
1565 p_list->p_values = malloc( i_count * sizeof( vlc_value_t ) );
1566 if( p_list->p_values == NULL )
1568 p_list->i_count = 0;
1575 static void ListReplace( vlc_list_t *p_list, vlc_object_t *p_object,
1578 if( p_list == NULL || i_index >= p_list->i_count )
1583 vlc_object_yield_locked( p_object );
1585 p_list->p_values[i_index].p_object = p_object;
1590 /*static void ListAppend( vlc_list_t *p_list, vlc_object_t *p_object )
1592 if( p_list == NULL )
1597 p_list->p_values = realloc( p_list->p_values, (p_list->i_count + 1)
1598 * sizeof( vlc_value_t ) );
1599 if( p_list->p_values == NULL )
1601 p_list->i_count = 0;
1605 vlc_object_yield_locked( p_object );
1607 p_list->p_values[p_list->i_count].p_object = p_object;
1613 static int CountChildren( vlc_object_t *p_this, int i_type )
1615 vlc_object_t *p_tmp;
1618 for( i = 0; i < p_this->i_children; i++ )
1620 p_tmp = p_this->pp_children[i];
1622 if( p_tmp->i_object_type == i_type )
1627 if( p_tmp->i_children )
1629 i_count += CountChildren( p_tmp, i_type );
1636 static void ListChildren( vlc_list_t *p_list, vlc_object_t *p_this, int i_type )
1638 vlc_object_t *p_tmp;
1641 for( i = 0; i < p_this->i_children; i++ )
1643 p_tmp = p_this->pp_children[i];
1645 if( p_tmp->i_object_type == i_type )
1647 ListReplace( p_list, p_tmp, p_list->i_count++ );
1650 if( p_tmp->i_children )
1652 ListChildren( p_list, p_tmp, i_type );